Web Service — Autorização da GTV-e

Mensagens, validações e processamento da GTV-e, modelo 64.

1. Visão Geral do Serviço

Serviço de recepção da Guia de Transporte de Valores Eletrônica, modelo 64.

Item	Especificação
Modelo	64.
Entrada	XML da GTV-e.
Retorno	GTV-e processada e protocolo.
Processamento	Síncrono.

2. Recepção da GTV-e

2.1. Serviço de Recepção de GTVe (Modelo 64)

O Serviço de Recepção de Guia de Transporte de Valores Eletrônica é o serviço oferecido pelos Portais das Secretarias de Fazenda dos Estados para recepção das GTVe emitidos pelos contribuintes credenciados em sua unidade federada.

A forma de processamento do serviço de recepção de GTVe é síncrona sem a formação de lotes. O contribuinte deve transmitir uma GTVe (modelo 64) através do Web Service de recepção de GTVe e receberá o resultado do processamento na mesma conexão.

Função: serviço destinado à recepção de mensagens de envio de GTVe (modelo 64).

Processo: síncrono.

Nome Serviço: CTeRecepcaoGTVeV4

Método: cteRecepcaoGTVe

Parâmetro da Mensagem da área de dados: Compactada utilizando GZip (Base64)

2.1.1. Leiaute Mensagem de Entrada

Entrada: Estrutura XML da GTVe está definido ao final desta Nota técnica. Schema XML: GTVe_v9.99.xsd

2.1.2. Leiaute Mensagem de Retorno

Retorno: Estrutura XML com a mensagem do resultado do envio da GTVe Schema XML: retGTVe_v9.99.xsd

#	Campo	Ele	Pai	Tipo	Ocor.	Tam.	Descrição/Observação
DR01	retGTVe	Raiz	-	-	-	-	TAG raiz da Resposta
DR02	Versão	A	DR01	N	1-1	2v2	Versão do leiaute
DR03	tpAmb	E	DR01	N	1-1	1	Identificação do Ambiente: 1 – Produção / 2 - Homologação
DR04	cUF	E	DR01	N	1-1	2	Código da UF que atendeu à solicitação.
DR05	verAplic	E	DR01	C	1-1	1-20	Versão do Aplicativo que recebeu a GTVe.
DR06	cStat	E	DR01	N	1-1	3	Código do status da resposta
DR07	xMotivo	E	DR01	C	1-1	1-255	Descrição literal do status da resposta
DR08	protCTe	E	DR01	G	0-1	XML	Resposta ao processamento da GTVe

2.1.3. Leiaute da GTVe processada

#	Campo	Ele	Pai	Tipo	Ocor.	Tam.	Descrição/Observação
PR01	protCTe	Raiz	-	-	-	-	TAG raiz da resposta processamento
PR02	versao	A	PR01	N	1-1	2v2	Versão do leiaute
PR03	infProt	G	PR01	-	1-1	-	Informações do protocolo de resposta
PR04	Id	A	PR03	C	0-1	-	Identificador da TAG a ser assinada, somente precisa ser informado se a UF assinar a resposta. Em caso de assinatura da resposta pela SEFAZ preencher o campo com o Nro do Protocolo, precedido com o literal “ID”
PR05	tpAmb	E	PR03	N	1-1	1	Identificação do Ambiente: 1 – Produção / 2 - Homologação
PR06	verAplic	E	PR03	C	1-1	1-20	Versão do Aplicativo que recebeu a GTVe
PR07	chCTe	E	PR03	N	1-1	44	Chave de acesso da GTVe
PR08	dhRecbto	E	PR03	D	1-1	-	Data e Hora do Processamento Formato = AAAA-MM-DDTHH:MM:SS TZD Preenchido com data e hora da gravação do CTe no Banco de Dados. Em caso de Rejeição, com data e hora do recebimento do Arquivo de GTVe enviado.
PR09	nProt	E	PR03	N	0-1	15	Número do protocolo de autorização do GTVe
PR10	digVal	E	PR03	C	0-1	28	Digest Value da GTVe processada, utilizado para conferir a integridade com a GTVe original
PR11	cStat	E	PR03	N	1-1	3	Código do status da resposta para a GTVe
PR12	xMotivo	E	PR03	C	1-1	1-255	Descrição literal do status da resposta para a GTVe
PR13	infFisco	G	PR01	-	0-1	-	Grupo reservado para envio de mensagem do Fisco para o contribuinte
PR14	cMsg	E	PR13	N	1-1	3	Código de status da mensagem do fisco
PR15	xMsg	E	PR13	C	1-1	1-255	Mensagem do Fisco para o contribuinte
PR16	Signature	G	PR01	XML	0-1	-	Assinatura XML do grupo identificado pelo atributo “ID” A decisão de assinar a mensagem fica a critério da UF interessada.

