NFeDistribuicaoDFe: consulta de DF-e e eventos na Nota Técnica 2014/002
NFeDistribuicaoDFe: consulta de DF-e e eventos na Nota Técnica 2014/002 O projeto Nota Fiscal Eletrônica (NF-e) visa fornecer aos atores envolvidos no processo informações de seu interesse de forma eficiente. Para isso, a Nota Técnica 2014/002 apresenta alterações no Web Service NFeDistribuicaoDFe. Este serviço...
NFeDistribuicaoDFe: consulta de DF-e e eventos na Nota Técnica 2014/002
O projeto Nota Fiscal Eletrônica (NF-e) visa fornecer aos atores envolvidos no processo informações de seu interesse de forma eficiente. Para isso, a Nota Técnica 2014/002 apresenta alterações no Web Service NFeDistribuicaoDFe. Este serviço distribui informações e documentos fiscais eletrônicos (DF-e) de interesse, com o objetivo de futuramente descontinuar o serviço NfeConsultaDest.
Visão Geral do Serviço NFeDistribuicaoDFe
O Web Service NFeDistribuicaoDFe permite a distribuição de documentos e informações de interesse de um ator da NF-e, seja pessoa física ou jurídica. Sua função é disponibilizar acesso a DF-e e informações resumidas que não foram gerados pelo ator, mas são de seu interesse. O serviço opera de forma síncrona, utilizando o método nfeDistDFeInteresse.
A autenticação é feita via certificado digital de PJ ou PF. No caso de Pessoa Jurídica, a consulta pode ser realizada por qualquer CNPJ da empresa, desde que o CNPJ base consultado seja o mesmo do certificado digital. Os documentos fiscais eletrônicos e informações resumidas ficam disponíveis para distribuição por até três meses após a recepção pelo Ambiente Nacional da NF-e.
Vigência e Desativação de Serviços
A Nota Técnica 2014/002 é apresentada na versão 1.02, divulgada em Outubro de 2016. Os esquemas (schemas) para este pacote de liberação são identificados como PL_NFeDistDFe_102.
A vigência do serviço em ambiente de homologação iniciou em 5 de dezembro de 2016 e, em ambiente de produção, em 9 de janeiro de 2017. O documento prevê a desativação dos Web Services NfeConsultaDest e NFeDownloadNF para 2 de maio de 2017.
Papeis e Documentos Distribuídos
A distribuição é realizada para diferentes atores, conforme seu papel na NF-e:
* Emitentes: Indentificados na tag emit.
* Destinatários: Identificados na tag dest.
* Transportadores: Identificados na tag transporta.
* Terceiros: Pessoas físicas autorizadas a acessar o XML, informadas na tag autXML.
A disponibilidade dos documentos varia de acordo com o papel do ator:
| 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 |
| 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 |
- ¹ Documentos fiscais e resumos de eventos para o destinatário estão disponíveis 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, que é disponibilizado independentemente. Antes da manifestação, o destinatário recebe apenas a estrutura XML de "Resumo de NF-e" e o cancelamento de NF-e.
- ² A NF-e está disponível para o transportador identificado no grupo X03.
- ³ A NF-e está disponível para terceiros se o CNPJ ou CPF estiver na tag
autXML. - ⁴ Eventos de Pedido de Prorrogação de Prazo da NT 2015.001 incluem EPP1, EPP2, ECPP1 e ECPP2.
- ⁵ Eventos do Fisco em Resposta ao Pedido de Prorrogação de Prazo da NT 2015.001 incluem EFPP1, EFPP2, EFCPP1 e EFCPP2.
Estrutura da Mensagem de Entrada
A mensagem de entrada do Web Service NFeDistribuicaoDFe é uma estrutura XML com o pedido de distribuição de DF-e de interesse. O esquema XML utilizado é distDFeInt_v9.99.xsd.
Campos principais incluem:
* distDFeInt (raiz): TAG raiz.
* versao: Versão do leiaute.
* tpAmb: Identifica o ambiente (1=Produção / 2=Homologação).
* cUFAutor: Código da UF do autor (opcional).
* CNPJ: CNPJ do interessado no DF-e.
* CPF: CPF do interessado no DF-e.
O XML do pedido de distribuição suporta três tipos de consulta, definidas pela tag informada:
Consulta por Último Número Sequencial Único (distNSU)
Este grupo (distNSU) é usado para distribuir um conjunto de DF-e. A aplicação cliente informa o ultNSU, que é o último número sequencial único recebido. Se o NSU informado for menor que o primeiro disponível, o Ambiente Nacional fornecerá documentos a partir do primeiro.
Consulta por NSU Específico (consNSU)
O grupo consNSU permite consultar um DF-e a partir de um NSU específico. Esta funcionalidade é utilizada para preencher lacunas na base de dados do interessado. A aplicação cliente informa o NSU identificado como faltante.
Consulta de NF-e por Chave de Acesso (consChNFe)
O grupo consChNFe permite consultar uma NF-e específica pela chave de acesso. A aplicação cliente informa uma chNFe (chave de acesso) válida para recuperar o documento.
Estrutura da Mensagem de Retorno
A mensagem de retorno do Web Service NFeDistribuicaoDFe é uma estrutura XML que contém os documentos de interesse do ator, com quantidade máxima de 50. O esquema XML é retDistDFeInt_v9.99.xsd.
Campos principais incluem:
* retDistDFeInt (raiz): TAG raiz da resposta.
* versao: Versão do leiaute.
* tpAmb: Ambiente (Produção/Homologação).
* 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 (formato UTC).
* 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 (tipo base64Binary). Possui atributos NSU e schema para identificar o documento.
Mensagem de Retorno Compactada
Para otimizar a infraestrutura de rede, cada documento na mensagem de retorno é compactado usando o padrão Gzip (tag docZip). A estimativa é que a compactação reduza o tamanho da mensagem em aproximadamente 60%.
A aplicação do Ambiente Nacional compacta cada documento individualmente. A aplicação cliente é responsável por descompactá-lo e processar o conteúdo. Gzip é suportado em plataformas como Java e .NET.
Processo de Distribuição de DF-e de Interesse
O Web Service NFeDistribuicaoDFe pode ser acessado por emitentes, destinatários, transportadores e terceiros, seja pessoa física ou jurídica, com um certificado digital (CPF ou CNPJ). O Ambiente Nacional gera um Número Sequencial Único (NSU) para cada documento fiscal de interesse, garantindo uma sequência sem intervalos na base de dados.
Geração do Pedido de Distribuição
O pedido de distribuição, enviado via Web Service, requer um certificado digital PJ ou PF válido. O Web Service do Ambiente Nacional é acionado pela aplicação cliente, que deve enviar uma mensagem conforme os padrões estabelecidos na Nota Técnica 2014/002.
CNPJ ou CPF do Interessado no DF-e
É necessário informar o CPF da pessoa física ou CNPJ da empresa para recuperar os DF-e. Este campo permite que uma empresa recupere DF-e de seus diversos estabelecimentos usando um único certificado digital PJ.
Processamento da Requisição distNSU
O Web Service gera lotes de até 50 documentos para o interessado. Estes documentos contêm informações resumidas ou DF-e com NSU superior ao informado. Se o NSU recebido for menor que o primeiro NSU disponível, o Ambiente Nacional fornecerá os documentos a partir do primeiro.
As regras para a criação do lote são:
* Ordem crescente de NSU.
* O lote pode conter diferentes tipos de documentos e seus NSUs.
* Limite de 50 documentos por lote.
Documentos emitidos pela própria empresa não são disponibilizados para consulta. A geração do NSU ocorre por ordem cronológica de recepção pelo Ambiente Nacional, não de emissão ou autorização de uso. Caso a resposta indique que não há mais documentos a serem pesquisados (cStat = '137-Nenhum documento localizado' e ultNSU igual a maxNSU), a empresa deve aguardar no mínimo uma hora antes de fazer uma nova solicitação.
Processamento da Requisição consNSU
A requisição consNSU é utilizada quando uma lacuna na sequência de NSUs é identificada na base de dados do interessado. Este processo permite consultar pontualmente um NSU faltante. Se o NSU não existir, o Ambiente Nacional indicará (cStat = '137-Nenhum documento localizado').
Processamento da Requisição consChNFe
A consulta por chave de acesso (consChNFe) permite ao interessado consultar uma NF-e específica. A chave de acesso deve ser válida, existir no Ambiente Nacional e estar vinculada ao interessado como destinatário, transportador ou terceiro.
Regras específicas para esta consulta:
* 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 integral é retornada. Caso contrário, apenas o resumo da NF-e é retornado.
* Transportador e Terceiros: A NF-e integral estará disponível.
* Emitente: A NF-e não é disponibilizada nesta consulta.
Esta consulta está disponível apenas para documentos recebidos nos últimos 90 dias.
Validação de Certificado Digital e Mensagens
O serviço NFeDistribuicaoDFe realiza validações rigorosas:
Validação do Certificado de Transmissão
O certificado digital utilizado na transmissão da mensagem passa por diversas verificações:
* Validade (início e fim).
* Cadeia de certificação e status de revogação.
* Presença da extensão de CNPJ ou CPF (OtherName - OID=2.16.76.1.3.3 ou OID=2.16.76.1.3.1) no certificado.
Validação Inicial da Mensagem no Web Service
A mensagem enviada é verificada quanto ao seu tamanho. Mensagens que excedam 10 KB são descartadas, podendo resultar no erro 214-Rejeição: Tamanho da mensagem excedeu o limite estabelecido. O serviço também verifica se está temporariamente paralisado (108-Serviço Paralisado Momentaneamente ou 109-Serviço Paralisado sem Previsão).
Validação da Área de Dados
Inclui a validação do Schema XML (215-Rejeição: Falha no schema XML), uso de prefixo no namespace (404-Rejeição: Uso de prefixo de namespace não permitido), codificação UTF-8 (402-Rejeição: XML da área de dados com codificação diferente de UTF-8) e versão dos dados.
Validação de Regras de Negócio
São aplicadas regras de negócio, como:
* CNPJ ou CPF do interessado inválido (489-Rejeição: CNPJ informado inválido, 490-Rejeição: CPF informado inválido).
* Divergência entre o CNPJ-Base/CPF do certificado e o consultado (593-Rejeição: CNPJ-Base consultado difere do CNPJ-Base do Certificado Digital, 472-Rejeição: CPF consultado difere do CPF do Certificado Digital).
* NSU informado superior ao maior NSU disponível (589-Rejeição: Número do NSU informado superior ao maior NSU do Ambiente Nacional).
* Chave de acesso inválida (dígito verificador, código UF, ano, mês, CNPJ, modelo, número da NF).
* NF-e inexistente para a chave de acesso (217-Rejeição: NF-e inexistente para a chave de acesso informada).
* Solicitação fora do prazo de 90 dias (632-Rejeição: Solicitação fora de prazo, a NF-e não está mais disponível para download).
* Falta de permissão do CNPJ/CPF interessado para consultar a NF-e (640-Rejeição: CNPJ/CPF do interessado não possui permissão para consultar esta NF-e).
* Tentativa de consulta pelo emitente (641-Rejeição: NF-e indisponível para o emitente).
* NF-e Cancelada ou Denegada, tornando o arquivo indisponível para download (653-Rejeição: NF-e Cancelada, arquivo indisponível para download, 654-Rejeição: NF-e Denegada, arquivo indisponível para download).
Leiautes Resumidos
A Nota Técnica 2014/002 introduz leiautes resumidos para manter o sigilo da informação e permitir o compartilhamento de dados relevantes.
Leiaute Resumo da NF-e (resNFe)
Este leiaute (resNFe_v9.99.xsd) é uma estrutura XML gerada pelo Ambiente Nacional com informações resumidas da NF-e. É distribuído aos destinatários para possibilitar a manifestação na operação. Inclui campos 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 Situação da NF-e (Uso autorizado, Uso denegado, NF-e Cancelada).
Leiaute Resumo do Evento de NF-e (resEvento)
Este leiaute (resEvento_v9.99.xsd) é uma estrutura XML com informações resumidas de um evento de NF-e. Inclui Código do órgão de recepção do Evento, CNPJ/CPF do Emitente, Chave de Acesso da NF-e, Data e Hora do Evento, Código e Descrição do Evento, Número Sequencial 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 é baseado na geração de um Número Sequencial Único (NSU) para cada CNPJ ou CPF. A consulta no Web Service NFeDistribuicaoDFe pode ser feita a qualquer momento.
O fluxo de distribuição pode ser exemplificado em 13 passos, que incluem:
1. Emitente transmite NF-e, autorizada e compartilhada com Ambiente Nacional.
2. Ambiente Nacional gera NSU para o destinatário do resumo da NF-e.
3. Destinatário consulta WS NFeDistribuicaoDFe e recupera o resumo da NF-e.
4. Destinatário gera evento de NF-e (ex: manifestação).
5. Ambiente Nacional gera NSU do evento para o emitente.
6. Se for manifestação diferente de "desconhecimento", o Ambiente Nacional gera NSU para o destinatário com a NF-e completa.
7. Emitente consulta WS NFeDistribuicaoDFe e recupera o evento do destinatário.
8. Destinatário consulta WS NFeDistribuicaoDFe e recupera a NF-e.
9. Emitente gera evento (ex: cancelamento de NF-e).
10. Ambiente Nacional gera NSU para o destinatário do evento do emitente.
11. Destinatário consulta WS NFeDistribuicaoDFe e recupera o evento do emitente.
12. Ambiente Nacional recebe evento do fisco, gera NSU para emitente e destinatário.
13. Emitente e destinatário consultam WS NFeDistribuicaoDFe e recuperam o evento do fisco.
Este modelo permite ao emitente consultar eventos manifestados pelos destinatários e disponibiliza ao destinatário qualquer evento gerado pelo emitente. Eventos do fisco também são disponibilizados para ambos. O download da NF-e é simplificado, sendo liberado após a manifestação do destinatário.
Recomendações Para Evitar o Uso Indevido
A Nota Técnica 2014/002 adverte sobre o uso indevido do serviço, como aplicações em "loop" que sobrecarregam os recursos. O Ambiente Nacional mantém controles para identificar tentativas sucessivas de busca de registros já disponibilizados. Tentativas inadequadas são rejeitadas com o erro 656-Rejeição: Consumo Indevido.
Endereço do Web Service e Códigos de Erro
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 se aplica ao ambiente de homologação, no Portal de Homologação (http://hom.nfe.fazenda.gov.br/portal).
A Nota Técnica 2014/002 inclui uma tabela detalhada de códigos e descrições de mensagens de erro, abrangendo resultados de processamento, motivos de não atendimento e rejeições específicas.
Conclusão
A Nota Técnica 2014/002 detalha o funcionamento do Web Service NFeDistribuicaoDFe, um serviço para consulta e distribuição de DF-e e eventos de interesse para diversos atores da NF-e. Este serviço centraliza o acesso a documentos, substitui ferramentas anteriores e estabelece um processo claro de consulta por NSU ou chave de acesso, com regras específicas de validação e disponibilidade.