NFS-e

Obter NFS-e

Retorna a nota pelo id, com o status atual e o resultado do último processamento (processingDetail). Use para acompanhar o status quando não usa webhooks.

get/v1/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/service-invoices/{id}
  • Auth: API key in header X-Api-Key

Path parameters

idstring uuid required

Response

OK

idstring uuid

ID da NF

integrationIdstring nullable

ID de integração

status'created' | 'enqueued' | 'received' | 'authorized' | 'inContingent' | 'rejected' | 'canceled' | 'denied' | 'removed' | 'disabled'
<p>Valores possíveis:</p> <ul> <li><b>created</b>: Criada — aguarda emissão explícita via issue ou gatilho automático (ex: afterPayment)</li> <li><b>enqueued</b>: Enfileirada para processamento junto à SEFAZ ou Prefeitura</li> <li><b>received</b>: Recebido</li> <li><b>authorized</b>: Autorizado</li> <li><b>inContingent</b>: Em contingência</li> <li><b>rejected</b>: Rejeitado</li> <li><b>canceled</b>: Cancelado</li> <li><b>denied</b>: Denegado</li> <li><b>removed</b>: Removido</li> <li><b>disabled</b>: Inutilizado</li> </ul>
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>
issuedOnstring date-time nullable

Data e hora em que a emissão foi solicitada

effectiveDatestring date-time nullable

Data de competência

amountnumber double

Valor total da NF

numberinteger nullable

Número

isFromApiboolean

Emitida via API pública

descriptionstring nullable
nbsCodestring nullable
nationalTaxationCodestring nullable
batchNumberinteger nullable

Changes

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