NFeDistribuicaoDFe: Consulta de NF-e e DF-e para Empresas

O projeto Nota Fiscal Eletrônica (NFe) busca fornecer informações de interesse aos participantes de forma eficiente. Este objetivo é atendido pelo Web Service NFeDistribuicaoDFe, que disponibiliza documentos fiscais eletrônicos (DF-e) e informações resumidas para emitentes, destinatários, transportadores e terceiros envolvidos. A Nota Técnica 2014.002 detalha o funcionamento e os procedimentos para uso deste serviço.

Histórico de atualizações do serviço

A Nota Técnica 2014.002 teve diversas atualizações desde sua versão inicial. Essas revisões incluíram a distribuição de novos eventos, como o Registro de Passagem, Pedido de Prorrogação de Prazo, Comprovante de Entrega e Averbação. Houve também melhorias na consulta, permitindo buscar documentos por chave de acesso da NF-e e otimizações na geração do Número Sequencial Único (NSU) para aprimorar a distribuição.

A versão 1.20, de maio de 2024, introduziu o evento "Ator Interessado". Essas atualizações visam garantir a abrangência e a eficiência do serviço na disponibilização de dados fiscais.

O Web Service NFeDistribuicaoDFe

O Web Service NFeDistribuicaoDFe tem a função de distribuir documentos e informações de interesse dos participantes da NFe. Ele permite que pessoas físicas ou jurídicas acessem DF-e e resumos que não foram gerados por elas, mas que são de seu interesse. Para isso, é necessário possuir um certificado digital de pessoa jurídica (PJ) ou pessoa física (PF).

Acesso e disponibilidade

O acesso para pessoa jurídica é autenticado pelo CNPJ base (os oito primeiros dígitos). É possível realizar consultas para qualquer CNPJ da empresa, desde que o CNPJ base consultado seja o mesmo do certificado digital utilizado. Os documentos fiscais eletrônicos e as informações resumidas ficam disponíveis para distribuição por até 90 dias após sua recepção pelo Ambiente Nacional da NFe.

Para destinatários, o Ambiente Nacional verifica a manifestação da operação ("Ciência da Operação", "Operação não Realizada" ou "Confirmação de Operação"). Se houver manifestação, a NF-e completa é retornada. Caso contrário, apenas o resumo da NF-e é disponibilizado, contendo as informações necessárias para que o destinatário possa se manifestar. Transportadores e terceiros têm acesso integral à NF-e na consulta.

Documentos e eventos distribuídos

A distribuição ocorre para emitentes, destinatários, transportadores e terceiros. A tabela a seguir detalha quais documentos e resumos de eventos são disponibilizados para cada papel:

Documentos ou Eventos	Emitente	Destinatário¹	Transportador²	Terceiros³	CNPJ em '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

• ¹ Os documentos fiscais e resumos de eventos são disponibilizados ao destinatário apenas após a manifestação da operação ("Ciência da Operação", "Operação não Realizada" ou "Confirmação de Operação"), com exceção do Evento de Cancelamento, que é disponibilizado independentemente da manifestação. Antes da manifestação, apenas a estrutura XML de "Resumo de NF-e" e o cancelamento da NF-e ficam disponíveis.
• ² A NF-e está disponível para o transportador identificado no grupo de informações de transporte ou que tenha sido informado no evento 'Ator Interessado na NF-e' (código 110150).
• ³ A NF-e está disponível para terceiros cujo CNPJ ou CPF esteja informado no grupo de pessoas autorizadas a acessar o XML.

A partir da versão 1.13 da Nota Técnica, eventos gerados pelo Fisco são distribuídos ao emitente independentemente da manifestação do destinatário, mesmo que emitente e destinatário sejam a mesma entidade.

Tipos de consulta

O Web Service NFeDistribuicaoDFe suporta três tipos de consultas, definidas pela tag informada no XML de pedido de distribuição: distNSU, consNSU e consChNFe.

Distribuição por NSU (tag distNSU)

Este tipo de consulta permite que a aplicação cliente informe o último Número Sequencial Único (NSU) que possui. O Ambiente Nacional então fornece todos os documentos (NF-e e eventos) disponíveis a partir do NSU informado. Caso o NSU fornecido seja muito antigo ou zero, a consulta retorna documentos recebidos no Ambiente Nacional nos últimos 90 dias. A geração de NSU considera apenas usuários ativos nos últimos 60 dias.

É importante que o solicitante mantenha o controle do primeiro NSU válido, pois não há geração retroativa para novos usuários ou para aqueles que ficam mais de 60 dias sem consultar.

Consulta por NSU específico (tag consNSU)

Este método permite consultar um DF-e específico a partir de um NSU. Ele é útil quando o interessado identifica uma lacuna na sequência de NSUs em sua base de dados. O Ambiente Nacional retorna um único documento fiscal (NF-e ou evento) referente ao NSU informado. Essa consulta também está limitada a documentos recebidos nos últimos 90 dias.

