NT2014.002 v1.01 WS Distribuicao DFE
NT2014.002 v1.01 WS Distribuicao DFE
NT2014.002 v1.01 WS Distribuicao DFE
Verso 1.01
Agosto 2014
ndice
1.
Resumo
2.
Web Service NFeDistribuicaoDFe
2.1.
Leiaute Mensagem de Entrada
2.2.
Leiaute Mensagem de Retorno
2.3.
Mensagem de Retorno Compactada
2.4.
Descrio do Processo de Distribuio de DF-e de Interesse
2.5.
Processamento da Requisio de Distribuio de Conjunto de DF-e a Partir do NSU Informado (distNSU)
2.6.
Processamento da Requisio de Distribuio de DF-e Vinculado ao NSU Informado (consNSU)
2.7.
Validao do Certificado de Transmisso
2.8.
Validao Inicial da Mensagem no Web Service
2.9.
Validao da rea de Dados
2.10.
Leiautes Resumidos
2.10.1.
Leiaute Resumo da NF-e
2.10.2.
Leiaute Resumo do Evento de NF-e
2.11.
Viso Geral do Modelo de Distribuio
2.12.
Recomendaes Para Evitar o Uso Indevido
2.13.
Endereo do Web Service
3.
Tabela de cdigos de erros e descries de mensagens de erros
Pg. 2 / 13
3
4
5
5
6
6
7
7
8
8
9
9
9
10
10
12
12
13
1. 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.
O Web Service de Consulta da Relao de Documentos Destinados (NfeConsultaDest) prov
informaes necessrias para a manifestao do destinatrio da NF-e. Alm de prover informaes
para possibilitar a manifestao do destinatrio, surgem novas necessidades de interesse de outros
atores para as quais ainda no existe um servio disponvel.
Esta nota tcnica tem como objetivo a apresentao de um novo Web Service denominado
NFeDistribuicaoDFe que disponibilizar para os atores da NF-e informaes e documentos
fiscais eletrnicos de seu interesse. A distribuio ser 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 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).
Prazos para entrada em vigncia da Nota Tcnica:
Ambiente de Homologao (ambiente de testes das empresas): 15/09/2014;
Ambiente de Produo: 06/10/2014;
Desativao do Web Service NfeConsultaDest: 02/02/15.
Pg. 3 / 13
Destinatrio1
Transportador2
Terceiros3
NF-e
No
Sim
Sim
Sim
Evento de Cancelamento
No
Sim
Sim
Sim
No
Sim
Sim
Sim
Sim
No
No
Sim
Sim
Sim
No
Sim
EPEC
No
Sim
Sim
No
Resumo de NF-e
No
Sim
No
No
Sim
Sim
Sim
Sim
Sim
Sim
Sim
Sim
Documento
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. Antes da manifestao do
destinatrio fica disponvel unicamente a estrutura XML de Resumo 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. 4 / 13
Campo
distDFeInt
versao
tpAmb
cUFAutor
CNPJ
CPF
distNSU
ultNSU
A09 consNSU
A10 NSU
Ele
A
E
E
CE
CE
CG
E
Pai
A01
A01
A01
A01
A01
A01
A07
CG
E
A1
A09
Raiz
1-1
1-1
Descrio/Observao
TAG raiz
Verso do leiaute
Identificao do Ambiente: 1=Produo /2=Homologao
Cdigo da UF do Autor
CNPJ do interessado no DF-e
CPF do interessado no DF-e
Grupo para distribuir DF-e de interesse
ltimo NSU recebido pelo ator.
Caso seja informado com zero, ou com um NSU muito antigo,
a consulta retornar unicamente as informaes resumidas e
documentos fiscais eletrnicos que tenham sido recepcionados
pelo Ambiente Nacional nos ltimos 3 meses.
Grupo para consultar um DF-e a partir de um NSU especfico
1-15 Nmero 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
no existe no Ambiente Nacional. Assim, esta consulta fechar a
lacuna do NSU identificado como faltante.
Campo
retDistDFeInt
versao
tpAmb
verAplic
cStat
xMotivo
dhResp
ultNSU
Ele
A
E
E
E
E
E
E
Pai
B01
B01
B01
B01
B01
B01
B01
B09 maxNSU
B01
B10 loteDistDFeInt
B01
B11 docZip
B10
B12 NSU
B13 schema
A
A
B11
B11
Raiz
Pg. 5 / 13
Pg. 6 / 13
de
na
do
no
Msg
280
Efeito
Rej.
281
283
Rej.
Rej.
286
Rej.
284
285
473
Rej.
Rej.
Rej.
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.
#
B01
B02
B03
Aplic.
Obrig.
Obrig.
Obrig.
Msg
214
108
109
Efeito
Rej.
Rej.
Rej.
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
Pg. 8 / 13
Aplic.
Obrig.
Obrig.
Obrig.
Facult.
Obrig.
Msg Efeito
215
Rej.
404
Rej.
402
Rej.
238
Rej.
239
Rej.
472
589
Rej.
Rej.
A
E
CE
CE
E
E
C01
C01
C01
C01
C01
C01
N
N
N
N
C
C
1-1
1-1
1-1
1-1
1-1
1-1
2v2
44
14
11
3-60
0 ou
2-14
C08 dhEmi
C01
1-1
C09 tpNF
C10 vNF
C11 digVal
E
E
E
C01
C01
C01
N
N
C
1-1
1-1
1-1
C02
C03
C04
C05
C06
C07
versao
chNFe
CNPJ
CPF
xNome
IE
1
13,2
28
Pg. 9 / 13
E
E
E
C01
C01
C01
D
N
N
1-1
1-1
1-1
15
1
CNPJ
CPF
chNFe
dhEvento
D08
D09
D10
D11
D12
tpEvento
nSeqEvento
xEvento
dhRecbto
nProt
Ele
Raiz
A
E
Pai
D01
D01
CE
CE
E
E
C01
C01
D01
D01
E
E
E
E
E
D01
D01
D01
D01
D01
Pg. 10 / 13
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 destinatrio do resumo da NF-e e o disponibiliza
para consulta;
3. O destinatrio consulta o WS NFeDistribuicaoDFe a partir do ltimo NSU recebido e recupera
o resumo da NF-e;
4. O destinatrio, de posse do resumo da NF-e, gera um evento de NF-e (Ex. evento de
manifestao do destinatrio);
5. O Ambiente Nacional gera um NSU do evento gerado pelo destinatrio para o emitente e o
disponibiliza para consulta;
6. Caso seja um evento de manifestao do destinatrio diferente do tipo desconhecimento da
operao, o Ambiente Nacional gera um NSU para o destinatrio com a NF-e (liberao do
download);
7. O emitente consulta o WS NFeDistribuicaoDFe a partir do ltimo NSU recebido e recupera o
evento gerado pelo destinatrio;
8. O destinatrio 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 no
exista outro evento que impea este cancelamento) que ser compartilhado pela Sefaz com o
Ambiente Nacional;
10. O Ambiente Nacional gera um NSU para o destinatrio do evento gerado pelo emitente e o
disponibiliza para consulta;
11. O destinatrio 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 destinatrio, disponibilizando-os para consulta;
13. Tanto o emitente quanto o destinatrio 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 destinatrio:
NSU Emitente
Documento
Evento do Destinatrio
Evento do Fisco
NSU Destinatrio
Documento
Resumo da NF-e
NF-e
Evento do Emitente
Evento do Fisco
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.
Pg. 11 / 13
Pg. 12 / 13
OBS.:
1. Recomendado a no utilizao de caracteres especiais ou acentuao nos textos das mensagens
de erro.
2. Recomendado que o campo xMotivo da mensagem de erro para o cdigo 999 seja informado com
a mensagem de erro do aplicativo ou do sistema que gerou a exceo no prevista.
Pg. 13 / 13