NFeDistribuicaoDFe: Consulta de NF-e e eventos por interessados
NFeDistribuicaoDFe: Consulta de NF-e e eventos por interessados O Web Service NFeDistribuicaoDFe disponibiliza informações e documentos fiscais eletrônicos (DF-e) para os atores envolvidos nos processos da Nota Fiscal Eletrônica (NF-e). Seu objetivo é prover acesso eficiente e confiável a esses dados, conforme...
NFeDistribuicaoDFe: Consulta de NF-e e eventos por interessados
O Web Service NFeDistribuicaoDFe disponibiliza informações e documentos fiscais eletrônicos (DF-e) para os atores envolvidos nos processos da Nota Fiscal Eletrônica (NF-e). Seu objetivo é prover acesso eficiente e confiável a esses dados, conforme detalhado na Nota Técnica 2014.002. O serviço abrange emitentes, destinatários, transportadores e terceiros que constam na NF-e, sejam pessoas físicas ou jurídicas.
O Serviço NFeDistribuicaoDFe
O serviço NFeDistribuicaoDFe permite que qualquer ator da NF-e, seja pessoa física ou jurídica, acesse documentos e informações resumidas que não foram gerados por ele, mas que são de seu interesse. Para isso, é necessário possuir um certificado digital de PJ ou PF. No caso de uma Pessoa Jurídica, a consulta pode ser feita para qualquer CNPJ (14 dígitos) da empresa, desde que o CNPJ base (8 primeiros dígitos) 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 a recepção pelo Ambiente Nacional da NF-e.
Acesso aos Documentos por Ator
A disponibilidade da NF-e e de seus eventos varia conforme o papel do interessado:
- Destinatário:
- O Ambiente Nacional verifica a existência de manifestação ("Ciência da Operação", "Operação Não Realizada" ou "Confirmação de Operação").
- Com manifestação, a NF-e completa é retornada.
- Sem manifestação, apenas o resumo da NF-e é retornado, fornecendo as informações necessárias para a manifestação.
- Exceção: O Evento de Cancelamento é disponibilizado ao destinatário mesmo sem manifestação.
- Transportador e Terceiros: A NF-e completa é disponibilizada integralmente na consulta, sem a necessidade de manifestação prévia. O transportador deve ser identificado no grupo de transportadores ou no evento "Ator Interessado na NF-e". Terceiros devem ter seu CNPJ ou CPF informado na tag
autXML(Pessoas Físicas autorizadas a acessar o XML).
A distribuição de documentos e resumos de eventos segue uma tabela específica para cada ator. Por exemplo, enquanto o emitente tem acesso aos Eventos de Manifestação do Destinatário e Eventos da Suframa, a NF-e em si não é disponibilizada para consulta pelo emitente. Já o destinatário pode acessar a NF-e, Eventos de Cancelamento e Carta de Correção, entre outros.
Os eventos gerados pelo Fisco, a partir da versão 1.13 da Nota Técnica, são distribuídos ao emitente independentemente da manifestação do destinatário, mesmo que emitente e destinatário sejam a mesma entidade.
Estrutura das Mensagens do Web Service
O Web Service NFeDistribuicaoDFe opera de forma síncrona, utilizando o método nfeDistDFeInteresse. As interações são realizadas por meio de mensagens XML de entrada e retorno, seguindo schemas específicos.
Mensagem de Entrada
A mensagem de entrada é uma estrutura XML que contém o pedido de distribuição de DF-e de interesse do ator. Os campos principais incluem:
tpAmb: Identifica o ambiente (1=Produção, 2=Homologação).cUFAutor: Código da UF do autor da requisição.CNPJ/CPF: Identificação do interessado na consulta do DF-e.
Esta mensagem suporta três tipos de consultas, definidas pela tag informada no XML: distNSU, consNSU e consChNFe.
Mensagem de Retorno Compactada
A mensagem de retorno é uma estrutura XML que contém os documentos de interesse do ator, com quantidade máxima de 50 documentos por lote. Para otimizar o uso da rede e minimizar as necessidades de infraestrutura, cada documento na mensagem de retorno é compactado individualmente.
A compactação utiliza o padrão Gzip (GNU zip), reduzindo o tamanho da mensagem em aproximadamente 60%. A aplicação cliente deve descompactar o conteúdo da tag docZip para o tratamento normal do documento.
Os principais campos da mensagem de retorno são:
cStat: Código do status da resposta, indicando o resultado do processamento.xMotivo: Descrição literal do status da resposta.dhResp: Data e hora da mensagem de resposta.ultNSU: Último NSU pesquisado no Ambiente Nacional, indicando o ponto de partida para consultas futuras.maxNSU: Maior NSU existente no Ambiente Nacional para o CNPJ/CPF consultado.loteDistDFeInt: Conjunto de informações resumidas e documentos fiscais eletrônicos.docZip: Informação resumida ou documento fiscal eletrônico de interesse, compactado no padrão Gzip.
Processo de Distribuição de Documentos Fiscais Eletrônicos (DF-e)
O Ambiente Nacional gera um Número Sequencial Único (NSU) para cada interessado nos documentos fiscais. Este NSU é fundamental para a recuperação ordenada dos DF-e.
Geração de NSU
A partir da versão 1.10 da Nota Técnica 2014.002, a geração de NSU considera somente os usuários que acessaram o serviço nos últimos 60 dias. Isso significa:
- Para usuários que acessaram o serviço nos últimos 60 dias, a geração de NSU continua normalmente.
- Novos usuários do serviço (
distNSU) terão o NSU gerado a partir do primeiro acesso, sem retroatividade. - Usuários inativos por mais de 60 dias terão a geração de NSU interrompida, sendo retomada a partir da próxima consulta, também sem retroatividade ao período de interrupção.
Nestes casos, o primeiro acesso pode retornar "cStat=137-Nenhum documento localizado". Consultas subsequentes, após o período de espera por uso indevido, podem então retornar documentos. A verificação da continuidade de uso é feita pelo CPF ou CNPJ-base constante na requisição.
Antes de gerar NSU para transportadores ou CNPJs informados no campo autXML, é verificado se eles também são destinatários da mesma NF-e. Se forem, o NSU só é gerado após a manifestação do destinatário.
Tipos de Consulta
O XML do pedido de distribuição suporta três tipos principais de consulta:
- Distribuição de Conjunto de DF-e a Partir do NSU Informado (
distNSU): A aplicação cliente informa o último NSU que possui, e o Ambiente Nacional retorna todos os documentos (NF-e e eventos) disponíveis a partir desse NSU. Se o NSU informado for menor que o primeiro disponível, são fornecidos os documentos fiscais das NF-es e eventos autorizados há menos de 90 dias, em lotes de até 50 documentos, em ordem crescente de NSU. - Consulta DF-e Vinculado ao NSU Informado (
consNSU): Este método permite consultar pontualmente um NSU específico que foi identificado como faltante na base de dados do interessado. O Ambiente Nacional fornece um único documento fiscal (NF-e ou evento) referente ao NSU solicitado. - Consulta de NF-e por Chave de Acesso Informada (
consChNFe): Permite consultar uma NF-e específica a partir de sua chave de acesso. O Ambiente Nacional retorna apenas a NF-e (sem eventos) relacionada à chave informada. A partir da versão 1.15 da Nota Técnica, esta consulta não exige a geração prévia de NSU para o documento fiscal.
Importante: Todos os tipos de consulta estão disponíveis para documentos recebidos pelo Ambiente Nacional nos últimos 90 dias. Após este prazo, a recuperação da NF-e não é possível.
Recuperação por CNPJ ou CPF
É obrigatório informar o CPF da pessoa física ou o CNPJ da empresa para a recuperação de DF-e de interesse. Para empresas, este campo permite a recuperação de DF-e de qualquer um de seus estabelecimentos utilizando um único certificado digital.
O pedido de distribuição é enviado por Web Service, exigindo o uso de um certificado digital de PJ ou PF válido.
Validações e Regras de Negócio
O processo de distribuição de DF-e envolve diversas validações para garantir a segurança e a integridade das informações.
Validação do Certificado de Transmissão
O certificado digital utilizado na transmissão da requisição é submetido a uma série de verificações:
- Validade: Data de início e fim do certificado.
- Cadeia de Certificação: Verificação da Autoridade Certificadora (AC) emissora, revogação de ACs e assinatura do certificado.
- Lista de Certificados Revogados (LCR): Acesso e validade da LCR.
- Certificado Raiz: Deve ser "ICP-Brasil".
- Extensões: Presença da extensão de CNPJ ou CPF no certificado.
A maioria dessas validações é realizada pelo protocolo SSL, sem necessidade de implementação adicional pela aplicação cliente.
Validação Inicial da Mensagem no Web Service
A mensagem de requisição é validada quanto a critérios básicos:
- Tamanho: O XML de dados não deve exceder 10 KB. Mensagens maiores podem ser descartadas.
- Serviço: Verificação se o servidor de processamento está paralisado momentaneamente ou sem previsão.
Validação da Área de Dados e Regras de Negócio
Após as validações iniciais, a área de dados da mensagem é verificada:
- Schema XML: Conformidade com o schema XML esperado.
- Codificação: O XML deve utilizar a codificação UTF-8.
- Versão dos Dados: A versão informada deve ser suportada e não superior à vigente.
As regras de negócio aplicam verificações mais específicas:
- O tipo de ambiente informado na NF-e deve ser o mesmo do Web Service.
- Validação do CNPJ/CPF do interessado na distribuição.
- O CNPJ-Base ou CPF do certificado digital deve corresponder ao CNPJ/CPF consultado.
- Para
distNSUeconsNSU, o NSU informado não pode ser superior ao maior NSU disponível. - Para
consChNFe, a chave de acesso passa por validação de dígito verificador, código da UF, ano, mês, CNPJ, modelo e número da NF-e. - A NF-e deve existir e estar no prazo de download (90 dias).
- Verificação de permissão: O CNPJ/CPF do interessado deve possuir permissão para consultar a NF-e. Por exemplo, a NF-e não é disponibilizada para o próprio emitente.
- NF-e Cancelada ou Denegada: O arquivo da NF-e é indisponível para download.
Leiautes Resumidos de Documentos
Para permitir o compartilhamento de informações sem violar o sigilo, foram criados leiautes com dados resumidos de NF-e e eventos.
Resumo da NF-e
Este leiaute (resNFe_v9.99.xsd) é gerado pelo Ambiente Nacional com informações essenciais da NF-e. É distribuído aos destinatários para que possam realizar a manifestação da operação. Inclui campos como Chave de acesso, CNPJ/CPF e Razão Social do Emitente, Data de Emissão, Tipo de Operação, Valor Total da NF-e, Digest Value, Data de Autorização, Número de Protocolo e Situação da NF-e (Uso Autorizado, Denegado, Cancelado).
Resumo do Evento de NF-e
O leiaute (resEvento_v9.99.xsd) contém informações resumidas de um evento de NF-e. Apresenta dados como Código do órgão de recepção do evento, CNPJ/CPF do Emitente, Chave de acesso da NF-e, Data e hora do evento, Tipo e Número sequencial do evento, Descrição do evento, Data de autorização e Número de Protocolo.
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 fluxo de distribuição de DF-e ocorre da seguinte forma:
- Um emitente gera e transmite uma NF-e, que é autorizada pela Sefaz e compartilhada com o Ambiente Nacional.
- O Ambiente Nacional gera um NSU para o destinatário do resumo da NF-e, disponibilizando-o para consulta.
- O destinatário consulta o serviço
NFeDistribuicaoDFeusando o último NSU recebido e recupera o resumo da NF-e. - Com o resumo, o destinatário gera um Evento de Manifestação do Destinatário.
- O Ambiente Nacional gera um NSU do evento para o emitente e o disponibiliza para consulta.
- Se a manifestação do destinatário for diferente de "Desconhecimento da Operação", o Ambiente Nacional gera um NSU para o destinatário, permitindo o download da NF-e completa.
- O emitente consulta o serviço e recupera o evento gerado pelo destinatário.
- O destinatário consulta o serviço e recupera a NF-e completa.
- O emitente gera um evento de sua NF-e (ex: Evento de Cancelamento), compartilhado pela Sefaz com o Ambiente Nacional.
- O Ambiente Nacional gera um NSU para o destinatário do evento do emitente e o disponibiliza.
- O destinatário consulta o serviço e recupera o evento gerado pelo emitente.
- Um evento gerado pelo Fisco é recebido pelo Ambiente Nacional, que gera um NSU para o emitente e outro para o destinatário, disponibilizando-os.
- Ambos, emitente e destinatário, consultam o serviço e recuperam o evento gerado pelo Fisco.
Este modelo simplifica o processo de acesso a informações relevantes, permitindo que emitentes monitorem manifestações e que destinatários obtenham a NF-e completa após sua manifestação.
Recomendações para Evitar Uso Indevido
Para manter a estabilidade do Ambiente Nacional, há controles para identificar e prevenir o "uso indevido" do Web Service NFeDistribuicaoDFe, que resulta no erro "656-Rejeição: Consumo Indevido".
Uso Indevido na Consulta com distNSU
- Consultas repetidas sem novos documentos: Se o retorno indicar
cStat=137(Nenhum documento localizado), o usuário deve aguardar uma hora antes de fazer nova consulta. Consultas dentro desse período de 1 hora geram uso indevido e bloqueio do CNPJ por uma hora. - Consulta de NSU não sequencial: O usuário deve usar sempre o
ultNSUretornado na consulta anterior para manter a sequência. Consultar fora de ordem ou continuar consultando quandoultNSUfor igual amaxNSU(não há mais documentos) antes de 1 hora também causa bloqueio.
Se diversas aplicações do mesmo ator consultarem o mesmo CNPJ por NSU, elas devem seguir a mesma sequência ordenada e ascendente para evitar uso indevido. Desde a versão 1.14 da Nota Técnica, o ultNSU é retornado na rejeição 656, auxiliando o usuário a retomar a consulta.
Uso Indevido nas Consultas com consChNFe e consNSU
Essas consultas são para buscas pontuais de NF-e ou NSU em um período máximo de 90 dias. Para download de múltiplos documentos dentro desse período, deve-se usar a consulta distNSU.
- Limite de consultas por hora: Existe um limite de 20 consultas por chave de acesso ou NSU em um período de 1 hora. Ultrapassar este limite resulta em
cStat=656e bloqueio do CNPJ por uma hora. Se uma nova consulta for feita antes de 1 hora, o tempo de bloqueio é zerado e reinicia a contagem.
Códigos de Erro
O serviço NFeDistribuicaoDFe utiliza códigos de status (cStat) e motivos (xMotivo) para indicar o resultado do processamento da solicitação ou os motivos de não atendimento. Alguns dos códigos comuns incluem:
- 108: Serviço Paralisado Momentaneamente.
- 109: Serviço Paralisado sem Previsão.
- 137: Nenhum documento localizado.
- 138: Documento(s) localizado(s).
- 214: Rejeição: Tamanho da mensagem excedeu o limite.
- 217: Rejeição: NF-e inexistente para a chave de acesso informada.
- 280: Rejeição: Certificado Transmissor inválido.
- 472: Rejeição: CPF consultado difere do CPF do Certificado Digital.
- 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 (após 90 dias).
- 656: Rejeição: Consumo Indevido.
Requisições e Respostas do Serviço
As requisições e respostas ao Web Service NFeDistribuicaoDFe são realizadas através de mensagens XML. Por exemplo, um pedido de distribuição por NSU em ambiente de homologação especifica o ambiente, UF do autor, CNPJ do interessado e o último NSU recebido. Uma consulta por chave de acesso em ambiente de produção, por sua vez, informa a chave de acesso da NF-e a ser consultada.
Os retornos do serviço indicam o sucesso ou falha da operação. Um retorno com cStat=589 pode indicar que o NSU informado é superior ao maior NSU disponível. Já cStat=137 sinaliza que não há documentos localizados para o CNPJ/CPF. Quando há sucesso e documentos encontrados, o retorno exibe cStat=138, e os documentos fiscais compactados são incluídos na mensagem.
Esses exemplos ilustram a interação direta com o Web Service, onde cada parâmetro e retorno possui um significado específico para o controle e a recuperação dos DF-e.
Endereços dos Web Services
Os endereços para acesso ao Web Service de Distribuição do Ambiente Nacional são publicados nos portais oficiais:
Eles podem ser encontrados no menu "Serviços" / "Relação de Serviços Web".
Conclusão
O Web Service NFeDistribuicaoDFe, conforme as diretrizes da Nota Técnica 2014.002, desempenha um papel importante na gestão de documentos fiscais eletrônicos. Ao prover um mecanismo padronizado para a consulta e distribuição de NF-e e eventos por diversos atores, o serviço auxilia empresas e contadores na organização e monitoramento de suas operações. A compreensão de suas funcionalidades, regras de acesso e validações é essencial para garantir o uso eficiente e a conformidade com as normas fiscais.