---
title: "Generate a lease amendment (PDF)"
method: POST
path: "/public/tools/avenant/generate"
tags: ["Public Tools"]
---

# Generate a lease amendment (PDF)

`POST /public/tools/avenant/generate`

## Request

- Base URL: `https://api.faireplace.com/api`
- URL: `https://api.faireplace.com/api/public/tools/avenant/generate`
- Auth: none required

Generates a lease amendment (avenant) PDF. `amendment_type` selects the
template: `GENERIC`, `RENT`, `DURATION` or `TENANT`.

Public, unauthenticated tool. Returns `application/pdf`.

## Request body

- AvenantGenerateRequest: Lease amendment generator. `amendment_type` selects the template: `GENERIC` (free amendment), `RENT` (rent revision, Art. 17-1), `DURATION` (duration change) or `TENANT` (tenant change).
  - `amendment_type` 'GENERIC' | 'RENT' | 'DURATION' | 'TENANT', required
  - `effective_date` string, date, required
  - `signature_date` string, date, nullable
  - `lease_id` string, nullable
  - `lease_start_date` string, date, nullable
  - `lease_end_date` string, date, nullable
  - `lease_type` string, nullable
  - `owner` DocOwnerDto, required: Landlord identity for a generated document.
    - `title` string
    - `first_name` string
    - `last_name` string, required
    - `legal_name` string: Company / legal name (e.g. an SCI).
    - `address` string, required
    - `postal_code` string, required
    - `city` string, required
  - `lessees` DocLesseeDto[], required
    - `title` string
    - `first_name` string
    - `last_name` string, required
  - `property` DocPropertyDto, required: Rented dwelling for a generated document.
    - `address` string, required
    - `postal_code` string, required
    - `city` string, required
  - `description` string, nullable: Free description (GENERIC / TENANT).
  - `conditions` string, nullable
  - `previous_amount` string, nullable: RENT: previous rent (formatted string).
  - `new_amount` string, nullable: RENT: new rent (formatted string).
  - `increase_percentage` string, nullable
  - `calculation_method` string, nullable
  - `calculation_details` string, nullable
  - `previous_end_date` string, date, nullable: DURATION: previous end date.
  - `new_end_date` string, date, nullable: DURATION: new end date.
  - `extension_type` string, nullable
  - `reason_details` string, nullable

## Response `200`

The generated amendment PDF.

## Other responses

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