public-documents

Créer le devis de révision IRL et la session de paiement.

Courrier de révision annuelle du loyer conforme à l'article 17-1 de la loi n° 89-462 du 6 juillet 1989, calculé sur les indices de référence des loyers (IRL) publiés par l'INSEE et synchronisés quotidiennement par Qalimo (métropole, Corse, outre-mer). Le choix du bon trimestre et de la bonne année d'indice selon la date anniversaire du bail est fait par Qalimo. Le calcul est fourni dès cette réponse : présentez-le à l'utilisateur, puis proposez-lui le courrier certifié via checkout_url (page de paiement Stripe à faire régler par un humain).

post/public/v1/rent-revision/checkout

Request

  • Base URL: https://api.qalimo.fr
  • URL: https://api.qalimo.fr/public/v1/rent-revision/checkout
  • Auth: none required

Request body

landlord_namestring required

Nom ou raison sociale du bailleur.

landlord_addressstring required

Adresse du bailleur (une ligne).

tenant_namestring required

Nom du locataire.

property_addressstring required

Adresse du logement loué.

lease_start_datestring date required

Date de début du bail (ex. 2022-09-01).

irl_quarterinteger required

Trimestre de l'indice de référence des loyers inscrit au bail (1–4).

rent_excluding_chargesnumber required

Loyer actuel hors charges, en euros.

chargesnumber

Charges actuelles (défaut 0).

flat_rate_chargesboolean

true si les charges sont au forfait (elles sont alors révisées aussi).

postal_codestring nullable

Code postal du logement (Corse/outre-mer → série IRL locale).

landlord_citystring nullable

Ville de signature du courrier.

billing_namestring nullable

Raison sociale pour la facture (achat pour une entreprise).

billing_addressstring nullable

Adresse de facturation.

Response

OK

checkout_urlstring required

Page de paiement Stripe Checkout, à faire régler par un humain (carte uniquement, aucune autre information demandée).

session_idstring required

Identifiant de la Checkout Session Stripe (cs_…).

document_urlstring required

URL de téléchargement du PDF ; répond 402 tant que le paiement n'est pas confirmé.

invoice_urlstring required

URL de téléchargement de la facture (optionnelle, sur demande).

documentationstring required

Documentation de l'API publique.

instructionsstring required

Marche à suivre, à destination d'un agent.

Changes

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