Skip to main content

Lease Move-in

Overview

·Event key:
lease.move_in

This event enables real-time tracking of lease move-in confirmations with detailed financial information. Use it to set up charges in your Property Management System (PMS), synchronize lease activation data, trigger billing workflows, update occupancy records, and maintain accurate financial and occupancy information with complete move-in details.

When This Event Triggers

This event fires when a resident officially moves into their unit and the lease becomes active. This event fires at the same time as lease.resident_move_in, but includes additional detailed financial information about the lease charges. The event fires in the following scenario:

  • Move-In Confirmed — When a leasing agent marks a resident as "Moved In" in the system, confirming that the resident has taken possession of their unit. This action changes the lease status from "Upcoming" to "Active." This event is specifically designed for integrations that need detailed charge information at move-in. Unlike the simpler lease.resident_move_in event, this event includes a comprehensive breakdown of all charges associated with the lease.

The event payload includes:

  • PMS identifiers for the community, unit, and tenant
  • The move-in date
  • A detailed list of all charges, including:
  • Monthly recurring charges (rent, parking fees, pet fees, etc.)
  • One-time fees (administrative fees, move-in fees, etc.)
  • Concessions and discounts applied to the lease
  • For each charge: the amount, charge type (Monthly or OneTime), description, start date, end date, and PMS attribute for mapping

This event is particularly useful for integrating with Property Management Systems that need to set up the resident's ledger with all applicable charges at move-in, or for billing systems that need to know exactly what the resident will be charged throughout their lease term.

Event Payload

Example payloadJSON200 · application/json
{
"id": "8cc87045-8888-4a16-a882-454044e6762a",
"event": "lease.move_in",
"timestamp": "2024-10-09T13:49:31.658518+00:00",
"data": {
  "unit_pms_identifier": "u1234",
  "community_pms_identifier": "c1234",
  "move_in_date": "2023-05-01",
  "pms_identifier": "t1234",
  "charges": [
    {
      "charge_type": "Monthly",
      "pms_identifier": "rent",
      "start_date": "2023-05-01",
      "end_date": "2024-04-30",
      "amount": 150000,
      "description": "Monthly Rent"
    }
  ]
}
}