Consulta por chave de acesso da NF-e (tag consChNFe)

Permite consultar uma NF-e pontualmente por sua chave de acesso. A chave informada deve ser válida, existir no Ambiente Nacional e estar vinculada ao interessado como destinatário, transportador ou terceiro. Neste tipo de consulta, o Ambiente Nacional retorna somente a NF-e (sem eventos). A partir da versão 1.15 da Nota Técnica, não é mais necessária a prévia geração de NSU para o documento fiscal consultado. Similar às outras consultas, a disponibilidade é limitada a documentos recebidos nos últimos 90 dias.

Processamento da requisição

O pedido de distribuição é enviado por Web Service, exigindo um certificado digital de pessoa jurídica ou física válido. O Web Service do Ambiente Nacional processa a requisição, que deve seguir os padrões estabelecidos na nota técnica.

Validação do certificado

A validação do certificado de transmissão é um passo inicial. Diversas regras são aplicadas:
* Certificado de Transmissor inválido: Verifica a existência, versão, uso de Basic Constraint, e KeyUsage de "Autenticação Cliente".
* Validade do Certificado: Analisa a data de início e fim da validade.
* Cadeia de Certificação: Verifica o cadastro da AC emissora, revogação da AC e assinatura do certificado.
* LCR do Certificado: Confere a existência do endereço da Lista de Certificados Revogados (LCR), sua disponibilidade e validade.
* Certificado do Transmissor revogado: Verifica se o certificado foi revogado.
* Certificado Raiz: Confirma se o certificado raiz é da "ICP-Brasil".
* Extensão de CNPJ ou CPF: Verifica se o certificado contém a extensão de CNPJ ou CPF.

Muitas dessas validações são realizadas pelo protocolo SSL, e as aplicações geralmente não precisam implementá-las diretamente.

Validação da mensagem e dados

Após a validação do certificado, a mensagem passa por validações iniciais no Web Service e na área de dados:

• Validação inicial da mensagem:
  • O tamanho do XML de dados não pode exceder 10 KB. Mensagens maiores podem ser descartadas.
  • Verificação se o servidor de processamento está temporariamente ou sem previsão paralisado.
• Validação de forma da área de dados:
  • Verificação do Schema XML.
  • Uso de prefixo no namespace.
  • Codificação XML (deve ser UTF-8).
  • Versão dos dados (não pode ser superior ou não suportada).
• Validação de regras de negócio: Inclui checagens como a validade do CNPJ/CPF do interessado, a correspondência entre o CNPJ base do certificado digital e o CNPJ consultado, a validade da chave de acesso da NF-e, o prazo de download (90 dias) e a permissão do interessado para acessar a NF-e.

Mensagem de retorno compactada

Para otimizar o uso da infraestrutura de rede, cada documento na mensagem de retorno é compactado individualmente. O padrão de compactação adotado é o Gzip. Estima-se que essa compactação reduza o tamanho da mensagem em aproximadamente 60%. As aplicações cliente devem descompactar os documentos para processá-los.

Leiautes resumidos

Foram criados leiautes de informações resumidas da NF-e e de eventos para permitir o compartilhamento de dados relevantes, mantendo o sigilo das informações completas.

Resumo da NF-e

O Leiaute Resumo da NF-e é uma estrutura XML gerada pelo Ambiente Nacional contendo um conjunto de informações resumidas da NF-e. Ele é distribuído aos destinatários para que possam se manifestar sobre a operação. Inclui campos como Chave de Acesso, CNPJ/CPF do Emitente, Razão Social, Inscrição Estadual, Data de Emissão, Tipo de Operação, Valor Total da NF-e, Digest Value, Data de Autorização e Situação da NF-e (autorizada, denegada ou cancelada).

Resumo do evento da NF-e

O Leiaute Resumo do Evento da NF-e é uma estrutura XML com informações resumidas de um evento da NF-e. Contém dados como Código do Órgão, CNPJ/CPF do Emitente, Chave de Acesso da NF-e, Data e Hora do Evento, Código e Número Sequencial do Evento, Descrição do Evento, Data de Autorização e Número de Protocolo do Evento.

Visão geral do modelo de distribuição

O modelo de distribuição de documentos é baseado na geração de um Número Sequencial Único (NSU) para cada CNPJ ou CPF. O NSU é gerado em ordem de recepção dos documentos no Ambiente Nacional. O fluxo de distribuição ocorre da seguinte forma:

