Documentos

Lista notas fiscais

Lista paginada por cursor, com filtros combináveis.

get/v1/documents

Request

  • Base URL: https://api.sudrel.com.br/api
  • URL: https://api.sudrel.com.br/api/v1/documents
  • Auth: HTTP bearer

Query parameters

cnpjsstring

Um ou vários CNPJs separados por vírgula. Ausente = todos os CNPJs da conta.

situacao'AUTORIZADA' | 'CANCELADA' | 'SUBSTITUIDA'
papel'RECEBIDA' | 'EMITIDA' | 'FORA_DE_ESCOPO'

RECEBIDA = a empresa é a tomadora do serviço; EMITIDA = a empresa é a prestadora. FORA_DE_ESCOPO existe no filtro, mas não aparece nas listas: é o documento em que a empresa não é nenhuma das duas partes, que também não conta na franquia.

Ausente = respeita o escopo de monitoramento configurado em cada empresa.

prestadorstring

Filtra por CNPJ/CPF ou nome do prestador (contém, sem diferenciar maiúsculas).

numerostring

Número da nota (contém).

chaveAcessostring
valorMinCentavosinteger
valorMaxCentavosinteger
dataIniciostring date-time

Filtra por data de emissão (ISO 8601), início do intervalo.

dataFimstring date-time

Filtra por data de emissão (ISO 8601), fim do intervalo.

tipoDocumento'NFSE' | 'NFE' | 'CTE'

Sem ele, a lista mistura NFS-e, NF-e e CT-e.

ordenarPor'dataEmissao' | 'recebidaEm'

dataEmissao (padrão) ou recebidaEm (o que a Sudrel capturou por último; uma NFS-e pode chegar hoje com data de emissão de dias atrás).

cicloCobranca'atual'

atual: só os documentos cobrados no ciclo atual de Recebidas. Ignora a data de emissão: o ciclo conta pela chegada.

cursorstring

proximoCursor da página anterior (hoje, o id do último item). Guarde e devolva sem interpretar.

limiteinteger

Response

OK

proximoCursorstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.