Nota Técnica 2015.002 - WS Distribuição Interessados - 1.03

Projeto Manifesto Eletrônico de Documentos Fiscais Nota Técnica 2015.002 Serviço de distribuição de DF-e de interesse dos atores do MDF-e Versão 1.03 - Abril 2022 Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 2 / 21 Sumário Controle de Versões ......................................................................................................................... 3 Histórico de Alterações / Cronograma .............................................................................................. 4 1 Resumo ..................................................................................................................................... 5 2 Arquitetura de Comunicação com o Contribuinte ....................................................................... 6 2.1 Padrões Técnicos ............................................................................................................... 6 2.1.1 Padrão de documento XML ......................................................................................................... 6 2.1.2 Padrão de Comunicação ............................................................................................................. 7 2.1.3 Padrão de Certificado Digital ....................................................................................................... 9 2.1.4 Padrão de compactação .............................................................................................................. 9 2.1.5 Padrão de mensagens dos Web Services .................................................................................. 9 2.1.6 Tabela de Unidades Federadas .................................................................................................. 9 2.1.7 Informações de controle e área de dados das mensagens ...................................................... 10 2.1.8 Validação da estrutura XML das Mensagens dos Web Services.............................................. 10 2.2 Resumo dos Padrões Técnicos ........................................................................................ 11 3 Serviço de Distribuição MDF-e Atores (MDFeDistribuicaoDFe) ............................................... 12 3.1 Leiaute Mensagem de Entrada ......................................................................................... 12 3.2 Leiaute Mensagem de Retorno ......................................................................................... 13 3.3 Mensagem de Retorno Compactada ................................................................................ 13 3.4 Descrição do Processo de Distribuição de DF-e de Interesse .......................................... 14 3.5 Processamento da Requisição de Distribuição de conjunto de DF-e a partir do NSU informado (distNSU) .................................................................................................................... 15 3.6 Processamento da Requisição de Distribuição de DF-e vinculado ao NSU informado (consNSU) .................................................................................................................................. 16 3.7 Regras de Validação Básicas do Serviço ......................................................................... 16 3.8 Validação das informações de controle da chamada ao Web Service .............................. 17 3.9 Validação da área de dados da mensagem ...................................................................... 18 3.10 Validação das Regras de Negócio .................................................................................... 18 3.11 Recomendações Para Evitar o Uso Indevido .................................................................... 18 4 Endereço do Web Service ....................................................................................................... 20 5 Tabela de Códigos e Descrições de Mensagens de Erros ....................................................... 21 Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 3 / 21 Controle de Versões Versão Publicação Descrição 1.00 04/2016 Especificação da Nota Técnica 1.00a 07/2016 Restrição a chaves de acesso (ENCAT) 1.00b 08/2016 Restrição ao CNPJ ANTT (SEFAZ SP) 1.01 05/2019 Regra de validação para prazo de consulta aos NSU antigos 1.02 05/2021 Inclusão dos contratantes na distribuição 1.03 04/2022 Retirada mascaramento das chaves Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 4 / 21 Histórico de Alterações / Cronograma Versão Histórico de atualizações Implantação Homologação Implantação Produção 1.00a Alteração conforme determinação do ENCAT – Retirada das chaves de acesso de NF-e, CT-e e MDF-e do XML retornado pelo serviço 07/2016 07/2016 1.00b Alteração conforme acertado em reunião do Grupo XML – Não distribuição de MDF-e da versão 3.00 para Agências Reguladoras quando o emitente do MDF-e for SP 08/2016 08/2016 1.01 Restrição da consulta para NSU dos últimos 6 meses 05/2019 05/2019 1.02 Inclusão dos contratantes na geração de NSU 05/2021 05/2021 1.03 Retirada da restrição do mascaramento 04/2022 04/2022 Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 5 / 21 1 Resumo Um dos grandes desafios dos projetos de Documentos Fiscais Eletrônicos é prover para os atores envolvidos nos processos informações de seu interesse de forma eficiente e confiável. Esta nota técnica tem como objetivo a apresentação de um serviço que disponibilizará para os atores do MDF-e informações e documentos fiscais eletrônicos de seu interesse. A distribuição será realizada para terceiros informados no conteúdo do MDF-e no grupo de pessoas autorizadas a acessar o XML (tag:autXML), para os contratantes do serviço (grupo infContratante do modal rodoviário) e para os proprietários de veículo quando o RNTRC do proprietário for diferente do RNTRC do emitente do MDF-e. Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 6 / 21 2 Arquitetura de Comunicação com o Contribuinte O Webservice de Distribuição DF-e seguirá o padrão síncrono de processamento da solicitação, iniciado pelo aplicativo do contribuinte através do envio de uma mensagem com os parâmetros desejados para a pesquisa. O Web Service sempre devolve uma mensagem de resposta confirmando o recebimento da solicitação de serviço ao aplicativo do contribuinte na mesma conexão. 2.1 Padrões Técnicos 2.1.1 Padrão de documento XML a) Padrão de Codificação A especificação do documento XML adotada é a recomendação W3C para XML 1.0, disponível em www.w3.org/TR/REC-xml e a codificação dos caracteres será em UTF-8, assim todos os documentos XML serão iniciados com a seguinte declaração: <?xml version="1.0" encoding="UTF-8"?> b) Declaração namespace O documento XML deverá ter uma única declaração de namespace no elemento raiz do documento com o seguinte padrão: <distDFeInt xmlns=”http://www.portalfiscal.inf.br/mdfe” > O uso de declaração namespace diferente do padrão estabelecido para o Projeto é vedado. c) Prefixo de namespace Não é permitida a utilização de prefixos de namespace. Essa restrição visa otimizar o tamanho do arquivo XML. Assim, ao invés da declaração: <mdfe:distDFeInt xmlns:mdfe=http://www.portalfiscal.inf.br/mdfe> Deverá ser adotada a declaração: <distDFeInt xmlns =”http://www.portalfiscal.inf.br/mdfe” > d) Validação de Schema Para garantir minimamente a integridade das informações prestadas e a correta formação dos arquivos XML, o contribuinte deverá submeter a mensagem XML para validação pelo Schema (XSD – XML Schema Definition), disponibilizado pelo Ambiente Autorizador, antes de seu envio. Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 7 / 21 2.1.2 Padrão de Comunicação O meio físico de comunicação utilizado será a Internet, com o uso do protocolo TLS versão 1.2 ou superior e autenticação mútua, que além de garantir um duto de comunicação seguro na Internet, permite a identificação do servidor e do cliente através de certificados digitais, eliminando a necessidade de identificação do usuário através de nome ou código de usuário e senha. O modelo de comunicação segue o padrão de Web Services definido pelo WS-I Basic Profile. A troca de mensagens entre os Web Services do Ambiente Autorizador e o aplicativo do contribuinte será realizada no padrão SOAP versão 1.2, com troca de mensagens XML no padrão Style/Enconding: Document/Literal. A chamada do Web Service distDFeInt é realizada com o envio de uma mensagem XML através do campo mdfeDadosMsg. A versão do leiaute da mensagem XML contida no campo mdfeDadosMsg e o código da UF requisitada serão informados nos campos versaoDados e cUF, ambos do tipo string localizados no elemento mdfeCabecMsg do SOAP header. Exemplo de uma mensagem requisição padrão SOAP: <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Header> <mdfeCabecMsg xmlns="http://www.portalfiscal.inf.br/mdfe/wsdl/ MDFeDistribuicaoDFe"> <cUF>string</cUF> <versaoDados>string</versaoDados> </mdfeCabecMsg> </soap12:Header> <soap12:Body> <mdfeDadosMsg xmlns="http://www.portalfiscal.inf.br/mdfe/wsdl/MDFeDistribuicaoDFe ">xml</mdfeDadosMsg> </soap12:Body> </soap12:Envelope> Exemplo de uma mensagem de retorno padrão SOAP: <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Header> <mdfeCabecMsg xmlns="http://www.portalfiscal.inf.br/mdfe/wsdl/ MDFeDistribuicaoDFe"> <cUF>string</cUF> <versaoDados>string</versaoDados> </mdfeCabecMsg> </soap12:Header> <soap12:Body> <mdfeDistribuicaoDFeResult xmlns="http://www.portalfiscal.inf.br/mdfe/wsdl/MdfeRecepcao">xml</mdfeDistribuicaoDFeRe sult> </soap12:Body> Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 8 / 21 </soap12:Envelope> Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 9 / 21 2.1.3 Padrão de Certificado Digital O certificado digital utilizado no Projeto do MDF-e será emitido por Autoridade Certificadora credenciada pela Infraestrutura de Chaves Públicas Brasileira – ICP-Brasil, tipo A1 ou A3, devendo conter o CNPJ da pessoa jurídica ou CPF da pessoa física titular do certificado digital. O certificado digital será exigido durante a transmissão das mensagens entre o servidor do contribuinte e o Ambiente Autorizador e deverá conter o CNPJ ou CPF do responsável pela transmissão das mensagens, devendo ter a extensão Extended Key Usage com permissão de "Autenticação Cliente". 2.1.4 Padrão de compactação O padrão de compactação adotado para o projeto será o Gzip (GNU zip) que é implementado nas plataformas Java e .NET framework 2.0 (classe System.IO.Compression.GZipStream). 2.1.5 Padrão de mensagens dos Web Services As chamadas dos Web Services disponibilizados pelo Ambiente Autorizador e os respectivos resultados do processamento são realizadas através das mensagens com o seguinte padrão:  cUF – código da UF de origem da mensagem.  versaoDados - versão do leiaute da estrutura XML informado na área de dados.  Área de Dados – estrutura XML variável definida na documentação do Web Service acessado. 2.1.6 Tabela de Unidades Federadas Região Norte Região Nordeste Região Sudeste Região Sul Região Centro-Oeste 11-Rondônia 12-Acre 13-Amazonas 14-Roraima 15-Pará 16-Amapá 17-Tocantins 21-Maranhão 22-Piauí 23-Ceará 24-Rio Grande do Norte 25-Paraíba 26-Pernambuco 27-Alagoas 28-Sergipe 29-Bahia 31-Minas Gerais 32-Espírito Santo 33-Rio de Janeiro 35-São Paulo 41-Paraná 42-Santa Catarina 43-Rio Grande do Sul 50-Mato Grosso do Sul 51-Mato Grosso 52-Goiás 53-Distrito Federal cUF Estrutura XML definida na documentação do Web Service Padrão de Mensagem de chamada/retorno de Web Service Elemento mdfeCabecMsg (SOAP Header) Área de dados (SOAP Body) versaoDados Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 10 / 21 2.1.7 Informações de controle e área de dados das mensagens As informações de controle das chamadas dos Web Services são armazenadas no elemento mdfeCabecMsg do SOAP Header e servem para identificar a UF de origem do emissor e a versão do leiaute da estrutura XML armazenada na área de dados da mensagem: <soap12:Header> <mdfeCabecMsg xmlns="http://www.portalfiscal.inf.br/mdfe/wsdl/MdfeRecepcao"> <cUF>string</cUF> <versaoDados>string</versaoDados> </mdfeCabecMsg> </soap12:Header> A informação armazenada na área de dados é um documento XML que deve atender o leiaute definido na documentação do Web Service acessado: <soap12:Body> <mdfeDadosMsg xmlns="http://www.portalfiscal.inf.br/mdfe/wsdl/MDFeDistribuicaoDFe">xml</mdfe DadosMsg> </soap12:Body> 2.1.8 Validação da estrutura XML das Mensagens dos Web Services As informações são enviadas ou recebidas do Web Service através de mensagens no padrão XML definido na documentação descrita nessa Nota Técnica. As alterações de leiaute e da estrutura de dados XML realizadas nas mensagens são controladas através da atribuição de um número de versão para a mensagem. Um Schema XML é uma linguagem que define o conteúdo do documento XML, descrevendo os seus elementos e a sua organização, além de estabelecer regras de preenchimento de conteúdo e de obrigatoriedade de cada elemento ou grupo de informação. A validação da estrutura XML da mensagem é realizada por um analisador sintático (parser) que verifica se a mensagem atende as definições e regras de seu Schema XML. Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 11 / 21 Qualquer divergência da estrutura XML da mensagem em relação ao seu Schema XML provoca um erro de validação do Schema XML. A primeira condição 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 versão 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> 2.2 Resumo dos Padrões Técnicos A tabela a seguir resume os principais padrões de tecnologia utilizados: Características Descrição WebServices Padrão definido pelo WS-I Basic Profile 1.1 ( http://www.ws- i.org/Profiles/BasicProfile-1.1-2004-08-24.html). Meio lógico de comunicação WebServices, disponibilizados pelo Ambiente Autorizador do MDF-e Meio físico de comunicação Internet Protocolo Internet TLS versão 1.2, com autenticação mútua através de certificados digitais. Padrão de troca de mensagens SOAP versão 1.2. Padrão da mensagem XML no padrão Style/Encoding: Document/Literal. Padrão de certificado digital X.509 versão 3, emitido por Autoridade Certificadora credenciada pela Infraestrutura de Chaves Públicas Brasileira – ICP-Brasil, do tipo A1 ou A3, devendo conter o CNPJ ou CPF do proprietário do certificado digital. Padrão de Compactação Gzip (GNU ZIP) Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 12 / 21 3 Serviço de Distribuição MDF-e Atores (MDFeDistribuicaoDFe) Função: Serviço destinado à distribuição de informações de documentos fiscais eletrônicos de interesse de um ator, seja esta pessoa física ou jurídica. Processo: síncrono. Método: mdfeDistDFeInteresse Este serviço permite que um ator do MDF-e tenha acesso aos documentos fiscais eletrônicos (DF-e) que não tenham sido gerados por ele e que sejam de seu interesse. Pode ser consumido por qualquer ator de MDF-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 estarão disponíveis para distribuição por até 6 meses após sua recepção pelo Ambiente Nacional do MDF-e. Os documentos que serão disponibilizados para terceiros (informado na tag autXML) seguem a tabela abaixo: Documento MDF-e Evento de Cancelamento Evento de Encerramento / Encerramento do Fisco Evento de Inclusão de Condutor 3.1 Leiaute Mensagem de Entrada Entrada: Estrutura XML contendo a consulta do MDF-e Schema XML: distDFeInt_v9.99.xsd # Campo Ele Pai Tipo Ocor. Tam. Descrição/Observação AP01 distDFeInt Raiz - - - - TAG raiz AP02 versao A AP01 N 1-1 2v2 Versão do leiaute AP03 tpAmb E AP01 N 1-1 1 Identificação do Ambiente: 1=Produção /2=Homologação AP04 CNPJ CE AP01 N 1-1 14 CNPJ do interessado no DF-e AP05 CPF CE AP01 N 1-1 11 CPF do interessado no DF-e AP06 distNSU CG AP01 - 1-1 - Grupo para distribuir DF-e de interesse AP07 ultNSU E AP06 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 de documentos fiscais eletrônicos que tenham sido recepcionados pelo Ambiente Nacional nos últimos 6 meses. AP08 consNSU CG AP01 - 1-1 - Grupo para consultar um DF-e a partir de um NSU específico AP09 NSU E AP08 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 Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 13 / 21 como faltante. 3.2 Leiaute Mensagem de Retorno Retorno: Estrutura XML com o resultado da Consulta. Schema XML: retDistDFeInt_v9.99.xsd # Campo Ele Pai Tipo Ocor. Tam. Descrição/Observação AR01 retDistDFeInt Raiz - - - - TAG raiz da Resposta AR02 versao A AR01 N 1-1 2v2 Versão do leiaute AR03 tpAmb E AR01 N 1-1 1 Identificação do Ambiente: 1=Produção /2=Homologação AR04 verAplic E AR01 C 1-1 1-20 Versão do aplicativo que processou a consulta AR05 cStat E AR01 N 1-1 3 Código do status da resposta (vide item 5) AR06 xMotivo E AR01 C 1-1 1-255 Descrição literal do status da resposta AR07 dhResp E AR01 D 1-1 Data e hora da mensagem de Resposta AR08 ultNSU E AR01 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. AR09 maxNSU E AR01 N 0-1 1-15 Maior NSU existente no Ambiente Nacional para o CNPJ/CPF informado AR10 loteDistDFeInt G AR01 B64 0-1 Conjunto de informações de documentos fiscais eletrônicos de interesse da pessoa ou empresa. AR11 docZip G AR10 1-50 Informação do 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. AR12 NSU A AR11 N 1-1 1-15 NSU do documento fiscal AR13 schema A AR11 C 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: - procMDFe_v3.00.xsd - procEventoMDFe_v3.00.xsd 3.3 Mensagem de Retorno Compactada O tamanho médio do MDF-e é de aproximadamente 10 KB, 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. Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 14 / 21 O padrão de compactação adotado para o projeto será o Gzip (GNU zip) que é implementado nas plataformas Java e .NET. 3.4 Descrição do Processo de Distribuição de DF-e de Interesse Este serviço pode ser consumido por atores relacionados como autorizados ao XML, contratantes e por proprietários de veículos utilizados em MDF-e quando o RNTRC do proprietário for diferente do RNTRC do emitente do manifesto, 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 Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 15 / 21 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. 3.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 dos 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. O processo de recepção e sincronizaçã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 autorização no 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á realizada através de um processo assíncrono na aplicação da SVRS, a empresa ou pessoa conseguirá recuperar todos os documentos de seu interesse tão logo estes sejam processados para distribuição pelo Ambiente Nacional do MDF-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; Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 16 / 21  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 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. 3.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 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 mdfeDistDFeInteresse do Web Service MDFeDistribuicaoDFe 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”. 3.7 Regras de Validação Básicas do Serviço Validação do Certificado Digital do Transmissor (protocolo TLS) # Regra de Validação Crítica Msg Efeito A01 Certificado de Transmissor Inválido: - Certificado de Transmissor inexistente na mensagem - Versão difere "3" - Se informado, Basic Constraint deve ser true (não pode ser Certificado de AC) - KeyUsage não define "Autenticação Cliente" Obrig. 280 Rej. Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 17 / 21 A02 Validade do Certificado (data início e data fim) Obrig. 281 Rej. A03 Verificar a Cadeia de Certificação: - Certificado da AC emissora não cadastrado na SEFAZ - Certificado de AC revogado - Certificado não assinado pela AC emissora do Certificado Obrig. 283 Rej. A04 LCR do Certificado de Transmissor - Falta o endereço da LCR (CRL DistributionPoint) - LCR indisponível - LCR inválida Obrig. 286 Rej. A05 Certificado do Transmissor revogado Obrig. 284 Rej. A06 Certificado Raiz difere da "ICP-Brasil" Obrig. 285 Rej. A07 Falta a extensão de CNPJ (OtherName - OID=2.16.76.1.3.3) ou a extensão de CPF (OtherName - OID=2.16.76.1.3.1) no Certificado Obrig. 287 Rej. As validações de A01, A02, A03, A04 e A05 são realizadas pelo protocolo TLS e não precisam ser implementadas. A validação A06 também pode ser realizada pelo protocolo, 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 Ambiente Autorizador. Validação Inicial da Mensagem no Web Service # Regra de Validação Crítica Msg Efeito B01 Tamanho do XML de Dados superior a 10 Kbytes Obrig. 214 Rej. B02 XML de Dados Malformado Obrig. 243 Rej. B03 Verificar se o Serviço de processamento está Paralisado Momentaneamente Obrig. 108 Rej. B04 Verificar se o Serviço de processamento está Paralisado sem Previsão Obrig. 109 Rej. A mensagem será descartada se o tamanho exceder o limite previsto (10 Kb). A aplicação do contribuinte não poderá permitir a geração de mensagem com tamanho superior a 10 Kb. Caso isto ocorra, a conexão poderá ser interrompida sem mensagem de erro se o controle do tamanho da mensagem for implementado por configurações do ambiente de rede do Ambiente Autorizador (ex.: controle no firewall). No caso de controle de tamanho ter sido implementado por aplicativo, teremos a devolução da mensagem de erro 214. Caso o WebService fique disponível, mesmo quando o serviço estiver paralisado, deverão implementar as verificações 108 e 109. Estas validações poderão ser dispensadas se o WebService não ficar disponível quando o serviço estiver paralisado. 3.8 Validação das informações de controle da chamada ao Web Service Validações de controle da chamada ao Web Service # Regra de Validação Crítica Msg Efeito C01 Elemento mdfeCabecMsg inexistente no SOAP Header Obrig. 242 Rej. C02 Campo cUF inexistente no elemento mdfeCabecMsg do SOAP Header Obrig. 409 Rej. C03 Verificar se a UF informada no campo cUF é válida Obrig. 410 Rej. C04 Campo versaoDados inexistente no elemento mdfeCabecMsg do SOAP Header Obrig. 411 Rej. C05 Versão dos Dados não suportada Obrig. 239 Rej. Este grupo de validações deverá ser descontinuado em futura versão do MDF-e Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 18 / 21 A informação da versão do leiaute do lote e a UF de origem são informados no elemento mdfeCabecMsg do SOAP Header. A aplicação deverá validar a UF solicitante (cUF) e versão da mensagem (versaoDados), rejeitando a solicitação recebida em caso de informações inexistentes ou inválidas. 3.9 Validação da área de dados da mensagem Validações de Forma Aplicadas a área de dados # Regra de Validação Crítica Msg Efeito D01 Verificar Schema XML da Área de Dados Obrig. 215 Rej. D02 Verificar a existência de qualquer namespace diverso do namespace padrão do projeto (http://www.portalfiscal.inf.br/mdfe) Obrig. 598 Rej. D03 Verificar a existência de caracteres de edição no início ou fim da mensagem ou entre as tags Obrig. 599 Rej. D04 Verificar o uso de prefixo no namespace Obrig. 404 Rej. D05 Verificar se o XML utiliza codificação diferente de UTF-8 Obrig. 402 Rej. 3.10 Validação das Regras de Negócio Validações das Regras de Negócio # Regra de Validação Crítica Msg Efeito H01 Tipo do ambiente do MDF-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 CNPJ base do CNPJ consultado Obrig. 491 Rej. H05 CPF do Certificado Digital utilizado na transmissão diferente do CPF consultado Obrig. 492 Rej. H06 Número do NSU informado superior ao maior NSU disponível para consulta Obrig. 493 Rej. H07 NSU informado corresponde a documento autorizado há mais de seis meses Retornar o menor NSU aceito para busca para o solicitante [NSUMin: 999999999999999] Obrig. 730 Rej. 3.11 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. Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 19 / 21 As novas tentativas serão rejeitadas com o erro “678–Rejeição: Consumo Indevido”. Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 20 / 21 4 Endereço do Web Service O endereço do Web Service de Distribuição do Ambiente Nacional está publicado no Portal dos Documentos Fiscais Eletrônicos da SVRS (http://dfe-portal.svrs.gov.br/MDFe), no link “Serviços” / “Relação de Serviços Web”. Produção: https://mdfe.svrs.rs.gov.br/WS/MDFeDistribuicaoDFe/MDFeDistribuicaoDFe.asmx Homologação: https://mdfe-homologacao.svrs.rs.gov.br/WS/MDFeDistribuicaoDFe/MDFeDistribuicaoDFe.asmx Projeto Manifesto de Documentos Fiscais Eletrônico NT 2015.002 – WS Distribuição DF-e Página 21 / 21 5 Tabela de Códigos e Descrições de Mensagens de Erros CÓDIGO RESULTADO DO PROCESSAMENTO DA SOLICITAÇÃO 108 Serviço Paralisado Momentaneamente (curto prazo) 109 Serviço Paralisado sem Previsão 137 Nenhum documento localizado 138 Documento localizado CÓDIGO MOTIVOS DE NÃO ATENDIMENTO DA SOLICITAÇÃO 214 Rejeição: Tamanho da mensagem excedeu o limite estabelecido 215 Rejeição: Falha no schema XML 239 Rejeição: Cabeçalho - Versão do arquivo XML não suportada 242 Rejeição: Elemento mdfeCabecMsg inexistente no SOAP Header 243 Rejeição: XML Malformado 252 Rejeição: Ambiente informado diverge do Ambiente de recebimento 280 Rejeição: Certificado Transmissor inválido 281 Rejeição: Certificado Transmissor Data Validade 283 Rejeição: Certificado Transmissor - erro Cadeia de Certificação 284 Rejeição: Certificado Transmissor revogado 285 Rejeição: Certificado Transmissor difere ICP-Brasil 286 Rejeição: Certificado Transmissor erro no acesso a LCR 287 Rejeição: Certificado Transmissor sem CNPJ ou CPF 402 Rejeição: XML da área de dados com codificação diferente de UTF-8 404 Rejeição: Uso de prefixo de namespace não permitido 409 Rejeição: Campo cUF inexistente no elemento mdfeCabecMsg do SOAP Header 410 Rejeição: UF informada no campo cUF não é atendida pelo Web Service 411 Rejeição: Campo versaoDados inexistente no elemento mdfeCabecMsg do SOAP Header 489 Rejeição: CNPJ informado inválido (DV ou zeros) 490 Rejeição: CPF informado inválido (DV ou zeros) 491 Rejeição: CNPJ-Base consultado difere do CNPJ-Base do Certificado Digital 492 Rejeição: CPF consultado difere do CPF do Certificado Digital 493 Rejeição: Número do NSU informado superior ao maior NSU da base de dados do Ambiente Nacional 598 Rejeição: Usar somente o namespace padrao do MDF-e 599 Rejeição: Não é permitida a presença de caracteres de edição no início/fim da mensagem ou entre as tags da mensagem 678 Rejeição: Consumo indevido 730 Rejeição: NSU solicitado muito antigo [NSUMin: 999999999999999]