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	CT-e
Segmento Executor	Serviços
Chamado/ISSUE	TWAM63 / MSERV-3320
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 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:

Data de início da vigência no ambiente de homologação (modelo 57) - 03/10/2016
Data de início da vigência no ambiente de homologação (modelo 67) - 12/12/2016
Data de início da vigência no ambiente de produção (modelo 57) - 12/12/2016
Data de início da vigência no ambiente de produção (modelo 67) - 03/04/2017
Data final da vigência da versão 2.00 - 04/12/2017

Definição da Regra de Negócio

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:

Transporte de Pessoas;
Transporte de Valores;
Excesso de Bagagem

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.

Serviços Compartilhados - Modelo 57 e Modelo 67

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:

Consulta Situação;
Inutilização numérica;
Recepção de Eventos;
Consulta Status Serviço.

No entanto, será disponibilizado um JOB específico para execução do modelo 67.

[CTEOS_WF]
main=CTEOSWF
environment=SPED

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 REMESSA3 do Web Service NFESBRA.

Eventos

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

Evento para que o emitente do CT-e OS do tipo serviço Transporte de Valores possa informar as GTV relacionadas com a prestação do serviço.

610110 - Evento Prestação de Serviço em Desacordo

Evento para que o tomador possa informar ao fisco que o documento CT-e que o relaciona está em desacordo com a prestação de serviço.

Leiautes Modelo 57 e Modelo 67

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

Web Services e Métodos TSS

Serão utilizados os métodos dos Web Services abaixo:

Web Service SPEDCFGNFE

Método CFGEPECCTE

O objetivo deste método é configurar os parâmetros dos Eventos do CT-e. Ele deve ser utilizado para configurar o uso dos seguintes eventos: EPEC, Cancelamento, CC-e, Registro do Multimodal, Informações da GTV e Prestação do Serviço em Desacordo.

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>

<HORAVERAOCTE>STRING</HORAVERAOCTE>

<HORARIOCTE>STRING</HORARIOCTE>

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

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

HORAVERAOCTE

CFGEPECCTE

A

1

0-1

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

1-Sim ou 2-Não

HORARIOCTE

CFGEPECCTE

A

1

0-1

Identificação do Horário:

1- Fernando de Noronha;

2- Brasília;

3- Manaus;

4- Acre.

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

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

<HORAVERAOCTE>STRING</HORAVERAOCTE>

<HORARIOCTE>STRING</HORARIOCTE>

</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: 1-Cancelamento por evento habilitado 0-Cancelamento por evento não habilitado
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

HORAVERAOCTE

Soap Fault

Fault

CFGEPECRESULT

A

Observações

1-5

0-1

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

1- Sim

2- Não

HORARIOCTE

CFGEPECRESULT

A

1-21

0-1

Identificação do Horário:

1- Fernando de Noronha;

2- Brasília;

3- Manaus;

4-Acre.

Soap Fault

Fault	Observações
Invalid 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 Informações da GTV inválida.
012	Versão do leiaute geral específico 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.
015014	Versão do leiaute específico do evento Prestação do Serviço em Desacordo inválida.
015	Horário de verão inválido. Valores válidos: 1-Sim e 2-Não
016	Horário inválido. Valores válidos: 1-Fernando de Noronha, 2-Brasilia, 3-Manaus e 4-Acre

Método CFGVERSAOCTE

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>

   <MODELO>STRING</MODELO>

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

MODELO

CFGVERSAOCTE

N

2

0-1

Informe:

57 – para CT-e;

67 - para CT-e OS.

Observação: Caso o campo não seja informado, será considerado como padrão o modelo 57.

Os parâmetros 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.

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

CFGAMBIENTE

