...
"NumeroSerialLoja": Informar o Diretório Site do ambiente que deseja consultar as informações de venda
"Chave": Manter Padrão "Chave"Usar SerialNumber
Request
{ "Usuario": "totvschef", "Senha": 123456, "NumeroSerialLoja":"96700001", "Chave": "Serial NumberSerialNumber" } |
|---|
Response
O serviço retorna um JSON no formato abaixo:
1- Válido
...
*NumeroCaixa: Número do caixa
*ValidaSaltoNota 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
...
| Table Filter |
|---|
| id | 1571251449942_-1129844512 |
|---|
|
{
"Vendas": [
{
"ChaveVenda": "6fdb67fc-3312-489b-b513-00fa679166fa",
"DataMovimento": "2022-12-02T00:00:00",
"DataRecebimento": "2022-12-02T00:10:08",
"NumeroCupom": 1037,
"NumeroNota": 227918,
"SerieNota": "",
"SubSerieNota": "",
"SerieSAT": "000988086",
"SerieECF": "",
"ModeloFiscal": 1,
"IDSetorVenda": 0,
"StatusVenda": 2,
"QuantidadePessoas": 1,
"StatusNotaNFCe": null,
"ChaveSefaz": "35221207758701000303590009880862279186478933",
"ProtocoloAutorizacaoSefaz": "",
"DataIntegracaoChefweb": "2022-12-02T10:23:46.427",
"CPFFidelidadeIntegracao": "",
"Loja": {
"Codigo": 3,
"Nome": "LOJA DO SEU ZÉ",
"CNPJ": "10.148.261/0001-01",
"InscricaoEstadual": "257454426115"
},
"Cliente": null,
"DadosCancelamento": null,
"Caixa": {
"Data": "2022-12-01T00:00:00",
"Numero": 1,
"NumeroFechamento": 6,
"Operador": {
"Codigo": 6,
"Nome": "CAIXA MADRUGADA",
"Cpf": ""
}
},
"Itens": [
{
"Status": 1,
"Produto": {
"Codigo": 40,
"Nome": "COXINHA",
"Unidade": "UN",
"CodigoGrupo": 61,
"Grupo": "ESTOQUE",
"CodigoSubGrupo": 65,
"SubGrupo": "SALGADOS",
"NCM": "16023290",
"CodigoOperador": 6,
"NomeOperador": "CAIXA MADRUGADA",
"CamposCustomizaveis": {},
"Composicoes": null
},
"Convenio": null,
"Quantidade": 4.0,
"ValorUnitario": 9.0000,
"ValorDesconto": 0.0000,
"ValorAcrescimo": 0.0000,
"ValorTotal": 36.0000,
"Cfop": "5102",
"Cst": "000",
"Csosn": null,
"CEST": null,
"Tributo": "T",
"Pis": {
"Aliquota": 0.0000,
"Cst": "49",
"BaseCalculo": 29.5200,
"Valor": 0.00
},
"Cofins": {
"Aliquota": 0.0000,
"Cst": "49",
"BaseCalculo": 29.5200,
"Valor": 0.00
},
"Icms": {
"Aliquota": 18.0000,
"BaseCalculo": 36.00,
"Valor": 6.48
}
},
{
"Status": 1,
"Produto": {
"Codigo": 51,
"Nome": "GELATINA MOSAICO",
"Unidade": "UN",
"CodigoGrupo": 61,
"Grupo": "ESTOQUE",
"CodigoSubGrupo": 66,
"SubGrupo": "SOBREMESAS",
"NCM": "21069029",
"CodigoOperador": 6,
"NomeOperador": "CAIXA MADRUGADA",
"CamposCustomizaveis": {},
"Composicoes": null
},
"Convenio": null,
"Quantidade": 1.0,
"ValorUnitario": 10.0000,
"ValorDesconto": 0.0000,
"ValorAcrescimo": 0.0000,
"ValorTotal": 10.0000,
"Cfop": "5102",
"Cst": "000",
"Csosn": null,
"CEST": null,
"Tributo": "T",
"Pis": {
"Aliquota": 0.0000,
"Cst": "49",
"BaseCalculo": 8.2000,
"Valor": 0.00
},
"Cofins": {
"Aliquota": 0.0000,
"Cst": "49",
"BaseCalculo": 8.2000,
"Valor": 0.00
},
"Icms": {
"Aliquota": 18.0000,
"BaseCalculo": 10.00,
"Valor": 1.80
}
}
],
"Comissoes": [
{
"Tipo": 1,
"Valor": 0.0000,
"Funcionario": {
"Codigo": 6,
"Nome": "CAIXA MADRUGADA",
"Cpf": ""
}
}
],
"Pagamentos": [
{
"TipoFormaPagamento": 3,
"Descricao": "DEBITO",
"ValorRecebido": 46.0000,
"ValorEfetivo": 46.0000,
"CodigoCliente": 0,
"CPFCliente": "",
"FormaPagamentoCartao": {
"TipoTransacao": 2,
"CodigoCartao": 1,
"DadosTEF": null,
"TipoCartao": "DÉBITO",
"DataDeposito": "2022-12-02T00:00:00"
},
"IdPagamento": 1
}
],
"TotalizadorVenda": {
"ValorSubTotal": 46.0000,
"ValorTotalDescontoFiscal": 0.0000,
"ValorTotalDescontoSistema": 0.0000,
"ValorTotalAcrescimo": 0.0000,
"ValorTotalServico": 0.0000,
"ValorTotalTaxaEntrega": 0.0000,
"ValorTotal": 46.0000,
"ValorTroco": 0.0000,
"ValorTotalBaseCalculoICMS": 46.0000,
"ValorTotalICMS": 8.2800,
"ValorTotalBaseCalculoPIS": 46.0000,
"ValorTotalPIS": 0.0000,
"ValorTotalBaseCalculoCOFINS": 46.0000,
"ValorTotalCOFINS": 0.0000
},
"Descontos": null,
"ItemCancelado": null,
"TelaVenda": 2
}
],
"NotasInutilizadas": [],
"NotasCanceladas": [],
"Sucesso": true,
"Erros": []
} |
|---|
|
| 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 - 60 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. |
|---|
| Titulo | Observação Importante sobre o uso da API |
|---|
|
Por Intervalo de Data de Integração
Retorna todas as vendas de uma loja integradas ao ChefWeb.
Por Intervalo de Data de Integração
Retorna todas as vendas de uma loja integradas ao ChefWeb.
URL do Serviço POST: http://URL do Serviço POST: http://{url_do_servidor}/Chefwebapi/api/CapaVenda/ListPorDataIntegracaoChefWeb
...
*DataHoraUltimaIntegracaoChefWeb: Será utilizado como data inicial quando preenchido considerando também a hora e minuto passados na data.
*ValidaSaltoNota 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
...
"Icms": {
"Aliquota": 18,
"BaseCalculo": 66,
"Valor": 11.88
}
},
{
"Status": 1,
"Produto": {
"Codigo": 2,
"Nome": "TESTE PRODUTO 2",
"Unidade": "KG",
"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"
}
], "NotasInutilizadas": [],
} |
|---|
| 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 - 60 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. |
|---|
| Titulo | Observação Importante sobre o uso da API |
|---|
|
Por Intervalo de Data Movimento
Por Intervalo de Data Movimento
A consulta por intervalo de 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.
...
*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).
Online: Informar true para exibição das vendas online e caixas Fechados, e false para 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: informar true para exibição de notas inutilizadas, e false para que a notas inutilizadas não sejam consideradas. Obs: Parâmetro Opcional
EnvioFaturamentoCaixaFechado: Informar true para permitir apenas o retorno das vendas apenas quando todos os caixas estiverem fechados, e false para sejam retornados os registros de vendas independente de todos os caixas estiverem fechados. O padrão do sistema é false Obs: Parâmetro Opcional
*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 NotasInutilizadas : false }
|
|---|
...
, EnvioFaturamentoCaixaFechado: false }
|
|---|
...
Exemplo Retorno Vendas Cartão POS
...
{
"Vendas": [
{
"ChaveVenda": "6b846084-744e-4e9e-8776-afa0cb9fb317",
"DataMovimento": "2019-01-08T00:00:00",
"DataRecebimento": "2019-01-08T12:03:52",
"NumeroCupom": 67153,
"NumeroNota": 6393,
"SerieNota": "290",
"SubSerieNota": null,
"SerieSAT": null,
"SerieECF": null,
"ModeloFiscal": 2,
"IDSetorVenda": 0,
"StatusVenda": 2,
"QuantidadePessoas": 1,
"StatusNotaNFCe": 1,
"ChaveSefaz": "33190182373077000171652900000063931063774289",
"ProtocoloAutorizacaoSefaz": "333190000008599",
"DataIntegracaoChefweb": null,
"CPFFidelidadeIntegracao": "",
"Loja": {
"Codigo": 50,
"Nome": "LOJA DO SEU ZÉ",
"CNPJ": "10.148.261/0001-01",
"InscricaoEstadual": "257454426115"
},
"Cliente": null,
"DadosCancelamento": null,
"Caixa": {
"Data": "2019-01-08T00:00:00",
"Numero": 1,
"NumeroFechamento": 1,
"Operador": {
"Codigo": 1,
"Nome": "ALBINO",
"Cpf": ""
}
},
"Itens": [
{
"Status": 1,
"Produto": {
"Codigo": 1,
"Nome": "A FRANCESA",
"Unidade": "KG",
"CodigoGrupo": 2451,
"Grupo": "BOLOS",
"CodigoSubGrupo": 2455,
"SubGrupo": "TRADICIONAIS",
"NCM": "21069090",
"CodigoOperador": 1,
"NomeOperador": "ALBINO",
"CamposCustomizaveis": {
"CODIGOPROTHEUS": "TESTE TESTE ",
"TIPODEUVA": "NIAGARA"
},
"Composicoes": null
},
"Convenio": null,
"Quantidade": 1.0,
"ValorUnitario": 66.0100,
"ValorDesconto": 0.0000,
"ValorAcrescimo": 6.6100,
"ValorTotal": 72.6200,
"Cfop": "5102",
"Cst": "020",
"Csosn": null,
"CEST": "0300600",
"Tributo": "T",
"Pis": {
"Aliquota": 1.6500,
"Cst": "02",
"BaseCalculo": 0.0,
"Valor": 1.19
},
"Cofins": {
"Aliquota": 7.6000,
"Cst": "02"",
"BaseCalculo": 0.0,
"Valor": 5.51
},
"Icms": {
"Aliquota": 18.0000,
"BaseCalculo": 072.062,
"Valor": 513.5107
},
"Icms": {
"AliquotaCodigoDeBarras": 18.0000"",
"BaseCalculoDataVenda": 72.62"31/03/2023 09:58:19",
"ValorPrecoCompra": 1323.071000,
}"AtendenteVenda": "ALBINO",
}, "CodigoAtendenteVenda": 1 {
"Status": 1,
"Produto": {
"Codigo": 3,
"Nome": "ALPES SUICO",
"Unidade": "KG",
"CodigoGrupo": 2451,
"Grupo": "BOLOS",
"CodigoSubGrupo": 2455,
"SubGrupo": "TRADICIONAIS",
"NCM": "22021000",
"CodigoOperador": 1,
"NomeOperador": "ALBINO",
"CamposCustomizaveis": {
"CODIGOPROTHEUS": "",
"TIPODEUVA": ""
},
"Composicoes": null
},
"Convenio": null,
"Quantidade": 1.0,
"ValorUnitario": 61.0000,
"ValorDesconto": 0.0000,
"ValorAcrescimo": 6.0900,
"ValorTotal": 67.0900,
"Cfop": "5101",
"Cst": "040",
"Csosn": null,
"CEST": "0300600",
"Tributo": "T",
"Pis": {
"Aliquota": 0.6500,
"Cst": "01",
"BaseCalculo": 0.0,
"Valor": 0.43
},
"Cofins": {
"Aliquota": 3.0000,
"Cst": "01",
"BaseCalculo": 0.0,
"Valor": 2.01
},
"Icms": {
"Aliquota": 18.0000,
"BaseCalculo": 66.08,
"Valor": 11.89
}
}
],
"Comissoes": [
{
"Tipo": 1,
"Valor": 12.7000,
"Funcionario": {
"Codigo": 1,
"Nome": "ALBINO",
"Cpf": ""
}
}
],
"Pagamentos": [
{
"TipoFormaPagamento": 1,
"Descricao": "DINHEIRO",
"ValorRecebido": 139.7100,
"ValorEfetivo": 139.7100,
"CodigoCliente": 0,
"CPFCliente": "",
"FormaPagamentoCartao": null,
"IdPagamento": 1
}
],
"TotalizadorVenda": {
"ValorSubTotal": 127.0100,
"ValorTotalDescontoFiscal": 0.0000,
"ValorTotalDescontoSistema": 0.0000,
"ValorTotalAcrescimo": 12.7000,
"ValorTotalServico": 12.7000,
"ValorTotalTaxaEntrega": 0.0000,
"ValorTotal": 139.7100,
"ValorTroco": 0.0000,
"ValorTotalBaseCalculoICMS": 138.7000,
"ValorTotalICMS": 24.9600,
"ValorTotalBaseCalculoPIS": 139.7100,
"ValorTotalPIS": 1.6200,
"ValorTotalBaseCalculoCOFINS": 139.7100,
"ValorTotalCOFINS": 7.5200
},
"Descontos": null,
"ItemCancelado": null,
"TelaVenda": 6
}
],
"NotasInutilizadas": [],
"NotasCanceladas": [],
"Sucesso": true,
"Erros": []
} |
|---|
|
|---|
|
|---|
|
|---|
...
Tipo Cartao |
DÉBITO |
CRÉDITO |
VOUCHER |
PIX |
TipoTransacao: Deve respeitar a tabela abaixo.
...
| 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 D - 60 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 |
|---|
|
...
