Através do serviço de Consulta Situação de GTV-e é possível obter a informação de qual o estado atual do GTV-e no banco de dados da Sefaz.
Esta funcionalidade é muito utilizada em casos onde é necessário verificar a existência e validade de um GTV-e, assim como obter informações sobre os eventos ocorridos com o mesmo (ex.: Cancelamento).
URL
Produção: POST https://gtve.ns.eti.br/v1/gtve/status
Dados de entrada
| Campo | Descriçãp | Tipo | Ocorrência | Observação |
|---|---|---|---|---|
| X-AUTH-TOKEN | Token de acesso do usuário | A | 0-1 | |
| licencaCnpj | CNPJ da licença interessada em consultar a situação da GTV-e | N | 0-1 | Utilizado para identificar o certificado digital que deverá ser utilizado Se não for enviado, o CNPJ será extraído da chave enviada no campo chGTVe |
| chCTe | Chave de acesso do GTV-e | N | 1-1 | |
| tpAmb | Tipo do ambiente de autorização da GTV-e | N | 1-1 | 1 - Produção 2 - Homologação |
Exemplo de requisição
Consulta de situação
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"X-AUTH-TOKEN": "SEU_TOKEN",
"licencaCnpj": "07364617000135",
"chCTe": "43161107364617000135580000000099461000094833",
"tpAmb": "2"
}'
https://gtve.ns.eti.br/v1/util/situation
Dados retornados
| Campo | Descrição | Ocorrência | Tipo | Pai | Observação |
|---|---|---|---|---|---|
| status | Código de status do processamento | 1-1 | N | ||
| motivo | Descrição literal do status de processamento | 1-1 | A | ||
| retConsSitGTVe | Objeto contendo os dados do protocolo de autorização da GTV-e e todos os eventos vinculados. | 0-1 | O | Somente em status = 200 | |
| erro | Objeto contendo os dados de erro ocorrido durante o processamento | 0-1 | O | Somente em status != 200 | |
| cStat | Código de status do erro | 1-1 | erro | ||
| xMotivo | Descrição literal do erro | 1-1 | erro |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"retConsSitGTVe": {
"tpAmb": "2",
"verAplic": "RS20191021102414",
"cStat": "101",
"xMotivo": "Cancelamento de CT-e homologado",
"cUF": "43",
"protCTe": {
"infProt": {
"tpAmb": "2",
"verAplic": "RS20210405092047",
"chCTe": "43210407364617000135640000000000211000010505",
"dhRecbto": "2021-04-16T09:29:33-03:00",
"nProt": "143210000210999",
"digVal": "QekZoG+3BGOk+nAH9QthAjKMhkk=",
"cStat": "100",
"xMotivo": "Autorizado o uso do CT-e"
},
"versao": "3.00"
},
"procEventoCTe": [
{
"eventoCTe": {
"infEvento": {
"Id": "ID1101114321040736461700013564000000000021100001050501",
"cOrgao": "43",
"tpAmb": "2",
"CNPJ": "07364617000135",
"chCTe": "43210407364617000135640000000000211000010505",
"dhEvento": "2021-04-16T15:13:49-03:00",
"tpEvento": "110111",
"nSeqEvento": "01",
"detEvento": {
"evCancCTe": {
"descEvento": "Cancelamento",
"nProt": "143210000210999",
"xJust": "CANCELAMENTO DE GTVE TESTE"
},
"versaoEvento": "3.00"
}
},
"Signature": {
"SignedInfo": {
"CanonicalizationMethod": {
"Algorithm": "http://www.w3.org/TR/2001/REC-xml-c14n-20010315"
},
"SignatureMethod": {
"Algorithm": "http://www.w3.org/2000/09/xmldsig#rsa-sha1"
},
"Reference": {
"Transforms": {
"Transform": [
{
"Algorithm": "http://www.w3.org/2000/09/xmldsig#enveloped-signature"
},
{
"Algorithm": "http://www.w3.org/TR/2001/REC-xml-c14n-20010315"
}
]
},
"DigestMethod": {
"Algorithm": "http://www.w3.org/2000/09/xmldsig#sha1"
},
"DigestValue": "B90f8is/EN5FZnhIEOuX246Uij8=",
"URI": "#ID1101114321040736461700013564000000000021100001050501"
}
},
"SignatureValue": {
"value": "Exnv1btps67qZ394WT++BKX0nVgap/5uCxixaE8dKK8uMHRTHZW1788bBQnILZ70+O/LoeCuA2RhPc81mEYHkCuB9Rkda9nu+NiuPryNvfTrqknBHQK/uy7G/2b6p6Ck0DCAj3J87ERtNFXfE37HkoYHKihASM4Ui5ToRPM+kFTrYoCNPyh64W1XdPqTif1DHr0TpTANOcvoxEGQHM5Tm0YceJIv3Ch0O+CO27KMHfTG4u1Bdvgqh4b5cGwKasG2oBjc8tbfiwKGWBv/gg2Ht6kOLEzJk5ySVa4Ptc4H9Q2TCjg2fDX9bpxQYfCR05c+fHr7IBQ8zYw9+6wBml9Bow=="
},
"KeyInfo": {
"X509Data": {
"X509Certificate": "MIIHrjCCBZagAwIBAgIIRcnVdMiHQNcwDQYJKoZIhvcNAQELBQAwdjELMAkGA1UEBhMCQlIxEzARBgNVBAoTCklDUC1CcmFzaWwxNjA0BgNVBAsTLVNlY3JldGFyaWEgZGEgUmVjZWl0YSBGZWRlcmFsIGRvIEJyYXNpbCAtIFJGQjEaMBgGA1UEAxMRQUMgU0FGRVdFQiBSRkIgdjUwHhcNMjAwODE3MTQ1ODE0WhcNMjEwODE3MTQ1ODE0WjCB6zELMAkGA1UEBhMCQlIxEzARBgNVBAoTCklDUC1CcmFzaWwxCzAJBgNVBAgTAlJTMRAwDgYDVQQHEwdDQU1BUVU/MTYwNAYDVQQLEy1TZWNyZXRhcmlhIGRhIFJlY2VpdGEgRmVkZXJhbCBkbyBCcmFzaWwgLSBSRkIxFjAUBgNVBAsTDVJGQiBlLUNOUEogQTExFzAVBgNVBAsTDjIwMDg1MTA1MDAwMTA2MRMwEQYDVQQLEwpwcmVzZW5jaWFsMSowKAYDVQQDEyFORVcgUyBTWVNURU1TIExUREE6MDczNjQ2MTcwMDAxMzUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCX1M9ceLVyyCjsWH1OOsTDrLcCmox2iOvWr8KYYzZ0MTAPEa9cFRI50KxD5rO5x+gYbSTotpIFDmmtc836OfRDCsDNSGEE/jSW0YF2OV+8pfUPnbeMuTn+xS+KTMFLGN7Wjd1NpTBn0Ob10c4WUYiFsvAeQGFgFsWbF4ZR1cw6ttgnvIozf7n7RIsV8FAy3/kOIQTZPZAS2QKFlmJMQ0Lcf+9Ejh6/6knQpVncfyjJGrdRklGhoXIUgw/BF5z5i7nJf5Iy2fi4hOia9yG0/D3UpGzp5lhL4q52KkrnfIKderHRGkJEiUbD1SguLy3RGcc1q5lYQOobR6wcOxSA8dGRAgMBAAGjggLIMIICxDAfBgNVHSMEGDAWgBQpXkvVRky7/hanY8EdxCby3djzBTAOBgNVHQ8BAf8EBAMCBeAwbQYDVR0gBGYwZDBiBgZgTAECATMwWDBWBggrBgEFBQcCARZKaHR0cDovL3JlcG9zaXRvcmlvLmFjc2FmZXdlYi5jb20uYnIvYWMtc2FmZXdlYnJmYi9hYy1zYWZld2ViLXJmYi1wYy1hMS5wZGYwga4GA1UdHwSBpjCBozBPoE2gS4ZJaHR0cDovL3JlcG9zaXRvcmlvLmFjc2FmZXdlYi5jb20uYnIvYWMtc2FmZXdlYnJmYi9sY3ItYWMtc2FmZXdlYnJmYnY1LmNybDBQoE6gTIZKaHR0cDovL3JlcG9zaXRvcmlvMi5hY3NhZmV3ZWIuY29tLmJyL2FjLXNhZmV3ZWJyZmIvbGNyLWFjLXNhZmV3ZWJyZmJ2NS5jcmwwgYsGCCsGAQUFBwEBBH8wfTBRBggrBgEFBQcwAoZFaHR0cDovL3JlcG9zaXRvcmlvLmFjc2FmZXdlYi5jb20uYnIvYWMtc2FmZXdlYnJmYi9hYy1zYWZld2VicmZidjUucDdiMCgGCCsGAQUFBzABhhxodHRwOi8vb2NzcC5hY3NhZmV3ZWIuY29tLmJyMIG4BgNVHREEgbAwga2BGlRISUFHT0BOU1RFQ05PTE9HSUEuQ09NLkJSoCEGBWBMAQMCoBgTFlRISUFHTyBEQSBTSUxWQSBEVU1NRVKgGQYFYEwBAwOgEBMOMDczNjQ2MTcwMDAxMzWgOAYFYEwBAwSgLxMtMTEwNDE5ODMwMDI2OTkyNTA3NDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwoBcGBWBMAQMHoA4TDDAwMDAwMDAwMDAwMDAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwCQYDVR0TBAIwADANBgkqhkiG9w0BAQsFAAOCAgEAYv2Ot1tAeaeXQIxKGRblp5sI3G3hW9tuGYm71E5y4YxNPHe9VwxCE1yfmQ2pwUIHU7iVDBEkcqbHSW7lKPb8Mn9qrY1v+WRA/SKWuZINX7k2orh+Vx6sDuae5N8s9PnT3hDfBoVDgCzJQC1zJSxFPGVjwBs5g/obhyYprTwoVXuIwJBNnli/GDRHfdzeHh+ddi4QKAnQ/dpKVOuOXg4dme1HgmwHJNCWVIqUVcab0vSDfEoQuPCn6aMZFzw0IFbakcxEyg3iFtkrc2xn59Yc+wh3NywNmJ91JzjmA5D0YTq+a2bmHnDQtms0zsRSVhCS1wSkVWKInqP/e8yfR5M193LW1qJO1OmRT9VPchiT9cUY0pB/xW2VeJTkhT86XDkVtzw3ehPiPWK75LwuX4sRyPyV45h2QwgNsXtdWCKdSZb+Pal9Bdj9fyKYE6qKf9BECJ6jDRsbi0u5ZevtfwAzHXxe0gUdeg4Zhx0UdsGjgaZTSqBhX+TGX4XgZNy9dKosDKJPmK3XP1GaoqlDj33g15ZRBCL7ghVbXl8Fyvi3wo5vLRbUOW/biagwxogiucLyznFubXdMrRQdCscxz+WVgbwUZmLA040ZyuX32DaP8ODoB2FMcMhNMlxJMg/btn87oySydJPvboWTRnsuV7l1Svpbe8AX4CT23vZt0O4ZIZs="
}
}
},
"versao": "3.00"
},
"retEventoCTe": {
"infEvento": {
"Id": "ID143210000213247",
"tpAmb": "2",
"verAplic": "RS20191021102444",
"cOrgao": "43",
"cStat": "135",
"xMotivo": "Evento registrado e vinculado a CT-e",
"chCTe": "43210407364617000135640000000000211000010505",
"tpEvento": "110111",
"xEvento": "Cancelamento",
"nSeqEvento": "1",
"dhRegEvento": "2021-04-19T16:19:26-03:00",
"nProt": "143210000213247"
},
"versao": "3.00"
},
"versao": "3.00"
}
],
"versao": "3.00"
}
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Consulta realizada com sucesso |
| -400 | Chave da CT-e ou Tipo do Ambiente não informados |
| -3 | Chave de acesso inválida |
| -6 | Erro ao realizar a consulta. Verifique o objeto erro para identificar o motivo. |