FairePlace Property Management API

Lease Annexes

Endpointhttps://api.faireplace.com/api

Management of regulatory and supplementary lease annexes.

Annexes are the mandatory and optional documents that accompany a rental contract in compliance with French legislation (ALUR Law, Decrees 87-712/87-713, etc.).

System catalog

The platform maintains a global catalog of system annexes containing official regulatory documents. These annexes are shared across all tenants and serve as templates when attaching to a lease.

Three source categories

Source	Description	Example
`STATIC_FILE`	Embedded static PDF file	Information notice, Recoverable charges
`GENERATED`	PDF dynamically generated from lease data	Furniture inventory
`USER_UPLOAD`	Document manually uploaded by the user	Insurance certificate

Recommended workflow

Create the lease via POST /leases
Attach mandatory annexes via POST /leases/{id}/annexes/attach-mandatory
Add custom annexes via POST /leases/{id}/annexes
Check compliance via GET /leases/{id}/annexes/compliance
Download PDFs via GET /leases/{id}/annexes/{annex_id}/download

List annexes du catalogue

GET

https://api.faireplace.com/api

/lease-annexes/system

Recupere la liste des annexes systeme disponibles dans le catalogue global de la plateforme.

Ces annexes correspondent aux documents reglementaires prevus par la loi francaise pour les contrats de location : notice d'information (Loi ALUR), liste des charges recuperables (Decret 87-713), reparations locatives (Decret 87-712), grille de vetuste, inventaire mobilier, etc.

Filtrage par type de bail

Utilisez le parametre lease_type_id pour obtenir uniquement les annexes applicables a un type de bail specifique. Par exemple, l'inventaire mobilier n'est applicable qu'aux baux meubles.

Sources des annexes

Chaque annexe a une source qui determine comment son contenu est resolu :

STATIC_FILE : fichier PDF statique embarque (textes reglementaires officiels)
GENERATED : document PDF genere dynamiquement a partir des donnees du bail
USER_UPLOAD : document uploade manuellement par l'utilisateur

List annexes du catalogue › query Parameters

lease_type_id

string · uuid

Filtrer par type de bail. Retourne uniquement les annexes dont le champ applicable_lease_type_ids contient cet identifiant.

List annexes du catalogue › Responses

Liste des annexes systeme recuperee avec succes.

object[]

Annexe systeme du catalogue global. Ces annexes sont predefinies par la plateforme et servent de modeles pour les annexes attachees aux baux individuels. Elles ne sont pas liees a un tenant specifique et sont partagees par tous les utilisateurs.

id

string · uuid · required

Unique identifier of the system annex

Example: a0000001-89ab-cdef-0123-456789abcdef

annex_type

string · enum · 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

Enum values:

NOTICE_INFORMATION

CHARGES_RECUPERABLES

REPARATIONS_LOCATIVES

GRILLE_VETUSTE

INVENTAIRE_MOBILIER

ETAT_DES_LIEUX

DPE

DIAGNOSTIC_PLOMB

Example: NOTICE_INFORMATION

source

string · enum · required

Methode de resolution du contenu de l'annexe.

STATIC_FILE - Fichier PDF statique embarque dans l'application (ex: textes reglementaires officiels).
GENERATED - 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.

Enum values:

STATIC_FILE

GENERATED

USER_UPLOAD

Example: STATIC_FILE

name

string · required

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

Example: Notice d'information relative aux droits et obligations des locataires et des bailleurs

version

string · required

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

Example: 2023.03

file_name

string · required

Nom du fichier a utiliser lors du telechargement.

Example: notice_information_mars_2023.pdf

mime_type

string · required

Type MIME du document.

Example: application/pdf

is_active

boolean · required

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

Example: true

is_mandatory

boolean · 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.

Example: true

created_at

string · date-time · required

Date de creation de l'annexe systeme.

description

string | null

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

Example: Notice d'information conforme a l'arrete du 29 mai 2015, mise a jour mars 2023

legal_reference

string | null

Reference legale associee (loi, decret, arrete).

Example: Loi n89-462 art. 3-3, Arrete du 29 mai 2015

file_path

