Exportar CPRs da empresa (Excel)

GET

/cpr/download

Exporta em uma planilha Excel (.xlsx) as CPRs registradas pela empresa do usuário autenticado, da solicitação mais recente para a mais antiga, inclusive as que estão na lixeira. taxId filtra por parte do CPF ou CNPJ do emitente. A planilha tem uma linha por CPR, com data da solicitação, vencimento, dias até o vencimento ou em atraso, valor, tipo, CPF/CNPJ do emitente e status de pagamento. Sem CPRs, a planilha vem só com o cabeçalho. A resposta é 201 com o arquivo para download (Content-Disposition: attachment). 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

🟢201

application/octet-stream

Planilha de CPRs

Headers

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

201 - Sucesso

binary

Modificado em 2026-10-21 19:11:22

Página anterior

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

Próxima página

Cancelar CPR Ag