NFeDistribuicaoDFe: Consulta NF-e, Eventos e Acesso para Atores
Consulta de DF-e via Web Service NFeDistribuicaoDFe. Acesso a NF-e e eventos para emitentes, destinatários, transportadores e terceiros.
NFeDistribuicaoDFe: Consulta NF-e, Eventos e Acesso para Atores
A gestão de documentos fiscais eletrônicos (DF-e) é um ponto central para empresas e profissionais contábeis. A Nota Técnica 2014.002 do Projeto Nota Fiscal Eletrônica regulamenta o uso do Web Service NFeDistribuicaoDFe. Este serviço permite que emissores, destinatários, transportadores e terceiros acessem informações e documentos fiscais eletrônicos de seu interesse.
O objetivo é prover acesso eficiente e confiável aos DF-e. A distribuição é feita para atores identificados no conteúdo da Nota Fiscal Eletrônica (NF-e) nos grupos de emitente, destinatário, transportador e pessoas físicas autorizadas a acessar o XML (tag autXML).
Web Service NFeDistribuicaoDFe: Funções e Acesso
O Web Service NFeDistribuicaoDFe tem a função de distribuir informações resumidas e documentos fiscais eletrônicos. É um serviço síncrono, operado pelo método nfeDistDFeInteresse. Este serviço permite o acesso a documentos que não foram gerados pelo próprio ator, mas são de seu interesse, seja Pessoa Jurídica ou Física, utilizando um certificado digital.
Para Pessoas Jurídicas, a consulta pode ser realizada para qualquer CNPJ da empresa, desde que o CNPJ base (os 8 primeiros dígitos) consultado seja o mesmo do certificado digital. Os documentos e informações resumidas ficam disponíveis por até 90 dias após a recepção pelo Ambiente Nacional da NF-e.
Disponibilidade dos Documentos por Tipo de Ator
A disponibilidade dos documentos e informações varia conforme o papel do ator na NF-e:
- Destinatário:
- A NF-e integral é retornada se houver manifestação ("Ciência da Operação", "Operação não Realizada" ou "Confirmação de Operação").
- Caso contrário, retorna apenas o resumo da NF-e para que a manifestação possa ser realizada.
- O Evento de Cancelamento é disponibilizado independentemente da manifestação.
- Transportador e Terceiros (identificados no campo
autXML):- A NF-e estará disponível integralmente na consulta.
- Para o transportador, a NF-e é acessível se identificado no grupo X03 ou no evento "Ator Interessado na NF-e" (código 110150).
- Para terceiros, a NF-e é acessível se o CNPJ ou CPF estiver informado na tag
autXML.
- Emitente:
- Eventos de Manifestação do Destinatário, Eventos da Suframa e eventos do Fisco em resposta ao pedido de prorrogação são disponibilizados.
- Eventos do Fisco são distribuídos ao emitente mesmo que emitente e destinatário sejam iguais, a partir da versão 1.13 da Nota Técnica.
A tabela a seguir detalha quais documentos e eventos são distribuídos para cada ator:
| Documentos | Emitente | Destinatário | Transportador | Terceiros | CNPJ Ator Interessado |
|---|---|---|---|---|---|
| NF-e | Não | Sim | Sim | Sim | Sim |
| Evento de Cancelamento | Não | Sim | Sim | Sim | Sim |
| Evento de Carta de Correção | Não | Sim | Sim | Sim | Sim |
| Eventos de Manifestação do Destinatário | Sim | Não | Não | Sim | Não |
| Eventos da Suframa (Vistoria/Internalização) | Sim | Sim | Não | Sim | Não |
| EPEC | Não | Sim | Sim | Não | Sim |
| Eventos de Pedido de Prorrogação de Prazo | Não | Sim | Não | Não | Não |
| Eventos do Fisco em Resposta ao Pedido de Prorrogação | Sim | Sim | Não | Não | Não |
| Evento de Averbação | Sim | Sim | Sim | Sim | Sim |
| Resumo de NF-e | Não | Sim | Não | Não | Não |
| Resumo de Eventos CTe Autorizado/Cancelado | Sim | Sim | Sim | Sim | Sim |
| Resumo de Eventos MDFe Autorizado/Cancelado | Sim | Sim | Sim | Sim | Sim |
| Resumo de Eventos de Registro de Passagem | Sim | Sim | Sim | Sim | Sim |
| Evento de Comprovante de Entrega propagado do CTe | Sim | Sim | Sim | Sim | Sim |
| Evento de Comprovante de Entrega na NF-e e Cancelamento | Não | Sim | Sim | Sim | Sim |
Estrutura das Mensagens e Tipos de Consulta
O Web Service NFeDistribuicaoDFe utiliza mensagens XML para requisições e retornos.
Mensagem de Entrada: Pedido de Distribuição
A mensagem de entrada (distDFeInt) é uma estrutura XML para o pedido de distribuição. Campos importantes incluem:
versao: Versão do leiaute.tpAmb: Identificação do ambiente (1=Produção / 2=Homologação).cUFAutor: Código da UF do autor.CNPJ/CPF: CNPJ ou CPF do interessado.distNSU: Grupo para distribuição de DF-e a partir do Número Sequencial Único (NSU).ultNSU: O último NSU recebido pelo ator. Se informado com zero ou um NSU antigo, a consulta retorna informações resumidas e documentos fiscais eletrônicos recepcionados nos últimos 90 dias.
consNSU: Grupo para consultar um DF-e a partir de um NSU específico.NSU: Número Sequencial Único para consulta pontual de um documento.
consChNFe: Grupo para consultar uma NF-e pela chave de acesso.chNFe: Chave de acesso específica da NF-e.
Mensagem de Retorno: Documentos Compactados
A mensagem de retorno (retDistDFeInt) contém os documentos de interesse do ator, com um limite máximo de 50 documentos por lote. Para otimizar a infraestrutura de rede, cada documento (docZip) é compactado individualmente no padrão Gzip. A aplicação cliente deve descompactá-los.
Campos importantes do retorno:
cStat: Código do status da resposta.xMotivo: Descrição literal do status.ultNSU: Último NSU pesquisado. Permite continuar a consulta a partir desse ponto.maxNSU: Maior NSU existente no Ambiente Nacional para o CNPJ/CPF informado.loteDistDFeInt: Conjunto de informações resumidas e documentos fiscais eletrônicos.docZip: Informação resumida ou documento fiscal eletrônico, compactado em Gzip.
Processo de Distribuição de DF-e de Interesse
O Ambiente Nacional gera um Número Sequencial Único (NSU) para cada interessado nos documentos fiscais. A partir da versão 1.10 da Nota Técnica, a geração de NSU considera apenas os usuários do serviço nos últimos 60 dias. Para novos usuários ou aqueles que ficaram mais de 60 dias sem utilizar o serviço, a geração de NSU retroativo não ocorre, sendo iniciada a partir do primeiro acesso subsequente.
O pedido de distribuição via Web Service requer um certificado digital de Pessoa Jurídica ou Física válido.
Tipos de Consulta Detalhados
-
Distribuição de Conjunto de DF-e a Partir do NSU Informado (
distNSU):- A aplicação cliente informa o
ultNSUque possui. - O Ambiente Nacional retorna todos os documentos (NF-e e eventos) disponíveis a partir desse NSU, em lotes de até 50 documentos, em ordem crescente de NSU.
- Se o NSU informado for menor que o primeiro disponível, são fornecidos documentos cujas NF-e e eventos foram autorizados há menos de 90 dias.
- A sincronização é por ordem de recepção dos documentos pelo Ambiente Nacional, não por emissão ou autorização.
- A aplicação cliente informa o
-
Consulta 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.
- O Ambiente Nacional retorna um único documento fiscal (NF-e ou evento) referente ao NSU informado.
-
Consulta de NF-e por Chave de Acesso Informada (
consChNFe):- Permite consultar uma NF-e específica pela chave de acesso.
- A chave de acesso deve ser válida, existir no Ambiente Nacional e estar vinculada ao interessado (destinatário, transportador ou terceiro).
- O retorno é somente a NF-e, sem eventos relacionados.
- Desde a versão 1.15 da Nota Técnica, não é mais necessária a prévia geração de NSU para o documento fiscal consultado.
Todas as consultas por NSU ou chave de acesso estão disponíveis para documentos recebidos pelo Ambiente Nacional nos últimos 90 dias. Após este período, a recuperação não é possível.
Validações e Regras de Negócio
O processo de consulta e distribuição de DF-e envolve 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 da requisição é validado quanto à sua autenticidade e validade. Regras incluem:
- Validade do certificado (data de início e fim).
- Verificação da cadeia de certificação (AC emissora, certificados revogados).
- Existência da extensão de CNPJ ou CPF no certificado.
- O certificado raiz deve ser "ICP-Brasil".
Validação Inicial da Mensagem e da Área de Dados
A mensagem XML de requisição passa por validações preliminares:
- Tamanho do XML: Não pode exceder 10 KB. Mensagens maiores podem ser descartadas.
- Serviço paralisado: Verificação se o servidor de processamento está temporariamente ou sem previsão paralisado.
- Schema XML: Conformidade com o schema XML esperado.
- Codificação: O XML deve utilizar codificação UTF-8.
- Versão dos dados: A versão informada deve ser compatível.
Validação de Regras de Negócio
Critérios específicos de negócio são aplicados para processar a requisição:
- Ambiente da NF-e: Deve coincidir com o ambiente do Web Service.
- CNPJ/CPF do interessado: Validação do dígito verificador.
- Certificado Digital: O CNPJ base do certificado digital deve ser o mesmo do CNPJ consultado, ou o CPF deve ser idêntico ao CPF consultado.
- NSU: O NSU informado não pode ser superior ao maior NSU disponível para consulta (para
distNSUeconsNSU). - Chave de Acesso: Validação da chave de acesso, incluindo Código da UF, Ano, Mês, CNPJ, Modelo da NF-e (55 para NF-e), Número da NF, e dígito verificador (para
consChNFe). - Prazo de download: A NF-e deve estar no prazo de 90 dias de recebimento no Ambiente Nacional.
- Permissão de consulta: O CNPJ/CPF do interessado deve ter permissão para consultar a NF-e.
- NF-e do emitente: A NF-e não é disponibilizada para consulta pelo próprio emitente.
- Status da NF-e: NF-e Cancelada ou Denegada pode ter o arquivo indisponível para download.
Leiautes Resumidos
Para permitir o compartilhamento de informações sem violar o sigilo, foram criados leiautes resumidos:
- Resumo da NF-e (
resNFe): Contém informações essenciais como chave de acesso, CNPJ/CPF do emitente, razão social, IE, data de emissão, tipo de operação, valor total da NF-e, digest value, data de autorização, número de protocolo e situação da NF-e (Uso autorizado, Uso denegado, NF-e Cancelada). É gerado na autorização ou denegação da NF-e e distribuído aos destinatários para a manifestação da operação. - Resumo do Evento de NF-e (
resEvento): Apresenta informações resumidas de um evento da NF-e, como código do órgão de recepção, CNPJ/CPF do emitente, chave de acesso da NF-e, data e hora do evento, tipo de evento, número sequencial, descrição do evento, data de autorização e número de protocolo do evento.
Fluxo de Distribuição e Prevenção de Uso Indevido
O modelo de distribuição se baseia na geração de um NSU para cada CNPJ ou CPF. Por exemplo, quando uma NF-e é autorizada, o Ambiente Nacional gera um NSU para o destinatário com o resumo da NF-e. Após a manifestação do destinatário, outro NSU é gerado para ele com a NF-e completa para download. Da mesma forma, eventos gerados pelo destinatário geram NSUs para o emitente, e eventos do fisco geram NSUs para ambos.
Para evitar o uso indevido do serviço, a Nota Técnica 2014.002 estabelece regras para o consumo do Web Service NFeDistribuicaoDFe:
- Consultas
distNSU:- Se não houver mais documentos a serem retornados (
cStat=137), o usuário deve aguardar 1 hora para nova consulta. Consultas antes desse prazo resultam emcStat=656(Consumo Indevido) e bloqueio do CNPJ por 1 hora. - O
ultNSUretornado na consulta anterior deve ser utilizado nas solicitações subsequentes para manter a sequência. Descumprir essa regra também leva ao bloqueio (cStat=656). - Ações de diferentes aplicações do mesmo ator (
CNPJ/CPF) devem seguir a mesma sequência de numeração ordenada para evitar uso indevido.
- Se não houver mais documentos a serem retornados (
- Consultas
consChNFeeconsNSU:- Há um limite de consultas por chave de acesso ou NSU em um período de 1 hora. Exceder esse limite (20 consultas por hora) gera
cStat=656e bloqueio por 1 hora. - Se o usuário receber
cStat=656, deve aguardar 1 hora. Retomar a consulta antes de completar o período reinicia a contagem do tempo de bloqueio.
- Há um limite de consultas por chave de acesso ou NSU em um período de 1 hora. Exceder esse limite (20 consultas por hora) gera
Os endereços dos Web Services estão disponíveis nos portais da NF-e do governo federal, tanto em ambiente de produção quanto de homologação, na seção "Serviços / Relação de Serviços Web".
Conclusão
A Nota Técnica 2014.002 detalha o funcionamento do Web Service NFeDistribuicaoDFe, um mecanismo central para o acesso a documentos fiscais eletrônicos. A compreensão das regras de acesso, tipos de consulta, validações e medidas de prevenção ao uso indevido é fundamental para garantir o correto consumo do serviço e a conformidade fiscal das operações. A consulta e distribuição de DF-e permitem que os diferentes atores envolvidos mantenham suas bases de dados atualizadas, facilitando a gestão e auditoria fiscal.