Public Tools

Generate a lease amendment (PDF)

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

Public, unauthenticated tool. Returns application/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

Request body

amendment_type'GENERIC' | 'RENT' | 'DURATION' | 'TENANT' required

effective_datestring date required

signature_datestring date nullable

lease_idstring nullable

lease_start_datestring date nullable

lease_end_datestring date nullable

lease_typestring nullable

descriptionstring nullable

Free description (GENERIC / TENANT).

conditionsstring nullable

previous_amountstring nullable

RENT: previous rent (formatted string).

new_amountstring nullable

RENT: new rent (formatted string).

increase_percentagestring nullable

calculation_methodstring nullable

calculation_detailsstring nullable

previous_end_datestring date nullable

DURATION: previous end date.

new_end_datestring date nullable

DURATION: new end date.

extension_typestring nullable

reason_detailsstring nullable

Example request

{
  "amendment_type": "RENT",
  "effective_date": "2026-07-01",
  "owner": {
    "title": "M.",
    "first_name": "Jean",
    "last_name": "Dupont",
    "legal_name": "SCI Les Tilleuls",
    "address": "12 rue de la République",
    "postal_code": "75001",
    "city": "Paris"
  },
  "lessees": [
    {
      "title": "Mme",
      "first_name": "Alice",
      "last_name": "Martin"
    }
  ],
  "property": {
    "address": "34 rue de la République",
    "postal_code": "69002",
    "city": "Lyon"
  }
}

Response

The generated amendment PDF.

Changes

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