NFeDistribuicaoDFe: Consulta DF-e por NSU e Fim do NfeConsultaDest
NFeDistribuicaoDFe: distribuição de DF-e por NSU. Acesso a dados fiscais como emitente, destinatário e transportador. Substitui NfeConsultaDest.
NFeDistribuicaoDFe: Consulta DF-e por NSU e Fim do NfeConsultaDest
A gestão da Nota Fiscal Eletrônica (NF-e) envolve a troca eficiente de informações entre os diversos atores fiscais. Para atender a essa necessidade, foi desenvolvida a Nota Técnica 2014/002, que introduz o serviço Web NFeDistribuicaoDFe. Este serviço visa disponibilizar documentos fiscais eletrônicos (DF-e) e informações resumidas de interesse de pessoas físicas ou jurídicas de maneira confiável.
Este desenvolvimento sucede o Web Service de Consulta da Relação de Documentos Destinados (NfeConsultaDest), que será desativado, centralizando e aprimorando o acesso a informações fiscais. Conforme a Nota Técnica 2014/002, a implementação ocorreu em fases, com ambiente de homologação a partir de 15/09/2014 e produção desde 06/10/2014, culminando na desativação do serviço anterior em 02/05/2017 e da própria NT v1.01b em 06/11/2017.
Web Service NFeDistribuicaoDFe: Visão Geral
O serviço NFeDistribuicaoDFe opera de forma síncrona, utilizando o método nfeDistDFeInteresse. Sua principal função é distribuir informações resumidas e documentos fiscais eletrônicos para diversos atores. Estes documentos podem não ter sido gerados pelo próprio interessado, mas são de seu interesse fiscal ou de negócio.
Qualquer ator da NF-e, seja Pessoa Jurídica (PJ) ou Pessoa Física (PF), pode consumir este serviço, desde que possua um certificado digital de PJ ou PF válido. Para Pessoas Jurídicas, a autenticação ocorre pelo CNPJ base, permitindo a consulta com qualquer CNPJ da empresa, desde que corresponda ao CNPJ base do certificado digital.
As informações e documentos ficam disponíveis para distribuição por até três meses após a recepção pelo Ambiente Nacional da NF-e. A distribuição abrange emitentes, destinatários, transportadores e terceiros, conforme seus papéis identificados nos grupos do Emitente (tag:emit), Destinatário (tag:dest), Transportador (tag:transporta) e pessoas autorizadas a acessar o XML (tag:autXML).
Documentos Distribuídos por Ator
A disponibilidade de documentos fiscais e 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 à 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 |
¹ Os documentos fiscais e resumos de eventos ficam disponíveis para o destinatário apenas se houver manifestação ("Ciência da Operação", "Operação não Realizada" ou "Confirmação de Operação"), com exceção do Evento de Cancelamento, que é disponibilizado mesmo sem manifestação. Antes da manifestação, o destinatário acessa apenas o Resumo de NF-e e o cancelamento.
² A NF-e é disponibilizada para o transportador se este for identificado no grupo X03 da nota.
³ Para terceiros, a NF-e estará disponível somente se seu CNPJ ou CPF for informado no campo de Pessoas Autorizadas a Acessar o XML.
⁴ Eventos de Pedido de Prorrogação de Prazo referem-se aos tipos EPP1, EPP2, ECPP1 e ECPP2, conforme a NT 2015.001.
⁵ Eventos do Fisco em Resposta ao Pedido de Prorrogação de Prazo referem-se aos tipos EFPP1, EFPP2, EFCPP1 e EFCPP2, conforme a NT 2015.001.
⁶ O Resumo de Eventos de Registro de Passagem é distribuído a partir da implantação da NT 2014/002 v.1.02.
Estrutura das Mensagens e Processo de Distribuição
O Web Service NFeDistribuicaoDFe utiliza estruturas XML para o envio de pedidos e recebimento de retornos.
Leiaute da Mensagem de Entrada
O pedido de distribuição é enviado em uma estrutura XML (distDFeInt_v9.99.xsd) que define os parâmetros da consulta. Os campos essenciais incluem a versão do leiaute, identificação do ambiente (Produção ou Homologação), o código da UF do autor, e o CNPJ ou CPF do interessado.
Para a geração do pedido de distribuição, o XML suporta dois tipos de consulta:
- 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 primeiro disponível para consulta, caso o NSU informado seja menor. O serviço gera lotes com até 50 documentos cujo NSU seja superior ao informado, em ordem crescente. Documentos emitidos pela própria empresa não são disponibilizados. - Consulta de DF-e Vinculado ao NSU Informado (consNSU): Permite consultar pontualmente um NSU específico que foi identificado como faltante na base de dados do interessado. A aplicação cliente informa o NSU desejado.
O processo de envio das informações por Web Service exige o uso de um certificado digital de PJ ou PF válido. O CNPJ ou CPF do interessado permite a recuperação de DF-e de qualquer estabelecimento da empresa utilizando um único certificado digital PJ.
Leiaute da Mensagem de Retorno
A mensagem de retorno (retDistDFeInt_v9.99.xsd) contém os documentos de interesse do ator, com quantidade máxima de 50 documentos por lote. Além da versão do leiaute e identificação do ambiente, inclui a versão do aplicativo que processou a consulta, o código de status (cStat) e a descrição literal do status (xMotivo).
Para otimizar o uso da rede e minimizar as necessidades de infraestrutura, cada documento na mensagem de retorno é compactado individualmente no padrão Gzip (tag:docZip). O tamanho médio de uma NF-e é de aproximadamente 10 KB, e a compactação reduz o tamanho da mensagem de retorno em cerca de 60%. A aplicação cliente deve descompactar os documentos para tratamento.
Os campos ultNSU (último NSU pesquisado) e maxNSU (maior NSU existente) permitem ao solicitante continuar a consulta a partir de um ponto específico para obter novos resultados. Se o ultNSU for igual ao maxNSU, não há mais documentos a serem pesquisados no momento. Recomenda-se aguardar um tempo mínimo de uma hora antes de uma nova solicitação caso não haja mais documentos.
Validações e Tratamento de Erros
O Web Service NFeDistribuicaoDFe realiza diversas validações para garantir a segurança e a integridade das informações.
Validação do Certificado de Transmissão
O certificado digital utilizado na transmissão é rigorosamente validado, abrangendo:
- Certificado Inválido: Verifica se o certificado existe, sua versão, se é um certificado de AC, e se o
KeyUsagedefine "Autenticação Cliente". (Crítica: Rejeição 280) - Validade: Checa a data de início e fim da validade do certificado. (Crítica: Rejeição 281)
- Cadeia de Certificação: Verifica se o certificado da Autoridade Certificadora (AC) emissora está cadastrado, se não foi revogado e se foi assinado pela AC correta. (Crítica: Rejeição 283)
- LCR (Lista de Certificados Revogados): Confere o endereço da LCR, sua disponibilidade e validade. (Crítica: Rejeição 286)
- Certificado Revogado: Se o certificado do transmissor foi revogado. (Crítica: Rejeição 284)
- Certificado Raiz: Valida se o certificado raiz difere da "ICP-Brasil". (Crítica: Rejeição 285)
- Extensão CNPJ/CPF: Verifica a presença da extensão de CNPJ ou CPF no certificado. (Crítica: Rejeição 473)
As validações A01 a A05 são geralmente realizadas pelo protocolo SSL, enquanto a A06 também pode ser, mas pode haver exceções se houver outros certificados raiz não ICP-Brasil.
Validação Inicial da Mensagem e da Área de Dados
A mensagem no Web Service é submetida a validações iniciais, incluindo:
- Tamanho do XML: Rejeição se o XML de dados for superior a 10 KB. (Crítica: Rejeição 214)
- Status do Servidor: Verificação se o servidor de processamento está paralisado temporariamente ou sem previsão. (Crítica: Rejeição 108/109)
Na área de dados, ocorrem validações de forma e de regras de negócio:
- Schema XML: Valida o schema XML da área de dados. (Crítica: Rejeição 215)
- Prefixo de Namespace: Não permite o uso de prefixo no namespace. (Crítica: Rejeição 404)
- Codificação: Rejeita XMLs com codificação diferente de UTF-8. (Crítica: Rejeição 402)
- Versão dos Dados: Verifica se a versão dos dados informada é superior à versão vigente ou não suportada. (Crítica: Rejeição 238/239)
- Ambiente Divergente: Rejeita se o tipo de ambiente da NF-e difere do ambiente de recebimento do Web Service. (Crítica: Rejeição 252)
- CNPJ/CPF Inválido: Valida se o CNPJ ou CPF do interessado na distribuição é inválido (DV ou zeros). (Crítica: Rejeição 489/490)
- CNPJ/CPF do Certificado: Rejeita se o CNPJ-Base do certificado digital difere do CNPJ-Base consultado, ou se o CPF do certificado difere do CPF consultado. (Crítica: Rejeição 593/472)
- NSU Superior ao Máximo: Rejeita se o NSU informado for superior ao maior NSU disponível para consulta na base de dados do Ambiente Nacional. (Crítica: Rejeição 589)
Recomendações para Evitar Uso Indevido
Para evitar sobrecarga e uso indevido dos recursos, o sistema mantém controles para identificar tentativas sucessivas de busca de registros já disponibilizados. Novas tentativas nessas condições serão rejeitadas com o código 656-Rejeição: Consumo Indevido.
Uma lista completa de códigos de erros e descrições de mensagens está disponível na Nota Técnica 2014/002, abordando desde a paralisação do serviço (108, 109) até a rejeição por consumo indevido (656).
Leiautes Resumidos
Para permitir o compartilhamento de informações relevantes com sigilo, foram criados leiautes resumidos para NF-e e eventos.
Leiaute Resumo da NF-e (resNFe_v9.99.xsd)
Esta estrutura XML é gerada pelo Ambiente Nacional com informações resumidas da NF-e, como:
- Chave de acesso da NF-e (
chNFe) - CNPJ ou CPF do Emitente (
CNPJ/CPF) - Razão Social ou Nome do Emitente (
xNome) - Inscrição Estadual do Emitente (
IE) - Data de Emissão da NF-e (
dhEmi) - Tipo de Operação (Entrada/Saída) (
tpNF) - Valor Total da NF-e (
vNF) - Digest Value da NF-e (
digVal) - Data de autorização da NF-e (
dhRecbto) - Número de protocolo da NF-e (
nProt) - Situação da NF-e (Uso autorizado/denegado) (
cSitNFe)
Este documento é distribuído aos destinatários para que possam manifestar-se sobre a operação.
Leiaute Resumo do Evento de NF-e (resEvento_v9.99.xsd)
Esta estrutura XML contém informações resumidas de um evento de NF-e, incluindo:
- Código do órgão de recepção do Evento (91 para Ambiente Nacional) (
cOrgao) - CNPJ ou CPF do Emitente (
CNPJ/CPF) - 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) - Número de protocolo do evento (
nProt)
Modelo de Distribuição por Número Sequencial Único (NSU)
O modelo de distribuição de documentos é baseado na geração de um Número Sequencial Único (NSU) para cada CNPJ ou CPF interessado. O NSU é organizado por ordem cronológica de recepção pelo Ambiente Nacional, garantindo que os documentos sejam recuperados sequencialmente.
Um exemplo do fluxo demonstra como o NSU é gerado e utilizado:
- Emissão da NF-e: O emitente transmite uma NF-e, que é autorizada pela Sefaz e compartilhada com o Ambiente Nacional.
- NSU para Resumo da NF-e: O Ambiente Nacional gera um NSU para o destinatário do resumo da NF-e.
- Consulta do Destinatário: O destinatário consulta o serviço NFeDistribuicaoDFe a partir do último NSU recebido e recupera o resumo da NF-e.
- Evento de Manifestação: O destinatário, com o resumo, gera um evento de manifestação (ex: "Confirmação de Operação").
- NSU para Evento do Destinatário: O Ambiente Nacional gera um NSU deste evento para o emitente.
- Liberação da NF-e para Destinatário: Se o evento de manifestação não for "desconhecimento da operação", o Ambiente Nacional gera um NSU para o destinatário, liberando o download da NF-e completa.
- Consulta do Emitente: O emitente consulta o serviço e recupera o evento gerado pelo destinatário.
- Consulta do Destinatário pela NF-e: O destinatário consulta o serviço e recupera a NF-e completa.
- Evento do Emitente: O emitente gera um evento (ex: cancelamento).
- NSU para Evento do Emitente: O Ambiente Nacional gera um NSU para o destinatário deste evento.
- Consulta do Destinatário pelo Evento: O destinatário consulta e recupera o evento gerado pelo emitente.
- Evento do Fisco: O Ambiente Nacional recebe um evento gerado pelo fisco e gera um NSU para o emitente e outro para o destinatário.
- Consulta por Evento do Fisco: Ambos, emitente e destinatário, consultam o serviço e recuperam o evento gerado pelo fisco.
O endereço do Web Service de Distribuio do Ambiente Nacional está publicado no Portal da NF-e, no link 'Serviços' / 'Relação de Serviços Web'. Para o ambiente de homologação, o endereço está disponível no Portal de Homologação.
Este novo modelo simplifica o processo de acesso a documentos fiscais, pois permite que o emitente consulte eventos manifestados por destinatários e que o destinatário acesse eventos gerados pelo emitente ou pelo fisco. A liberação do download da NF-e para o destinatário ocorre automaticamente após a manifestação, com a geração de um NSU referenciando a NF-e para recuperação.
Conclusão
O Web Service NFeDistribuicaoDFe, conforme detalhado na Nota Técnica 2014/002, representa um avanço na distribuição de documentos fiscais eletrônicos. Ele oferece aos emitentes, destinatários, transportadores e terceiros uma forma padronizada e segura de acessar DF-e e informações resumidas, utilizando o Número Sequencial Único (NSU) como base para a organização e recuperação dos documentos. Este serviço centraliza e simplifica o fluxo de informações fiscais, sendo essencial para a conformidade e a organização das operações fiscais das empresas.