FairePlace Property Management API

Lease Notices

Endpointhttps://api.faireplace.com/api

List lease notices

GET

https://api.faireplace.com/api

/leases/{lease_id}/notices

List all notices for a lease, with optional status filter.

Permissions required: LeasesRead

List lease notices › path Parameters

lease_id

string · uuid · required

List lease notices › query Parameters

status

string · enum

Enum values:

DRAFT

SENT

RECEIVED

ACKNOWLEDGED

CONTESTED

EFFECTIVE

CANCELLED

List lease notices › Responses

List of notices

object[]

id

string · uuid

lease_id

string · uuid

notice_type

string · enum

Enum values:

LANDLORD_NOTICE

TENANT_NOTICE

notice_reason

string · enum

Enum values:

SALE

PERSONAL_USE

LEGITIMATE_SERIOUS

TENANT_STANDARD

TENSE_ZONE

FIRST_EMPLOYMENT

PROFESSIONAL_TRANSFER

JOB_LOSS

initiated_by

string · uuid

notice_date

string · date

reception_date

string | null · date

effective_date

string · date

notice_period_months

integer

delivery_method

string | null · enum

Enum values:

LRAR

HUISSIER

HAND_DELIVERY

ELECTRONIC_LRAR

tracking_number

string | null

status

string · enum

Enum values:

DRAFT

SENT

RECEIVED

ACKNOWLEDGED

CONTESTED

EFFECTIVE

CANCELLED

document_url

string | null

signed_document_url

string | null

sale_price

number | null · decimal

sale_conditions

string | null

beneficiary_name

string | null

beneficiary_address

string | null

beneficiary_relationship

string | null · enum

Enum values:

SELF

SPOUSE

PACS_PARTNER

COHABITANT

ASCENDANT

DESCENDANT

reprise_justification

string | null

legitimate_reason_detail

string | null

tenant_preemption_expires_at

string | null · date

tenant_preemption_response

string | null · enum

Enum values:

ACCEPTED

DECLINED

EXPIRED

reduced_notice_justification

string | null

justification_document_url

string | null

tenant_age_at_notice

integer | null

tenant_income_eligible

boolean | null

landlord_age_exemption

boolean | null

rehousing_offer

string | null

contestation_reason

string | null

notes

string | null

created_at

string · date-time

updated_at

string · date-time

GET/leases/{lease_id}/notices

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/notices

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "lease_id": "00000000-0000-0000-0000-000000000000",
    "notice_type": "LANDLORD_NOTICE",
    "notice_reason": "SALE",
    "initiated_by": "00000000-0000-0000-0000-000000000000",
    "notice_date": "2024-08-25",
    "reception_date": "2024-08-25",
    "effective_date": "2024-08-25",
    "notice_period_months": 0,
    "delivery_method": "LRAR",
    "tracking_number": {},
    "status": "DRAFT",
    "document_url": {},
    "signed_document_url": {},
    "sale_price": {},
    "sale_conditions": {},
    "beneficiary_name": {},
    "beneficiary_address": {},
    "beneficiary_relationship": "SELF",
    "reprise_justification": {},
    "legitimate_reason_detail": {},
    "tenant_preemption_expires_at": "2024-08-25",
    "tenant_preemption_response": "ACCEPTED",
    "reduced_notice_justification": {},
    "justification_document_url": {},
    "tenant_age_at_notice": {},
    "tenant_income_eligible": {},
    "landlord_age_exemption": {},
    "rehousing_offer": {},
    "contestation_reason": {},
    "notes": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Create a lease notice

POST

https://api.faireplace.com/api

/leases/{lease_id}/notices

Create a lease notice (congé) for a lease — landlord or tenant side.

French law context (art. 15 loi 89-462, loi ALUR): A notice terminates or non-renews the lease. The system automatically computes:

notice_period_months based on type/reason/lease type
effective_date = notice_date + period (last day of month)
tenant_preemption_expires_at for sale notices (2 months)

Created with DRAFT status. Use /generate-letter → /send → /receive workflow.

Permissions required: LeasesWrite

Create a lease notice › path Parameters

lease_id

string · uuid · required

Create a lease notice › Request Body

notice_type

string · enum · required

Enum values:

LANDLORD_NOTICE

TENANT_NOTICE

notice_reason

string · enum · required

Enum values:

SALE

PERSONAL_USE

LEGITIMATE_SERIOUS

