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 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., 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 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>
<HORAVERAOMDFE>STRING</HORAVERAOMDFE>
< HORARIOMDFE >STRING</ 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 |
HORAVERAOMDFE | Alfanumérico | 1 | 1-1 | Identificação de Horário de Verão: 1-Sim ou 2-Não |
HORARIOMDFE | 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>
< HORARIOMDFE >STRING</ HORARIOMDFE >
<HORAVERAOMDFE>STRING</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. |
HORARIOMDFE | CFGMDFERESULT | - | A | 1-1 | Horário inválido. Valores válidos: |
HORAVERAOMDFE | 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
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>
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>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: |
HORAVERAOCCE | 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: 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 |
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):
Tipo de Evento | Modelo de MDFe | Descrição Evento | Tipo de Autor do Evento | Local Evento |
---|---|---|---|---|
110111 | 55 e 57 | Evento de Cancelamento do MDF-e. | Emitente | Sefaz Autorizadora |
110112 | 55 e 57 | Evento de Encerramento do MDF-e. | Emitente | Sefaz Autorizadora |
110114 | 55 e 57 | Evento de Inclusão de Condutor do MDF-e. | Emitente | Sefaz Autorizadora |
MODELO DO XML de evento
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.
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>
Nome | Pai | Tipo | Tam. | Ocor. | Observações |
---|---|---|---|---|---|
CONFIGURARPARAMETROS | - | - | - | 1-1 | Tag raiz. |
USERTOKEN | CONFIGURARPARAMETROS | A | 5 | 1-1 | Deverá ser preenchido com o valor “TOTVS”. |
ID_ENT | CONFIGURARPARAMETROS | A | 6 | 1-1 | ID da entidade a ser utilizada. |
AMBIENTE | CONFIGURARPARAMETROS | A | 1 | 0-1 | Ambiente utilizado na sincronização de documentos. Os valores possíveis são: 1 – Produção; 2 –Homologação. |
VERSAO | CONFIGURARPARAMETROS | A | 4 | 0-1 | Versão utilizada na sincronização de documentos. Os valores possíveis são: 1.00 - NF-e / MDF-e |
ULTNSU | CONFIGURARPARAMETROS | A | 15 | 0-1 | Ultimo NSU da sincronização de documentos. |
MODELO | CONFIGURARPARAMETROS | A | 2 | 0-1 | Modelo de documento utilizado na sincronização do documento. Os valores possíveis são: 55- NF-e; 58 – MDF-e. Caso não seja informado, será utilizado o valor “55” como padrão, realizando assim a configuração da Manifestação do Destinatário – MD-e. |
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>
Nome | Pai | Tipo | Tam. | Ocor. | Observações |
---|---|---|---|---|---|
CONFIGURARPARAMETROSRESULT | - | - | - | 1-1 | Tag raiz. |
AMBIENTE | CONFIGURARPARAMETROSRESULT | A | 1 | 1-1 | Ambiente utilizado na sincronização de documentos. Os valores possíveis são: 1 – Produção; 2 – Homologação. |
ID_ENT | CONFIGURARPARAMETROSRESULT | A | 6 | 1-1 | ID da entidade a ser utilizada. |
VERSAO | CONFIGURARPARAMETROSRESULT | A | 4 | 1-1 | Versão utilizada na sincronização de documentos. |
ULTNSU | CONFIGURARPARAMETROSRESULT | A | 15 | 0-1 | Ultimo NSU da sincronização de documentos |
MODELO | CONFIGURARPARAMETROSRESULT | A | 2 | 0-1 | Modelo de documento configurado utilizado na sincronização do documento 58 – MDF-e. 55 - NF-e. |
Soap Fault
Fault | Observações |
---|---|
Invalid Token | O parâmetro USERTOKEN foi passado incorretamente. |
001 | Código de entidade inválido. |
002 | Código de entidade em branco. |
003 | Falha no processamento do método. |
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>
Nome | Pai | Tipo | Tam. | Ocor. | Observações |
---|---|---|---|---|---|
SINCRONIZARDOCUMENTOS | - | - | - | 1-1 | Tag raiz. |
USERTOKEN | SINCRONIZARDOCUMENTOS | A | 5 | 1-1 | Deverá ser preenchido com o valor “TOTVS”. |
ID_ENT | SINCRONIZARDOCUMENTOS | A | 6 | 1-1 | ID da entidade a ser utilizada. |
INDNFE | SINCRONIZARDOCUMENTOS | A | 1 | 0-1 | Indicação para quais NF-e sincronizar. Os valores possíveis são: 0 – Todas as NF-e; 1 – Somente as NF-e que ainda não tiveram manifestação do destinatário; 2 – Idem opção 1 incluindo também as NF-e que não tiveram Ciência da Operação declarada. Caso não seja informado, será utilizado o valor “0” como padrão. Para modelo 58, parâmetro será desconsiderado. |
INDEMI | SINCRONIZARDOCUMENTOS | A | 1 | 0-1 | Indicação para quais emitentes buscar as NF-e para sincronizar. Os valores possíveis são: 0 – Todos os emitentes; 1 – Apenas emitentes aonde a raiz do CNPJ seja diferente do destinatário (evitando transferências entre filiais). Caso não seja informado, será utilizado o valor “0” como padrão. Para modelo 58, parâmetro será desconsiderado |
MODELO | SINCRONIZARDOCUMENTOS | A | 2 | 0-1 | Modelo de documento a ser sincronizado. 58 – MDF-e. 55- NF-e. Caso não seja informado, será utilizado o valor “55” como padrão, realizando assim a sincronização da Manifestação do Destinatário – MD-e. |
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>
Nome | Pai | Tipo | Tam. | Ocor. | Observações |
---|---|---|---|---|---|
SINCRONIZARDOCUMENTOSRESULT | - | - | - | 1-1 | Tag raiz |
AMBIENTE | SINCRONIZARDOCUMENTOSRESULT | A | 2 | 1-1 | Identificação do Ambiente consultado: 1 - Produção; 2 - Homologação |
DOCUMENTOS | SINCRONIZARDOCUMENTOSRESULT | - | - | 0-1 | Tag raiz para os documentos sincronizados. |
SINCDOCUMENTOSINFO | DOCUMENTOS | - | - | 0-N | Tag raíz para as informações de um documento sincronizado |
CANCNSU | SINCDOCUMENTOSINFO | A | 15 | 0-1 | NSU de cancelamento. |
CHAVE | SINCDOCUMENTOSINFO | A | 44 | 1-1 | Chave de acesso do documento sincronizado. |
SITCONF | SINCDOCUMENTOSINFO | A | 1 | 1-1 | Código da situação da confirmação da manifestação do documento. Os valores possíveis são: 0 – Sem manifestação do destinatário; 1 – Confirmada operação; 2 – Desconhecida; 3 – Operação não realizada; 4 – Ciência. Para modelo 58, parâmetro sempre retornará 0 |
CODEVENTO | SINCDOCUMENTOSINFO | A | 6 | 1-1 | Tipo do Evento. |
IDENT | SINCRONIZARDOCUMENTOSRESULT | A | 6 | 1-1 | ID da Entidade utilizada. |
INDCONT | SINCRONIZARDOCUMENTOSRESULT | A | 1-4 | 0-1 | Indicador de continuação: 0 - SEFAZ não possui mais documentos para o CNPJ informado; 1 - SEFAZ possui mais documentos para o CNPJ informado, ou ainda não avaliou a totalidade da sua base de dados. |
Soap Fault
Fault | Observações |
---|---|
Invalid Token | O parâmetro USERTOKEN foi passado incorretamente. |
001 | Código de entidade inválido. |
002 | Código de entidade em branco. |
003 | Falha no processamento do método. |
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>
Nome | Pai | Tipo | Tam. | Ocor. | Observações |
---|---|---|---|---|---|
RETORNARDOCUMENTO | - | - | - | 1-1 | Tag raiz. |
USERTOKEN | RETORNARDOCUMENTO | A | 5 | 1-1 | Deverá ser preenchido com o valor “TOTVS”. |
ID_ENT | RETORNARDOCUMENTO | A | 6 | 1-1 | ID da entidade a ser utilizada. |
AMBIENTE | RETORNARDOCUMENTO | A | 1 | 0-1 | Ambiente a ser pesquisado. Os valores possíveis são: 1 – Produção; 2 – Homologação. |
CHAVE | RETORNARDOCUMENTO | A | 44 | 1-1 | Chave do Documento a ser retornado. |
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>
Nome | Pai | Tipo | Tam. | Ocor. | Observações | |||||
---|---|---|---|---|---|---|---|---|---|---|
REMESSA | - | - | - | 1-1 | Tag raiz. | |||||
USERTOKEN | RETORNARDOCUMENTORESULTREMESSA | A | 5 | 1-1 | Deverá ser preenchido com o valor “TOTVS”. | |||||
ID_ENT | RETORNARDOCUMENTORESULTREMESSA | A6 | 1-1 | ID da entidade a ser utilizada. | ||||||
NFE | RETORNARDOCUMENTORESULTREMESSA | A- | 1- | 0- | 1Ambiente a ser pesquisado. Os valores possíveis são: 1 – Produção; 2 – Homologação. | Estrutura | ||||
NOTAS | NFE | DOCUMENTO | RETORNARDOCUMENTORESULT | - | - | 0- | 1Tag raiz para as informações do documento pesquisado. | CANCELAMENTO | DOCUMENTOEstrutura | |
NFES | NOTAS | - | - | 0- | 1Tag raiz para as informações de cancelamento do documento. | CANCNSU | CANCELAMENTOEstrutura | |||
ID | NFES | A | 151-250 | 01-1 | NSU do cancelamento. | |||||
CANCXMLRET | CANCELAMENTO | BASE64BINARY | - | 0-1 | XML de retorno da SEFAZ apenas para o cancelamento. | |||||
DATAUTORIZACAO | CANCELAMENTO | A | 10 | 0-1 | Data de autorização do cancelamento. Formato – AAAA-MM-DD | |||||
DATAEMISSAO | CANCELAMENTO | A | 10 | 0-1 | Data de emissão do cancelamento. Formato – AAAA-MM-DD | |||||
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 | CCE | DOCUMENTO | -- | 0-1 | Tag raiz para as informações da carta de correção eletrônica do documento. | ||||
CCENSU | CCE | A | 15 | 0-1 | NSU da carta de correção eletrônica. | |||||
CCEXMLRET | CCE | BASE64BINARY | - | 0-1 | XML de retorno da SEFAZ apenas para a CC-e. | |||||
CORRECAO | CCE | A | 1000 | 0-1 | Correção da CC-e. | |||||
DATAAUTORIZACAO | CCE | A | 10 | 0-1 | Data da autorização da CC-e. Formato – AAAA-MM-DD | |||||
DATAEMISSAO | CCE | A | 10 | 0-1 | Data de emissão da CC-e. Formato – AAAA-MM-DD | |||||
HORAEMISSAO | CCE | A | 8 | 0-1 | Horário de emissão da CC-e. Formato – HH:MM:SS | |||||
TZD | CCE | A | 6 | 0-1 | TZD do horário de emissão da CC-e. | |||||
CHAVE | DOCUMENTO | A | 44 | 0-1 | Chave do documento. | |||||
CONDUTOR | DOCUMENTO | - | - | 0-1 | Tag raiz para as informações do último evento de inclusão de condutor (MDF-e). IMPORTANTE: As informações serão retornadas com base no último evento de inclusão de condutor autorizado. | |||||
CONDNSU | CONDUTOR | A | 15 | 0-1 | NSU do evento de inclusão de condutor. | |||||
CONDXMLRET | CONDUTOR | BASE64BINARY | - | 0-1 | XML de retorno da SEFAZ apenas para a Inclusão de Condutor | |||||
CPF | CONDUTOR | A | 11 | 0-1 | CPF do condutor do veículo. | |||||
DTHRAUTORIZACAO | CONDUTOR | A | 19 | 0-1 | Data e hora da autorização do evento de Inclusão de Condutor. Formato – AAAA-MM-DDTHH:MM:SS | |||||
DTHREMISSAO | CONDUTOR | A | 19 | 0-1 | Data e hora da emissão do evento de Inclusão de Condutor. Formato – AAAA-MM-DDTHH:MM:SS | |||||
NOME | CONDUTOR | A | 60 | 0-1 | Nome do condutor do veículo. | |||||
DATAAUTORIZACAO | DOCUMENTO | A | 10 | 0-1 | Data de autorização do documento. Formato – AAAA-MM-DD | |||||
DATAEMISSAO | DOCUMENTO | A | 10 | 0-1 | Data de emissão do documento. Formato – AAAA-MM-DD | |||||
EMITENTE | DOCUMENTO | - | - | 0-1 | Tag raiz para as informações do emitente do documento. | |||||
CNPJ | EMITENTE | A | 14 | 0-1 | CNPJ do emitente do documento. | |||||
CPF | EMITENTE | A | 11 | 0-1 | CPF do emitente do documento. | |||||
IE | EMITENTE | A | 14 | 0-1 | Inscrição Estadual do emitente do documento. | |||||
NOME | EMITENTE | A | 60 | 0-1 | Nome / Razão Social do emitente do documento. | |||||
ENCERRAMENTO | DOCUMENTO | - | - | 0-1 | Tag raiz para as informações do evento de encerramento (MDF-e). | |||||
ENCNSU | ENCERRAMENTO | A | 15 | 0-1 | NSU do evento de encerramento. | |||||
ENCXMLRET | ENCERRAMENTO | BASE64BINARY | - | 0-1 | XML de retorno da SEFAZ apenas para o encerramento. | |||||
CODIGOIBGE | ENCERRAMENTO | A | 7 | 0-1 | Código do município onde ocorreu o encerramento. | |||||
DTHRAUTORIZACAO | ENCERRAMENTO | A | 19 | 0-1 | Data e hora da autorização do evento de encerramento. Formato – AAAA-MM-DDTHH:MM:SS | |||||
DTHREMISSAO | ENCERRAMENTO | A | 19 | 0-1 | Data e hora da emissão do evento de encerramento. Formato – AAAA-MM-DDTHH:MM:SS | |||||
ENCDTENC | ENCERRAMENTO | A | 10 | 0-1 | Data em que o MDF-e foi encerrado. Formato – AAAA-MM-DD | |||||
NSU | DOCUMENTO | A | 15 | 0-1 | NSU do documento. | |||||
RESPOSTA | DOCUMENTO | - | - | 0-1 | Tag raiz para as informações de resposta da SEFAZ no momento da sincronização do documento. | |||||
DESCRICAO | RESPOSTA | A | 255 | 0-1 | Descrição do status de resposta da SEFAZ. | |||||
STATUS | RESPOSTA | A | 3 | 0-1 | Código de status de resposta da SEFAZ. | |||||
SITUACAO | DOCUMENTO | A | 1 | 0-1 | Código de situação do documento. Os valores possíveis são: 1 – Uso autorizado no momento da consulta; 2 – Uso denegado (Para NF-e); 3 – NF-e/MDF-e cancelada; 4- MDF-e Encerrado. | |||||
SITUACAOCONFIRMACAO | DOCUMENTO | A | 1 | 0-1 | Código da situação da confirmação da manifestação do destinatário. Os valores possíveis são: 0 – Sem manifestação do destinatário; 1 – Confirmada operação; 2 – Desconhecida; 3 – Operação não realizada; 4 – Ciência. Para modelo 58, parâmetro sempre retornará 0. | |||||
TIPOOPERACAO | DOCUMENTO | A | 1 | 0-1 | Tipo da operação do documento. Os valores possíveis são: 0 – Entrada; 1 – Saída. Para modelo 58, parâmetro sempre retornará 1. | |||||
VALORTOTAL | DOCUMENTO | N | 15,2 | 0-1 | Valor total do documento. | |||||
XMLSEFAZ | DOCUMENTO | BASE64BINARY | - | 0-1 | XML de retorno da SEFAZ apenas para o documento. | |||||
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>
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>
TABELA SPED156 - MANIFESTAÇÃO DO DESTINATÁRIO.
Campo | ENCDTHREMI |
Tipo | C |
Tamanho | 25 |
Descrição | Data e hora de emissão do evento de encerramento. |
Campo | ENCDTHRAUT |
Tipo | C |
Tamanho | 25 |
Descrição | Data e hora de autorização do evento de encerramento. |
Campo | ENCNSU |
Tipo | C |
Tamanho | 15 |
Descrição | NSU do encerramento. |
Campo | ENCXMLRET |
Tipo | M |
Tamanho | 10 |
Descrição | XML do encerramento. |
Campo | ENCCODMUN |
Tipo | C |
Tamanho | 7 |
Descrição | Código do município do IBGE onde ocorreu o encerramento. |
Campo | ENCDTENC |
Tipo | C |
Tamanho | 10 |
Descrição | Data em que o MDF-e foi encerrado. |
Campo | CONDTHREMI |
Tipo | C |
Tamanho | 25 |
Descrição | Data e hora de emissão do evento de inclusão de condutor. |
Campo | CONDTHRAUT |
Tipo | C |
Tamanho | 25 |
Descrição | Data e hora de autorização do evento de inclusão de condutor. |
Campo | CONDNSU |
Tipo | C |
Tamanho | 15 |
Descrição | NSU da inclusão de condutor. |
Campo | CONDCPF |
Tipo | C |
Tamanho | 11 |
Descrição | CPF do condutor do veículo. |
Campo | CONDNOME |
Tipo | C |
Tamanho | 60 |
Descrição | Nome do condutor do veículo. |
Campo | CONDXMLRET |
Tipo | M |
Tamanho | 10 |
Descrição | XML da inclusão de condutor. |
Campo
MODELO
Tipo
C
Tamanho
2
Descrição
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|