---
title: "Read the rent-receipt automation switch of a lease"
method: GET
path: "/leases/{lease_id}/quittance-workflow"
tags: ["Rent Receipts", "Leases"]
---

# Read the rent-receipt automation switch of a lease

`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

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.

## Path parameters

- `lease_id` string, uuid, required

## Response `200`

OK

- object
  - `enabled` boolean, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/faireplace/apis/faireplace-property-management-api.md) · [All operations](https://skmtc.dev/faireplace/apis/faireplace-property-management-api/llms.txt) · [OpenAPI document](https://skmtc.dev/faireplace/apis/faireplace-property-management-api/revisions/69de39762919?raw)