Listar CPRs de um cliente (detalhado)

GET

/queries/clients/{clientId}/cpr/{queryId}/detailed

Lista as CPRs registradas de um cliente numa consulta, com resumo (quantidade, valor total, vencidas e inadimplentes) e o detalhe de cada uma: datas de emissão, registro e vencimento, tipo, produtos e garantias. Traz também a URL do arquivo gerado (documentUrl). Só retorna dados de clientes vinculados à empresa do usuário autenticado. 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 Caminho

Parâmetros Header

Respostas

🟢200

application/json

Harvested 200

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/queries/clients/CLIENT_ID/cpr/QUERY_ID/detailed' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "requestStatus": "Processada",
    "completedAt": "2025-10-15T10:00:00.000Z",
    "documentUrl": "https://storage.example/cpr.xlsx",
    "resume": {
        "cprsCount": 1,
        "totalValue": 150000.75,
        "cprsOverdue": 0,
        "totalValueOverdue": 0,
        "cprsDefaultCount": 0,
        "totalValueDefault": 0
    },
    "items": [
        {
            "cercPublicidadeCprsId": "string",
            "issueDate": "2025-01-20T00:00:00Z",
            "registerDate": "2025-10-15T10:00:00Z",
            "dueDate": "2026-01-20T00:00:00Z",
            "typeCpr": "financeira",
            "financialValue": 150000.75,
            "product": "SOJA",
            "numberControl": "CPR-TEST-001",
            "status": "Ativo",
            "origin": "CERC",
            "isOverdue": false,
            "isDefault": false,
            "issueTaxId": "***********",
            "issueName": "PRODUTOR RURAL ATIVO",
            "registerId": "CPR-TEST-001",
            "transactionDate": "2025-01-20T00:00:00Z",
            "totalValue": 150000.75,
            "indexing": null,
            "percIndexing": null,
            "emitters": [
                {
                    "taxId": "***********",
                    "name": "PRODUTOR RURAL ATIVO"
                }
            ],
            "products": [
                {
                    "culture": "SOJA",
                    "volume": 5000,
                    "unit": "SC",
                    "packaginForm": "A GRANEL",
                    "harvest": "2025/2026"
                }
            ],
            "guarantees": [
                {
                    "type": "Sem Garantia",
                    "description": null,
                    "constitutionProcessIndicator": null
                }
            ]
        }
    ]
}

Modificado em 2026-10-13 09:47:06

Página anterior

Exportar CPRs de um cliente (Excel)

Próxima página

Visualizar detalhes de uma CPR