Calcular custo de registro de CPR

POST

/cpr/cost

Calcula, sem debitar nada, quantos créditos custa registrar uma CPR do cliente. O custo depende do valor da CPR e do prazo até o vencimento, com mínimo de 10 créditos; sem dueDate, o custo é o mínimo. A resposta traz o custo em credits, o momento do cálculo em requestDate e o ID e a razão social do cliente encontrado pelo taxId. É o mesmo custo debitado em Registrar CPR de um cliente. taxId é o CPF ou CNPJ do cliente, só dígitos, e precisa ser o de um cliente ativo da empresa do usuário autenticado. taxId ausente, cliente não encontrado e valor menor ou igual a zero devolvem 404; dueDate inválida devolve 400. 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 Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Custo calculado

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Data de vencimento inválida

🟠404Cliente não encontrado ou valor inválido

Request Example

Shell

JavaScript

Java

Swift

curl --location '/cpr/cost' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "taxId": "11222333000181",
    "value": 250000.5,
    "dueDate": "2027-03-31T03:00:00.000Z"
}'

Response Example

200 - Sucesso

{
    "credits": 105,
    "requestDate": "2026-09-28T12:00:00.000Z",
    "clientId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "clientName": "FAZENDA EXEMPLO LTDA"
}

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

Página anterior

Registrar CPR Ag

Próxima página

Registrar CPR Ag em rascunho ou com erro