Professional Documents
Culture Documents
NT 2015/002
Verso 1.00b
Maro 2016 *
* Alterao conforme determinao do ENCAT Retirada das chaves de acesso de NF-e, CT-e e
MDF-e do XML retornado pelo servio
Manifesto Eletrnico de Documentos Fiscais
NT 2015/002
ndice
1. Resumo ................................................................................................................................. 3
2. Arquitetura de Comunicao com Contribuinte........................................................................... 4
1.1.1. Padro de documento XML ..................................................................................................4
1.1.2. Padro de Comunicao ........................................................................................................5
1.1.3. Padro de Certificado Digital ................................................................................................6
1.1.4. Padro de compactao .........................................................................................................6
1.1.5. Padro de mensagens dos Web Services...............................................................................6
1.1.6. Informaes de controle e rea de dados das mensagens .....................................................7
1.1.7. Validao da estrutura XML das Mensagens dos Web Services ..........................................7
Resumo dos Padres Tcnicos ..........................................................................................................7
1.1.8. Resumo dos Padres Tcnicos ..............................................................................................8
3. Web Service MDFeDistribuicaoDFe ....................................................................................... 9
3.1. Leiaute Mensagem de Entrada ................................................................................................ 10
3.2. Leiaute Mensagem de Retorno................................................................................................ 10
3.3. Mensagem de Retorno Compactada......................................................................................... 12
3.4. Descrio do Processo de Distribuio de DF-e de Interesse....................................................... 12
3.5. Processamento da Requisio de Distribuio de Conjunto de DF-e a Partir do NSU Informado
(distNSU) ........................................................................................................................................... 13
3.6. Processamento da Requisio de Distribuio de DF-e Vinculado ao NSU Informado (consNSU) .. 14
3.7. Validao do Certificado de Transmisso................................................................................. 14
3.8. Validao Inicial da Mensagem no Web Service ....................................................................... 14
3.9. Validao das informaes de controle da chamada ao Web Service ........................................... 15
3.10. Validao da rea de Dados................................................................................................... 15
3.11. Recomendaes Para Evitar o Uso Indevido ............................................................................. 16
3.12. Endereo do Web Service ....................................................................................................... 16
4. Tabela de cdigos de erros e descries de mensagens de erros .................................................. 17
Pg. 2 / 17
Manifesto Eletrnico de Documentos Fiscais
NT 2015/002
1. Resumo
Um dos grandes desafios dos projetos de Documentos Fiscais Eletrnicos prover para os atores
envolvidos nos processos informaes de seu interesse de forma eficiente e confivel.
Esta nota tcnica tem como objetivo a apresentao de um novo Web Service denominado
MDFeDistribuicaoDFe que disponibilizar para os atores do MDF-e informaes e documentos
fiscais eletrnicos de seu interesse. A distribuio ser realizada terceiros informados no contedo
do MDF-e no grupo de pessoas autorizadas a acessar o XML (tag:autXML) e para os proprietrios de
veculo quando o RNTRC do proprietrio for diferente do RNTRC do emitente do MDF-e.
Visando a preservao do sigilo fiscal dos documentos fiscais eletrnicos relacionados no MDF-e no
grupo de documentos originrios (infDoc), este webservice dever manipular o XML retornado
alterando as chaves de acesso de CT-e, NF-e e MDF-e pelo literal
99999999999999999999999999999999999999999999 conforme deciso do ENCAT.
Pg. 3 / 17
Manifesto Eletrnico de Documentos Fiscais
NT 2015/002
a) Padro de Codificao
A especificao do documento XML adotada a recomendao W3C para XML 1.0, disponvel em
www.w3.org/TR/REC-xml e a codificao dos caracteres ser em UTF-8, assim todos os documentos
XML sero iniciados com a seguinte declarao:
OBS1: Lembrando que cada arquivo XML somente poder ter uma nica declarao <?xml
version="1.0" encoding="UTF-8"?>.
b) Declarao namespace
O documento XML dever ter uma nica declarao de namespace no elemento raiz do documento
com o seguinte padro:
c) Prefixo de namespace
d) Validao de Schema
Para garantir minimamente a integridade das informaes prestadas e a correta formao dos
arquivos XML, o contribuinte dever submeter a mensagem XML para validao pelo Schema (XSD
XML Schema Definition), disponibilizado pelo Ambiente Autorizador, antes de seu envio.
Pg. 4 / 17
Manifesto Eletrnico de Documentos Fiscais
NT 2015/002
O meio fsico de comunicao utilizado ser a Internet, com o uso do protocolo SSL verso 3.0, com
autenticao mtua, que alm de garantir um duto de comunicao seguro na Internet, permite a
identificao do servidor e do cliente atravs de certificados digitais, eliminando a necessidade de
identificao do usurio atravs de nome ou cdigo de usurio e senha.
O modelo de comunicao segue o padro de Web Services definido pelo WS-I Basic Profile.
A chamada do Web Service distDFeInt realizada com o envio de uma mensagem XML atravs do
campo mdfeDadosMsg.
Pg. 5 / 17
Manifesto Eletrnico de Documentos Fiscais
NT 2015/002
O certificado digital utilizado no Projeto do MDF-e ser emitido por Autoridade Certificadora
credenciada pela Infraestrutura de Chaves Pblicas Brasileira ICP-Brasil, tipo A1 ou A3, devendo
conter o CNPJ da pessoa jurdica titular do certificado digital no campo otherName OID
=2.16.76.1.3.3.
O certificado digital ser exigido durante a transmisso das mensagens entre o servidor do
contribuinte e o Ambiente Autorizador e dever conter o CNPJ ou CPF do responsvel pela
transmisso das mensagens, devendo ter a extenso Extended Key Usage com permisso de
"Autenticao Cliente".
O padro de compactao adotado para o projeto ser o Gzip (GNU zip) que implementado nas
plataformas Java e .NET framework 2.0 (classe System.IO.Compression.GZipStream).
Regio Norte Regio Nordeste Regio Sudeste Regio Sul Regio Centro-
Oeste
11-Rondnia 21-Maranho 31-Minas Gerais 41-Paran 50-Mato Grosso do
12-Acre 22-Piau 32-Esprito Santo 42-Santa Catarina Sul
13-Amazonas 23-Cear 33-Rio de Janeiro 43-Rio Grande do Sul 51-Mato Grosso
14-Roraima 24-Rio Grande do Norte 35-So Paulo 52-Gois
15-Par 25-Paraba 53-Distrito Federal
16-Amap 26-Pernambuco
17-Tocantins 27-Alagoas
28-Sergipe
29-Bahia
Pg. 6 / 17
Manifesto Eletrnico de Documentos Fiscais
NT 2015/002
<soap12:Header>
<mdfeCabecMsg xmlns="http://www.portalfiscal.inf.br/mdfe/wsdl/MdfeRecepcao">
<cUF>string</cUF>
<versaoDados>string</versaoDados>
</mdfeCabecMsg>
</soap12:Header>
A informao armazenada na rea de dados um documento XML que deve atender o leiaute
definido na documentao do Web Service acessado:
<soap12:Body>
<mdfeDadosMsg
xmlns="http://www.portalfiscal.inf.br/mdfe/wsdl/MDFeDistribuicaoDFe">xml</mdfeDadosMsg>
</soap12:Body>
Um Schema XML uma linguagem que define o contedo do documento XML, descrevendo os seus
elementos e a sua organizao, alm de estabelecer regras de preenchimento de contedo e de
obrigatoriedade de cada elemento ou grupo de informao.
A validao da estrutura XML da mensagem realizada por um analisador sinttico (parser) que
verifica se a mensagem atende as definies e regras de seu Schema XML.
Qualquer divergncia da estrutura XML da mensagem em relao ao seu Schema XML provoca um
erro de validao do Schema XML.
A primeira condio para que a mensagem seja validada com sucesso que ela seja submetida ao
Schema XML correto.
Assim, o aplicativo do contribuinte deve estar preparado para gerar as mensagens no leiaute em
vigor, devendo ainda informar a verso do leiaute da estrutura XML da mensagem no campo
versaoDados do elemento mdfeCabecMsg do SOAP Header.
<soap12:Header>
<mdfeCabecMsg xmlns="http://www.portalfiscal.inf.br/mdfe/wsdl/mdfeDistribuicaoDFe">
<cUF>35</cUF>
<versaoDados>1.00</versaoDados>
</mdfeCabecMsg>
</soap12:Header>
Pg. 7 / 17
Manifesto Eletrnico de Documentos Fiscais
NT 2015/002
Caracterstica Descrio
Web Services Padro definido pelo WS-I Basic Profile 1.1 (http://www.ws-
i.org/Profiles/BasicProfile-1.1-2004-08-24.html).
Meio lgico de comunicao Web Services, disponibilizados pelo Portal do Ambiente Autorizador.
Meio fsico de comunicao Internet
Protocolo Internet SSL verso 3.0, com autenticao mtua atravs de certificados digitais.
Padro de troca de mensagens SOAP verso 1.2.
Padro da mensagem XML no padro Style/Encoding: Document/Literal.
Padro de certificado digital X.509 verso 3, emitido por Autoridade Certificadora credenciada pela
Infra-estrutura de Chaves Pblicas Brasileira ICP-Brasil, do tipo A1 ou
A3, devendo conter o CNPJ ou CPF do proprietrio do certificado digital.
Padro de compactao Gzip (GNU zip)
Pg. 8 / 17
Manifesto Eletrnico de Documentos Fiscais
NT 2015/002
Web Service
MDFeDistribuicaoDFe
Consulta DF-e de interesse Req. Distribui
mdfeDistDFeInteresse
documentos
Ret.
Cliente
Aplicao MDF-e
Retorno
Processo: sncrono
Mtodo: mdfeDistDFeInteresse
Este servio permite que um ator do MDF-e tenha acesso aos documentos fiscais eletrnicos (DF-e)
que no tenham sido gerados por ele e que sejam de seu interesse. Pode ser consumido por
qualquer ator de MDF-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 estaro disponveis para distribuio por at 3 meses aps sua
recepo pelo Ambiente Nacional do MDF-e. Os documentos que sero disponibilizados para
terceiros (informado na tag autXML) seguem a tabela abaixo:
Documento
MDF-e
Evento de Cancelamento
Evento de Encerramento
Evento de Incluso de Condutor
Visando a preservao do sigilo fiscal dos documentos fiscais eletrnicos relacionados no MDF-e no
grupo de documentos originrios (infDoc), este webservice dever manipular o XML retornado
alterando as chaves de acesso de CT-e, NF-e e MDF-e pelo literal
99999999999999999999999999999999999999999999 conforme deciso do ENCAT.
Pg. 9 / 17
Manifesto Eletrnico de Documentos Fiscais
NT 2015/002
Pg. 10 / 17
Manifesto Eletrnico de Documentos Fiscais
NT 2015/002
Pg. 11 / 17
Manifesto Eletrnico de Documentos Fiscais
NT 2015/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 relacionados como autorizados ao XML e por
proprietrios de veculos utilizados em MDF-e quando o RNTRC do proprietrio for diferente do
RNTRC do emitente do manifesto, 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 dois tipos de consultas que so definidas de acordo com a
tag informada no XML. As tags so distNSU e consNSU.
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.
Informar o CPF da pessoa 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.
Pg. 12 / 17
Manifesto Eletrnico de Documentos Fiscais
NT 2015/002
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 dos
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 realizada atravs de um processo
assncrono na aplicao da SVRS, a empresa ou pessoa conseguir recuperar todos os documentos
de seu interesse to logo estes sejam processados para distribuio pelo Ambiente Nacional do
MDF-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. 13 / 17
Manifesto Eletrnico de Documentos Fiscais
NT 2015/002
Neste caso, o interessado deve consultar pontualmente os NSU identificados como faltantes em sua
base de dados atravs do mtodo mdfeDistDFeInteresse do Web Service MDFeDistribuicaoDFe
informando o NSU desejado no contedo da tag consNSU no XML de requisio.
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.
Pg. 14 / 17
Manifesto Eletrnico de Documentos Fiscais
NT 2015/002
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. 15 / 17
Manifesto Eletrnico de Documentos Fiscais
NT 2015/002
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 do MDF-
e (http://mdfe-portal.sefaz.rs.gov.br), no link Servios / Relao de Servios Web.
Produo:
https://mdfe.svrs.rs.gov.br/WS/MDFeDistribuicaoDFe/MDFeDistribuicaoDFe.asmx
Homologao:
https://mdfe-homologacao.svrs.rs.gov.br/WS/MDFeDistribuicaoDFe/MDFeDistribuicaoDFe.asmx
Pg. 16 / 17
Manifesto Eletrnico de Documentos Fiscais
NT 2015/002
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. 17 / 17