NFeDistribuicaoDFe: Consulta de DF-e e Regras da NT 2014.002
Explore o Web Service NFeDistribuicaoDFe: consulte DF-e, informações fiscais para emitentes, destinatários e mais. Conheça as regras da NT 2014.002 e otimize sua gestão fiscal.
NFeDistribuicaoDFe: Consulta de DF-e e Regras da NT 2014.002
O Web Service NFeDistribuicaoDFe disponibiliza informações e documentos fiscais eletrônicos (DF-e) de interesse para os participantes do processo da Nota Fiscal Eletrônica (NF-e). Seu objetivo é oferecer um método eficiente e confiável para acesso a dados fiscais. Este serviço é regulamentado pela Nota Técnica 2014.002 v1.20, atualizada em maio de 2024.
O serviço permite que pessoas físicas ou jurídicas consultem DF-e e informações resumidas que não foram gerados por elas, mas são de seu interesse fiscal. Para acessá-lo, é necessário possuir um certificado digital de Pessoa Jurídica (PJ) ou Pessoa Física (PF).
NFeDistribuicaoDFe: Funções e Atores
O serviço NFeDistribuicaoDFe distribui documentos e informações. Ele pode ser consumido por qualquer ator da NF-e, seja PJ ou PF, desde que possua um certificado digital. Empresas são autenticadas pelo CNPJ base (8 primeiros dígitos), podendo realizar consultas para qualquer CNPJ (14 dígitos) desde que o CNPJ base consultado seja o mesmo do certificado digital.
Os documentos fiscais e informações resumidas ficam disponíveis para distribuição por até 90 dias após a recepção pelo Ambiente Nacional da NF-e.
Os atores com permissão para acessar o serviço incluem:
* Emitentes (identificados no grupo do Emitente, tag: emit)
* Destinatários (identificados no grupo do Destinatário, tag: dest)
* Transportadores (identificados no grupo do Transportador, tag: transporta)
* Terceiros autorizados (informados no grupo de pessoas físicas autorizadas a acessar o XML, tag: autXML)
* CNPJs informados no evento "Ator Interessado"
A disponibilidade dos documentos varia conforme o papel do interessado. O destinatário, por exemplo, terá acesso à NF-e integral somente após registrar uma manifestação ("Ciência da Operação", "Operação não Realizada" ou "Confirmação de Operação"). Antes disso, apenas o resumo da NF-e é retornado. Transportadores e terceiros têm acesso à NF-e integral de imediato.
A tabela de documentos e eventos distribuídos para cada ator é a seguinte:
| Documentos | Emitente | Destinatário | Transportador | Terceiros | CNPJ informado em evento 'Ator Interessado' |
|---|---|---|---|---|---|
| NF-e | Não | Sim | Sim | Sim | Sim |
| Evento de Cancelamento | Não | Sim | Sim | Sim | Sim |
| Evento de Carta de Correção | Não | Sim | Sim | Sim | Sim |
| Eventos de Manifestação do Destinatário | Sim | Não | Não | Sim | Não |
| Eventos da Suframa (Vistoria/Internalização) | Sim | Sim | Não | Sim | Não |
| EPEC | Não | Sim | Sim | Não | Sim |
| Eventos de Pedido de Prorrogação de Prazo | Não | Sim | Não | Não | Não |
| Eventos do Fisco em Resposta ao Pedido de Prorrogação | Sim | Sim | Não | Não | Não |
| Evento de Averbação | Sim | Sim | Sim | Sim | Sim |
| Resumo de NF-e | Não | Sim | Não | Não | Não |
| Resumo de Eventos CT-e Autorizado/Cancelado | Sim | Sim | Sim | Sim | Sim |
| Resumo de Eventos MDF-e Autorizado/Cancelado | Sim | Sim | Sim | Sim | Sim |
| Resumo de Eventos de Registro de Passagem | Sim | Sim | Sim | Sim | Sim |
| Evento de Comprovante de Entrega propagado do CT-e | Sim | Sim | Sim | Sim | Sim |
| Evento de Comprovante de Entrega na NF-e e Cancelamento | Não | Sim | Sim | Sim | Sim |
A partir da versão 1.13 da Nota Técnica, eventos gerados pelo Fisco são distribuídos ao emitente, mesmo que o destinatário seja o mesmo e independentemente de sua manifestação.
Tipos de Consulta e Operação
O serviço NFeDistribuicaoDFe suporta três tipos de consultas, definidas pela tag informada no XML de requisição: distNSU, consNSU e consChNFe. Para todas elas, o Ambiente Nacional gera um Número Sequencial Único (NSU) para cada interessado nos documentos fiscais.
distNSU: Distribuição por Número Sequencial Único
Esta consulta permite que a aplicação cliente informe o último NSU recebido (tag: ultNSU). O Ambiente Nacional retorna um lote de até 50 documentos (NF-e e eventos) disponíveis a partir desse NSU. Se o NSU informado for zero ou muito antigo, a consulta retorna as informações resumidas e documentos fiscais eletrônicos recepcionados pelo Ambiente Nacional nos últimos 90 dias. A geração de NSU considera apenas usuários do serviço nos últimos 60 dias. Para novos usuários ou aqueles que ficaram mais de 60 dias sem consultar, a geração de NSU é retomada a partir do primeiro acesso, sem retroatividade.
consNSU: Consulta Específica por NSU
Usada para consultar um DF-e de maneira pontual, a partir de um NSU específico que foi identificado como faltante na base de dados do interessado. O Ambiente Nacional retorna um único documento fiscal (NF-e ou evento) referente ao NSU informado.
consChNFe: Consulta por Chave de Acesso da NF-e
Permite consultar uma NF-e específica pela sua chave de acesso. A chave deve ser válida, existir no Ambiente Nacional e estar vinculada ao interessado como destinatário, transportador ou terceiro. Esta consulta retorna apenas a NF-e, sem os eventos relacionados. Desde a versão 1.15 da Nota Técnica, esta consulta não exige a geração prévia de NSU para o documento fiscal consultado.
Para qualquer tipo de consulta, os documentos estão disponíveis apenas se recebidos pelo Ambiente Nacional nos últimos 90 dias. Após esse período, a recuperação da NF-e não é possível.
Estrutura das Mensagens XML
As mensagens trocadas com o Web Service seguem uma estrutura XML definida.
Leiaute de Mensagem de Entrada
A mensagem de entrada, encapsulada na tag distDFeInt, contém o pedido de distribuição de DF-e. Campos importantes incluem:
* versao: Versão do leiaute.
* tpAmb: Identificação do ambiente (1=Produção, 2=Homologação).
* cUFAutor: Código da UF do autor.
* CNPJ ou CPF: CNPJ ou CPF do interessado no DF-e.
* Tags de consulta: distNSU, consNSU ou consChNFe, conforme o tipo de solicitação.
Leiaute de Mensagem de Retorno
A mensagem de retorno, na tag retDistDFeInt, contém os documentos de interesse do ator. Pode retornar um máximo de 50 documentos. Campos relevantes incluem:
* versao: Versão do leiaute.
* tpAmb: Ambiente (Produção ou Homologação).
* cStat: Código do status da resposta (ex: 137 para "Nenhum documento localizado", 138 para "Documento(s) localizado(s)", 656 para "Consumo Indevido").
* xMotivo: Descrição literal do status.
* dhResp: Data e hora da resposta.
* ultNSU: Último NSU pesquisado no Ambiente Nacional.
* maxNSU: Maior NSU existente para o CNPJ/CPF informado.
* loteDistDFeInt: Conjunto de informações resumidas e documentos fiscais.
* docZip: Informação resumida ou documento fiscal eletrônico, compactado no padrão Gzip (tag com atributos NSU e schema).
Mensagem de Retorno Compactada
Para otimizar a infraestrutura de rede, cada documento na mensagem de retorno é compactado individualmente no padrão Gzip (tag: docZip). Estima-se que essa compactação reduza o tamanho da mensagem em aproximadamente 60%. A aplicação cliente deve descompactar o conteúdo para tratamento.
Validações do Web Service
O Web Service NFeDistribuicaoDFe aplica diversas validações para garantir a segurança e a integridade das operações.
Validação de Certificado de Transmissão
O certificado digital utilizado na transmissão é rigorosamente validado, incluindo:
* Verificação da validade e existência do certificado.
* Validação da cadeia de certificação (AC emissora, revogação).
* Acesso à Lista de Certificados Revogados (LCR).
* Conformidade com a ICP-Brasil como certificado raiz.
* Existência da extensão de CNPJ ou CPF no certificado.
Validação Inicial da Mensagem no Web Service
A mensagem é validada quanto ao seu formato e tamanho:
* Tamanho do XML de dados não pode exceder 10 KB (código de erro 214).
* Verificação do status de operação do servidor (código de erro 108 ou 109 se o serviço estiver paralisado).
Validação da Área de Dados
A estrutura e o conteúdo da área de dados da mensagem também são verificados:
* Conformidade com o Schema XML (código de erro 215).
* Não uso de prefixo no namespace (código de erro 404).
* Codificação XML deve ser UTF-8 (código de erro 402).
* Versão dos dados deve ser compatível (códigos de erro 238, 239).
Validação de Regras de Negócio
Regras específicas de negócio são aplicadas, incluindo:
* Ambiente informado deve ser o mesmo do Web Service (código de erro 252).
* Validade do CNPJ ou CPF do interessado (códigos de erro 489, 490).
* O CNPJ-base do certificado digital deve corresponder ao CNPJ consultado (código de erro 593).
* O CPF do certificado digital deve ser o mesmo do CPF consultado (código de erro 472).
* NSU informado não pode ser superior ao maior NSU disponível (código de erro 589).
* Chave de acesso da NF-e deve ser válida em todos os seus componentes (DV, UF, ano, mês, CNPJ, modelo, número) e a NF-e deve existir (códigos de erro 236, 614, 615, 616, 617, 618, 619, 217).
* A NF-e deve estar dentro do prazo de 90 dias para download (código de erro 632).
* Verificação de permissão de consulta do interessado para a NF-e (código de erro 640).
* NF-e não deve ser disponibilizada para o emitente da própria NF-e (código de erro 641).
* NF-e Cancelada ou Denegada não permite download do arquivo integral (códigos de erro 653, 654).
Leiautes Resumidos de Documentos
Para permitir o compartilhamento de informações relevantes com sigilo, foram criados leiautes resumidos da NF-e e de eventos.
Resumo da NF-e (resNFe)
Esta estrutura XML contém informações resumidas da NF-e, geradas quando a NF-e é autorizada ou denegada. É distribuída para destinatários, permitindo a manifestação da operação. Campos incluem: Chave de Acesso, CNPJ/CPF e Razão Social do Emitente, Inscrição Estadual, Data de Emissão, Tipo de Operação, Valor Total da NF-e, Digest Value, Data de Autorização e Número de Protocolo.
Resumo de Evento da NF-e (resEvento)
Esta estrutura XML contém informações resumidas de um evento de NF-e. Campos incluem: Código do Órgão de recepção, CNPJ/CPF do Emitente, Chave de Acesso da NF-e, Data e Hora do Evento, Tipo e Sequencial do Evento, Descrição do Evento, Data de Autorização e Número de Protocolo do Evento.
Modelo de Distribuição e Fluxo de NSU
O modelo de distribuição de documentos é baseado na geração de um Número Sequencial Único (NSU) para cada CNPJ ou CPF. Esse NSU é organizado cronologicamente pela ordem de recepção dos documentos fiscais pelo Ambiente Nacional.
Um fluxo de exemplo demonstra como os NSUs são gerados para emitente e destinatário:
1. Emitente transmite uma NF-e, que é autorizada e compartilhada com o Ambiente Nacional.
2. O Ambiente Nacional gera um NSU para o destinatário do resumo da NF-e.
3. O destinatário consulta o NFeDistribuicaoDFe usando o último NSU e recupera o resumo.
4. O destinatário gera um evento de manifestação.
5. O Ambiente Nacional gera um NSU do evento para o emitente.
6. Se for um evento de manifestação que não seja "desconhecimento da operação", o Ambiente Nacional gera um NSU para o destinatário com a NF-e completa (liberando o download).
7. O emitente consulta o NFeDistribuicaoDFe e recupera o evento do destinatário.
8. O destinatário consulta o NFeDistribuicaoDFe e recupera a NF-e completa.
9. O emitente gera um evento de sua NF-e (ex: cancelamento).
10. O Ambiente Nacional gera um NSU para o destinatário do evento do emitente.
11. O destinatário consulta o NFeDistribuicaoDFe e recupera o evento do emitente.
12. O Ambiente Nacional recebe um evento do Fisco, gerando NSUs para emitente e destinatário.
13. Ambos consultam e recuperam o evento do Fisco.
Esse modelo simplifica o download da NF-e, pois a manifestação do destinatário aciona automaticamente a geração de um NSU referenciando a NF-e para sua recuperação.
Prevenção ao Uso Indevido
O Web Service NFeDistribuicaoDFe implementa controles para evitar o "Consumo Indevido", caracterizado por tentativas excessivas ou inadequadas de consulta. As tentativas enquadradas como uso indevido resultam na rejeição com o código 656.
Há duas situações principais de uso indevido para a consulta com a tag distNSU:
* Ausência de documentos a distribuir: Se o sistema retornar cStat=137 (Nenhum documento localizado), o usuário deve aguardar uma hora antes de realizar uma nova consulta. Tentar novamente dentro desse período resultará em "Consumo Indevido" e bloqueio do CNPJ por uma hora.
* Consulta não sequencial de NSU: O usuário deve sempre utilizar o ultNSU retornado na consulta anterior para as requisições subsequentes. Consultas fora da sequência correta resultam em bloqueio do CNPJ por uma hora. Se o ultNSU for igual ao maxNSU, significa que não há mais documentos a serem recuperados e, nesse caso, deve-se aguardar uma hora para novas consultas.
Para as consultas com consChNFe e consNSU, o uso indevido ocorre se o número de consultas exceder o limite de 20 por hora. Ao atingir o limite, o CNPJ é bloqueado por uma hora. Em qualquer caso de "Consumo Indevido" (cStat=656), se a consulta for retomada antes de completar uma hora, o contador de tempo é zerado e reinicia.
Endereços e Códigos de Erro
Os endereços dos Web Services de Distribuição do Ambiente Nacional são publicados no Portal Nacional da NF-e (http://www.nfe.fazenda.gov.br/portal) e no Portal de Homologação (http://hom.nfe.fazenda.gov.br/portal), no menu 'Serviços' / 'Relação de Serviços Web'.
A tabela de códigos de erros e descrições de mensagens de erros é abrangente, auxiliando na identificação e resolução de problemas. Alguns exemplos incluem:
* 108: Serviço Paralisado Momentaneamente.
* 137: Nenhum documento localizado.
* 214: Tamanho da mensagem excedeu o limite estabelecido.
* 280: Certificado Transmissor inválido.
* 489: CNPJ informado inválido.
* 632: Solicitação fora de prazo, NF-e não está mais disponível.
* 656: Consumo Indevido.
Conclusão
O Web Service NFeDistribuicaoDFe, conforme detalhado na Nota Técnica 2014.002, é um recurso central para a gestão fiscal eletrônica. Ele oferece aos emitentes, destinatários, transportadores e terceiros uma forma padronizada e segura de acessar documentos fiscais eletrônicos e eventos. A compreensão das regras de consulta, dos leiautes de mensagens e das validações, incluindo as de uso indevido, é necessária para otimizar a interação com o Ambiente Nacional da NF-e e garantir o cumprimento das obrigações fiscais.