Rent Receipts
Leases

Send a rent receipt to the tenant by email

Queues the emailing of an already generated receipt. The send is asynchronous: a 202 means "accepted for delivery", not "delivered". Poll GET /leases/{lease_id}/receipts/{receipt_id} and read delivery_status (PENDING → QUEUED → SENT / FAILED).

Three gates, three different failures

The call is refused, with distinct status codes, when:

  • the PDF is not archived yet → 400. Generate it first (POST /leases/{lease_id}/receipts/generate, or POST …/regenerate-pdf if it was lost).
  • a send is already running or has succeeded → 400. Only PENDING and FAILED receipts may be sent; QUEUED and SENT are refused, so a double click cannot email the tenant twice.
  • the landlord has no rent-receipt entitlement → 402. Either a paid plan or the €4.90/year one-shot credit is required (GET /quittance-access).
  • the tenant has not consented to email delivery → 409. See POST /leases/{lease_id}/lessees/{lessee_id}/request-consent.

In every one of those cases the receipt still exists and stays readable by the tenant in their portal: refusing the email never withholds the document itself.

post/leases/{lease_id}/receipts/{receipt_id}/send

Request

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

Path parameters

lease_idstring uuid required
receipt_idstring uuid required

Response

Send accepted; delivery continues asynchronously.

receipt_idstring uuid
delivery_status'PENDING' | 'QUEUED' | 'SENT' | 'FAILED'

Status right after queuing: normally QUEUED.

Changes

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