Este documento é material de especificação dos requisitos de manutenção, trata-se de conteúdo extremamente técnico. |
---|
Especificação | |||
Produto | TSS | Módulo | MDF-e |
Segmento Executor | Serviços | ||
Chamado | |||
País | ( X ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( ) Outro _____________. |
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:
O MDF-e sofreu alteração em seu leiaute.
A versão 3.00 introduz novas validações d Alterado o campo de Data de Emissão para o formato UTC completo com a informação do TimeZone. Este tipo de representação de dados já é utilizado atualmente no projeto da NF-e e é ecnicamente adequado para a representação do horário para um País com dimensões continentais como o Brasil. Todos os demais campos com horário foram migrados para este tipo de dado, inclusive os horários que constam nas mensagens de resposta fornecidas pelas SEFAZ. Nesta nova versão do leiaute, serão aceitos os horários de qualquer região do mundo (faixa de horário UTC de -11 a +12) e não apenas as faixas de horário do Brasil Exemplo: no formato UTC para os campos de Data-Hora, "TZD" pode ser -02:00 (Fernando de Noronha), -03:00 (Brasília) ou -04:00 (Manaus), no horário de verão serão -01:00, -02:00 e - 03:00. Exemplo: "2010-08-19T13:00:15-03:00".
O MDF-e sofreu alterações em seu leiaute.
Consulte , 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.
Serão utilizados os métodos do Web Service SPEDCFGNFESOAP.dos Web Services abaixo:
Web Service SPEDCFGNFESOAP
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><HORAVERAOMDFE>STRING</HORAVERAOCCE>HORAVERAOMDFE>
< HORARIOCCE HORARIOMDFE >STRING</ HORARIOCCE HORARIOMDFE >
</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 : 1.00 - 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: 1.00 - 3.00 |
VERMDFELAYEVEN | Alfanumérico | 1-4 | 1-1 | Versão do leiaute geral do evento: 1.00 - 3.00 |
SEQLOTEMDFE | Inteiro | -- | 0-1 | Número sequencial do lote do MDF-e |
HORAVERAOCCEHORAVERAOMDFE | Alfanumérico | 1 | 1-1 | Identificação de Horário de Verão: 1-Sim ou 2-Não |
HORARIOCCEHORARIOMDFE | 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 HORARIOMDFE >STRING</ HORARIOCCE HORARIOMDFE >
<HORAVERAOCCE><HORAVERAOMDFE>STRING</HORAVERAOCCE>HORAVERAOMDFE>
<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. |
HORARIOCCEHORARIOMDFE | CFGMDFERESULT | - | A | 1-1 | Horário inválido. Valores válidos: |
HORAVERAOCCEHORAVERAOMDFE | CFGMDFERESULT |
| A | 1-1 | Horário de verão inválido. Valores válidos: |
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: 1.00 - 3.00 |
VERMDFELAYOUT | CFGMDFERESULT | 1-4 | A | 1-1 | Versão do leiaute específico do evento: 1.00 - 3.00 |
VERSAOMDFE | CFGMDFERESULT | 1-4 | A | 1-1 | Versão do Layout do MDF-e : 1.00 - 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
Através do método REMESSA será possível enviar os seguintes documentos fiscais eletrônicos emitidos para a entidade solicitada:
MODELO DO XML
Através do método REMESSAEVENTO será possível enviar os seguintes documentos fiscais eletrônicos emitidos para a entidade solicitada, desde que esteja autorizado o MDFe (tag autXML MDFe):
MDF-e;
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-1 | Tag raiz. |
USERTOKEN | REMESSA | A | 5 | 1-1 | Deverá ser preenchido com o valor “TOTVS”. |
ID_ENT | REMESSA | 6 | 1-1 | ID da entidade a ser utilizada. | |
NFE | REMESSA | - | - | - | Estrutura |
NOTAS | NFE | - | - | - | Estrutura |
NFES | NOTAS | - | - | - | Estrutura |
ID | NFES | A | 1-250 | 1-1 | Id 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. |
XML | NFES | BASE64BINARY | 1-1 | NF-e: Leiaute TSS ou padrão SEFAZ. CT-e: Leiaute SEFAZ. MDF-e: Leiaute SEFAZ. | |
NFES | A | - | 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 | - | - | |
ID | NFeOk | Matriz[0,n] | 006 | 0-1 | Matriz 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. |
CSTRING | NFeOk | A | 1-250 | 0-1 | Identificação da NF-e, CT-e e MDF-e que foram aceitas pelo serviço. |
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) |
Eventos modelo 58 – MDF-e
Tipo de Evento | Modelo de MDFe | Descrição Evento | Tipo de Autor do Evento | Local Evento |
---|---|---|---|---|
110111 |
58 | Evento de Cancelamento do MDF-e. | Emitente | Sefaz Autorizadora |
110112 |
58 | Evento de Encerramento do MDF-e. | Emitente | Sefaz Autorizadora |
110114 |
58 | Evento de Inclusão de Condutor do MDF-e. | Emitente | Sefaz Autorizadora |
Campo | Ele | Pai | Tipo | Ocor | Tam. | Dec. | Descrição |
detEvento | G | - | E | 1-N | - | - | Informações do Evento (estrutura XML variável, depende do tipo de evento) |
tpEvento | E | CC03 | Num | 1-1 | 06 | - | Tipo de Evento Informar : 110111 |
chNFe | E | CC03 | Num | 1-1 | 44 | - | Chave de Acesso do MDF-e. |
ambiente | E | CC03 | Num | 1-1 | 01 | - | Informar o ambiete de emissão do MDF-e |
xJust | E | CC03 | Alfa | 1-1 | 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>
Campo | Ele | Pai | Tipo | Ocor | Tam. | Dec. | Descrição |
detEvento | G | - | E | 1-N | - | - | Informações do Evento (estrutura XML variável, depende do tipo de evento) |
tpEvento | E | CC03 | Num | 1-1 | 06 | - | Tipo de Evento Informar : 110112 |
chNFe | E | CC03 | Num | 1-1 | 44 | - | Chave de Acesso do MDF-e. |
ambiente | E | CC03 | Num | 1-1 | 01 | - | Informar o ambiete de emissão do MDF-e |
dtEnc | E | CC03 | Date | 1-1 | 10 | - | Data do encerramento do MDF-e. |
cUF | E | CC03 | String | 1 | 02 | - | Sigla da UF. |
cMun | E | CC03 | Num | 1 | 07 | - | Código do município. |
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>
MODELO DO XML de evento
Campo | Ele | Pai | Tipo | Ocor | Tam. | Dec. |
detEvento | G | - | E | - | - | Informações do Evento (estrutura XML variável, depende do tipo de evento) |
tpEvento | A | CC03 | Num | 1-1 | 6 | Tipo de Evento Informar : 110114 |
chNFe | N | CC03 | Num | 1-1 | 44 | Chave de Acesso do MDF-e. |
ambiente | E | CC03 | Num | 1-1 | 1 | Ambiente de Transmissão: 1 – Homologação;2 - Produção |
nomecondutor | A | CC03 | Alfa | 1-1 | 1-60 | Nome do Condutor |
cpfcondutor | A | CC03 | Num | 1-1 | 1-11 | CPF do Condutor |
Exemplo de XML o evento Inclusão de Condutor
<envEvento>
<eventos>
<detEvento>
<tpEvento>110114</tpEvento>
<chnfe></chnfe>
<ambiente></ambiente>
<nomecondutor></nomecondutor>
<cpfcondutor></cpfcondutor>
</detEvento>
<detEvento>
<tpEvento>110114</tpEvento>
<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. |
---|