NFeDistribuicaoDFe: Consulta de DF-e e Notas Fiscais Eletrônicas
Explore o Web Service NFeDistribuicaoDFe para acessar DF-e e NF-e de interesse. Saiba como consultar documentos fiscais eletrônicos com certificado digital e suas últimas atualizações.
NFeDistribuicaoDFe: Consulta de DF-e e Notas Fiscais Eletrônicas
O Web Service NFeDistribuicaoDFe permite a atores fiscais, sejam pessoas físicas ou jurídicas, o acesso a Documentos Fiscais Eletrônicos (DF-e) e informações resumidas de seu interesse. Este serviço regulamentado pela Nota Técnica 2014.002 v1.20, que detalha seu funcionamento e as regras para distribuição de dados. O objetivo principal é fornecer de maneira eficiente e confiável informações relevantes sobre Notas Fiscais Eletrônicas (NF-e) aos envolvidos.
O acesso aos documentos é feito para emitentes, destinatários, transportadores e terceiros autorizados, conforme identificados no conteúdo da NF-e pelos grupos específicos (emitente, destinatário, transportador, pessoas físicas autorizadas a acessar o XML). O serviço distribui informações resumidas e DF-e de interesse que não foram gerados pelo próprio ator, mediante uso de certificado digital de Pessoa Jurídica (PJ) ou Pessoa Física (PF).
Histórico de alterações do serviço
A Nota Técnica 2014.002 teve diversas atualizações desde sua versão inicial em janeiro de 2014, desenvolvida pelo Serpro. As alterações buscaram otimizar a distribuição de DF-e e eventos, além de incluir novas funcionalidades. Por exemplo:
- Versão 1.02b: Incluiu a distribuição de eventos como Registro de Passagem, Pedido de Prorrogação/Cancelamento do prazo de suspensão do ICMS e outros Eventos de Resposta do Fisco. Permitiu a consulta por Chave de Acesso da NF-e e a distribuição do Evento de Cancelamento para destinatário, independente de sua manifestação.
- Versão 1.02c: Adicionou a distribuição de Eventos de Averbação e do Evento de Comprovante de Entrega.
- Versão 1.02d: Focou em melhorias na documentação, esclarecendo os tipos de consulta (por Chave de Acesso, por Número Sequencial Único - NSU) e detalhando as situações de uso indevido.
- Versão 1.10/1.11: Trouxe alterações na geração de NSU para otimização da distribuição e incluiu o evento de Comprovante de Entrega da NF-e, conforme a NT 2021.001.
- Versão 1.13: Passou a disponibilizar eventos do Fisco para emitente e destinatário, mesmo quando forem iguais, independente da manifestação do destinatário.
- Versão 1.14: Permitiu o retorno do último NSU na rejeição 656 ("Consumo Indevido") para consultas via "distNSU".
- Versão 1.15: Tornou o retorno de NSU facultativo.
- Versão 1.20 (Maio de 2024): Incluiu o evento "Ator Interessado".
Detalhes do Web Service NFeDistribuicaoDFe
O serviço NFeDistribuicaoDFe é síncrono e usa o método nfeDistDFeInteresse. Ele disponibiliza informações resumidas e documentos fiscais eletrônicos para qualquer ator da NF-e, pessoa física ou jurídica, que possua certificado digital. Para pessoas jurídicas, a consulta pode ser feita para qualquer CNPJ da empresa, desde que o CNPJ base (8 primeiros dígitos) seja o mesmo do certificado digital.
Os documentos e informações ficam disponíveis por até 90 dias após a recepção pelo Ambiente Nacional da NF-e. O retorno de uma NF-e integral ao destinatário depende da existência de sua manifestação ("Ciência da Operação", "Operação não Realizada" ou "Confirmação de Operação"). Sem manifestação, é retornado apenas o resumo da NF-e. Para transportadores e terceiros, a NF-e é disponibilizada integralmente na consulta.
A distribuição abrange documentos conforme o papel do ator, com a seguinte disponibilidade:
- NF-e: Disponível para destinatário, transportador, terceiros e CNPJ informado em evento "Ator Interessado".
- Eventos de Cancelamento, Carta de Correção: Disponíveis para destinatário, transportador, terceiros e CNPJ "Ator Interessado".
- Eventos de Manifestação do Destinatário: Disponíveis para emitente e terceiros.
- Eventos da Suframa (Vistoria/Internalização): Disponíveis para emitente, destinatário e terceiros.
- EPEC: Disponível para destinatário, transportador e CNPJ "Ator Interessado".
- Eventos de Pedido de Prorrogação de Prazo: Disponíveis para destinatário.
- Eventos do Fisco em Resposta ao Pedido de Prorrogação: Disponíveis para emitente e destinatário.
- Evento de Averbação: Disponível para emitente, destinatário, transportador, terceiros e CNPJ "Ator Interessado".
- Resumo de NF-e: Disponível para destinatário.
- Resumo de Eventos CT-e Autorizado/Cancelado e MDF-e Autorizado/Cancelado: Disponíveis para emitente, destinatário, transportador, terceiros e CNPJ "Ator Interessado".
- Resumo de Eventos de Registro de Passagem: Disponíveis para emitente, destinatário, transportador, terceiros e CNPJ "Ator Interessado".
- Evento de Comprovante de Entrega propagado do CT-e e na NF-e e Cancelamento: Disponíveis para emitente, destinatário, transportador, terceiros e CNPJ "Ator Interessado".
Os documentos fiscais e resumos de eventos ficam disponíveis para o destinatário apenas com manifestação, exceto para o Evento de Cancelamento. A NF-e estará disponível para o transportador se identificado no grupo X03 ou no evento "Ator Interessado na NF-e". Para terceiros, a NF-e é liberada se o CNPJ ou CPF estiver na tag autXML.
Leiaute da mensagem de entrada
A requisição XML para o serviço de distribuição de DF-e de interesse do ator utiliza o schema 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.CNPJouCPF: Identificação do interessado no DF-e.distNSU: Grupo para distribuição de DF-e a partir do último NSU recebido (ultNSU).consNSU: Grupo para consultar um DF-e por um NSU específico (NSU).consChNFe: Grupo para consultar uma NF-e pela Chave de Acesso informada (chNFe).
Leiaute da mensagem de retorno
A resposta do serviço retorna uma estrutura XML com os documentos de interesse, limitada a um máximo de 50 documentos por lote, usando o schema retDistDFeInt_v9.99.xsd. Elementos relevantes no retorno incluem:
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 resposta.ultNSU: Último NSU pesquisado no Ambiente Nacional, indicando onde continuar a consulta para novos resultados.maxNSU: Maior NSU existente no Ambiente Nacional para o CNPJ/CPF informado.loteDistDFeInt: Conjunto de informações resumidas e documentos fiscais eletrônicos.docZip: Informação resumida ou documento fiscal eletrônico, compactado no padrão Gzip (GNU zip), tipobase64Binary.NSU(atributo dedocZip): NSU do documento fiscal.schema(atributo dedocZip): Identificação do Schema XML para validação do documento.
A compactação Gzip dos documentos na mensagem de retorno reduz o tamanho da mensagem em aproximadamente 60%, otimizando o uso da infraestrutura de rede.
Processo de distribuição de DF-e
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, a geração de NSU considera apenas usuários do serviço nos últimos 60 dias. Para novos usuários ou para aqueles que ficaram mais de 60 dias sem utilizar o serviço, a geração de NSU é retomada a partir do primeiro acesso subsequente, sem retroatividade para o período de interrupção. O primeiro acesso nessas condições pode retornar "cStat=137-Nenhum documento localizado".
O XML do pedido de distribuição suporta três tipos de consulta:
- distNSU – Distribuição de conjunto de DF-e a partir do NSU informado: A aplicação cliente informa o último NSU que possui, e o Ambiente Nacional fornece todos os documentos e eventos disponíveis a partir desse NSU. Se o NSU informado for menor que o primeiro disponível, são fornecidos documentos dos últimos 90 dias.
- consNSU – Consulta DF-e vinculado ao NSU informado: Permite consultar pontualmente um NSU específico que foi identificado como faltante na base de dados do interessado. O Ambiente Nacional retorna um único documento fiscal (NF-e ou evento) referente ao NSU informado.
- consChNFe – Consulta de NF-e por Chave de Acesso informada: Permite consultar pontualmente uma NF-e pela Chave de Acesso. O Ambiente Nacional retorna somente a NF-e (sem eventos) referente à Chave de Acesso. A partir da versão 1.15 da Nota Técnica, essa consulta não exige prévia geração de NSU para o documento.
As consultas estão disponíveis para documentos recebidos pelo Ambiente Nacional nos últimos 90 dias.
Validação e regras de negócio
A transmissão de informações exige o uso de certificado digital de PJ ou PF válido. O Web Service realiza diversas validações, como:
- Certificado de Transmissão: Verifica validade, cadeia de certificação e se o certificado possui a extensão de CNPJ ou CPF correspondente.
- Mensagem Inicial: Avalia o tamanho do XML de dados (máximo 10 KB) e o status de paralisação do servidor de processamento.
- Área de Dados: Valida o schema XML, o uso de prefixo no namespace, a codificação UTF-8 e a versão dos dados.
- Regras de Negócio: Verifica a validade do CNPJ/CPF do interessado, a conformidade do CNPJ/CPF do certificado digital com o consultado, a validade da Chave de Acesso (UF, ano, mês, CNPJ, modelo, número da NF), se a NF-e existe e está no prazo de download (90 dias). A NF-e não é disponibilizada para o emitente da NF-e ou se estiver cancelada/denegada.
Leiautes resumidos
Para otimizar o compartilhamento de informações relevantes e manter o sigilo, foram criados leiautes resumidos de NF-e e eventos:
- Leiaute Resumo da NF-e: Contém informações essenciais como Chave de Acesso, CNPJ/CPF e Razão Social 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. Sua finalidade é possibilitar a manifestação do destinatário.
- Leiaute Resumo do Evento de NF-e: Inclui Código do Órgão, 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.
Visão geral do modelo de distribuição
O modelo de distribuição de documentos baseia-se na geração de um NSU para cada CNPJ ou CPF. O fluxo geralmente envolve:
- Emitente transmite uma NF-e, autorizada pela Sefaz e compartilhada com o Ambiente Nacional.
- Ambiente Nacional gera um NSU para o destinatário com o resumo da NF-e.
- Destinatário consulta o Web Service, recupera o resumo e pode gerar um evento de manifestação.
- Se houver manifestação (exceto "desconhecimento da operação"), o Ambiente Nacional gera um NSU para o destinatário com a NF-e completa (liberação para download).
- Eventos gerados pelo emitente (ex: cancelamento) ou pelo Fisco também geram NSUs para os atores envolvidos.
Este modelo permite ao emitente consultar eventos manifestados pelos destinatários e ao destinatário acessar eventos gerados pelo emitente e pelo Fisco. O download da NF-e é simplificado, pois a manifestação do destinatário aciona a geração automática de um NSU para a NF-e completa.
Recomendações para evitar o uso indevido
Para prevenir sobrecarga no ambiente e no canal de comunicação, o Web Service NFeDistribuicaoDFe implementa controles contra uso indevido. Consultas que não seguem as regras podem resultar na rejeição "656 - Consumo Indevido".
As principais situações de uso indevido na consulta com distNSU incluem:
- 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 antes de realizar nova consulta. Consultas antes desse prazo resultam em bloqueio do CNPJ por uma hora. - Usuário não consulta os NSUs de forma sequencial: O
ultNSUretornado na consulta anterior deve ser usado como ponto de partida para a próxima. SeultNSUfor igual amaxNSU, não há mais documentos e é necessário aguardar uma hora. Consultar fora da sequência também gera bloqueio.
Para consultas com consChNFe e consNSU, o limite é de 20 consultas por hora. Exceder esse limite também resulta em bloqueio por uma hora. Em qualquer caso de rejeição por consumo indevido (cStat=656), o tempo de uma hora para desbloqueio é zerado se uma nova consulta for feita antes do término do período.
Endereços dos Web Services
Os endereços para os Web Services de Distribuição do Ambiente Nacional, tanto para produção quanto para homologação, são divulgados nos respectivos portais da NF-e (http://www.nfe.fazenda.gov.br/portal e http://hom.nfe.fazenda.gov.br/portal), no menu "Serviços" / "Relação de Serviços Web".
Tabela de códigos de erros e descrições
O sistema utiliza uma série de códigos de status (cStat) para informar o resultado do processamento da solicitação. Alguns exemplos 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 à validação do Certificado Transmissor.
- 472: Rejeição: CPF consultado difere do CPF do Certificado Digital.
- 473: Rejeição: Certificado Transmissor sem CNPJ ou CPF.
- 489/490: Rejeição: CNPJ/CPF informado inválido.
- 593: Rejeição: CNPJ-Base consultado difere do CNPJ-Base do Certificado Digital.
- 614-619: Rejeições por Chave de Acesso inválida (UF, ano, mês, CNPJ, modelo, número da NF).
- 632: Rejeição: Solicitação fora de prazo, a NF-e não está mais disponível para download (após 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/654: Rejeição: NF-e Cancelada/Denegada, arquivo indisponível para download.
- 656: Rejeição: Consumo Indevido.
- 999: Rejeição: Erro não catalogado.
Exemplos de requisições e retornos XML
A Nota Técnica 2014.002 ilustra a estrutura das requisições e retornos XML para o Web Service. Por exemplo, uma requisição para distNSU em ambiente de homologação incluiria o tpAmb como '2' e o ultNSU. Já uma consulta consChNFe em produção especificaria tpAmb como '1' e a chNFe desejada. Os retornos podem indicar sucesso (cStat=138), ausência de documentos (cStat=137) ou uma rejeição com código específico, como cStat=589 (NSU informado superior ao maior NSU disponível). Esses exemplos demonstram a interação técnica para o uso do serviço.
Conclusão
O Web Service NFeDistribuicaoDFe é um recurso para a gestão de documentos fiscais eletrônicos, permitindo que os diferentes atores envolvidos com a NF-e consultem e obtenham documentos e informações de seu interesse. O conhecimento das regras de validação, dos tipos de consulta e das recomendações de uso é importante para garantir a utilização eficiente e a conformidade com as diretrizes do Ambiente Nacional da NF-e.