NFS-e

Consultar nota fiscal

Consulta o status da NFS-e diretamente na prefeitura e reconcilia o resultado no Spedy.

Use esta consulta para reconciliar uma nota cujo status no Spedy pode estar desatualizado em relação à prefeitura:

  • Nota marcada como Rejeitada no Spedy mas que consta autorizada na prefeitura.
  • Nota cujo acompanhamento automático pós-envio esgotou as tentativas (a prefeitura demorou a processar) e ficou travada — a consulta destrava o processamento.

Para apenas acompanhar o status (polling): se você não usa webhooks e precisa verificar o status periodicamente, use Obter NFS-e (GET /v1/service-invoices/{id}) — retorna o status atual da nota sem acionar a prefeitura. Reserve este check-status para os casos de reconciliação/destrave acima.

Quando NÃO usar: não serve para "furar a fila" e forçar a emissão na hora. Enquanto a nota está enfileirada para emissão (ainda não enviada à prefeitura), o endpoint responde HTTP 400 — aguarde o processamento. Só há status a consultar depois que a nota foi enviada à autoridade.

post/v1/service-invoices/{id}/check-status

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}/check-status
  • 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.