Lease Notices

Compute notice dates

Pure computation endpoint. Calculates notice period, effective date, and preemption expiry based on notice type, reason, and lease type.

Permissions required: leases:read

get/leases/{lease_id}/notices/compute-dates

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/notices/compute-dates
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Query parameters

notice_type'LANDLORD_NOTICE' | 'TENANT_NOTICE' required
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' required
lease_typestring required

"VIDE" or "MEUBLE"

reception_datestring date

Base date for computation (defaults to today)

Response

Computed dates

notice_period_monthsinteger
effective_datestring date
preemption_expires_atstring date nullable

Changes

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