Web Service — DCeConsultaProtocolo

Consulta da situação atual da DC-e a partir da chave de acesso.

Função:

Processo:

Método:

dceConsulta

Schema entrada:

consSitDCe_1.00.xsd

Schema retorno:

retConsSitDCe_v1.00.xsd

Chave de acesso:

1.1. Leiaute Da Mensagem De Entrada

Entrada: estrutura XML contendo a chave de acesso da DC-e.

Tabela 5-4 — Leiaute da mensagem de entrada do Web Service dceConsultaProtocolo (schema `consSitDCe_1.00.xsd`)
#	Campo	Ele	Pai	Tipo	Ocor.	Tam.	Descrição / Observação
EP01	consSitDCe	Raiz	–	–	–	–	TAG raiz.
EP02	versao	A	EP01	N	1-1	1-2v2	Versão do leiaute.
EP03	tpAmb	E	EP01	N	1-1	1	Identificação do ambiente: 1 = Produção; 2 = Homologação.
EP04	xServ	E	EP01	C	1-1	9	Serviço solicitado: CONSULTAR.
EP05	chDCe	E	EP01	N	1-1	44	Chave de acesso da DC-e.

1.2. Leiaute Da Mensagem De Retorno

Retorno: estrutura XML contendo o resultado da consulta de protocolo.

Tabela 5-5 — Leiaute da mensagem de retorno do Web Service dceConsultaProtocolo (schema `retConsSitDCe_v1.00.xsd`)
#	Campo	Ele	Pai	Tipo	Ocor.	Tam.	Descrição / Observação
ER01	retConsSitDCe	Raiz	–	–	–	–	TAG raiz da resposta.
ER02	versao	A	ER01	N	1-1	1-2v2	Versão do leiaute.
ER03	tpAmb	E	ER01	N	1-1	1	Identificação do ambiente: 1 = Produção; 2 = Homologação.
ER04	verAplic	E	ER01	C	1-1	1-20	Versão do aplicativo que processou a consulta.
ER05	cStat	E	ER01	N	1-1	3	Código do status da resposta.
ER06	xMotivo	E	ER01	C	1-1	1-255	Descrição literal do status da resposta.
ER07	cUF	E	ER01	N	1-1	2	Código da UF que atendeu a solicitação.
ER07a	dhRecbto	E	ER01	D	1-1	–	Data e hora do processamento. Formato AAAA-MM-DDThh:mm:ssTZD (UTC).
ER07b	chDCe	E	ER01	N	1-1	44	Chave de acesso da DC-e consultada.
ER08	protDCe	G	ER01	xml	0-1	–	Protocolo de autorização da DC-e.
ER09	procEventoDCe	G	ER01	xml	0-N	–	Informação do evento e respectivo protocolo de registro de evento.
ER10	DCe	G	ER01	xml	0-1	–	XML da DC-e — somente se a conexão for feita com o mesmo CNPJ base de algum dos atores da DC-e.
ER11	evento	G	ER01	xml	0-1	–	XML dos eventos da DC-e — somente se a conexão for feita com o mesmo CNPJ base de algum dos atores da DC-e.

1.3. Descrição Do Processo

O método recebe as solicitações de consulta de situação da Declaração de Conteúdo eletrônica enviadas às Secretarias de Fazenda Estaduais. O acesso é permitido apenas pela chave única de identificação da DC-e. Ao receber a solicitação, a aplicação do Portal valida a chave de acesso e retorna a mensagem com a situação atual da DC-e na base de dados.

Quem recebe o XML completo: Se a conexão for feita com certificado digital cujo CNPJ base corresponda a um dos atores da DC-e — emitente, destinatário, Marketplace, Transportadora ou autorizado XML — e a consulta ocorrer dentro do prazo de 3 meses contados da autorização, o serviço retorna também o XML da DC-e e o XML dos seus eventos. Também podem obter o XML da DC-e outras empresas transportadoras devidamente habilitadas no CCC.

1.4. Regras De Validação

1.4.1. Regras Genéricas

Tabela 5-6 — Grupos de regras de validação genéricas do Web Service dceConsultaProtocolo
Grupo	Descrição
A	Validação do certificado de transmissão (protocolo TLS).
B	Validação inicial da mensagem no Web Service.
D	Validação da área de dados.
E	Validação do certificado digital de assinatura.
F	Validação da assinatura digital.

1.4.2. Regras Específicas

Nova incluída pela NT 2024.001, v. 1.00.

Tabela 5-7 — Regras de validação específicas do Web Service dceConsultaProtocolo
#	Regra de validação	Aplic.	Msg	Efeito	Descrição do erro
J01	Tipo do ambiente da DC-e difere do ambiente do Web Service.	Obrig.	252	Rej.	Rejeição: Ambiente informado diverge do Ambiente de recebimento.
J01a	Site de autorização na chave de acesso da DC-e difere do site de recebimento.	Obrig.	228	Rej.	Rejeição: Site de autorização da chave de acesso da DC-e diverge do site de recebimento.
J02	Validar chave de acesso: CNPJ ou CPF zerado ou inválido; Ano < 2021 ou maior que o atual; Mês inválido (0 ou > 12); Modelo diferente de 99; Número zerado; Tipo de emissão inválido; Tipo do emitente inválido; UF inválida; DV inválido.	Obrig.	614	Rej.	Rejeição: Chave de acesso inválida [Motivo: XXXXXXXXXXXX].
J02a	UF da chave de acesso difere da UF do Web Service.	Obrig.	226	Rej.	Rejeição: Código da UF do emitente diverge da UF autorizadora.
J02b Nova	UF da chave de acesso não é atendida pelo Web Service.	Obrig.	XXX	Rej.	Rejeição: UF informada na chave de acesso não é atendida pelo Web Service.
J03	Ano-Mês da chave de acesso com atraso superior a 6 meses em relação ao Ano-Mês atual. Observação: eventualmente a SEFAZ autorizadora poderá não implementar esta validação, conforme seu critério.	Obrig.	526	Rej.	Rejeição: Consulta a uma chave de acesso muito antiga.
J04	Acesso ao BD DC-e — verificar se a DC-e existe no site de autorização.	Obrig.	217	Rej.	Rejeição: DC-e inexistente na base de dados do site de autorização consultado.

Código de rejeição da regra J02b ainda não publicado: A Nota Técnica 2024.001 criou a regra J02b indicando o código de mensagem como XXX, sem definição do número da rejeição. O código deverá ser confirmado em publicação posterior da Coordenação Técnica do Sistema.

1.5. Final Do Processamento

O processamento do pedido de consulta pode resultar em mensagem de erro ou no retorno da situação atual da DC-e consultada. Localizada a DC-e, o campo cStat retorna:

Situações possíveis para a DC-e localizada
cStat	Situação
100	Autorizado o uso.
101	Cancelamento de DC-e homologado.

Web Service DCeConsultaProtocolo