string | null

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

Example: lease-annexes/notice_information_mars_2023.pdf

template_name

string | null

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

Example: inventaire_mobilier

applicable_lease_type_ids

array | null

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.

Example: ["e0000002-89ab-cdef-0123-456789abcdef","e0000003-89ab-cdef-0123-456789abcdef"]

GET/lease-annexes/system

curl --request GET \
  --url https://api.faireplace.com/api/lease-annexes/system

shell

Example Responses

[
  {
    "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 conforme a l'arrete du 29 mai 2015",
    "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",
    "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"
    ],
    "created_at": "2024-01-15T10:00:00"
  },
  {
    "id": "a0000005-89ab-cdef-0123-456789abcdef",
    "annex_type": "INVENTAIRE_MOBILIER",
    "source": "GENERATED",
    "name": "Inventaire et etat detaille du mobilier",
    "description": "Inventaire exhaustif du mobilier fourni avec le logement meuble",
    "legal_reference": "Loi n89-462 art. 25-5, Decret n2015-981",
    "version": "1.0",
    "template_name": "inventaire_mobilier",
    "file_name": "inventaire_mobilier.pdf",
    "mime_type": "application/pdf",
    "is_active": true,
    "is_mandatory": true,
    "applicable_lease_type_ids": [
      "e0000003-89ab-cdef-0123-456789abcdef"
    ],
    "created_at": "2024-01-15T10:00:00"
  },
  {
    "id": "a0000006-89ab-cdef-0123-456789abcdef",
    "annex_type": "ETAT_DES_LIEUX",
    "source": "GENERATED",
    "name": "Etat des lieux",
    "description": "Constat de l'etat du logement piece par piece, conforme au decret n2016-382",
    "legal_reference": "Loi n89-462 art. 3-2, Decret n2016-382 du 30 mars 2016",
    "version": "1.0",
    "template_name": "etat_des_lieux",
    "file_name": "etat_des_lieux.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",
      "e0000004-89ab-cdef-0123-456789abcdef",
      "e0000005-89ab-cdef-0123-456789abcdef"
    ],
    "created_at": "2024-01-15T10:00:00"
  }
]

json

application/json

Recuperer une annexe systeme

GET

https://api.faireplace.com/api

/lease-annexes/system/{annex_id}

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.

Recuperer une annexe systeme › path Parameters

annex_id

string · uuid · required

Unique identifier of the system annex

Recuperer une annexe systeme › Responses

Annexe systeme recuperee avec succes.

id

string · uuid · required

Unique identifier of the system annex

Example: a0000001-89ab-cdef-0123-456789abcdef

annex_type

string · enum · 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

Enum values:

NOTICE_INFORMATION

CHARGES_RECUPERABLES

REPARATIONS_LOCATIVES

GRILLE_VETUSTE

INVENTAIRE_MOBILIER

ETAT_DES_LIEUX

DPE

DIAGNOSTIC_PLOMB

Example: NOTICE_INFORMATION

source

string · enum · required

Methode de resolution du contenu de l'annexe.

STATIC_FILE - Fichier PDF statique embarque dans l'application (ex: textes reglementaires officiels).
GENERATED - 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.

Enum values:

STATIC_FILE

GENERATED

USER_UPLOAD

Example: STATIC_FILE

name

string · required

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

Example: Notice d'information relative aux droits et obligations des locataires et des bailleurs

version

string · required

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

Example: 2023.03

file_name

string · required

Nom du fichier a utiliser lors du telechargement.

Example: notice_information_mars_2023.pdf

mime_type

string · required

Type MIME du document.

Example: application/pdf

is_active

boolean · required

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

Example: true

is_mandatory

boolean · 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.

Example: true

created_at

string · date-time · required

Date de creation de l'annexe systeme.

description

string | null

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

Example: Notice d'information conforme a l'arrete du 29 mai 2015, mise a jour mars 2023

legal_reference

string | null

Reference legale associee (loi, decret, arrete).

Example: Loi n89-462 art. 3-3, Arrete du 29 mai 2015

file_path

string | null

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

Example: lease-annexes/notice_information_mars_2023.pdf

template_name

string | null

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

Example: inventaire_mobilier

applicable_lease_type_ids

array | null

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.

Example: ["e0000002-89ab-cdef-0123-456789abcdef","e0000003-89ab-cdef-0123-456789abcdef"]

GET/lease-annexes/system/{annex_id}

curl --request GET \
  --url https://api.faireplace.com/api/lease-annexes/system/:annex_id

shell

Example Responses

{
  "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"
  ],
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Telecharger le fichier d'une annexe systeme

GET

https://api.faireplace.com/api

/lease-annexes/system/{annex_id}/download

Telecharge le fichier PDF d'une annexe systeme de source STATIC_FILE.

Le fichier est retourne en tant que contenu binaire avec les en-tetes Content-Type et Content-Disposition configures pour declencher un telechargement.

Limitation : Seules les annexes de source STATIC_FILE peuvent etre telechargees via cet endpoint. Les annexes GENERATED doivent etre telechargees via l'endpoint de telechargement par bail (/leases/{lease_id}/annexes/{annex_id}/download) qui genere le PDF avec les donnees specifiques du bail.

Telecharger le fichier d'une annexe systeme › path Parameters

annex_id

string · uuid · required

Unique identifier of the system annex

Telecharger le fichier d'une annexe systeme › Responses

Fichier PDF telecharge avec succes.

string

GET/lease-annexes/system/{annex_id}/download

curl --request GET \
  --url https://api.faireplace.com/api/lease-annexes/system/:annex_id/download

shell

Example Responses

string

plain

application/pdf

List annexes d'un bail

GET

https://api.faireplace.com/api

/leases/{lease_id}/annexes

Recupere la liste ordonnee de toutes les annexes attachees a un bail.

Les annexes sont retournees triees par leur champ position (ordre croissant). Cet ordre correspond a l'ordre dans lequel les annexes apparaitront dans le dossier de bail complet.

List annexes d'un bail › path Parameters

lease_id

string · uuid · required

Identifiant du bail.

List annexes d'un bail › Responses

Liste des annexes du bail recuperee avec succes.

object[]

Annexe attachee a un bail specifique. Chaque annexe est isolee par tenant et liee a un bail unique. Une annexe peut etre : - Derivee d'une annexe systeme (via `system_annex_id`) pour les documents reglementaires - Creee manuellement avec un media uploade (via `media_id`) pour les documents personnalises - Generee dynamiquement (ex: inventaire mobilier) avec un PDF stocke sur le serveur

id

string · uuid · required

Unique identifier of the annex

tenant_id

string · required

Identifiant du tenant proprietaire de cette ressource.

lease_id

string · uuid · required

Identifiant du bail auquel cette annexe est rattachee.

annex_type

string · enum · 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

Enum values:

NOTICE_INFORMATION

CHARGES_RECUPERABLES

REPARATIONS_LOCATIVES

GRILLE_VETUSTE

INVENTAIRE_MOBILIER

ETAT_DES_LIEUX

DPE

DIAGNOSTIC_PLOMB

Example: NOTICE_INFORMATION

name

string · required

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

Example: Notice d'information relative aux droits et obligations

position

integer · required

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

Example: 0

is_included

boolean · required

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

Example: true

created_at

string · date-time · required

Date de creation.

updated_at

string · date-time · required

Date de derniere mise a jour.

system_annex_id

string | null · uuid

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

description

string | null

Description complementaire de l'annexe.

media_id

string | null · uuid

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

generated_pdf_path

string | null

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

GET/leases/{lease_id}/annexes

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/annexes

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "tenant_id": "tenant_id",
    "lease_id": "00000000-0000-0000-0000-000000000000",
    "system_annex_id": "00000000-0000-0000-0000-000000000000",
    "annex_type": "NOTICE_INFORMATION",
    "name": "Notice d'information relative aux droits et obligations",
    "description": {},
    "media_id": "00000000-0000-0000-0000-000000000000",
    "generated_pdf_path": {},
    "position": 0,
    "is_included": true,
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Attacher une annexe a un bail

POST

https://api.faireplace.com/api

/leases/{lease_id}/annexes

Attache une nouvelle annexe a un bail existant.

Deux modes d'utilisation :

Depuis le catalogue systeme : Fournissez un system_annex_id pour attacher une annexe reglementaire du catalogue global. Le type et le contenu seront resolus automatiquement a partir de l'annexe systeme.
Annexe personnalisee : Fournissez un media_id pour attacher un document que vous avez prealablement uploade via le systeme de medias.

Contrainte d'unicite : Un seul exemplaire de chaque annex_type peut etre attache par bail (sauf le type CUSTOM qui peut apparaitre plusieurs fois).

Attacher une annexe a un bail › path Parameters

lease_id

string · uuid · required

Identifiant du bail auquel attacher l'annexe.

Attacher une annexe a un bail › Request Body

Donnees necessaires pour attacher une nouvelle annexe a un bail. **Deux cas d'usage :** 1. **Annexe systeme** : Renseigner `system_annex_id` pour lier a une annexe du catalogue global. Le type et le nom seront herites de l'annexe systeme. 2. **Annexe personnalisee** : Renseigner `media_id` pour associer un document uploade.

annex_type

string · enum · 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

Enum values:

NOTICE_INFORMATION

CHARGES_RECUPERABLES

REPARATIONS_LOCATIVES

GRILLE_VETUSTE

INVENTAIRE_MOBILIER

ETAT_DES_LIEUX

DPE

DIAGNOSTIC_PLOMB

Example: NOTICE_INFORMATION

name

string · required

Nom de l'annexe.

Example: Notice d'information

system_annex_id

string | null · uuid

Identifiant de l'annexe systeme a lier. Fournir cet identifiant pour attacher une annexe reglementaire du catalogue.

description

string | null

Description complementaire.

media_id

string | null · uuid

Identifiant du media uploade a associer a cette annexe.

position

integer | null

Position souhaitee dans la liste des annexes. Par defaut, ajoutee en derniere position.

Example: 0

Attacher une annexe a un bail › Responses

Annexe attachee avec succes au bail.

id

string · uuid · required

Unique identifier of the annex

tenant_id

string · required

Identifiant du tenant proprietaire de cette ressource.

lease_id

string · uuid · required

Identifiant du bail auquel cette annexe est rattachee.

annex_type

string · enum · 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

Enum values:

NOTICE_INFORMATION

CHARGES_RECUPERABLES

REPARATIONS_LOCATIVES

GRILLE_VETUSTE

INVENTAIRE_MOBILIER

ETAT_DES_LIEUX

DPE

DIAGNOSTIC_PLOMB

Example: NOTICE_INFORMATION

name

string · required

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

Example: Notice d'information relative aux droits et obligations

position

integer · required

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

Example: 0

is_included

boolean · required

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

Example: true

created_at

string · date-time · required

Date de creation.

updated_at

string · date-time · required

Date de derniere mise a jour.

system_annex_id

string | null · uuid

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

description

string | null

Description complementaire de l'annexe.

media_id

string | null · uuid

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

generated_pdf_path

string | null

POST/leases/{lease_id}/annexes

curl --request POST \
  --url https://api.faireplace.com/api/leases/:lease_id/annexes \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "system_annex_id": "a0000001-89ab-cdef-0123-456789abcdef",
  "annex_type": "NOTICE_INFORMATION",
  "name": "Notice d'information",
  "description": "Notice reglementaire jointe au bail",
  "position": 0
}
EOF

shell

Example Request Body

{
  "system_annex_id": "a0000001-89ab-cdef-0123-456789abcdef",
  "annex_type": "NOTICE_INFORMATION",
  "name": "Notice d'information",
  "description": "Notice reglementaire jointe au bail",
  "position": 0
}

json

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "tenant_id": "tenant_id",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "system_annex_id": "00000000-0000-0000-0000-000000000000",
  "annex_type": "NOTICE_INFORMATION",
  "name": "Notice d'information relative aux droits et obligations",
  "description": {},
  "media_id": "00000000-0000-0000-0000-000000000000",
  "generated_pdf_path": {},
  "position": 0,
  "is_included": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Reorganiser l'ordre des annexes

PUT

https://api.faireplace.com/api

/leases/{lease_id}/annexes/reorder

Modifie l'ordre d'affichage des annexes d'un bail en fournissant la liste ordonnee de leurs identifiants.

La position de chaque annexe sera mise a jour pour correspondre a son index dans la liste fournie (0, 1, 2, ...).

Tous les identifiants d'annexes du bail doivent etre presents dans la liste. Si un identifiant est manquant ou ne correspond a aucune annexe du bail, l'operation echoue.

Reorganiser l'ordre des annexes › path Parameters

lease_id

string · uuid · required

Identifiant du bail.

Reorganiser l'ordre des annexes › Request Body

Liste ordonnee des identifiants d'annexes pour reorganiser leur ordre d'affichage. Tous les identifiants d'annexes du bail doivent etre presents dans la liste.

annex_ids

string[] · required

Liste ordonnee des identifiants d'annexes. La position de chaque annexe sera mise a jour selon son index dans cette liste.

Example: ["11111111-1111-1111-1111-111111111111","22222222-2222-2222-2222-222222222222","33333333-3333-3333-3333-333333333333"]

Reorganiser l'ordre des annexes › Responses

Annexes reorganisees avec succes. Retourne la liste mise a jour.

object[]

id

string · uuid · required

Unique identifier of the annex

tenant_id

string · required

Identifiant du tenant proprietaire de cette ressource.

lease_id

string · uuid · required

Identifiant du bail auquel cette annexe est rattachee.

annex_type

string · enum · 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

Enum values:

NOTICE_INFORMATION

CHARGES_RECUPERABLES

REPARATIONS_LOCATIVES

GRILLE_VETUSTE

INVENTAIRE_MOBILIER

ETAT_DES_LIEUX

DPE

DIAGNOSTIC_PLOMB

Example: NOTICE_INFORMATION

name

string · required

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

Example: Notice d'information relative aux droits et obligations

position

integer · required

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

Example: 0

is_included

boolean · required

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

Example: true

created_at

string · date-time · required

Date de creation.

updated_at

string · date-time · required

Date de derniere mise a jour.

system_annex_id

string | null · uuid

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

description

string | null

Description complementaire de l'annexe.

media_id

string | null · uuid

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

generated_pdf_path

string | null

PUT/leases/{lease_id}/annexes/reorder

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/annexes/reorder \
  --header 'Content-Type: application/json' \
  --data '
{
  "annex_ids": [
    "11111111-1111-1111-1111-111111111111",
    "22222222-2222-2222-2222-222222222222",
    "33333333-3333-3333-3333-333333333333"
  ]
}
'

shell

Example Request Body

{
  "annex_ids": [
    "11111111-1111-1111-1111-111111111111",
    "22222222-2222-2222-2222-222222222222",
    "33333333-3333-3333-3333-333333333333"
  ]
}

json

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "tenant_id": "tenant_id",
    "lease_id": "00000000-0000-0000-0000-000000000000",
    "system_annex_id": "00000000-0000-0000-0000-000000000000",
    "annex_type": "NOTICE_INFORMATION",
    "name": "Notice d'information relative aux droits et obligations",
    "description": {},
    "media_id": "00000000-0000-0000-0000-000000000000",
    "generated_pdf_path": {},
    "position": 0,
    "is_included": true,
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Attacher les annexes obligatoires

POST

https://api.faireplace.com/api

/leases/{lease_id}/annexes/attach-mandatory

Attache automatiquement toutes les annexes obligatoires applicables au type de bail.

L'API identifie le type de bail, recherche dans le catalogue systeme les annexes marquees is_mandatory = true et applicables a ce type de bail, puis les attache au bail.

Idempotency: Les annexes deja attachees ne sont pas dupliquees. L'operation peut etre appelee plusieurs fois sans effet de bord.

Exemple de resultat pour un bail meuble :

attached : Notice d'information, Charges recuperables, Reparations locatives, Inventaire mobilier
already_attached : [] (si premiere execution)
not_applicable : [] (si le bail est bien un bail meuble)

Attacher les annexes obligatoires › path Parameters

lease_id

