NFeDistribuicaoDFe: Acesse NF-e e DF-e para Contadores e Empresas
NFeDistribuicaoDFe: Web Service para consulta de NF-e, DF-e e eventos fiscais. Emitentes, destinatários e transportadores otimizam acesso e gestão fiscal.
O Ambiente Nacional da Nota Fiscal Eletrônica (NF-e) disponibiliza informações relevantes para os participantes dos processos da NF-e por meio do Web Service NFeDistribuicaoDFe. Este serviço visa fornecer documentos e informações fiscais eletrônicas de interesse de emissores, destinatários, transportadores e terceiros autorizados. Com a sua implementação, o Web Service NFeConsultaDest, que provia informações para a manifestação do destinatário, será descontinuado.
NFeDistribuicaoDFe: O Web Service de Distribuição de DF-e
O Web Service NFeDistribuicaoDFe é responsável pela distribuição de documentos e informações de interesse dos atores da NF-e. Seu objetivo é disponibilizar de forma eficiente e confiável os Documentos Fiscais Eletrônicos (DF-e) e dados resumidos para pessoas físicas ou jurídicas envolvidas nas operações de NF-e.
Objetivo e papel no cenário da NF-e
A Nota Técnica 2014/002 estabelece que este serviço distribui informações e DF-e para quem desempenha papéis de emitente, destinatário, transportador e terceiros autorizados. O grupo do Emitente, o grupo do Destinatário, o grupo do Transportador e o grupo de pessoas físicas autorizadas a acessar o XML são os perfis de interesse considerados. A versão da Nota Técnica é 1.02, com divulgação em Outubro/2016 e vigência em ambiente de produção a partir de 09/01/2017. Os serviços NfeConsultaDest e NFeDownloadNF foram desativados em 02/05/2017, consolidando as funcionalidades no NFeDistribuicaoDFe.
Quem pode acessar e por quanto tempo
O acesso ao Web Service NFeDistribuicaoDFe é permitido a qualquer pessoa jurídica ou física que possua um certificado digital válido. Para pessoas jurídicas, a autenticação ocorre pelo CNPJ base, permitindo a consulta com qualquer CNPJ da empresa, desde que o CNPJ base do certificado digital seja o mesmo do CNPJ consultado. Os documentos fiscais eletrônicos e informações resumidas ficam acessíveis para distribuição por até três meses após a sua recepção pelo Ambiente Nacional da NF-e.
Documentos e eventos disponíveis para consulta
O NFeDistribuicaoDFe distribui diversos tipos de documentos e eventos, dependendo do papel do interessado:
- NF-e: Disponível para o destinatário (após manifestação de "Ciência da Operação", "Operação não Realizada" ou "Confirmação de Operação"), transportador (identificado no grupo X03) e terceiros (com CNPJ ou CPF informado no grupo de pessoas físicas autorizadas a acessar o XML). Não disponível para o emitente.
- Evento de Cancelamento: Disponível para destinatário (mesmo sem manifestação), transportador e terceiros.
- Evento de Carta de Correção: Disponível para destinatário, transportador e terceiros.
- Eventos de Manifestação do Destinatário: Disponíveis para o emitente e terceiros.
- Eventos da Suframa (Vistoria/Internalização): Disponíveis para emitente, destinatário e terceiros.
- EPEC (Evento Prévio de Emissão em Contingência): Disponível para destinatário e transportador.
- Eventos de Pedido de Prorrogação de Prazo: Disponíveis para o destinatário (referentes à Nota Técnica 2015.001, como EPP1, EPP2, ECPP1, ECPP2).
- Eventos do Fisco em Resposta ao Pedido de Prorrogação: Disponíveis para emitente e destinatário (referentes à Nota Técnica 2015.001, como EFPP1, EFPP2, EFCPP1, EFCPP2).
- Resumo de NF-e: Disponível para o destinatário (sempre, antes da manifestação).
- Resumo de Eventos CT-e Autorizado/Cancelado: Disponível para emitente, destinatário, transportador e terceiros.
- Resumo de Eventos MDF-e Autorizado/Cancelado: Disponível para emitente, destinatário, transportador e terceiros.
- Resumo de Eventos de Registro de Passagem: Disponível para emitente, destinatário, transportador e terceiros.
Tipos de Consulta via NFeDistribuicaoDFe
O pedido de distribuição, feito por meio de uma estrutura XML, suporta três tipos de consulta, definidos pela tag informada no XML de requisição: distNSU, consNSU e consChNFe.
Distribuição por NSU (distNSU)
Neste tipo de consulta, a aplicação cliente deve informar o último Número Sequencial Único (ultNSU) que possui em sua base. O Web Service do Ambiente Nacional gerará lotes de até 50 documentos, incluindo informações resumidas ou DF-e, com NSU superior ao informado. Se o NSU informado for menor que o primeiro NSU disponível, o sistema fornecerá os documentos a partir do primeiro. Os documentos são retornados em ordem crescente de NSU, e um lote pode conter diferentes tipos de documentos válidos. Documentos emitidos pela própria empresa não são disponibilizados.
É importante observar que o processo de recepção e sincronização não segue a ordem cronológica de emissão ou autorização de uso, mas sim a ordem cronológica de recepção pelo Ambiente Nacional. Assim, a empresa ou pessoa física pode recuperar todos os documentos de seu interesse assim que forem recebidos pelo Ambiente Nacional da NF-e.
Consulta de DF-e por NSU específico (consNSU)
Quando uma lacuna é identificada na sequência de NSUs na base de dados do interessado, o processo consNSU permite a consulta pontual de um DF-e a partir de um NSU específico. A aplicação cliente informa o NSU faltante e o Web Service retorna o documento correspondente ou indica que o NSU não existe no Ambiente Nacional. Esta funcionalidade ajuda a preencher eventuais lacunas de documentos.
Consulta de NF-e por Chave de Acesso (consChNFe)
A consulta por chave de acesso (chNFe) permite que o interessado recupere uma NF-e específica. A chave de acesso informada deve ser válida, existir no Ambiente Nacional e estar vinculada ao interessado como destinatário, transportador ou terceiro. Para o destinatário, se houver manifestação ("Ciência da Operação", "Operação não Realizada" ou "Confirmação de Operação"), a NF-e completa é retornada. Caso contrário, apenas o resumo da NF-e é disponibilizado, contendo informações para que a manifestação seja realizada. Transportadores e terceiros recebem a NF-e integralmente. Esta consulta não está disponível para o emitente da NF-e e é limitada a documentos recebidos pelo Ambiente Nacional nos últimos 90 dias.
Mensagens e Processamento
O envio e retorno das informações no Web Service NFeDistribuicaoDFe seguem leiautes XML específicos e regras de processamento.
Estrutura da mensagem de entrada
A mensagem de entrada é uma estrutura XML que contém o pedido de distribuição de DF-e. Os principais campos incluem:
* versao: Versão do leiaute.
* tpAmb: Identificação do Ambiente (1=Produção / 2=Homologação).
* cUFAutor: Código da UF do autor (opcional).
* CNPJ/CPF: CNPJ ou CPF do interessado no DF-e (apenas um deve ser informado).
* distNSU: Grupo para distribuição por NSU, com o último NSU recebido (ultNSU).
* consNSU: Grupo para consultar um DF-e por NSU específico, com o NSU desejado.
* consChNFe: Grupo para consultar uma NF-e por chave de acesso, com a chave de acesso específica (chNFe).
O pedido de distribuição é enviado via Web Service e exige um certificado digital de Pessoa Jurídica ou Física válido.
Estrutura e compactação da mensagem de retorno
A mensagem de retorno é uma estrutura XML contendo os documentos de interesse do ator, com quantidade máxima de 50 documentos. Os campos 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.
* dhResp: Data e hora da resposta.
* ultNSU: Último NSU pesquisado no Ambiente Nacional, para continuidade da consulta.
* maxNSU: Maior NSU existente no Ambiente Nacional para o CNPJ/CPF informado.
* loteDistDFeInt: Conjunto de informações e documentos fiscais eletrônicos.
* docZip: Informação resumida ou documento fiscal eletrônico, compactado no padrão Gzip. Este campo também possui atributos como o NSU do documento e o schema XML para validação.
A compactação individual de cada documento contido na mensagem de retorno (campo docZip) reduz o tamanho da mensagem em aproximadamente 60%, minimizando as necessidades de infraestrutura de rede. A aplicação cliente é responsável por descompactar o conteúdo para tratamento.
Processamento e regras dos pedidos de distribuição
Ao receber uma requisição distNSU, o Web Service gera lotes de até 50 documentos para o interessado, com NSUs superiores ao informado. Caso o NSU seja menor que o primeiro disponível, a consulta começa do primeiro. Os documentos são organizados em ordem crescente de NSU. Para requisições consNSU, o sistema busca o NSU específico, e para consChNFe, valida a chave de acesso e permissões antes de retornar a NF-e completa ou resumida. O Ambiente Nacional gera um Número Sequencial Único (NSU) para cada interessado nos documentos fiscais, assegurando uma sequência sem intervalos.
As respostas podem ser:
* Rejeição: Com o motivo da falha no código de status (cStat).
* Nenhum documento localizado: Código 137-Nenhum documento localizado.
* Documento(s) localizado(s): Código 138-Documento(s) localizado(s).
Se o ultNSU informado for igual ao maxNSU do Ambiente Nacional, não há mais documentos a serem pesquisados no momento. Nesses casos, a empresa deve aguardar no mínimo uma hora antes de fazer uma nova solicitação de distribuição para evitar consumo indevido.
Validações Essenciais para o Acesso
O acesso ao Web Service NFeDistribuicaoDFe passa por diversas etapas de validação para garantir a segurança e a integridade das informações.
Validação do certificado digital
O certificado de transmissão utilizado na requisição é validado quanto a:
* Validade: Se é inexistente, se a versão difere, se o Basic Constraint é true (não pode ser certificado de AC), se o KeyUsage não define "Autenticação Cliente".
* Prazo: Validade do certificado (data início e fim).
* Cadeia de Certificação: Se o certificado da Autoridade Certificadora (AC) emissora é cadastrado no Ambiente Nacional, se a AC foi revogada, se o certificado não foi assinado pela AC.
* Lista de Certificados Revogados (LCR): Endereço da LCR, disponibilidade e validade.
* Revogação: Se o certificado do transmissor foi revogado.
* Certificado Raiz: Se o certificado raiz difere da "ICP-Brasil".
* Extensões: Falta da extensão de CNPJ (OID=2.16.76.1.3.3) ou CPF (OID=2.16.76.1.3.1) no certificado.
A maioria dessas validações é feita pelo protocolo SSL, mas algumas são verificadas pelo próprio Web Service.
Validação inicial da mensagem e área de dados
A mensagem XML de requisição é submetida a validações iniciais e da área de dados:
* Tamanho: A mensagem não pode exceder 10 KB. Mensagens maiores são rejeitadas com erro 214.
* Disponibilidade do Serviço: Verifica se o servidor de processamento está paralisado momentaneamente (108) ou sem previsão (109).
* Schema XML: Validação da conformidade da área de dados com o schema XML. (erro 215)
* Prefixo Namespace: Não é permitido o uso de prefixos no namespace. (erro 404)
* Codificação: O XML deve usar codificação UTF-8. (erro 402)
* Versão dos Dados: A versão informada não pode ser superior à vigente (238) ou não suportada (239).
Regras de negócio da requisição
Diversas regras de negócio são aplicadas para processar a requisição:
* Ambiente: O ambiente informado na NF-e deve ser o mesmo do Web Service. (erro 252)
* CNPJ/CPF: O CNPJ ou CPF do interessado na distribuição deve ser válido (sem DV ou zeros inválidos). (erros 489, 490)
* Certificado Digital: O CNPJ base do certificado digital deve ser o mesmo do CNPJ consultado (593) ou o CPF deve ser o mesmo do consultado (472).
* NSU: O NSU informado não pode ser superior ao maior NSU disponível. (erro 589)
* Chave de Acesso (consChNFe):
* Dígito verificador inválido (236).
* Código da UF inválido (614).
* Ano menor que 06 ou maior que o ano corrente (615).
* Mês menor que 1 ou maior que 12 (616).
* CNPJ zerado ou dígito inválido (617).
* Modelo diferente de 55 (618).
* Número da NF igual a 0 (619).
* NF-e inexistente para a chave (217).
* Fora do prazo de download (90 dias) (632).
* CNPJ/CPF do interessado sem permissão (640).
* NF-e indisponível para o emitente (641).
* NF-e Cancelada ou Denegada (653, 654) torna o arquivo indisponível para download.
Leiautes Resumidos e o Modelo de Distribuição
Para manter o sigilo das informações e permitir o compartilhamento de dados essenciais, foram desenvolvidos leiautes resumidos de NF-e e de eventos.
Informações resumidas de NF-e e eventos
Dois novos leiautes foram criados:
* Leiaute Resumo da NF-e (resNFe_v9.99.xsd): Estrutura XML com informações resumidas da NF-e, gerada pelo Ambiente Nacional. Inclui a chave de acesso, CNPJ/CPF e Razão Social do emitente, Inscrição Estadual, data de emissão, tipo de operação (Entrada/Saída), 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, Uso denegado, NF-e Cancelada). É distribuído para os destinatários para possibilitar a manifestação.
* Leiaute Resumo do Evento de NF-e (resEvento_v9.99.xsd): Estrutura XML com informações resumidas de um evento de NF-e. Contém o código do órgão de recepçã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, data de autorização e número de protocolo do evento.
Visão geral do fluxo de NSU
O modelo de distribuição utiliza um Número Sequencial Único (NSU) para cada CNPJ ou CPF. A consulta ao NFeDistribuicaoDFe pode ser feita a qualquer momento. O fluxo exemplifica:
1. Emitente transmite NF-e, autorizada pela Sefaz e compartilhada com o Ambiente Nacional.
2. Ambiente Nacional gera um NSU para o destinatário do resumo da NF-e.
3. Destinatário consulta o Web Service, recupera o resumo da NF-e.
4. Destinatário gera evento de NF-e (ex: manifestação).
5. Ambiente Nacional gera um NSU do evento para o emitente.
6. Se o evento for uma manifestação diferente de "desconhecimento da operação", o Ambiente Nacional gera um NSU para o destinatário com a NF-e completa para download.
7. Emitente consulta o Web Service e recupera o evento do destinatário.
8. Destinatário consulta o Web Service e recupera a NF-e.
9. Emitente gera um evento de sua NF-e (ex: cancelamento).
10. Ambiente Nacional gera um NSU para o destinatário do evento do emitente.
11. Destinatário consulta o Web Service e recupera o evento do emitente.
12. Ambiente Nacional recebe evento do fisco, gera NSUs para emitente e destinatário.
13. Ambos consultam o Web Service e recuperam o evento do fisco.
Este modelo permite ao emitente consultar os eventos manifestados pelos destinatários e disponibiliza para o destinatário qualquer evento gerado pelo emitente ou pelo fisco. Simplifica o download da NF-e, pois a manifestação do destinatário automaticamente libera a NF-e completa via NSU.
Prevenção de Uso Indevido e Endereço do Serviço
Para manter a estabilidade dos sistemas, o Ambiente Nacional implementa controles para identificar e reagir a situações de uso indevido do Web Service.
Controles para evitar consumo excessivo
A falta de controle em algumas aplicações cliente pode gerar loops de requisição, sobrecarregando os recursos do ambiente. Para mitigar isso, o NFeDistribuicaoDFe possui controles que identificam tentativas sucessivas de busca de registros já disponibilizados. Requisições que se enquadram como consumo indevido são rejeitadas com o código de erro 656-Rejeição: Consumo Indevido.
Localização do Web Service
O endereço do Web Service de Distribuição do Ambiente Nacional está publicado no Portal da NF-e (http://www.nfe.fazenda.gov.br/portal), no link "Serviços" / "Relação de Serviços Web". O mesmo ocorre para o ambiente de homologação, no Portal de Homologação (http://hom.nfe.fazenda.gov.br/portal).
Códigos e Descrições de Erros
A comunicação com o Web Service NFeDistribuicaoDFe pode resultar em diversos códigos de erro, indicando o resultado do processamento ou o motivo de não atendimento 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: Rejeição: Certificado Transmissor inválido.
* 472: Rejeição: CPF consultado difere do CPF do Certificado Digital.
* 589: Rejeição: Número do NSU informado superior ao maior NSU do Ambiente Nacional.
* 632: Rejeição: Solicitação fora de prazo, a NF-e não está mais disponível para download.
* 656: Rejeição: Consumo Indevido.
Esses códigos permitem que as aplicações cliente identifiquem a causa de eventuais falhas e ajustem suas requisições.
Conclusão
A Nota Técnica 2014/002 detalha o Web Service NFeDistribuicaoDFe, um serviço essencial para a distribuição e acesso a documentos fiscais eletrônicos e informações resumidas da NF-e para todos os atores envolvidos. Este serviço centraliza as consultas de DF-e, substituindo os Web Services anteriores, e garante que emissores, destinatários, transportadores e terceiros possam obter os dados de seu interesse de forma padronizada. A implementação do NSU, a compactação de dados e um robusto sistema de validação asseguram a eficiência e a confiabilidade na recuperação dos documentos. O entendimento dessas regras e procedimentos é fundamental para a correta interação com o Ambiente Nacional da NF-e.