Leases

Create a review detail

Create a new detail line for a charge review

post/leases/{lease_id}/charges/reviews/{review_id}/details

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/charges/reviews/{review_id}/details
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Lease ID

review_idstring uuid required

Review ID

Request body

annual_charge_review_idstring uuid required
lease_charge_idstring uuid required
provisional_amountnumber required
actual_amountnumber required
difference_amountnumber required
calculation_detailsobject nullable
supporting_documentsobject nullable

Response

Review detail created successfully

idstring uuid required
annual_charge_review_idstring uuid required

Parent review ID

lease_charge_idstring uuid required

The charge being reviewed

provisional_amountnumber required

Amount provisioned during the period

actual_amountnumber required

Actual expense amount

difference_amountnumber required

Difference (actual - provisional). Positive = underpayment, negative = overpayment

calculation_detailsobject nullable

Details of the calculation (JSON)

supporting_documentsobject nullable

References to supporting documents (JSON)

status'DRAFT' | 'CALCULATED' | 'VALIDATED' | 'DISPUTED' | 'ADJUSTED' | 'CLOSED' required

Status of a review detail line.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "status": "DRAFT"
}

Changes

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