FairePlace Property Management API

Rent Reminders

Endpointhttps://api.faireplace.com/api

List rent reminders

GET

https://api.faireplace.com/api

/leases/{lease_id}/rent-reminders

List all rent reminders for a lease, with optional status filter.

Permissions required: LeasesRead

List rent reminders › path Parameters

lease_id

string · uuid · required

List rent reminders › query Parameters

status

string · enum

Enum values:

DRAFT

SENT

ACKNOWLEDGED

List rent reminders › Responses

List of rent reminders

object[]

id

string · uuid

lease_id

string · uuid

reminder_type

string · enum

Enum values:

FRIENDLY

FORMAL_NOTICE

PAYMENT_ORDER

sent_date

string | null · date

due_amount

number · decimal

object[]

delivery_method

string · enum

Enum values:

LETTER

LRAR

tracking_number

string | null

status

string · enum

Enum values:

DRAFT

SENT

ACKNOWLEDGED

document_url

string | null

notes

string | null

created_at

string · date-time

updated_at

string · date-time

GET/leases/{lease_id}/rent-reminders

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/rent-reminders

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "lease_id": "00000000-0000-0000-0000-000000000000",
    "reminder_type": "FRIENDLY",
    "sent_date": "2024-08-25",
    "due_amount": 0,
    "periods_covered": [
      {}
    ],
    "delivery_method": "EMAIL",
    "tracking_number": {},
    "status": "DRAFT",
    "document_url": {},
    "notes": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Create a rent reminder

POST

https://api.faireplace.com/api

/leases/{lease_id}/rent-reminders

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:

FRIENDLY — Amiable reminder (email/letter)
FORMAL_NOTICE — Mise en demeure (LRAR recommended)
PAYMENT_ORDER — Commandement de payer (via huissier)

The reminder is created with DRAFT status. Use /send to mark it as sent.

Permissions required: LeasesWrite

Create a rent reminder › path Parameters

lease_id

string · uuid · required

Create a rent reminder › Request Body

reminder_type

string · enum · required

Enum values:

FRIENDLY

FORMAL_NOTICE

PAYMENT_ORDER

due_amount

number · decimal · required

Total amount due

Example: 1800

object[] · required

JSON array of covered periods

Example: [{"start":"2025-01-01","end":"2025-01-31"},{"start":"2025-02-01","end":"2025-02-28"}]

delivery_method

string · enum · required

Enum values:

LETTER

LRAR

tracking_number

string | null

LRAR tracking number

notes

string | null

Create a rent reminder › Responses

Reminder created

id

string · uuid

lease_id

string · uuid

reminder_type

string · enum

Enum values:

FRIENDLY

FORMAL_NOTICE

PAYMENT_ORDER

sent_date

string | null · date

due_amount

number · decimal

object[]

delivery_method

string · enum

Enum values:

LETTER

LRAR

tracking_number

string | null

status

string · enum

Enum values:

DRAFT

SENT

ACKNOWLEDGED

document_url

string | null

notes

string | null

created_at

string · date-time

updated_at

string · date-time

POST/leases/{lease_id}/rent-reminders

curl --request POST \
  --url https://api.faireplace.com/api/leases/:lease_id/rent-reminders \
  --header 'Content-Type: application/json' \
  --data '
{
  "reminder_type": "FRIENDLY",
  "due_amount": 1800,
  "periods_covered": [
    {
      "start": "2025-01-01",
      "end": "2025-01-31"
    },
    {
      "start": "2025-02-01",
      "end": "2025-02-28"
    }
  ],
  "delivery_method": "EMAIL",
  "tracking_number": {},
  "notes": {}
}
'

shell

Example Request Body

