GET api/caixa/recebimento/concluir

Conclui o recebimento da mensalidade do cliente

Request Information

URI Parameters

None.

Body Parameters

Informações de valores recebidos e dos titulos a serem pagos

Concluir
NameDescriptionTypeAdditional information
cadastro_id

Código do cadastro do cliente

integer

None.

valor_dinheiro

Valor pago em dinheiro

decimal number

None.

valor_cheque

Valor pago em cheque

decimal number

None.

valor_cartao

Valor pago em cartão

decimal number

None.

valor_troco

Valor do troco

decimal number

None.

cheques

Lista dos cheques, caso pagamento via cheque

Collection of ChequesLista

None.

titulos

Lista dos títulos envolvidos no pagamento

Collection of TitulosPendentes

None.

cartao_tipo

Informe 0-Se não for cartão, 1-cartão de crédito, 2-cartão de débito

integer

None.

cartao_maquineta_id

Código da maquineta do caixa do operador

integer

None.

cartao_nr_parcelas

Se pagamento com cartão, informar o número de parcelas

integer

None.

reativar_cadastro_encerrado

Se o cadastro estiver encerrado, True indica se deve reativar o cadastro após o recebimento e fechar ordem de serviço de retirada

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "cadastro_id": 1,
  "valor_dinheiro": 2.0,
  "valor_cheque": 3.0,
  "valor_cartao": 4.0,
  "valor_troco": 5.0,
  "cheques": [
    {
      "id": 1,
      "valor": 2.0,
      "data_bom_para": "sample string 3"
    },
    {
      "id": 1,
      "valor": 2.0,
      "data_bom_para": "sample string 3"
    }
  ],
  "titulos": [
    {
      "titulo_numero": 1,
      "vencimento": "sample string 2",
      "dias_atraso": 3,
      "valor_documento": 4.0,
      "valor_desconto": 5.0,
      "valor_juros": 6.0,
      "valor_total": 7.0,
      "descricao_titulo": "sample string 8",
      "descricao_desconto": "sample string 9"
    },
    {
      "titulo_numero": 1,
      "vencimento": "sample string 2",
      "dias_atraso": 3,
      "valor_documento": 4.0,
      "valor_desconto": 5.0,
      "valor_juros": 6.0,
      "valor_total": 7.0,
      "descricao_titulo": "sample string 8",
      "descricao_desconto": "sample string 9"
    }
  ],
  "cartao_tipo": 6,
  "cartao_maquineta_id": 7,
  "cartao_nr_parcelas": 8,
  "reativar_cadastro_encerrado": true
}

application/xml, text/xml

Sample:
<Recebimento.Concluir xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api_pgp">
  <cadastro_id>1</cadastro_id>
  <cartao_maquineta_id>7</cartao_maquineta_id>
  <cartao_nr_parcelas>8</cartao_nr_parcelas>
  <cartao_tipo>6</cartao_tipo>
  <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>
  <reativar_cadastro_encerrado>true</reativar_cadastro_encerrado>
  <titulos>
    <Recebimento.TitulosPendentes>
      <descricao_desconto>sample string 9</descricao_desconto>
      <descricao_titulo>sample string 8</descricao_titulo>
      <dias_atraso>3</dias_atraso>
      <titulo_numero>1</titulo_numero>
      <valor_desconto>5</valor_desconto>
      <valor_documento>4</valor_documento>
      <valor_juros>6</valor_juros>
      <valor_total>7</valor_total>
      <vencimento>sample string 2</vencimento>
    </Recebimento.TitulosPendentes>
    <Recebimento.TitulosPendentes>
      <descricao_desconto>sample string 9</descricao_desconto>
      <descricao_titulo>sample string 8</descricao_titulo>
      <dias_atraso>3</dias_atraso>
      <titulo_numero>1</titulo_numero>
      <valor_desconto>5</valor_desconto>
      <valor_documento>4</valor_documento>
      <valor_juros>6</valor_juros>
      <valor_total>7</valor_total>
      <vencimento>sample string 2</vencimento>
    </Recebimento.TitulosPendentes>
  </titulos>
  <valor_cartao>4</valor_cartao>
  <valor_cheque>3</valor_cheque>
  <valor_dinheiro>2</valor_dinheiro>
  <valor_troco>5</valor_troco>
</Recebimento.Concluir>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Resposta
NameDescriptionTypeAdditional information
resposta

1-Indica que tudo ocorreu bem, 0-Houve algum erro

integer

None.

msg

Mensagem de erro

string

None.

comprovante

Comprovante texto do recebimento

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:
<Recebimento.Resposta 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>
</Recebimento.Resposta>