Clickfin

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

Obter conta a receber

Retorna os dados de uma conta a receber específica da empresa autenticada. Para contas avulsas, inclui editPermissions, que informa os campos liberados conforme os boletos e NFS-e vinculados ao vencimento. Documentos com status deleted não bloqueiam edição nem nova emissão.

AcessoChave de API · receivables:read
Parâmetros1
Respostas7

Parâmetros

  • accountReceivableIdpath

    Identificador da conta a receber.

Respostas

200Sucesso

Registro retornado com sucesso.

400Erro

Erro de validação nos parâmetros da consulta.

401Erro

Token ausente, inválido ou sem empresa selecionada.

403Erro

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).

404Erro

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.