Condition Reports

Record key handover snapshots

Record key delivery/return as dated snapshots. Does not update the current key status: uses the snapshot pattern to capture the handover at the time of the condition report.

References existing EstateKey entities via estate_key_id. Missing keys at exit (key_diffs.missing > 0) constitute a justified deposit deduction.

Only allowed when the report is in DRAFT status.

Permissions required: leases:write

post/leases/{lease_id}/condition-reports/{report_id}/key-handover

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/condition-reports/{report_id}/key-handover
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required
report_idstring uuid required

Request body

Example request

{
  "keys": [
    {
      "estate_key_id": "550e8400-e29b-41d4-a716-446655440001",
      "quantity_delivered": 3,
      "condition_notes": "Porte d'entrée: 3 clés remises"
    }
  ]
}

Response

Key snapshots recorded

idstring uuid
estate_key_idstring uuid
quantity_deliveredinteger
condition_notesstring nullable
created_atstring date-time

Changes

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