NFC-e

Consultar nota fiscal

Consulta o status da NFC-e diretamente na SEFAZ e reconcilia o resultado no Spedy.

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

Nota marcada como Rejeitada no Spedy mas que consta autorizada na SEFAZ.
Nota cujo acompanhamento automático pós-envio esgotou as tentativas (a SEFAZ 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 NFC-e (GET /v1/consumer-invoices/{id}) — retorna o status atual da nota sem acionar a SEFAZ. 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 à SEFAZ), o endpoint responde HTTP 400 — aguarde o processamento. Só há status a consultar depois que a nota foi enviada à autoridade.

post/v1/consumer-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/consumer-invoices/{id}/check-status
Auth: API key in header X-Api-Key

Path parameters

idstring uuid required

Response

idstring uuid

ID da NF

integrationIdstring nullable

ID de integração

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

model'productInvoice' | 'consumerInvoice' | 'serviceInvoice'

Valores possíveis: <ul> <li>productInvoice: NF-e</li> <li>consumerInvoice: NFC-e</li> <li>serviceInvoice: NFS-e</li> </ul>

environmentType'production' | 'development' | 'simulation'

Valores possíveis: <ul> <li>production: Produção</li> <li>development: Homologação</li> <li>simulation: </li> </ul>

issuedOnstring date-time nullable

Data de emissão [dhEmi]

effectiveDatestring date-time nullable

Data usada como emissão da nota. Após a emissão, tem o mesmo valor de issuedOn.

amountnumber double

Valor total da NF

numberinteger nullable

Número

isFromApiboolean

Emitida via API pública

accessKeystring nullable

seriesstring nullable

operationType'incoming' | 'outgoing'

Tipo de operação da nota fiscalValores possíveis:

<ul> <li>incoming: Entrada</li> <li>outgoing: Saída</li> </ul>

Formato de impressão do DANFEValores possíveis:

<ul> <li>none: Sem geração de DANFE</li> <li>portrait: Retrato (orientação vertical)</li> <li>landscape: Paisagem (orientação horizontal)</li> <li>simplified: Simplificado</li> <li>consumerInvoice: DANFE NFC-e (cupom fiscal eletrônico)</li> <li>electronicMessage: Mensagem eletrônica</li> </ul>

Valores possíveis: <ul> <li>normal: Normal</li> <li>complement: Complemento</li> <li>adjustment: Ajustamento</li> <li>devolution: Devolução</li> <li>credit: Crédito</li> <li>debit: Débito</li> </ul>

Tipo de Nota de Débito — NT 2025.002 Reforma TributáriaValores possíveis:

<ul> <li>creditTransferToCooperatives: Transferência de créditos para Cooperativas</li> <li>creditReversalForExemptOrImmuneOutputs: Anulação de crédito por saídas imunes/isentas</li> <li>unprocessedInvoiceDebitInAssessment: Débitos de notas fiscais não processadas na apuração</li> <li>penaltyAndInterest: Multa e juros</li> <li>creditTransferBySuccession: Transferência de crédito de sucessão</li> <li>advancePayment: Pagamento antecipado</li> <li>inventoryLoss: Perda em estoque</li> <li>simplesNacionalExclusion: Desenquadramento do Simples Nacional</li> </ul>

Tipo de Nota de Crédito — NT 2025.002 Reforma TributáriaValores possíveis:

<ul> <li>finesAndInterest: Multa e juros</li> <li>appropriation: Apropriação de crédito presumido de IBS sobre o saldo devedor na ZFM (art. 450, § 1º, LC 214/25)</li> <li>returnByFullRefusal: Retorno por recusa total na entrega ou por não localização do destinatário na tentativa de entrega</li> <li>amountReduction: Redução de valores</li> <li>creditTransferBySuccession: Transferência de crédito na sucessão</li> <li>returnByPartialRefusal: Retorno por recusa parcial na entrega</li> </ul>

govOperationType'supply' | 'receipt'

Tipo de operação com o ente governamental — NT 2025.002 Reforma TributáriaValores possíveis:

<ul> <li>supply: Fornecimento</li> <li>receipt: Recebimento do pagamento, conforme fato gerador do IBS/CBS (Art. 10 § 2º)</li> </ul>

authorizedPersonsstring[] nullable

issueType'normal' | 'offLine'

Forma de emissão da NFC-e [tpEmis]. Definida pela Spedy conforme o estado de contingência da UF no momento da emissão — o padrão é normal. Use principalmente para ler, na consulta da nota, se ela saiu em contingência.Valores possíveis:

<ul> <li>normal: Emissão normal, direto na SEFAZ da UF</li> <li>offLine: Contingência off-line — a nota é assinada e transmitida depois que a SEFAZ volta</li> </ul>

Changes

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