TSS

Páginas filhas
  • ER_MDFe_v3.00

Versões comparadas

Versão antiga 31

changes.mady.by.user Cleiton Genuino Da Silva

Gravado em

comparado com

Nova versão 32

changes.mady.by.user Cleiton Genuino Da Silva

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

 Este documento é material de especificação dos requisitos de manutenção, trata-se de conteúdo extremamente técnico.                                                             

 Informações Gerais

Especificação

Produto

TSS

Módulo

MDF-e

Segmento Executor

Serviços

Chamado

MSERV-3533 

País

( X ) Brasil  (  ) Argentina  (  ) Mexico  (  ) Chile  (  ) Paraguai  (  ) Equador

(  ) USA  (  ) Colombia   (  ) Outro _____________.

Objetivo

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

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:   
  • Ambiente de Produção:   
  • Data final da vigência da versão 1.00:   


Definição da Regra de Negócio

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>

  <HORAVERAOCCE>STRING</HORAVERAOCCE>

  < HORARIOCCE >STRING</ HORARIOCCE >

</soap:Body>

 

Parâmetro

Tipo

Tam.

Ocor.

Descrição

 CFGMDFE - - 1-1 Tag raiz.

USERTOKEN

Alfanumérico

6

1-1

Token de bilhetagem para execução do   serviço TOTVS.

ID_ENT

Alfanumérico

6

1-1

Código da entidade.

AMBIENTEMDFE

Inteiro

1

1-1

Identificação   do Ambiente do MDF-e:

 1-Produção ou 2-Homologação.

VERSAOMDFE

Alfanumérico

1-4

1-1

Versão   do Layout do MDF-e :

3.00

MODALIDADEMDFE

Inteiro

1

1-1

Modalidade   de Transmissão do MDF-e:

1-Normal   ou 2-Contingência

VERMDFELAYOUT

Alfanumérico

1-4

1-1

Versão   do leiaute específico do evento:

3.00

VERMDFELAYEVEN

Alfanumérico

1-4

1-1

Versão   do leiaute geral do evento:

3.00

SEQLOTEMDFE

Inteiro

--

0-1

Número   sequencial do lote do MDF-e

HORAVERAOCCE

Alfanumérico

1

1-1

Identificação de Horário de Verão:

1-Sim ou 2-Não

HORARIOCCE

Alfanumérico

1

1-1

Identificação do Horário:

1-Fernando de Noronha; 2-Brasília ;3-Manaus e 4-Acre

 

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

 

<soap:Body>

 <CFGMDFERESULT>

  <AMBIENTEMDFE>STRING</AMBIENTEMDFE>

  <MODALIDADEMDFE>STRING</MODALIDADEMDFE>

  < HORARIOCCE >STRING</ HORARIOCCE >

  <HORAVERAOCCE>STRING</HORAVERAOCCE>

  <SEQLOTEMDFE>INTEGER</SEQLOTEMDFE>

  <VERMDFELAYEVEN>STRING</VERMDFELAYEVEN>

  <VERMDFELAYOUT>STRING</VERMDFELAYOUT>

  <VERSAOMDFE>STRING</VERSAOMDFE>

 </CFGMDFERESULT>

</soap:Body>                                            


Parâmetro

PAI

Tam.

Tipo

Ocor. 

Descrição

 CFGMDFERESULT     

AMBIENTEMDFE

CFGMDFERESULT

-

A

 1-1

Identificação   do Ambiente:

1-Produção   ou 2-Homologação.

HORARIOCCE

CFGMDFERESULT

-

A

 1-1

Horário inválido. Valores   válidos:
  1-Fernando de Noronha, 2-Brasilia, 3-Manaus e 4-Acre

HORAVERAOCCE

CFGMDFERESULT

 

 A

 1-1

Horário de verão   inválido. Valores válidos:
  1-Sim e 2-Não

MODALIDADEMDFE

CFGMDFERESULT

-

 A

 1-1

Identificação   do Ambiente do MDF-e:

1-Produção   ou 2-Homologação.

SEQLOTEMDFE

CFGMDFERESULT

-

I

 1-1

Número   sequencial do lote do MDF-e

VERMDFELAYEVEN

CFGMDFERESULT

1-4

A

 1-1

Versão   do leiaute geral do evento:

3.00

VERMDFELAYOUT

CFGMDFERESULT

1-4

A

 1-1

Versão   do leiaute específico do evento:

3.00

VERSAOMDFE

CFGMDFERESULT

1-4

A

 1-1

Versão   do Layout do MDF-e :

3.00

 

Soap Fault

Fault

Descrição

Invalid Token

O parâmetro “USERTOKEN” foi passado incorretamente.

1

Código da entidade inválida.

2

Código da entidade em branco.

3

Código do ambiente inválido. Valores válidos:   0-Configuração,1-Produção e 2-Homologação.

4

Versão do MDF-e inválida.

5

Modalidade inválida para MDF-e. Valores válidos:   0-Configuração,1-Normal,2-Contingência.

6

Versão do leiaute especifico do evento inválida.

7

Versão do leiaute geral dos eventos inválida.