1. Um 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 e o disponibiliza para consulta.
3. O destinatário consulta o serviço NFeDistribuicaoDFe com o último NSU recebido e recupera o resumo da NF-e.
4. Com o resumo, o destinatário pode gerar um evento de manifestação.
5. O Ambiente Nacional gera um NSU do evento para o emitente.
6. Se a manifestação do destinatário for diferente de "desconhecimento da operação", o Ambiente Nacional gera um NSU para o destinatário com a NF-e completa, liberando o download.
7. Emitente e destinatário consultam o serviço para recuperar os eventos ou a NF-e correspondente.
8. Eventos gerados pelo Fisco também são distribuídos com seus respectivos NSUs para emitente e destinatário.

Este modelo permite ao emitente consultar os eventos manifestados pelos destinatários e ao destinatário acessar eventos gerados pelo emitente ou pelo Fisco.

Uso indevido do serviço

Para evitar a sobrecarga do Ambiente Nacional, há controles para identificar situações de uso indevido. O consumo indevido pode resultar na rejeição da consulta com o código 656-Rejeição: Consumo Indevido e no bloqueio temporário do CNPJ ou CPF por uma hora.

Critérios de uso indevido

Duas situações principais geram o uso indevido na consulta com distNSU:
* Consulta após cStat=137: Se o usuário consulta novamente antes de uma hora após receber a mensagem cStat=137-Nenhum documento localizado (indicando que não há mais documentos a serem retornados), a nova tentativa é rejeitada.
* Não utilizar o NSU de forma sequencial: O usuário deve sempre basear a consulta no ultNSU retornado na consulta anterior. O ultNSU indica o ponto de onde a leitura de novos documentos deve continuar. Se o ultNSU for igual ao maxNSU (maior NSU existente), não há mais documentos no momento, e o usuário deve aguardar uma hora para nova consulta.

Se diferentes aplicações do mesmo interessado (emitente, destinatário, transportador ou CNPJ informado em autXML) realizarem consultas por NSU para o mesmo CNPJ (14 dígitos) e não seguirem a mesma sequência ordenada e ascendente, isso também configura uso indevido. A partir da versão 1.14, o ultNSU é retornado na rejeição 656 para auxiliar o usuário.

Limites de consulta

Para as consultas por chave de acesso (consChNFe) e por NSU específico (consNSU), existe um limite de consultas por hora. Se o limite for excedido (por exemplo, 20 consultas por hora), o serviço retornará 656 - Consumo indevido. O CNPJ é bloqueado por uma hora. A contagem do tempo de bloqueio é reiniciada se o usuário tentar consultar antes do término do período de uma hora.

Endereços do Web Service

Os endereços dos Web Services de Distribuição do Ambiente Nacional são divulgados no Portal Nacional da NFe e no Portal de Homologação, ambos acessíveis pelo menu "Serviços" / "Relação de Serviços Web".

Tabela de códigos de erros e descrições

As requisições ao Web Service podem retornar diferentes códigos de status (cStat) e mensagens (xMotivo). Alguns dos códigos de retorno mais comuns incluem:

• 108: Serviço Paralisado Momentaneamente (curto prazo).
• 109: Serviço Paralisado sem Previsão.
• 137: Nenhum documento localizado.
• 138: Documento localizado.
• 214: Rejeição: Tamanho da mensagem excedeu o limite estabelecido.
• 215: Rejeição: Falha no schema XML.
• 217: Rejeição: NF-e inexistente para a chave de acesso informada.
• 280-286: Rejeições relacionadas a certificados (inválido, data de validade, cadeia, revogado, ICP-Brasil, LCR).
• 472-473: Rejeições por CPF/CNPJ divergente ou ausente no certificado.
• 489-490: Rejeições por CNPJ/CPF inválido.
• 593: Rejeição: CNPJ-Base consultado difere do CNPJ-Base do Certificado Digital.
• 632: Rejeição: Solicitação fora de prazo, a NF-e não está mais disponível para download (mais de 90 dias).
• 640: Rejeição: CNPJ/CPF do interessado não possui permissão para consultar esta NF-e.
• 641: Rejeição: NF-e indisponível para o emitente.
• 653: Rejeição: NF-e Cancelada, arquivo indisponível para download.
• 654: Rejeição: NF-e Denegada, arquivo indisponível para download.
• 656: Rejeição: Consumo Indevido.

Esses códigos e mensagens auxiliam no diagnóstico e correção de problemas durante o uso do Web Service. O documento fonte inclui exemplos de requisições e retornos XML para diversos cenários de sucesso e erro.

Conclusão

O Web Service NFeDistribuicaoDFe é uma solução para acesso e distribuição de documentos fiscais eletrônicos de interesse dos participantes do ambiente da NFe. Ele proporciona a consulta de NF-e e eventos por NSU sequencial, NSU específico ou chave de acesso, com controles de acesso e validações rigorosas. A compreensão das regras de uso, dos leiautes e dos códigos de erro permite que contadores e empresas utilizem o serviço de forma eficiente para gerenciar suas informações fiscais.