TENANT_STANDARD

TENSE_ZONE

FIRST_EMPLOYMENT

PROFESSIONAL_TRANSFER

JOB_LOSS

initiated_by

string · uuid · required

Person ID (owner or lessee) who initiates the notice

notice_date

string · date · required

delivery_method

string | null · enum

Enum values:

LRAR

HUISSIER

HAND_DELIVERY

ELECTRONIC_LRAR

sale_price

number | null · decimal

Sale price (landlord sale notice only)

sale_conditions

string | null

beneficiary_name

string | null

Name of the person for personal use (landlord reprise only)

beneficiary_address

string | null

beneficiary_relationship

string | null · enum

Enum values:

SELF

SPOUSE

PACS_PARTNER

COHABITANT

ASCENDANT

DESCENDANT

reprise_justification

string | null

legitimate_reason_detail

string | null

reduced_notice_justification

string | null

Justification for reduced notice period (tenant only)

notes

string | null

Create a lease notice › Responses

Notice created

id

string · uuid

lease_id

string · uuid

notice_type

string · enum

Enum values:

LANDLORD_NOTICE

TENANT_NOTICE

notice_reason

string · enum

Enum values:

SALE

PERSONAL_USE

LEGITIMATE_SERIOUS

TENANT_STANDARD

TENSE_ZONE

FIRST_EMPLOYMENT

PROFESSIONAL_TRANSFER

JOB_LOSS

initiated_by

string · uuid

notice_date

string · date

reception_date

string | null · date

effective_date

string · date

notice_period_months

integer

delivery_method

string | null · enum

Enum values:

LRAR

HUISSIER

HAND_DELIVERY

ELECTRONIC_LRAR

tracking_number

string | null

status

string · enum

Enum values:

DRAFT

SENT

RECEIVED

ACKNOWLEDGED

CONTESTED

EFFECTIVE

CANCELLED

document_url

string | null

signed_document_url

string | null

sale_price

number | null · decimal

sale_conditions

string | null

beneficiary_name

string | null

beneficiary_address

string | null

beneficiary_relationship

string | null · enum

Enum values:

SELF

SPOUSE

PACS_PARTNER

COHABITANT

ASCENDANT

DESCENDANT

reprise_justification

string | null

legitimate_reason_detail

string | null

tenant_preemption_expires_at

string | null · date

tenant_preemption_response

string | null · enum

Enum values:

ACCEPTED

DECLINED

EXPIRED

reduced_notice_justification

string | null

justification_document_url

string | null

tenant_age_at_notice

integer | null

tenant_income_eligible

boolean | null

landlord_age_exemption

boolean | null

rehousing_offer

string | null

contestation_reason

string | null

notes

string | null

created_at

string · date-time

updated_at

string · date-time

POST/leases/{lease_id}/notices

curl --request POST \
  --url https://api.faireplace.com/api/leases/:lease_id/notices \
  --header 'Content-Type: application/json' \
  --data '
{
  "notice_type": "LANDLORD_NOTICE",
  "notice_reason": "SALE",
  "initiated_by": "00000000-0000-0000-0000-000000000000",
  "notice_date": "2024-08-25",
  "delivery_method": "LRAR",
  "sale_price": {},
  "sale_conditions": {},
  "beneficiary_name": {},
  "beneficiary_address": {},
  "beneficiary_relationship": "SELF",
  "reprise_justification": {},
  "legitimate_reason_detail": {},
  "reduced_notice_justification": {},
  "notes": {}
}
'

shell

Example Request Body

