GET api/caixa/lancar

Efetua lançamentos no caixa, crédito ou débito

Request Information

URI Parameters

None.

Body Parameters

Informações com os dados do lançamento

Lancamento
NameDescriptionTypeAdditional information
operacao

1 = Crédito, 2 = Débito

integer

None.

debito_fonte_id

Em caso de débito, informar o código da fonte, ver: api/caixa/debito/fontes

integer

None.

debito_conta_id

Em caso de débito, informar o código da conta, ver: api/caixa/debito/contas

integer

None.

debito_subconta_id

Em caso de débito, informar o código da sub-conta, ver: api/caixa/debito/subcontas/{idconta}

integer

None.

debito_is_deposito

Em caso de débito, True indica que é depósito

boolean

None.

debito_is_transf_tesouraria

Em caso de débito, True indica que é transferência para a tesouraria

boolean

None.

valor_dinheiro

Valor em dinheiro

decimal number

None.

valor_cheque

Valor em cheque

decimal number

None.

cheques

Se informar o valor dos cheques, deve informar a lista de cheques

Collection of ChequesLista

None.

valor_cartao

Valor em cartão

decimal number

None.

historico

Descrição do lançamento que está sendo efetuado

string

None.

Request Formats

application/json, text/json

Sample:
{
  "operacao": 1,
  "debito_fonte_id": 2,
  "debito_conta_id": 3,
  "debito_subconta_id": 4,
  "debito_is_deposito": true,
  "debito_is_transf_tesouraria": true,
  "valor_dinheiro": 7.0,
  "valor_cheque": 8.0,
  "cheques": [
    {
      "id": 1,
      "valor": 2.0,
      "data_bom_para": "sample string 3"
    },
    {
      "id": 1,
      "valor": 2.0,
      "data_bom_para": "sample string 3"
    }
  ],
  "valor_cartao": 9.0,
  "historico": "sample string 10"
}

application/xml, text/xml

Sample:
<CaixaModels.Lancamento xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api_pgp">
  <cheques>
    <CaixaModels.ChequesLista>
      <data_bom_para>sample string 3</data_bom_para>
      <id>1</id>
      <valor>2</valor>
    </CaixaModels.ChequesLista>
    <CaixaModels.ChequesLista>
      <data_bom_para>sample string 3</data_bom_para>
      <id>1</id>
      <valor>2</valor>
    </CaixaModels.ChequesLista>
  </cheques>
  <debito_conta_id>3</debito_conta_id>
  <debito_fonte_id>2</debito_fonte_id>
  <debito_is_deposito>true</debito_is_deposito>
  <debito_is_transf_tesouraria>true</debito_is_transf_tesouraria>
  <debito_subconta_id>4</debito_subconta_id>
  <historico>sample string 10</historico>
  <operacao>1</operacao>
  <valor_cartao>9</valor_cartao>
  <valor_cheque>8</valor_cheque>
  <valor_dinheiro>7</valor_dinheiro>
</CaixaModels.Lancamento>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LancamentoRetorno
NameDescriptionTypeAdditional information
resposta

0 = ocorreu algum problema, 1 = Lançamento efetuado

integer

None.

msg

Descrição da resposta ao lançamento no caixa

string

None.

comprovante

Pode retorna aqui um comprovante em formato texto

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "resposta": 1,
  "msg": "sample string 2",
  "comprovante": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<CaixaModels.LancamentoRetorno xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api_pgp">
  <comprovante xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </comprovante>
  <msg>sample string 2</msg>
  <resposta>1</resposta>
</CaixaModels.LancamentoRetorno>