FairePlace Property Management API

Rent Payments

Endpointhttps://api.faireplace.com/api

List rent payments

GET

https://api.faireplace.com/api

/leases/{lease_id}/rent-payments

List all rent payments for a lease, with optional filters by status and period.

Permissions required: LeasesRead

List rent payments › path Parameters

lease_id

string · uuid · required

List rent payments › query Parameters

status

string · enum

Enum values:

PENDING

PAID

PARTIALLY_PAID

LATE

UNPAID

IN_DISPUTE

period_start

string · date

Filter payments with period_start >= this date

period_end

string · date

Filter payments with period_end <= this date

List rent payments › Responses

List of rent payments

object[]

id

string · uuid

lease_id

string · uuid

period_start

string · date

period_end

string · date

expected_amount

number · decimal

paid_amount

number · decimal

payment_date

string | null · date

payment_method

string | null

reference

string | null

status

string · enum

Enum values:

PENDING

PAID

PARTIALLY_PAID

LATE

UNPAID

IN_DISPUTE

receipt_id

string | null · uuid

notes

string | null

created_at

string · date-time

updated_at

string · date-time

GET/leases/{lease_id}/rent-payments

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

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "lease_id": "00000000-0000-0000-0000-000000000000",
    "period_start": "2024-08-25",
    "period_end": "2024-08-25",
    "expected_amount": 0,
    "paid_amount": 0,
    "payment_date": "2024-08-25",
    "payment_method": {},
    "reference": {},
    "status": "PENDING",
    "receipt_id": "00000000-0000-0000-0000-000000000000",
    "notes": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Record a rent payment

POST

https://api.faireplace.com/api

/leases/{lease_id}/rent-payments

Record a rent payment for a lease period.

The payment status is auto-computed based on amounts and dates:

PAID if paid_amount >= expected_amount
PARTIALLY_PAID if paid_amount > 0 but less than expected
LATE if no payment and period_end has passed
PENDING if no payment but period not yet ended

Permissions required: LeasesWrite

Record a rent payment › path Parameters

lease_id

string · uuid · required

Lease ID

Record a rent payment › Request Body

period_start

string · date · required

Start of the rent period

Example: 2025-01-01

period_end

string · date · required

End of the rent period

Example: 2025-01-31

expected_amount

number · decimal · required

Expected rent amount (rent + charges)

Example: 900

paid_amount

number · decimal · required

Amount actually paid

Example: 900

payment_date

string | null · date

Date of payment

Example: 2025-01-05

payment_method

string | null · enum

Payment method

Enum values:

VIREMENT_BANCAIRE

PRELEVEMENT_AUTOMATIQUE

CHEQUE

ESPECES

CARTE_BANCAIRE

MANDAT_CASH

AUTRE

reference

string | null

Payment reference (transfer number, check number)

notes

string | null

Optional notes

Record a rent payment › Responses

Payment recorded successfully

id

string · uuid

lease_id

string · uuid

period_start

string · date

period_end

string · date

expected_amount

number · decimal

paid_amount

number · decimal

payment_date

string | null · date

payment_method

string | null

reference

string | null

status

string · enum

Enum values:

PENDING

PAID

PARTIALLY_PAID

LATE

UNPAID

IN_DISPUTE

receipt_id

string | null · uuid

notes

string | null

created_at

string · date-time

updated_at

string · date-time

POST/leases/{lease_id}/rent-payments

curl --request POST \
  --url https://api.faireplace.com/api/leases/:lease_id/rent-payments \
  --header 'Content-Type: application/json' \
  --data '
{
  "period_start": "2025-01-01",
  "period_end": "2025-01-31",
  "expected_amount": 900,
  "paid_amount": 900,
  "payment_date": "2025-01-05",
  "payment_method": "VIREMENT_BANCAIRE",
  "reference": {},
  "notes": {}
}
'

shell

Example Request Body

