NF-e
Consultar NF-e
Retorna status, dados da nota e links de download do DANFE / XML.
/openapi/v2/empresas/{empresaId}/nf-e/{nfeId}token, timestamp e sign, veja Autenticação.nfeId é o id enviado na emissão. A resposta ecoa a requisição de emissão com a mesma forma, mais os dados que a SEFAZ devolveu. Erros de autenticação (10009xxx) estão em Autenticação.
Parâmetros de caminho
empresaId* | string | Identificador da empresa |
nfeId* | string | Identificador da nota |
* Campo obrigatório
id | string | Identificador da requisição |
tipo | string | Tipo do documento |
status | string | Status da nota |
motivoStatus | string | Motivo da negativa |
ambienteEmissao | string | Ambiente |
enviadaPorEmail | bool | Enviada por e-mail |
dataCriacao | string | Data de aceitação |
dataUltimaAlteracao | string | Última alteração |
forcarEmissaoContingencia | bool | Contingência forçada |
| object | Pedido |
| object | Comprador |
numero | string | Número da nota |
serie | string | Série da nota |
dataEmissao | string | Data de emissão |
chaveAcesso | string | Chave de acesso |
| object | Transporte |
dataAutorizacao | string | Data de autorização |
linkDanfe | string | Link do DANFE |
linkDownloadXml | string | Link do XML autorizado |
linkConsultaPorChaveAcesso | string | Consulta pública |
| object | Protocolo de autorização |
emitidaEmContingencia | bool | Emitida em contingência |
finalidade | string | Finalidade |
naturezaOperacao | string | Natureza da operação |
| object | Nota original |
| array | Itens |
valorTotal | number | Valor total da nota |
informacoesAdicionais | string | Observações da nota |
informacoesAdicionaisFisco | string | Observações ao fisco |
A nota passa por AguardandoAutorizacao até a SEFAZ responder, e termina em Autorizada, Negada ou Cancelada. Nos estados finais a plataforma descarta os parâmetros da requisição: pedido, observações, naturezaOperacao e os parâmetros de imposto além de código e alíquota deixam de vir.
AguardandoAutorizacao: em processamento
Da aceitação até a resposta da SEFAZ. Sem número, chave, protocolo nem links; pedido, cliente e todos os parâmetros de imposto são ecoados como enviados. Consulte de novo ou aguarde o callback.
{"id": "NFe-000014553","status": "AguardandoAutorizacao","numero": null,"chaveAcesso": null,"dataAutorizacao": null,"linkDanfe": null,"linkDownloadXml": null,"pedido": { "presencaConsumidor": "OperacaoPelaInternet", "pagamento": { "tipo": "PagamentoAVista", "formas": [ { "tipo": "CartaoDeCredito", "valor": 28.47 } ] } },"itens": [ { "cfop": "6102", "codigo": "000068", "origem": 0, "impostos": { "icms": { "situacaoTributaria": "102" }, "pis": { "situacaoTributaria": "49", "aliquota": 0 }, "cofins": { "situacaoTributaria": "49", "aliquota": 0 } } } ]}
Autorizada: autorizada pela SEFAZ
Número, chave, dataAutorizacao, protocolo e os dois links preenchidos. Cada consulta gera links novos.
{"id": "NFe-000014553","status": "Autorizada","numero": "262","serie": "2","chaveAcesso": "35241104893402000113550020000002621202427463","dataAutorizacao": "2024-11-27T20:56:55Z","protocolo": { "numero": "135240009194753" },"linkDanfe": "https://api.v2.tffiscal.com/openapi/files/danfe/35241104893402000113550020000002621202427463?token=…","linkDownloadXml": "https://api.v2.tffiscal.com/openapi/files/xml/8801?token=…"}
Negada: recusada pela SEFAZ
motivoStatus traz o código e o motivo da SEFAZ. Sem DANFE; o número, se já alocado, é reaproveitado pelas próximas emissões, sem pular número. Corrija a requisição e emita de novo.
{"id": "NFe-000014553","status": "Negada","motivoStatus": "778 - Rejeicao: NCM inexistente","linkDanfe": null,"linkDownloadXml": null}
Cancelada: cancelada depois de autorizada
Depois de Cancelar NF-e. Número, chave e protocolo permanecem; o DANFE deixa de vir e o XML continua disponível.
{"id": "NFe-000014553","status": "Cancelada","numero": "262","chaveAcesso": "35241104893402000113550020000002621202427463","protocolo": { "numero": "135240009194753" },"linkDanfe": null,"linkDownloadXml": "https://api.v2.tffiscal.com/openapi/files/xml/8801?token=…"}
linkDanfe e linkDownloadXml têm o formato https://api.v2.tffiscal.com/openapi/files/{kind}/{ref}?token=… e dispensam cabeçalhos de assinatura: um GET simples que siga o redirecionamento 302 basta. Cada consulta emite links novos; um link expirado retorna 401 + 10009036. Validade e demais erros estão em Download de arquivos.
statusStatus da nota
| Valores | Significado |
|---|---|
| AguardandoAutorizacao | Aceita, aguardando resposta da SEFAZ |
| Autorizada | Autorizada pela SEFAZ; DANFE e XML disponíveis |
| Negada | Recusada pela SEFAZ; motivo em motivoStatus |
| Cancelada | Cancelada depois de autorizada |
ambienteEmissaoAmbiente de emissão
| Valores | Significado |
|---|---|
| Homologacao | Ambiente de teste da SEFAZ; a nota não tem validade |
| Producao | Ambiente oficial |
finalidadeFinalidade da nota
| Valores | Significado |
|---|---|
| Normal | Venda comum |
| Complementar | Nota complementar de uma nota já autorizada |
| Ajuste | Nota de ajuste de uma nota já autorizada |
| Devolucao | Devolução de uma nota já autorizada; traz notaReferenciada |
pedido.presencaConsumidorPresença do comprador
| Valores | Significado |
|---|---|
| NaoSeAplica | Não se aplica; devolução |
| OperacaoPresencial | Venda presencial na loja |
| OperacaoPelaInternet | Venda pela internet |
| OperacaoPorTelefone | Venda por telefone |
| EntregaEmDomicilio | Venda fechada na entrega em domicílio |
| OperacaoPresencialForaDoEstabelecimento | Venda presencial fora da loja |
| Outros | Outros |
pedido.pagamento.tipoPrazo do pagamento
| Valores | Significado |
|---|---|
| PagamentoAVista | À vista |
| PagamentoAPrazo | A prazo |
pedido.pagamento.formas[].tipoForma de pagamento
| Valores | Significado |
|---|---|
| Dinheiro | Dinheiro |
| Cheque | Cheque |
| CartaoDeCredito | Cartão de crédito |
| CartaoDeDebito | Cartão de débito |
| CreditoLoja | Crédito na loja |
| ValeAlimentacao | Vale-alimentação |
| ValeRefeicao | Vale-refeição |
| ValePresente | Vale-presente |
| ValeCombustivel | Vale-combustível |
| BoletoBancario | Boleto bancário |
| DepositoBancario | Depósito bancário |
| PagamentoInstantaneoPix | Pix |
| TransferenciaBancaria | Transferência bancária |
| ProgramaDeFidelidade | Programa de fidelidade ou cashback |
| PagamentoInstantaneoPixEstatico | Pix estático |
| CreditoEmLoja | Saldo em loja |
| PagamentoEletronicoNaoInformado | Pagamento eletrônico não informado |
| PagamentoInstantaneoPixAutomatico | Pix automático |
| TransferenciaTefBookTransfer | Transferência TEF no mesmo banco |
| SemPagamento | Sem pagamento; devolução |
| PagamentoPosterior | Pagamento posterior |
| Outros | Outros |
cliente.indicadorContribuinteICMSSituação do comprador perante o ICMS
Depois do estado final só ContribuinteICMS (CNPJ com inscrição estadual) ou NaoContribuinte.
| Valores | Significado |
|---|---|
| ContribuinteICMS | Contribuinte com inscrição estadual |
| ContribuinteIsento | Isento de inscrição estadual |
| NaoContribuinte | Não contribuinte |
cliente.tipoPessoaTipo de comprador
| Valores | Significado |
|---|---|
| F | Pessoa física; CPF de 11 dígitos |
| J | Pessoa jurídica; CNPJ de 14 dígitos |
cliente.endereco.ufEstado do comprador
EX só em nota de exportação.
| Valores | Significado |
|---|---|
| AC | Acre |
| AL | Alagoas |
| AP | Amapá |
| AM | Amazonas |
| BA | Bahia |
| CE | Ceará |
| DF | Distrito Federal |
| ES | Espírito Santo |
| GO | Goiás |
| MA | Maranhão |
| MT | Mato Grosso |
| MS | Mato Grosso do Sul |
| MG | Minas Gerais |
| PA | Pará |
| PB | Paraíba |
| PR | Paraná |
| PE | Pernambuco |
| PI | Piauí |
| RJ | Rio de Janeiro |
| RN | Rio Grande do Norte |
| RS | Rio Grande do Sul |
| RO | Rondônia |
| RR | Roraima |
| SC | Santa Catarina |
| SP | São Paulo |
| SE | Sergipe |
| TO | Tocantins |
| EX | Exterior (nota de exportação) |
transporte.frete.modalidadeModalidade do frete
| Valores | Significado |
|---|---|
| SemFrete | Sem frete |
| PorContaDoEmitente | Frete por conta do vendedor |
| PorContaDoDestinatario | Frete por conta do comprador |
| PorContaDeTerceiros | Frete por conta de terceiros |
| TransporteProprioPorContaDoRemetente | Transporte próprio do vendedor |
| TransporteProprioPorContaDoDestinatario | Transporte próprio do comprador |
itens[].origemOrigem do produto
| Valores | Significado |
|---|---|
| 0 | Nacional |
| 1 | Importado diretamente |
| 2 | Importado, comprado no mercado interno |
| 3 | Nacional com mais de 40 % de conteúdo importado |
| 4 | Nacional por processo produtivo básico |
| 5 | Nacional com até 40 % de conteúdo importado |
| 6 | Importado diretamente, sem similar nacional |
| 7 | Importado do mercado interno, sem similar nacional |
| 8 | Nacional com mais de 70 % de conteúdo importado |
itens[].impostos.icms.situacaoTributariaCST do ICMS (regime normal, CRT 2 / 3)
| Valores | Significado |
|---|---|
| 00 | Tributada integralmente |
| 02 | Monofásica própria (combustíveis) |
| 10 | Tributada com cobrança de ST |
| 15 | Monofásica própria e com retenção (combustíveis) |
| 20 | Com redução de base de cálculo |
| 30 | Isenta ou não tributada, com cobrança de ST |
| 40 | Isenta |
| 41 | Não tributada |
| 50 | Suspensão |
| 51 | Diferimento |
| 53 | Monofásica com diferimento (combustíveis) |
| 60 | ICMS cobrado anteriormente por ST |
| 61 | Monofásica cobrada anteriormente (combustíveis) |
| 70 | Com redução de base e cobrança de ST |
| 90 | Outras |
itens[].impostos.icms.situacaoTributariaCSOSN do ICMS (Simples Nacional, CRT 1 / 4)
| Valores | Significado |
|---|---|
| 101 | Tributada com permissão de crédito |
| 102 | Tributada sem permissão de crédito |
| 103 | Isenção por faixa de receita bruta |
| 201 | Tributada com permissão de crédito e cobrança de ST |
| 202 | Tributada sem permissão de crédito e com cobrança de ST |
| 203 | Isenção por faixa de receita, com cobrança de ST |
| 300 | Imune |
| 400 | Não tributada |
| 500 | ICMS cobrado anteriormente por ST |
| 900 | Outros |
itens[].impostos.pis.situacaoTributariaCST do PIS
| Valores | Significado |
|---|---|
| 01 | Tributável à alíquota básica |
| 02 | Tributável à alíquota diferenciada |
| 03 | Tributável por quantidade |
| 04 | Monofásico, revenda a alíquota zero |
| 05 | Substituição tributária |
| 06 | Alíquota zero |
| 07 | Isenta |
| 08 | Sem incidência (exportação) |
| 09 | Suspensão |
| 49 | Outras operações de saída |
| 50–56 | Entrada com direito a crédito, por tipo de receita (só devolução) |
| 60–66 | Entrada com crédito presumido, por tipo de receita (só devolução) |
| 67 | Crédito presumido, outras operações (só devolução) |
| 70 | Entrada sem direito a crédito |
| 71 | Entrada com isenção |
| 72 | Entrada com suspensão |
| 73 | Entrada a alíquota zero |
| 74 | Entrada sem incidência |
| 75 | Entrada por substituição tributária |
| 98 | Outras operações de entrada |
| 99 | Outras operações |
itens[].impostos.cofins.situacaoTributariaCST da COFINS
Mesma tabela do PIS.
| Valores | Significado |
|---|---|
| 01 | Tributável à alíquota básica |
| 02 | Tributável à alíquota diferenciada |
| 03 | Tributável por quantidade |
| 04 | Monofásico, revenda a alíquota zero |
| 05 | Substituição tributária |
| 06 | Alíquota zero |
| 07 | Isenta |
| 08 | Sem incidência (exportação) |
| 09 | Suspensão |
| 49 | Outras operações de saída |
| 50–56 | Entrada com direito a crédito, por tipo de receita (só devolução) |
| 60–66 | Entrada com crédito presumido, por tipo de receita (só devolução) |
| 67 | Crédito presumido, outras operações (só devolução) |
| 70 | Entrada sem direito a crédito |
| 71 | Entrada com isenção |
| 72 | Entrada com suspensão |
| 73 | Entrada a alíquota zero |
| 74 | Entrada sem incidência |
| 75 | Entrada por substituição tributária |
| 98 | Outras operações de entrada |
| 99 | Outras operações |
itens[].impostos.ipi.situacaoTributariaCST do IPI
| Valores | Significado |
|---|---|
| 00 | Entrada com recuperação de crédito |
| 01 | Entrada tributada a alíquota zero |
| 02 | Entrada isenta |
| 03 | Entrada não tributada |
| 04 | Entrada imune |
| 05 | Entrada com suspensão |
| 49 | Outras entradas |
| 50 | Saída tributada |
| 51 | Saída tributada a alíquota zero |
| 52 | Saída isenta |
| 53 | Saída não tributada |
| 54 | Saída imune |
| 55 | Saída com suspensão |
| 99 | Outras saídas |
| Código | HTTP | |
|---|---|---|
| 10004000 | 404 | O nfeId não existe. Verifique o id enviado na emissão e o empresaId. |
| 10004001 | 404 | O nfeId não existe. Verifique o id enviado na emissão e o empresaId. |
| 10003000 | 404 | empresaId não existe ou não pertence a esta aplicação. |
