Web Service – NfeDistribuicaoDFe

Este serviço permite que um ator da NF-e tenha acesso aos documentos fiscais eletrônicos (DF-e) e informações resumidas que não tenham sido gerados por ele e que sejam de seu interesse. Pode ser consumido por qualquer ator de NF-e, Pessoa Jurídica ou Pessoa Física, que possua um certificado digital de PJ ou PF. No caso de Pessoa Jurídica, a empresa será autenticada pelo CNPJ base e poderá realizar a consulta com 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 estarão disponíveis para distribuição por até 3 meses após sua recepção pelo Ambiente Nacional da NF-e. A distribuição ocorrerá para os atores que desempenham papéis de emitente, destinatário, transportador e terceiros (informado na tag autXML) conforme a tabela abaixo:

¹Os documentos fiscais e resumos de eventos estarão disponíveis somente se o destinatário se manifestar dando "Ciência da Operação", “Operação não Realizada” ou "Confirmação de Operação" para a NF-e, exceto para o Evento de Cancelamento, que será disponibilizado mesmo sem a manifestação do destinatário. Antes da manifestação ficará disponível para o destinatário somente a estrutura XML de “Resumo de NF-e” e o cancelamento de NF-e.

²A NF-e estará disponível somente para o transportador identificado no grupo X03.

³A NF-e estará disponível para terceiros somente cujo CNPJ ou CPF estiver informado na tag autXML.

⁴Eventos de Pedido de Prorrogação de Prazo da NT 2015.001: EPP1 e EPP2 (Evento Pedido de Prorrogação 1º e 2º Prazo), ECPP1 e ECPP2 (Evento Cancelamento Pedido de Prorrogação 1º e 2º Prazo).

⁵Eventos do Fisco em Resposta ao Pedido de Prorrogação de Prazo da NT 2015.001: EFPP1 e EFPP2 (Evento Fisco Resposta ao Pedido de Prorrogação 1º e 2º Prazo), EFCPP1 e EFCPP2 (Evento Fisco Resposta ao Cancelamento de Prorrogação 1º e 2º Prazo).

⁶Os Eventos de Averbação serão distribuídos a partir da implantação da BT 2017.001 v1.0.

⁶Os eventos de comprovante de entrega serão distribuídos a partir da implantação do BT 2019.001 v.1.10.

O tamanho médio da NF-e é de aproximadamente 10 KB (dependendo da quantidade de itens), necessitando de um dimensionamento correto da rede interna e do canal de Internet das empresas e do Ambiente Nacional.

Para minimizar necessidades de infraestrutura de rede cada documento contido na mensagem de retorno da solicitação será compactado (tag:docZip). Estima-se que a compactação reduzirá o tamanho da mensagem de retorno em aproximadamente 60%.

A aplicação do Ambiente Nacional irá compactar individualmente cada documento da mensagem de retorno e a aplicação cliente deverá descompactá-lo e seguir o procedimento normal do tratamento do documento descompactado.

O padrão de compactação adotado para o projeto será o Gzip (GNU zip) que é implementado nas plataformas Java e .NET.

Este serviço pode ser consumido por atores que desempenham papel na NF-e de emitente, destinatário, transportador ou terceiro, Pessoa Física ou Jurídica, que possua um certificado digital com, respectivamente, seu CPF ou seu CNPJ.

O Ambiente Nacional gera um número sequencial único (NSU) para cada interessado nos documentos fiscais. Os documentos recuperados deverão conter uma sequência de numeração sem intervalos em sua base de dados.

O XML do pedido de distribuição suporta três tipos de consultas que são definidas de acordo com a tag informada no XML. As tags são distNSU, consNSU e consChNFe.

A aplicação cliente do WS deve informar o último número sequencial único (ultNSU) que possui. Caso o NSU informado seja menor que o primeiro NSU disponível para distribuição, a aplicação do Ambiente Nacional deverá fornecer os documentos a partir do primeiro disponível para consulta.

Este processo de consulta DF-e a partir de um NSU permite que o interessado nos documentos fiscais consulte de maneira pontual um NSU que foi identificado como faltante em sua base de dados.

A aplicação cliente do WS deve informar o número sequencial único (NSU) identificado como faltante em sua base de dados

Este processo de consulta a partir de uma chave de acesso permite que o interessado na NF-e consulte de maneira pontual uma chave de acesso e obtenha o documento relativo à esta chave. A aplicação cliente do WS deve informar uma chave de acesso válida para recuperar a NF-e.

