Skip to main content
GET
Listar NF-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 NF-e (44 dígitos).

status
enum<string>[]

Filtra pela situação da nota na SEFAZ (Authorized, Denied, Canceled). Aceita múltiplos valores.

Valores possíveis:

  • authorized: Nota autorizada na SEFAZ.
  • denied: Nota denegada pela SEFAZ (emitente com pendência cadastral ou tributária).
  • canceled: Nota cancelada pelo emitente.
Available options:
authorized,
denied,
canceled
manifestationStatus
enum<string>

Filtra pelo status de manifestação do destinatário.

Valores possíveis:

  • none:
  • acknowledged:
  • confirmed:
  • unknown:
  • notPerformed:
  • rejected:
Available options:
none,
acknowledged,
confirmed,
unknown,
notPerformed,
rejected
operationType
enum<string>

Filtra pelo tipo de operação (tpNF) na ótica do emitente. Tipo de operação da nota fiscal

Valores possíveis:

  • incoming: Entrada
  • outgoing: Saída
Available options:
incoming,
outgoing
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.