tenants

Modifie un bail : seuls les champs fournis sont appliqués.

Le passage de notice_given à true ouvre le processus de départ (fin de bail) ; son retour à false l'annule.

patch/api/v1/tenants/{tenant_id}

Request

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

Request body

start_datestring date

Date de début du bail.

end_datestring date nullable

Date de fin du bail (null pour l'effacer).

contract_duration_monthsinteger nullable

Durée du contrat en mois.

rent_excluding_chargesnumber

Loyer hors charges, hors complément.

chargesnumber

Charges.

depositnumber

Dépôt de garantie.

payment_dayinteger

Jour du mois auquel le loyer est dû.

payment_recurrence_monthsinteger

Périodicité de l'échéance en mois.

payment_periods_from_start_dateboolean

Vrai si les périodes trimestrielles, semestrielles ou annuelles sont calées sur le mois de début du bail plutôt que sur l'année civile (sans effet en mensuel).

signature_datestring date nullable

Date de signature du bail.

notice_givenboolean

Préavis posé : le passage à true ouvre le processus de départ, le retour à false l'annule.

Response

OK

idinteger required

Identifiant du bail.

namestring required

Libellé du bail.

occupantsstring required

Nom d'affichage des occupants.

property_idinteger required

Identifiant du bien loué.

start_datestring date required

Date de début du bail.

end_datestring date nullable

Date de fin du bail (null si non renseignée).

rent_excluding_chargesnumber nullable

Loyer hors charges, complément de loyer inclus.

status'active' | 'candidate' | 'archived' | 'archived_candidate' required

État du bail (actif, candidat, archivé, candidat archivé).

chargesnumber nullable

Charges.

additional_rentnumber nullable

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

depositnumber nullable

Montant du dépôt de garantie.

payment_dayinteger nullable

Jour du mois auquel le loyer est dû.

payment_recurrence_monthsinteger nullable

Périodicité de l'échéance en mois (1 = mensuelle, 3 = trimestrielle…).

payment_periods_from_start_dateboolean

Vrai si les périodes trimestrielles, semestrielles ou annuelles sont calées sur le mois de début du bail plutôt que sur l'année civile (sans effet en mensuel).

payment_type'prelevement' | 'virement' | 'espece' | 'cheque' | 'null' nullable

Mode de paiement du loyer.

signature_datestring date nullable

Date de signature du bail.

contract_duration_monthsinteger nullable

Durée du contrat en mois.

lease_type'lcd' | 'nu' | 'meuble' | 'commercial' | 'garage' | 'habitation' | 'mobilite' | 'professionnel' | 'etudiant' | 'commercial_derogatoire' | 'sous-location' | 'civil' | 'civil_habitation' | 'stockage' | 'parking' | 'null' nullable

Type de bail.

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

Mode de facturation des charges.

vat_enabledboolean

Vrai si le loyer est soumis à TVA.

caf_amountnumber nullable

Montant de l'aide CAF versée directement.

last_rent_revision_datestring date nullable

Date de la dernière révision de loyer.

notice_givenboolean nullable

Vrai si le locataire a posé son préavis.

Changes

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