{
  "notice_type": "LANDLORD_NOTICE",
  "notice_reason": "SALE",
  "initiated_by": "00000000-0000-0000-0000-000000000000",
  "notice_date": "2024-08-25",
  "delivery_method": "LRAR",
  "sale_price": {},
  "sale_conditions": {},
  "beneficiary_name": {},
  "beneficiary_address": {},
  "beneficiary_relationship": "SELF",
  "reprise_justification": {},
  "legitimate_reason_detail": {},
  "reduced_notice_justification": {},
  "notes": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "notice_type": "LANDLORD_NOTICE",
  "notice_reason": "SALE",
  "initiated_by": "00000000-0000-0000-0000-000000000000",
  "notice_date": "2024-08-25",
  "reception_date": "2024-08-25",
  "effective_date": "2024-08-25",
  "notice_period_months": 0,
  "delivery_method": "LRAR",
  "tracking_number": {},
  "status": "DRAFT",
  "document_url": {},
  "signed_document_url": {},
  "sale_price": {},
  "sale_conditions": {},
  "beneficiary_name": {},
  "beneficiary_address": {},
  "beneficiary_relationship": "SELF",
  "reprise_justification": {},
  "legitimate_reason_detail": {},
  "tenant_preemption_expires_at": "2024-08-25",
  "tenant_preemption_response": "ACCEPTED",
  "reduced_notice_justification": {},
  "justification_document_url": {},
  "tenant_age_at_notice": {},
  "tenant_income_eligible": {},
  "landlord_age_exemption": {},
  "rehousing_offer": {},
  "contestation_reason": {},
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Compute notice dates

GET

https://api.faireplace.com/api

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

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

Permissions required: LeasesRead

Compute notice dates › path Parameters

lease_id

string · uuid · required

Compute notice dates › query Parameters

notice_type

string · enum · required

Enum values:

LANDLORD_NOTICE

TENANT_NOTICE

notice_reason

string · enum · required

Enum values:

SALE

PERSONAL_USE

LEGITIMATE_SERIOUS

TENANT_STANDARD

TENSE_ZONE

FIRST_EMPLOYMENT

PROFESSIONAL_TRANSFER

JOB_LOSS

lease_type

string · required

"VIDE" or "MEUBLE"

reception_date

string · date

Base date for computation (defaults to today)

Compute notice dates › Responses

Computed dates

notice_period_months

integer

effective_date

string · date

preemption_expires_at

string | null · date

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

curl --request GET \
  --url 'https://api.faireplace.com/api/leases/:lease_id/notices/compute-dates?notice_type=%3Cstring%3E&notice_reason=%3Cstring%3E&lease_type=%3Cstring%3E'

shell

Example Responses

{
  "notice_period_months": 0,
  "effective_date": "2024-08-25",
  "preemption_expires_at": "2024-08-25"
}

json

application/json

Get a lease notice

GET

https://api.faireplace.com/api

/leases/{lease_id}/notices/{notice_id}

Retrieve detailed information about a specific notice.

Permissions required: LeasesRead

Get a lease notice › path Parameters

lease_id

string · uuid · required

notice_id

string · uuid · required

Get a lease notice › Responses

Notice details

id

string · uuid

lease_id

string · uuid

notice_type

string · enum

Enum values:

LANDLORD_NOTICE

TENANT_NOTICE

notice_reason

string · enum

Enum values:

SALE

PERSONAL_USE

LEGITIMATE_SERIOUS

TENANT_STANDARD

TENSE_ZONE

FIRST_EMPLOYMENT

PROFESSIONAL_TRANSFER

JOB_LOSS

initiated_by

string · uuid

notice_date

string · date

reception_date

string | null · date

effective_date

string · date

notice_period_months

integer

delivery_method

string | null · enum

Enum values:

LRAR

HUISSIER

HAND_DELIVERY

ELECTRONIC_LRAR

tracking_number

string | null

status

string · enum

Enum values:

DRAFT

SENT

RECEIVED

ACKNOWLEDGED

CONTESTED

EFFECTIVE

CANCELLED

document_url

string | null

signed_document_url

string | null

sale_price

number | null · decimal

sale_conditions

string | null

beneficiary_name

string | null

beneficiary_address

string | null

beneficiary_relationship

string | null · enum

Enum values:

SELF

SPOUSE

PACS_PARTNER

COHABITANT

ASCENDANT

DESCENDANT

reprise_justification

string | null

legitimate_reason_detail

string | null

tenant_preemption_expires_at

string | null · date

tenant_preemption_response

string | null · enum

Enum values:

ACCEPTED

DECLINED

EXPIRED

reduced_notice_justification

string | null

justification_document_url

string | null

tenant_age_at_notice

integer | null

tenant_income_eligible

boolean | null

landlord_age_exemption

boolean | null

rehousing_offer

string | null

contestation_reason

string | null

notes

string | null

created_at

string · date-time

updated_at

string · date-time

GET/leases/{lease_id}/notices/{notice_id}

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/notices/:notice_id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "notice_type": "LANDLORD_NOTICE",
  "notice_reason": "SALE",
  "initiated_by": "00000000-0000-0000-0000-000000000000",
  "notice_date": "2024-08-25",
  "reception_date": "2024-08-25",
  "effective_date": "2024-08-25",
  "notice_period_months": 0,
  "delivery_method": "LRAR",
  "tracking_number": {},
  "status": "DRAFT",
  "document_url": {},
  "signed_document_url": {},
  "sale_price": {},
  "sale_conditions": {},
  "beneficiary_name": {},
  "beneficiary_address": {},
  "beneficiary_relationship": "SELF",
  "reprise_justification": {},
  "legitimate_reason_detail": {},
  "tenant_preemption_expires_at": "2024-08-25",
  "tenant_preemption_response": "ACCEPTED",
  "reduced_notice_justification": {},
  "justification_document_url": {},
  "tenant_age_at_notice": {},
  "tenant_income_eligible": {},
  "landlord_age_exemption": {},
  "rehousing_offer": {},
  "contestation_reason": {},
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update a lease notice

PUT

https://api.faireplace.com/api

/leases/{lease_id}/notices/{notice_id}

Update a notice (Draft status only). If type/reason/date change, dates are recalculated.

Permissions required: LeasesWrite

Update a lease notice › path Parameters

lease_id

string · uuid · required

notice_id

string · uuid · required

Update a lease notice › Request Body

notice_type

string · enum

Enum values:

LANDLORD_NOTICE

TENANT_NOTICE

notice_reason

string · enum

Enum values:

SALE

PERSONAL_USE

LEGITIMATE_SERIOUS

TENANT_STANDARD

TENSE_ZONE

FIRST_EMPLOYMENT

PROFESSIONAL_TRANSFER

JOB_LOSS

initiated_by

string · uuid

notice_date

string · date

delivery_method

string · enum

Enum values:

LRAR

HUISSIER

HAND_DELIVERY

ELECTRONIC_LRAR

sale_price

number · decimal

sale_conditions

string

beneficiary_name

string

beneficiary_address

string

beneficiary_relationship

string · enum

Enum values:

SELF

SPOUSE

PACS_PARTNER

COHABITANT

ASCENDANT

DESCENDANT

reprise_justification

string

legitimate_reason_detail

string

reduced_notice_justification

string

notes

string

Update a lease notice › Responses

Notice updated

id

string · uuid

lease_id

string · uuid

notice_type

string · enum

Enum values:

LANDLORD_NOTICE

TENANT_NOTICE

notice_reason

string · enum

Enum values:

SALE

PERSONAL_USE

LEGITIMATE_SERIOUS

TENANT_STANDARD

TENSE_ZONE

FIRST_EMPLOYMENT

PROFESSIONAL_TRANSFER

JOB_LOSS

initiated_by

string · uuid

notice_date

string · date

reception_date

string | null · date

effective_date

string · date

notice_period_months

integer

delivery_method

string | null · enum

Enum values:

LRAR

HUISSIER

HAND_DELIVERY

ELECTRONIC_LRAR

tracking_number

string | null

status

string · enum

Enum values:

DRAFT

SENT

RECEIVED

ACKNOWLEDGED

CONTESTED

EFFECTIVE

CANCELLED

document_url

string | null

signed_document_url

string | null

sale_price

number | null · decimal

sale_conditions

string | null

beneficiary_name

string | null

beneficiary_address

string | null

beneficiary_relationship

string | null · enum

Enum values:

SELF

SPOUSE

PACS_PARTNER

COHABITANT

ASCENDANT

DESCENDANT

reprise_justification

string | null

legitimate_reason_detail

string | null

tenant_preemption_expires_at

string | null · date

tenant_preemption_response

string | null · enum

Enum values:

ACCEPTED

DECLINED

EXPIRED

reduced_notice_justification

string | null

justification_document_url

string | null

tenant_age_at_notice

integer | null

tenant_income_eligible

boolean | null

landlord_age_exemption

boolean | null

rehousing_offer

string | null

contestation_reason

string | null

notes

string | null

created_at

string · date-time

updated_at

string · date-time

PUT/leases/{lease_id}/notices/{notice_id}

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/notices/:notice_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "notice_type": "LANDLORD_NOTICE",
  "notice_reason": "SALE",
  "initiated_by": "00000000-0000-0000-0000-000000000000",
  "notice_date": "2024-08-25",
  "delivery_method": "LRAR",
  "sale_price": 0,
  "sale_conditions": "sale_conditions",
  "beneficiary_name": "beneficiary_name",
  "beneficiary_address": "beneficiary_address",
  "beneficiary_relationship": "SELF",
  "reprise_justification": "reprise_justification",
  "legitimate_reason_detail": "legitimate_reason_detail",
  "reduced_notice_justification": "reduced_notice_justification",
  "notes": "notes"
}
'

