Informações Gerais

Objetivo

Demonstrar as implementações necessárias para atender a o Manual de Orientações do Contribuinte versão 3.00 do MDF-e. 

Esta nota técnica tem como objetivo a apresentação da nova versão do Web Service da SEFAZ denominado MDFeDistribuicaoDFe  versão 3.00 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). 

Este Manual tem por objetivo a definição das especificações e critérios técnicos necessários para a integração entre os Portais das Secretarias de Fazendas das Unidades Federadas, Receita Federal do Brasil - RFB, Superintendência da Zona Franca de Manaus – SUFRAMA, e os sistemas das empresas emissoras do Manifesto Eletrônico de Documentos Fiscais – MDF-e. Prazos para entrada em vigência da Nota Técnica: 

• Ambiente de Homologação:  03/10/2016; 
• Ambiente de Produção:  12/12/2016; 
• Data final da vigência da versão 1.00:   05/06/2017;

Definição da Regra de Negócio

Serão utilizados os métodos do Web Service MANIFESTACAODESTINATARIO.

Através do método SINCRONIZARDOCUMENTOS será possível sincronizar os seguintes documentos fiscais eletrônicos emitidos para a entidade solicitada, desde que esteja autorizado a acessar o XML (tag autXML MDFe): 

• MDF-e;
• Evento de Cancelamento do MDF-e;
• Evento de Encerramento do MDF-e;
• Evento de Inclusão de Condutor do MDF-e.

Para identificar que a sincronização se refere ao MDF-e (modelo 58), foi criado o parâmetro MODELO neste método.

O parâmetro MODELO será disponibilizado também através do método CONFIGURARPARAMETROS, a fim de diferenciar as configurações de ambiente e versão para a Manifestação do Destinatário (MD-e, modelo 55) e Manifesto Eletrônico de Documentos Fiscais (MDF-e, modelo 58).

Através dos métodos MONITORARDOCUMENTOS e RETORNARDOCUMENTO serão disponibilizadas informações relacionadas ao MDF-e e seus eventos já sincronizados.

Web Service MANIFESTACAODESTINATARIO

• Método CFGMDFE

 Método de configuração dos parâmetros do Manifesto Eletrônico de Documentos Fiscais (MDF-e)

Os parâmetros de entrada do método são: 

Parâmetros de entrada:

<soap:Body>

<USERTOKEN>STRING</USERTOKEN>

  <ID_ENT>STRING</ID_ENT>

  <AMBIENTEMDFE>INTEGER</AMBIENTEMDFE>

  <VERSAOMDFE>STRING</VERSAOMDFE>

  <MODALIDADEMDFE>INTEGER</MODALIDADEMDFE>

  <VERMDFELAYOUT>STRING</VERMDFELAYOUT>

  <VERMDFELAYEVEN>STRING</VERMDFELAYEVEN>

  <SEQLOTEMDFE>INTEGER</SEQLOTEMDFE>

  <HORAVERAOCCE>STRING</HORAVERAOCCE>

O MDF-e sofreu alteração em seu leiaute.

A versão 3.00 introduz novas validações do campo de Data de Emissão para o formato UTC completo com a informação do TimeZone, consulte o Manual de Orientações do Contribuinte, versão 3.00 de Outubro de 2016 para verificação das alterações do modelo 58. É imprescindível a leitura completa deste manual para entendimento das alterações pertinentes à versão 3.00.

Web Services e Métodos TSS

Serão utilizados os métodos dos Web Services abaixo:

Web Service SPEDCFGNFESOAP

•  Método CFGMDFE

 Método de configuração dos parâmetros do Manifesto Eletrônico de Documentos Fiscais (MDF-e)

Os parâmetros de entrada do método são: 

Parâmetros de entrada:

<soap:Body>

<USERTOKEN>STRING</USERTOKEN>

  <ID_ENT>STRING</ID_ENT>

  <AMBIENTEMDFE>INTEGER</AMBIENTEMDFE>

  <VERSAOMDFE>STRING</VERSAOMDFE>

  <MODALIDADEMDFE>INTEGER</MODALIDADEMDFE>

  <VERMDFELAYOUT>STRING</VERMDFELAYOUT>

  <VERMDFELAYEVEN>STRING</VERMDFELAYEVEN>

  <SEQLOTEMDFE>INTEGER</SEQLOTEMDFE>

  <HORAVERAOMDFE>STRING</HORAVERAOMDFE>

  < HORARIOMDFE >STRING</ HORARIOMDFE   < HORARIOCCE >STRING</ HORARIOCCE >

