Leases

Get a rent receipt

Retrieve a specific rent receipt by ID.

Permissions required: leases:read

get/leases/{lease_id}/receipts/{receipt_id}

Request

Base URL: https://api.faireplace.com/api
URL: https://api.faireplace.com/api/leases/{lease_id}/receipts/{receipt_id}
Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Lease ID

receipt_idstring uuid required

Receipt ID

Response

Receipt details

idstring uuid required

Unique identifier of the rent receipt

lease_idstring uuid required

ID of the associated lease

lessee_idstring uuid required

ID of the tenant this receipt is for

lessee_namestring required

Full name of the tenant

period_startstring date required

Start date of the rental period

period_endstring date required

End date of the rental period

rent_amountnumber required

Rent amount for this tenant (adjusted by rent_share)

charges_totalnumber required

Total charges amount for this tenant (adjusted by rent_share)

total_duenumber required

Total amount due (rent + charges)

amount_paidnumber required

Amount actually paid by the tenant

document_typestring required

QUITTANCE (full payment) or RECU (partial payment)

has_pdfboolean required

Whether a PDF has been generated for this receipt

Example response

{
  "lessee_name": "Marie Martin",
  "period_start": "2026-03-01",
  "period_end": "2026-03-31",
  "rent_amount": 450,
  "charges_total": 87.5,
  "charges_detail": [
    {
      "category_name": "Eau froide",
      "amount": 12.5,
      "calculation_method": "Provision"
    }
  ],
  "total_due": 537.5,
  "amount_paid": 537.5,
  "document_type": "QUITTANCE",
  "has_pdf": true
}

Changes

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