8

Horário de verão   inválido. Valores válidos: 1-Sim e 2-Não

9

Horário inválido. Valores   válidos: 1-Fernando de Noronha, 2-Brasilia, 3-Manaus e 4-Acre

 

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>

 

 

 

Nome
Pai
Tipo
Tam.
Ocor.
Observações
REMESSA---1-1Tag raiz.
USERTOKENREMESSAA51-1Deverá ser preenchido com o valor “TOTVS”.
ID_ENTREMESSA 61-1ID da entidade a ser utilizada.
NFEREMESSA---Estrutura
NOTASNFE--

-

Estrutura
NFESNOTAS---Estrutura
IDNFESA1-2501-1Id de identificação do XML da XML da NF-e, CT-e e MDF-e com o ERP. Este número será sempre informado ou solicitado pelo TOTVS Service Soa para fornecer informações sobre o status atual da NF-e, CT-e e MDF-e. É recomendado para o ERP enviar o número da chave de acesso da NF-e, CTe e MDF-e, caso utilize uma base de dados 100% volátil.
XMLNFESBASE64BINARY 1-1

NF-e:  Leiaute TSS ou padrão SEFAZ.

CT-e: Leiaute SEFAZ.

MDF-e: Leiaute SEFAZ.

MAILNFESA-0-1

Informe e-mails para que seja enviado o documento quando for autorizado/cancelado.

Caso este campo seja preenchido, o e-mail enviado no XML do documento será desconsiderado.

Os e-mails devem ser separados por ponto e vírgula(;).

Exemplo de preenchimento:

[email protected];ciclano@totvs.com.br

 

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

<soap:Body>
  <NFEOK>
     <ID>
      <STRING>STRING</STRING>
     </ID>
   </NFEOK>
</soap:Body>

 

Nome
Pai
Tipo
Tam.
Ocor.
Observações
NFeOk-Estrutura-- 
IDNFeOkMatriz[0,n]0060-1Matriz com as identificações das NF-es, CT-es e MDF-es que foram aceitas pelo Totvs Service Soa. O serviço somente aceita remessas duplicadas de NF-e, CT-e e MDF-e , em caso de erro na transmissão devido ao preenchimento errado dos dados do XML ou antes de realizar a transmissão. 
CSTRINGNFeOkA1-2500-1Identificação da NF-e, CT-e e MDF-e que foram aceitas pelo serviço.

 

  • Método REMESSAEVENTO

 

Método destinado ao envio em lote dos novos eventos da Nota Fiscal Eletrônica – NF-e, Manifestação Eletrônico de Documentos Fiscais – MDF-e e Conhecimento de Transporte Eletrônico – CT-e. Os eventos são recebidos em lote, porém, são tratados e enviados a SEFAZ individualmente.

 

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

 <soap:Body>

   <USERTOKEN>STRING</USERTOKEN>
   <ID_ENT>STRING</ID_ENT>
   <XML_LOTE>BINÁRIO</XML_LOTE>
</soap:Body>

 

Nome
Pai
Tipo
Tam.
Ocor.
Observações

REMESSAEVENTO

-

-

-

-

Tag raiz da requisição

USERTOKEN

-

A

5

1-1

Deverá ser preenchido com o valor “TOTVS”.

ID_ENT

-

A

6

1-1

ID da entidade a ser utilizada.

XML_LOTE

-

 

1-500K

1-1

XML do Lote de envio dos eventos, este XML será definido conforme o Layout de cada evento

 

 

Para o envio dos eventos, foi disponibilizado um leiaute padrão atender a todos os eventos disponibilizados para a NFe,tendo como diferencial para cada evento,apenas a tag detEvento, que deverá conter os elementos de acordo com evento a ser enviado.O Xml deverá respeitar a seguinte estrutura:

Nome
Pai
Tipo
Tam.
Ocor.
Observações

envEvento

-

-

-

1-1

Tag raiz

Eventos

envEvento

G

-

1-1

Evento

detEvento

Eventos

G

-

1-N

Informações do Evento (estrutura XML variável, depende do tipo de evento)

XML_LOTE

-

 

1-500K

1-1

XML do Lote de envio dos eventos, este XML será definido conforme o Layout de cada evento

 

Eventos modelo 58 – MDF-e

 

Tipo de Evento
Modelo de MDFe
Descrição Evento
Tipo de Autor do Evento
Local Evento
 110111 58Evento de Cancelamento do MDF-e.  Emitente Sefaz Autorizadora
110112 58 Evento de Encerramento do MDF-e. Emitente Sefaz Autorizadora
110114 58Evento de Inclusão de Condutor do MDF-e.EmitenteSefaz Autorizadora
 

 


  • detEvento –
Carta de correção do CT
  • Cancelamento MDF-e

 

Nome

 

#

Campo

Ele

Pai

Tipo

Ocor

Tam.

Ocor

Dec.

Descrição

Observações

CC03

detEvento

Eventos

G

-

E

1-N

Tag raiz

tpEvento

detEvento

A

6

1-1

Tipo de Evento

Informar : 110110

-

-

Informações do   Evento (estrutura XML variável, depende do tipo de evento)

