Public Tools

Generate a security-deposit restitution receipt (PDF)

Renders the restitution receipt (bordereau) as a PDF. Same computation inputs as POST /public/tools/depot-garantie/calculate plus the parties, signature place and rendering options.

Public, unauthenticated tool. Returns application/pdf.

Example

curl -X POST https://api.faireplace.com/api/public/tools/depot-garantie/bordereau \
  -H "Content-Type: application/json" \
  -d '{ ... }' --output bordereau.pdf
post/public/tools/depot-garantie/bordereau

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/public/tools/depot-garantie/bordereau
  • Auth: none required

Request body

lease_typestring required
monthly_rent_hcnumber required
deposit_amountnumber required
lease_end_datestring date required
exit_inspection_conformityboolean nullable
retained_for_chargesnumber nullable
retained_for_damagesnumber nullable
retained_for_unpaid_rentnumber nullable
actual_return_datestring date nullable
lieu_signaturestring required

Place where the receipt is signed.

deposit_paid_datestring date nullable

Date the deposit was paid at lease signature (shown on the receipt).

restitution_mode'virement' | 'cheque' | 'especes' nullable

Restitution mode shown on the receipt. Default virement.

justification_chargesstring nullable

Optional free-text justification for the charges retention.

justification_damagesstring nullable
justification_unpaid_rentstring nullable

Example request

{
  "lease_type": "vide",
  "monthly_rent_hc": 750,
  "deposit_amount": 750,
  "lease_end_date": "2026-03-31",
  "exit_inspection_conformity": true,
  "bailleur": {
    "nom_prenom": "Camille Richard",
    "adresse": "12 rue de la République",
    "code_postal": "75001",
    "ville": "Paris"
  },
  "locataire": {
    "nom_prenom": "Camille Richard",
    "adresse": "12 rue de la République",
    "code_postal": "75001",
    "ville": "Paris"
  },
  "logement": {
    "adresse": "34 rue de la République",
    "code_postal": "69002",
    "ville": "Lyon",
    "nom": "Appartement T3"
  },
  "lieu_signature": "Lyon",
  "restitution_mode": "virement"
}

Response

The generated restitution receipt PDF.

Changes

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