---
title: "Generate an unpaid-rent reminder (PDF)"
method: POST
path: "/public/tools/relance-impaye/generate"
tags: ["Public Tools"]
---

# Generate an unpaid-rent reminder (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

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`.

## Request body

- RelanceImpayeGenerateRequest: Unpaid-rent reminder / formal notice generator (Art. 7a & 24 Loi 89-462). `reminder_type`: FRIENDLY (amicable), FORMAL_NOTICE (mise en demeure) or PAYMENT_ORDER (commandement: bailiff act).
  - `reminder_type` 'FRIENDLY' | 'FORMAL_NOTICE' | 'PAYMENT_ORDER', required
  - `delivery_method` string, nullable
  - `owner` DocOwnerDto, required: Landlord identity for a generated document.
    - `title` string
    - `first_name` string
    - `last_name` string, required
    - `legal_name` string: Company / legal name (e.g. an SCI).
    - `address` string, required
    - `postal_code` string, required
    - `city` string, required
  - `lessees` RelanceLesseeDto[], required
    - `title` string
    - `first_name` string
    - `last_name` string, required
    - `address` string: Recipient (rented dwelling) address: used for the first tenant.
    - `postal_code` string
    - `city` string
  - `property` DocPropertyDto, required: Rented dwelling for a generated document.
    - `address` string, required
    - `postal_code` string, required
    - `city` string, required
  - `periods` RelancePeriodDto[], required
    - `start` string, date, required
    - `end` string, date, required
  - `due_amount` string, required: Total amount due, pre-formatted client-side (the template adds €).
  - `tracking_number` string, nullable
  - `notes` string, nullable

## Response `200`

The generated reminder PDF.

## Other responses

- `400`: Bad request
- `422`: Unprocessable Entity
- `500`: Internal Server Error

---

[API](https://skmtc.dev/faireplace/apis/faireplace-property-management-api.md) · [All operations](https://skmtc.dev/faireplace/apis/faireplace-property-management-api/llms.txt) · [OpenAPI document](https://skmtc.dev/faireplace/apis/faireplace-property-management-api/revisions/69de39762919?raw)