GET
Détail complet d'un bail (Éditeur de documents)
Il faudra que l’équipe flatbay vous fournisse une clé d’API (au niveau du groupe) pour utiliser cette route. À partir de l’identifiant d’un document (un bail ou un acte de cautionnement généré via l’éditeur de documents), cette route renvoie toutes les données du bail : le bien et ses lots, les intervenants, la TVA, les variables du document, le statut, les annexes, les RIB des locataires et les URL de téléchargement du PDF signé, des annexes et des RIB.

Intervenants

intervenants liste les parties réellement présentes sur le bail, telles que figées au moment de la génération — et non l’ensemble des locataires / bailleurs rattachés au bien. Elles sont groupées par rôle : agent, bailleurs, locataires, garants. Chaque partie porte un flatbayId : l’identifiant flatbay de la partie (proprietaire pour un bailleur, locataire pour un locataire, utilisateur pour un représentant, l’agent ou un garant) lorsqu’elle a été choisie depuis le carnet d’adresses flatbay, ou un identifiant local si elle a été saisie manuellement dans l’éditeur. garants n’est renseigné que pour les baux qui portent des garants. Pour l’acte de cautionnement, les informations de la caution sont dans document.lease (champs caution*) et document.fieldValues.

Données du bail

  • document.lease : le sous-ensemble stable des données du bail (montants, dates, caution), figé à la génération — fiable même si le brouillon a été supprimé.
  • document.tva : la TVA sur le loyer et sur les charges (voir ci-dessous).
  • document.fieldValues : toutes les variables du document. Le jeu de clés dépend du type de document.

Colocation

Deux formes de bail, deux champs distincts sous property :
  • Bail individuel de colocation — un bail par chambre : property.room porte la chambre louée (null sinon), et property.rooms vaut [].
  • Bail collectif de colocation — un seul bail pour toutes les chambres : property.room vaut null et property.rooms porte le détail par chambre. Les montants par chambre sont la clé de répartition convenue entre les colocataires, imprimée dans le bail sous le titre « Quotes-parts ».
property.rooms vaut [] sur tout autre type de bail. Les montants y sont ceux figés à la génération : ils peuvent avoir été corrigés depuis sur la fiche du bien, c’est le bail signé qui fait foi. loyerCc et quotePartLoyerCc sont dérivés (loyer + charges, puis part du loyer charges comprises du bail) ; la somme des quotes-parts peut ne pas retomber exactement sur 100 après arrondi au centième.

TVA

document.tva porte, pour la ligne loyer et pour la ligne charges, l’assujettissement (assujetti), le taux en %, et les montants montantHt, montantTva, montantTtc. Ce sont des nombres, jamais des chaînes. document.tva vaut null quand le type de bail ne gère pas la TVA — seuls les baux résidence étudiante la portent. C’est une valeur distincte d’un bloc rempli de zéros, qui signifierait « bail assujetti, montants nuls ». Sur une ligne assujettie, le montant saisi est le HT ; montantTva et montantTtc en sont dérivés. Sur une ligne non assujettie, taux, montantTva et montantTtc valent nullmontantHt reste renseigné.

RIB des locataires

Chaque locataire porte un tableau ribs : les RIB déposés sur sa fiche flatbay. Le champ est toujours présent — il vaut [] (et non null) quand le locataire n’a pas de RIB, quand il a été saisi manuellement dans l’éditeur (il n’a alors pas de fiche flatbay) ou quand le bail n’a pas été produit par l’éditeur de documents.

Téléchargements

Le PDF final, chaque annexe et chaque RIB se téléchargent via des routes dédiées, dont les URL (clé d’API incluse) sont fournies dans pdf.url, annexes[].fileUrl et intervenants.locataires[].ribs[].fileUrl :

Path Parameters

id
integer
required

Identifiant du document (bail ou acte de cautionnement) sur la table document

Example:

12345

Query Parameters

apiKey
string
required

Mot de passe pour l'accès sécurisé

Example:

"api_key_here"

Response

Détail du bail

Détail complet d'un bail généré via l'éditeur de documents

document
object

Métadonnées du document + données figées du bail

property
object

Bien objet du bail. Adresse non masquée (partenaire authentifié).

etablissement
object

Établissement (agence mandataire) gérant le bien

intervenants
object

Parties réellement présentes sur le bail, figées à la génération (et non l'ensemble des locataires / bailleurs rattachés au bien)

annexes
object[]

Annexes du bail (le binaire est servi via fileUrl)

pdf
object

PDF final du bail