Lease Annexes

Attacher les annexes obligatoires

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)
post/leases/{lease_id}/annexes/attach-mandatory

Request

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

Path parameters

lease_idstring uuid required

Identifiant du bail.

Response

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

already_attachedstring[] required

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

not_applicablestring[] required

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

Example response

{
  "attached": [
    {
      "annex_type": "NOTICE_INFORMATION",
      "name": "Notice d'information relative aux droits et obligations",
      "is_included": true
    }
  ],
  "not_applicable": [
    "Inventaire mobilier : applicable uniquement aux baux meubles"
  ]
}

Changes

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