Rent Reminders

Create a rent reminder

Create a rent reminder (relance) for unpaid rent periods.

French law context (art. 24 loi 89-462): Before any legal proceedings, the landlord must demonstrate graduated reminders:

  1. FRIENDLY: Amiable reminder (email/letter)
  2. FORMAL_NOTICE: Mise en demeure (LRAR recommended)
  3. PAYMENT_ORDER: Commandement de payer (via huissier)

The reminder is created with DRAFT status. Use PUT /leases/{lease_id}/notices/{notice_id}/send to mark it as sent.

Permissions required: leases:write

post/leases/{lease_id}/rent-reminders

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/rent-reminders
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Request body

reminder_type'FRIENDLY' | 'FORMAL_NOTICE' | 'PAYMENT_ORDER' required
due_amountnumber required

Total amount due

delivery_method'EMAIL' | 'LETTER' | 'LRAR' required
tracking_numberstring nullable

LRAR tracking number

notesstring nullable

Example request

{
  "due_amount": 1800,
  "periods_covered": [
    {
      "start": "2025-01-01",
      "end": "2025-01-31"
    },
    {
      "start": "2025-02-01",
      "end": "2025-02-28"
    }
  ]
}

Response

Reminder created

idstring uuid
lease_idstring uuid
reminder_type'FRIENDLY' | 'FORMAL_NOTICE' | 'PAYMENT_ORDER'
sent_datestring date nullable
due_amountnumber
periods_coveredobject[]
delivery_method'EMAIL' | 'LETTER' | 'LRAR'
tracking_numberstring nullable
status'DRAFT' | 'SENT' | 'ACKNOWLEDGED'
document_urlstring nullable
notesstring nullable
created_atstring date-time
updated_atstring date-time

Changes

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