Clickfin

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

Consultar NFS-e

Retorna os dados persistidos da NFS-e usando o identificador interno da nota no ClickFin, inclusive quando a emissão está com erro. historyData representa o contexto fiscal não secreto salvo no momento da criação, incluindo historyData.invoice.number quando o número fiscal estiver disponível. Requer perfil de administrador e respeita a empresa e o licenciado da sessão.

AcessoChave de API · service_invoices:read
Parâmetros1
Respostas7

Parâmetros

  • serviceInvoiceIdpath

    Sem descrição disponível.

Respostas

200Sucesso

NFS-e retornada com sucesso.

400Erro

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

401Erro

Token ausente, inválido ou sem empresa selecionada.

403Erro

Falha de autorização.

404Erro

NFS-e não encontrada para a empresa selecionada.

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.