Listar CPRs da empresa

GET

/cpr/list

Lista, com paginação de 60 por página, as CPRs registradas pela empresa do usuário autenticado, da mais recente para a mais antiga, sem as que estão na lixeira.

taxId filtra por parte do CPF ou CNPJ do emitente. next vale true quando a página veio cheia, o que indica que pode haver mais CPRs.

Cada item traz o valor, o valor já pago em amount_partial e o status de pagamento em payment_status:

vazio quando não há registro de pagamento;

processando enquanto o último registro aguarda processamento;

pagamento-parcial ou pagamento-completo conforme o total pago;

pagamento-atrasado quando o último registro é de inadimplência.

A baixa automática não muda o status: a CPR continua sendo cobrada.

Para CPR vencida, custody_cost traz os créditos da próxima cobrança mensal de custódia; para as demais, vem null.

summary traz os totais de todas as CPRs da empresa, independentemente da página: overdue_count é a quantidade de CPRs vencidas sem pagamento total, e monthly_custody_total é a soma do custody_cost dessas CPRs.

available_download indica que o registro da CPR foi concluído e o documento pode ser baixado.

Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200

application/json

CPRs da empresa

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/cpr/list?page=1&taxId=11222333' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "items":  [
                  {
                      "_id":  "3f2b8c1e-0000-4000-8000-00000000c001",
                      "tax_id":  "11222333000181",
                      "due_date":  "2027-03-31T03:00:00.000Z",
                      "request_date":  "2026-09-28T12:00:00.000Z",
                      "value":  250000.5,
                      "url_document":  "https://files.example.com/cpr/cpr-fazenda-exemplo.pdf",
                      "cpr_type":  "fisica",
                      "payment_status":  "pagamento-parcial",
                      "amount_partial":  100000,
                      "client_id":  "7c9e6679-7425-40de-944b-e07fc1f90ae7",
                      "available_download":  true,
                      "client_name":  "Fazenda Exemplo Ltda",
                      "custody_cost":  null
                  },
                  {
                      "_id":  "3f2b8c1e-0000-4000-8000-00000000c002",
                      "tax_id":  "11222333000181",
                      "due_date":  "",
                      "request_date":  "2026-09-20T15:30:00.000Z",
                      "value":  80000,
                      "url_document":  "https://files.example.com/cpr/cpr-fazenda-exemplo-2.pdf",
                      "cpr_type":  "financeira",
                      "payment_status":  "",
                      "amount_partial":  0,
                      "client_id":  "7c9e6679-7425-40de-944b-e07fc1f90ae7",
                      "client_name":  "Fazenda Exemplo Ltda",
                      "custody_cost":  null
                  }
              ],
    "next":  false,
    "summary":  {
                    "overdue_count":  3,
                    "monthly_custody_total":  42
                }
}

Modificado em 2026-10-22 17:20:53

Página anterior

Registrar CPR Ag em rascunho ou com erro

Próxima página

Enviar documento de CPR Ag para análise automática