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 dos Web 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 | 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 |
| VERSAOGERALGTV | CFGEPECCTE | A | 1-4 | 0-1 | Versão do leiaute geral do evento Informações da GTV |
| VERSAOEVENGTV | CFGEPECCTE | A | 1-4 | 0-1 | Versão do leiaute específico do evento Informações da GTV |
| VERSAOGERALDESAC | CFGEPECCTE | A | 1-4 | 0-1 | Versão do leiaute geral do evento Prestação do Serviço em Desacordo |
| VERSAOEVENDESAC | CFGEPECCTE | A | 1-4 | 0-1 | Versão do leiaute específico do evento Prestação do Serviço em Desacordo |
| 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 |
Os parâmetros de saída do método são:
<CFGEPECRESULT>
<SEQLOTEEPEC>INTEGER</SEQLOTEEPEC>
<VERSAOEVENCANC>STRING</VERSAOEVENCANC>
<VERSAOEVENCCE>STRING</VERSAOEVENCCE>
<VERSAOEVENEPEC>STRING</VERSAOEVENEPEC>
<VERSAOEVENMULT>STRING</VERSAOEVENMULT>
<VERSAOGERALCANC>STRING</VERSAOGERALCANC>
<VERSAOGERALCCE>STRING</VERSAOGERALCCE>
<VERSAOGERALEPEC>STRING</VERSAOGERALEPEC>
<VERSAOGERALMULT>STRING</VERSAOGERALMULT>
<VERSAOGERALGTV>STRING</VERSAOGERALGTV>
<VERSAOEVENGTV>STRING</VERSAOEVENGTV>
<VERSAOGERALDESAC>STRING</VERSAOGERALDESAC>
<VERSAOEVENDESAC>STRING</VERSAOEVENDESAC>
<CTECANCEVENTO>STRING</CTECANCEVENTO>
</CFGEEPECRESULT>
| Nome | Pai | Tipo | Tam. | Ocor. | Observações |
|---|---|---|---|---|---|
| CFGEPECRESULT | CFGEPECCTERESPONSE | - | - | 1-1 | Tag raiz do retorno |
| CTECANCEVENTO | CFGEPECRESULT | A | 2 | 1-1 | Indica se o cancelamento será realizado por evento ou não. Os valores possíveis são:
|
| SEQLOTEEPEC | CFGEPECRESULT | N | - | 0-1 | Número sequencial do lote. |
| VERSAOEVENCANC | CFGEPECRESULT | A | 1-4 | 0-1 | Versão do leiaute específico do evento Cancelamento |
| VERSAOEVENCCE | CFGEPECRESULT | A | 1-4 | 0-1 | Versão do leiaute específico do evento Carta de Correção |
| VERSAOEVENEPEC | CFGEPECRESULT | A | 1-4 | 0-1 | Versão do leiaute específico do evento EPEC |
| VERSAOEVENMULT | CFGEPECRESULT | A | 1-4 | 0-1 | Versão do leiaute específico do evento Registro do Multimodal |
| VERSAOGERALCANC | CFGEPECRESULT | A | 1-4 | 0-1 | Versão do leiaute geral do evento Cancelamento |
| VERSAOGERALCCE | CFGEPECRESULT | A | 1-4 | 0-1 | Versão do leiaute geral do evento Carta de Correção |
| VERSAOGERALEPEC | CFGEPECRESULT | A | 1-4 | 0-1 | Versão do leiaute geral do evento EPEC |
| VERSAOGERALMULT | CFGEPECRESULT | A | 1-4 | 0-1 | Versão do leiaute geral do evento Registro do Multimodal |
| VERSAOGERALGTV | CFGEPECRESULT | A | 1-4 | 0-1 | Versão do leiaute geral do evento Informações da GTV |
| VERSAOEVENGTV | CFGEPECRESULT | A | 1-4 | 0-1 | Versão do leiaute específico do evento Informações da GTV |
| VERSAOGERALDESAC | CFGEPECRESULT | A | 1-4 | 0-1 | Versão do leiaute geral do evento Prestação do Serviço em Desacordo |
| VERSAOEVENDESAC | CFGEPECRESULT | A | 1-4 | 0-1 | Versão do leiaute específico do evento Prestação do Serviço em Desacordo |
Soap Fault
| Fault | Observações |
|---|---|
| Invalid Token | O parâmetro USERTOKEN foi informado incorretamente. |
| 001 | Código de entidade inválida. |
| 002 | Código de entidade em branco. |
| 003 | Versão do leiaute geral do evento EPEC inválida. |
| 004 | Versão do leiaute específico do evento EPEC inválida. |
| 005 | Versão do leiaute geral do evento de Cancelamento inválida. |
| 006 | Versão do leiaute específico do evento de Cancelamento inválida. |
| 007 | Versão do leiaute geral do evento de Carta de Correção inválida. |
| 008 | Versão do leiaute específico do evento de Carta de Correção inválida. |
| 009 | Versão do leiaute geral do evento de Registro do Multimodal inválida. |
| 010 | Versão do leiaute específico do evento de Registro do Multimodal inválida. |
| 011 | Versão do leiaute geral do evento de Registro do Multimodal inválida. |
| 012 | Versão do leiaute geral do evento Informações da GTV inválida. |
| 013 | Versão do leiaute específico do evento Informações da GTV inválida. |
| 014 | Versão do leiaute geral do evento Prestação do Serviço em Desacordo inválida. |
| 015 | Versão do leiaute específico do evento Prestação do Serviço em Desacordo inválida. |
O objetivo deste método é informar ao TSS para qual versão deve converter o XML recebido do ERP. Caso a versão não seja informada o método irá retornar a lista de versões disponíveis. Caso a versão informada seja 0.00 o método irá retornar a versão configurada. Caso a versão informada seja 9.99 o método não ira configurar a versão.
Os parâmetros de entrada do método são:
<soap:Body>
<USERTOKEN>STRING</USERTOKEN>
<ID_ENT>STRING</ID_ENT>
<VERSAO>STRING</VERSAO>
</soap:Body>
Nome | Pai | Tipo | Tam. | Ocor. | Observações |
|---|---|---|---|---|---|
CFGVERSAOCTE |
|
|
|
| Tag raiz da requisição |
USERTOKEN | CFGVERSAOCTE | A | 5 | 1-1 | Deverá ser preenchido com o valor “TOTVS”. |
ID_ENT | CFGVERSAOCTE | A | 6 | 1-1 | ID da entidade a ser utilizada. |
VERSAO | CFGVERSAOCTE | A | 1-4 | 1-1 | Informe branco para saber as versões admitidas pelo Totvs Service Soa separadas por pipe ‘|’, ‘0.00’ para saber a versão configurada atualmente ou uma versão valida para que o parâmetro seja alterado. Versões possíveis: 2.00|3.00 |
Os parâmetros de saída do método são:
<soap:Body>
<CFGVERSAOCTERESPONSE>
<CFGVERSAOCTERESULT>STRING</CFGVERSAOCTERESULT>
</CFGVERSAOCTERESPONSE>
</soap:Body>
Nome | Pai | Tipo | Tam. | Ocor. | Observações |
|---|---|---|---|---|---|
CFGVERSAOCTERESPONSE | - | - | - | 1-1 | Tag raíz do retorno. |
CFGVERSAOCTERESULT | CFGVERSAOCTERESPONSE | A | 1-250 | 0-1 | Retorna vazio caso o parâmetro seja configurado corretamente. Se passado em branco retorna as possíveis versões de configuração: 9.99|2.00|3.00 |
Soap Fault
| Fault | Observações |
|---|---|
| Invalid Token | O parâmetro USERTOKEN foi passado incorretamente. |
| 001 | Código de entidade inválida. |
| 002 | Código de entidade em branco. |
| 003 | Versão incorreta. |
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, CT-e OS e MDF-e com o ERP. Este número será sempre informado ou solicitado pelo TOTVS Services Sped para fornecer informações sobre o status atual da NF-e, CT-e, CT-e OS e MDF-e. É recomendado para o ERP enviar o número da chave de acesso da NF-e, CTe,, CT-e OS 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. CT-e OS 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 Services 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, CT-e OS e MDF-e que foram aceitas pelo serviço. |
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
|---|