Clickfin

Referência da API
Portal oficial
PUT/account-receivable/{accountReceivableId}

Editar conta a receber avulsa

Edita parcialmente uma conta a receber avulsa. Sem boleto ou NFS-e associados, os campos financeiros podem ser alterados e ambos os documentos podem ser solicitados. Com um documento associado, somente a observação e a emissão do outro tipo de documento permanecem permitidas. Boletos e NFS-e excluídos logicamente (status deleted) não bloqueiam a edição nem uma nova solicitação do mesmo tipo de documento. Contas automáticas não aceitam esta operação. Um documento solicitado que não pôde ser emitido aparece em documents.bankSlip ou documents.serviceInvoice com status: error e error: { code, message }, sem desfazer a conta. code é a categoria do erro da emissão (por exemplo BANK_SLIP.ISSUE_RECONCILIATION_REQUIRED); um erro sem categoria usa o próprio código ou DOCUMENT_ISSUANCE_FAILED.

AcessoChave de API · receivables:write
Parâmetros1
Respostas8

Parâmetros

  • accountReceivableIdpath

    Identificador da conta a receber.

Respostas

200Sucesso

Conta avulsa atualizada; documentos solicitados podem conter resultado parcial.

400Erro

Erro de validação ou indisponibilidade do documento solicitado.

401Erro

Token ausente, inválido ou sem empresa selecionada.

403Erro

Erro de regra de negócio ou integração.

404Erro

Erro de regra de negócio ou integração.

409Erro

Erro de regra de negócio ou integração.

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.

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.