Skip to main content
GET
Listar eventos da NFS-e

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 do evento (usado em /events/{eventId}/xml).

type
enum<string>

Tipo do evento (ex.: authorization, cancellation, correctionLetter).

Valores possíveis:

  • authorization: Autorização
  • rejection: Rejeição
  • cancellation: Cancelamento
  • denegation: Denegação
  • contingency: Contingência
  • received: Recebimento
  • error: Falha
  • correctionLetter: Carta de correção
  • creation: Criado
  • confirmOperation: Confirmação da operação
  • awareOperation: Ciência da operação
  • unawareOperation: Desconhecimento da operação
  • operationNotPerformed: Operação não realizada
  • disablement: Inutilização
  • accessKeyChanged: Chave de acesso alterada
  • enqueued: Enfileirado
  • emailSent: Email enviado
Available options:
authorization,
rejection,
cancellation,
denegation,
contingency,
received,
error,
correctionLetter,
creation,
confirmOperation,
awareOperation,
unawareOperation,
operationNotPerformed,
disablement,
accessKeyChanged,
enqueued,
emailSent
date
string<date-time>

Data do evento.

protocol
string | null

Protocolo devolvido pela autoridade fiscal, quando houver.

code
string | null

Código devolvido pela autoridade fiscal.

message
string | null

Mensagem devolvida pela autoridade fiscal.

hasXml
boolean

Indica se o evento tem XML disponível em /events/{eventId}/xml.