{
  "period_start": "2025-01-01",
  "period_end": "2025-01-31",
  "expected_amount": 900,
  "paid_amount": 900,
  "payment_date": "2025-01-05",
  "payment_method": "VIREMENT_BANCAIRE",
  "reference": {},
  "notes": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "period_start": "2024-08-25",
  "period_end": "2024-08-25",
  "expected_amount": 0,
  "paid_amount": 0,
  "payment_date": "2024-08-25",
  "payment_method": {},
  "reference": {},
  "status": "PENDING",
  "receipt_id": "00000000-0000-0000-0000-000000000000",
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get tenant balance

GET

https://api.faireplace.com/api

/leases/{lease_id}/rent-payments/balance

Returns the aggregated balance for a lease: total expected, total paid, arrears, overpayment, and count of unpaid periods.

Permissions required: LeasesRead

Get tenant balance › path Parameters

lease_id

string · uuid · required

Get tenant balance › Responses

Lease balance

lease_id

string · uuid

total_expected

number · decimal

Total expected rent across all periods

total_paid

number · decimal

Total amount paid

arrears

number · decimal

Amount owed (total_expected - total_paid, min 0)

overpayment

number · decimal

Overpayment amount (total_paid - total_expected, min 0)

unpaid_periods

integer

Count of periods with LATE or UNPAID status

GET/leases/{lease_id}/rent-payments/balance

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/rent-payments/balance

shell

Example Responses

{
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "total_expected": 0,
  "total_paid": 0,
  "arrears": 0,
  "overpayment": 0,
  "unpaid_periods": 0
}

json

application/json

Generate payment schedule

POST

https://api.faireplace.com/api

/leases/{lease_id}/rent-payments/generate-schedule

Generates expected payment entries for a date range based on the lease parameters (rent amount, frequency). Skips periods where a payment already exists.

Permissions required: LeasesWrite

Generate payment schedule › path Parameters

lease_id

string · uuid · required

Generate payment schedule › Request Body

range_start

string · date · required

range_end

string · date · required

Generate payment schedule › Responses

Payment schedule entries created

object[]

id

string · uuid

lease_id

string · uuid

period_start

string · date

period_end

string · date

expected_amount

number · decimal

paid_amount

number · decimal

payment_date

string | null · date

payment_method

string | null

reference

string | null

status

string · enum

Enum values:

PENDING

PAID

PARTIALLY_PAID

LATE

UNPAID

IN_DISPUTE

receipt_id

string | null · uuid

notes

string | null

created_at

string · date-time

updated_at

string · date-time

POST/leases/{lease_id}/rent-payments/generate-schedule

curl --request POST \
  --url https://api.faireplace.com/api/leases/:lease_id/rent-payments/generate-schedule \
  --header 'Content-Type: application/json' \
  --data '
{
  "range_start": "2025-01-01",
  "range_end": "2025-12-31"
}
'

shell

Example Request Body

{
  "range_start": "2025-01-01",
  "range_end": "2025-12-31"
}

json

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "lease_id": "00000000-0000-0000-0000-000000000000",
    "period_start": "2024-08-25",
    "period_end": "2024-08-25",
    "expected_amount": 0,
    "paid_amount": 0,
    "payment_date": "2024-08-25",
    "payment_method": {},
    "reference": {},
    "status": "PENDING",
    "receipt_id": "00000000-0000-0000-0000-000000000000",
    "notes": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Get a rent payment

GET

https://api.faireplace.com/api

/leases/{lease_id}/rent-payments/{payment_id}

Retrieve a specific rent payment by ID.

Permissions required: LeasesRead

Get a rent payment › path Parameters

lease_id

string · uuid · required

payment_id

string · uuid · required

Get a rent payment › Responses

Payment details

id

string · uuid

lease_id

string · uuid

period_start

string · date

period_end

string · date

expected_amount

number · decimal

paid_amount

number · decimal

payment_date

string | null · date

payment_method

string | null

reference

string | null

status

string · enum

Enum values:

PENDING

PAID

PARTIALLY_PAID

LATE

UNPAID

IN_DISPUTE

receipt_id

string | null · uuid

notes

string | null

created_at

string · date-time

updated_at

string · date-time

GET/leases/{lease_id}/rent-payments/{payment_id}

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/rent-payments/:payment_id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "period_start": "2024-08-25",
  "period_end": "2024-08-25",
  "expected_amount": 0,
  "paid_amount": 0,
  "payment_date": "2024-08-25",
  "payment_method": {},
  "reference": {},
  "status": "PENDING",
  "receipt_id": "00000000-0000-0000-0000-000000000000",
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update a rent payment

PUT

https://api.faireplace.com/api

/leases/{lease_id}/rent-payments/{payment_id}

Update a rent payment. Status is auto-recalculated unless manually overridden.

Permissions required: LeasesWrite

Update a rent payment › path Parameters

lease_id

string · uuid · required

payment_id

string · uuid · required

Update a rent payment › Request Body

paid_amount

number · decimal

payment_date

string · date

payment_method

string · enum

Enum values:

VIREMENT_BANCAIRE

PRELEVEMENT_AUTOMATIQUE

CHEQUE

ESPECES

CARTE_BANCAIRE

MANDAT_CASH

AUTRE

reference

string

status

string · enum

Manually override status (otherwise auto-computed)

Enum values:

PENDING

PAID

PARTIALLY_PAID

LATE

UNPAID

IN_DISPUTE

receipt_id

string · uuid

notes

string

Update a rent payment › Responses

Payment updated

id

string · uuid

lease_id

string · uuid

period_start

string · date

period_end

string · date

expected_amount

number · decimal

paid_amount

number · decimal

payment_date

string | null · date

payment_method

string | null

reference

string | null

status

string · enum

Enum values:

PENDING

PAID

PARTIALLY_PAID

LATE

UNPAID

IN_DISPUTE

receipt_id

string | null · uuid

notes

string | null

created_at

string · date-time

updated_at

string · date-time

PUT/leases/{lease_id}/rent-payments/{payment_id}

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/rent-payments/:payment_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "paid_amount": 0,
  "payment_date": "2024-08-25",
  "payment_method": "VIREMENT_BANCAIRE",
  "reference": "reference",
  "status": "PENDING",
  "receipt_id": "00000000-0000-0000-0000-000000000000",
  "notes": "notes"
}
'

shell

Example Request Body

{
  "paid_amount": 0,
  "payment_date": "2024-08-25",
  "payment_method": "VIREMENT_BANCAIRE",
  "reference": "reference",
  "status": "PENDING",
  "receipt_id": "00000000-0000-0000-0000-000000000000",
  "notes": "notes"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "period_start": "2024-08-25",
  "period_end": "2024-08-25",
  "expected_amount": 0,
  "paid_amount": 0,
  "payment_date": "2024-08-25",
  "payment_method": {},
  "reference": {},
  "status": "PENDING",
  "receipt_id": "00000000-0000-0000-0000-000000000000",
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete a rent payment

DELETE

https://api.faireplace.com/api

/leases/{lease_id}/rent-payments/{payment_id}

Delete a rent payment.

Permissions required: LeasesDelete

Delete a rent payment › path Parameters

lease_id

string · uuid · required

payment_id

string · uuid · required

Delete a rent payment › Responses

Payment deleted

No data returned

DELETE/leases/{lease_id}/rent-payments/{payment_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/leases/:lease_id/rent-payments/:payment_id

shell

Example Responses

No example specified for this content type

PDF Condition Reports