CONTEÚDO
- Visão Geral
- Autenticação
- Consulta Contas a Pagar
- Dicionário de Dados
01. VISÃO GERAL
A API - Contas a Pagar permite a consulta, por sistemas externos, de despesas lançadas no TOTVS Varejo Food Service Retaguarda.
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.
Servidor
url_do_servidor: chefweb.chef.totvs.com.br/chefwebapi
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": Será informado "CentralNumber"
Request
{ "Usuario": "totvschef", "Senha": 123456, "NumeroSerialLoja":"96700001", "Chave": "CentralNumber" } |
---|
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 CONTAS A PAGAR
Por Data de Lançamento
URL do Serviço GET: http://{url_do_servidor}/chefwebapi/api/Financeiro/ListContasPagar
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
{ "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":
{ "ContasPagar": [ { "NumeroControle": 19, "Credor": "TESTE TESTE TESTE", "Valor": 150.00, "PlanoContas": "PLANO DE CONTAS ALTERACAO", "NumeroDocumento": "", "Pagamento": true, "DataPagamento": "2019-12-03T03:00:00", "ValorPagamento": 150.00, "DataAtualizacao": "2019-12-03T00:00:00", "Operador": "TOTVS", "DataVencimento": "2019-12-03T12:00:00", "Banco": "", "DataEmissao": "2019-12-03T00:00:00", "DataCompetencia": "2019-12-03T12:26:58.21", "PlanoContas2": "VIM DO LIVRO CAIXA", "CodigoBarras": "", "Loja": 50, "DataRegistro": "2019-12-03T12:26:58.21", "Compra": false, "Investimento": false, "Deletado": false, "Cheque": " TESTE NOVO MULTI", "NPedido": 0, "EmissaoPagamento": "2019-12-03T03:00:00", "PagamentoMultiplo": false, "Frete": false, "CNPJ": "82.373.077/0020-34", "IE": "ISENTO", "UF": "SP", "ModeloNF": 0, "SerieNF": "", "SubSerieNF": "", "CFOP": 0, "BaseCalculoICMS": 0.00, "ValorICMS": 0.00, "IsentaOuNaoTributada": 0.00, "Outras": 0.00, "ModalidadeFrete": 0, "NumeroControleRecebimento": 0, "PlanoMultiplo": 0 }, { "NumeroControle": 20, "Credor": "TESTE TESTE TESTE", "Valor": 150.00, "PlanoContas": "PLANO DE CONTAS ALTERACAO", "NumeroDocumento": "", "Pagamento": true, "DataPagamento": "2019-12-03T11:30:57", "ValorPagamento": 150.00, "DataAtualizacao": "2019-12-03T00:00:00", "Operador": "TOTVS", "DataVencimento": "2020-01-03T12:00:00", "Banco": "", "DataEmissao": "2019-12-03T00:00:00", "DataCompetencia": "2019-12-03T12:27:19.053", "PlanoContas2": "VIM DO LIVRO CAIXA", "CodigoBarras": "", "Loja": 50, "DataRegistro": "2019-12-03T12:27:19.053", "Compra": false, "Investimento": false, "Deletado": false, "Cheque": " TESTE NOVO MULTI", "NPedido": 0, "EmissaoPagamento": "2019-12-03T03:00:00", "PagamentoMultiplo": false, "Frete": false, "CNPJ": "82.373.077/0020-34", "IE": "ISENTO", "UF": "SP", "ModeloNF": 0, "SerieNF": "", "SubSerieNF": "", "CFOP": 0, "BaseCalculoICMS": 0.00, "ValorICMS": 0.00, "IsentaOuNaoTributada": 0.00, "Outras": 0.00, "ModalidadeFrete": 0, "NumeroControleRecebimento": 0, "PlanoMultiplo": 0 } ], "Sucesso": true, "Erros": [] } |
---|
|
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.