string · uuid · required

Identifiant du bail.

Attacher les annexes obligatoires › Responses

Operation terminee. Le resultat detaille les annexes nouvellement attachees, celles deja presentes et celles non applicables.

Resultat de l'operation d'attachement automatique des annexes obligatoires. Fournit un bilan detaille des annexes traitees.

object[] · required

Liste des annexes qui ont ete nouvellement attachees au bail.

already_attached

string[] · required

Identifiants des annexes systeme qui etaient deja attachees (pas de doublons crees).

not_applicable

string[] · required

Descriptions des annexes obligatoires qui n'ont pas pu etre attachees (ex: type de bail non compatible, source non resolue).

Example: ["Inventaire mobilier : applicable uniquement aux baux meubles"]

POST/leases/{lease_id}/annexes/attach-mandatory

curl --request POST \
  --url https://api.faireplace.com/api/leases/:lease_id/annexes/attach-mandatory

shell

Example Responses

{
  "attached": [
    {
      "id": "11111111-1111-1111-1111-111111111111",
      "tenant_id": "tenant_abc",
      "lease_id": "22222222-2222-2222-2222-222222222222",
      "system_annex_id": "a0000001-89ab-cdef-0123-456789abcdef",
      "annex_type": "NOTICE_INFORMATION",
      "name": "Notice d'information",
      "position": 0,
      "is_included": true,
      "created_at": "2024-06-15T14:30:00",
      "updated_at": "2024-06-15T14:30:00"
    }
  ],
  "already_attached": [],
  "not_applicable": []
}

json

application/json

Verifier la conformite des annexes

GET

https://api.faireplace.com/api

/leases/{lease_id}/annexes/compliance

Verifie la conformite reglementaire des annexes d'un bail en comparant les annexes presentes avec les exigences legales du type de bail.

Le rapport indique :

is_compliant : true si toutes les annexes obligatoires sont presentes et incluses
mandatory : detail de chaque annexe obligatoire avec son statut (present, excluded, missing)
recommended : annexes recommandees mais non obligatoires

Cas d'usage : Appelez cet endpoint avant de finaliser un bail ou d'initier une signature electronique pour vous assurer que le dossier est complet.

Verifier la conformite des annexes › path Parameters

lease_id

string · uuid · required

Identifiant du bail a verifier.

Verifier la conformite des annexes › Responses

Rapport de conformite genere avec succes.

Resultat de la verification de conformite des annexes d'un bail. Compare les annexes presentes avec les exigences reglementaires du type de bail.

lease_id

string · uuid · required

Identifiant du bail verifie.

is_compliant

boolean · required

true si toutes les annexes obligatoires sont presentes et incluses. false si au moins une annexe obligatoire est manquante.

Example: false

total_annexes

integer · required

Nombre total d'annexes attachees au bail.

Example: 3

included_annexes

integer · required

Nombre d'annexes incluses (non exclues) dans le dossier.

Example: 3

object[] · required

Liste des annexes obligatoires avec leur statut de presence.

object[] · required

Liste des annexes recommandees (non obligatoires) avec leur statut.

GET/leases/{lease_id}/annexes/compliance

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/annexes/compliance

shell

Example Responses

{
  "lease_id": "22222222-2222-2222-2222-222222222222",
  "is_compliant": false,
  "total_annexes": 3,
  "included_annexes": 3,
  "mandatory": [
    {
      "annex_type": "NOTICE_INFORMATION",
      "name": "Notice d'information",
      "status": "present",
      "annex_id": "11111111-1111-1111-1111-111111111111"
    },
    {
      "annex_type": "CHARGES_RECUPERABLES",
      "name": "Charges recuperables",
      "status": "present",
      "annex_id": "33333333-3333-3333-3333-333333333333"
    },
    {
      "annex_type": "REPARATIONS_LOCATIVES",
      "name": "Reparations locatives",
      "status": "present",
      "annex_id": "44444444-4444-4444-4444-444444444444"
    },
    {
      "annex_type": "DPE",
      "name": "Diagnostic de Performance Energetique",
      "status": "missing",
      "annex_id": null
    }
  ],
  "recommended": [
    {
      "annex_type": "GRILLE_VETUSTE",
      "name": "Grille de vetuste",
      "status": "missing",
      "annex_id": null
    }
  ]
}