Configurar o ambiente de operação da Nota Fiscal Eletrônica, Conhecimento de Transporte Eletrônico, Nota Fiscal do Consumidor Eletrônica e Conhecimento de Trasporte Eletrônico para Outros Serviços. Entende-se por ambiente o modo de operação do cliente junto `s SEFAZ, que no caso pode ser Produção ou Homologação.

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

<soap:Body>

   <USERTOKEN>STRING</USERTOKEN>

   <ID_ENT>STRING</ID_ENT>

   <NFE><AMBIENTE>STRING</AMBIENTE>

      <NOTAS>         <NFES>            <ID><MODELO>STRING</ID>MODELO>

<XML>BASE64BINARY</XML>

         </NFES>

<NFES>

<ID>STRING</ID>

<XML>BASE64BINARY</XML>

</NFES>

      </NOTAS>

   </NFE>

</soap:Body>

REMESSA---1-1.

Nome	Pai	Tipo	Tam.	Ocor.	Observações
CFGAMBIENTE					Tag raiz	da requisição
USERTOKEN	REMESSA CFGAMBIENTE	A	5	1-1	Deverá ser preenchido com o valor “TOTVS”.
ID_ENT	REMESSA CFGAMBIENTE	A	6	1-1	ID da entidade a ser utilizada.
NFE AMBIENTE	REMESSA CFGAMBIENTE	- A	1-4	1-1	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.
MAIL	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:

NomePaiTipoTam.Ocor.Observações

Informe:

1 para produção;

2 para homologação ou

0 para saber a configuração atual do ambiente.

MODELO

CFGAMBIENTE

N

2

0-1

Informe:

65 - para NFC-e;

67 - para CT-e OS.

Observação: Caso o campo não seja informado, será considerado como padrão o modelo 55 / 57.

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

<soap:Body>

   <CFGAMBIENTERESPONSE>

    <CFGAMBIENTERESULT>STRING</CFGAMBIENTERESULT>

   </CFGAMBIENTERESPONSE>

</soap:Body>

Nome

Pai

Tipo

Tam.

Ocor.

Observações

CFGAMBIENTERESPONSE

-

1-1

Tag raíz do retorno.

CFGAMBIENTERESULT

CFGAMBIENTERESPONSE

A

0-25

1-1

Retorna as expressões:

1-Produção;

2-Homologação.

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	Código do ambiente inválido. Valores válidos: 0- Configuração; 1- Produção; 2- Homologação.

Método CFGMODALIDADE

Configurar a modalidade de operação da Nota Fiscal eletrônica, Conhecimento de Transporte Eletrônico, Nota Fiscal de Consumidor Eletrônica e Conhecimento de Trasporte Eletrônico para Outros Serviços. Entende-se por modalidade, a forma de geração da Nota Fiscal do cliente junto à SEFAZ, que no caso pode ser Normal ou de Contingência.

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

<soap:Body>

   <USERTOKEN>STRING</USERTOKEN>

   <ID_ENT>STRING</ID_ENT>

   <MODALIDADE>STRING</MODALIDADE>

   <MODELO>STRING</MODELO>

</soap:Body>

Nome	Pai	Tipo	Tam.	Ocor.	Observações
CFGMODALIDADE					Tag raiz da requisição
USERTOKEN	CFGAMBIENTE	A	5	1-1	Deverá ser preenchido com o valor “TOTVS”.
ID_ENT	CFGAMBIENTE	A	6	1-1	ID da entidade a ser utilizada.
MODALIDADE	CFGAMBIENTE	A	1-4	1-1	Modalidades de transmissão: 0 - Configuração atual NFE (modelo 55): 1 – Normal; 2 - Contingência Off-Line; 4 – Ambiente nacional; 5 – EPEC; 6 – Sefaz Virtual RS; 7 – Contingência FS-DA; 8 – Contingência SVC-AN; 9 – Contingência SVC-RS. CTE (modelo 57): 1 – Normal; 5 - EPEC; 7 - Contingência FS-DA; 8 –Sefaz Virtual SP; 9 –Sefaz Virtual RS. NFCE (modelo 65): 1 – Normal; 9 – Contingência Off-Line; 2 – Contingência Off-Line. (a partir do TSS 2.50). CTE OS (modelo 67): 1 – Normal; 7 - Contingência FS-DA; 8 –Sefaz Virtual SP; 9 –Sefaz Virtual RS.
MODELO	CFGAMBIENTE	N	2	0-1	Informe: 55 - para NF-e; 57 - para CT-e; 65 - para NFC-e; 67 - para CT-e OS. Observação: Caso o campo não seja informado, será considerado como padrão o modelo 55.

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

<soap:Body>

   <CFGMODALIDADERESPONSE>

    <CFGMODALIDADERESULT>STRING</CFGMODALIDADERESULT>

   </CFGMODALIDADERESPONSE>

</soap:Body>

Nome

Pai

Tipo

Tam.

Ocor.

Observações

CFGMODALIDADERESPONSE

-

1-1

Tag raíz do retorno.

CFGMODALIDADERESULT

CFGMODALIDADERESPONSE

A

0-25

1-1

Retorna as expressão:

NFE (modelo 55):

1 – Normal;

2 - Contingência Off-Line;

4 – Ambiente nacional;

5 – EPEC;

6 – Sefaz Virtual RS;

7 – Contingência FS-DA;

8 – Contingência SVC-AN;

9 – Contingência SVC-RS

CTE (modelo 57):

1 – Normal;

5 - EPEC;

7 - Contingência FS-DA;

8 –Sefaz Virtual SP;

9 –Sefaz Virtual RS

NFCE (modelo 65):

1 – Normal;

9 – Contingência Off-Line;

2 – Contingência Off-Line. (a partir do TSS 2.50).

CTE OS (modelo 67):

1 – Normal;

7 - Contingência FS-DA;

8 –Sefaz Virtual SP;

9 –Sefaz Virtual RS.

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	Para NF-e: Código da modalidade inválido para NF-e. Valores válidos: 0-Configuração, 1-Normal, 2-Contingência off-line, 4-Ambiente Nacional, 5- EPEC, 6-Sefaz Virtual, 7-Contingência FS-DA, 8-Contingência SVC-AN, 9-Contingência SVC-RS. Para CT-e: Código da modalidade inválido para CT-e. Valores válidos: 0-Configuração, 1-Normal, 5-EPEC, 7-Contingência FS-DA, 8-Contingência SVC-SP, 9-Contingência SVC-RS. Para NFC-e: Código da modalidade inválido para NFC-e. Valores válidos: 0-Configuração, 1-Normal, 9-Contingência Off-Line, 2 – Contingência Off-Line. (a partir do TSS 2.50). Para CT-e OS: Código da modalidade inválido para CT-e OS. Valores válidos: 0-Configuração, 1-Normal, 7-Contingência FS-DA, 8-Contingência SVC-SP, 9-Contingência SVC-RS.
004	Código do Modelo inválido. Valores válidos: 55 NF-e, 57 CT-e, 65 NFC-e e 67 CT-e OS.

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-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.
MAIL	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 REMESSA3

Método destinado à remessa síncrona de NFC-e, CT-e OS (posteriormente NF-e), em sua versão 3.00 ou superior.

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

<soap:Body>

<USERTOKEN>STRING</USERTOKEN>

<ID_ENT>STRING</ID_ENT>

<NOTAS>

<ID>STRING</ID>

<MODELO>STRING</MODELO>

<XML>BASE64BINARY</XML>

</REMESSA3ENVNOTA>

<ID>STRING</ID>

<MODELO>STRING</MODELO>

<XML>BASE64BINARY</XML>

</REMESSA3ENVNOTA>

</NOTAS>

</REMESSA3ENVNOTAS>

</soap:Body>

Nome	Pai	Tipo	Tam.	Ocor.	Observações
USERTOKEN	-	Caractere	006	1-1	Deverá ser preenchido com o valor “TOTVS”.
ID_ENT	-	Caractere	006	1-1	ID da entidade a ser utilizada.
REMESSA3ENVNOTAS	-	XML	-	1-1	Tag para as informações das notas a serem enviadas.
NOTAS	REMESSA3ENVNOTAS	XML	-	1-1	Tag para as informações das notas a serem enviadas.
REMESSA3ENVNOTA	NOTAS	XML	-	0-N	Tag para as informações de uma nota.
ID	REMESSA3ENVNOTA	Caractere	250	1-1	Id de identificação do XML da NFC-e / CT-e OS com o ERP. Este número sempre será informado ou solicitado pelo TOTVS Services SOA para fornecer informações sobre o status atual da NFC-e / CT-e OS. É recomendado para o ERP enviar o número da chave de acesso da NFC-e / CT-e OS, caso utilize uma base de dados 100% volátil.
MODELO	REMESSA3ENVNOTA	Caractere	002	0-1	Modelo do documento: 65 – NFC-e 67- CT-e OS 55 – NF-e (Implementação Futura)
XML	REMESSA3ENVNOTA	Base64	500-K	1-1	XML da nota.

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

<soap:Body>

<NOTAS>

<ID>STRING</ID>

<XMLPROT>BASE64BINARY</XMLPROT>

</REMESSA3RETNOTA>

<ID>STRING</ID>

<XMLPROT>BASE64BINARY</XMLPROT>

</REMESSA3RETNOTA>

</NOTAS>

</REMESSA3RETNOTAS>

</soap:Body>

Nome	Pai	Tipo	Tam.	Ocor.	Observações
REMESSA3RETNOTAS	-	XML	-	1-1	Tag que conterá as notas que foram recebidas com sucesso.
NOTAS	REMESSA3RETNOTAS	XML	-	1-1	Tag que conterá as notas que foram recebidas com sucesso.
REMESSA3RETNOTA	NOTAS	XML	-	0-N	Tag que conterá as informações de uma nota recebida com sucesso.
ID	REMESSA3RETNOTA	Caractere	250	1-1	Id de identificação do XML da NF-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. É recomendado para o ERP enviar o número da chave de acesso da NF-e, caso utilize uma base de dados 100% volátil.
XMLPROT	REMESSA3RETNOTA	Base64	500KB	0-1	XML da nota autorizada em caso do processo utilizado ter sido síncrono.

Soap Fault

Fault	Observações
Invalid Token	O parâmetro USERTOKEN foi informado incorretamente.
001	Código da entidade inválido.
002	As informações obrigatórias de uma ou mais notas não foram recebidas.
003	O modelo especificado para uma ou mais notas é inválido.
004	NFC-e /CT-e OS devem ser enviadas apenas em lotes de no máximo uma ocorrência.
004	Versão do leiaute específico do evento EPEC inválida.

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)

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

Nome	Pai	Tipo	Tam.	Ocor.	Observações
detEvento	Eventos	G	-	1-N	Tag raiz
tpEvento	detEvento	A	6	1-1	Tipo de Evento Informar : 110110
chNFe	detEvento	N	44	1-1	Chave de Acesso do CT-e.
correcao	detEvento	G	-	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-20	1-1	Nome do campo modificado do CT-e Original
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:

</correcao>

</correcao>

</detEvento>

</correcao>

</detEvento>

</eventos>

</envEvento>

detEvento – Registro do Multimodal

Nome	Pai	Tipo	Tam.	Ocor.	Observações
detEvento	Eventos	G	-	1-N	Tag raiz
tpEvento	detEvento	A	6	1-1	Tipo de Evento Informar : 110160
chNFe	detEvento	N	44	1-1	Chave de Acesso do CT-e.
registro	detEvento	A	15-1000	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)
doc	detEvento	A	43	0-1	Número do Documento lançado no CT-e Multimodal

Exemplo de XML para Registro do Multimodal

</detEvento>

</detEvento>

</eventos>

</envEvento>

detEvento – Informações da GTV

Nome	Pai	Tipo	Tam.	Ocor.	Observações
detEvento	Eventos	G	-	1-N	Tag raiz
tpEvento	detEvento	A	6	1-1	Tipo de Evento Informar : 110170
chNFe	detEvento	N	44	1-1	Chave de Acesso do CT-e OS.
infGTV	detEvento	G	-	1-N	Grupo de informações da GTV
nDoc	infGTV	A	20	1-1	Número da GTV
id	infGTV	A	20	1-1	Identificador para diferenciar GTV de mesmo número (Usar número do AIDF ou identificador interno da empresa)
serie	infGTV	A	3	0-1	Série da GTV (opcional)
subserie	infGTV	A	3	0-1	Subsérie da GTV (opcional)
dEmi	infGTV	D	-	1-1	Data de emissão. Formato AAAA-MM-DD
nDV	infGTV	N	1	1-1	Número do Dígito Verificador
qCarga	infGTV	N	11,4	1-1	Quantidade de volumes/malotes
infEspecie	infGTV	G	-	1-N	Informações das espécies transportadas
tpEspecie	infEspecie	N	1	1-1	Tipo da espécie: 1 – Numerário; 2 – Cheque; 3 – Moeda; 4 - Outros
vEspecie	infEspecie	N	13,2	0-1	Valor Transportado em espécie indicada
rem	infGTV	G	-	1-1	Informações do remetente da GTV
CPFCNPJ	rem	N	11-14	1-1	CPF ou CNPJ
IE	rem	A	14	0-1	Inscrição Estadual
UF	rem	A	2	1-1	Sigla da UF
xNome	rem	A	60	1-1	Razão social ou nome do remetente da GTV
dest	infGTV	G	-	1-1	Informações do destinatário da GTV
CPFCNPJ	dest	N	11-14	1-1	CPF ou CNPJ
IE	dest	A	14	0-1	Inscrição Estadual
UF	dest	A	2	1-1	Sigla da UF
xNome	dest	A	60	1-1	Razão social ou nome do destinatário da GTV
placa	infGTV	A	7	0-1	Placa do veículo
UF	infGTV	A	2	0-1	UF da placa onde o veículo está registrado
RNTRC	infGTV	A	8	0-1	RNTRC do transportador

Exemplo de XML para Informações da GTV

</infEspecie>

<rem>

</rem>

<dest>

</dest>

</infGTV>

</infEspecie>

<rem>

</rem>

<dest>

</dest>

</infGTV>

</detEvento>

</eventos>

</envEvento>

detEvento – Prestação de Serviço em Desacordo

Nome	Pai	Tipo	Tam.	Ocor.	Observações
detEvento	Eventos	G	-	1-N	Tag raiz
tpEvento	detEvento	A	6	1-1	Tipo de Evento Informar : 610110
chNFe	detEvento	N	44	1-1	Chave de Acesso do CT-e ou CT-e OS.
indDesacordoOper	detEvento	A	1	1-1	Indicador de prestação do serviço em desacordo.
xOBS	detEvento	A	15-255	0-1	Observações do tomador

Exemplo de XML para Prestação de Serviço em Desacordo

</detEvento>

</detEvento>

</eventos>

</envEvento>

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

Páginas filhas

Versões comparadas

Versão antiga 17

Nova versão 130

Chave

Informações Gerais

Objetivo

Definição da Regra de Negócio

Serviços Compartilhados - Modelo 57 e Modelo 67

Eventos

Leiautes Modelo 57 e Modelo 67

Web Services e Métodos TSS

Web Service SPEDCFGNFE

Método CFGEPECCTE

Método CFGVERSAOCTE

Método

CFGAMBIENTE

Método CFGMODALIDADE

Método REMESSA

Método REMESSA3

Método REMESSAEVENTO

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 17

Nova versão 130

Chave

Informações Gerais

Objetivo

Definição da Regra de Negócio

Serviços Compartilhados - Modelo 57 e Modelo 67

Eventos

Leiautes Modelo 57 e Modelo 67

Web Services e Métodos TSS

Web Service SPEDCFGNFE

Método CFGEPECCTE

Método CFGVERSAOCTE

Método

CFGAMBIENTE

Método CFGMODALIDADE

Método REMESSA

Método REMESSA3

Método REMESSAEVENTO