Clickfin

Referência da API
Portal oficial
GET/service-invoice/{serviceInvoiceId}/error

Consultar erro da NFS-e

Retorna os detalhes do último erro associado à NFS-e usando o identificador interno da nota no ClickFin. Para exibir o motivo ao usuário, use data.providerCode e data.providerReason (ou a lista data.rejections); data.message é técnica. data é null quando a nota não tem erro. Requer perfil de administrador.

AcessoChave de API · service_invoices:read
Parâmetros1
Respostas5

Parâmetros

  • serviceInvoiceIdpath

    Sem descrição disponível.

Respostas

200Sucesso

Erro retornado com sucesso.

401Erro

Token ausente, inválido ou sem empresa selecionada.

403Erro

Falha de autorizaçã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.