</soap:Body>

Os parâmetros de saída do método são:

<soap:Body>

 <CFGMDFERESULT>

 <AMBIENTEMDFE>STRING</AMBIENTEMDFE>

  <MODALIDADEMDFE>STRING</MODALIDADEMDFE>

  < HORARIOCCE HORARIOMDFE >STRING</ HORARIOCCE HORARIOMDFE >

  <HORAVERAOCCE><HORAVERAOMDFE>STRING</HORAVERAOCCE>

HORAVERAOMDFE>

  <SEQLOTEMDFE>INTEGER</SEQLOTEMDFE>

  <VERMDFELAYEVEN>STRING</VERMDFELAYEVEN>

  <VERMDFELAYOUT>STRING</VERMDFELAYOUT>

  <VERSAOMDFE>STRING</VERSAOMDFE>

 </CFGMDFERESULT>

</soap:Body>  

• Método CONFIGURARPARAMETROS

Configura e retorna os parâmetros para a manifestação do destinatário.

Os parâmetros de entrada do método são:

<soap:Body>

  <USERTOKEN>STRING</USERTOKEN>

  <ID_ENT>STRING</ID_ENT>

  <AMBIENTE>STRING</AMBIENTE>

  <VERSAO>STRING</VERSAO>

  <ULTNSU>STRING</ULTNSU>

  <MODELO>STRING</MODELO>

</soap:Body>

CONFIGURARPARAMETROS

Os parâmetros de saída do método são:

<soap:Body>

  <USERTOKEN>STRING</USERTOKEN>

  <ID_ENT>STRING</ID_ENT>

  <AMBIENTE>STRING</AMBIENTE>

  <VERSAO>STRING</VERSAO>

  <ULTNSU>STRING</ULTNSU>

  <MODELO>STRING</MODELO>

</soap:Body>

Soap Fault

• Método SINCRONIZARDOCUMENTOS

Sincroniza junto com a Sefaz a base de dados do TSSS através de documentos que tenham como destinatário a entidade solicitada.

Os parâmetros de entrada do método são:

<soap:Body>

 <USERTOKEN>STRING</USERTOKEN>

 <ID_ENT>STRING</ID_ENT>

 <INDNFE>STRING</INDNFE>

 <INDEMI>STRING</INDEMI>

 <MODELO>STRING</MODELO> 

</soap:Body>

Os parâmetros de saída do método são:

<SINCRONIZARDOCUMENTOSRESULT>

 <AMBIENTE>STRING</AMBIENTE>

 <DOCUMENTOS>

      <SINCDOCUMENTOSINFO>

            <CANCNSU>STRING</CANCNSU>

            <CHAVE>STRING</CHAVE>

            </SITCONF>STRING</SITCONF>

       </SINCDOCUMENTOSINFO>

      <SINCDOCUMENTOSINFO>

            <CANCNSU>STRING</CANCNSU>

            <CHAVE>STRING</CHAVE>

            </SITCONF>STRING</SITCONF>

       </SINCDOCUMENTOSINFO>

  </DOCUMENTOS>

 <IDENT>STRING</IDENT>

 <INDCONT>STRING</INDCONT>

</SINCRONIZARDOCUMENTOSRESULT>

Soap Fault

• Método RETORNARDOCUMENTO

Retorna todas as informações sobre um documento sincronizado anteriormente.

Os parâmetros de entrada do método são:

<soap:Body>

 <USERTOKEN>STRING</USERTOKEN>

 <IDENT>STRING</IDENT>

 <AMBIENTE>STRING</AMBIENTE>

 <CHAVE>STRING</CHAVE>

</soap:Body>

Os parâmetros de saída do método são:

<soap:Body>

 <ID_ENT>STRING</ID_ENT>

 <AMBIENTE>STRING</AMBIENTE>

  <DOCUMENTO>

      <CANCELAMENTO>

         <CANCNSU>STRING</CANCNSU>

         <CANCXMLRET>BASE64BINARY</CANCXMLRET>

         <DATAAUTORIZACAO>STRING</DATAAUTORIZACAO>

         <DATAEMISSAO>STRING</DATAEMISSAO>

      </CANCELAMENTO>

      <CCE>

         <CCENSU>STRING</CCENSU>

         <CCEXMLRET>BASE64BINARY</CCEXMLRET>

         <CORRECAO>STRING</CORRECAO>

         <DATAAUTORIZACAO>STRING</DATAAUTORIZACAO>

         <DATAEMISSAO>STRING</DATAEMISSAO>

         <HORAEMISSAO>STRING</HORAEMISSAO>

         <TZD>STRING</TZD>

      </CCE>

      <CHAVE>STRING</CHAVE>

      <CONDUTOR>

          <CONDNSU>STRING</CONDNSU>

          <CONDXMLRET>BASE64BINARY</CONDXMLRET>

          <CPF>STRING</CPF>

          <DTHRAUTORIZACAO>STRING</DTHRAUTORIZACAO>

          <DTHREMISSAO>STRING</DTHREMISSAO>

          <NOME>STRING</NOME>

      </CONDUTOR>

       <DATAAUTORIZACAO>STRING</DATAAUTORIZACAO>

       <DATAEMISSAO>STRING</DATAEMISSAO>

       <EMITENTE>

           <CNPJ>STRING</CNPJ>

           <CPF>STRING</CPF>

           <IE>STRING</IE>

           <NOME>STRING</NOME>

        </EMITENTE>

        <ENCERRAMENTO>

           <ENCNSU>STRING</ENCNSU>

           <ENCXMLRET>BASE64BINARY</ENCXMLRET>

           <CODIGOIBGE>STRING</CODIGOIBGE>

           <DTHRAUTORIZACAO>STRING</DTHRAUTORIZACAO>

           <DTHREMISSAO>STRING</DTHREMISSAO>

           <ENCDTENC>STRING</ENCDTENC>

        </ENCERRAMENTO>

        <NSU>STRING</NSU>

        <RESPOSTA>

            <DESCRICAO>STRING</DESCRICAO>

            <STATUS>STRING</STATUS>

        </RESPOSTA>

        <SITUACAO>STRING</SITUACAO>

        <SITUACAOCONFIRMACAO>STRING</SITUACAOCONFIRMACAO>

        <TIPOOPERACAO>STRING</TIPOOPERACAO>

        <VALORTOTAL>FLOAT</VALORTOTAL>

        <XMLSEFAZ>BASE64BINARY</XMLSEFAZ>

  </DOCUMENTO>

</soap:Body>

Soap Fault

Web Service NFESBRA

• Método REMESSA

Método destinado à remessa de documentos fiscais eletrônicos. Este método recebe o XML do documento e assegura a transmissão para a SEFAZ.

Os parâmetros de entrada do método são:

<soap:Body>

   <USERTOKEN>STRING</USERTOKEN>

   <ID_ENT>STRING</ID_ENT>

   <NFE>

      <NOTAS>

         <NFES>

            <ID>STRING</ID>

            <XML>BASE64BINARY</XML>

         </NFES>

         <NFES>

            <ID>STRING</ID>

            <XML>BASE64BINARY</XML>

         </NFES>

      </NOTAS>

   </NFE>

</soap:Body>

Os parâmetros de saída do método são: 

<soap:Body>

  <NFEOK>

     <ID>

      <STRING>STRING</STRING>

     </ID>

   </NFEOK>

</soap:Body>

• Método REMESSAEVENTO

   <USERTOKEN>STRING</USERTOKEN>

   <ID_ENT>STRING</ID_ENT>

   <XML_LOTE>BINÁRIO</XML_LOTE>

</soap:Body>

<envEvento>

<eventos>

<detEvento>

<tpEvento>110111</tpEvento>

<chnfe>1234567891234567891234567891234567891234567</chnfe>

<ambiente>2</ambiente>

<xJust>Informe aqui a justificativa de cancelamento.</xJust>

</detEvento>

</eventos>

</envEvento>

<envEvento>

<eventos>

<detEvento>

<tpEvento>110112</tpEvento>

<chnfe>1234567891234567891234567891234567891234567</chnfe>

<ambiente>2</ambiente>

<dtEnc>AAAA-MM-DD</dtEnc>

<cUF>SP</cUF> - Informar a Sigla da UF

<cMun>3550308</cMun> - Código de Município do IBGE

</detEvento>

</eventos>

</envEvento>

Dicionário de Dados

TABELA SPED156 - MANIFESTAÇÃO DO DESTINATÁRIO.

Campo

MODELO

Tipo

C

Tamanho

2

Descrição