properties

Modifie un bien : seuls les champs renseignés sont appliqués.

patch/api/v1/properties/{property_id}

Request

  • Base URL: https://api.qalimo.fr
  • URL: https://api.qalimo.fr/api/v1/properties/{property_id}
  • Auth: HTTP bearer

Request body

namestring

Nom du bien.

streetstring

Numéro et rue.

address_line_2string nullable

Complément d'adresse.

postal_codestring

Code postal.

citystring

Ville.

housing_typeunknown
surface_areanumber nullable

Surface habitable en mètres carrés.

main_room_countinteger nullable

Nombre de pièces principales.

rent_excluding_chargesnumber

Loyer hors charges, hors complément (additional_rent).

additional_rentnumber nullable

Complément de loyer.

chargesnumber

Charges.

depositnumber

Montant du dépôt de garantie.

payment_dayinteger

Jour du mois auquel le loyer est dû.

charge_type'provision' | 'forfait'

Mode de facturation des charges.

energy_performance_gradeunknown
purchase_datestring date nullable

Date d'achat.

purchase_priceinteger nullable

Prix d'achat en euros.

Response

OK

idinteger required

Identifiant du bien.

namestring required

Nom d'affichage du bien.

type'habitation' | 'commercial' | 'garage' required

Type de bien.

citystring required

Ville.

postal_codestring required

Code postal.

rent_excluding_chargesnumber required

Loyer hors charges, complément de loyer inclus.

chargesnumber required

Charges.

status'active' | 'archived' required

État du bien (actif ou archivé).

streetstring

Numéro et rue.

address_line_2string nullable

Complément d'adresse.

housing_type'individuel' | 'collectif' | 'null' nullable

Type d'habitat.

surface_areanumber nullable

Surface habitable en mètres carrés.

main_room_countinteger nullable

Nombre de pièces principales.

is_shared_housingboolean

Vrai si le bien est loué en colocation.

shared_housing_capacityinteger nullable

Nombre de chambres en colocation.

depositnumber nullable

Montant du dépôt de garantie.

payment_dayinteger nullable

Jour du mois auquel le loyer est dû.

additional_rentnumber nullable

Complément de loyer, déjà inclus dans rent_excluding_charges.

charge_type'provision' | 'forfait' | 'null' nullable

Mode de facturation des charges.

energy_performance_grade'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'null' nullable

Classe énergétique (DPE).

purchase_datestring date nullable

Date d'achat.

purchase_priceinteger nullable

Prix d'achat en euros.

owner_profile_idinteger nullable

Identifiant du profil bailleur propriétaire.

Changes

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