Encerrar contrato
PATCH /leads/{idApplication}/contract/closing
Encerra um contrato originado por você, informando o motivo e, opcionalmente, uma data de encerramento retroativa. O escopo vem do seu token: só é possível encerrar contratos da sua própria produção.
Pré-requisito. O contrato precisa estar com o endosso ativo:
applicationStatusigual aENDORSEMENT_RECEIVEDeclosingDatevazia. Confira os dois campos emGET /leads?idApplication=(6.4) antes de chamar. OapplicationStatusé um conjunto aberto de valores: trate defensivamente qualquer valor que você não conheça.
Path params
| Param | Tipo | Obrigatório | Regras |
|---|---|---|---|
idApplication | string | Sim | Identificador do lead, como em GET /leads. |
Corpo
{
"closeReason": "Rescisão amigável",
"retroactiveDate": "2026-10-15"
}| Campo | Tipo | Obrigatório | Regras |
|---|---|---|---|
closeReason | string | Sim | Texto livre. Não pode ser vazio nem conter só espaços. |
retroactiveDate | string (yyyy-MM-dd) | Não | Data de encerramento. Se omitida, o contrato é encerrado na data de hoje. Não pode ser futura nem anterior a 30 dias atrás. |
Janela de 30 dias. O limite acompanha o prazo de sinistro após o encerramento: uma data mais antiga venceria esse prazo de imediato. Hoje e o dia de 30 dias atrás são aceitos; amanhã e 31 dias atrás são recusados. A data é calculada em UTC.
Sucesso — 204 No Content
Sem corpo. O contrato fica com closingDate preenchida em GET /leads.
Encerrar é definitivo pela API. Não há endpoint de reativação exposto ao parceiro. Não repita a chamada ao receber
CONTRACT_CLOSING_ALREADY_CLOSED: o contrato já está encerrado e uma nova tentativa não altera a data.
Chamadas simultâneas. A verificação de contrato já encerrado é feita antes do pedido, sem garantia atômica. Evite enviar duas chamadas em paralelo para o mesmo contrato.
Erros mapeados
| HTTP | code | Quando ocorre |
|---|---|---|
| 400 | Erro de validação | closeReason ausente ou em branco; retroactiveDate fora do formato, futura ou com mais de 30 dias. details[] aponta o campo. |
| 400 | CONTRACT_CLOSING_INVALID_REQUEST | O pedido foi recusado como inválido pelo contrato. Revise os dados antes de reenviar. |
| 403 | CONTRACT_CLOSING_PARTNER_NOT_AUTHORIZED | O contrato não pertence ao seu parceiro. |
| 404 | CONTRACT_CLOSING_NOT_FOUND | O idApplication não corresponde a um contrato existente. |
| 409 | CONTRACT_CLOSING_ALREADY_CLOSED | O contrato já tem data de encerramento. |
| 409 | CONTRACT_CLOSING_STATUS_NOT_ALLOWED | O contrato não está em um estado que permita encerrar (não é ENDORSEMENT_RECEIVED). |
| 422 | CONTRACT_CLOSING_UNPROCESSABLE | As regras de negócio do contrato recusaram o encerramento. |
| 500 | CONTRACT_CLOSING_INTEGRATION_FAILURE | Falha ou indisponibilidade ao processar o pedido. Antes de repetir, confira se o contrato já foi encerrado (closingDate em GET /leads). |
Updated about 17 hours ago
