NFS-e Recebidas

Obter NFS-e Recebida

Retorna os dados completos de uma nota recebida: emissor com endereço, a manifestação registrada e todos os eventos vinculados à nota, como cancelamento e a própria manifestação.

get/v1/inbound-service-invoices/{id}

Request

  • Base URL: https://api.spedy.com.br (the document declares no server; this is the origin it was published from)
  • URL: https://api.spedy.com.br/v1/inbound-service-invoices/{id}
  • Auth: API key in header X-Api-Key

Path parameters

idstring uuid required

Response

OK

idstring uuid

Identificador da nota recebida no Spedy.

model'productInvoice' | 'consumerInvoice' | 'serviceInvoice'
<p>Valores possíveis:</p> <ul> <li><b>productInvoice</b>: NF-e</li> <li><b>consumerInvoice</b>: NFC-e</li> <li><b>serviceInvoice</b>: NFS-e</li> </ul>
environmentType'production' | 'development' | 'simulation'
<p>Valores possíveis:</p> <ul> <li><b>production</b>: Produção</li> <li><b>development</b>: Homologação</li> <li><b>simulation</b>: </li> </ul>
accessKeystring nullable

Chave de acesso da NFS-e.

nsuinteger

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

isCompleteboolean

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'authorized' | 'canceled'
<p>Valores possíveis:</p> <ul> <li><b>authorized</b>: Nota autorizada no Ambiente de Dados Nacional.</li> <li><b>canceled</b>: Nota cancelada pelo prestador do serviço.</li> </ul>
issuedOnstring date-time

Data de emissão da nota.

amountnumber double

Valor total da nota.

numberinteger nullable

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

serviceDescriptionstring nullable

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

role'recipient' | 'intermediary'
<p>Valores possíveis:</p> <ul> <li><b>recipient</b>: Sua empresa é a tomadora do serviço.</li> <li><b>intermediary</b>: Sua empresa é a intermediária da operação.</li> </ul>
creationTimestring date-time

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

lastModificationTimestring date-time nullable

Data da última atualização da nota.

Changes

No recorded changes to this operation across all 1 revision of this API.