Clickfin

Referência da API
Portal oficial
PUT/contract/{contractId}

Atualiza um contrato existente

Atualiza os campos editáveis de um contrato existente pelo ID, permitindo atualização parcial. O campo status é somente leitura e não pode ser alterado manualmente. Quando os indicadores de emissão automática de boleto ou NFS-e forem true, a empresa deve ter ativado e salvo a configuração correspondente.

AcessoChave de API · contracts:write
Parâmetros1
Respostas9

Parâmetros

  • contractIdpath

    ID do contrato (24 caracteres hexadecimais)

Respostas

200Sucesso

Contrato atualizado com sucesso

400Erro

Erro de validação ou indisponibilidade de emissão automática na atualização do contrato

401Erro

Não autorizado - token ausente ou inválido, ou a empresa da sessão foi excluída ou deixou de pertencer ao licenciado no momento da gravação (CONTRACT.UPDATE.NOT_AUTHORIZED).

403Erro

Proibido - acesso negado

404Erro

Contrato não encontrado

409Erro

Conflito com o estado atual do contrato: cobranças ou documentos já vinculados às parcelas ou ao modo recorrente/não recorrente alterados, redução do número de parcelas (não permitida; exclua e recrie o contrato) ou alteração concorrente por outra requisição (recarregue o contrato e tente novamente).

429Erro

Limite de requisições excedido (RATE_LIMIT.EXCEEDED). Por chave: 120 requisições por minuto (janela fixa de 60 s); o 429 da chave traz X-RateLimit-* da chave. Por IP, para tráfego com chave: 600 requisições em 10 minutos; esse 429 traz só Retry-After, sem X-RateLimit-* (os cabeçalhos descrevem apenas o limite da chave). Aguarde Retry-After segundos antes de tentar de novo.

500Erro

Erro interno no servidor

503Erro

Credencial não pôde ser verificada por falha temporária do servidor (AUTH.SESSION_UNAVAILABLE). Não invalida a chave nem a sessão: repita com backoff.