Lease Annexes

Mettre a jour une annexe de bail

Met a jour les proprietes d'une annexe attachee a un bail.

Seuls les champs fournis dans le corps de la requete sont mis a jour. Les champs non fournis conservent leur valeur actuelle.

Operations courantes :

  • Modifier le nom ou la description
  • Changer la position dans la liste
  • Inclure ou exclure l'annexe du dossier (is_included)
  • Associer ou dissocier un media uploade
put/leases/{lease_id}/annexes/{annex_id}

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/annexes/{annex_id}
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Identifiant du bail.

annex_idstring uuid required

Identifiant de l'annexe a modifier.

Request body

namestring nullable

Nouveau nom de l'annexe.

descriptionstring nullable

Nouvelle description.

media_idstring uuid nullable

Nouveau media a associer. Passer null pour dissocier le media actuel.

positioninteger nullable

Nouvelle position dans la liste.

is_includedboolean nullable

Inclure ou exclure l'annexe du dossier de bail.

Response

Annexe mise a jour avec succes.

idstring uuid required

Unique identifier of the annex

tenant_idstring required

Identifiant du tenant proprietaire de cette ressource.

lease_idstring uuid required

Identifiant du bail auquel cette annexe est rattachee.

system_annex_idstring uuid nullable

Reference vers l'annexe systeme dont cette annexe est derivee. null pour les annexes creees manuellement.

annex_type'NOTICE_INFORMATION' | 'CHARGES_RECUPERABLES' | 'REPARATIONS_LOCATIVES' | 'GRILLE_VETUSTE' | 'INVENTAIRE_MOBILIER' | 'ETAT_DES_LIEUX' | 'DPE' | 'DIAGNOSTIC_PLOMB' | 'DIAGNOSTIC_AMIANTE' | 'DIAGNOSTIC_ELECTRICITE' | 'DIAGNOSTIC_GAZ' | 'ETAT_RISQUES' | 'REGLEMENT_COPROPRIETE' | 'PERMIS_LOUER' | 'ASSURANCE_HABITATION' | 'CAUTIONNEMENT' | 'CUSTOM' required

Type d'annexe au bail. Chaque type correspond a un document reglementaire ou complementaire qui doit etre joint au contrat de location conformement a la legislation francaise.

Documents reglementaires obligatoires :

  • NOTICE_INFORMATION - Notice d'information (Loi ALUR art. 3-3)
  • CHARGES_RECUPERABLES - Liste des charges recuperables (Decret 87-713)
  • REPARATIONS_LOCATIVES - Reparations a la charge du locataire (Decret 87-712)
  • GRILLE_VETUSTE - Grille de vetuste indicative (Decret 2016-382)
  • INVENTAIRE_MOBILIER - Inventaire du mobilier (baux meubles, Decret 2015-981)
  • ETAT_DES_LIEUX - Etat des lieux d'entree/sortie (Decret 2016-382)

Diagnostics techniques :

  • DPE - Diagnostic de Performance Energetique
  • DIAGNOSTIC_PLOMB - Constat de Risque d'Exposition au Plomb (CREP)
  • DIAGNOSTIC_AMIANTE - Etat d'amiante (parties privatives)
  • DIAGNOSTIC_ELECTRICITE - Etat de l'installation interieure d'electricite
  • DIAGNOSTIC_GAZ - Etat de l'installation interieure de gaz
  • ETAT_RISQUES - Etat des Risques et Pollutions (ERP)

Documents complementaires :

  • REGLEMENT_COPROPRIETE - Extraits du reglement de copropriete
  • ASSURANCE_HABITATION - Attestation d'assurance habitation
  • CAUTIONNEMENT - Acte de cautionnement
  • CUSTOM - Document personnalise
namestring required

Nom de l'annexe tel qu'il apparait dans le dossier du bail.

descriptionstring nullable

Description complementaire de l'annexe.

media_idstring uuid nullable

Identifiant du media associe (document uploade par l'utilisateur). Utilise pour les annexes de source USER_UPLOAD.

generated_pdf_pathstring nullable

Chemin du fichier PDF genere dynamiquement sur le serveur. Renseigne apres la premiere generation d'une annexe DYNAMIC_TYPST (ex: inventaire mobilier). Sert de cache pour eviter les regenerations inutiles.

positioninteger required

Position d'affichage de l'annexe dans la liste (0 = premiere position).

is_includedboolean required

Indique si l'annexe est incluse dans le dossier du bail. Permet d'exclure temporairement une annexe sans la supprimer.

created_atstring date-time required

Date de creation.

updated_atstring date-time required

Date de derniere mise a jour.

Example response

{
  "annex_type": "NOTICE_INFORMATION",
  "name": "Notice d'information relative aux droits et obligations",
  "is_included": true
}

Changes

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