Rent Receipts

List every rent receipt of the organisation

Cross-lease view of the rent receipts issued by the landlord, optionally narrowed to a period.

Each row already carries the property label and the tenant's name, so a table can be rendered from this single call: no fan-out into /leases, /estates and /lessees.

For the per-lease list, use GET /leases/{lease_id}/receipts.

get/receipts

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/receipts
  • Auth: HTTP bearer

Query parameters

period_startstring date

Keep only receipts whose period starts on or after this date.

period_endstring date

Keep only receipts whose period ends on or before this date.

Response

OK

receipt_idstring uuid
lease_idstring uuid
lessee_idstring uuid
property_labelstring

Libellé lisible du bien : « nom, adresse ».

L'adresse est omise quand elle n'ajoute rien: beaucoup de bailleurs nomment leur bien par son adresse, et la coller deux fois donnait des lignes identiques pour chaque lot d'un même immeuble. Un numéro de lot présent dans le nom reste donc distinctif, alors qu'un nom qui reprend mot pour mot l'adresse se suffit à lui-même.

lessee_namestring

Legal name if the tenant is a company, otherwise first + last name.

period_startstring date
period_endstring date
total_duestring

Total amount of the receipt, as a decimal string.

document_typestring

QUITTANCE when the rent was paid in full, RECU for a partial payment: the two are legally distinct documents.

delivery_status'PENDING' | 'QUEUED' | 'SENT' | 'FAILED'
  • PENDING: generated, never sent
  • QUEUED: send accepted, delivery in flight
  • SENT: delivered to the tenant
  • FAILED: delivery failed; the receipt may be sent again
sent_atstring nullable

When the receipt was emailed. null when it has not been sent.

No timezone offset is carried by this field: read it as Europe/Paris, and do not feed it to a parser that assumes UTC.

Example response

[
  {
    "property_label": "Studio 3B, 12 rue de la Paix, 75002 Paris",
    "lessee_name": "Marie Dupont",
    "total_due": "850.00",
    "document_type": "QUITTANCE",
    "delivery_status": "SENT",
    "sent_at": "2026-03-05T08:30:00.123456"
  }
]

Changes

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