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 | CT-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 dos Estados e os sistemas de informações das empresas emissoras de Conhecimento de Transportes Eletrônicos - CT-e.
Identificação e vigência do Manual:
A versão 3.00 introduz novas possibilidades de emissão do Conhecimento de Transporte para outros serviços, visando substituir a Nota Fiscal de Serviço de Transporte modelo 7 no que se refere aos serviços que não envolvem o transporte de cargas, a saber:
Na primeira versão, o novo documento modelo 67 será desenvolvido para atender exclusivamente as prestações de serviço de Transporte de Pessoas, com a possibilidade de ser expandido futuramente para os outros serviços através de revisão do Manual ou Notas Técnicas.
A SEFAZ disponibilizou um novo Web Service de Recepção CT-e Outros Serviços (modelo 67) dedicado à autorização síncrona desse novo CT-e.
O modelo 67 utilizará os mesmos Web Services do modelo 57 para suprir os demais serviços essenciais para o contribuinte:
O Web Service de retorno de recepção não será necessário ao modelo 67 uma vez que o mesmo deverá responder de forma síncrona em uma conexão, para tal, o lote CT-e Outros Serviços deverá conter apenas um documento por vez, documento este que será enviado também através do método REMESSA do Web Service NFESBRA.
Para contemplar os dois modelos de CT-e previstos (57 e 67), o sistema de registro de eventos da SEFAZ Autorizadora deverá identificar na chave de acesso do CT-e o modelo indicado e aplicar as regras conforme o estabelecido para cada um caso haja alguma diferença específica para os eventos comuns aos dois documentos.
Existe a possibilidade de ocorrerem eventos específicos para um modelo e para outros não e também a possibilidade de ambos utilizarem o mesmo tipo de evento, como no caso do evento de Cancelamento.
Observe no quadro abaixo a aplicação do evento conforme o modelo de CT-e:
Tipo de Evento | Modelo de CT-e | Descrição Evento | Tipo de Autor do Evento | Local Evento | CT-e deve existir? |
---|---|---|---|---|---|
110110 | 57 e 67 | Carta de Correção | Emitente | Sefaz Autorizadora | Sim |
110111 | 57 e 67 | Cancelamento | Emitente | Sefaz Autorizadora | Sim |
110113 | 57 | EPEC | Emitente | SVC | Não |
110160 | 57 | Registro do Multimodal | Emitente | Sefaz Autorizadora | Sim |
110170 | 67 | Informações da GTV *NOVO | Emitente | Sefaz Autorizadora | Sim |
610110 | 57 e 67 | Prestação do Serviço em Desacordo *NOVO | Tomador | Sefaz Autorizadora | Sim |
110170 - Evento Informações da GTV
610110 - Evento Prestação de Serviço em Desacordo
O CT-e sofreu alterações em seu leiaute.
Consulte o Manual de Orientações do Contribuinte - Versão 3.00 - 08/09/2016 (PDF) para verificação das alterações do modelo 57 e a estrutura do novo modelo 67.
É imprescindível a leitura completa deste MOC para entendimento das alterações pertinentes à versão 3.00
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):
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
Configura e retorna os parâmetros para a manifestação do destinatário.
Os parâmetros de entrada do método são:
Services abaixo:
Os parâmetros de entrada do método são:
<soap:Body>
<USERTOKEN>STRING</USERTOKEN>
<ID_ENT>STRING</ID_ENT>
<VERSAOGERALEPEC>STRING</VERSAOGERALEPEC>
<VERSAOEVENEPEC>STRING</VERSAOEVENEPEC>
<VERSAOGERALCANC>STRING</VERSAOGERALCANC>
<VERSAOEVENCANC>STRING</VERSAOEVENCANC>
<VERSAOGERALCCE>STRING</VERSAOGERALCCE>
<VERSAOEVENCCE>STRING</VERSAOEVENCCE>
<VERSAOGERALMULT>STRING</VERSAOGERALMULT>
<VERSAOEVENMULT>STRING</VERSAOEVENMULT>
<VERSAOGERALGTV>STRING</VERSAOGERALGTV>
<VERSAOEVENGTV>STRING</VERSAOEVENGTV>
<VERSAOGERALDESAC>STRING</VERSAOGERALDESAC>
<VERSAOEVENDESAC>STRING</VERSAOEVENDESAC>
<SEQLOTEEPEC>INTEGER</SEQLOTEEPEC>
<CTECANCEVENTO>BOOLEAN</CTECANCEVENTO>
</soap:Body>
Nome | Pai | Tipo | Tam. | Ocor. | Observações |
---|---|---|---|---|---|
CFGEPECCTE | - | - | - | 1-1 | Tag raiz. |
USERTOKEN | CFGEPECCTE | A | 5 | 1-1 | Deverá ser preenchido com o valor “TOTVS”. |
ID_ENT | CFGEPECCTE | A | 6 | 1-1 | |
VERSAOGERALEPEC | CFGEPECCTE | A | 1-4 | 1-1 | |
VERSAOEVENEPEC | CFGEPECCTE | A | 1-4 | 1-1 | |
VERSAOGERALCANC | CFGEPECCTE | A | 1-4 | 1-1 | |
VERSAOEVENCANC | CFGEPECCTE | A | 1-4 | 1-1 | |
VERSAOGERALCCE | CFGEPECCTE | A | 1-4 | 1-1 | |
VERSAOEVENCCE | CFGEPECCTE | A | 1-4 | 1-1 | |
VERSAOGERALMULT | CFGEPECCTE | A | 1-4 | 0-1 | |
VERSAOEVENMULT | CFGEPECCTE | A | 1-4 | 0-1 | |
VERSAOGERALGTV | CFGEPECCTE | A | 1-4 | 0-1 | |
VERSAOEVENGTV | CFGEPECCTE | A | 1-4 | 0-1 | |
VERSAOGERALDESAC | CFGEPECCTE | A | 1-4 | 0-1 | |
VERSAOEVENDESAC | CFGEPECCTE | A | 1-4 | 0-1 | |
SEQLOTEEPEC | CFGEPECCTE | N | -- | 0-1 | |
CTECANCEVENTO | CFGEPECCTE | L | -- | 1-1 |
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 | ||||
---|---|---|---|---|---|---|---|---|---|
CONFIGURARPARAMETROS | - | - | - | 1-1 | Tag raiz. | ||||
USERTOKEN | CONFIGURARPARAMETROS | A | 5 | 1-1 | Deverá ser preenchido com o valor “TOTVS”. | ||||
. | Ocor. | Observações | |||||||
CONFIGURARPARAMETROSRESULT | - | - | - | ID_ENT | CONFIGURARPARAMETROS | A | 6 | 1-1 | ID da entidade a ser utilizadaTag raiz. |
AMBIENTE | CONFIGURARPARAMETROSCONFIGURARPARAMETROSRESULT | A | 1 | 01-1 | Ambiente utilizado na sincronização de documentos. Os valores possíveis são: 1 – Produção; 2 –Homologação– Homologação. | ||||
ID_ENT | CONFIGURARPARAMETROSRESULT | A | 6 | 1-1 | ID da entidade a ser utilizada. | ||||
VERSAO | CONFIGURARPARAMETROSCONFIGURARPARAMETROSRESULT | A | 4 | 01-1 | Versão utilizada na sincronização de documentos. Os valores possíveis são: 1.00 - NF-e / MDF-esincronização de documentos. | ||||
ULTNSU | CONFIGURARPARAMETROSCONFIGURARPARAMETROSRESULT | A | 15 | 0-1 | Ultimo NSU da sincronização de documentos. | ||||
MODELO | CONFIGURARPARAMETROSCONFIGURARPARAMETROSRESULT | 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 saída entrada do método são:
<soap:Body>
<USERTOKEN>STRING</USERTOKEN>
<ID_ENT>STRING</ID_ENT><AMBIENTE>
<INDNFE>STRING</AMBIENTE>
INDNFE>
<VERSAO><INDEMI>STRING</VERSAO>
INDEMI>
<ULTNSU>STRING</ULTNSU>
<MODELO>STRING</MODELO>
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 | Ocor. | Observações | ||||
CONFIGURARPARAMETROSRESULT | - | - | - | 1-1 | Tag raiz. | ||
AMBIENTE | CONFIGURARPARAMETROSRESULT | A | 1 | 10-1 | Ambiente utilizado na sincronização de documentosIndicação para quais NF-e sincronizar. 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 | ||
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 | 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. |
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 entrada saída 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>
<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 | . | 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 | SINCRONIZARDOCUMENTOS | - | - | - | 10-1 | Tag raiz para os documentos sincronizados. | ||
USERTOKENSINCDOCUMENTOSINFO | SINCRONIZARDOCUMENTOSDOCUMENTOS | A- | 5 | 1-1 | Deverá ser preenchido com o valor “TOTVS”. | ||||
ID_ENT | SINCRONIZARDOCUMENTOS | A | 6 | 1-1 | ID da entidade a ser utilizada. | ||||
0-N | Tag raíz para as informações de um documento sincronizado | ||||||||
CANCNSU | SINCDOCUMENTOSINFO | A | 15 | INDNFE | SINCRONIZARDOCUMENTOS | A | 1 | 0-1 | NSU de cancelamento. |
CHAVE | SINCDOCUMENTOSINFO | A | 44 | 1-1 | Chave de acesso do documento sincronizado. | ||||
SITCONF | SINCDOCUMENTOSINFO | 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 | 01-1 | Indicação para quais emitentes buscar as NF-e para sincronizarCódigo da situação da confirmação da manifestação do documento. Os valores possíveis são: 0 – Todos os emitentesSem manifestação do destinatário; 1 – Apenas emitentes aonde a raiz do CNPJ seja diferente do destinatário (evitando transferências entre filiais).Confirmada operação; 2 – Desconhecida; 3 – Operação não realizada; 4 – CiênciaCaso não seja informado, será utilizado o valor “0” como padrão. Para modelo 58, parâmetro será desconsideradosempre 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 | 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>
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>
</SINCRONIZARDOCUMENTOSRESULT>
Nome | Pai | Tipo | Tam. | Ocor. | Observações |
---|---|---|---|---|---|
SINCRONIZARDOCUMENTOSRESULTRETORNARDOCUMENTO | - | - | - | 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 | SINCRONIZARDOCUMENTOSRESULTRETORNARDOCUMENTO | A | 21 | 10-1 | Ambiente a ser pesquisado. Os valores possíveis sãoIdentificação do Ambiente consultado: 1 - – Produção; 2 - – Homologação. |
DOCUMENTOSCHAVE | SINCRONIZARDOCUMENTOSRESULTRETORNARDOCUMENTO | -A- | 44 | 01-1 | Tag raiz para os documentos sincronizadosChave do Documento a ser retornado. |
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>
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> <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>
Tipo | Tam. | Ocor. | Observações | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
RETORNARDOCUMENTORESULT | - | - | - | 1-1 | Tag raiz. | ||||||||||||
USERTOKEN | RETORNARDOCUMENTORESULT | A | 5 | 1-1 | Deverá ser preenchido com o valor “TOTVS”. | ||||||||||||
ID_ENT | RETORNARDOCUMENTORESULT | A | 6 | 1-1 | ID da entidade a ser utilizada. | ||||||||||||
AMBIENTE | RETORNARDOCUMENTORESULT | A | 1 | 0-1 | Ambiente a ser pesquisado. Os valores possíveis são: 1 – Produção; 2 – Homologação. | ||||||||||||
DOCUMENTO | RETORNARDOCUMENTORESULT | - | - | 0-1 | Tag raiz para as informações do documento pesquisado. | ||||||||||||
CANCELAMENTO | DOCUMENTO | - | - | 0-1 | Tag raiz para as informações de cancelamento do documento. | ||||||||||||
CANCNSU | CANCELAMENTO | A | 15 | 0-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 | ||||||||||||
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 | |||||||||||||||||
Nome | Pai | Tipo | Tam. | Ocor. | Observações | ||||||||||||
RETORNARDOCUMENTORESULT | - | - | - | 1-1 | Tag raiz. | ||||||||||||
USERTOKEN | RETORNARDOCUMENTORESULT | A | 5 | 1-1 | Deverá ser preenchido com o valor “TOTVS”. | ||||||||||||
ID_ENT | RETORNARDOCUMENTORESULT | A | 6 | 1-1 | ID da entidade a ser utilizada. | ||||||||||||
AMBIENTE | RETORNARDOCUMENTORESULT | A | 1 | 0-1 | Ambiente a ser pesquisado. Os valores possíveis são: 1 – Produção; 2 – Homologação. | ||||||||||||
DOCUMENTO | RETORNARDOCUMENTORESULT | - | - | 0-1 | Tag raiz para as informações do documento pesquisado. | ||||||||||||
DOCUMENTO | - | - | 0-1 | Tag raiz para as informações | de cancelamento do documento.CANCNSU | CANCELAMENTOdo ú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 | cancelamentoevento de inclusão de condutor. | CANCXMLRET|||||||||||
CONDXMLRET | CANCELAMENTOCONDUTOR | BASE64BINARY | - | 0-1 | XML de retorno da SEFAZ apenas para | o cancelamento.DATAUTORIZACAO | CANCELAMENTOa Inclusão de Condutor | ||||||||||
CPF | CONDUTOR | A | 1011 | 0-1 | Data de autorização do cancelamento. Formato – AAAA-MM-DD | DATAEMISSAO | CPF do condutor do veículo. | ||||||||||
DTHRAUTORIZACAO | CONDUTOR | CANCELAMENTOA | 1019 | 0-1 | Data | de emissão do cancelamento.||||||||||||
CCE | DOCUMENTO | - | - | 0-1 | Tag raiz para as informações da carta de correção eletrônica do documento. | ||||||||||||
e hora da autorização do evento de Inclusão de Condutor. Formato – AAAA-MM-DDTHH:MM:SS | |||||||||||||||||
DTHREMISSAO | CONDUTOR | A | 19 | CCENSU | CCE | A | 150-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. | ||||||||||||
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 | DATAAUTORIZACAO | CCEA | 10 | 0-1 | Data | da autorização da CC-ede emissão do documento. Formato – AAAA | -MM-DDDATAEMISSAO | CCE-MM-DD | ||||||||
EMITENTE | DOCUMENTO | - | - | 0-1 | Tag raiz para as informações do emitente do documento. | ||||||||||||
CNPJ | EMITENTE | A | 1014 | 0-1 | Data de emissão da CC-e. Formato – AAAA-MM-DD | HORAEMISSAO | CCE | A | CNPJ do emitente do documento. | ||||||||
CPF | EMITENTE | A | 11 | 80-1 | Horário de emissão da CC-e. Formato – HH:MM:SS | TZD | CPF do emitente do documento. | ||||||||||
IE | EMITENTE | CCEA | 614 | 0-1 | TZD do horário de emissão da CC-e. | CHAVE | Inscrição Estadual do emitente do documento. | ||||||||||
NOME | EMITENTE | DOCUMENTOA | 4460 | 0-1 | ChaveNome / Razão Social do emitente do documento. | ||||||||||||
CONDUTORENCERRAMENTO | DOCUMENTO | - | - | 0-1 | Tag raiz para as informações do último evento de inclusão de condutor encerramento (MDF-e). IMPORTANTE: As informações serão retornadas com base no último evento de inclusão de condutor autorizado. | ||||||||||||
ENCNSU | ENCERRAMENTO | CONDNSU | CONDUTOR | A | 15 | 0-1 | NSU do evento de inclusão de condutorencerramento. | ||||||||||
CONDXMLRETENCXMLRET | CONDUTORENCERRAMENTO | BASE64BINARY | - | 0-1 | XML de retorno da SEFAZ apenas para a Inclusão de Condutoro encerramento. | ||||||||||||
CODIGOIBGE | ENCERRAMENTO | CPF | CONDUTOR | A | 117 | 0-1 | CPF do condutor do veículoCódigo do município onde ocorreu o encerramento. | ||||||||||
DTHRAUTORIZACAO | CONDUTORENCERRAMENTO | A | 19 | 0-1 | Data e hora da autorização do evento de Inclusão de Condutorencerramento. Formato Formato – AAAA-MM-DDTHH:MM:SS | ||||||||||||
DTHREMISSAO | CONDUTORENCERRAMENTO | A | 19 | 0-1 | Data e hora da emissão do evento de Inclusão de Condutorencerramento. 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 | ||||||||||||
:SS | |||||||||||||||||
ENCDTENC | ENCERRAMENTO | DATAEMISSAO | DOCUMENTO | A | 10 | 0-1 | Data de emissão do documentoem que o MDF-e foi encerrado. FormatoFormato – AAAA-MM-DD | ||||||||||
EMITENTENSU | DOCUMENTO | - | - | 0-1 | Tag raiz para as informações do emitente do documento. | CNPJ | EMITENTE | A | 1415 | 0-1 | CNPJ do emitente do documento. | CPF | EMITENTE | A | 11 | 0-1 | CPF do emitente NSU do documento. |
IERESPOSTA | EMITENTEDOCUMENTO | A- | 14- | 0-1 | Inscrição Estadual do emitente do Tag raiz para as informações de resposta da SEFAZ no momento da sincronização do documento. | ||||||||||||
NOMEDESCRICAO | EMITENTERESPOSTA | A | 60255 | 0-1 | Nome / Razão Social do emitente do documento. | Descrição do status de resposta da SEFAZ. | |||||||||||
STATUS | RESPOSTA | A | 3 | ENCERRAMENTO | DOCUMENTO | - | - | 0-1 | Tag raiz para as informações do evento de encerramento (MDF-e). | ENCNSU | Código de status de resposta da SEFAZ. | ||||||
SITUACAO | DOCUMENTOENCERRAMENTO | A | 151 | 0-1 | NSU do evento de encerramento. | ||||||||||||
ENCXMLRET | ENCERRAMENTO | BASE64BINARY | - | 0-1 | XML de retorno da SEFAZ apenas para o encerramento. | ||||||||||||
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 | CODIGOIBGE | ENCERRAMENTO | A | 7 | 0-1 | Código do município onde ocorreu o encerramento.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 | DTHRAUTORIZACAO | ENCERRAMENTO | A | 19 | 0-1 | Data e hora Tipo da autorização operação do evento de encerramento. Formato – AAAA-MM-DDTHH:MM:SS | DTHREMISSAO | ENCERRAMENTO | A | documento. Os valores possíveis são: 0 – Entrada; 1 – Saída. Para modelo 58, parâmetro sempre retornará 1. | ||||
VALORTOTAL | DOCUMENTO | N | 15,219 | 0-1 | Data e hora da emissão do evento de encerramento. Formato – AAAA-MM-DDTHH:MM:SS | ENCDTENC | ENCERRAMENTO | A | Valor total do documento. | ||||||||
XMLSEFAZ | DOCUMENTO | BASE64BINARY | -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.|||||||
XML de retorno da SEFAZ apenas para o documento. |
CFGEPECCTE | - | - | - | 1-1 | Tag raíz. |
USERTOKEN | CFGEPECCTE | A | 5 | 1-1 | Deverá ser preenchido com o valor “TOTVS”. |
ID_ENT | CFGEPECCTE | A | 6 | 1-1 | ID da entidade a ser utilizada. |
VERSAOGERALEPEC | CFGEPECCTE | A | 1-4 | 1-1 | Versão do leiaute geral do evento EPEC |
VERSAOEVENEPEC | CFGEPECCTE | A | 1-4 | 1-1 | Versão do leiaute específico do evento EPEC |
VERSAOGERALCANC | CFGEPECCTE | A | 1-4 | 1-1 | Versão do leiaute geral do evento Cancelamento |
VERSAOEVENCANC | CFGEPECCTE | A | 1-4 | 1-1 | Versão do leiaute específico do evento de Cancelamento |
VERSAOGERALCCE | CFGEPECCTE | A | 1-4 | 1-1 | Versão do leiaute geral do evento Carta de Correção |
VERSAOEVENCCE | CFGEPECCTE | A | 1-4 | 1-1 | Versão do leiaute específico do evento Carta de Correção |
VERSAOGERALMULT | CFGEPECCTE | A | 1-4 | 0-1 | Versão do leiaute geral do evento Registro do Multimodal |
VERSAOEVENMULT | CFGEPECCTE | A | 1-4 | 0-1 | Versão do leiaute específico do evento Registro do Multimodal |
SEQLOTEEPEC | CFGEPECCTE | N | -- | 0-1 | Número sequencial do lote. |
CTECANCEVENTO | CFGEPECCTE | L |
| 1-1 | Indica se o cancelamento será realizado por evento ou não. Os valores possíveis são: - TRUE para sim - FALSE para não |
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 | Modelo do documento sincronizado. |
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|