Listar CPRs de um cliente

GET

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

Devolve o resumo das CPRs do cliente informado em clientId encontradas na consulta de publicidade de CPR informada em queryId (o identificador da consulta, listado por serviço na rota de consultas do cliente). A resposta traz requestStatus, completedAt, documentUrl (arquivo da consulta, quando existe), o resumo em resume e as CPRs em items. As CPRs canceladas não entram. Uma CPR é considerada vencida quando a consulta terminou depois da data de vencimento dela. Em resume, cprsCount e totalValue somam as CPRs que não estão vencidas; cprsOverdue e totalValueOverdue, as vencidas que não são de origem CERC; cprsDefaultCount e totalValueDefault, as vencidas de origem CERC. Quando a solicitação não foi autorizada (requestStatus Não autorizado), a resposta traz items vazio, completedAt vazio e, em resume, só cprsCount e totalValue, ambos 0. Se não existe consulta com o queryId para esse cliente, ou ela ainda não terminou, a resposta é 404 (Consulta não encontrada). Requer autenticação via Bearer JWT ou header x-api-key. O cliente precisa pertencer à empresa do usuário: cliente inexistente devolve 404 (Cliente não encontrado), cliente de outra empresa devolve 401 (Acesso negado) e usuário inativo devolve 404 (Usuário não encontrado).

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

Resumo das CPRs do cliente

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠404Consulta, cliente ou usuário não encontrados

Request Example

Shell

JavaScript

Java

Swift

curl --location '/queries/clients/7c9e6679-7425-40de-944b-e07fc1f90ae7/cpr/3f6b1d2e-8c4a-4b7e-9d1a-5e2c7a9b0f13' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "requestStatus": "Processada",
    "completedAt": "2026-09-18T14:03:10.000Z",
    "documentUrl": "https://files.example.com/cpr.xlsx",
    "resume": {
        "cprsCount": 1,
        "totalValue": 150000.75,
        "cprsOverdue": 0,
        "totalValueOverdue": 0,
        "cprsDefaultCount": 0,
        "totalValueDefault": 0
    },
    "items": [
        {
            "cercPublicidadeCprsId": "466c4908-c23e-4167-90ec-e44bbff4081b",
            "issueDate": "2026-01-20T00:00:00Z",
            "registerDate": "2026-02-10T10:00:00Z",
            "dueDate": "2027-01-20T00:00:00Z",
            "typeCpr": "financeira",
            "financialValue": 150000.75,
            "product": "SOJA",
            "numberControl": 202600123456,
            "status": "Ativo",
            "origin": "CERC",
            "isOverdue": false,
            "isDefault": false
        }
    ]
}

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

Página anterior

Registrar decisão sobre solicitação de consulta de CPR na CERC

Próxima página

Listar solicitações de consulta de CPR na CERC