Lease Transaction Terms Updated

Overview

·Event key:

lease_transaction.terms_updated

This event enables real-time tracking of lease term changes, including move-in dates, lease duration, unit assignments, pricing, and lease end dates. Use it to synchronize lease data across systems, update contract management platforms, trigger lease document regeneration, notify stakeholders of term modifications, and maintain accurate lease records with both previous and new values.

When This Event Triggers

This event fires whenever the core lease terms of a lease transaction are modified. The lease terms are the fundamental details that define the rental agreement. The event fires when any of the following fields are changed:

• Base Price (Rent) Changed — When the monthly rent amount for the unit is updated, whether by a leasing agent adjusting the price, the system applying a scheduled price update, or the applicant selecting a different pricing option.
• Lease Term Changed — When the length of the lease is modified (e.g., changing from a 12-month lease to a 6-month lease, or vice versa).
• Lease Start Date Changed — When the move-in date or lease start date is adjusted, whether by the applicant selecting a new date or a leasing agent modifying it.
• Lease End Date Changed — When the lease end date is modified, which typically happens as a result of changing the lease term or start date.
• Unit Changed — When the selected unit is changed to a different unit within the same community. This can happen when an applicant decides to apply for a different apartment or when a leasing agent reassigns them to another available unit.

The event payload includes both the old values and the new values for all of these fields, allowing receiving systems to see exactly what changed. This is particularly useful for keeping external systems (like a Property Management System) synchronized with the latest lease terms.

This event applies to all lease transaction types including Applications, Renewals, Transfers, and other transaction types where lease terms can be modified.

Event Payload

Example payloadJSON200 · application/json

{
"id": "8cc87045-5555-4a16-a882-454044e6762a",
"event": "lease_transaction.terms_updated",
"timestamp": "2024-10-09T13:49:31.658518+00:00",
"data": {
  "lease_transaction_id": 74826,
  "lease_transaction_type": "Application",
  "current_status": "Approved",
  "client_id": 12457535,
  "tenant_pms_identifier": "t1234",
  "unit_pms_identifier": "u1234",
  "community_id": 435242,
  "community_pms_identifier": "c1234",
  "lease_id": null,
  "context": {
    "new_value": {
      "unit": "268",
      "lease_end": "2026-03-02",
      "base_price": 1997.0,
      "lease_term": 14,
      "lease_start": "2025-01-03"
    },
    "old_value": {
      "unit": "268",
      "lease_end": "2026-02-02",
      "base_price": 1997.0,
      "lease_term": 13,
      "lease_start": "2025-01-03"
    }
  }
}
}