Leases

Generate amendment PDF

Generate a legal PDF document for the amendment using Typst templates. The template is automatically selected based on the amendment type:

  • RENT_MODIFICATION: Rent revision template (Art. 17-1)
  • DURATION_MODIFICATION: Duration modification template
  • TENANT_MODIFICATION: Tenant modification template (3 signature zones)
  • Other types: Generic amendment template

Returns the PDF binary content with Content-Type: application/pdf.

post/leases/{lease_id}/amendments/{amendment_id}/generate-pdf

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/amendments/{amendment_id}/generate-pdf
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Lease ID

amendment_idstring uuid required

Amendment ID

Response

PDF generated successfully

Changes

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