Web Service NFeDistribuicaoDFe: Acesso Otimizado a DF-e e NF-e
Conheça o Web Service NFeDistribuicaoDFe: acesse documentos fiscais eletrônicos (DF-e) e NF-e como emitente, destinatário ou transportador. Otimize sua gestão fiscal.
O Web Service NFeDistribuicaoDFe disponibiliza informações e documentos fiscais eletrônicos (DF-e) de interesse para os diversos atores da Nota Fiscal Eletrônica (NF-e). Este serviço, detalhado na Nota Técnica 2014.002, oferece acesso a documentos fiscais para emitentes, destinatários, transportadores e terceiros, otimizando o fluxo de dados fiscais.
Histórico de atualizações do Web Service
O serviço NFeDistribuicaoDFe passou por diversas atualizações desde sua versão inicial para aprimorar a distribuição de DF-e. A versão 1.02b incluiu a distribuição de eventos como Registro de Passagem, Pedido de Prorrogação de Prazo para ICMS e respostas do Fisco, além de permitir consultas por chave de acesso da NF-e e o cancelamento para o destinatário sem manifestação.
Posteriormente, a versão 1.02c adicionou eventos de Averbação e Comprovante de Entrega. A versão 1.02d focou em melhorias documentais, esclarecendo os tipos de consulta (por chave de acesso, distribuição NSU e NSU pontual) e detalhando situações de uso indevido.
Versões como a 1.10 e 1.11 otimizaram a geração do Número Sequencial Único (NSU) e incluíram o evento de comprovante de entrega da NF-e. A versão 1.13 possibilitou a distribuição de eventos do Fisco para o emitente, mesmo que emitente e destinatário fossem iguais. Na versão 1.14, o ultNSU passou a ser retornado em rejeições do tipo 656.
A versão 1.15 tornou o retorno do NSU facultativo na consulta por chave de acesso (consChNFe). A atualização mais recente, versão 1.20 de maio de 2024, incorporou o evento "Ator Interessado", ampliando o alcance da distribuição.
NFeDistribuicaoDFe: serviço e funcionalidades
O Web Service NFeDistribuicaoDFe, acessado pelo método nfeDistDFeInteresse, distribui documentos e informações de interesse de um ator da NF-e, seja ele pessoa física ou jurídica. Este serviço é síncrono e permite o acesso a DF-e e informações resumidas que não foram gerados pelo próprio ator, mas são de seu interesse legítimo. Para utilizá-lo, é necessário um certificado digital de Pessoa Jurídica (PJ) ou Pessoa Física (PF) válido.
Para Pessoas Jurídicas, a consulta pode ser realizada para qualquer CNPJ da empresa, desde que o CNPJ base (os 8 primeiros dígitos) seja o mesmo do certificado digital utilizado na autenticação. Os documentos fiscais eletrônicos 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.
Disponibilidade de documentos por ator
A disponibilidade dos documentos varia conforme o papel do interessado na NF-e:
- Destinatário: Recebe o resumo da NF-e inicialmente. A NF-e completa é disponibilizada após a manifestação ("Ciência da Operação", "Operação Não Realizada" ou "Confirmação de Operação"), exceto para o Evento de Cancelamento, que é disponibilizado sem manifestação.
- Transportador e Terceiros (informados na tag
autXML): A NF-e integral é disponibilizada diretamente na consulta. - Emitente, Destinatário, Transportador e Terceiros: A distribuição abrange diversos documentos e resumos, dependendo do papel, conforme a tabela da Nota Técnica 2014.002. Por exemplo, NF-e, Eventos de Cancelamento, Carta de Correção são disponibilizados para Destinatário, Transportador e Terceiros. Eventos de Manifestação do Destinatário e da Suframa são disponibilizados para o Emitente.
Mensagens de entrada e retorno
As mensagens de entrada e retorno do Web Service NFeDistribuicaoDFe seguem estruturas XML específicas.
Leiaute mensagem de entrada
A requisição de distribuição de DF-e de interesse do ator é feita através de uma estrutura XML que segue o schema distDFeInt_v9.99.xsd. Esta mensagem contém informações sobre o ambiente (produção/homologação), o código da UF do autor, e o CNPJ ou CPF do interessado.
O XML de entrada suporta três tipos de consultas, definidas pela tag utilizada:
* distNSU: para distribuição de um conjunto de DF-e a partir de um Número Sequencial Único.
* consNSU: para consultar um DF-e específico a partir de um NSU.
* consChNFe: para consultar uma NF-e pela chave de acesso.
Leiaute mensagem de retorno
A resposta do Web Service é uma estrutura XML que segue o schema retDistDFeInt_v9.99.xsd, contendo os documentos de interesse do ator, com um máximo de 50 documentos por lote. O retorno inclui informações como a versão do leiaute, identificação do ambiente, versão do aplicativo, código e descrição do status da resposta (cStat e xMotivo), data e hora da resposta, e os NSUs pesquisados (ultNSU e maxNSU).
Cada documento na mensagem de retorno é compactado individualmente no padrão Gzip (tag docZip), o que reduz o tamanho da mensagem em aproximadamente 60%. A aplicação cliente deve descompactar o documento para processá-lo.
Processo de distribuição de DF-e de interesse
O Ambiente Nacional gera um Número Sequencial Único (NSU) para cada documento fiscal de interesse, por cada interessado. A geração do NSU, a partir da versão 1.10 da Nota Técnica, considera somente os usuários que acessaram o serviço nos últimos 60 dias. Para novos usuários ou aqueles que ficaram mais de 60 dias sem utilizar o serviço, a geração de NSU retroativa não ocorre, iniciando a partir do primeiro acesso válido.
Tipos de consulta
O serviço NFeDistribuicaoDFe oferece três modalidades de consulta para recuperar documentos fiscais eletrônicos:
-
Distribuição de conjunto de DF-e a partir do NSU informado (
distNSU): A aplicação cliente informa o último NSU recebido (ultNSU), e o Ambiente Nacional retorna todos os documentos e eventos disponíveis a partir desse NSU. Os documentos são organizados em lotes de até 50, em ordem crescente de NSU, e são disponibilizados por até 90 dias após a recepção pelo Ambiente Nacional. Se oultNSUfor zero ou muito antigo, a consulta retorna documentos recebidos nos últimos 90 dias a partir do NSU mais antigo disponível. -
Consulta DF-e vinculado ao NSU informado (
consNSU): Usada para consultar um NSU específico que o interessado identificou como faltante em sua base de dados. O Ambiente Nacional fornece um único documento fiscal (NF-e ou evento) referente ao NSU informado. Esta consulta também é limitada a documentos recebidos nos últimos 90 dias. -
Consulta de NF-e por chave de acesso informada (
consChNFe): Permite consultar uma NF-e pontualmente por 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 eventos, e também se limita a documentos recebidos nos últimos 90 dias. A partir da versão 1.15 da Nota Técnica, esta consulta não exige a prévia geração de NSU para o documento fiscal.
Respostas do Web Service
As respostas do Web Service para as requisições de distribuição podem ser:
- Rejeição: A mensagem é devolvida com um
cStatindicando o motivo da falha. - Nenhum documento localizado (
cStat=137): Não existem documentos fiscais para o CNPJ/CPF informado ou o NSU não foi gerado. - Documento(s) localizado(s) (
cStat=138): Os documentos fiscais encontrados são devolvidos.
Após uma resposta cStat=137, é necessário aguardar uma hora para realizar uma nova solicitação, a fim de evitar o uso indevido do serviço.
Validações e regras de negócio
O Web Service NFeDistribuicaoDFe implementa validações rigorosas para garantir a segurança e a conformidade das operações.
Validação do certificado de transmissão
O certificado digital utilizado na transmissão da mensagem é validado quanto a sua validade, cadeia de certificação e revogação. Além disso, verifica-se a presença da extensão de CNPJ ou CPF no certificado. Rejeições ocorrem se o certificado for inválido, vencido, revogado ou não assinado pela AC emissora cadastrada no Ambiente Nacional.
Validação inicial da mensagem
Antes de processar o conteúdo da mensagem, são realizadas validações preliminares:
* Tamanho do XML: O tamanho do XML de dados não pode exceder 10 KB. Mensagens maiores são descartadas ou rejeitadas com erro 214.
* Status do serviço: Verifica se o servidor de processamento não está paralisado momentaneamente (erro 108) ou sem previsão (erro 109).
Validação da área de dados
A estrutura do XML é validada formalmente, incluindo:
* Schema XML: Conformidade com o schema distDFeInt_v9.99.xsd (erro 215).
* Prefixo de namespace: Proibição de uso de prefixos (erro 404).
* Codificação: O XML deve utilizar codificação UTF-8 (erro 402).
* Versão dos dados: Verificação da versão informada em relação à versão vigente ou suportada (erros 238 e 239).
Validação de regras de negócio
As regras de negócio garantem que a solicitação de distribuição esteja em conformidade com as exigências fiscais:
- Ambiente: O tipo de ambiente da NF-e deve ser o mesmo do Web Service (erro 252).
- CNPJ/CPF do interessado: Validação do CNPJ (erro 489) ou CPF (erro 490) do interessado, verificando dígito verificador e zeros.
- CNPJ/CPF do certificado: O CNPJ-Base do certificado digital deve corresponder ao CNPJ-Base consultado (erro 593), ou o CPF deve ser idêntico (erro 472).
- NSU informado: Para consultas
distNSUeconsNSU, o NSU informado não pode ser superior ao maior NSU disponível (erro 589). - Chave de acesso: Para consultas
consChNFe, a chave de acesso é validada quanto a dígito verificador, código UF, ano, mês, CNPJ, modelo e número da NF-e (erros 236, 614, 615, 616, 617, 618, 619). - Existência da NF-e: A NF-e deve existir no Ambiente Nacional (erro 217) e estar dentro do prazo de 90 dias para download (erro 632).
- Permissão de acesso: O CNPJ/CPF do interessado deve ter permissão para consultar a NF-e (erro 640).
- Disponibilidade para emitente: NF-e não é disponibilizada para o emitente (erro 641).
- NF-e Cancelada/Denegada: Arquivos de NF-e canceladas (erro 653) ou denegadas (erro 654) não estão disponíveis para download.
Leiautes resumidos
Para otimizar o compartilhamento de informações, o Ambiente Nacional gera leiautes resumidos da NF-e e dos eventos.
Leiaute resumo da NF-e
O resNFe_v9.99.xsd é uma estrutura XML com informações resumidas da NF-e, gerada quando a NF-e é autorizada ou denegada. Este resumo é distribuído aos destinatários para permitir a manifestação sobre a operação. Inclui a chave de acesso da NF-e, CNPJ/CPF e nome 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, além da situação da NF-e (uso autorizado, denegado ou cancelado).
Leiaute resumo do evento de NF-e
O resEvento_v9.99.xsd é a estrutura XML com informações resumidas de um evento de NF-e. Contém o 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 do evento.
Modelo de distribuição de documentos fiscais
O modelo de distribuição baseia-se na geração de um Número Sequencial Único (NSU) para cada CNPJ ou CPF interessado. O processo envolve a geração e disponibilização do NSU para resumos de NF-e, eventos de manifestação do destinatário, a liberação do download da NF-e completa após a manifestação, e a distribuição de eventos gerados pelo emitente ou pelo Fisco.
Este modelo permite ao emitente consultar os eventos manifestados pelos destinatários de suas NF-e, e ao destinatário acessar qualquer evento gerado pelo emitente. Eventos gerados pelo Fisco são disponibilizados tanto para o emitente quanto para o destinatário. A manifestação do destinatário simplifica o download da NF-e, pois o Ambiente Nacional gera automaticamente um NSU para a NF-e completa após a manifestação, permitindo sua recuperação.
Recomendações para evitar o uso indevido
O Web Service NFeDistribuicaoDFe possui controles para identificar e prevenir o uso indevido, que pode sobrecarregar a infraestrutura e o canal de comunicação. O "consumo indevido" resulta na rejeição com código 656 e bloqueio temporário do CNPJ/CPF por uma hora.
Regras para evitar uso indevido na consulta distNSU:
- Consulta sem documentos: Se o retorno for
cStat=137(Nenhum documento localizado), indicando que não há mais documentos a serem retornados no momento, o usuário deve aguardar uma hora antes de realizar uma nova consulta. Tentar novamente antes desse período causará um bloqueio de uma hora. - Consulta não sequencial: O usuário deve sempre usar o
ultNSUretornado na consulta anterior para as requisições subsequentes. Consultar fora da sequência numérica ascendente resultará em bloqueio. SeultNSUfor igual amaxNSU, significa que não há mais documentos, e o usuário deve aguardar uma hora.
É fundamental que diferentes aplicações do mesmo ator (emitente, destinatário, transportador ou informado no campo autXML) sigam a mesma sequência ordenada de NSU para o mesmo CNPJ, evitando bloqueios por uso indevido. A partir da versão 1.14 da Nota Técnica, o ultNSU da última consulta é retornado na rejeição 656, auxiliando o usuário a retomar a sequência correta.
Regras para evitar uso indevido nas consultas consChNFe e consNSU:
As consultas por chave de acesso e por NSU são projetadas para buscas pontuais de documentos com no máximo 90 dias de retroatividade. Para download de múltiplos documentos dentro desse período, a consulta distNSU é a mais adequada.
- Quantidade de consultas por hora: Existe um limite de 20 consultas por chave de acesso ou NSU em um período de uma hora. Exceder esse limite resulta na rejeição
cStat=656e bloqueio do CNPJ/CPF por uma hora.
Em qualquer tipo de consulta, se o cStat=656 for recebido, o usuário deve aguardar uma hora completa antes de tentar novamente. Se a consulta for retomada antes desse intervalo, o contador de tempo é zerado e reinicia.
Endereços dos Web Services
Os endereços para acesso aos Web Services de Distribuição do Ambiente Nacional, tanto para produção quanto para homologação, são publicados nos portais oficiais da NF-e:
* Portal Nacional da NF-e
* Portal de Homologação (http://hom.nfe.fazenda.gov.br/portal)
Estes endereços estão disponíveis no menu "Serviços" / "Relação de Serviços Web".
Conclusão
O Web Service NFeDistribuicaoDFe é um serviço central para a gestão de documentos fiscais eletrônicos no Brasil, oferecendo um mecanismo padronizado e eficiente para que os atores da NF-e acessem informações de seu interesse. A conformidade com as regras de uso e as especificações da Nota Técnica 2014.002 é crucial para garantir o fluxo contínuo e confiável de dados, evitando interrupções e penalidades por consumo indevido. O entendimento detalhado das modalidades de consulta e das validações permite que empresas e profissionais de contabilidade otimizem seus processos de auditoria e conformidade fiscal.