Monthly rent tracking across all active leases

The landlord's monthly dashboard: one row per active lease, telling you whether the rent for the period was received and whether the receipt has been produced and sent.

Both period_start and period_end are required: this is a view of a given month, not an open-ended history.

payment_status is computed, not stored: paid when a payment is recorded, otherwise late or pending depending on whether the lease's due date for that period has passed. The due day is clamped to the length of the month, so a lease due on the 31st falls due on 28 February.

Served by a single read model: no N+1 behind it, so it stays usable on large portfolios.

get/rent-status

Request

Base URL: https://api.faireplace.com/api
URL: https://api.faireplace.com/api/rent-status
Auth: HTTP bearer

Query parameters

period_startstring date required

First day of the period, typically the 1st of the month.

period_endstring date required

Last day of the period.

Response

lease_idstring uuid

property_labelstring

Libellé lisible du bien : « nom, adresse ». L'adresse est omise quand le nom la reprend déjà.

tenant_namestring

rent_amountstring

Rent for the period, as a decimal string.

payment_status'paid' | 'pending' | 'late'

paid: payment recorded for the period
pending: not received yet, due date not passed
late: due date passed and nothing recorded

The due date is the lease's payment day, clamped to the length of the month (a lease due on the 31st falls due on the 28th in February).

receipt_idstring uuid nullable

Receipt for this period, null if none was generated yet.

receipt_statusstring nullable

Delivery status of that receipt, null when there is none.

Example response

[
  {
    "property_label": "Studio 3B, 12 rue de la Paix, 75002 Paris",
    "tenant_name": "Marie Dupont",
    "rent_amount": "850.00",
    "payment_status": "pending",
    "receipt_status": "SENT"
  }
]

Changes

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