índice
01. INFORMAÇÕES GERAIS
Veja como autenticar a API Obter Fechamento de Caixa
02. CONFIGURAÇÃO
Segurança
Como autenticar via API ChefWeb
Geração Token
Todo cliente ChefWeb possui um número de licença que identifica o cliente no ambiente do ChefWeb. Para realizar qualquer acesso aos métodos, o cliente deverá efetuar um "login" na API que deverá ser informado o usuário, a senha e o número de série do cliente. Após estes dados serem validados, será gerado um token de autenticação com duração de 2 minutos. Este token será composto de um código aleatório do tipo string que deverá ser utilizado em apenas uma única chamada da API(Exemplo: ZQGL16Q3D43mhSi8nw8s3j2HhZPQ9Ei6). Para todas as chamadas seguintes aos métodos da API, sempre deverá ser seguido o fluxo de geração de token de autenticação. Após a geração do token, caso o acesso não seja utilizado em 2 minutos ele estará automaticamente cancelado. O número do token poderá ser utilizado apenas uma vez.
URL do Serviço: POST:http://{url_do_servidor}/api/Token/GerarToken
"Usuario": Usuário utilizado para acessar o ambiente no ChefWeb
“Senha”: Senha utilizada do usuário para acessar o ChefWeb
"NumeroSerialLoja": Informar o Diretório Site do ambiente que deseja consultar as informações de venda
"Chave": Manter Padrão "Chave"
Request
{ "Usuario": "totvschef", "Senha": 123456 "NumeroSerialLoja":"96700001", "Chave": "Serial Number" } |
|---|
Response
O serviço retorna um JSON no formato abaixo:
{ "Token": "69e9dde6-c91c-4c50-af1c-fc2dbe7875ba" "DataExpiração": "2017-12-22T10:41:53.4976772-02:00", "Sucesso": : true "Erro":: [] } |
|---|
Obter Fechamento de Caixa
Retorna a lista de fechamento de caixas por uma lista de lojas.
URL do Serviço POST: http://{url_do_servidor}/Chefwebapi/api/FechamentoCaixa/ObterFechamentoCaixa
Request
A requisição deve ser preenchida obedecendo os seguintes critérios:
*Token: Token de autenticação
*Lojas: Listagem de Lojas
*DataInicial: Data Inicial para consulta de um período de fechamento
*DataFinal: Data Final para consulta de um período de fechamento.
OBS: O período não pode ser superior a 30 dias. A data de término não poderá ser menor que a data de início do período.
*Preenchimento obrigatório
{ "Token": "2e9304ef-ce59-4d9b-9d16-b447ebff972d", } |
|---|
Response
O retorno do servidor será um JSON contendo uma lista de Fechamento de Caixa conforme os critérios preenchidos no "Request":
{ "Fechamentos": } |
|---|
Dicionário de Retorno
Informações sobre os retorno da API Obter Fechamento de Caixa
CodigoNaturezaFinanceira: Campo Utilizado para Integrar a Natureza financeira nos ERP’s;
Campos do Sistema: [ Conciliação de Caixa ]
| Campo da API | Campo do Banco de Dados |
| ValorBordero | Informação retornada pelo sistema (Valor do Banco de Dados) |
| ValorDiferencaDinheiroBordero | Diferença do Caixa com pagamento efetuado em DINHEIRO |
| ValorDiferencaChequeBordero | Diferença do Caixa com pagamento efetuado em CHEQUE |
| ValorDiferencaDinheiroRecebido | Diferença do Caixa com pagamento recebido em DINHEIRO |
| ValorDiferencaChequeRecebido | Diferença do Caixa com pagamento recebido em CHEQUE |
DescricaoFormaPagamento: Formas de pagamentos que foram recebidos pelo PDV.
| Tipo Pagamento | Descrição |
| DINHEIRO | |
| CARTÕES DE CRÉDITO | AMEX, VISA, ELO, MASTER, ENTRE OUTROS |
| DINHEIRO-CUPOM AUTOMATICO | Caso existam mesas em aberto por mais de 24h, por regra do PAF-ECF, é obrigatório o fechamento destas mesas. O Sistema “recebe” como esta forma de pagamento. |
Tipo de Usuário de Conferência: Deve respeitar a tabela abaixo.
Código | Tipo Usuário de Conferência |
O | OPERADOR |
G | GERENTE |
PeriodoMovimento: Período da abertura de caixa.
Código | Código |
1 | MANHÃ |
2 | TARDE |
3 | NOITE |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas