Lease Annexes

Recuperer une annexe systeme

Recupere les details complets d'une annexe systeme par son identifiant.

Utilisez cet endpoint pour obtenir les metadonnees detaillees d'une annexe avant de l'attacher a un bail, notamment sa reference legale, sa version et son caractere obligatoire.

get/lease-annexes/system/{annex_id}

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/lease-annexes/system/{annex_id}
  • Auth: HTTP bearer

Path parameters

annex_idstring uuid required

Unique identifier of the system annex

Response

Annexe systeme recuperee avec succes.

idstring uuid required

Unique identifier of the system annex

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
source'STATIC_FILE' | 'DYNAMIC_TYPST' | 'USER_UPLOAD' required

Methode de resolution du contenu de l'annexe.

  • STATIC_FILE - Fichier PDF statique embarque dans l'application (ex: textes reglementaires officiels).
  • DYNAMIC_TYPST - Document PDF genere dynamiquement a partir des donnees du bail (ex: inventaire mobilier).
  • USER_UPLOAD - Document uploade manuellement par l'utilisateur via le systeme de medias.
namestring required

Nom complet de l'annexe tel qu'il apparaitra dans le bail.

descriptionstring nullable

Description detaillee du contenu et de l'objet de l'annexe.

legal_referencestring nullable

Reference legale associee (loi, decret, arrete).

versionstring required

Version du document (permet le suivi des mises a jour reglementaires).

file_pathstring nullable

Chemin relatif du fichier statique dans le repertoire d'assets. Renseigne uniquement pour les annexes de source STATIC_FILE.

template_namestring nullable

Identifiant interne du template utilise pour la generation dynamique du PDF. Renseigne uniquement pour les annexes de source DYNAMIC_TYPST.

file_namestring required

Nom du fichier a utiliser lors du telechargement.

mime_typestring required

Type MIME du document.

is_activeboolean required

Indique si l'annexe est active et disponible pour etre attachee aux baux.

is_mandatoryboolean required

Indique si l'annexe est obligatoire pour les types de bail concernes. Les annexes obligatoires sont automatiquement attachees lors de l'appel a attach-mandatory.

applicable_lease_type_idsstring[] nullable

Liste des identifiants de types de bail pour lesquels cette annexe est applicable. Si null, l'annexe est applicable a tous les types de bail.

created_atstring date-time required

Date de creation de l'annexe systeme.

Example response

{
  "id": "a0000001-89ab-cdef-0123-456789abcdef",
  "annex_type": "NOTICE_INFORMATION",
  "source": "STATIC_FILE",
  "name": "Notice d'information relative aux droits et obligations des locataires et des bailleurs",
  "description": "Notice d'information conforme a l'arrete du 29 mai 2015, mise a jour mars 2023",
  "legal_reference": "Loi n89-462 art. 3-3, Arrete du 29 mai 2015",
  "version": "2023.03",
  "file_path": "lease-annexes/notice_information_mars_2023.pdf",
  "template_name": "inventaire_mobilier",
  "file_name": "notice_information_mars_2023.pdf",
  "mime_type": "application/pdf",
  "is_active": true,
  "is_mandatory": true,
  "applicable_lease_type_ids": [
    "e0000002-89ab-cdef-0123-456789abcdef",
    "e0000003-89ab-cdef-0123-456789abcdef"
  ]
}

Changes

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