{
  "reminder_type": "FRIENDLY",
  "due_amount": 1800,
  "periods_covered": [
    {
      "start": "2025-01-01",
      "end": "2025-01-31"
    },
    {
      "start": "2025-02-01",
      "end": "2025-02-28"
    }
  ],
  "delivery_method": "EMAIL",
  "tracking_number": {},
  "notes": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "reminder_type": "FRIENDLY",
  "sent_date": "2024-08-25",
  "due_amount": 0,
  "periods_covered": [
    {}
  ],
  "delivery_method": "EMAIL",
  "tracking_number": {},
  "status": "DRAFT",
  "document_url": {},
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get a rent reminder

GET

https://api.faireplace.com/api

/leases/{lease_id}/rent-reminders/{reminder_id}

Retrieve a specific rent reminder by ID.

Permissions required: LeasesRead

Get a rent reminder › path Parameters

lease_id

string · uuid · required

reminder_id

string · uuid · required

Get a rent reminder › Responses

Reminder details

id

string · uuid

lease_id

string · uuid

reminder_type

string · enum

Enum values:

FRIENDLY

FORMAL_NOTICE

PAYMENT_ORDER

sent_date

string | null · date

due_amount

number · decimal

object[]

delivery_method

string · enum

Enum values:

LETTER

LRAR

tracking_number

string | null

status

string · enum

Enum values:

DRAFT

SENT

ACKNOWLEDGED

document_url

string | null

notes

string | null

created_at

string · date-time

updated_at

string · date-time

GET/leases/{lease_id}/rent-reminders/{reminder_id}

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/rent-reminders/:reminder_id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "reminder_type": "FRIENDLY",
  "sent_date": "2024-08-25",
  "due_amount": 0,
  "periods_covered": [
    {}
  ],
  "delivery_method": "EMAIL",
  "tracking_number": {},
  "status": "DRAFT",
  "document_url": {},
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update a rent reminder

PUT

https://api.faireplace.com/api

/leases/{lease_id}/rent-reminders/{reminder_id}

Update a rent reminder. Only draft reminders can be updated.

Permissions required: LeasesWrite

Update a rent reminder › path Parameters

lease_id

string · uuid · required

reminder_id

string · uuid · required

Update a rent reminder › Request Body

reminder_type

string · enum

Enum values:

FRIENDLY

FORMAL_NOTICE

PAYMENT_ORDER

due_amount

number · decimal

object[]

delivery_method

string · enum

Enum values:

LETTER

LRAR

tracking_number

string

notes

string

Update a rent reminder › Responses

Reminder updated

id

string · uuid

lease_id

string · uuid

reminder_type

string · enum

Enum values:

FRIENDLY

FORMAL_NOTICE

PAYMENT_ORDER

sent_date

string | null · date

due_amount

number · decimal

object[]

delivery_method

string · enum

Enum values:

LETTER

LRAR

tracking_number

string | null

status

string · enum

Enum values:

DRAFT

SENT

ACKNOWLEDGED

document_url

string | null

notes

string | null

created_at

string · date-time

updated_at

string · date-time

PUT/leases/{lease_id}/rent-reminders/{reminder_id}

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/rent-reminders/:reminder_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "reminder_type": "FRIENDLY",
  "due_amount": 0,
  "periods_covered": [
    {}
  ],
  "delivery_method": "EMAIL",
  "tracking_number": "tracking_number",
  "notes": "notes"
}
'

shell

Example Request Body

{
  "reminder_type": "FRIENDLY",
  "due_amount": 0,
  "periods_covered": [
    {}
  ],
  "delivery_method": "EMAIL",
  "tracking_number": "tracking_number",
  "notes": "notes"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "reminder_type": "FRIENDLY",
  "sent_date": "2024-08-25",
  "due_amount": 0,
  "periods_covered": [
    {}
  ],
  "delivery_method": "EMAIL",
  "tracking_number": {},
  "status": "DRAFT",
  "document_url": {},
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete a rent reminder

DELETE

https://api.faireplace.com/api

/leases/{lease_id}/rent-reminders/{reminder_id}

Delete a rent reminder. Only draft reminders can be deleted.

Permissions required: LeasesDelete

Delete a rent reminder › path Parameters

lease_id

string · uuid · required

reminder_id

string · uuid · required

Delete a rent reminder › Responses

Reminder deleted

No data returned

DELETE/leases/{lease_id}/rent-reminders/{reminder_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/leases/:lease_id/rent-reminders/:reminder_id

shell

Example Responses

No example specified for this content type

Generate reminder letter PDF

POST

https://api.faireplace.com/api

/leases/{lease_id}/rent-reminders/{reminder_id}/generate-pdf

Generate a formal letter PDF for the reminder using Typst templates. The generated document URL is stored on the reminder.

Permissions required: LeasesWrite

Generate reminder letter PDF › path Parameters

lease_id

string · uuid · required

reminder_id

string · uuid · required

Generate reminder letter PDF › Responses

PDF generation result

id

string · uuid

status

string

message

string

POST/leases/{lease_id}/rent-reminders/{reminder_id}/generate-pdf

curl --request POST \
  --url https://api.faireplace.com/api/leases/:lease_id/rent-reminders/:reminder_id/generate-pdf

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "status",
  "message": "message"
}

json

application/json

Mark reminder as sent

PUT

https://api.faireplace.com/api

/leases/{lease_id}/rent-reminders/{reminder_id}/send

Mark a reminder as sent. Sets status to SENT and records the current date as sent_date.

Permissions required: LeasesWrite

Mark reminder as sent › path Parameters

lease_id

string · uuid · required

reminder_id

string · uuid · required

Mark reminder as sent › Responses

Reminder marked as sent

id

string · uuid

lease_id

string · uuid

reminder_type

string · enum

Enum values:

FRIENDLY

FORMAL_NOTICE

PAYMENT_ORDER

sent_date

string | null · date

due_amount

number · decimal

object[]

delivery_method

string · enum

Enum values:

LETTER

LRAR

tracking_number

string | null

status

string · enum

Enum values:

DRAFT

SENT

ACKNOWLEDGED

document_url

string | null

notes

string | null

created_at

string · date-time

updated_at

string · date-time

PUT/leases/{lease_id}/rent-reminders/{reminder_id}/send

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/rent-reminders/:reminder_id/send

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "reminder_type": "FRIENDLY",
  "sent_date": "2024-08-25",
  "due_amount": 0,
  "periods_covered": [
    {}
  ],
  "delivery_method": "EMAIL",
  "tracking_number": {},
  "status": "DRAFT",
  "document_url": {},
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Lease Notices Payments