---
title: "Generate payment schedule"
method: POST
path: "/leases/{lease_id}/rent-payments/generate-schedule"
tags: ["Rent Payments"]
---

# Generate payment schedule

`POST /leases/{lease_id}/rent-payments/generate-schedule`

## Request

- Base URL: `https://api.faireplace.com/api`
- URL: `https://api.faireplace.com/api/leases/{lease_id}/rent-payments/generate-schedule`
- Auth: HTTP bearer

Generates expected payment entries for a date range based on the lease parameters (rent amount, frequency).
Skips periods where a payment already exists.

**Permissions required:** `leases:write`

## Path parameters

- `lease_id` string, uuid, required

## Request body

- object
  - `range_start` string, date, required
  - `range_end` string, date, required

## Response `201`

Payment schedule entries created

- RentPaymentResponse[]
  - `id` string, uuid
  - `lease_id` string, uuid
  - `period_start` string, date
  - `period_end` string, date
  - `expected_amount` number
  - `paid_amount` number
  - `payment_date` string, date, nullable
  - `payment_method` string, nullable
  - `reference` string, nullable
  - `status` 'PENDING' | 'PAID' | 'PARTIALLY_PAID' | 'LATE' | 'UNPAID' | 'IN_DISPUTE'
  - `receipt_id` string, uuid, nullable
  - `notes` string, nullable
  - `created_at` string, date-time
  - `updated_at` string, date-time

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Lease not found

---

[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)