Skip to main content
GET
Listar NFS-e Recebidas

Authorizations

X-Api-Key
string
header
required

Authorization By X-Api-Key inside request's header

Query Parameters

accessKey
string

Filtra pela chave de acesso da NFS-e (50 dígitos).

status
enum<string>[]

Filtra pela situação da nota no Ambiente de Dados Nacional. Aceita múltiplos valores.

Valores possíveis:

  • authorized: Nota autorizada no Ambiente de Dados Nacional.
  • canceled: Nota cancelada pelo prestador do serviço.
Available options:
authorized,
canceled
manifestationStatus
enum<string>

Filtra pelo status de manifestação do tomador.

Valores possíveis:

  • none: Nenhuma manifestação registrada ainda para a nota.
  • confirmed: O tomador confirmou a operação.
  • rejected: O tomador rejeitou a operação.
Available options:
none,
confirmed,
rejected
role
enum<string>

Filtra pelo papel da sua empresa na nota.

Valores possíveis:

  • recipient: Sua empresa é a tomadora do serviço.
  • intermediary: Sua empresa é a intermediária da operação.
Available options:
recipient,
intermediary
environmentType
enum<string>

Ambiente das notas (produção ou homologação). Opcional — se omitido, retorna notas de todos os ambientes.

Valores possíveis:

  • production: Produção
  • development: Homologação
  • simulation:
Available options:
production,
development,
simulation
initialDate
string<date-time>

Data de emissão inicial do período (inclusive).

endDate
string<date-time>

Data de emissão final do período (inclusive).

cursor
string

Envie o nextCursor recebido na resposta anterior para obter a próxima página. Vazio ou ausente retorna a primeira. Não interprete o conteúdo: o formato pode mudar sem aviso.

limit
integer<int32>

Quantidade de itens por página (padrão 20, máximo 200).

Response

OK

Resposta de listagem paginada por cursor. Substitui o padrão de offset (page/pageSize/totalCount): em vez de pedir uma página por número, o cliente devolve o GetNotas.Application.Model.CursorPage`1.NextCursor recebido na requisição anterior.

items
object[] | null

Itens da página atual.

nextCursor
string | null

Cursor para a próxima página; envie-o no parâmetro cursor da próxima requisição. Nulo quando não há mais páginas.

hasNext
boolean

Indica se há mais páginas a buscar.