...
Como autenticar via API ChefWeb
url_do_servidor: chefweb.chef.totvs.com.br/chefwebapi
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.
...
*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
*Preenchimento obrigatório
...
{
Token:"2d7f8eb0-268a-4adb-89e6-53285b01dba2"
CodigoLoja: "96700001",
NumeroFechamento: "6",
NumeroCaixa: "18"
}
*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.
*NotasInutilizadas: informar true para exibição de notas inutilizadas, e false para que a notas inutilizadas não sejam consideradas.
*Preenchimento obrigatório
{ Token:"2d7f8eb0-268a-4adb-89e6-53285b01dba2", CodigoLoja: "35", Composicoes: true, NumeroFechamento: "6", NumeroCaixa: "18", ValidaSaltoNota: false, NotasInutilizadas: false } |
---|
Response
Response
O retorno do servidor será um JSON contendo uma lista de vendas conforme os critérios preenchidos no "Request":
Table Filter | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||
"Codigo": 123, "Nome": "LOJA TESTE", "CNPJ": "82.373.077/0001-71", "InscricaoEstadual": "111111111111" }, "Cliente": { "Codigo": 19, "Nome": "TESTE DE CAPA VENDA", "TipoPessoa": 1, "Documento": "00000000191" },
}
"SubGrupo": "SUB GRUPO TESTE", "NCM": "11010010", "CamposCustomizaveis": { "CustomA": "Custom A", "CustomB": "true", "CustomC": "123" } }, "Quantidade": 1, "ValorUnitario": 66, "ValorDesconto": 0, "ValorAcrescimo": 0, "ValorTotal": 66, "Cfop": "5102", "Cst": "020", "Csosn": null, "CEST": "0300600", "Tributo": "T", "Pis": { "Aliquota": 0, "Cst": "49", "BaseCalculo": 0, "Valor": 0 }, "Cofins": { "Aliquota": 0,
"Valor": 11.88 } }, { "Status": 1, "Produto": { "Codigo": 2, "Nome": "TESTE PRODUTO 2", "Unidade": "KG", "Grupo": "GRUPO TESTE", "SubGrupo": "SUB GRUPO TESTE", "NCM": "19059090", "CamposCustomizaveis": {} }, "Quantidade": 1, "ValorUnitario": 33.99, "ValorDesconto": 0, "ValorAcrescimo": 0, "ValorTotal": 33.99, "Cfop": "5101", "Cst": "020", "Csosn": null, "CEST": null, "Tributo": "T", "Pis": { "Aliquota": 0, "Cst": "07", "BaseCalculo": 0, "Valor": 0 }, "Cofins": { "Aliquota": 0, "Cst": "07", "BaseCalculo": 0, "Valor": 0 }, "Icms": { "Aliquota": 18, "BaseCalculo": 33.99, "Valor": 6.11 } } ], "Comissoes": null, "Pagamentos": [ { "TipoFormaPagamento": 1, "Descricao": "DINHEIRO", "ValorRecebido": 99.99, "ValorEfetivo": 99.99, "FormaPagamentoCartao": null } ], "TotalizadorVenda": { "ValorSubTotal": 99.99, "ValorTotalDescontoFiscal": 0, "ValorTotalDescontoSistema": 0, "ValorTotalAcrescimo": 0, "ValorTotalServico": 0, "ValorTotalTaxaEntrega": 0, "ValorTotal": 99.99, "ValorTroco": 0, "ValorTotalBaseCalculoICMS": 99.99, "ValorTotalICMS": 17.99, "ValorTotalBaseCalculoPIS": 0, "ValorTotalPIS": 0, "ValorTotalBaseCalculoCOFINS": 0, "ValorTotalCOFINS": 0 }, "TelaVenda": 4 } ], "Sucesso": true, "Erros": [ { "CodigoErro": 999, "DescricaoErro": "Erro Teste Documentação" } ] } |
Pagamentos
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
*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.
*Preenchimento obrigatório
...
{
Token
:
"cf82bad6-aa4d-47b2-aaff-ff299f7e81fa",
CodigoLoja
:
"50",
DataInicialIntegracaoChefweb
:
"2017-06-06T15:36:12",
DataFinalIntegracaoChefweb
:
"2017-06-13T15:36:12"
DataHoraUltimaIntegracaoChefweb
:
"2017-06-06T15:36:12",
}
Response
...
{
"Vendas": [
{
"ChaveVenda": "b59c3261-d214-45e9-9324-817560a4efbc",
"DataMovimento": "2019-03-21T00:00:00",
"DataRecebimento": "2019-03-21T16:57:32",
"DataIntegracaoChefweb": "2019-03-21T16:57:32",
"NumeroCupom": 68018,
"NumeroNota": 6593,
"SerieNota": "290",
"SubSerieNota": null,
"SerieSAT": null,
"SerieECF": null,
"ModeloFiscal": 2,
"IDSetorVenda": 0,
"StatusVenda": 2,
"QuantidadePessoas": 1,
"StatusNotaNFCe": 1,
"ChaveSefaz": "41190382373077099999999900000065931046261791",
"ProtocoloAutorizacaoSefaz": "141199999366915",
"Loja": {
"Codigo": 123,
"Nome": "LOJA TESTE",
"CNPJ": "82.373.077/0001-71",
"InscricaoEstadual": "111111111111"
},
"Cliente": {
"Codigo": 19,
"Nome": "TESTE DE CAPA VENDA",
"TipoPessoa": 1,
"Documento": "00000000191"
},
"DadosCancelamento": null,
"Caixa": {
"Data": "2019-03-21T00:00:00",
"Numero": 1,
"NumeroFechamento": 95,
"Operador": {
"Codigo": 1,
"Nome": "TESTE OPERADOR",
"Cpf": null
}
},
"Itens": [
{
"Status": 1,
"Produto": {
"Codigo": 1,
"Nome": "PRODUTO TESTE",
"Unidade": "KG",
"Grupo": "GRUPO TESTE",
"SubGrupo": "SUB GRUPO TESTE",
"NCM": "11010010",
"CamposCustomizaveis": {
"CustomA": "Custom A",
"CustomB": "true",
"CustomC": "123"
}
},
"Quantidade": 1,
"ValorUnitario": 66,
"ValorDesconto": 0,
"ValorAcrescimo": 0,
"ValorTotal": 66,
"Cfop": "5102",
"Cst": "020",
"Csosn": null,
"CEST": "0300600",
"Tributo": "T",
"Pis": {
"Aliquota": 0,
"Cst": "49",
"BaseCalculo": 0,
"Valor": 0
},
"Cofins": {
"Aliquota": 0,
"Cst": "49",
"BaseCalculo": 0,
"Valor": 0
},
"Icms": {
"Aliquota": 18,
"BaseCalculo": 66,
"Valor": 11.88
}
},
{
"Status": 1,
"Produto": {
"Codigo": 2,
"Nome": "TESTE PRODUTO 2",
"Unidade": "KG",
"Grupo": "GRUPO TESTE",
"SubGrupo": "SUB GRUPO TESTE",
"NCM": "19059090",
"CamposCustomizaveis": {}
},
"Quantidade": 1,
"ValorUnitario": 33.99,
"ValorDesconto": 0,
"ValorAcrescimo": 0,
"ValorTotal": 33.99,
"Cfop": "5101",
"Cst": "020",
"Csosn": null,
"CEST": null,
"Tributo": "T",
"Pis": {
"Aliquota": 0,
"Cst": "07",
"BaseCalculo": 0,
"Valor": 0
},
"Cofins": {
"Aliquota": 0,
"Cst": "07",
"BaseCalculo": 0,
"Valor": 0
},
"Icms": {
"Aliquota": 18,
"BaseCalculo": 33.99,
"Valor": 6.11
}
}
],
"Comissoes": [
{
"Tipo": 1,
"Valor": 6.1,
"Funcionario": {
"Codigo": 1,
"Nome": "CORDEIRO",
"Cpf": "112.644.158-93"
}
}
],
"Pagamentos": [
{
"TipoFormaPagamento": 1,
"Descricao": "DINHEIRO",
"ValorRecebido": 99.99,
"ValorEfetivo": 99.99,
"FormaPagamentoCartao": null
}
],
"TotalizadorVenda": {
"ValorSubTotal": 99.99,
"ValorTotalDescontoFiscal": 0,
"ValorTotalDescontoSistema": 0,
"ValorTotalAcrescimo": 0,
"ValorTotalServico": 0,
"ValorTotalTaxaEntrega": 0,
"ValorTotal": 99.99,
"ValorTroco": 0,
"ValorTotalBaseCalculoICMS": 99.99,
"ValorTotalICMS": 17.99,
"ValorTotalBaseCalculoPIS": 0,
"ValorTotalPIS": 0,
"ValorTotalBaseCalculoCOFINS": 0,
"ValorTotalCOFINS": 0
},
"TelaVenda": 4
}
],
"Sucesso": true,
"Erros": [
{
"CodigoErro": 999,
"DescricaoErro": "Erro Teste Documentação"
}
]
}
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
*DataMovimentoInicial: Data inicial do período critério de busca.
*DataMovimentoFinal: Data Final do período critério de busca.
Online: O parâmetro Online pode ser preenchido com 0(Zero), somente caixas fechados ou 1(Um) para caixas abertos e fechados. O valor padrão é 0(Zero).
*Preenchimento obrigatório
...
{
Token
:
"cf82bad6-aa4d-47b2-aaff-ff299f7e81fa",
CodigoLoja
:
"50",
DataMovimentoInicial
:
"2017-06-06T15:36:12",
DataMovimentoFinal
:
"2017-06-13T15:36:12",
Online
:
"1"
}
|
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.
*NotasInutilizadas: informar true para exibição de notas inutilizadas, e false para que a notas inutilizadas não sejam consideradas.
*Preenchimento obrigatório
Token:"2d7f8eb0-268a-4adb-89e6-53285b01dba2", CodigoLoja: "50", Composicoes: true, DataInicialIntegracaoChefweb: "2017-06-06T15:36:12", DataFinalIntegracaoChefweb: "2017-06-13T15:36:12", DataHoraUltimaIntegracaoChefweb: "2017-06-06T15:36:12", ValidaSaltoNota: false, NotasInutilizadas: false
|
---|
Response
"NotasInutilizadas": [], |
---|
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: O parâmetro Online pode ser preenchido com 0(Zero), somente caixas fechados ou 1(Um) para caixas abertos e fechados. O valor padrão é 0(Zero).
*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.
*NotasInutilizadas: informar true para exibição de notas inutilizadas, e false para que a notas inutilizadas não sejam consideradas.
*Preenchimento obrigatório
Token:"2d7f8eb0-268a-4adb-89e6-53285b01dba2", CodigoLoja: "50", Composicoes: true, DataMovimentoInicial: "2017-06-06T00:00:00", DataMovimentoFinal: "2017-06-06T23:59:59", Online: 1, ValidaSaltoNota: true, NotasInutilizadas : false
|
---|
Response
{ |
---|
Response
{ |
---|
Response
...
{
"Vendas": [
{
"ChaveVenda": "b59c3261-d214-45e9-9324-817560a4efbc",
"DataMovimento": "2019-03-21T00:00:00",
"DataRecebimento": "2019-03-21T16:57:32",
"NumeroCupom": 68018,
"NumeroNota": 6593,
"SerieNota": "290",
"SubSerieNota": null,
"SerieSAT": null,
"SerieECF": null,
"ModeloFiscal": 2,
"IDSetorVenda": 0,
"StatusVenda": 2,
"QuantidadePessoas": 1,
"StatusNotaNFCe": 1,
"ChaveSefaz": "41190382373077099999999900000065931046261791",
"ProtocoloAutorizacaoSefaz": "141199999366915",
"Loja": {
"Codigo": 123,
"Nome": "LOJA TESTE",
"CNPJ": "82.373.077/0001-71",
"InscricaoEstadual": "111111111111"
},
"Cliente": {
"Codigo": 19,
"Nome": "TESTE DE CAPA VENDA",
"TipoPessoa": 1,
"Documento": "00000000191"
},
"DadosCancelamento": null,
"Caixa": {
"Data": "2019-03-21T00:00:00",
"Numero": 1,
"NumeroFechamento": 95,
"Operador": {
"Codigo": 1,
"Nome": "TESTE OPERADOR",
"Cpf": null
}
},
"Itens": [
{
"Status": 1,
"Produto": {
"Codigo": 1,
"Nome": "PRODUTO TESTE",
"Unidade": "KG",
"Grupo": "GRUPO TESTE",
"SubGrupo": "SUB GRUPO TESTE",
"NCM": "11010010",
"CamposCustomizaveis": {
"CustomA": "Custom A",
"CustomB": "true",
"CustomC": "123"
}
},
"Quantidade": 1,
"ValorUnitario": 66,
"ValorDesconto": 0,
"ValorAcrescimo": 0,
"ValorTotal": 66,
"Cfop": "5102",
"Cst": "020",
"Csosn": null,
"CEST": "0300600",
"Tributo": "T",
"Pis": {
"Aliquota": 0,
"Cst": "49",
"BaseCalculo": 0,
"Valor": 0
},
"Cofins": {
"Aliquota": 0,
"Cst": "49",
"BaseCalculo": 0,
"Valor": 0
},
"Icms": {
"Aliquota": 18,
"BaseCalculo": 66,
"Valor": 11.88
}
},
{
"Status": 1,
"Produto": {
"Codigo": 2,
"Nome": "TESTE PRODUTO 2",
"Unidade": "KG",
"Grupo": "GRUPO TESTE",
"SubGrupo": "SUB GRUPO TESTE",
"NCM": "19059090",
"CamposCustomizaveis": {}
},
"Quantidade": 1,
"ValorUnitario": 33.99,
"ValorDesconto": 0,
"ValorAcrescimo": 0,
"ValorTotal": 33.99,
"Cfop": "5101",
"Cst": "020",
"Csosn": null,
"CEST": null,
"Tributo": "T",
"Pis": {
"Aliquota": 0,
"Cst": "07",
"BaseCalculo": 0,
"Valor": 0
},
"Cofins": {
"Aliquota": 0,
"Cst": "07",
"BaseCalculo": 0,
"Valor": 0
},
"Icms": {
"Aliquota": 18,
"BaseCalculo": 33.99,
"Valor": 6.11
}
}
],
"Comissoes": [
{
"Tipo": 1,
"Valor": 6.1,
"Funcionario": {
"Codigo": 1,
"Nome": "CORDEIRO",
"Cpf": "112.644.158-93"
}
}
],
"Pagamentos": [
{
"TipoFormaPagamento": 1,
"Descricao": "DINHEIRO",
"ValorRecebido": 99.99,
"ValorEfetivo": 99.99,
"FormaPagamentoCartao": null
}
],
"TotalizadorVenda": {
"ValorSubTotal": 99.99,
"ValorTotalDescontoFiscal": 0,
"ValorTotalDescontoSistema": 0,
"ValorTotalAcrescimo": 0,
"ValorTotalServico": 0,
"ValorTotalTaxaEntrega": 0,
"ValorTotal": 99.99,
"ValorTroco": 0,
"ValorTotalBaseCalculoICMS": 99.99,
"ValorTotalICMS": 17.99,
"ValorTotalBaseCalculoPIS": 0,
"ValorTotalPIS": 0,
"ValorTotalBaseCalculoCOFINS": 0,
"ValorTotalCOFINS": 0
},
"TelaVenda": 4
}
],
"Sucesso": true,
"Erros": [
{
"CodigoErro": 999,
"DescricaoErro": "Erro Teste Documentação"
}
]
}
Response
{ [ "FormaPagamentoCartao": { |
---|
Informações sobre os retorno da API CapaVenda
ModeloFiscal: Deve respeitar a tabela abaixo.
17.99, |
---|
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 | |
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 |
...
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 |
Card documentos Informacao 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. Titulo Observação Importante sobre o uso da API
Button Texto Outras integrações do Chef Web Link http://tdn.totvs.com/display/TChef/TOTVS+Chef+Web
...