Nota T?cnica n? 2 DE 01/08/2014
Norma Federal - Publicado no DO em 01 ago 2014
Web Service de Distribui??o de DF-e de Interesse dos Atores da NF-e (PF ou PJ)
1. Resumo
Um dos grandes desafios do projeto Nota Fiscal Eletr?nica ? prover para os atores envolvidos nos
processos da NF-e informa??es de seu interesse de forma eficiente e confi?vel.
O Web Service de Consulta da Rela??o de Documentos Destinados (NfeConsultaDest) prov? informa??es necess?rias para a manifesta??o do destinat?rio da NF-e. Al?m de prover informa??es
para possibilitar a manifesta??o do destinat?rio, surgem novas necessidades de interesse de outros
atores para as quais ainda n?o existe um servi?o dispon?vel.
Esta nota t?cnica tem como objetivo a apresenta??o de um novo Web Service denominado NFeDistribuicaoDFe que disponibilizar? para os atores da NF-e informa??es e documentos
fiscais eletr?nicos de seu interesse. A distribui??o ser? realizada para emitentes, destinat?rios,
transportadores e terceiros informados no conte?do da NF-e respectivamente no grupo do
Emitente (tag:emit, id:C01), no grupo do Destinat?rio (tag:dest, id:E01), no grupo do Transportador
(tag:transporta, id:X03) e no grupo de pessoas autorizadas a acessar o XML (tag:autXML, id:GA01).
Este Web Service possibilitar? a descontinuidade, no futuro, do Web Service de Consulta da Rela??o de Documentos Destinados (NfeConsultaDest).
Prazos para entrada em vig?ncia da Nota T?cnica:
• Ambiente de Homologa??o (ambiente de testes das empresas): 15/09/2014;
• Ambiente de Produ??o: 06/10/2014;
• Desativa??o do Web Service NfeConsultaDest: 02/02/15.
2. Web Service – NFeDistribuicaoDFe
Fun??o: Servi?o destinado ? distribui??o de informa??es resumidas e documentos fiscais eletr?nicos de interesse de um ator, seja este pessoa f?sica ou jur?dica.
Processo: s?ncrono
M?todo: nfeDistDFeInteresse
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 tabela abaixo:
Documento | Emitente | Destinat?rio1 | Transportador2 | Terceiros3 |
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 |
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 |
1Os 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. Antes da manifesta??o do destinat?rio fica dispon?vel unicamente a estrutura XML de “Resumo de NF-e”.
2 A NF-e estar? dispon?vel somente para o transportador identificado no grupo X03.
3 A NF-e estar? dispon?vel para terceiros somente cujo CNPJ ou CPF estiver informado na tag autXML.
2.1. Leiaute Mensagem de Entrada
Entrada: Estrutura XML com o pedido de distribui??o de DF-e de interesse do ator
Schema XML: distDFeInt_v9.99.xsd
# | Campo | Ele | Pai | Tipo | Ocor. | Tam. | Descri??o/Observa??o |
A01 | distDFeInt | Raiz | - | - | - | - | TAG raiz |
A02 | versao | A | A01 | N | 1-1 | 2v2 | Vers?o do leiaute |
A03 | tpAmb | E | A01 | N | 1-1 | 1 | Identifica??o do Ambiente: 1=Produ??o /2=Homologa??o |
A04 | cUFAutor | E | A01 | N | 1-1 | 2 | C?digo da UF do Autor |
A05 | CNPJ | CE | A01 | N | 1-1 | 14 | CNPJ do interessado no DF-e |
A06 | CPF | CE | A01 | N | 1-1 | 11 | CPF do interessado no DF-e |
A07 | distNSU | CG | A01 | - | 1-1 | - | Grupo para distribuir DF-e de interesse |
A08 | ultNSU | E | A07 | N | 1-1 | 1-15 | ?ltimo NSU recebido pelo ator. Caso seja informado com zero, ou com um NSU muito antigo, a consulta retornar? unicamente as informa??es resumidas e documentos fiscais eletr?nicos que tenham sido recepcionados pelo Ambiente Nacional nos ?ltimos 3 meses. |
A09 | consNSU | CG | A1 | - | 1-1 | - | Grupo para consultar um DF-e a partir de um NSU espec?fico |
A10 | NSU | E | A09 | N | 1-1 | 1-15 |
N?mero Sequencial ?nico. Geralmente esta consulta ser? utilizada quando identificado pelo interessado um NSU faltante. O Web Service retornar? o documento ou informar? que o NSU n?o existe no Ambiente Nacional. Assim, esta consulta fechar? a lacuna do NSU identificado como faltante. |
2.2. Leiaute Mensagem de Retorno
Retorno: Estrutura XML com os documentos de interesse do ator (qtde m?xima=50).
Schema XML: retDistDFeInt _v9.99.xsd
# | Campo | Ele | Pai | Tipo | Ocor. | Tam. | Descri??o/Observa??o |
B01 | retDistDFeInt | Raiz | - | - | - | - | TAG raiz da Resposta |
B02 | versao | A | B01 | N | 1-1 | 2v2 | Vers?o do leiaute |
B03 | tpAmb | E | B01 | N | 1-1 | 1 | Identifica??o do Ambiente: 1=Produ??o /2=Homologa??o |
B04 | verAplic | E | B01 | C | 1-1 | 1-20 | Vers?o do aplicativo que processou a consulta |
B05 | cStat | E | B01 | N | 1-1 | 3 | C?digo do status da resposta (vide item 5) |
B06 | xMotivo | E | B01 | C | 1-1 | 1-255 | Descri??o literal do status da resposta |
B07 | dhResp | E | B01 | D | 1-1 | ? | Data e hora da mensagem de Resposta |
B08 | ultNSU | E | B01 | N | 0-1 | 1-15 | ?ltimo NSU pesquisado no Ambiente Nacional. Se for o caso, o solicitante pode continuar a consulta a partir deste NSU para obter novos resultados. |
B09 | maxNSU | E | B01 | N | 0-1 | 1-15 | Maior NSU existente no Ambiente Nacional para o CNPJ/CPF informado |
B10 | loteDistDFeInt | G | B01 | B64 | 0-1 | ? | Conjunto de informa??es resumidas e documentos fiscais eletr?nicos de interesse da pessoa ou empresa. |
B11 | docZip | G | B10 | ? | 1-50 | ? |
Informa??o resumida ou documento fiscal eletr?nico de interesse da pessoa ou empresa. O conte?do desta tag estar? compactado no padr?o gZip. O tipo do campo ? base64Binary. |
B12 | NSU | A | B11 | B11 | 1-1 | 1-15 | NSU do documento fiscal |
B13 | schema | A | B11 | B11 | 1-1 | ? |
Identifica??o do Schema XML que ser? utilizado para validar o XML existente no campo seguinte. Vai identificar o tipo do documento e sua vers?o. Exemplos: - resNFe_v1.00.xsd - procNFe_v3.10.xsd - resEvento_1.00.xsd - procEventoNFe_v1.00.xsd |
2.3. Mensagem de Retorno Compactada
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.
2.4. Descri??o do Processo de Distribui??o de DF-e de Interesse
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
de PF com seu CPF ou PJ com 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.
a) Gera??o do pedido de distribui??o
O XML do pedido de distribui??o suporta dois tipos de consultas que s?o definidas de acordo com a
tag informada no XML. As tags s?o distNSU e consNSU.
a.1) distNSU – Distribui??o de Conjunto de DF-e a Partir do NSU Informado
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.
a.2) consNSU – Distribui??o de DF-e Vinculado ao NSU Informado
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.
b) CNPJ ou CPF do interessado no DF-e Informar o CPF da pessoa 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.
c) Envio das informa??es
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.
2.5. Processamento da Requisi??o de Distribui??o de Conjunto de DF-e a Partir do NSU Informado (distNSU)
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 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 localizado”.
A empresa dever? aguardar um tempo m?nimo de uma hora para efetuar uma nova solicita??o
distribui??o caso receba a indica??o que n?o existem mais documentos a serem pesquisados
base de dados do Ambiente Nacional. Se o NSU informado (tag:ultNSU) for igual ao maior NSU Ambiente Nacional (tag:maxNSU), ent?o n?o existem mais documentos a serem pesquisados no
momento.
2.6. Processamento da Requisi??o de Distribui??o de DF-e Vinculado ao NSU
Informado (consNSU)
Considerando que o Ambiente Nacional gera NSU sem lacunas, o processo de d istribui??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 do documento fiscal encontrado – cStat=”138-
Documento localizado”.
2.7. Valida??o do Certificado de Transmiss?o
As valida??es de A01, A02, A03, A04 e A05 s?o realizadas pelo protocolo SSL e n?o precisam ser
implementadas. A valida??o A06 tamb?m pode ser realizada pelo protocolo SSL, mas pode falhar se existirem outros certificados digitais de Autoridade Certificadora Raiz que n?o sejam “ICP-Brasil” no reposit?rio de certificados digitais do servidor de Web Service do ?rg?o da consulta.
2.8. Valida??o Inicial da Mensagem no Web Service
A mensagem ser? descartada se o tamanho exceder o limite previsto (10 KB). A aplica??o do
Ambiente Nacional n?o poder? permitir a recep??o de mensagem com tamanho superior a 10 KB.
Caso isto ocorra, a conex?o poder? ser interrompida sem retorno da mensagem de erro se o controle do tamanho da mensagem for implementado por configura??es do ambiente de rede (ex.: controle no firewall). No caso do controle de tamanho ser implementado por aplicativo poder? ocorrer adevolu??o da mensagem de erro 214.
Caso o Web Service fique dispon?vel em ocasi?o que o servi?o estiver paralisado, dever?o ser
implementadas as verifica??es 108 e 109. Estas valida??es poder?o ser dispensadas se o Web
Service n?o ficar dispon?vel quando o servi?o estiver paralisado.
2.9. Valida??o da ?rea de Dados
a) Valida??o de forma da ?rea de dados
Valida??o da ?rea de dados da mensagem | ||||
# | Regra de Valida??o | Aplic. | Msg | Efeito |
D01 | Verifica Schema XML da ?rea de Dados | Obrig. | 215 | Rej. |
D02 | Verifica o uso de prefixo no namespace | Obrig | 404 | Rej. |
D03 | XML utiliza codifica??o diferente de UTF-8 | Obrig. | 402 | Rej. |
D04 | Vers?o dos Dados informada ? superior ? vers?o vigente | Facult. | 238 | Rej. |
D05 | Vers?o dos Dados n?o suportada | Obrig. | 239 | Rej. |
b) Valida??o de regras de neg?cio
Valida??o da ?rea de dados da mensagem | ||||
# | Regra de Valida??o | Aplic. | Msg | Efeito |
H01 | Tipo do ambiente da NF-e difere do ambiente do Web Service | Obrig. | 252 | Rej. |
H02 | CNPJ do interessado na distribui??o inv?lido (DV ou zeros) | Obrig. | 489 | Rej. |
H03 | CPF do interessado na distribui??o inv?lido (DV ou zeros) | Obrig. | 490 | Rej. |
H04 | CNPJ do Certificado Digital utilizado na transmiss?o n?o tem o mesmo CNPJbase do CNPJ consultado | Obrig. | 593 | Rej. |
H05 | CPF do Certificado Digital utilizado na transmiss?o diferente do CPF consultado | Obrig. | 472 | Rej. |
H06 | N?mero do NSU informado superior ao maior NSU dispon?vel para consulta | Obrig. | 589 | Rej. |
2.10. Leiautes Resumidos
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.
2.10.1. Leiaute Resumo da NF-e
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_v9.99.xsd
2.10.2. Leiaute Resumo do Evento de NF-e
Descri??o: Estrutura XML gerada pelo Ambiente Nacional com o conjunto de informa??es resumidas
de um evento de NF-e.
Schema XML: resEvento_v9.99.xsd
2.11. 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. O fluxo 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. 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.
2.12. Recomenda??es Para Evitar o Uso Indevido
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”.
2.13. Endere?o do Web Service
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”.
Idem para o ambiente de homologa??o, no Portal de Homologa??o (http://hom.nfe.fazenda.gov.br/
portal)
3. Tabela de c?digos de erros e descri??es de mensagens de erros
OBS.:
1. Recomendado a n?o utiliza??o de caracteres especiais ou acentua??o nos textos das mensagens
de erro.
2. Recomendado que o campo xMotivo da mensagem de erro para o c?digo 999 seja informado com
a mensagem de erro do aplicativo ou do sistema que gerou a exce??o n?o prevista.