NFeDistribuicaoDFe: Consulta DF-e e NF-e via Web Service Fiscal
Entenda o NFeDistribuicaoDFe, o Web Service que unifica o acesso a DF-e e NF-e para emitentes, destinatários e transportadores, conforme a NT 2014.002. Veja como consultar!
NFeDistribuicaoDFe: Consulta DF-e e NF-e via Web Service Fiscal
A administração tributária federal e estadual busca aprimorar a troca de informações fiscais, provendo dados relevantes de forma eficiente. A Nota Técnica 2014.002 detalha o uso do Web Service NFeDistribuicaoDFe, que permite o acesso a documentos e informações fiscais eletrônicas (DF-e) de interesse de pessoas físicas ou jurídicas envolvidas com a Nota Fiscal Eletrônica (NF-e). Este serviço visa disponibilizar de maneira automatizada os dados para emitentes, destinatários, transportadores e terceiros autorizados.
Nota Técnica 2014.002 e o Serviço NFeDistribuicaoDFe
O Projeto Nota Fiscal Eletrônica, por meio da Nota Técnica 2014.002, estabelece as diretrizes para a distribuição de DF-e. O documento, em sua versão 1.20 de maio de 2024, reflete uma série de atualizações desde sua versão inicial em 2014.
Histórico e atualizações
A Nota Técnica 2014.002 passou por diversas atualizações desde sua versão 1.00. Modificações importantes foram implementadas para incluir a distribuição de eventos como Registro de Passagem, Pedido de Prorrogação de Prazo, Cancelamento do prazo de suspensão do ICMS, Eventos de Averbação e o Comprovante de Entrega. A versão 1.02b introduziu a consulta por chave de acesso da NF-e e a distribuição do Evento de Cancelamento para destinatários sem manifestação prévia. A versão 1.10 trouxe otimizações na geração de NSU e a 1.20, mais recente, incluiu o evento "Ator Interessado".
Propósito do Web Service
O Web Service NFeDistribuicaoDFe tem a função de distribuir informações resumidas e documentos fiscais eletrônicos relevantes para os atores da NF-e. Este serviço, que opera de forma síncrona através do método nfeDistDFeInteresse, permite que empresas e pessoas físicas acessem DF-e que não foram gerados por eles, mas que são de seu interesse fiscal. O acesso exige a utilização de 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 (14 dígitos), desde que o CNPJ base (8 primeiros dígitos) consultado seja o mesmo do certificado digital utilizado. Os documentos 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.
Atores e documentos abrangidos
A distribuição de documentos é realizada para diversos atores envolvidos na NF-e, incluindo emitentes, destinatários, transportadores e terceiros informados na tag autXML. A disponibilidade dos documentos varia conforme o papel do ator.
Para destinatários, a NF-e completa só é retornada se houver manifestação (Ciência da Operação, Operação Não Realizada ou Confirmação de Operação). Caso contrário, apenas o resumo da NF-e é disponibilizado, contendo as informações necessárias para que o destinatário realize a manifestação. Transportadores e terceiros recebem a NF-e integralmente na consulta.
A distribuição abrange os seguintes documentos e resumos de eventos, com suas respectivas disponibilidades para cada tipo de ator:
- NF-e: Disponível para Destinatário, Transportador, Terceiros e CNPJ informado em evento 'Ator Interessado'.
- Evento de Cancelamento: Disponível para Destinatário, Transportador, Terceiros e CNPJ informado em evento 'Ator Interessado', mesmo sem manifestação.
- Evento de Carta de Correção: Disponível para Destinatário, Transportador, Terceiros e CNPJ informado em evento 'Ator Interessado'.
- Eventos de Manifestação do Destinatário: Disponível para Emitente e Terceiros.
- Eventos da Suframa (Vistoria/Internalização): Disponível para Emitente, Destinatário e Terceiros.
- EPEC: Disponível para Destinatário, Transportador e CNPJ informado em evento 'Ator Interessado'.
- Eventos de Pedido de Prorrogação de Prazo: Disponível para Destinatário.
- Eventos do Fisco em Resposta ao Pedido de Prorrogação: Disponível para Emitente e Destinatário.
- Evento de Averbação: Disponível para Emitente, Destinatário, Transportador, Terceiros e CNPJ informado em evento 'Ator Interessado'.
- Resumo de NF-e: Disponível para Destinatário.
- Resumo de Eventos CT-e Autorizado/Cancelado: Disponível para Emitente, Destinatário, Transportador, Terceiros e CNPJ informado em evento 'Ator Interessado'.
- Resumo de Eventos MDF-e Autorizado/Cancelado: Disponível para Emitente, Destinatário, Transportador, Terceiros e CNPJ informado em evento 'Ator Interessado'.
- Resumo de Eventos de Registro de Passagem: Disponível para Emitente, Destinatário, Transportador, Terceiros e CNPJ informado em evento 'Ator Interessado'.
- Evento de Comprovante de Entrega Autorizado/Cancelado (propagado do CT-e): Disponível para Emitente, Destinatário, Transportador, Terceiros e CNPJ informado em evento 'Ator Interessado'.
- Evento de Comprovante de entrega na NF-e e Cancelamento: Disponível para Destinatário, Transportador, Terceiros e CNPJ informado em evento 'Ator Interessado'.
Desde a versão 1.13 da Nota Técnica, eventos gerados pelo Fisco são distribuídos ao emitente, mesmo que o emitente e o destinatário sejam iguais, e independentemente da manifestação do destinatário.
Operacionalização do NFeDistribuicaoDFe
O Web Service NFeDistribuicaoDFe opera através de mensagens XML padronizadas, que contêm o pedido de distribuição de DF-e de interesse do ator. O retorno do serviço também segue um leiaute XML específico.
Mensagens de entrada e retorno
A mensagem de entrada para solicitar a distribuição de DF-e é uma estrutura XML que inclui o pedido. Campos importantes da mensagem de entrada (distDFeInt) são:
versao: Versão do leiaute.tpAmb: Identifica o ambiente (1=Produção / 2=Homologação).cUFAutor: Código da UF do autor.CNPJouCPF: CNPJ ou CPF do interessado no DF-e.distNSU: Grupo para distribuir DF-e a partir do Número Sequencial Único (NSU) informado.ultNSU: Último NSU recebido pelo ator, usado em consultas sequenciais.consNSU: Grupo para consultar um DF-e a partir de um NSU específico.NSU: Número Sequencial Único para consulta pontual.consChNFe: Grupo para consultar uma NF-e pela chave de acesso.chNFe: Chave de acesso específica da NF-e.
A mensagem de retorno (retDistDFeInt) é uma estrutura XML com os documentos de interesse, com uma quantidade máxima de 50 documentos por lote. Principais campos da mensagem de retorno:
versao: Versão do leiaute.tpAmb: Ambiente da resposta.verAplic: Versão do aplicativo que processou a consulta.cStat: Código do status da resposta (ex: 137 para nenhum documento localizado, 138 para documento(s) localizado(s)).xMotivo: Descrição literal do status da resposta.dhResp: Data e hora da resposta.ultNSU: Último NSU pesquisado, para continuar futuras consultas.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 DF-e compactado no padrão Gzip.NSU: NSU do documento fiscal dentro dodocZip.schema: Identificação do Schema XML para validar o documento compactado.
Formato e compactação dos dados
O tamanho médio de uma NF-e é de aproximadamente 10 KB. Para otimizar a infraestrutura de rede, cada documento na mensagem de retorno é compactado individualmente no padrão Gzip (tag docZip). Essa compactação pode reduzir o tamanho da mensagem em cerca de 60%, exigindo que a aplicação cliente descompacte os dados para processamento.
Tipos de consulta de Documentos Fiscais Eletrônicos
O pedido de distribuição via Web Service suporta três tipos de consultas, definidos pela tag informada no XML de requisição.
Distribuição por Número Sequencial Único (NSU)
Na consulta distNSU, a aplicação cliente informa o ultNSU que possui. O Ambiente Nacional então disponibiliza todos os documentos (NF-e e eventos) para o interessado a partir desse NSU. Se o NSU informado for anterior ao primeiro NSU disponível para distribuição, o serviço fornecerá os documentos fiscais mais antigos, desde que as NF-es e eventos tenham sido autorizados há menos de 90 dias. Os lotes de documentos são gerados em ordem crescente de NSU, com limite de 50 documentos por lote, e incluem qualquer tipo de documento válido.
Consulta de DF-e por NSU específico
A consulta consNSU permite que o interessado verifique de forma pontual um NSU específico que foi identificado como ausente em sua base de dados. O sistema retornará um único documento fiscal (NF-e ou evento) referente ao NSU solicitado. Este tipo de consulta, assim como as demais, está disponível para documentos recebidos pelo Ambiente Nacional nos últimos 90 dias.
Consulta de NF-e por Chave de Acesso
A consulta consChNFe possibilita a busca pontual de uma NF-e pela sua chave de acesso. A chave informada deve ser válida, existente no Ambiente Nacional e vinculada ao interessado (destinatário, transportador ou terceiro). Nesta modalidade, o Ambiente Nacional retorna apenas a NF-e, sem os eventos relacionados à chave de acesso 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. A disponibilidade para documentos é de até 90 dias após o recebimento pelo Ambiente Nacional.
Geração de Número Sequencial Único (NSU)
O Ambiente Nacional gera um NSU para cada documento fiscal de interesse, atribuído a cada CNPJ ou CPF. Desde a versão 1.10 da Nota Técnica, a geração de NSU considera apenas os usuários do serviço nos últimos 60 dias.
- Para usuários que utilizam o serviço regularmente nos últimos 60 dias, a geração de NSU prossegue normalmente.
- Novos usuários do serviço
distNSUterão a geração de NSU iniciada a partir do primeiro acesso, sem retroatividade. - Usuários que interromperem o uso do serviço
distNSUpor mais de 60 dias terão a geração de NSU interrompida e retomada a partir da próxima consulta, também sem retroatividade para o período de interrupção.
Para transportadores e CNPJs informados no campo autXML, o NSU só é gerado após a manifestação do destinatário, caso eles também sejam destinatários na mesma NF-e. Isso evita a duplicidade de NSU e garante a sequência numérica dos documentos.
Validações e Rejeições no Processo de Distribuição
O processo de distribuição via NFeDistribuicaoDFe envolve uma série de validações para garantir a integridade e segurança das informações. Falhas nestas validações resultam em rejeições com códigos e motivos específicos.
Validação do certificado digital
O certificado digital utilizado para a transmissão da mensagem é validado em diversas etapas, garantindo que o transmissor seja autêntico e autorizado. Algumas das regras de validação incluem:
- A01: Certificado de Transmissor Inválido (inexistente, versão incorreta, uso indevido para autenticação). Rejeição 280.
- A02: Validade do Certificado (data de início e fim). Rejeição 281.
- A03: Verificação da Cadeia de Certificação (AC emissora não cadastrada/revogada, certificado não assinado). Rejeição 283.
- A04: Lista de Certificados Revogados (LCR) indisponível ou inválida. Rejeição 286.
- A05: Certificado do Transmissor revogado. Rejeição 284.
- A06: Certificado Raiz difere da "ICP-Brasil". Rejeição 285.
- A07: Ausência da extensão de CNPJ ou CPF no Certificado. Rejeição 473.
As validações A01 a A05 são comumente realizadas pelo protocolo SSL, enquanto a A06 pode ser feita pelo SSL, mas pode falhar se houver outros certificados de AC Raiz além do 'ICP-Brasil'.
Validação inicial da mensagem
Antes de qualquer processamento, a mensagem XML enviada ao Web Service passa por validações iniciais:
- B01: Tamanho do XML de Dados superior a 10 KB. Rejeição 214.
- B02: Servidor de Processamento paralisado momentaneamente. Rejeição 108.
- B03: Servidor de Processamento paralisado sem previsão. Rejeição 109.
Mensagens com tamanho superior a 10 KB serão descartadas, podendo resultar na interrupção da conexão sem retorno de erro se o controle for via rede, ou erro 214 se for por aplicativo.
Validação da área de dados e regras de negócio
A área de dados da mensagem também é validada quanto à sua forma e regras de negócio:
- D01: Verifica Schema XML da área de Dados. Rejeição 215.
- D02: Verifica o uso de prefixo no namespace. Rejeição 404.
- D03: XML utiliza codificação diferente de UTF-8. Rejeição 402.
- D04: Versão dos Dados informada superior à versão vigente. Rejeição 238.
- D05: Versão dos Dados não suportada. Rejeição 239.
Além disso, regras de negócio específicas são aplicadas, incluindo:
- H01: Tipo de ambiente da NF-e difere do ambiente do Web Service. Rejeição 252.
- H02/H03: CNPJ/CPF do interessado na distribuição inválido. Rejeições 489/490.
- H04/H05: CNPJ-Base do Certificado Digital difere do CNPJ consultado, ou CPF do certificado difere do CPF consultado. Rejeições 593/472.
- H06: NSU informado superior ao maior NSU disponível. Rejeição 589.
- H07 a H13: Chave de Acesso inválida (dígio verificador, UF, ano, mês, CNPJ, modelo, número NF). Rejeições 236, 614, 615, 616, 617, 618, 619.
- H14: NF-e inexistente para a chave de acesso informada. Rejeição 217.
- H15: NF-e fora do prazo de download (90 dias). Rejeição 632.
- H16: CNPJ/CPF do interessado não possui permissão para consultar. Rejeição 640.
- H17: NF-e não deve ser disponibilizada para o emitente. Rejeição 641.
- H18/H19: NF-e Cancelada ou Denegada, arquivo indisponível para download. Rejeições 653/654.
Resumos de NF-e e Eventos
Para possibilitar o compartilhamento de informações relevantes mantendo o sigilo, foram criados leiautes para resumos de NF-e e de eventos.
Leiaute resumo da NF-e
O resNFe_v9.99.xsd define a estrutura XML com as informações resumidas da NF-e. Este resumo é gerado e distribuído para os destinatários quando a NF-e é autorizada ou denegada, permitindo sua manifestação. Os campos incluem:
chNFe: Chave de acesso da NF-e.CNPJouCPF: CNPJ ou CPF do Emitente.xNome: Razão Social ou Nome do Emitente.IE: Inscrição Estadual do Emitente.dhEmi: Data de Emissão da NF-e no formato UTC.tpNF: Tipo de Operação (0=Entrada; 1=Saída).vNF: Valor Total da NF-e.digVal: Digest Value da NF-e.dhRecbto: Data de autorização da NF-e.nProt: Número de protocolo da NF-e.cSitNFe: Situação da NF-e (1=Uso autorizado; 2=Uso denegado; 3=NF-e Cancelada).
Leiaute resumo do evento de NF-e
O resEvento_v9.99.xsd descreve a estrutura XML para o conjunto de informações resumidas de um evento de NF-e. Este leiaute contém dados como:
cOrgao: Código do órgão de recepção do Evento (91 para Ambiente Nacional).CNPJouCPF: CNPJ ou CPF do Emitente.chNFe: Chave de acesso da NF-e vinculada ao evento.dhEvento: Data e hora do evento no formato UTC.tpEvento: Código do evento.nSeqEvento: Número sequencial do evento.xEvento: Descrição do evento.dhRecbto: Data de autorização do evento.nProt: Número de protocolo do evento.
Modelo de Distribuição e Prevenção ao Uso Indevido
O modelo de distribuição de documentos fiscais eletrônicos é baseado na geração de um Número Sequencial Único (NSU) para cada CNPJ ou CPF interessado, garantindo uma sequência ordenada.
Visão geral do fluxo de distribuição
O fluxo de distribuição via Web Service NFeDistribuicaoDFe permite que empresas e pessoas físicas consultem documentos de seu interesse a qualquer momento. Os passos exemplificam a geração e recuperação de NSU para emitente e destinatário:
- O emitente transmite uma NF-e, que é autorizada pela Sefaz e compartilhada com o Ambiente Nacional.
- O Ambiente Nacional gera um NSU para o destinatário referente ao resumo da NF-e.
- O destinatário consulta o serviço NFeDistribuicaoDFe com o último NSU recebido e recupera o resumo da NF-e.
- Com o resumo da NF-e, o destinatário gera um evento de manifestação.
- O Ambiente Nacional gera um NSU do evento para o emitente.
- 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).
- 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 para sua NF-e (ex: cancelamento).
- O Ambiente Nacional gera um NSU para o destinatário do evento.
- O destinatário consulta o serviço e recupera o evento gerado pelo emitente.
- O Ambiente Nacional recebe um evento gerado pelo fisco, gera NSUs para o emitente e destinatário.
- Ambos consultam o serviço e recuperam o evento gerado pelo fisco.
Este modelo permite ao emitente consultar eventos manifestados pelos destinatários e ao destinatário acessar eventos gerados pelo emitente ou pelo fisco. A manifestação do destinatário simplifica o processo de download da NF-e completa.
Recomendações para evitar o uso indevido
Para manter a estabilidade do sistema e evitar sobrecarga, existem controles para identificar e restringir o uso indevido do Web Service NFeDistribuicaoDFe. O uso indevido resulta na rejeição 656 ("Consumo Indevido") e no bloqueio temporário do CNPJ/CPF.
Para consultas distNSU, as regras são:
- Não há mais documentos a distribuir e o usuário continua consultando: Se o retorno for
cStat=137(Nenhum documento localizado), o usuário deve aguardar uma hora para nova consulta. Consultas dentro desse período de uma hora resultarão em bloqueio por uma hora. - Usuário não consulta NSU de forma sequencial: É necessário utilizar o
ultNSUretornado na consulta anterior como ponto de partida para a próxima solicitação. Consultar fora da sequência gera bloqueio. OultNSUna rejeição 656 ajuda a retomar a consulta. - Múltiplas aplicações do mesmo ator: Se diferentes aplicações de um mesmo ator consultarem por NSU para o mesmo CNPJ (14 dígitos), elas devem seguir a mesma sequência ordenada e ascendente para evitar uso indevido.
Para consultas consChNFe e consNSU:
- Quantidade de consultas por hora excedida: Há um limite de 20 consultas por hora para estes tipos. Exceder este limite resulta em bloqueio de uma hora. Se o usuário tentar consultar antes do término do bloqueio, o tempo é zerado e a contagem reinicia.
Endereços dos Web Services e Códigos de Erro
Os endereços dos Web Services de Distribuição do Ambiente Nacional estão disponíveis 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".
Uma tabela de códigos de erros e descrições de mensagens de erros detalha os possíveis retornos do serviço. Entre eles, destacam-se:
- 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: Rejeição: Certificado Transmissor inválido.
- 473: Rejeição: Certificado Transmissor sem CNPJ ou CPF.
- 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).
- 656: Rejeição: Consumo Indevido.
Esses códigos e descrições auxiliam na identificação e correção de problemas durante a interação com o Web Service.
Conclusão
O Web Service NFeDistribuicaoDFe, conforme a Nota Técnica 2014.002, é um serviço fundamental para a gestão fiscal de empresas e indivíduos. Ele oferece um acesso organizado e padronizado a documentos fiscais eletrônicos e informações resumidas, considerando o papel de cada ator na operação da NF-e. A compreensão dos tipos de consulta (por NSU, NSU específico, ou chave de acesso), dos leiautes de mensagens e das regras de validação é importante para garantir a correta utilização do serviço e evitar rejeições ou bloqueios por uso indevido. As atualizações contínuas da nota técnica visam aprimorar a eficiência e a confiabilidade da distribuição de DF-e no ambiente nacional.