NT 2014.002: Web Service NFeDistribuicaoDFe para DF-e e NF-e
A Nota Técnica 2014.002 detalha o Web Service NFeDistribuicaoDFe para DF-e e NF-e. Saiba como emitentes, destinatários e transportadores acessam e distribuem documentos fiscais eletrônicos essenciais.
NT 2014.002: Web Service NFeDistribuicaoDFe para DF-e e NF-e
O Projeto Nota Fiscal Eletrônica lançou a Nota Técnica 2014.002, focada no Web Service NFeDistribuicaoDFe. Este serviço distribui Documentos Fiscais Eletrônicos (DF-e) de interesse dos atores envolvidos com a NF-e, como emitentes, destinatários, transportadores e terceiros. O objetivo é prover informações de forma eficiente, superando desafios na disponibilização desses dados.
Histórico e Evolução do Web Service
A Nota Técnica 2014.002 passou por diversas atualizações desde sua versão inicial 1.00, desenvolvida em 2014. A versão 1.02, implementada em outubro de 2016, incluiu a distribuição de eventos como Registro de Passagem, Pedido de Prorrogação/Cancelamento do prazo de suspensão do ICMS, e possibilitou a consulta ao Web Service por chave de acesso de NF-e. Adicionalmente, passou a distribuir o Evento de Cancelamento diretamente para o destinatário, mesmo sem sua manifestação.
A versão 1.02b, de maio de 2017, adicionou a distribuição de Eventos de Averbação. Por fim, a versão 1.02c, de setembro de 2020, trouxe a inclusão da distribuição do Evento de Comprovante de Entrega, propagado do Conhecimento de Transporte Eletrônico (CT-e).
Propósito do Web Service NFeDistribuicaoDFe
O serviço NFeDistribuicaoDFe distribui informações resumidas e documentos fiscais eletrônicos para qualquer ator da NF-e, seja pessoa física ou jurídica. Ele permite o acesso a documentos e resumos que não foram gerados pelo próprio interessado, mas que são de seu interesse. A autenticação ocorre via certificado digital de PJ ou PF. Para Pessoas Jurídicas, a consulta pode ser feita por qualquer CNPJ da empresa, desde que a base do CNPJ consultado seja a mesma do certificado digital.
Este Web Service se propõe a substituir, futuramente, o NfeConsultaDest (Web Service de Consulta da Relação de Documentos Destinados), que provê informações para a manifestação do destinatário da NF-e. Os documentos fiscais eletrônicos e informações resumidas ficam disponíveis para distribuição por até três meses após sua recepção pelo Ambiente Nacional da NF-e.
A distribuição ocorre para os seguintes papéis, identificados nas respectivas tags da NF-e:
* Emitente: grupo emit (id:C01)
* Destinatário: grupo dest (id:E01)
* Transportador: grupo transporta (id:X03)
* Terceiros: pessoas físicas autorizadas a acessar o XML, no grupo autXML (id:GA01).
Estrutura das Mensagens de Entrada e Retorno
O serviço NFeDistribuicaoDFe opera de forma síncrona, utilizando o método nfeDistDFeInteresse.
Mensagem de Entrada
A mensagem de entrada é uma estrutura XML que contém o pedido de distribuição de DF-e, baseada no Schema XML distDFeInt_v9.99.xsd. Campos importantes incluem:
* tpAmb: Identificação do Ambiente (1=Produção / 2=Homologação).
* cUFAutor: Código da UF do autor.
* CNPJ ou CPF: Identificação do interessado no DF-e.
* Grupos de Consulta: distNSU, consNSU ou consChNFe, que definem o tipo de consulta.
Mensagem de Retorno
A mensagem de retorno, baseada no Schema XML retDistDFeInt_v9.99.xsd, contém os documentos de interesse do ator, com quantidade máxima de 50 por lote. Campos relevantes são:
* tpAmb: Identificação do Ambiente.
* cStat: Código do status da resposta.
* xMotivo: Descrição literal do status da resposta.
* ultNSU: Último NSU pesquisado no Ambiente Nacional.
* maxNSU: Maior NSU existente no Ambiente Nacional para o CNPJ/CPF informado.
* loteDistDFeInt: Conjunto de informações resumidas e DF-e, contendo a tag docZip.
Mensagem de Retorno Compactada
Para otimizar o uso da infraestrutura de rede, cada documento contido na mensagem de retorno é compactado usando o padrão Gzip (tag docZip). Essa compactação reduz o tamanho da mensagem em aproximadamente 60%. A aplicação cliente deve descompactar o documento para processamento normal.
Tipos de Pedido de Distribuição
O XML do pedido de distribuição suporta três tipos de consultas, definidas pela tag informada:
Distribuição de Conjunto de DF-e a Partir do NSU Informado (distNSU)
A aplicação cliente informa o último Número Sequencial Único (ultNSU) que possui. O Ambiente Nacional fornece os documentos a partir do NSU subsequente. Se o NSU informado for zero ou muito antigo, a consulta retorna as informações dos últimos três meses.
Consulta DF-e Vinculado ao NSU Informado (consNSU)
Permite consultar um DF-e específico a partir de um NSU identificado como faltante na base de dados do interessado. Este tipo de consulta preenche lacunas na sequência de documentos recebidos.
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.
Papeis do Interessado e Disponibilidade de Documentos
A disponibilidade de DF-e e resumos de eventos varia conforme o papel do interessado:
| 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 de Prorrogação | 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 |
| Eventos de Comprovante de Entrega propagado do CT-e | Sim | Sim | Sim | Sim |
¹ Documentos fiscais e resumos de eventos ficam disponíveis para o destinatário após manifestação ("Ciência da Operação", "Operação não Realizada" ou "Confirmação de Operação"), exceto o Evento de Cancelamento. Antes da manifestação, apenas o resumo da NF-e e o cancelamento estão disponíveis.
² A NF-e está disponível para o transportador identificado no grupo X03.
³ A NF-e está disponível para terceiros cujo CNPJ ou CPF esteja informado na tag autXML.
As consultas por chave de acesso estão disponíveis para documentos recebidos pelo Ambiente Nacional nos últimos 90 dias.
Visão Geral do Modelo de Distribuição
O modelo de distribuição utiliza um Número Sequencial Único (NSU) para cada CNPJ ou CPF. O Ambiente Nacional gera um NSU para cada documento de interesse. A consulta pode ser feita a qualquer momento, e os documentos são disponibilizados em lotes de até 50, em ordem crescente de NSU.
O processo de recepção e sincronização não é em ordem cronológica de emissão ou autorização, mas sim pela ordem de recepção dos documentos no Ambiente Nacional. Documentos emitidos pela própria empresa não ficam disponíveis para consulta neste serviço. É recomendado aguardar um mínimo de uma hora entre solicitações de distribuição se a resposta indicar que não há mais documentos a serem pesquisados.
Um exemplo de fluxo inclui:
1. Emitente transmite NF-e, autorizada pela Sefaz e compartilhada com o Ambiente Nacional.
2. O Ambiente Nacional gera um NSU para o destinatário com o resumo da NF-e.
3. Destinatário consulta o Web Service e recupera o resumo.
4. Destinatário gera um evento de NF-e (ex: manifestação).
5. Ambiente Nacional gera um NSU do evento para o emitente.
6. Após manifestação (exceto "desconhecimento"), Ambiente Nacional gera NSU para o destinatário com a NF-e completa para download.
7. Emitente consulta e recupera o evento do destinatário.
8. Destinatário consulta e recupera a NF-e.
9. Emitente gera um evento (ex: cancelamento).
10. Ambiente Nacional gera NSU do evento para o destinatário.
11. Destinatário consulta e recupera o evento do emitente.
12. Evento do fisco gera NSUs para emitente e destinatário.
13. Ambos consultam e recuperam o evento do fisco.
Este modelo permite ao emitente consultar os eventos manifestados pelos destinatários e ao destinatário acessar eventos gerados pelo emitente, além dos eventos do fisco para ambos. O download da NF-e é simplificado, pois o Ambiente Nacional gera um NSU automaticamente após a manifestação do destinatário.
Validações e Tratamento de Erros
O Web Service NFeDistribuicaoDFe implementa diversas validações para garantir a integridade e o uso correto do serviço.
Validação do Certificado de Transmissão
A transmissão requer um certificado digital de PJ ou PF válido. As validações incluem a existência do certificado, sua validade, a cadeia de certificação (ICP-Brasil), a Lista de Certificados Revogados (LCR) e a presença das extensões de CNPJ ou CPF. Falhas nessas validações resultam em rejeição da solicitação.
Validação Inicial da Mensagem
Mensagens enviadas são submetidas a uma validação inicial:
* Tamanho do XML: O XML de dados não deve exceder 10 KB. Mensagens maiores podem ser descartadas com erro "214-Rejeição: Tamanho da mensagem excedeu o limite estabelecido".
* Disponibilidade do Serviço: O Web Service verifica se o servidor de processamento está paralisado momentaneamente ("108-Serviço Paralisado Momentaneamente") ou sem previsão ("109-Serviço Paralisado sem Previsão").
Validação da Área de Dados
As validações da área de dados garantem a conformidade do XML:
* Schema XML: Verificação do Schema XML da área de dados ("215-Rejeição: Falha no schema XML").
* Codificação: O XML deve usar codificação UTF-8 ("402-Rejeição: XML da área de dados com codificação diferente de UTF-8").
* Versão: A versão dos dados informada deve ser compatível com a versão vigente ("238-Rejeição: Cabeçalho - Versão do arquivo XML superior a Versão vigente"; "239-Rejeição: Cabeçalho - Versão do arquivo XML não suportada").
Validação de Regras de Negócio
Regras de negócio específicas são aplicadas, como:
* Ambiente: O ambiente informado deve coincidir com o ambiente de recebimento.
* CNPJ/CPF: Validação da correção dos números de CNPJ ou CPF do interessado.
* Certificado Digital: O CNPJ base ou CPF do certificado digital deve ser o mesmo do CNPJ ou CPF consultado.
* NSU: O NSU informado não pode ser superior ao maior NSU disponível no Ambiente Nacional.
* Chave de Acesso: A chave de acesso deve ser válida em sua estrutura (UF, ano, mês, CNPJ, modelo 55, número NF) e existir.
* Prazo de Download: A NF-e deve estar dentro do prazo de 90 dias da data de recebimento no Ambiente Nacional para download.
* Permissão: O CNPJ/CPF do interessado deve ter permissão para consultar a NF-e.
* Emitente: A NF-e não é disponibilizada para consulta ao próprio emitente.
* NF-e Cancelada/Denegada: Arquivos de NF-e canceladas ou denegadas não estão disponíveis para download.
Consumo Indevido
O Web Service possui controles para identificar e rejeitar tentativas sucessivas de busca de registros já disponibilizados. Aplicações que entram em "loop" e consomem recursos indevidamente são rejeitadas com o erro "656-Rejeição: Consumo Indevido".
Leiautes Resumidos de NF-e e Eventos
Foram criados leiautes resumidos para permitir o compartilhamento de informações relevantes mantendo o sigilo.
Leiaute Resumo da NF-e
Este leiaute, gerado pelo Ambiente Nacional, contém informações resumidas da NF-e quando ela é autorizada ou denegada. É distribuído aos destinatários para possibilitar a manifestação da operação. Inclui campos como Chave de Acesso da NF-e (chNFe), CNPJ/CPF e Razão Social do emitente, Inscrição Estadual (IE), Data de Emissão (dhEmi), Tipo de Operação (tpNF), Valor Total da NF-e (vNF), Digest Value, Data de Autorização (dhRecbto), Número de Protocolo (nProt) e Situação da NF-e (cSitNFe).
Leiaute Resumo do Evento de NF-e
Este leiaute resume informações de um evento de NF-e. Contém dados como Código do Órgão de recepção do Evento (cOrgao), CNPJ/CPF do Emitente, Chave de Acesso da NF-e (chNFe), Data e Hora do evento (dhEvento), Código do evento (tpEvento), Número Sequencial do evento (nSeqEvento), Descrição do evento (xEvento), Data de Autorização do evento (dhRecbto) e Número de Protocolo do evento (nProt).
Conclusão
A Nota Técnica 2014.002, com o Web Service NFeDistribuicaoDFe, oferece um mecanismo centralizado e padronizado para a distribuição de DF-e e eventos de interesse dos diversos atores da NF-e. Sua estrutura permite que empresas e pessoas físicas acessem documentos fiscais eletrônicos de forma controlada, facilitando a gestão fiscal e a conformidade. O uso correto deste serviço, respeitando as regras de consulta e evitando o consumo indevido, garante a eficiência do processo de obtenção de informações fiscais.