Lease Notices

Generate notice letter PDF

Generate the formal notice letter as a PDF using Typst templates. Selects the appropriate template based on notice_type and notice_reason:

  • Landlord → conge_bailleur.typ (3 variants: sale/reprise/legitimate)
  • Tenant → conge_locataire.typ (11 variants: standard + 10 reduced)
  • Mutual → resiliation_amiable.typ

Updates document_url on the notice.

Permissions required: leases:write

post/leases/{lease_id}/notices/{notice_id}/generate-letter

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/notices/{notice_id}/generate-letter
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required
notice_idstring uuid required

Response

PDF generated, notice updated with document_url

idstring uuid
lease_idstring uuid
notice_type'LANDLORD_NOTICE' | 'TENANT_NOTICE'
notice_reason'SALE' | 'PERSONAL_USE' | 'LEGITIMATE_SERIOUS' | 'TENANT_STANDARD' | 'TENSE_ZONE' | 'FIRST_EMPLOYMENT' | 'PROFESSIONAL_TRANSFER' | 'JOB_LOSS' | 'NEW_JOB_AFTER_JOB_LOSS' | 'RSA_BENEFICIARY' | 'AAH_BENEFICIARY' | 'HEALTH_CONDITION' | 'DOMESTIC_VIOLENCE' | 'SOCIAL_HOUSING_ATTRIBUTION' | 'MUTUAL_AGREEMENT'
initiated_bystring uuid
notice_datestring date
reception_datestring date nullable
effective_datestring date
notice_period_monthsinteger
delivery_method'LRAR' | 'HUISSIER' | 'HAND_DELIVERY' | 'ELECTRONIC_LRAR' nullable
tracking_numberstring nullable
status'DRAFT' | 'SENT' | 'RECEIVED' | 'ACKNOWLEDGED' | 'CONTESTED' | 'EFFECTIVE' | 'CANCELLED'
document_urlstring nullable
signed_document_urlstring nullable
sale_pricenumber nullable
sale_conditionsstring nullable
beneficiary_namestring nullable
beneficiary_addressstring nullable
beneficiary_relationship'SELF' | 'SPOUSE' | 'PACS_PARTNER' | 'COHABITANT' | 'ASCENDANT' | 'DESCENDANT' nullable
reprise_justificationstring nullable
legitimate_reason_detailstring nullable
tenant_preemption_expires_atstring date nullable
tenant_preemption_response'ACCEPTED' | 'DECLINED' | 'EXPIRED' nullable
reduced_notice_justificationstring nullable
justification_document_urlstring nullable
tenant_age_at_noticeinteger nullable
tenant_income_eligibleboolean nullable
landlord_age_exemptionboolean nullable
rehousing_offerstring nullable
contestation_reasonstring nullable
notesstring nullable
created_atstring date-time
updated_atstring date-time

Changes

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