2.1.4. Regras de Validação Básicas do Serviço

Deverão ser aplicadas as validações gerais conforme quadro abaixo:

Grupo	Descrição
A	Validação do Certificado de Transmissão (protocolo TLS)
B-0	Validação da Compactação da Mensagem
B	Validação Inicial da Mensagem no Web Service
C	Validação da Área de Dados da mensagem
C-1	Validação do Ambiente de Autorização

Detectar UF pela UF da chave de acesso

2.1.5. Validação das regras de negócio da GTVe

As regras de negócio que serão aplicadas a GTVe estão descritas Grupo I constante no item 2.3 do Anexo I: Manual de Orientações do Contribuinte – Leiaute e Regras de Validação.

2.1.6. Final do Processamento da GTVe

A validação da GTVe poderá resultar em:

Rejeição – a GTVe será descartada, não sendo armazenada no Banco de Dados podendo ser corrigido e novamente transmitida;
Autorização de uso – a GTVe será armazenada no Banco de Dados;

Validação	Consequência
De forma da GTVe	Para o contribuinte Banco de Dados
Inválida	Corrigir GTVe Não gravar
Válida	Prestação autorizada Gravar

Para cada GTVe autorizada será atribuído um número de protocolo da SEFAZ.

3. Especificação Completa da NT 2020.002

A NT 2020.002 instituiu a GTV-e e alterou serviços relacionados. Nesta página permanecem as mensagens próprias da autorização; leiautes e regras já consolidados em páginas temáticas são apresentados por referência.

3.1. Serviço Síncrono de Recepção da GTVe (Modelo 64)

Função: serviço destinado à recepção de mensagens de envio de GTVe (modelo 64).

Processo: síncrono.

Método: cteRecepcaoGTVe

Parâmetro da Mensagem da área de dados: Compactada utilizando GZip (Base64)

3.1.1. Leiaute Mensagem de Entrada

Entrada: Estrutura XML da GTVe está definido ao final desta Nota técnica. Schema XML: GTVe_v9.99.xsd

3.1.2. Leiaute Mensagem de Retorno

Retorno: Estrutura XML com a mensagem do resultado do envio da GTVe Schema XML: retGTVe_v9.99.xsd

#	Campo	Ele	Pai	Tipo	Ocor.	Tam.	Descrição/Observação
CR01	retGTVe	Raiz	-	-	-	-	TAG raiz da Resposta
CR02	Versão	A	CR01	N	1-1	2v2	Versão do leiaute
CR03	tpAmb	E	CR01	N	1-1	1	Identificação do Ambiente: 1 – Produção / 2 - Homologação
CR04	cUF	E	CR01	N	1-1	2	Código da UF que atendeu à solicitação.
CR05	verAplic	E	CR01	C	1-1	1-20	Versão do Aplicativo que recebeu a GTVe.
CR06	cStat	E	CR01	N	1-1	3	Código do status da resposta
CR07	xMotivo	E	CR01	C	1-1	1-255	Descrição literal do status da resposta
CR08	protCTe	E	CR01	G	0-1	XML	Resposta ao processamento da GTVe

3.1.3. Leiaute da GTVe processada

#	Campo	Ele.	Pai	Tipo	Ocorr.	Tam.	Descrição/Observação
PR01	protCTe	Raiz	-	-	-	-	TAG raiz da resposta do processamento.
PR02	versao	A	PR01	N	1-1	2v2	Versão do leiaute.
PR03	infProt	G	PR01	-	1-1	-	Informações do protocolo de resposta.
PR04	Id	A	PR03	C	0-1	-	Identificador da tag a ser assinada. Se a UF assinar a resposta, informar o número do protocolo precedido do literal “ID”.
PR05	tpAmb	E	PR03	N	1-1	1	Identificação do ambiente: 1 – Produção; 2 – Homologação.
PR06	verAplic	E	PR03	C	1-1	1-20	Versão do aplicativo que recebeu a GTV-e.
PR07	chCTe	E	PR03	N	1-1	44	Chave de acesso da GTV-e.
PR08	dhRecbto	E	PR03	D	1-1	-	Data e hora do processamento, no formato AAAA-MM-DDTHH:MM:SS TZD.
PR09	nProt	E	PR03	N	0-1	15	Número do protocolo de autorização da GTV-e.
PR10	digVal	E	PR03	C	0-1	28	Digest Value da GTV-e processada, utilizado para conferir a integridade com a GTV-e original.
PR11	cStat	E	PR03	N	1-1	3	Código do status da resposta para a GTV-e.
PR12	xMotivo	E	PR03	C	1-1	1-255	Descrição literal do status da resposta para a GTV-e.
PR13	infFisco	G	PR01	-	0-1	-	Grupo reservado para envio de mensagem do Fisco ao contribuinte.
PR14	cMsg	E	PR13	N	1-1	3	Código de status da mensagem do Fisco.
PR15	xMsg	E	PR13	C	1-1	1-255	Mensagem do Fisco para o contribuinte.
PR16	Signature	G	PR01	XML	0-1	-	Assinatura XML do grupo identificado pelo atributo “ID”; a assinatura da resposta fica a critério da UF.