json

application/json

Recuperer une annexe de bail

GET

https://api.faireplace.com/api

/leases/{lease_id}/annexes/{annex_id}

Recupere les details complets d'une annexe attachee a un bail.

Recuperer une annexe de bail › path Parameters

lease_id

string · uuid · required

Identifiant du bail.

annex_id

string · uuid · required

Identifiant de l'annexe.

Recuperer une annexe de bail › Responses

Annexe recuperee avec succes.

id

string · uuid · required

Unique identifier of the annex

tenant_id

string · required

Identifiant du tenant proprietaire de cette ressource.

lease_id

string · uuid · required

Identifiant du bail auquel cette annexe est rattachee.

annex_type

string · enum · 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

Enum values:

NOTICE_INFORMATION

CHARGES_RECUPERABLES

REPARATIONS_LOCATIVES

GRILLE_VETUSTE

INVENTAIRE_MOBILIER

ETAT_DES_LIEUX

DPE

DIAGNOSTIC_PLOMB

Example: NOTICE_INFORMATION

name

string · required

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

Example: Notice d'information relative aux droits et obligations

position

integer · required

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

Example: 0

is_included

boolean · required

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

Example: true

created_at

string · date-time · required

Date de creation.

updated_at

string · date-time · required

Date de derniere mise a jour.

system_annex_id

string | null · uuid

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

description

string | null

Description complementaire de l'annexe.

media_id

string | null · uuid

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

generated_pdf_path

string | null

GET/leases/{lease_id}/annexes/{annex_id}

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/annexes/:annex_id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "tenant_id": "tenant_id",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "system_annex_id": "00000000-0000-0000-0000-000000000000",
  "annex_type": "NOTICE_INFORMATION",
  "name": "Notice d'information relative aux droits et obligations",
  "description": {},
  "media_id": "00000000-0000-0000-0000-000000000000",
  "generated_pdf_path": {},
  "position": 0,
  "is_included": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Mettre a jour une annexe de bail

PUT

https://api.faireplace.com/api

/leases/{lease_id}/annexes/{annex_id}

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

Mettre a jour une annexe de bail › path Parameters

lease_id

string · uuid · required

Identifiant du bail.

annex_id

string · uuid · required

Identifiant de l'annexe a modifier.

Mettre a jour une annexe de bail › Request Body

Donnees de mise a jour partielle d'une annexe de bail. Seuls les champs fournis sont mis a jour.

name

string | null

Nouveau nom de l'annexe.

description

string | null

Nouvelle description.

media_id

string | null · uuid

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

position

integer | null

Nouvelle position dans la liste.

is_included

boolean | null

Inclure ou exclure l'annexe du dossier de bail.

Mettre a jour une annexe de bail › Responses

Annexe mise a jour avec succes.

id

string · uuid · required

Unique identifier of the annex

tenant_id

string · required

Identifiant du tenant proprietaire de cette ressource.

lease_id

string · uuid · required

Identifiant du bail auquel cette annexe est rattachee.

annex_type

string · enum · 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

Enum values:

NOTICE_INFORMATION

CHARGES_RECUPERABLES

REPARATIONS_LOCATIVES

GRILLE_VETUSTE

INVENTAIRE_MOBILIER

ETAT_DES_LIEUX

DPE

DIAGNOSTIC_PLOMB

Example: NOTICE_INFORMATION

name

string · required

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

Example: Notice d'information relative aux droits et obligations

position

integer · required

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

Example: 0

is_included

boolean · required

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

Example: true

created_at

string · date-time · required

Date de creation.

updated_at

string · date-time · required

Date de derniere mise a jour.

system_annex_id

string | null · uuid

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

description

string | null

Description complementaire de l'annexe.

media_id

string | null · uuid

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

generated_pdf_path

string | null

PUT/leases/{lease_id}/annexes/{annex_id}

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/annexes/:annex_id \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "name": "Notice d'information - Version mise a jour",
  "is_included": true,
  "position": 0
}
EOF

