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": Usar SerialNumber
Request
{
"Usuario": "totvschef",
"Senha": 123456,
"NumeroSerialLoja":"96700001",
"Chave": "SerialNumber"
}
Response
O serviço retorna um JSON no formato abaixo: 1- Válido
Retorna todas as vendas agrupadas por fechamento de caixa de uma loja.
URL do Serviço POST: http://{url_do_servidor}/Chefwebapi/api/CapaVenda/ListPorNumeroFechamento
Request
A requisição deve ser preenchida obedecendo os seguintes critérios:
*Token:Token de autenticação
*CodigoLoja:Código da Loja
*Composicoes:informar true para exibição das composições de um produto composto caso existam ou informar false estes compostos não serão exibidos
*NumeroFechamento: Número de fechamento de caixa
*NumeroCaixa: Número do caixa
ValidaSaltoNota: O parâmetro ValidaSaltoNota pode ser preenchido com "False", indicando que toda a movimentação será integrada, ou "True", indicando que apenas datas com todos os documentos fiscais (se pulo de sequência) serão integradas. O valor padrão é "False. Obs: Parâmetro Opcional
NotasInutilizadas: informar true para exibição de notas inutilizadas, e false para que a notas inutilizadas não sejam consideradas. Obs: Parâmetro Opcional
*Preenchimento obrigatório
{
Token:"2d7f8eb0-268a-4adb-89e6-53285b01dba2",
CodigoLoja: "35",
Composicoes: true,
NumeroFechamento: "6",
NumeroCaixa: "18",
ValidaSaltoNota: false,
NotasInutilizadas: false
}
Response
O retorno do servidor será um JSON contendo uma lista de vendas conforme os critérios preenchidos no "Request":
Retorna todas as vendas de uma loja integradas ao ChefWeb.
URL do Serviço POST: http://{url_do_servidor}/Chefwebapi/api/CapaVenda/ListPorDataIntegracaoChefWeb
Request
A requisição deve ser preechida obedecendo os seguintes critérios:
*Token: Token de autenticação
*CodigoLoja : Código da Loja
*Composicoes:informar true para exibição das composições de um produto composto caso existam ou informar false estes compostos não serão exibidos
*DataInicialIntegracaoChefWeb: Data inicial do período critério de busca.
*DataFinalIntegracaoChefWeb : Data Final do período critério de busca. A DataFinalIntegracaoChefWeb não pode ser maior que a DataInicialIntegracaoChefWeb e o intervalo máximo configurado é de 1 dia.
*DataHoraUltimaIntegracaoChefWeb:Será utilizado como data inicial quando preenchido considerando também a hora e minuto passados na data.
ValidaSaltoNota: O parâmetro ValidaSaltoNota pode ser preenchido com "False", indicando que toda a movimentação será integrada, ou "True", indicando que apenas datas com todos os documentos fiscais (se pulo de sequência) serão integradas. O valor padrão é "False. Obs: Parâmetro Opcional
NotasInutilizadas: informar true para exibição de notas inutilizadas, e false para que a notas inutilizadas não sejam consideradas. Obs: Parâmetro Opcional
A consulta por intervalo de data de movimento tem por finalidade retornar todas as vendas, independentemente do status do caixa, aberto ou fechado, de uma loja integrada ao ChefWeb.
URL do Serviço POST: http://{url_do_servidor}/Chefwebapi/api/CapaVenda/ListPorDataMovimento
Request
A requisição deve ser preenchida obedecendo os seguintes critérios:
*Token: Token de autenticação
*CodigoLoja : Código da Loja
*Composicoes:informar true para exibição das composições de um produto composto caso existam ou informar false estes compostos não serão exibidos
*DataMovimentoInicial: Data inicial do período critério de busca.
*DataMovimentoFinal: Data Final do período critério de busca.
Online: Informartruepara exibição das vendas online e caixas Fechados, efalsepara não exibir somente vendas de caixas fechados. O padrão do sistema é false. Obs: Parâmetro Opcional
ValidaSaltoNota: O parâmetro ValidaSaltoNota pode ser preenchido com "False", indicando que toda a movimentação será integrada, ou "True", indicando que apenas datas com todos os documentos fiscais (se pulo de sequência) serão integradas. O valor padrão é "False. Obs: Parâmetro Opcional
NotasInutilizadas: informartruepara exibição de notas inutilizadas, efalsepara que a notas inutilizadas não sejam consideradas. Obs: Parâmetro Opcional
EnvioFaturamentoCaixaFechado: Informartruepara permitir apenas o retorno das vendas apenas quando todos os caixas estiverem fechados, efalsepara sejam retornados os registros de vendas independente de todos os caixas estiverem fechados. O padrão do sistema é false Obs: Parâmetro Opcional
Informação Importante: Para utilização de um código bandeira que possua texto em seu nome, usar o novo campo "CodigoBandeiraTexto" .
Dicionário de Retorno
Informações sobre os retorno da API CapaVenda
ModeloFiscal: Deve respeitar a tabela abaixo.
Modelo Fiscal
Código
SAT - Sistema autenticador e transmissor de cupons fiscais eletrônicos
1
NFCe - Nota Fiscal de Consumidor Eletrônica
2
BNF - Bloco de Notas Fiscais
3
ECF - Escrituração Contábil Fiscal
4
NFe - Nota Fiscal Eletrônica
5
ModuloVenda: Deve respeitar a tabela abaixo.
ModuloVenda
Código
PDV - Ponto de venda
1
PED - Processamento eletrônico de dados
2
Recebimento automático
3
Contingência
4
Emissor de Nfe(Nota fiscal eletrônica)
5
Pedido de Venda
6
Comanda - Mobile
7
ATM - Terminal de autoatendimento
8
StatusNotaNFCe: Deve respeitar a tabela abaixo.
Status da Nota NFCe(Nota fiscal de consumidor eletrônica)
Código
Emissão normal autorizada
1
Contingência pendente
2
Contingência autorizada
3
Contingência rejeitada
4
StatusVenda:Deve respeitar a tabela abaixo.
Status da Venda
Código
Aberto
1
Finalizado
2
Cancelado
3
Erro
4
StatusItemVenda: Deve respeitar a tabela abaixo.
Status do item de venda
Código
Finalizado
1
Cancelado
2
TipoPessoa: Deve respeitar a tabela abaixo.
Status da Venda
Código
Não informado
0
Física
1
Jurídica
2
TipoFormaPagamento:Deve respeitar a tabela abaixo.
Tipo de forma de pagamento
Código
Dinheiro
1
Cheque
2
Cartão
3
Ticket
4
Contra vale
5
Assinada
6
Cortesia
7
Boleto
8
FormaPagamentoCartao > TipoCartao: Deve conter um destes itens abaixo.
Tipo Cartao
DÉBITO
CRÉDITO
VOUCHER
PIX
TipoTransacao: Deve respeitar a tabela abaixo.
Tipo de transação
Código
TEF - Transferência eletrônica de fundos
1
POS - "Point of Sale" ou ponto de venda
2
Observação Importante sobre o uso da API
Para que não ocorra bloqueios por consumo indevido, as chamadas na API devem ter intervalos mínimos de 30 minutos entre cada chamada e o período de D - 3 máximo. Em caso de consumo de base histórica, este processo deverá ser efetuado durante o período de 23:00 às 06:00. Neste período, o intervalo entre chamadas poderá ser reduzido sem o risco de consumo indevido. Caso seja recorrente o consumo da base histórica, poderá acarretar em consumo indevido e bloqueio do uso da API.
