Imóveis › Finalidades

Pesquisar

<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>
get/buildings/{building_id}/purposes

Request

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

Query parameters

sortstring

Campo para ordenar os registros

Example:amount
fieldsstring

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:type,amount
filter[type]string

Tipo de finalidade.

Example:sale
filter[currency]string

Código da moeda.

Example:BRL
filter[amount]number

Valor.

Example:1300
filter[amount_original]number

Valor original quando em promoção.

Example:1500
filter[condition]string

Condição de pagamento.

Example:monthly
filter[accepts]string

Opções de pagamento.

Example:FGTS
filter[acceptance_notes]string

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

Example:Apenas para Aposentados
filter[iptu_amount]number

Valor do IPTU.

Example:1750
filter[iptu_installment]integer

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

Example:5
filter[condominium]number

Valor do Condomínio.

Example:250
filter[tax]number

Valor das taxas.

Example:100
filter[show_tax]boolean

Divulga Taxas.

Example:true
filter[show]boolean

Divulga Finalidade.

filter[show_pack]boolean

Divulga Pacotes de Temporada.

filter[season_low_active]boolean

Baixa Temporada Ativa.

filter[season_low_condition]string

Condição de pagamento da Baixa Temporada.

Example:daily
filter[season_low_tax]number

Valor das Taxas da Baixa Temporada.

Example:100
filter[season_high_active]boolean

Alta Temporada Ativa.

filter[season_high_condition]string

Condição de pagamento da Alta Temporada.

Example:daily
filter[season_high_tax]number

Valor das Taxas da Alta Temporada.

Example:150
filter[comission]number

Porcentagem de Comissão.

Example:20
filter[first_commission]number

Porcentagem da primeira Comissão.

Example:40
filter[iptu_free]boolean

IPTU isento.

Example:true
filter[condominium_free]boolean

Condomínio isento.

include[building]string

Retorna os dados do imóvel .

Example:id,title

Changes

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