3.1.4. Regras de Validação Básicas do Serviço

O conteúdo vigente está consolidado em Regras de Validação Gerais.

3.1.5. Validação da área de dados da mensagem

O conteúdo vigente está consolidado em Grupo C - Validação da Área de Dados.

3.1.6. Validações do Certificado de Assinatura

O conteúdo vigente está consolidado em Grupo D - Certificado de Assinatura Digital.

3.1.7. Validação da Assinatura Digital

Validações da Assinatura Digital da GTV-e

#	Regra de Validação	Crítica	Msg	Efeito
F01	Assinatura difere do padrão do Projeto: não foi assinado o atributo Id (falta Reference URI na assinatura); ou faltam os Transform Algorithm previstos na assinatura (C14N e Enveloped). Estas validações também são implementadas pelo Schema XML da Signature.	Obrig.	298	Rej.
F02	Valor da assinatura (SignatureValue) difere do valor calculado.	Obrig.	297	Rej.
F03	CNPJ-base do emitente difere do CNPJ-base do certificado digital.	Obrig.	213	Rej.

3.1.8. Regras de negócio da GTVe (modelo 64)

O conteúdo vigente está consolidado em Regras de Validação da GTV-e.

3.1.9. Final do Processamento da GTVe

A validação da GTVe poderá resultar em:

Rejeição – a GTVe será descartada, não sendo armazenada no Banco de Dados podendo ser corrigido e novamente transmitida;
Autorização de uso – a GTVe será armazenado no Banco de Dados;

Validação	Consequência
De forma da GTVe	Para o contribuinte Banco de Dados
Inválida	Corrigir GTVe Não gravar
Válida	Prestação autorizada Gravar

Para cada GTVe autorizada será atribuído um número de protocolo da SEFAZ.

3.2. Serviço de Recepção CT-e (RV)

A RV G234 foi suspensa pela NT 2020.002 e, por isso, não integra o catálogo vigente. Consulte as Regras de Validação do CT-e.

3.3. Alteração no layout do CT-e OS

A NT 2020.002 permitiu a indicação de chaves de BP-e com evento de excesso de bagagem e criou o grupo de informações da GTV-e no CT-e OS.

#	Campo	Ele.	Pai	Tipo	Ocorr.	Tam.	Descrição/Observação
#	infGTVe	G	infCteNorm	-	0-n	-	Grupo de informações da GTV-e relacionadas ao CT-e OS de transporte de valores.
#	chCTe	E	infGTVe	C	1-1	44	Chave de acesso da GTV-e.
#	Comp	G	infGTVe	-	1-n	-	Componentes do valor da GTV-e.
#	tpComp	E	Comp	N	1-1	1	1 - Custódia; 2 - Embarque; 3 - Tempo de espera; 4 - Malote; 5 - Ad Valorem; 6 - Outros.
#	vComp	E	Comp	N	1-1	13,2	15 posições, sendo 13 inteiras e 2 decimais.
#	xComp	E	Comp	C	0-1	1-15	Exemplos: FRETE PESO, FRETE VALOR, SEC/CAT, ADEME, AGENDAMENTO etc.

O leiaute completo e consolidado do modelo 67 está disponível em Leiaute - CT-e Outros Serviços.

3.4. Serviço de Recepção CT-e OS (RV)

As regras vigentes do serviço estão consolidadas em Regras de Validação do CT-e OS.

3.5. Serviço de Consulta Situação (RV)

As regras vigentes da consulta estão consolidadas em Consulta Situação do CT-e.

3.6. Serviço Recepção Eventos – parte Geral (RV)

As regras comuns aos eventos estão consolidadas em Recepção de Evento - Parte Geral.

3.7. Evento de Cancelamento (RV)

As regras de cancelamento vigentes estão consolidadas em Eventos Específicos - Cancelamento.

3.8. Evento de Informações da GTV (RV)

Os eventos vigentes estão consolidados em Eventos Específicos do CT-e.

3.9. Mensagens de Rejeição

O conteúdo vigente está consolidado em Códigos de Resultado e Rejeição.