O parâmetros desta requisição são enviado no header, abaixo estão listados os parâmetros
Parametro | Descrição | Tipo | Obrigatório | Observação |
---|---|---|---|---|
IdInquilino | Identificador do inquilino | String | S | |
IdLojaRetaguarda | Identificador da loja da retaguarda | String | S | |
IdDispositivo | Identificador do dipositivo | String | S |
Campo |
Tipo |
Descrição |
---|---|---|
success | Booleano | Indica se a requisição retornou sucesso |
message | String | Campo com as mensagens de erro |
data | Obejto | Dado de retorno |
data.idInquilino | String | Identificador do inquilino |
data.idLojaRetaguarda | String | Identificador da loja na retaguarda |
data.idDispositivo | String | Identificador do dispositivo |
data.ipServidor | String | Ip do servidor |
data.pdv | Inteiro | PDV |
data.tef | Objeto | Objeto TEF |
data.tef.codigoEmpresa | String | Código da empresa |
data.tef.ip | String | IP |
data.tef.terminal | Int | Terminal |
data.dadosFiscais | Objeto | Objeto de dados fiscais |
data.dadosFiscais.serieNota | Int | Serie da nota |
data.dadosFiscais.modeloFiscal | Int | Modelo Fiscal |
data.dadosFiscais.numeroNota | String | Número da nota |
errors | Nulo | Lista com erros |
totalTime | Inteiro | Tempo de requisição |
numberOfRecords | Inteiro | Número de linhas retornadas |
{
"success": true,
"message": "string",
"data": {
"idInquilino": "string",
"idLojaRetaguarda": "string",
"idDispositivo": "string",
"ipServidor": "string",
"pdv": 0,
"tef": {
"codigoEmpresa": "string",
"ip": "string",
"terminal": 0
},
"dadosFiscais": {
"serieNota": "string",
"modeloFiscal": 0,
"numeroNota": 0
}
},
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}
Campo |
Tipo |
Descrição |
Observação |
---|---|---|---|
Success | bool | Indica se a requisição foi feita com sucesso | |
Message | string | Mensagem de retorno de erros | |
Data | Objeto | Objeto de retorno | |
Errors | Lista de objetos | Lista de erros | Somente é retornado na V3 |
TotalTime | Int | Tempo total da requisição | |
NumberOfRecords | Int | Número de registros |
{
"success": false,
"message": "string",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}