Dicionário de Dados
API Integração - Caixa
- Caixa Método
GET:https://lx-degust-api-integracao-prd.azurewebsites.net/api/caixa/dados-fechamento Essa requisição consulta dados sintéticos do fechamento de caixa. As informações retornadas trazem dados sobre o tipo da receita, a descrição da forma de
pagamento, o código do franqueador, apuração de dados da receita e seu lançamento via web.
Parâmetro Descrição Tipo Requerido Formato
CodigoFranqueador Código franqueador dentro do Degust One
Int32 (Número inteiro)
Sim
CodigoLoja Código da loja dentro do Degust One
Int32 (Número inteiro)
Sim
DataInicial Data inicial da pesquisa String (Texto)
Sim YYYY-MM-DD
(ANO-MES-DIA) DataFinal Data final da pesquisa String
(Texto)
Sim YYYY-MM-DD
(ANO-MES-DIA)
*Parâmetros via query Retorno:
Propriedade Descrição Tipo
CodigoFranqueador Código do franqueador dentro do Degust One
Int32 (Número inteiro) CodigoLoja Código da loja dentro do Degust One Int32
NomeReceita Nome da receita String (Texto) ApuradoSistemaFc Apurado sistema frente de caixa Double
(Número com casas
decimais)
GerenteFc Gerente da frente de caixa Double
(Número com casas
decimais) LancamentoReceitaWeb Lançamento da receita via web Double
(Número com casas
decimais)
Json Retorno:
{
"CodigoFranqueador": 0,
"CodigoLoja": 0,
"Data": "string",
"CodigoReceita": 0,
"NomeReceita": "string",
"ApuradoSistemaFc": 0,
"GerenteFc": 0,
"LancamentoReceitaWeb": 0
}
Método
POST:https://lx-degust-api-integracao-prd.azurewebsites.net/api/caixa/detalhamento-caixa Essa requisição consulta dados detalhados do fechamento de caixa. As informações retornadas trazem dados sobre o franqueador, loja e informações do caixa, tais como, a data do fechamento, data de abertura, data de fechamento, número do ponto de venda, nome do operador, código do operador, nome do gerente, código do gerente e informações sobre receitas.
Parâmetro Descrição Tipo Requerido Formato
CodigoFranqueador Código franqueador dentro do Degust One
Int32 (Número inteiro)
Sim
CodigoLoja Código da loja dentro do Degust One
String (Texto)
Sim
CaiData Data desejada da
pesquisa
String (Texto)
Sim YYYY-MM-DD
(ANO-MES-DIA)
Exemplo JSON de envio(body):
{
"CodigoFranqueador": 0,
"CodigoLoja": "string",
"CaiData": "2021-10-08T04:18:04.834Z"
}
Retorno:
Propriedade Descrição Tipo
CodigoFranqueador Código do franqueador dentro do Degust One
Int32
(Número inteiro)
NumPdv Número PDV Int32
(Número inteiro)
NumAbertura Número abertura Int32
(Número inteiro) DataHoraAbertura Data e hora da abertura String
(Texto) DataHoraReducao Data e hora da redução String
(Texto) DataHoraFechamento Data e hora do fechamento String
(Texto)
NomeOperador Nome do operador String
(Texto)
CodigoOperador Código do operador String
(Texto)
NomeGerente Nome do gerente String
(Texto)
CodigoGerente Código do gerente String
(Texto) DcReceitas Objeto contendo Código da receita,
gerente de fluxo de caixa, apurado sistema fluxo de caixa e nome da receita
DCReceitasResponse
CodigoReceita Código da receita String
(Texto)
GerenteFc Gerente frente de caixa String
(Texto) ApuradoSistemaFc Apurado sistema frente de caixa Double
(Número com casas decimais)
NomeReceita Nome da receita String
(Texto)
