NFeDistribuicaoDFe: Consulta e Distribuição de DF-e e NF-e
Conheça o NFeDistribuicaoDFe, o Web Service que simplifica a consulta e distribuição de documentos fiscais eletrônicos (DF-e) e NF-e. Acesse informações para emitentes, destinatários e transportadores.
NFeDistribuicaoDFe: Consulta e Distribuição de DF-e e NF-e
O projeto Nota Fiscal Eletrônica (NF-e) busca oferecer informações relevantes aos envolvidos de forma eficiente e segura. A Nota Técnica 2014/002 apresentou o novo Web Service NFeDistribuicaoDFe, que visa disponibilizar documentos fiscais eletrônicos (DF-e) e resumos de interesse para emitentes, destinatários, transportadores e terceiros. Este serviço substituirá o NfeConsultaDest, simplificando o acesso a dados fiscais.
Resumo da Nota Técnica 2014/002
A Nota Técnica 2014/002 foi criada para aprimorar a distribuição de documentos fiscais eletrônicos. Seu objetivo é consolidar a oferta de informações para diversos atores envolvidos nos processos de NF-e, que antes eram dispersas ou indisponíveis para alguns interessados.
O Web Service NFeDistribuicaoDFe foi projetado para oferecer informações e documentos de interesse de forma mais abrangente. A distribuição é direcionada a diferentes perfis: emitentes (grupo C01), destinatários (grupo E01), transportadores (grupo X03) e pessoas autorizadas a acessar o XML (tag autXML, id GA01).
A implementação do NFeDistribuicaoDFe ocorreu com prazos definidos: ambiente de homologação a partir de 15/09/2014 e ambiente de produção em 06/10/2014. O Web Service NfeConsultaDest foi desativado em 31/05/2017.
O Web Service NFeDistribuicaoDFe
O NFeDistribuicaoDFe é um serviço síncrono que utiliza o método nfeDistDFeInteresse. Sua função principal é distribuir informações resumidas e documentos fiscais eletrônicos para qualquer ator (Pessoa Física ou Jurídica) que possua um certificado digital válido.
Para Pessoas Jurídicas, a autenticação ocorre pelo CNPJ base. As consultas podem ser realizadas por qualquer CNPJ da empresa, desde que o CNPJ base consultado seja o mesmo do certificado digital. Os documentos ficam disponíveis para distribuição por até 3 meses após a recepção pelo Ambiente Nacional da NF-e.
Documentos e informações disponíveis para distribuição
A tabela abaixo detalha quais documentos e resumos de eventos são disponibilizados para cada tipo de ator pela Nota Técnica 2014/002:
| Documentos | Emitente | Destinatário¹ | Transportador² | Terceiros³ |
|---|---|---|---|---|
| NF-e | Não | Sim | Sim | Sim |
| Evento de Cancelamento | Não | Sim | Sim | Sim |
| Evento de Carta de Correção | Não | Sim | Sim | Sim |
| Eventos de Manifestação do Destinatário | Sim | Não | Não | Sim |
| Eventos da Suframa (Vistoria/Internalização) | Sim | Sim | Não | Sim |
| EPEC | Não | Sim | Sim | Não |
| Eventos de Pedido de Prorrogação de Prazo⁴ | Não | Sim | Não | Não |
| Eventos do Fisco em Resposta ao Pedido⁵ | Sim | Sim | Não | Não |
| Evento de Averbação⁶ | Sim | Sim | Sim | Sim |
| Resumo de NF-e | Não | Sim | Não | Não |
| Resumo de Eventos CT-e Autorizado/Cancelado | Sim | Sim | Sim | Sim |
| Resumo de Eventos MDF-e Autorizado/Cancelado | Sim | Sim | Sim | Sim |
| Resumo de Eventos de Registro de Passagem⁷ | Sim | Sim | Sim | Sim |
Observações:
- Destinatário: Documentos e resumos de eventos ficam disponíveis somente após a manifestação ("Ciência da Operação", "Operação não Realizada" ou "Confirmação de Operação") da NF-e, exceto para o Evento de Cancelamento, que é disponibilizado mesmo sem manifestação. Antes da manifestação, o destinatário recebe apenas o Resumo da NF-e e o cancelamento de NF-e.
- Transportador: A NF-e é disponibilizada apenas para o transportador identificado no grupo X03 do XML.
- Terceiros: A NF-e é disponibilizada para terceiros cujo CNPJ ou CPF esteja informado na tag
autXML. - Eventos de Pedido de Prorrogação de Prazo: Referem-se aos eventos EPP1, EPP2, ECPP1 e ECPP2 da Nota Técnica 2015.001.
- Eventos do Fisco em Resposta ao Pedido de Prorrogação: Incluem os eventos EFPP1, EFPP2, EFCPP1 e EFCPP2 da Nota Técnica 2015.001.
- Eventos de Averbação: Serão distribuídos a partir da implantação da BT 2017/001 v1.0.
- Resumo de Eventos de Registro de Passagem: Distribuídos a partir da implantação da Nota Técnica 2014/002 v1.02.
Leiaute da mensagem de entrada
A mensagem de entrada para o pedido de distribuição de DF-e é uma estrutura XML definida pelo schema distDFeInt_v9.99.xsd. Os principais campos incluem:
versao(A02): Versão do leiaute.tpAmb(A03): Identificação do ambiente, sendo "1" para produção e "2" para homologação.cUFAutor(A04): Código da UF do autor da requisição.CNPJ(A05) ouCPF(A06): CNPJ ou CPF do interessado nos DF-e.
O pedido de distribuição suporta dois tipos de consultas, conforme a tag informada:
distNSU(A07): Grupo para distribuição de um conjunto de DF-e a partir do Último Número Sequencial Único (ultNSU) informado. OultNSU(A08) indica o último NSU recebido pelo ator. Se o NSU informado for zero ou muito antigo, a consulta retornará documentos dos últimos 3 meses.consNSU(A09): Grupo para consultar um DF-e específico a partir de um Número Sequencial Único (NSU) (A10) que foi identificado como faltante na base de dados do interessado.
O certificado digital (PJ ou PF) é obrigatório para o envio da requisição, sendo o CNPJ ou CPF do certificado validado em relação ao interessado na consulta. Uma empresa pode consultar DF-e de seus estabelecimentos com um único certificado digital PJ.
Leiaute da mensagem de retorno
A mensagem de retorno do Web Service NFeDistribuicaoDFe é uma estrutura XML com os documentos de interesse do ator, limitada a 50 documentos por lote, conforme o schema retDistDFeInt_v9.99.xsd. Campos importantes são:
versao(B02): Versão do leiaute.tpAmb(B03): Ambiente (produção ou homologação).cStat(B05): Código de status da resposta (ex: 137 para "Nenhum documento localizado", 138 para "Documento localizado").xMotivo(B06): Descrição literal do status da resposta.dhResp(B07): Data e hora da mensagem de resposta.ultNSU(B08): Último NSU pesquisado no Ambiente Nacional, indicando o ponto de continuidade para futuras consultas.maxNSU(B09): Maior NSU existente no Ambiente Nacional para o CNPJ/CPF informado.loteDistDFeInt(B10): Conjunto de informações resumidas e documentos fiscais eletrônicos.docZip(B11): Informação resumida ou documento fiscal eletrônico de interesse, compactado no padrão Gzip.NSU(B12): NSU do documento fiscal dentro dodocZip.schema(B13): Identificação do schema XML usado para validar o documento (ex:resNFe_v1.00.xsd,procNFe_v3.10.xsd).
Mensagem de retorno compactada
Para otimizar a infraestrutura de rede, cada documento na mensagem de retorno é compactado usando o padrão Gzip, identificado pela tag docZip. A compactação reduz o tamanho da mensagem em aproximadamente 60%, facilitando a transmissão e o consumo.
A aplicação cliente deve descompactar individualmente cada documento para processamento.
Processamento do pedido de distribuição
O Ambiente Nacional gera um Número Sequencial Único (NSU) para cada interessado nos documentos fiscais. Os documentos são recuperados em uma sequência sem intervalos, garantindo a integridade dos dados.
Distribuição de conjunto de DF-e a partir do NSU informado (distNSU)
Neste modo, o Web Service gera lotes com até 50 documentos para o interessado. Os documentos incluem informações resumidas ou documentos fiscais eletrônicos com NSU superior ao informado pelo cliente (ultNSU).
Se o NSU fornecido for menor que o primeiro NSU disponível, o Ambiente Nacional entrega os documentos a partir do primeiro NSU consultável. A ordem dos documentos no lote é crescente por NSU, podendo incluir diferentes tipos de documentos válidos. Documentos emitidos pela própria empresa não são disponibilizados.
A geração do NSU é organizada pela ordem de inserção dos documentos no Ambiente Nacional, não pela ordem cronológica de emissão ou autorização.
As respostas possíveis incluem:
* Rejeição, com o motivo da falha no cStat.
* "Nenhum documento localizado" (cStat = '137'), indicando a ausência de documentos fiscais para o CNPJ/CPF.
* "Documento localizado" (cStat = '138'), com os documentos fiscais encontrados.
Após uma resposta de "Nenhum documento localizado", a empresa deve aguardar no mínimo uma hora antes de fazer uma nova solicitação. Se o ultNSU informado for igual ao maxNSU do Ambiente Nacional, não há novos documentos para pesquisa.
Distribuição de DF-e vinculado ao NSU informado (consNSU)
Este processo permite a consulta pontual de um NSU específico que esteja faltando na base de dados do interessado. A identificação de lacunas na numeração indica falhas no processo de distribuição.
O interessado deve informar o NSU desejado na tag consNSU do XML de requisição.
As respostas possíveis são:
* Rejeição, com o motivo da falha no cStat.
* "Nenhum documento localizado" (cStat = '137'), indicando que o NSU não foi gerado pelo Ambiente Nacional.
* "Documento localizado" (cStat = '138'), com o documento fiscal encontrado.
Validação do certificado e da mensagem
O processo de comunicação com o Web Service NFeDistribuicaoDFe inclui diversas validações de segurança e integridade:
- Validação do certificado de transmissão: O certificado digital utilizado na transmissão é rigorosamente verificado. Regras como validade, cadeia de certificação (ICP-Brasil), lista de certificados revogados (LCR) e presença das extensões de CNPJ ou CPF são aplicadas.
- Validação inicial da mensagem no Web Service: A mensagem XML de dados não pode exceder 10 KB. Caso o servidor de processamento esteja paralisado, são aplicadas verificações específicas.
- Validação da área de dados:
- Validação de formato: Verifica a conformidade com o Schema XML, o uso de prefixos no namespace, a codificação UTF-8 e a versão do leiaute.
- Validação de regras de negócio: Inclui a verificação de ambiente (produção/homologação), a validade do CNPJ/CPF do interessado e a correlação entre o CNPJ/CPF do certificado digital e o consultado. Há também a validação se o NSU informado não é superior ao maior NSU disponível.
Leiautes resumidos
Para viabilizar o compartilhamento de informações sem expor todos os detalhes do documento fiscal original, a Nota Técnica 2014/002 introduziu dois novos leiautes resumidos:
Resumo da NF-e (resNFe)
Esta estrutura XML contém um conjunto de informações resumidas da NF-e. É gerada pelo Ambiente Nacional quando a NF-e é autorizada ou denegada e distribuída aos destinatários para possibilitar a manifestação na operação.
Campos relevantes incluem:
* chNFe (C03): Chave de acesso da NF-e.
* CNPJ (C04) ou CPF (C05): CNPJ ou CPF do emitente.
* xNome (C06): Razão Social ou Nome do emitente.
* IE (C07): Inscrição Estadual do emitente.
* dhEmi (C08): Data de emissão da NF-e no formato UTC.
* tpNF (C09): Tipo de operação (0=Entrada; 1=Saída).
* vNF (C10): Valor total da NF-e.
* cSitNFe (C13): Situação da NF-e (1=Uso autorizado; 2=Uso denegado).
Resumo do evento de NF-e (resEvento)
Esta estrutura XML contém informações resumidas de um evento de NF-e, gerada pelo Ambiente Nacional.
Campos importantes são:
* cOrgao (D03): Código do órgão de recepção do evento (91 para Ambiente Nacional).
* CNPJ (D04) ou CPF (D05): CNPJ ou CPF do emitente.
* chNFe (D06): Chave de acesso da NF-e.
* dhEvento (D07): Data e hora do evento no formato UTC.
* tpEvento (D08): Código do evento.
* xEvento (D10): Descrição do evento.
* nProt (D12): Número de protocolo do evento.
Visão geral do modelo de distribuição
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. O NSU é gerado cronologicamente pela ordem de recepção dos documentos pelo Ambiente Nacional.
Um fluxo simplificado de NSU para emitente e destinatário ocorre da seguinte forma:
- 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 do resumo da NF-e.
- O destinatário consulta o NFeDistribuicaoDFe com seu último NSU e recupera o resumo.
- Com o resumo, o destinatário gera um evento de manifestação.
- O Ambiente Nacional gera um NSU do evento para o emitente.
- Se a manifestação não for de "desconhecimento da operação", o Ambiente Nacional gera um NSU para o destinatário com a NF-e completa para download.
- O emitente consulta o NFeDistribuicaoDFe e recupera o evento do destinatário.
- O destinatário consulta o NFeDistribuicaoDFe e recupera a NF-e completa.
- O emitente gera um evento de sua NF-e (ex: cancelamento), que é compartilhado com o Ambiente Nacional.
- O Ambiente Nacional gera um NSU para o destinatário do evento do emitente.
- O destinatário consulta o NFeDistribuicaoDFe e recupera o evento do emitente.
- O Ambiente Nacional recebe um evento do fisco e gera NSUs para emitente e destinatário.
- Ambos consultam o NFeDistribuicaoDFe e recuperam o evento do fisco.
Este modelo permite ao emitente consultar os eventos manifestados pelos destinatários e o destinatário acessar eventos gerados pelo emitente. Eventos do fisco são disponibilizados para ambos. O download da NF-e é simplificado, pois a manifestação do destinatário aciona a geração de um NSU referenciando a NF-e completa.
Exemplo de NSU gerados:
| NSU Emitente | Documento |
|---|---|
| 1 | Evento do Destinatário |
| 2 | Evento do Fisco |
| NSU Destinatário | Documento |
|---|---|
| 1 | Resumo da NF-e |
| 2 | NF-e |
| 3 | Evento do Emitente |
| 4 | Evento do Fisco |
Recomendações para evitar o uso indevido
Para garantir a estabilidade do sistema, o Ambiente Nacional monitora o uso do Web Service. Tentativas sucessivas e desnecessárias de busca de registros já disponibilizados podem ser identificadas como "consumo indevido".
Ações de consumo indevido resultam na rejeição da requisição com o código '656-Rejeição: Consumo Indevido'. Essa medida previne sobrecargas no canal de comunicação e nos recursos do sistema.
Endereço do Web Service
O endereço oficial do Web Service de Distribuição para o Ambiente Nacional está disponível no Portal da NF-e (http://www.nfe.fazenda.gov.br/portal), na seção "Serviços" / "Relação de Serviços Web". Para o ambiente de homologação, o endereço pode ser encontrado no Portal de Homologação (http://hom.nfe.fazenda.gov.br/portal).
Tabela de códigos de erros
O Web Service NFeDistribuicaoDFe retorna códigos de erro específicos para indicar o resultado do processamento ou o motivo de não atendimento da solicitação. Alguns códigos comuns incluem:
- 108: Serviço Paralisado Momentaneamente.
- 109: Serviço Paralisado sem Previsão.
- 137: Nenhum documento localizado.
- 138: Documento localizado.
- 214: Rejeição: Tamanho da mensagem excedeu o limite.
- 215: Rejeição: Falha no schema XML.
- 472: Rejeição: CPF consultado difere do CPF do Certificado Digital.
- 593: Rejeição: CNPJ-Base consultado difere do CNPJ-Base do Certificado Digital.
- 656: Rejeição: Consumo Indevido.
É recomendado que as mensagens de erro não utilizem caracteres especiais ou acentuação e que o campo xMotivo para o código 999 contenha a mensagem de erro da aplicação que gerou a exceção.
Conclusão
O Web Service NFeDistribuicaoDFe, introduzido pela Nota Técnica 2014/002, representa uma evolução na distribuição de documentos fiscais eletrônicos. Ele oferece um método padronizado e seguro para que emitentes, destinatários, transportadores e terceiros acessem informações relevantes de NF-e e eventos associados, utilizando um sistema de NSU. O cumprimento das regras de validação e o uso adequado do serviço são essenciais para evitar rejeições e garantir o fluxo eficiente de informações fiscais.