Get debt capacity result (CDP)

Retrieves the Debt Capacity Result (Resultado da Capacidade de Pagamento) linked to a PVL request. The id_pleito can be obtained from get_pvl().

Usage

get_res_cdp(
  id_pleito,
  use_cache = TRUE,
  verbose = FALSE,
  page_size = NULL,
  max_rows = Inf
)

get_debt_capacity(request_id, use_cache = TRUE, verbose = FALSE,
  page_size = NULL, max_rows = Inf)

Arguments

id_pleito

Integer. Database ID from get_pvl(). Required.

use_cache

Logical. If TRUE (default), uses an in-memory cache.

verbose

Logical. If TRUE, prints the full API URL being called. Useful for debugging or testing in a browser. Defaults to getOption("tesouror.verbose", FALSE).

page_size

Integer or NULL. Number of rows per API page. If NULL (default), uses the API server default (5000 for SICONFI/SADIPEM).

max_rows

Numeric. Maximum number of rows to return. Defaults to Inf (all rows). Useful for quick tests with large datasets (e.g., max_rows = 100).

request_id

Integer. Database ID of the PVL request. Obtain from the id_pleito column of get_pvl() results. Required. Maps to id_pleito.

Value

A tibble with CDP result data.

Details

get_debt_capacity() is an English alias.

See also

Other SADIPEM: get_opc_cronograma_liberacoes(), get_opc_cronograma_pagamentos(), get_opc_taxa_cambio(), get_pvl(), get_pvl_tramitacao(), get_res_cronograma_pagamentos()

Examples

if (FALSE) { # \dontrun{
cdp <- get_res_cdp(id_pleito = 40353)
} # }