Através deste endpoint é possível consultar a lista de NSNRecs vinculados a um GTV-e a partir de sua chave de acesso.
URL
Produção: POST https://gtve.ns.eti.br/v1/util/nsnrecs
Dados de entrada
Os dados de entrada deste método por ser enviado no corpo da requisição em formato JSON ou como QueryString na URL do método.
Campo | Descrição | Tipo | Ocorrência | Observação |
---|---|---|---|---|
X-AUTH-TOKEN | Token de acesso do usuário | A | 1-1 | |
chGTVe | Chave de acesso da GTV-e | N | 1-1 | |
tpAmb | Tipo do ambiente de autorização do GTV-e 1 - Produção 2 - Homologação | N | 1-1 |
Exemplo de requisição
Requisição de Lista de NSNRecs
curl -X POST \
-H "Content-Type: application/json" \
-d '{"X-AUTH-TOKEN": "SEU_TOKEN", "chGTVe": "43170120121850000156580010002037451076558734", "tpAmb": 2}'\
https://gtve.ns.eti.br/v1/util/nsnrecs
Dados retornados
Campo | Descrição | Tipo | Ocorrência | Pai | Onservação |
---|---|---|---|---|---|
status | Código de status do processamento | N | 1-1 | ||
motivo | Descrição literal do status de processamento | A | 1-1 | ||
nsNRecs | Objeto contendo os dados da pessoa solicitada | Array | 1-1 | Conterá itens apenas se forem encontrados nsNRecs vinculados a chave do GTV-e fornecido | |
nsNRec | nsNRec vinculado | N | 1-1 | nsNRecs | |
cStat | Código do status do nsNRec | N | 1-1 | nsNRecs | |
xMotivo | Descrição literal do status do nsNRec | A | 1-1 | nsNRecs |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"nsNRecs": [
{
"cStat": 228,
"nsNRec": 6,
"xMotivo": "Rejeição: Data de Emissao muito atrasada"
},
{
"cStat": 100,
"nsNRec": 7,
"xMotivo": "Autorizado o uso do CT-e "
}
]
}
Códigos de retorno
Código | Descrição |
---|---|
200 | Consulta realizada com sucesso |
-2 | Chave de acesso inválida |
-6 | Erro ao carregar as informações |