Registrar aditivo de CPR de um cliente

POST

/cpr/additive/{clientId}

Solicita o registro de um aditivo a uma CPR do cliente. Informe em cprId a CPR alterada, em multipleSelection quais partes da CPR o aditivo altera (marque true em pelo menos uma), em textInformation a descrição das alterações e em urlDocument o endereço do documento do aditivo já enviado. O aditivo é gravado e segue para processamento; a resposta 201 indica que a solicitação foi aceita, não que o aditivo já foi registrado. multipleSelection ausente ou sem nenhuma parte marcada, textInformation ausente e documento ausente devolvem 400; a falta de textInformation vem com a mensagem dentro de um array a mais. CPR inexistente devolve 500. Só aceita clientes vinculados à empresa do usuário autenticado: cliente inexistente devolve 404, e cliente de outra empresa devolve 401. 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

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201

application/json

Aditivo solicitado

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Dados do aditivo inválidos

🟠404Registro de CPR indisponível

🔴500CPR não encontrada

Request Example

Shell

JavaScript

Java

Swift

curl --location '/cpr/additive/7c9e6679-7425-40de-944b-e07fc1f90ae7' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "cprId": "3f2b8c1e-0000-4000-8000-00000000c001",
    "taxId": "11222333000181",
    "multipleSelection": {
        "cprData": true,
        "parcelData": true
    },
    "textInformation": "Alteração do vencimento da segunda parcela para 30/06/2027.",
    "urlDocument": "https://files.example.com/cpr/aditivo-fazenda-exemplo.pdf"
}'

Response Example

201 - Sucesso

{
    "message": "Additive registered successfully"
}

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

Página anterior

Registrar cessão de CPR de um cliente

Próxima página

Registrar cessão de CPR Ag de um cliente