Alterar valores do contrato
PATCH /leads/{idApplication}/contract/values
Define o aluguel, o condomínio e o IPTU de um contrato originado por você. O escopo vem do seu token: só é possível alterar 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. Um contrato ainda sem endosso ou já encerrado responde409.
Path params
| Param | Tipo | Obrigatório | Regras |
|---|---|---|---|
idApplication | string | Sim | Identificador do lead, como em GET /leads. |
Corpo
{
"rentalAmount": 2500.00,
"condominiumAmount": 600.00,
"iptuAmount": 150.00
}| Campo | Tipo | Obrigatório | Regras |
|---|---|---|---|
rentalAmount | number | Sim | Aluguel mensal. Maior que zero, até 2 casas decimais. |
condominiumAmount | number | Sim | Condomínio mensal. Maior ou igual a zero, até 2 casas decimais. |
iptuAmount | number | Sim | IPTU mensal. Maior ou igual a zero, até 2 casas decimais. |
Os três valores substituem os atuais. Envie sempre os três, inclusive os que não mudaram. Cada valor aceita no máximo 10 dígitos inteiros e 2 decimais. Não há valor máximo definido para o aluguel.
Sucesso — 204 No Content
Sem corpo. Um 204 significa que os valores foram aceitos. Para conferir, consulte GET /leads?idApplication= (6.4): o aluguel aparece em rentAmount.
Contrato de outro parceiro. Um
idApplicationque não existe e um que pertence a outro parceiro recebem a mesma resposta (404), para que não seja possível descobrir contratos de terceiros.
Erros mapeados
| HTTP | code | Quando ocorre |
|---|---|---|
| 400 | Erro de validação | Campo ausente, negativo, com mais de 2 casas decimais ou mais de 10 dígitos inteiros, ou rentalAmount igual a zero. details[] aponta o campo. |
| 400 | CONTRACT_VALUES_INVALID | Os valores foram recusados como inválidos. Revise-os antes de reenviar. |
| 403 | CONTRACT_VALUES_PARTNER_NOT_AUTHORIZED | Quem chama não tem identidade de parceiro ativa. |
| 404 | CONTRACT_NOT_FOUND | Não há lead com esse idApplication entre os seus. |
| 409 | CONTRACT_VALUES_CONFLICT | O contrato já foi encerrado, ainda não tem endosso ativo, ou recusou a alteração pelo estado atual. A mensagem diz qual caso ocorreu. |
| 422 | CONTRACT_VALUES_REJECTED | As regras de negócio do contrato recusaram a alteração. |
| 500 | CONTRACT_VALUES_INTEGRATION_FAILURE | Falha ou indisponibilidade ao processar o pedido. Pode repetir após alguns segundos, com backoff. |
Updated about 17 hours ago
