Rent Receipts
Leases

Read the rent-receipt automation switch of a lease

Tells you whether the automatic rent-receipt loop is on for this lease.

When enabled, the daily job reminds the landlord at the rent due date and, once payment is confirmed, generates and sends the receipt. When disabled, the lease is skipped entirely by that job: you can still generate and send receipts by hand.

The switch is per lease, not per account: a landlord can automate one property and keep another manual.

get/leases/{lease_id}/quittance-workflow

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/quittance-workflow
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Response

OK

enabledboolean required

Changes

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