shell

Example Request Body

{
  "name": "Notice d'information - Version mise a jour",
  "is_included": true,
  "position": 0
}

json

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "tenant_id": "tenant_id",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "system_annex_id": "00000000-0000-0000-0000-000000000000",
  "annex_type": "NOTICE_INFORMATION",
  "name": "Notice d'information relative aux droits et obligations",
  "description": {},
  "media_id": "00000000-0000-0000-0000-000000000000",
  "generated_pdf_path": {},
  "position": 0,
  "is_included": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete annexe de bail

DELETE

https://api.faireplace.com/api

/leases/{lease_id}/annexes/{annex_id}

Supprime definitivement une annexe attachee a un bail.

Attention : Cette operation est irreversible. L'annexe sera detachee du bail et sa reference supprimee. Si l'annexe etait derivee d'une annexe systeme, l'annexe systeme n'est pas affectee et pourra etre rattachee ulterieurement.

Les fichiers PDF generes dynamiquement associes a cette annexe (le cas echeant) ne sont pas supprimes du disque par cette operation.

Delete annexe de bail › path Parameters

lease_id

string · uuid · required

Identifiant du bail.

annex_id

string · uuid · required

Identifiant de l'annexe a supprimer.

Delete annexe de bail › Responses

Annexe supprimee avec succes.

No data returned

DELETE/leases/{lease_id}/annexes/{annex_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/leases/:lease_id/annexes/:annex_id

shell

Example Responses

No example specified for this content type

Telecharger le PDF d'une annexe

GET

https://api.faireplace.com/api

/leases/{lease_id}/annexes/{annex_id}/download

Telecharge le fichier PDF d'une annexe attachee a un bail.

Le comportement depend de la source de l'annexe :

Fichier statique (STATIC_FILE) : Retourne le fichier PDF embarque dans l'application (ex: notice d'information, liste des charges recuperables).

Generation dynamique (GENERATED) : Genere un PDF personnalise a partir des donnees du bail. Deux templates sont disponibles :

Inventaire mobilier (INVENTAIRE_MOBILIER) : informations du bailleur et des locataires, adresse du bien, tableau detaille du mobilier par piece avec etat et quantite, verification des 11 elements obligatoires (decret 2015-981), zone de signatures.
Etat des lieux (ETAT_DES_LIEUX) : constat piece par piece conforme au decret 2016-382. Inclut les informations des parties, releves des compteurs (a remplir manuellement), remise des cles (pre-remplie), grille d'elements structurels par piece (sols, murs, plafonds, portes, fenetres, electricite, plomberie, chauffage), equipements et mobilier si presents, observations generales et zone de signatures. Utilisez ?edl_type=entree (defaut) ou ?edl_type=sortie pour choisir le type.

Mise en cache : Les PDF generes dynamiquement sont mis en cache sur le serveur. Les appels suivants retournent la version en cache sans regeneration. Utilisez ?force=true pour forcer une regeneration avec les donnees a jour.

Media uploade (USER_UPLOAD) : Retourne une erreur 400 car les medias uploades doivent etre telecharges via l'endpoint /media/download/{id}.

Telecharger le PDF d'une annexe › path Parameters

lease_id

string · uuid · required

Identifiant du bail.

annex_id

string · uuid · required

Identifiant de l'annexe a telecharger.

Telecharger le PDF d'une annexe › query Parameters

force

boolean

Forcer la regeneration du PDF pour les annexes dynamiques. Par defaut false. Passer true pour obtenir un PDF regenere avec les donnees les plus recentes du bail.

Default: false

edl_type

string · enum

Type d'etat des lieux a generer. Applicable uniquement aux annexes ETAT_DES_LIEUX.

entree (defaut) : etat des lieux d'entree
sortie : etat des lieux de sortie

Enum values:

entree

sortie

Default: entree

Telecharger le PDF d'une annexe › Responses

Fichier PDF retourne avec succes.

string

GET/leases/{lease_id}/annexes/{annex_id}/download

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/annexes/:annex_id/download

shell

Example Responses

string

plain

application/pdf

Credits Webhooks