Skip to main content
GET
Obter NFS-e Recebida

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>

Identificador da nota recebida no Spedy.

model
enum<string>

Valores possíveis:

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

Valores possíveis:

  • production: Produção
  • development: Homologação
  • simulation:
Available options:
production,
development,
simulation
accessKey
string | null

Chave de acesso da NFS-e.

nsu
integer<int64>

NSU do documento na distribuição do Ambiente de Dados Nacional (rastreio).

isComplete
boolean

Sempre verdadeiro na NFS-e: o Ambiente de Dados Nacional entrega o documento autoritativo de uma só vez, sem etapa de resumo como na NF-e.

status
enum<string>

Valores possíveis:

  • authorized: Nota autorizada no Ambiente de Dados Nacional.
  • canceled: Nota cancelada pelo prestador do serviço.
Available options:
authorized,
canceled
issuer
object
issuedOn
string<date-time>

Data de emissão da nota.

amount
number<double>

Valor total da nota.

number
integer<int64> | null

Número sequencial da NFS-e no Ambiente de Dados Nacional (nNFSe).

serviceDescription
string | null

Descrição do serviço prestado (DPS/infDPS/serv/cServ/xDescServ).

role
enum<string>

Valores possíveis:

  • recipient: Sua empresa é a tomadora do serviço.
  • intermediary: Sua empresa é a intermediária da operação.
Available options:
recipient,
intermediary
manifestation
object
events
object[] | null

Eventos vinculados à nota (cancelamento, a própria manifestação, etc.).

creationTime
string<date-time>

Data em que a nota foi detectada/criada no Spedy.

lastModificationTime
string<date-time> | null

Data da última atualização da nota.