shell

Example Request Body

{
  "notice_type": "LANDLORD_NOTICE",
  "notice_reason": "SALE",
  "initiated_by": "00000000-0000-0000-0000-000000000000",
  "notice_date": "2024-08-25",
  "delivery_method": "LRAR",
  "sale_price": 0,
  "sale_conditions": "sale_conditions",
  "beneficiary_name": "beneficiary_name",
  "beneficiary_address": "beneficiary_address",
  "beneficiary_relationship": "SELF",
  "reprise_justification": "reprise_justification",
  "legitimate_reason_detail": "legitimate_reason_detail",
  "reduced_notice_justification": "reduced_notice_justification",
  "notes": "notes"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "notice_type": "LANDLORD_NOTICE",
  "notice_reason": "SALE",
  "initiated_by": "00000000-0000-0000-0000-000000000000",
  "notice_date": "2024-08-25",
  "reception_date": "2024-08-25",
  "effective_date": "2024-08-25",
  "notice_period_months": 0,
  "delivery_method": "LRAR",
  "tracking_number": {},
  "status": "DRAFT",
  "document_url": {},
  "signed_document_url": {},
  "sale_price": {},
  "sale_conditions": {},
  "beneficiary_name": {},
  "beneficiary_address": {},
  "beneficiary_relationship": "SELF",
  "reprise_justification": {},
  "legitimate_reason_detail": {},
  "tenant_preemption_expires_at": "2024-08-25",
  "tenant_preemption_response": "ACCEPTED",
  "reduced_notice_justification": {},
  "justification_document_url": {},
  "tenant_age_at_notice": {},
  "tenant_income_eligible": {},
  "landlord_age_exemption": {},
  "rehousing_offer": {},
  "contestation_reason": {},
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete a lease notice

DELETE

https://api.faireplace.com/api

/leases/{lease_id}/notices/{notice_id}

Delete a notice (Draft status only).

Permissions required: LeasesDelete

Delete a lease notice › path Parameters

lease_id

string · uuid · required

notice_id

string · uuid · required

Delete a lease notice › Responses

Notice deleted

No data returned

DELETE/leases/{lease_id}/notices/{notice_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/leases/:lease_id/notices/:notice_id

shell

Example Responses

No example specified for this content type

Generate notice letter PDF

POST

https://api.faireplace.com/api

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

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: LeasesWrite

Generate notice letter PDF › path Parameters

lease_id

string · uuid · required

notice_id

string · uuid · required

Generate notice letter PDF › Responses

PDF generated, notice updated with document_url

id

string · uuid

lease_id

string · uuid

notice_type

string · enum

Enum values:

LANDLORD_NOTICE

TENANT_NOTICE

notice_reason

string · enum

Enum values:

SALE

PERSONAL_USE

LEGITIMATE_SERIOUS

TENANT_STANDARD

TENSE_ZONE

FIRST_EMPLOYMENT

PROFESSIONAL_TRANSFER

JOB_LOSS

initiated_by

string · uuid

notice_date

string · date

reception_date

string | null · date

effective_date

string · date

notice_period_months

integer

delivery_method

string | null · enum

Enum values:

LRAR

HUISSIER

HAND_DELIVERY

ELECTRONIC_LRAR

tracking_number

string | null

status

string · enum

Enum values:

DRAFT

SENT

RECEIVED

ACKNOWLEDGED

CONTESTED

EFFECTIVE

CANCELLED

document_url

string | null

signed_document_url

string | null

sale_price

number | null · decimal

sale_conditions

string | null

beneficiary_name

string | null

beneficiary_address

string | null

beneficiary_relationship

string | null · enum

Enum values:

SELF

SPOUSE

PACS_PARTNER

COHABITANT

ASCENDANT

DESCENDANT

reprise_justification

string | null

legitimate_reason_detail

string | null

tenant_preemption_expires_at

string | null · date

tenant_preemption_response

string | null · enum

Enum values:

ACCEPTED

DECLINED

EXPIRED

reduced_notice_justification

string | null

justification_document_url

string | null

tenant_age_at_notice

integer | null

tenant_income_eligible

boolean | null

landlord_age_exemption

boolean | null

rehousing_offer

string | null

contestation_reason

string | null

notes

string | null

created_at

string · date-time

updated_at

string · date-time

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

curl --request POST \
  --url https://api.faireplace.com/api/leases/:lease_id/notices/:notice_id/generate-letter

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "notice_type": "LANDLORD_NOTICE",
  "notice_reason": "SALE",
  "initiated_by": "00000000-0000-0000-0000-000000000000",
  "notice_date": "2024-08-25",
  "reception_date": "2024-08-25",
  "effective_date": "2024-08-25",
  "notice_period_months": 0,
  "delivery_method": "LRAR",
  "tracking_number": {},
  "status": "DRAFT",
  "document_url": {},
  "signed_document_url": {},
  "sale_price": {},
  "sale_conditions": {},
  "beneficiary_name": {},
  "beneficiary_address": {},
  "beneficiary_relationship": "SELF",
  "reprise_justification": {},
  "legitimate_reason_detail": {},
  "tenant_preemption_expires_at": "2024-08-25",
  "tenant_preemption_response": "ACCEPTED",
  "reduced_notice_justification": {},
  "justification_document_url": {},
  "tenant_age_at_notice": {},
  "tenant_income_eligible": {},
  "landlord_age_exemption": {},
  "rehousing_offer": {},
  "contestation_reason": {},
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Mark notice as sent

PUT

https://api.faireplace.com/api

/leases/{lease_id}/notices/{notice_id}/send

Transition notice from DRAFT to SENT. Requires document_url to be set (letter must be generated first). Records delivery method and optional tracking number.

Permissions required: LeasesWrite

Mark notice as sent › path Parameters

lease_id

string · uuid · required

notice_id

string · uuid · required

Mark notice as sent › Request Body

delivery_method

string · enum · required

Enum values:

LRAR

HUISSIER

HAND_DELIVERY

ELECTRONIC_LRAR

tracking_number

string | null

Mark notice as sent › Responses

Notice marked as sent

id

string · uuid

lease_id

string · uuid

notice_type

string · enum

Enum values:

LANDLORD_NOTICE

TENANT_NOTICE

notice_reason

string · enum

Enum values:

SALE

PERSONAL_USE

LEGITIMATE_SERIOUS

TENANT_STANDARD

TENSE_ZONE

FIRST_EMPLOYMENT

PROFESSIONAL_TRANSFER

JOB_LOSS

initiated_by

string · uuid

notice_date

string · date

reception_date

string | null · date

effective_date

string · date

notice_period_months

integer

delivery_method

string | null · enum

Enum values:

LRAR

HUISSIER

HAND_DELIVERY

ELECTRONIC_LRAR

tracking_number

string | null

status

string · enum

Enum values:

DRAFT

SENT

RECEIVED

ACKNOWLEDGED

CONTESTED

EFFECTIVE

CANCELLED

document_url

string | null

signed_document_url

string | null

sale_price

number | null · decimal

sale_conditions

string | null

beneficiary_name

string | null

beneficiary_address

string | null

beneficiary_relationship

string | null · enum

Enum values:

SELF

SPOUSE

PACS_PARTNER

COHABITANT

ASCENDANT

DESCENDANT

reprise_justification

string | null

legitimate_reason_detail

string | null

tenant_preemption_expires_at

string | null · date

tenant_preemption_response

string | null · enum

Enum values:

ACCEPTED

DECLINED

EXPIRED

reduced_notice_justification

string | null

justification_document_url

string | null

tenant_age_at_notice

integer | null

tenant_income_eligible

boolean | null

landlord_age_exemption

boolean | null

rehousing_offer

string | null

contestation_reason

string | null

notes

string | null

created_at

string · date-time

updated_at

string · date-time

PUT/leases/{lease_id}/notices/{notice_id}/send

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/notices/:notice_id/send \
  --header 'Content-Type: application/json' \
  --data '
{
  "delivery_method": "LRAR",
  "tracking_number": {}
}
'

shell

Example Request Body

{
  "delivery_method": "LRAR",
  "tracking_number": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "notice_type": "LANDLORD_NOTICE",
  "notice_reason": "SALE",
  "initiated_by": "00000000-0000-0000-0000-000000000000",
  "notice_date": "2024-08-25",
  "reception_date": "2024-08-25",
  "effective_date": "2024-08-25",
  "notice_period_months": 0,
  "delivery_method": "LRAR",
  "tracking_number": {},
  "status": "DRAFT",
  "document_url": {},
  "signed_document_url": {},
  "sale_price": {},
  "sale_conditions": {},
  "beneficiary_name": {},
  "beneficiary_address": {},
  "beneficiary_relationship": "SELF",
  "reprise_justification": {},
  "legitimate_reason_detail": {},
  "tenant_preemption_expires_at": "2024-08-25",
  "tenant_preemption_response": "ACCEPTED",
  "reduced_notice_justification": {},
  "justification_document_url": {},
  "tenant_age_at_notice": {},
  "tenant_income_eligible": {},
  "landlord_age_exemption": {},
  "rehousing_offer": {},
  "contestation_reason": {},
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Mark notice as received

PUT

https://api.faireplace.com/api

/leases/{lease_id}/notices/{notice_id}/receive

Transition notice from SENT to RECEIVED. Records reception_date and recalculates:

effective_date from reception_date + notice period
tenant_preemption_expires_at for sale notices (reception_date + 2 months)

Permissions required: LeasesWrite

Mark notice as received › path Parameters

lease_id

string · uuid · required

notice_id

string · uuid · required

Mark notice as received › Request Body

reception_date

string · date · required

Mark notice as received › Responses

Notice marked as received with recalculated dates

id

string · uuid

lease_id

string · uuid

notice_type

string · enum

Enum values:

LANDLORD_NOTICE

TENANT_NOTICE

notice_reason

string · enum

Enum values:

SALE

PERSONAL_USE

LEGITIMATE_SERIOUS

TENANT_STANDARD

TENSE_ZONE

FIRST_EMPLOYMENT

PROFESSIONAL_TRANSFER

JOB_LOSS

initiated_by

string · uuid

notice_date

string · date

reception_date

string | null · date

effective_date

string · date

notice_period_months

integer

delivery_method

string | null · enum

Enum values:

LRAR

HUISSIER

HAND_DELIVERY

ELECTRONIC_LRAR

tracking_number

string | null

status

string · enum

Enum values:

DRAFT

SENT

RECEIVED

ACKNOWLEDGED

CONTESTED

EFFECTIVE

CANCELLED

document_url

string | null

signed_document_url

string | null

sale_price

number | null · decimal

sale_conditions

string | null

beneficiary_name

string | null

beneficiary_address

string | null

beneficiary_relationship

string | null · enum

Enum values:

SELF

SPOUSE

PACS_PARTNER

COHABITANT

ASCENDANT

DESCENDANT

reprise_justification

string | null

legitimate_reason_detail

string | null

tenant_preemption_expires_at

string | null · date

tenant_preemption_response

string | null · enum

Enum values:

ACCEPTED

DECLINED

EXPIRED

reduced_notice_justification

string | null

justification_document_url

string | null

tenant_age_at_notice

integer | null

tenant_income_eligible

boolean | null

landlord_age_exemption

boolean | null

rehousing_offer

string | null

contestation_reason

string | null

notes

string | null

created_at

string · date-time

updated_at

string · date-time

PUT/leases/{lease_id}/notices/{notice_id}/receive

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/notices/:notice_id/receive \
  --header 'Content-Type: application/json' \
  --data '
{
  "reception_date": "2024-08-25"
}
'

shell

Example Request Body

{
  "reception_date": "2024-08-25"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "notice_type": "LANDLORD_NOTICE",
  "notice_reason": "SALE",
  "initiated_by": "00000000-0000-0000-0000-000000000000",
  "notice_date": "2024-08-25",
  "reception_date": "2024-08-25",
  "effective_date": "2024-08-25",
  "notice_period_months": 0,
  "delivery_method": "LRAR",
  "tracking_number": {},
  "status": "DRAFT",
  "document_url": {},
  "signed_document_url": {},
  "sale_price": {},
  "sale_conditions": {},
  "beneficiary_name": {},
  "beneficiary_address": {},
  "beneficiary_relationship": "SELF",
  "reprise_justification": {},
  "legitimate_reason_detail": {},
  "tenant_preemption_expires_at": "2024-08-25",
  "tenant_preemption_response": "ACCEPTED",
  "reduced_notice_justification": {},
  "justification_document_url": {},
  "tenant_age_at_notice": {},
  "tenant_income_eligible": {},
  "landlord_age_exemption": {},
  "rehousing_offer": {},
  "contestation_reason": {},
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Condition Reports Rent Reminders