Leases

Create a charge regulation

Create a new regulation for a charge.

Validation rules:

  • If type is FREEZE, then freeze_period_id is required
  • If type is LEGAL_EXCEPTION, then legal_exception_id is required
  • adjusted_amount must be less than or equal to original_amount
post/leases/{lease_id}/charges/{charge_id}/regulations

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/charges/{charge_id}/regulations
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Lease ID

charge_idstring uuid required

Charge ID

Request body

lease_charge_idstring uuid required
regulation_type'FREEZE' | 'LEGAL_EXCEPTION' required

Type of charge regulation adjustment.

  • FREEZE: Adjustment due to an active freeze period
  • LEGAL_EXCEPTION: Adjustment due to a legal exception
freeze_period_idstring uuid nullable
legal_exception_idstring uuid nullable
application_datestring date required
original_amountnumber required
adjusted_amountnumber required
adjustment_detailsobject nullable

Example request

{
  "regulation_type": "FREEZE"
}

Response

Regulation created successfully

idstring uuid required
lease_charge_idstring uuid required

The charge being regulated

regulation_type'FREEZE' | 'LEGAL_EXCEPTION' required

Type of charge regulation adjustment.

  • FREEZE: Adjustment due to an active freeze period
  • LEGAL_EXCEPTION: Adjustment due to a legal exception
freeze_period_idstring uuid nullable

Reference to the freeze period (required if type is FREEZE)

legal_exception_idstring uuid nullable

Reference to the legal exception (required if type is LEGAL_EXCEPTION)

application_datestring date required

Date the regulation takes effect

original_amountnumber required

Original charge amount before regulation

adjusted_amountnumber required

Adjusted amount after regulation (must be <= original_amount)

adjustment_detailsobject nullable

Details about the adjustment calculation (JSON)

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "regulation_type": "FREEZE"
}

Changes

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