NFeDistribuicaoDFe: Consulta NF-e e DF-e Essenciais para Contadores
Entenda o NFeDistribuicaoDFe: o Web Service para consultar NF-e, DF-e e eventos fiscais eletrônicos. Acesse informações cruciais para sua gestão fiscal e contábil de forma eficiente.
NFeDistribuicaoDFe: Consulta NF-e e DF-e Essenciais para Contadores
O Web Service NFeDistribuicaoDFe é um serviço que possibilita aos participantes da Nota Fiscal Eletrônica (NF-e) acessar documentos fiscais eletrônicos (DF-e) e informações resumidas de seu interesse. Esta ferramenta é essencial para emitentes, destinatários, transportadores e terceiros envolvidos nas operações, garantindo o acesso a dados fiscais relevantes de forma padronizada e segura. A Nota Técnica 2014.002 detalha o funcionamento e os requisitos para o uso deste serviço.
Histórico de Alterações do Web Service
A Nota Técnica 2014.002, que regulamenta o Web Service NFeDistribuicaoDFe, passou por diversas atualizações desde sua versão inicial em janeiro de 2014. Essas alterações visam aprimorar a distribuição de documentos e eventos, além de incluir novas funcionalidades e correções.
Versões importantes incluem:
* 1.02b: Inclusão da distribuição de eventos como Registro de Passagem e Pedido de Prorrogação de ICMS, além da possibilidade de consulta por chave de acesso da NF-e e distribuição de evento de Cancelamento para destinatário sem manifestação.
* 1.02c: Distribuição de Eventos de Averbação e de Comprovante de Entrega.
* 1.02d: Melhorias na documentação, esclarecendo os tipos de consulta e as situações de uso indevido.
* 1.10 e 1.11: Alterações na geração do NSU para otimização da distribuição e atualização da tabela de eventos, incluindo o Comprovante de Entrega da NF-e.
* 1.13: Distribuição de eventos gerados pelo Fisco para emitente e destinatário, mesmo que sejam os mesmos, independente de manifestação.
* 1.14: Retorno do último NSU na rejeição 656, facilitando a continuidade das consultas.
* 1.15: O retorno do NSU tornou-se facultativo, e a consulta por chave de acesso não exige mais a prévia geração de NSU.
* 1.20 (Maio de 2024): Inclusão do evento "Ator Interessado".
Visão Geral do Web Service NFeDistribuicaoDFe
O Web Service NFeDistribuicaoDFe é um serviço que distribui documentos e informações de interesse para os atores da NF-e. Sua função é prover, de forma eficiente e confiável, informações e DF-e para pessoas físicas ou jurídicas envolvidas. O processo é síncrono, e o método de chamada é nfeDistDFeInteresse. Este serviço permite acesso a DF-e e informações resumidas que não foram gerados pelo próprio interessado, mas são de seu interesse.
Qualquer ator da NF-e, seja Pessoa Jurídica ou Pessoa Física, pode consumir o serviço, desde que possua um certificado digital (de PJ ou PF). Para Pessoas Jurídicas, a autenticação ocorre pelo CNPJ base (primeiros 8 dígitos) do certificado, permitindo a consulta para qualquer CNPJ da empresa (14 dígitos) dentro do mesmo CNPJ base.
Os documentos fiscais eletrônicos e informações resumidas ficam disponíveis para distribuição por até 90 dias após sua recepção pelo Ambiente Nacional da NF-e.
Disponibilização de Documentos por Ator
A distribuição de documentos ocorre para atores que atuam como emitente, destinatário, transportador e terceiros (informados no campo autXML, que se refere a pessoas físicas autorizadas a acessar o XML). A tabela a seguir detalha quais documentos são disponibilizados para cada ator:
| 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 |
- ¹ Os documentos e resumos de eventos ficam disponíveis para o destinatário apenas se houver manifestação ("Ciência da Operação", "Operação não Realizada" ou "Confirmação de Operação"), com exceção do Evento de Cancelamento. Antes da manifestação, apenas o resumo da NF-e e o cancelamento estão disponíveis.
- ² A NF-e está disponível para o transportador identificado no grupo
transporta(X03) ou no evento "Ator Interessado na NF-e". - ³ A NF-e está disponível para terceiros cujo CNPJ ou CPF esteja informado no campo
autXML.
Estrutura das Mensagens
Mensagem de Entrada
A mensagem de entrada é uma estrutura XML com o pedido de distribuição de DF-e de interesse do ator. O schema XML para este pedido é distDFeInt_v9.99.xsd. 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.
* distNSU: Grupo para distribuir DF-e a partir do último NSU recebido.
* consNSU: Grupo para consultar um DF-e a partir de um NSU específico.
* consChNFe: Grupo para consultar uma NF-e pela chave de acesso.
Mensagem de Retorno
A mensagem de retorno é uma estrutura XML com os documentos de interesse do ator, com quantidade máxima de 50. O schema XML é retDistDFeInt _v9.99.xsd. Os campos relevantes são:
* versao: Versão do leiaute.
* tpAmb: Identificação do Ambiente.
* verAplic: Versão do aplicativo que processou a consulta.
* cStat: Código do status da resposta.
* xMotivo: Descrição literal do status da resposta.
* dhResp: Data e hora da mensagem de resposta.
* ultNSU: Último NSU pesquisado no Ambiente Nacional.
* maxNSU: Maior NSU existente no Ambiente Nacional para o CNPJ/CPF.
* loteDistDFeInt: Conjunto de informações resumidas e DF-e.
* docZip: Informação resumida ou documento fiscal eletrônico, compactado no padrão Gzip.
Para otimizar a infraestrutura de rede, cada documento na mensagem de retorno é compactado individualmente no padrão Gzip. Essa compactação pode reduzir o tamanho da mensagem em até 60%, exigindo que a aplicação cliente descompacte o conteúdo antes do processamento.
Processo de Distribuição de DF-e de Interesse
O Ambiente Nacional gera um Número Sequencial Único (NSU) para cada interessado nos documentos fiscais. A partir da versão 1.10 da Nota Técnica 2014.002, a geração do NSU considera apenas os usuários do serviço nos últimos 60 dias. Para novos usuários, a geração de NSU ocorre a partir do primeiro acesso, sem retroatividade. Se um usuário ficar inativo por mais de 60 dias, a geração de NSU é interrompida e retomada na próxima consulta, também sem retroatividade ao período de interrupção.
É possível consultar DF-e de interesse de uma pessoa física ou jurídica através de três tipos de requisição:
1. Distribuição de Conjunto de DF-e a Partir do NSU Informado (tag distNSU)
A aplicação cliente informa o último NSU que possui, e o Ambiente Nacional fornece todos os documentos (NF-e e eventos) disponíveis a partir desse NSU. Se o NSU informado for menor que o primeiro NSU disponível, o serviço retorna os documentos fiscais do NSU mais antigo que foram autorizados há menos de 90 dias. O Web Service gera lotes com até 50 documentos, organizados em ordem crescente de NSU.
2. Consulta DF-e Vinculado ao NSU Informado (tag consNSU)
Este tipo de consulta permite que o interessado busque um NSU específico que foi identificado como faltante em sua base de dados. O Ambiente Nacional fornece um único documento fiscal (NF-e ou evento) referente ao NSU solicitado. Esta consulta, assim como as demais, está disponível para documentos recebidos nos últimos 90 dias.
3. Consulta de NF-e por Chave de Acesso Informada (tag consChNFe)
Para consultar uma NF-e específica, o interessado pode informar a chave de acesso. A chave deve ser válida, existir no Ambiente Nacional e estar vinculada ao interessado como destinatário, transportador ou terceiro. O Ambiente Nacional retorna somente a NF-e (não eventos) referente à chave informada. Desde a versão 1.15 da nota técnica, esta consulta não exige prévia geração de NSU para o documento fiscal.
Para as empresas, informar o CNPJ no pedido de distribuição permite a recuperação de DF-e de qualquer um de seus estabelecimentos utilizando um único certificado digital. O pedido de distribuição é enviado via Web Service, exigindo um certificado digital de PJ ou PF válido.
Validações e Regras de Negócio
O Web Service realiza diversas validações para garantir a segurança e a integridade das informações.
Validação do Certificado de Transmissão
As regras de validação do certificado de transmissão incluem:
* Certificado de Transmissor inválido ou inexistente.
* Validade do certificado (data início e fim).
* Verificação da cadeia de certificação (AC emissora não cadastrada, revogada ou certificado não assinado).
* Lista de Certificados Revogados (LCR) indisponível ou inválida.
* Certificado do Transmissor revogado.
* Certificado Raiz diferente de "ICP-Brasil".
* Falta de extensão de CNPJ ou CPF no certificado.
Muitas dessas validações são realizadas pelo protocolo SSL, mas a validação do certificado raiz pode exigir atenção adicional para evitar falhas se houver outros certificados digitais de Autoridade Certificadora Raiz diferentes de "ICP-Brasil" no servidor.
Validação Inicial da Mensagem e Área de Dados
O sistema verifica o tamanho do XML de dados, que não deve exceder 10 KB. Mensagens maiores podem ser descartadas. Também são verificadas as condições de paralisação do servidor. Na validação da área de dados, são conferidos:
* Schema XML da área de dados.
* Uso de prefixo no namespace.
* Codificação XML (deve ser UTF-8).
* Versão dos dados.
Validação de Regras de Negócio
As regras de negócio validam os dados inseridos, como:
* Tipo de ambiente da NF-e diferente do ambiente do Web Service.
* CNPJ ou CPF do interessado inválido.
* CNPJ base do certificado digital diferente do CNPJ base consultado.
* CPF do certificado digital diferente do CPF consultado.
* NSU informado superior ao maior NSU disponível (para distNSU e consNSU).
* Chave de acesso inválida (dígito verificador, código UF, ano, mês, CNPJ, modelo, número da NF).
* NF-e inexistente para a chave de acesso.
* Prazo de download de 90 dias (para NF-e).
* Permissões de consulta para o CNPJ/CPF interessado.
* Disponibilidade da NF-e para o emitente.
* NF-e cancelada ou denegada (arquivo indisponível).
Leiautes Resumidos
Para permitir o compartilhamento de informações relevantes com sigilo, foram criados leiautes resumidos para NF-e e eventos.
Resumo da NF-e
Este é um XML gerado pelo Ambiente Nacional com informações resumidas da NF-e. Ele é distribuído para os destinatários, permitindo a manifestação da operação. Contém campos como:
* Chave de acesso da NF-e.
* CNPJ ou CPF do emitente.
* Razão Social ou Nome do emitente.
* Inscrição Estadual do emitente.
* Data de Emissão da NF-e.
* Tipo de Operação (0=Entrada; 1=Saída).
* Valor Total da NF-e.
* Digest Value da NF-e.
* Data de autorização da NF-e.
* Número de protocolo da NF-e.
* Situação da NF-e (Uso autorizado, Uso denegado, NF-e Cancelada).
Resumo do Evento de NF-e
Uma estrutura XML com informações resumidas de um evento de NF-e. Inclui:
* Código do órgão de recepção do Evento (91 para Ambiente Nacional).
* CNPJ ou CPF do emitente.
* Chave de acesso da NF-e.
* Data e hora do evento.
* Código do evento.
* Número sequencial do evento.
* Descrição do evento.
* Data de autorização do evento.
* Número de protocolo do evento.
Prevenção de Uso Indevido
O Web Service NFeDistribuicaoDFe implementa controles para identificar e coibir situações de uso indevido, como tentativas sucessivas de busca por registros já disponibilizados ou consultas em "loop". O retorno de uso indevido é sinalizado pelo código de status 656 - Rejeição: Consumo Indevido.
Regras para Consulta com 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 fazer uma nova consulta. Consultas realizadas antes desse período resultarão em uso indevido e bloqueio do CNPJ por uma hora. - Consulta fora de sequência: O usuário deve sempre utilizar o
ultNSUretornado na consulta anterior para manter a sequência. Consultas fora de sequência levam ao bloqueio do CNPJ por uma hora. Se oultNSUfor igual aomaxNSU, significa que não há mais documentos, e o usuário deve aguardar uma hora para novas consultas.
É importante que todas as aplicações de um mesmo ator (emitente, destinatário, transportador ou informado no campo autXML) que efetuam consultas por NSU para o mesmo CNPJ sigam a mesma sequência numerada ascendente para evitar o uso indevido.
Regras para Consultas com consChNFe e consNSU:
Essas consultas são para buscas pontuais de NF-e ou NSU em um período retroativo de no máximo 90 dias. Se a intenção for baixar todas as NF-es de um CNPJ dentro dos 90 dias, a consulta distNSU é a recomendada.
- Limite de consultas por hora: Existe um limite para o número de consultas por chave de acesso ou NSU em um período de 1 hora. Ultrapassar esse limite resulta na mensagem
656 - Consumo indevido, bloqueando o CNPJ por 1 hora.
Em qualquer tipo de consulta, se o usuário receber a mensagem 656 - Consumo Indevido, ele deve aguardar uma hora. Reiniciar a consulta antes do término desse período zera a contagem e reinicia o tempo de espera.
Códigos de Erro
A nota técnica apresenta uma tabela de códigos de erros e descrições de mensagens de erros para auxiliar na compreensão dos retornos do Web Service. Alguns exemplos incluem:
* 108: Serviço Paralisado Momentaneamente.
* 137: Nenhum documento localizado.
* 138: Documento localizado.
* 214: Tamanho da mensagem excedeu o limite.
* 217: NF-e inexistente para a chave de acesso.
* 280: Certificado Transmissor inválido.
* 656: Consumo Indevido.
Esses códigos permitem que as aplicações clientes identifiquem a causa de eventuais falhas e ajam de acordo.
Conclusão
O Web Service NFeDistribuicaoDFe é um recurso para garantir que emitentes, destinatários, transportadores e terceiros possam acessar documentos fiscais eletrônicos e eventos de seu interesse. O modelo de distribuição baseado em NSU e as diversas opções de consulta (por NSU sequencial, NSU específico ou chave de acesso) buscam atender às diferentes necessidades dos usuários. A implementação das validações e das regras para evitar o uso indevido reforçam a estabilidade do sistema, tornando a recuperação de informações fiscais um processo padronizado e acessível, contanto que as diretrizes da Nota Técnica 2014.002 sejam seguidas.