CONTEÚDO
- Visão Geral
- Autenticação
- Consulta Contas a Pagar
- Dicionário de Retorno
01. VISÃO GERAL
Servidor
url_do_servidor: chefweb.chef.totvs.com.br/chefwebapi
02. AUTENTICAÇÃO
Geração Token
Para realizar qualquer acesso às consultas disponibilizadas é necessário solicitar um Token de autenticação, através da API "Gerar Token". Nessa chamada devem ser informados o usuário, a senha e o número de série do cliente que deseja consultar. O método retornará Token de acesso, com duração de 2 minutos. Este Token será composto de um código aleatório, do tipo string (Exemplo: ZQGL16Q3D43mhSi8nw8s3j2HhZPQ9Ei6), que deverá ser utilizado em uma chamada da API.
Não é possível reutilizar o Token de autenticação, sendo assim para cada chamada, dos métodos da API, deverá ser solicitado um novo.
Caso o Token gerado não seja utilizado em até 2 minutos ele estará automaticamente cancelado.
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
Response
O serviço retorna um JSON no formato abaixo:
1- Válido
{ "Token": "69e9dde6-c91c-4c50-af1c-fc2dbe7875ba" "DataExpiração": "2017-12-22T10:41:53.4976772-02:00", "Sucesso": : true "Erro":: [] } |
---|
03. CONSULTA LIVRO CAIXA
Por Data de Lançamento
URL do Serviço POST: http://{url_do_servidor}/chefwebapi/api/Financeiro/ListLivroCaixa
Request
A requisição deve ser preenchida obedecendo os seguintes critérios:
Token: Token de autenticação - Obrigatório
CodigoLoja: Código da Loja - Obrigatório
DataInicial: Data inicial do período critério de busca - Obrigatório
DataFinal: Data Final do período critério de busca - Obrigatório
Table Filter |
---|
id | 1642513076124_-2140218130 |
---|
|
{ "Token": "802ba82d-06ad-4948-acc0-0f62d671f393", "CodigoLoja": "50", "DataInicial": "2019-12-01T00:00:00", "DataFinal": "2019-12-22T23:59:59" } |
---|
|
|
Response
O retorno do servidor será um JSON contendo uma lista de vendas conforme os critérios preenchidos no "Request":
{ "LivroCaixa": [ { "Controle": 9, "QuantidadeContasAPagar": 0, "PermitirAlterar": false, "DataLancamento": "2019-12-03T11:30:57", "DataEmissao": "2019-12-03T00:00:00", "Entrada": 0.00, "Saida": 150.00, "Saldo": -411.99, "Banco": "SANTANDER", "Cheque": "", "Documento": "", "Extorno": false, "Operador": "TOTVS", "CodigoConta": 3, "Historico1": " TESTE NOVO MULTI", "Historico2": " ", "Historico3": " ", "NDocumento": "", "CodigoContabil": 0.0, "DescricaoContabil": "", "Loja": 50, "PlanoContas": "02 - CUSTOS OPERACIONAIS", "PlanoContas2": "CUST. OP 27 MANUTENCAO", "CodigoBarras": "", "Compensado": false, "ValorOriginal": 150.00, "Fornecedor": "TESTE TESTE TESTE", "Transfere": false, "NumeroControle": 19, "NumeroControles": null, "DataAtualizacao": "2019-12-03T12:30:57.263", "NumeroControleRecebimento": 0, "Automatico": false, "Contador": 9, "Deletado": false, "OperadorDelete": null, "DataDelete": "0001-01-01T00:00:00", "MotivoDelete": null, "PagamentoMultiplo": true, "DataOperacao": "2019-12-03T11:30:57.42", "DataEmissaoNovo": "2019-12-03T00:00:00", "PlanoMultiplo": null, "Transferido": false },
{ "Controle": 21, "QuantidadeContasAPagar": 0, "PermitirAlterar": false, "DataLancamento": "2019-12-03T11:25:54", "DataEmissao": "2019-12-03T00:00:00", "Entrada": 0.00, "Saida": 100.00, "Saldo": -185.36, "Banco": "MASTERCARD", "Cheque": "", "Documento": "", "Extorno": false, "Operador": "TOTVS", "CodigoConta": 2, "Historico1": " TESTE NOVO", "Historico2": "", "Historico3": "", "NDocumento": "", "CodigoContabil": 0.0, "DescricaoContabil": "", "Loja": 50, "PlanoContas": "02 - CUSTOS OPERACIONAIS", "PlanoContas2": "CUST. OP 27 MANUTENCAO", "CodigoBarras": "", "Compensado": false, "ValorOriginal": 100.00, "Fornecedor": "TESTE TESTE TESTE", "Transfere": false, "NumeroControle": 1, "NumeroControles": null, "DataAtualizacao": "2019-12-03T12:25:53.963", "NumeroControleRecebimento": 0, "Automatico": false, "Contador": 21, "Deletado": false, "OperadorDelete": null, "DataDelete": "0001-01-01T00:00:00", "MotivoDelete": null, "PagamentoMultiplo": false, "DataOperacao": "2019-12-03T11:25:54.077", "DataEmissaoNovo": "2019-12-03T00:00:00", "PlanoMultiplo": null, "Transferido": false } ], "Sucesso": true, "Erros": [] }
|
---|
|
Card documentos |
---|
Informacao | Use esse box para destacar informações relevantes e/ou de destaque. |
---|
Titulo | IMPORTANTE! |
---|
|
04. DICIONÁRIO DE DADOS
- Número de Série: É o número de licença que identifica cada cliente TOTVS Varejo Food Service Retaguarda em nosso ambiente.
HTML |
---|
<!-- esconder o menu -->
<style>
div.theme-default .ia-splitter #main {
margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
display: none;
}
#main {
padding-left: 10px;
padding-right: 10px;
overflow-x: hidden;
}
.aui-header-primary .aui-nav, .aui-page-panel {
margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
margin-left: 0px !important;
}
</style>
|