Páginas filhas
  • API - Obter Fechamento de Caixa

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

"Chave": Manter Padrão "Chave"


Request

{

"Usuario": "totvschef",

"Senha": 123456

"NumeroSerialLoja":"96700001",

"Chave": "Serial Number"

}

Response

O serviço retorna um JSON no formato abaixo:

{

   "Token": "69e9dde6-c91c-4c50-af1c-fc2dbe7875ba"

   "DataExpiração": "2017-12-22T10:41:53.4976772-02:00",

   "Sucesso": : true

   "Erro"::  []

}

Obter Fechamento de Caixa

...

*Preenchimento obrigatório

{

    "Token": "2e9304ef-ce59-4d9b-9d16-b447ebff972d",
    "Lojas": [101],
    "DataInicial": "2019-03-01T00:00:00.0000000-03:00",
    "DataFinal": "2019-03-30T23:59:59.0000000-03:00"

}

Response

O retorno do servidor será um JSON contendo uma lista de Fechamento de Caixa conforme os critérios preenchidos no "Request":

{

{

   "Fechamentos":
   [{
     "IdLoja": 50,
     "DescricaoLoja": "",
     "IdFechamento": 243,
     "NrFechamentoBordero": 0,
     "Caixa": 1,
     "NumeroCaixaMapping": 0,
     "CNPJ": """,
     "DataAbertura": "2019-06-24T17:02:38",
     "DataFechamento": "2019-06-24T17:05:24",
     "DataCriacao": "2019-10-29T20:50:21.0407616",
     "PeriodoMovimento": 2,
     "ValorTotalBordero": 277.2,
     "ValorTotalSistema": 277.2,
     "ValorTotalRecebido": 277.2,
     "ValorTotalDinheiro": 145.2,
     "ValorTotalCheque": 0.0,
     "ValorDiferencaDinheiroBordero": 0.0,
     "ValorDiferencaChequeBordero": 0.0,
     "ValorDiferencaDinheiroRecebido": 0.0,
     "ValorDiferencaChequeRecebido": 0.0,
     "IdOperadorCaixa": 1,
     "OperadorCaixa": "ALBINO",
     "IdOperadorCaixaFechamento": 1,
     "OperadorCaixaFechamento": "ALBINO",
     "IdUsuarioConferencia": 7908,
     "UsuarioConferencia": "RAFAEL.LIMA",
     "TipoUsuarioConferencia": "O",
     "DataCaixa": "2019-06-24T00:00:00",
     "Itens": [
     {
       "IdFormaPagamento": 1,
       "DescricaoFormaPagamento": "DINHEIRO",
       "ValorBordero": 145.2,
       "ValorSistema": 145.2,
       "ValorRecebido": 145.2,
       "Observacao": "",
       "NrFechamentoBordero": 0,
       "CodigoNaturezaFinanceira": "1"
     },
     {
       "IdFormaPagamento": 20011,
       "DescricaoFormaPagamento": "VISA",
       "ValorBordero": 132.0,
       "ValorSistema": 132.0,
       "ValorRecebido": 132.0,
       "Observacao": "",
       "NrFechamentoBordero": 0,
       "CodigoNaturezaFinanceira": "1"
     }],
     "Filial": null
     },
   [{
     "IdLoja": 50,
     "DescricaoLoja": "",
     "IdFechamento": 244,
     "NrFechamentoBordero": 0,
     "Caixa": 1,
     "NumeroCaixaMapping": 0,
     "CNPJ": """,
     "DataAbertura": "2019-06-25T09:06:04",
     "DataFechamento": "2019-06-25T17:03:46",
     "DataCriacao": "2019-10-29T20:50:21.0407616",
     "PeriodoMovimento": 1,
     "ValorTotalBordero": 561.27,
     "ValorTotalSistema": 561.27,
     "ValorTotalRecebido": 561.27,
     "ValorTotalDinheiro": 27.89,
     "ValorTotalCheque": 0.0,
     "ValorDiferencaDinheiroBordero": 0.0,
     "ValorDiferencaChequeBordero": 0.0,
     "ValorDiferencaDinheiroRecebido": 0.0,
     "ValorDiferencaChequeRecebido": 0.0,
     "IdOperadorCaixa": 1,
     "OperadorCaixa": "ALBINO",
     "IdOperadorCaixaFechamento": 1,
     "OperadorCaixaFechamento": "ALBINO",
     "IdUsuarioConferencia": 7908,
     "UsuarioConferencia": "RAFAEL.LIMA",
     "TipoUsuarioConferencia": "O",
     "DataCaixa": "2019-06-25T00:00:00",
     "Itens": [
     {
       "IdFormaPagamento": 1,
       "DescricaoFormaPagamento": "DINHEIRO",
       "ValorBordero": 27.89,
       "ValorSistema": 27.89,
       "ValorRecebido": 27.89,
       "Observacao": "",
       "NrFechamentoBordero": 0,
       "CodigoNaturezaFinanceira": "1"
     },
     {
       "IdFormaPagamento": 20011,
       "DescricaoFormaPagamento": "VISA",
       "ValorBordero": 533.38,
       "ValorSistema": 533.38,
       "ValorRecebido": 533.38,
       "Observacao": "",
       "NrFechamentoBordero": 0,
       "CodigoNaturezaFinanceira": "1"
     }],
     "Filial": null
     },
   [{
     "IdLoja": 50,
     "DescricaoLoja": "",
     "IdFechamento": 246,
     "NrFechamentoBordero": 0,
     "Caixa": 1,
     "NumeroCaixaMapping": 0,
     "CNPJ": "",
     "DataAbertura": "2019-06-26T15:58:13",
     "DataFechamento": "2019-06-27T08:34:12",
     "DataCriacao": "2019-10-29T20:50:21.0407616",
     "PeriodoMovimento": 2,
     "ValorTotalBordero": 0.0,
     "ValorTotalSistema": 121.78,
     "ValorTotalRecebido": 0.0,
     "ValorTotalDinheiro": 0.0,
     "ValorTotalCheque": 0.0,
     "ValorDiferencaDinheiroBordero": -121.78,
     "ValorDiferencaChequeBordero": 0.0,
     "ValorDiferencaDinheiroRecebido": -121.78,
     "ValorDiferencaChequeRecebido": 0.0,
     "IdOperadorCaixa": 1,
     "OperadorCaixa": "ALBINO",
     "IdOperadorCaixaFechamento": 1,
     "OperadorCaixaFechamento": "ALBINO",
     "IdUsuarioConferencia": 7908,
     "UsuarioConferencia": "RAFAEL.LIMA",
     "TipoUsuarioConferencia": "O",
     "DataCaixa": "2019-06-26T00:00:00",
     "Itens": [
     {
       "IdFormaPagamento": 1,
       "DescricaoFormaPagamento": "DINHEIRO",
       "ValorBordero": 0.0,
       "ValorSistema": 121.78,
       "ValorRecebido": 0.0,
       "Observacao": "TESTE",
       "NrFechamentoBordero": 0,
       "CodigoNaturezaFinanceira": "1"
     }],
     "Filial": null
     },
   [{
     "IdLoja": 50,
     "DescricaoLoja": "",
     "IdFechamento": 245,
     "NrFechamentoBordero": 0,
     "Caixa": 1,
     "NumeroCaixaMapping": 0,
     "CNPJ": "",
     "DataAbertura": "2019-06-26T08:53:37",
     "DataFechamento": "2019-06-26T14:53:51",
     "DataCriacao": "2019-10-29T20:50:21.0407616",
     "PeriodoMovimento": 1,
     "ValorTotalBordero": 217.88,
     "ValorTotalSistema": 217.88,
     "ValorTotalRecebido": 217.88,
     "ValorTotalDinheiro": 217.88,
     "ValorTotalCheque": 0.0,
     "ValorDiferencaDinheiroBordero": 0.0,
     "ValorDiferencaChequeBordero": 0.0,
     "ValorDiferencaDinheiroRecebido": 0.0,
     "ValorDiferencaChequeRecebido": 0.0,
     "IdOperadorCaixa": 1,
     "OperadorCaixa": "ALBINO",
     "IdOperadorCaixaFechamento": 1,
     "OperadorCaixaFechamento": "ALBINO",
     "IdUsuarioConferencia": 7908,
     "UsuarioConferencia": "RAFAEL.LIMA",
     "TipoUsuarioConferencia": "O",
     "DataCaixa": "2019-06-26T00:00:00",
     "Itens": [
     {
       "IdFormaPagamento": 1,
       "DescricaoFormaPagamento": "DINHEIRO",
       "ValorBordero": 217.88,
       "ValorSistema": 217.88,
       "ValorRecebido": 217.88,
       "Observacao": "TESTE",
       "NrFechamentoBordero": 0,
       "CodigoNaturezaFinanceira": "1"
     }],
     "Filial": null
     },
   }],
  "Sucesso": true,
  "Erros": []

}

Dicionário de Retorno

Informações sobre os retorno da API Obter Fechamento de Caixa


CodigoNaturezaFinanceira: Campo Utilizado para Integrar a Natureza financeira nos ERP’s;


Campos do Sistema: [ Conciliação de Caixa ]

Campo da APICampo do Banco de Dados
ValorBordero Informação retornada pelo sistema (Valor do Banco de Dados)
ValorDiferencaDinheiroBordero
Valor Calculado da Conciliação
Diferença do Caixa com pagamento efetuado em DINHEIRO
ValorDiferencaChequeBordero
Valor Calculado da Conciliação
Diferença do Caixa com pagamento efetuado em CHEQUE
ValorDiferencaDinheiroRecebidoDiferença do Caixa com pagamento recebido em DINHEIRO
ValorDiferencaChequeRecebidoDiferença do Caixa com pagamento recebido em CHEQUE


DescricaoFormaPagamento: Formas de pagamentos que foram recebidos pelo PDV.

Tipo PagamentoDescrição
DINHEIRO
CARTÕES DE CRÉDITOAMEX, VISA, ELO, MASTER, ENTRE OUTROS
DINHEIRO-CUPOMCaso existam mesas em aberto por mais de 24h, por regra do PAF-ECF, é obrigatório o fechamento destas mesas. O Sistema “recebe” como esta forma de pagamento.


Tipo de Usuário de Conferência: Deve respeitar a tabela abaixo.

Código

Tipo Usuário de Conferência

Código

OPERADOR [

O

]

1

OPERADOR

GERENTE [

G

]

2

GERENTE


PeriodoMovimento: Período da abertura de caixa.

Descrição

Código

Código

1

MANHÃ

1

2

TARDE

2

3

NOITE

3