TF Fiscal
Documentação

NF-e

Consultar NF-e

Retorna status, dados da nota e links de download do DANFE / XML.

GET/openapi/v2/empresas/{empresaId}/nf-e/{nfeId}

Requer os cabeçalhos de assinatura token, timestamp e sign, veja Autenticação.

nfeId é o id enviado na emissão. Ids desconhecidos retornam HTTP 404 + NFe0001. Erros de autenticação (10009xxx) estão em Autenticação.

Parâmetros

Parâmetros de caminho

  • empresaIdstringobrigatório

    Identificador da empresa devolvido em Registrar empresa.

    Exemplo: 1934811222334455
  • nfeIdstringobrigatório

    O id enviado na emissão.

    Exemplo: NFe-000014553

Respostas

200

Nota encontrada.

  • idstring

    Id da requisição de emissão.

  • tipostring

    Sempre NF-e.

  • statusstring

    AguardandoAutorizacao em processamento / Autorizada autorizada / Negada negada / Cancelada cancelada.

    Valores:AguardandoAutorizacaoAutorizadaNegadaCancelada
  • motivoStatusstring

    Motivo da negativa: código de status da SEFAZ + descrição, por exemplo 778 - Rejeicao: NCM inexistente; presente somente em Negada.

  • ambienteEmissaostring

    Homologacao / Producao.

  • enviadaPorEmailboolean

    Sempre false (a plataforma não envia notas por e-mail).

  • dataCriacaostring

    Momento em que a requisição de emissão foi aceita, ISO-8601 UTC.

  • dataUltimaAlteracaostring

    Última atualização.

  • forcarEmissaoContingenciaboolean

    Sempre false.

  • pedidoobject

    Dados do pedido.

  • clienteobject

    Dados do cliente.

  • numerostring

    Número da nota nNF (string).

  • seriestring

    Série.

  • dataEmissaostring

    Momento da emissão.

  • chaveAcessostring

    Chave de acesso de 44 dígitos.

  • transporteobject

    Transporte.

  • dataAutorizacaostring

    Momento da autorização na SEFAZ; vazio até autorizar.

  • linkDanfestring

    Link de download do DANFE em PDF, somente Autorizada; o primeiro download dispara a renderização. Veja Download de arquivos.

  • linkDownloadXmlstring

    Link de download do XML autorizado, quando existe um XML. Veja Download de arquivos.

  • linkConsultaPorChaveAcessostring

    Sempre a string vazia.

  • protocoloobject

    Protocolo de autorização.

  • emitidaEmContingenciaboolean

    Se foi emitida em contingência.

  • finalidadestring

    Finalidade da nota ecoada: Normal / Devolucao.

  • notaReferenciadaobject

    Notas de devolução ecoam a chave de acesso da nota original.

  • itensarray

    Itens da nota.

  • valorTotalnumber

    Total da nota.

  • informacoesAdicionaisstring

    Informações adicionais, não fornecidas no momento.

  • informacoesAdicionaisFiscostring

    Informações adicionais para o fisco, não fornecidas no momento.

Erros

CódigoHTTP
NFe0001404

O nfeId não existe. Verifique o id enviado na emissão e o empresaId.

10003000404

empresaId não existe ou não pertence a esta aplicação.

Semântica dos status

AguardandoAutorizacao da aceitação até a resposta da SEFAZ; Autorizada depois de autorizada; Negada quando rejeitada (motivoStatus explica o motivo: corrija e reenvie); Cancelada após um cancelamento bem-sucedido.

Links de download (`linkDanfe` / `linkDownloadXml`)

Os links 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, renderização sob demanda do DANFE e os demais erros estão em Download de arquivos.

AnteriorEmitir NF-ePróximoCancelar NF-e