Skip to main content
POST
Consultar nota fiscal

Authorizations

X-Api-Key
string
header
required

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

Path Parameters

id
string<uuid>
required

Response

OK

id
string<uuid>

ID da NF

integrationId
string | null

ID de integração

status
enum<string>

Status

Valores possíveis:

  • created: Criada — aguarda emissão explícita via issue ou gatilho automático (ex: afterPayment)
  • enqueued: Enfileirada para processamento junto à SEFAZ ou Prefeitura
  • received: Recebido
  • authorized: Autorizado
  • inContingent: Em contingência
  • rejected: Rejeitado
  • canceled: Cancelado
  • denied: Denegado
  • removed: Removido
  • disabled: Inutilizado
Available options:
created,
enqueued,
received,
authorized,
inContingent,
rejected,
canceled,
denied,
removed,
disabled
model
enum<string>

Modelo

Valores possíveis:

  • productInvoice: NF-e
  • consumerInvoice: NFC-e
  • serviceInvoice: NFS-e
Available options:
productInvoice,
consumerInvoice,
serviceInvoice
environmentType
enum<string>

Ambiente

Valores possíveis:

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

Data e hora em que a emissão foi solicitada

effectiveDate
string<date-time> | null

Data de competência

receiver
object | null

Cliente

company
object | null

Empresa

order
object | null

Dados da venda

authorization
object | null

Dados da autorização

cancellation
object | null

Dados do cancelamento

amount
number<double>

Valor total da NF

number
integer<int64> | null

Número

processingDetail
object | null

Detalhes do processamento

isFromApi
boolean

Emitida via API pública

description
string | null
totals
object | null
rps
object | null
location
object | null
ibsCbs
object | null
nbsCode
string | null
nationalTaxationCode
string | null
batchNumber
integer<int32> | null
approximateTaxes
object | null