CC04

tpEvento

E

CC03

Num

1-1

06

-

Tipo de Evento

Informar : 110111

CC05

chNFe

E

CC03

Num

1-1

44

-

chNFe

detEvento

N

44

1-1

Chave de Acesso do

CT

MDF-e.

correcao

CC06

detEvento

ambiente

G

E

-

CC03

Num

1-

N

Grupo de Informações de Correção

grupo

correcao

A

1-20

1-1

Indicar o grupo de nformações que pertence o campo Alterado. Ex: ide

campo

correcao

A

1

01

-

Informar o ambiete de emissão do MDF-e

CC07

xJust

E

CC03

Alfa

1-20

1-1

Nome do campo modificado do CT-e Original

15-255

-

Informar a justificativa do cancelamento.

 

 

Modelo XML do Evento de Cancelamento – MDF-e

 
<envEvento>
<eventos>
<detEvento>
<tpEvento>110111</tpEvento>
<chnfe>1234567891234567891234567891234567891234567</chnfe>
<ambiente>2</ambiente>
<xJust>Informe aqui a justificativa de cancelamento.</xJust>
</detEvento>
</eventos>
</envEvento>

 

 

  • detEvento – Evento de Encerramento  MDF-e

 

 

#

Campo

Ele

Pai

Tipo

Ocor

Tam.

Dec.

Descrição

CC03

detEvento

G

-

E

1-N

-

-

Informações do   Evento (estrutura XML variável, depende do tipo de evento)

CC04

tpEvento

E

CC03

Num

1-1

06

-

Tipo de Evento

Informar : 110112

CC05

chNFe

E

CC03

Num

1-1

44

-

Chave de Acesso do MDF-e.

CC06

ambiente

E

CC03

Num

1-1

01

-

Informar o ambiete de emissão do MDF-e

CC07

dtEnc

E

CC03

Date

1-1

10

-

Data do encerramento do MDF-e.

CC08

cUF

E

CC03

String

1

02

-

Sigla da UF.

CC09

cMun

E

CC03

Num

1

07

-

Código do município.

 
 

valor

correcao

A

1-500

1-1

Valor correspondente á alteração

item

correcao

N

2

0-1

Preencher com o indice do item alterado caso a alteração ocorra em uma lista.

Por exemplo: Se corrigir uma das NF-e do remetente, esta tag deverá indicar a posição

da NF-e alterada na lista. OBS: O indice inicia sempre em 1

 

Exemplo de  XML para carta de correção do CT-e:

 

<envEvento>

  <eventos>

    <detEvento>

      <tpEvento>110110</tpEvento>

      <chNFe></chNFe>

      <correcao>

         <grupo></grupo>

         <campo></campo>

         <valor></valor>

         <item></item>

     </correcao>

  <correcao>

       <grupo></grupo>

       <campo></campo>

       <valor></valor>

       <item></item>

     </correcao>

    </detEvento>

    <detEvento>

      <tpEvento>110110</tpEvento>

      <chNFe></chNFe>

      <correcao>

        <grupo></grupo>

        <campo></campo>

        <valor></valor>

        <item></item>

     </correcao>

    </detEvento>

 

Modelo XML do Evento de Encerramento – MDF-e

 

<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>

 

 
  • detEvento –
Registro do Multimodal
  • Inclusão de Condutor

 

 

Nome

Pai

Tipo

Tam.

Tamanho

Ocor.

Ocorrências

Observações

detEvento

Eventos

G

-

1-N

Tag raiz

tpEvento

detEvento

A

6

1-1

Tipo de Evento

Informar :

110160

110114

chNFe

detEvento

N

44

1-1

Chave de Acesso do

CT

MDF-e.

registro

ambiente

detEvento

A

N

15-1000

1

1-1

Informaçoes sobre o tipo de documento utilizado e ressalvas, se for o caso,

conforme Lei 9611, de 19 de fevereiro de 1998 (Texto Livre)

Ambiente de Transmissão:

1 – Homologação;2 - Produção

nomecondutor

doc

detEvento

A

43

1-60

0

1-1

Número do Documento lançado no CT-e Multimodal

Nome do Condutor

cpfcondutor

detEvento

A

1-11

1-1

CPF do Condutor

 
 

Exemplo

de XML para Registro do Multimodal

de  XML o evento Inclusão de Condutor

 

<envEvento>

 

<eventos>

   

<detEvento>

     

<tpEvento>

110160   

110114</tpEvento>

      <chNFe></chNFe>

      <registro></registro>

      <doc></doc>

<chnfe></chnfe>

<ambiente></ambiente>

<nomecondutor></nomecondutor>

<cpfcondutor></cpfcondutor>

</detEvento>

   

<detEvento>

     

<tpEvento>

110160

110114</tpEvento>

      <chNFe></chNFe>

      <registro></registro>

      <doc></doc>

   

<chnfe></chnfe>

<ambiente></ambiente>

<nomecondutor></nomecondutor>

<cpfcondutor></cpfcondutor>

</detEvento>

 

</eventos>

</envEvento>

 

 

 Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico.