O método de download do GTV-e é responsável por retornar o JSON e XML a partir do fornecimento da chave de acesso de uma GTV-e autorizada.
URL
Produção: POST https://gtve.ns.eti.br/v1/gtve/get
Dados de entrada
| Campo | Ocorrência | Descrição |
|---|---|---|
| X-AUTH-TOKEN | 1-1 | Token de acesso do usuário |
| chCTe | 1-1 | Chave de acesso do GTV-e |
| tpAmb | 1-1 | Tipo de Ambiente:1 - Produção2 - Homologação |
| tpDown | 1-1 | Tipo do download: X - XMLJ - JSON |
Exemplo de requisição
Requisição de download de GTV-e
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"X-AUTH-TOKEN":"SEU_TOKEN",
"chGTVe":"44444444444444444444444444444444444444444444",
"tpAmb":"2",
"tpDown":"X"
}' \
https://gtve.ns.eti.br/v1/gtve/get
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 | ||
| chCTe | Chave da GTV-e | 0-1 | N | ||
| xml | XML de distribuição da GTV-e autorizada | 0-1 | A | Somente em quando tipo = X Apenas com status = 200 | |
| gtveProc | Objeto JSON com os dados de distribuição da GTV-e autorizada | 0-1 | O | Somente em quando tipo = J Apenas com status = 200 | |
| erro | Objeto contendo informações de erro ao carregar a GTV-e | 0-1 | Apenas com status diferente de 200 | ||
| cStat | Código do status de erro | N | |||
| xMotivo | Descrição literal do erro | A |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"chCTe": "43210107364617000135640000000000031000010506",
"xml": "<GTVeProc versao="3.00" xmlns="http: //www.portalfiscal.inf.br/cte"><GTVe versao="3.00"><infCte versao="3.00" Id="CTe43210107364617000135640000000000031000010506">...</infCte></GTVe></GTVeProc>"
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Download realizado com sucesso |
| -2 | Tipo de download inválido Obs.: Quando o tipo for diferente X e J (case-insensitive). |
| -3 | Chave de acesso inválida |
| -4 | GTV-e não encontrada com a chave de acesso informada |