Atualizar status da conta a receber
Atualiza o status de uma conta a receber da empresa autenticada e de suas parcelas na mesma transação: ambas as alterações são confirmadas ou revertidas juntas. Contas excluídas logicamente não podem ser reativadas por esta operação e retornam 404. Uma alteração concorrente que invalide o status lido retorna 409, sem aplicar parcialmente a alteração. Os valores de status são enviados em letras maiúsculas.
PAID ("Definir como Pago") registra o pagamento em cada parcela que ainda não estava paga: amountPaid recebe amountDue quando a parcela não tinha valor pago (nulo ou 0) e paymentDate recebe a data de hoje (00:00 em America/Sao_Paulo) quando não havia data; valor e data já registrados (por exemplo, por liquidação de boleto) são mantidos, e parcela já paga não é alterada. Ao sair de PAID para PENDING, OVERDUE ou CANCELED, as parcelas voltam a amountPaid 0 e paymentDate nulo; a auditoria guarda os valores anteriores.
receivables:writeParâmetros
- accountReceivableIdpath
Identificador da conta a receber.
Respostas
Status atualizado com sucesso.
Erro de validação nos parâmetros da consulta.
Token ausente, inválido ou sem empresa selecionada.
A chave foi reconhecida, mas não pode fazer esta chamada: API_KEY.SCOPE_REQUIRED (falta o escopo; details.requiredScope diz qual), API_KEY.ROUTE_NOT_ALLOWED (rota fora da API pública), API_KEY.IP_NOT_ALLOWED (IP fora da lista da chave), API_KEY.PLAN_NOT_ALLOWED (plano sem acesso à API) ou BILLING.COMMERCIAL.ACCESS_BLOCKED (licença bloqueada).
Conta a receber inexistente, fora da empresa autenticada ou excluída logicamente.
O status foi alterado por outra requisição antes da gravação.
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.
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.