Public Tools

Generate a rent receipt (PDF)

Generates a rent receipt PDF. If the amount paid covers the total due the document is a "Quittance"; otherwise a "Reçu".

Accepts the structured payload below, or a simplified payload for AI agents (fields like landlord_name, landlord_address, tenant_name, property_address, month such as "avril 2026", rent, charges, paid); the handler auto-detects and converts it.

Public, unauthenticated tool. Returns application/pdf.

Example

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

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/public/tools/quittance/generate
  • Auth: none required

Request body

loyer_hcnumber required

Monthly rent excluding charges (0–100 000 EUR).

amount_paidnumber required

Amount actually paid (0–100 000 EUR).

payment_datestring date nullable
lieu_signaturestring required

Example request

{
  "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"
  },
  "periode": {
    "debut": "2026-04-01",
    "fin": "2026-04-30"
  },
  "loyer_hc": 850,
  "charges": [
    {
      "libelle": "Provisions charges",
      "montant": 75
    }
  ],
  "amount_paid": 925,
  "lieu_signature": "Lyon"
}

Response

The generated rent receipt PDF.

Changes

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