Informar o CPF da pessoa física ou CNPJ da empresa para recuperação de DF-e de seu interesse. Este campo possibilita que uma empresa consiga recuperar os DF-e de qualquer um de seus estabelecimentos utilizando somente um certificado digital PJ.

O pedido de distribuição será enviado por Web Service, sendo necessário o uso de um certificado digital de PJ ou PF válido.

O WS do Ambiente Nacional é acionado pela aplicação cliente do interessado que deve enviar uma mensagem que atenda os padrões estabelecidos neste manual.

O Web Service deverá gerar lotes com até 50 documentos ao interessado com informações resumidas ou documentos fiscais eletrônicos que tenham o número sequencial único (NSU) superior ao NSU informado.

Caso o NSU informado seja menor que o primeiro NSU disponível para distribuição, a aplicação do Ambiente Nacional deverá fornecer os documentos a partir do primeiro disponível para consulta.

A criação do lote de documentos deverá observar as seguintes regras:

• Ordem crescente de NSU
• O lote poderá conter qualquer tipo de documento válido e seu respectivo NSU
• Quantidade máxima de documentos no lote: 50 documentos

Documentos emitidos pela própria empresa não estarão disponíveis para consulta.

Importante ressaltar que o processo de recepção e sincronização não será realizado em ordem cronológica de emissão ou autorização de uso, uma vez que a geração do NSU dos documentos será organizada por ordem cronológica de recepção pelo Ambiente Nacional.

Não existe necessidade de o Ambiente Nacional estar sincronizado em tempo real com todos os documentos fiscais autorizados. Como a geração do NSU será organizada por ordem de inserção de documentos, a empresa ou pessoa física conseguirá recuperar todos os documentos de seu interesse tão logo estes sejam recebidos pelo Ambiente Nacional da NF-e.

É conveniente manter um controle do primeiro NSU válido para consulta. A resposta do WS do Ambiente Nacional poderá ser:

• Rejeição –
  com a devolução da mensagem com o motivo da falha informado no cStat;
• Nenhum documento localizado –
  não existe documentos fiscais para o CNPJ/CPF informado – cStat=”137-Nenhum documento localizado”;
• Documento localizado –
  com a devolução dos documentos fiscais encontrados – cStat=”138- Documento(s) localizado(s)”.

A empresa deverá aguardar um tempo mínimo de uma hora para efetuar uma nova solicitação de distribuição caso receba a indicação que não existem mais documentos a serem pesquisados na base de dados do Ambiente Nacional. Se o NSU informado (tag:ultNSU) for igual ao maior NSU do Ambiente Nacional (tag:maxNSU), então não existem mais documentos a serem pesquisados no momento.

Considerando que o Ambiente Nacional gera NSU sem lacunas, o processo de distribuição de conjunto de DF-e a partir do NSU informado (tag:distNSU) disponibiliza para o interessado uma sequência de numeração ordenada de forma ascendente. A identificação de alguma lacuna na base de dados do interessado indica que houve alguma falha no processo de distribuição dos documentos.

Neste caso, o interessado deve consultar pontualmente os NSU identificados como faltantes em sua base de dados através do método nfeDistDFeInteresse do Web Service nfeDistribuicaoDFe informando o NSU desejado no conteúdo da tag consNSU no XML de requisição

A resposta do WS poderá ser:

• Rejeição –
  com a devolução da mensagem com o motivo da falha informado no cStat;
• Nenhum documento localizado –
  indicando que o Ambiente Nacional não gerou o NSU e o interessado deve desconsiderá-lo – cStat=”137-Nenhum documento localizado”;
• Documento localizado –
  com a devolução dos documento fiscal encontrado – cStat=”138- Documento localizado”.

O processo de consulta por chave de acesso (tag: chNFe) permite ao interessado consultar pontualmente uma NF-e pela chave de acesso. A chave de acesso informada deve ser válida, existir no Ambiente Nacional e estar vinculada ao interessado como destinatário, transportador ou terceiro.

Caso a consulta seja realizada pelo destinatário o Ambiente Nacional irá verificar a existência de sua manifestação (“Ciência da Operação”, “Operação não Realizada” ou “Confirmação de Operação”). Em caso da existência da manifestação do destinatário a NF-e será retornada para o destinatário. Caso contrário, será retornado apenas o resumo da NF-e. Com o resumo o destinatário terá as informações necessárias para realizar a manifestação.

Para transportador e terceiros a NF-e estará disponível integralmente na consulta. Para o emitente a NF-e não será disponibilizada nesta consulta.

