NF-e
Obter NF-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/product-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/product-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 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 fiscal<p>Valores possíveis:</p>
<ul> <li><b>incoming</b>: Entrada</li> <li><b>outgoing</b>: Saída</li> </ul>printingType'none' | 'portrait' | 'landscape' | 'simplified' | 'consumerInvoice' | 'electronicMessage'
Formato de impressão do DANFE<p>Valores possíveis:</p>
<ul> <li><b>none</b>: Sem geração de DANFE</li> <li><b>portrait</b>: Retrato (orientação vertical)</li> <li><b>landscape</b>: Paisagem (orientação horizontal)</li> <li><b>simplified</b>: Simplificado</li> <li><b>consumerInvoice</b>: DANFE NFC-e (cupom fiscal eletrônico)</li> <li><b>electronicMessage</b>: Mensagem eletrônica</li> </ul>purposeType'normal' | 'complement' | 'adjustment' | 'devolution' | 'credit' | 'debit'
<p>Valores possíveis:</p>
<ul>
<li><b>normal</b>: Normal</li>
<li><b>complement</b>: Complemento</li>
<li><b>adjustment</b>: Ajustamento</li>
<li><b>devolution</b>: Devolução</li>
<li><b>credit</b>: Crédito</li>
<li><b>debit</b>: Débito</li>
</ul>
debitType'creditTransferToCooperatives' | 'creditReversalForExemptOrImmuneOutputs' | 'unprocessedInvoiceDebitInAssessment' | 'penaltyAndInterest' | 'creditTransferBySuccession' | 'advancePayment' | 'inventoryLoss' | 'simplesNacionalExclusion'
Tipo de Nota de Débito — NT 2025.002 Reforma Tributária<p>Valores possíveis:</p>
<ul> <li><b>creditTransferToCooperatives</b>: Transferência de créditos para Cooperativas</li> <li><b>creditReversalForExemptOrImmuneOutputs</b>: Anulação de crédito por saídas imunes/isentas</li> <li><b>unprocessedInvoiceDebitInAssessment</b>: Débitos de notas fiscais não processadas na apuração</li> <li><b>penaltyAndInterest</b>: Multa e juros</li> <li><b>creditTransferBySuccession</b>: Transferência de crédito de sucessão</li> <li><b>advancePayment</b>: Pagamento antecipado</li> <li><b>inventoryLoss</b>: Perda em estoque</li> <li><b>simplesNacionalExclusion</b>: Desenquadramento do Simples Nacional</li> </ul>creditType'finesAndInterest' | 'appropriation' | 'returnByFullRefusal' | 'amountReduction' | 'creditTransferBySuccession' | 'returnByPartialRefusal'
Tipo de Nota de Crédito — NT 2025.002 Reforma Tributária<p>Valores possíveis:</p>
<ul> <li><b>finesAndInterest</b>: Multa e juros</li> <li><b>appropriation</b>: Apropriação de crédito presumido de IBS sobre o saldo devedor na ZFM (art. 450, § 1º, LC 214/25)</li> <li><b>returnByFullRefusal</b>: Retorno por recusa total na entrega ou por não localização do destinatário na tentativa de entrega</li> <li><b>amountReduction</b>: Redução de valores</li> <li><b>creditTransferBySuccession</b>: Transferência de crédito na sucessão</li> <li><b>returnByPartialRefusal</b>: Retorno por recusa parcial na entrega</li> </ul>govOperationType'supply' | 'receipt'
Tipo de operação com o ente governamental — NT 2025.002 Reforma Tributária<p>Valores possíveis:</p>
<ul> <li><b>supply</b>: Fornecimento</li> <li><b>receipt</b>: Recebimento do pagamento, conforme fato gerador do IBS/CBS (Art. 10 § 2º)</li> </ul>authorizedPersonsstring[] nullable
issueType'normal' | 'svcan' | 'svcrs'
Forma de emissão da NF-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.<p>Valores possíveis:</p>
<ul> <li><b>normal</b>: Emissão normal, direto na SEFAZ da UF</li> <li><b>svcan</b>: Contingência SVC-AN — SEFAZ Virtual de Contingência do Ambiente Nacional</li> <li><b>svcrs</b>: Contingência SVC-RS — SEFAZ Virtual de Contingência do Rio Grande do Sul</li> </ul>Changes
No recorded changes to this operation across all 1 revision of this API.