Clickfin

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

Listar notas de serviço

Retorna a lista de notas de serviço da empresa autenticada. Cada item contém historyData, o contexto fiscal não secreto preservado no momento da criação da NFS-e. A grid deve usar esse snapshot para os valores históricos, inclusive historyData.invoice.number para o número fiscal, sem usar cadastros atuais como fallback. Requer perfil de administrador. limit=0 retorna todos os itens em uma única resposta, com totalPages: 0.

AcessoChave de API · service_invoices:read
Parâmetros5
Respostas5

Parâmetros

  • pagequery

    Página (base 1).

  • limitquery

    Itens por página. `0` retorna todos os itens (`totalPages` = 0).

  • statusquery

    Filtra pelo status da NFS-e.

  • createdAtStartquery

    Data inicial inclusiva da Data de Emissão (`createdAt`), no formato YYYY-MM-DD e interpretada em America/Sao_Paulo.

  • createdAtEndquery

    Data final inclusiva da Data de Emissão (`createdAt`), no formato YYYY-MM-DD e interpretada em America/Sao_Paulo.

Respostas

200Sucesso

Lista retornada 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.