Assim como nas demais consultas disponibilizadas pelo Web Service nfeDistribuicaoDFe, a consulta por chave de acesso estará disponível para documentos recebidos pelo Ambiente Nacional nos últimos 90 dias. Após este período não será possível recuperar a NF-e.

A resposta do WS poderá ser:

• Rejeição –
  com a devolução da mensagem com o motivo da falha informado no cStat;
• Nenhum documento localizado –
  indicando que o Ambiente Nacional não possui a NF-e consultada – cStat= “137-Nenhum documento localizado”;
• Documento localizado –
  com a devolução dos documento fiscal encontrado – cStat=”138- Documento localizado”.

Serão aplicadas as regras de validação genéricas conforme os grupos citados na tabela abaixo, detalhados na Seção 1 do Anexo de Regras de Validação da NF-e e da NFC-e.

As regras de validação específicas deste WS podem ser vistas abaixo:

#	Regra de Validação	Aplic.	Msg	Efeito	Descrição Erro
H01	Tipo do ambiente da NF-e difere do ambiente do Web Service	Obrig.	252	Rej.	Rejeição: Ambiente informado diverge do Ambiente de recebimento
H02	CNPJ do interessado na distribuição inválido (DV ou zeros)	Obrig.	489	Rej.	Rejeição: CNPJ informado inválido (DV ou zeros)
H03	CPF do interessado na distribuição inválido (DV ou zeros)	Obrig.	490	Rej.	Rejeição: CPF informado inválido (DV ou zeros)
H04	CNPJ do Certificado Digital utilizado na transmissão não tem o mesmo CNPJ base do CNPJ consultado	Obrig.	593	Rej.	Rejeição: CNPJ-Base consultado difere do CNPJ-Base do Certificado Digital
H05	CPF do Certificado Digital utilizado na transmissão diferente do CPF consultado	Obrig.	472	Rej.	Rejeição: CPF consultado difere do CPF do Certificado Digital
H061	Número do NSU informado superior ao maior NSU disponível para consulta	Obrig.	589	Rej.	Rejeição: Número do NSU informado superior ao maior NSU do Ambiente Nacional
H072	Chave de Acesso com dígito verificador inválido	Obrig.	236	Rej.	Rejeição: Chave de Acesso com dígito verificador inválido
H082	Chave de Acesso inválida (Código UF inválido)	Obrig.	614	Rej.	Rejeição: Chave de Acesso inválida (Código UF inválido)
H092	Chave de Acesso inválida (Ano < 06 ou Ano maior que Ano)	Obrig.	615	Rej.	Rejeição: Chave de Acesso inválida (Ano menor que 06 ou Ano maior que Ano
H102	Chave de Acesso inválida (Mês =0 ou Mês > 12)	Obrig.	616	Rej.	Rejeição: Chave de Acesso inválida (Mês menor que 1 ou Mês maior que 12)
H112	Chave de Acesso inválida: - Série = [0-909] e CNPJ zerado ou dígito inválido, ou - Série = [910-969] e CPF zerado ou dígito inválido Exceção: Não se aplica para NFF (tpEmis = 3-NFF) (NT 2021.002)	Obrig.	617	Rej.	Rejeição: Chave de Acesso inválida (CNPJ zerado ou dígito inválido)
H122	Chave de Acesso inválida (modelo diferente de 55)	Obrig.	618	Rej.	Rejeição: Chave de Acesso inválida (CNPJ zerado ou dígito inválido)
H132	Chave de Acesso inválida (número NF = 0)	Obrig.	619	Rej.	Rejeição: Chave de Acesso inválida (número NF = 0)
H142	NF-e inexistente para a chave de acesso informada	Obrig.	217	Rej.	Rejeição: NF-e inexistente para a chave de acesso informada
H152	Verificar se NF-e está no prazo de download, 90 dias da data de recebimento da NF-e no Ambiente Nacional	Obrig.	632	Rej.	Rejeição: Solicitação fora de prazo, a NF-e não está mais disponível para download
H162	Se CNPJ, verificar se o CNPJ do interessado na NF-e tem o mesmo CNPJ-Base informado no pedido. Se CPF, verificar se o CPF é o mesmo do interessado.	Obrig.	640	Rej.	Rejeição: CNPJ/CPF do interessado não possui permissão para consultar esta NF-e
H172	A NF-e não deve ser disponibilizada para o emitente da NF-e. Verificar se CNPJ do interessado na NF-e é o emitente.	Obrig.	641	Rej.	Rejeição: NF-e indisponível para o emitente
H182	NF-e Cancelada, arquivo NF-e indisponível para download	Obrig.	653	Rej.	Rejeição: NF-e Cancelada, arquivo indisponível para download
H192	NF-e Denegada, arquivo NF-e indisponível para download	Obrig.	654	Rej.	Rejeição: NF-e Denegada, arquivo indisponível para download

Para possibilitar o compartilhamento de informações relevantes para o ator de forma a manter o sigilo da informação, foram criados dois novos leiautes contendo informações resumidas das NF-e e informações resumidas dos eventos.

Descrição:
Estrutura XML gerada pelo Ambiente Nacional com o conjunto de informações resumidas da NF-e. Este documento será distribuído para os destinatários possibilitando sua manifestação na operação acobertada pela Nota Fiscal eletrônica emitida para o seu CNPJ.
Schema XML: resNFe_v1.01.xsd

O modelo de distribuição de documentos é baseado na geração de um número sequencial único (NSU) para cada CNPJ ou CPF. O fluxo que pode ser visto na figura abaixo exemplifica a geração do NSU para o emitente e destinatário da NF-e.

A consulta no Web Service nfeDistribuicaoDFe poderá ser realizada a qualquer instante pela empresa ou pessoa física. O Ambiente Nacional disponibilizará para consulta os documentos de interesse de cada ator. Seguem os passos do fluxo exemplificado:

(1) O emitente gera e transmite uma NF-e que será autorizada pela Sefaz e compartilhada com o Ambiente Nacional;

(2) O Ambiente Nacional gera um NSU para o destinatário do resumo da NF-e e o disponibiliza para consulta;

(3) O destinatário consulta o WS nfeDistribuicaoDFe a partir do último NSU recebido e recupera o resumo da NF-e;

(4) O destinatário, de posse do resumo da NF-e, gera um evento de NF-e (Ex. evento de manifestação do destinatário);

(5) O Ambiente Nacional gera um NSU do evento gerado pelo destinatário para o emitente e o disponibiliza para consulta;

(6) Caso seja um evento de manifestação do destinatário diferente do tipo “desconhecimento da operação”, o Ambiente Nacional gera um NSU para o destinatário com a NF-e (liberação do download);

(7) O emitente consulta o WS nfeDistribuicaoDFe a partir do último NSU recebido e recupera o evento gerado pelo destinatário;

(8) O destinatário consulta o WS nfeDistribuicaoDFe a partir do último NSU recebido e recupera a NF-e;

(9) O emitente gera um evento de sua NF-e (ex.: evento de cancelamento de NF-e, caso não exista outro evento que impeça este cancelamento) que será compartilhado pela Sefaz com o Ambiente Nacional;

(10) O Ambiente Nacional gera um NSU para o destinatário do evento gerado pelo emitente e o disponibiliza para consulta;

(11) O destinatário consulta o WS nfeDistribuicaoDFe a partir do último NSU recebido e recupera o evento gerado pelo emitente;

(12) O Ambiente Nacional recebe um evento gerado pelo fisco e gera um NSU para o emitente e outro NSU para o destinatário, disponibilizando-os para consulta;

(13) Tanto o emitente quanto o destinatário consultam o WS nfeDistribuicaoDFe a partir do último NSU recebido e recuperam o evento gerado pelo fisco;

O fluxo exemplificado resulta nos seguintes NSU para emitente e destinatário:

Este novo modelo permitirá ao emitente a consulta dos eventos manifestados pelos destinatários de suas NF-e. Também será disponibilizado para o destinatário da NF-e qualquer evento gerado pelo emitente. Além disso, os eventos gerados pelo fisco serão disponibilizados tanto para o emitente quanto para o destinatário da NF-e.

O modelo simplifica o processo de download da NF-e uma vez que a partir da manifestação do destinatário o Ambiente Nacional gera automaticamente um NSU referenciando a NF-e e permitindo sua recuperação a partir do WS nfeDistribuicaoDFe.

A análise do comportamento atual das aplicações das empresas (“aplicação cliente”) permite identificar algumas situações de “uso indevido” nos ambientes autorizadores.

Como exemplo maior do mau uso do ambiente, ressalta-se a falta de controle de algumas aplicações que entram em “loop”, consumindo recursos de forma indevida, sobrecarregando principalmente o canal de comunicação com a Internet.

Para este Web Service serão mantidos controles para identificar as situações de uso indevido de sucessivas tentativas de busca de registros já disponibilizados anteriormente.

As novas tentativas serão rejeitadas com o erro “656–Rejeição: Consumo Indevido”.

Os endereços dos Web Services de Distribuição do Ambiente Nacional estão publicados no Portal da NF- e , e no Portal de Homologação no menu “Serviços” / “Relação de Serviços Web”.