Public Tools

Generate an unpaid-rent reminder (PDF)

Generates an unpaid-rent reminder / formal notice PDF (Art. 7a & 24 Loi 89-462). reminder_type: FRIENDLY, FORMAL_NOTICE or PAYMENT_ORDER.

Public, unauthenticated tool. Returns application/pdf.

post/public/tools/relance-impaye/generate

Request

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

Request body

reminder_type'FRIENDLY' | 'FORMAL_NOTICE' | 'PAYMENT_ORDER' required
delivery_methodstring nullable
due_amountstring required

Total amount due, pre-formatted client-side (the template adds €).

tracking_numberstring nullable
notesstring nullable

Example request

{
  "reminder_type": "FORMAL_NOTICE",
  "owner": {
    "title": "M.",
    "first_name": "Jean",
    "last_name": "Dupont",
    "legal_name": "SCI Les Tilleuls",
    "address": "12 rue de la République",
    "postal_code": "75001",
    "city": "Paris"
  },
  "property": {
    "address": "34 rue de la République",
    "postal_code": "69002",
    "city": "Lyon"
  },
  "periods": [
    {
      "start": "2026-04-01",
      "end": "2026-04-30"
    }
  ],
  "due_amount": "1 700,00"
}

Response

The generated reminder PDF.

Changes

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