---
title: "Turn the rent-receipt automation on or off for a lease"
method: PATCH
path: "/leases/{lease_id}/quittance-workflow"
tags: ["Rent Receipts", "Leases"]
---

# Turn the rent-receipt automation on or off for a lease

`PATCH /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

Flips the per-lease switch read by `GET`. Takes effect on the next daily
run: it does not retroactively create or cancel anything already
generated.

## Path parameters

- `lease_id` string, uuid, required

## Request body

- object
  - `enabled` boolean, required

## Response `200`

New state of the switch.

- object
  - `enabled` boolean, required

## Other responses

- `400`: Bad request
- `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)