Professional Documents
Culture Documents
Verso 1.02
Outubro 2016
Nota Fiscal Eletrnica Nota Tcnica 2014/002
ndice
Pg. 2 / 15
Nota Fiscal Eletrnica Nota Tcnica 2014/002
1. Controle de Verses
Verso Data/Descrio
1.00 01/2014 Verso inicial desenvolvida pelo Serpro
1.01 08/2014 Acertos sugeridos pelo Grupo XML
1.02 10/2016 Evoluo da NT 2014.002
Incluso para distribuio dos Eventos: Registro de Passagem, Pedido de
Prorrogao/Cancelamento do prazo de suspenso do ICMS nas remessas
enviadas para industrializao e os demais Eventos de Resposta do Fisco;
Possibilidade de consulta ao Web Service para uma chave de acesso de NF-e
informada;
Distribuio do Evento de Cancelamento para o destinatrio independente de sua
manifestao;
Pg. 3 / 15
Nota Fiscal Eletrnica Nota Tcnica 2014/002
2. Resumo
Um dos grandes desafios do projeto Nota Fiscal Eletrnica prover para os atores envolvidos nos
processos da NF-e informaes de seu interesse de forma eficiente e confivel.
Esta nota tcnica tem como objetivo a alterao do Web Service denominado NFeDistribuicaoDFe que
disponibiliza para os atores da NF-e informaes e documentos fiscais eletrnicos de seu interesse. A
distribuio realizada para emitentes, destinatrios, transportadores e terceiros informados no
contedo da NF-e respectivamente no grupo do Emitente (tag:emit, id:C01), no grupo do Destinatrio
(tag:dest, id:E01), no grupo do Transportador (tag:transporta, id:X03) e no grupo de pessoas fsicas
autorizadas a acessar o XML (tag:autXML, id:GA01).
Este Web Service possibilitar a descontinuidade, no futuro, do Web Service de Consulta da Relao
de Documentos Destinados (NfeConsultaDest).
Pg. 4 / 15
Nota Fiscal Eletrnica Nota Tcnica 2014/002
Web Service
NFeDistribuicaoDFe
Consulta DF-e de interesse Req. Distribui
nfeDistDFeInteresse
documentos
Ret.
Cliente
Aplicao NF-e
Retorno
Processo: sncrono
Mtodo: nfeDistDFeInteresse
Este servio permite que um ator da NF-e tenha acesso aos documentos fiscais eletrnicos (DF-e) e
informaes resumidas que no tenham sido gerados por ele e que sejam de seu interesse. Pode ser
consumido por qualquer ator de NF-e, Pessoa Jurdica ou Pessoa Fsica, que possua um certificado
digital de PJ ou PF. No caso de Pessoa Jurdica, 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 eletrnicos e informaes resumidas estaro disponveis para distribuio por
at 3 meses aps sua recepo pelo Ambiente Nacional da NF-e. A distribuio ocorrer para os atores
que desempenham papis de emitente, destinatrio, transportador e terceiros (informado na tag autXML)
conforme tabela abaixo:
1 Os documentos fiscais e resumos de eventos estaro disponveis somente se o destinatrio se manifestar dando "Cincia da
Operao", Operao no Realizada ou "Confirmao de Operao" para a NF-e, exceto para o Evento de Cancelamento,
que ser disponibilizado mesmo sem a manifestao do destinatrio. Antes da manifestao ficar disponvel para o
destinatrio somente a estrutura XML de Resumo de NF-e e o cancelamento de NF-e.
2 A NF-e estar disponvel somente para o transportador identificado no grupo X03.
3 A NF-e estar disponvel para terceiros somente cujo CNPJ ou CPF estiver informado na tag autXML.
Pg. 5 / 15
Nota Fiscal Eletrnica Nota Tcnica 2014/002
4 Eventos de Pedido de Prorrogao de Prazo da NT 2015.001: EPP1 e EPP2 (Evento Pedido de Prorrogao 1 e 2 Prazo),
ECPP1 e ECPP2 (Evento Cancelamento Pedido de Prorrogao 1 e 2 Prazo).
5 Eventos do Fisco em Resposta ao Pedido de Prorrogao de Prazo da NT 2015.001: EFPP1 e EFPP2 (Evento Fisco Resposta
ao Pedido de Prorrogao 1 e 2 Prazo), EFCPP1 e EFCPP2 (Evento Fisco Resposta ao Cancelamento de Prorrogao 1 e
2 Prazo).
Pg. 6 / 15
Nota Fiscal Eletrnica Nota Tcnica 2014/002
O padro de compactao adotado para o projeto ser o Gzip (GNU zip) que implementado nas
plataformas Java e .NET.
Este servio pode ser consumido por atores que desempenham papel na NF-e de emitente, destinatrio,
transportador ou terceiro, Pessoa Fsica ou Jurdica, que possua um certificado digital de PF com seu
CPF ou PJ com seu CNPJ.
O Ambiente Nacional gera um nmero sequencial nico (NSU) para cada interessado nos documentos
fiscais. Os documentos recuperados devero conter uma sequncia de numerao sem intervalos em
sua base de dados.
O XML do pedido de distribuio suporta trs tipos de consultas que so definidas de acordo com a tag
informada no XML. As tags so distNSU, consNSU e consChNFe.
A aplicao cliente do WS deve informar o ltimo nmero sequencial nico (ultNSU) que possui.
Caso o NSU informado seja menor que o primeiro NSU disponvel para distribuio, a aplicao do
Ambiente Nacional dever fornecer os documentos a partir do primeiro disponvel 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 aplicao cliente do WS deve informar o nmero 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 aplicao cliente do WS deve informar uma chave de acesso vlida para recuperar a NF-e.
Pg. 7 / 15
Nota Fiscal Eletrnica Nota Tcnica 2014/002
Informar o CPF da pessoa fsica ou CNPJ da empresa para recuperao 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 distribuio ser enviado por Web Service, sendo necessrio o uso de um certificado digital
de PJ ou PF vlido.
O WS do Ambiente Nacional acionado pela aplicao cliente do interessado que deve enviar uma
mensagem que atenda os padres estabelecidos neste manual.
O Web Service dever gerar lotes com at 50 documentos ao interessado com informaes resumidas
ou documentos fiscais eletrnicos que tenham o nmero sequencial nico (NSU) superior ao NSU
informado.
Caso o NSU informado seja menor que o primeiro NSU disponvel para distribuio, a aplicao do
Ambiente Nacional dever fornecer os documentos a partir do primeiro disponvel para consulta.
No existe necessidade de o Ambiente Nacional estar sincronizado em tempo real com todos os
documentos fiscais autorizados. Como a gerao do NSU ser organizada por ordem de insero de
documentos, a empresa ou pessoa fsica conseguir recuperar todos os documentos de seu interesse
to logo estes sejam recebidos pelo Ambiente Nacional da NF-e.
A empresa dever aguardar um tempo mnimo de uma hora para efetuar uma nova solicitao de
distribuio caso receba a indicao que no 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), ento no existem mais documentos a serem pesquisados no momento.
Pg. 8 / 15
Nota Fiscal Eletrnica Nota Tcnica 2014/002
Considerando que o Ambiente Nacional gera NSU sem lacunas, o processo de distribuio de conjunto
de DF-e a partir do NSU informado (tag:distNSU) disponibiliza para o interessado uma sequncia de
numerao ordenada de forma ascendente. A identificao de alguma lacuna na base de dados do
interessado indica que houve alguma falha no processo de distribuio dos documentos.
Neste caso, o interessado deve consultar pontualmente os NSU identificados como faltantes em sua
base de dados atravs do mtodo nfeDistDFeInteresse do Web Service NFeDistribuicaoDFe
informando o NSU desejado no contedo da tag consNSU no XML de requisio.
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 vlida, existir no
Ambiente Nacional e estar vinculada ao interessado como destinatrio, transportador ou terceiro.
Caso a consulta seja realizada pelo destinatrio o Ambiente Nacional ir verificar a existncia de sua
manifestao (Cincia da Operao, Operao no Realizada ou Confirmao de Operao). Em
caso da existncia da manifestao do destinatrio a NF-e ser retornada para o destinatrio. Caso
contrrio, ser retornado apenas o resumo da NF-e. Com o resumo o destinatrio ter as informaes
necessrias para realizar a manifestao.
Para transportador e terceiros a NF-e estar disponvel integralmente na consulta. Para o emitente a
NF-e no ser disponibilizada nesta consulta.
Assim como nas demais consultas disponibilizadas pelo Web Service NFeDistribuicaoDFe, a consulta
por chave de acesso estar disponvel para documentos recebidos pelo Ambiente Nacional nos ltimos
90 dias. Aps este perodo no ser possvel recuperar a NF-e.
Pg. 9 / 15
Nota Fiscal Eletrnica Nota Tcnica 2014/002
As validaes de A01, A02, A03, A04 e A05 so realizadas pelo protocolo SSL e no precisam ser
implementadas. A validao A06 tambm pode ser realizada pelo protocolo SSL, mas pode falhar se
existirem outros certificados digitais de Autoridade Certificadora Raiz que no sejam ICP-Brasil no
repositrio de certificados digitais do servidor de Web Service do rgo da consulta.
A mensagem ser descartada se o tamanho exceder o limite previsto (10 KB). A aplicao do Ambiente
Nacional no poder permitir a recepo de mensagem com tamanho superior a 10 KB. Caso isto ocorra,
a conexo poder ser interrompida sem retorno da mensagem de erro se o controle do tamanho da
mensagem for implementado por configuraes do ambiente de rede (ex.: controle no firewall). No
caso do controle de tamanho ser implementado por aplicativo poder ocorrer a devoluo da
mensagem de erro 214.
Caso o Web Service fique disponvel em ocasio que o servio estiver paralisado, devero ser
implementadas as verificaes 108 e 109. Estas validaes podero ser dispensadas se o Web Service
no ficar disponvel quando o servio estiver paralisado.
Pg. 10 / 15
Nota Fiscal Eletrnica Nota Tcnica 2014/002
Para possibilitar o compartilhamento de informaes relevantes para o ator de forma a manter o sigilo
da informao, foram criados dois novos leiautes contendo informaes resumidas das NF-e e
informaes resumidas dos eventos.
Descrio: Estrutura XML gerada pelo Ambiente Nacional com o conjunto de informaes resumidas
da NF-e. Este documento ser distribudo para os destinatrios possibilitando sua manifestao na
operao acobertada pela Nota Fiscal eletrnica emitida para o seu CNPJ.
Schema XML: resNFe_v9.99.xsd
Pg. 11 / 15
Nota Fiscal Eletrnica Nota Tcnica 2014/002
Descrio: Estrutura XML gerada pelo Ambiente Nacional com o conjunto de informaes resumidas
de um evento de NF-e.
Schema XML: resEvento_v9.99.xsd
Pg. 12 / 15
Nota Fiscal Eletrnica Nota Tcnica 2014/002
1 2 3
NF-e Resumo NF-e NSU 1
Gera NSU para o
Consulta
Emite NF-e destinatrio com o
NFeDistribuicaoDFe
resumo da NF-e
7 5 4
Evento Destinatrio NSU 1 Evento Destinatrio
Gera NSU para o Gera evento de
Consulta
emitente com o evento destinatrio (Ex.
NFeDistribuicaoDFe
do destinatrio Manifestao)
6 8
NF-e NSU 2
Gera NSU para o Consulta
destinatrio com a NF-e NFeDistribuicaoDFe
9 10 11
Evento Emitente Evento Emitente NSU 3
Gera NSU para o
Consulta
Gerar evento de emitente destinatrio com o
NFeDistribuicaoDFe
evento do emitente
13 12 13
Evento Fisco NSU 2 Evento Fisco NSU 4
Evento do fisco gera
Consulta Consulta
NSU para emitente e
NFeDistribuicaoDFe NFeDistribuicaoDFe
destinatrio
A consulta no Web Service NFeDistribuicaoDFe poder ser realizada a qualquer instante pela empresa
ou pessoa fsica. 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 destinatrio do resumo da NF-e e o disponibiliza para
consulta;
Pg. 13 / 15
Nota Fiscal Eletrnica Nota Tcnica 2014/002
Este novo modelo permitir ao emitente a consulta dos eventos manifestados pelos destinatrios de
suas NF-e. Tambm ser disponibilizado para o destinatrio da NF-e qualquer evento gerado pelo
emitente. Alm disso, os eventos gerados pelo fisco sero disponibilizados tanto para o emitente quanto
para o destinatrio da NF-e.
O modelo simplifica o processo de download da NF-e uma vez que a partir da manifestao do
destinatrio o Ambiente Nacional gera automaticamente um NSU referenciando a NF-e e permitindo sua
recuperao a partir do WS NFeDistribuicaoDFe.
A anlise do comportamento atual das aplicaes das empresas (aplicao cliente) permite identificar
algumas situaes de uso indevido nos ambientes autorizadores.
Como exemplo maior do mau uso do ambiente, ressalta-se a falta de controle de algumas aplicaes
que entram em loop, consumindo recursos de forma indevida, sobrecarregando principalmente o canal
de comunicao com a Internet.
Para este Web Service sero mantidos controles para identificar as situaes de uso indevido de
sucessivas tentativas de busca de registros j disponibilizados anteriormente.
O endereo do Web Service de Distribuio do Ambiente Nacional est publicado no Portal da NF-e
(http://www.nfe.fazenda.gov.br/portal), no link Servios / Relao de Servios Web.
Pg. 14 / 15
Nota Fiscal Eletrnica Nota Tcnica 2014/002
Pg. 15 / 15