Skip to main content

Lease Transaction Unit Reserved

Overview

·Event key:
lease_transaction.unit_reserved

This event enables real-time tracking of unit availability and reservation state during the lease transaction lifecycle. Use it to keep your systems synchronized when units are reserved, update inventory displays, trigger automated workflows, and notify stakeholders about reservation changes.

When This Event Triggers

This event fires in the following scenarios when a unit becomes reserved for a specific lease transaction:

  • Holding Deposit Payment — Triggered when an applicant successfully pays their holding deposit (or the deposit is waived). The unit is automatically reserved for their application. This is the most common trigger and ensures the unit is held while the application is being processed.
  • Agent-Managed Application Submission — Triggered when a leasing agent submits an application on behalf of an applicant (admin-managed applications). The unit is reserved at the time of submission, even if no holding deposit payment is required.
  • Application Reactivation — Triggered when a previously denied or canceled application is reactivated (un-denied or un-canceled). The unit that was originally selected is reserved again for the applicant.
  • Unit Change During Application — Triggered when an applicant or agent changes the selected unit during an active application. The new unit is reserved (after the previous unit is released).
  • Transfer Creation — Triggered when a transfer request is created for an existing resident to move to a new unit. The destination unit is reserved for the transfer.
  • Transfer Approval — Triggered when a transfer request is approved. The new unit is reserved to ensure it remains available for the transferring resident.

Note: In all cases, the unit's status changes from "Available" to "Pending," which removes it from the list of available units shown to other prospective residents. The reservation ensures that while an application is being processed, screened, and approved, the unit remains held for that specific applicant.

Event Payload

Example payloadJSON200 · application/json
{
"id": "8cc87045-1111-4a16-a882-454044e6762a",
"event": "lease_transaction.unit_reserved",
"timestamp": "2024-10-09T13:49:31.658518+00:00",
"data": {
  "lease_transaction_id": 74824,
  "lease_transaction_type": "Application",
  "client_id": 12457533,
  "guestcard_pms_identifier": "p1234",
  "tenant_pms_identifier": "t1234",
  "unit_id": 4352,
  "unit_pms_identifier": "u1234",
  "unit_number": "101",
  "community_id": 435242,
  "community_pms_identifier": "c1234",
  "building_number": "123",
  "internal_building_number": "456"
}
}