Imóveis › Finalidades

Alterar

<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis</aside>
put/buildings/{building_id}/purposes/{id}

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/buildings/{building_id}/purposes/{id}
  • Auth: HTTP bearer

Request body

typestring

Tipo de finalidade.

currencystring

Código da moeda.

amountnumber

Valor.

amount_originalnumber

Valor original; preenchido liga a promoção e o amount passa a ser o valor promocional.

discount_typestring

Legado: use amount_original. Quando vier com discount e sem amount_original, é convertido (amount_original = amount informado; amount = valor com desconto, 'value' em R$ ou 'percentage' em %).

discountnumber

Legado: valor do desconto de discount_type; convertido como descrito acima.

amount_maxnumber

Valor da alta temporada (somente temporada).

conditionstring

Condição de pagamento.

acceptsstring

Opções de pagamento.

acceptance_notesstring

Observações para Opções de pagamento.

iptu_amountnumber

Valor do IPTU.

iptu_installmentinteger

Quantidade em que pode-se parcelar o valor do IPTU.

condominiumnumber

Valor do Condomínio.

taxnumber

Valor das taxas.

show_taxboolean

Divulga Taxas.

showboolean

Divulga Finalidade.

show_packboolean

Divulga Pacotes de Temporada.

season_low_activeboolean

Baixa Temporada Ativa.

season_low_conditionstring

Condição de pagamento da Baixa Temporada.

season_low_taxnumber

Valor das Taxas da Baixa Temporada.

season_high_activeboolean

Alta Temporada Ativa.

season_high_conditionstring

Condição de pagamento da Alta Temporada.

season_high_taxnumber

Valor das Taxas da Alta Temporada.

comissionnumber

Porcentagem de Comissão.

first_commissionnumber

Porcentagem da primeira Comissão.

iptu_freeboolean

IPTU isento.

condominium_freeboolean

Condomínio isento.

Example request

{
  "type": "sale",
  "currency": "BRL",
  "amount": 1300,
  "amount_original": 1500,
  "discount_type": "percentage",
  "discount": 10,
  "amount_max": 1500,
  "condition": "monthly",
  "accepts": "FGTS",
  "acceptance_notes": "Apenas para Aposentados",
  "iptu_amount": 1750,
  "iptu_installment": 18,
  "condominium": 250,
  "tax": 100,
  "season_low_active": true,
  "season_low_condition": "daily",
  "season_low_tax": 100,
  "season_high_active": true,
  "season_high_condition": "daily",
  "season_high_tax": 150,
  "comission": 20,
  "first_commission": 40,
  "iptu_free": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.