Lease Transaction Concessions Updated

Overview

·Event key:

lease_transaction.concessions_updated

This event enables real-time tracking of concessions (discounts) associated with a lease transaction. Use it to synchronize financial records, update accounting systems, and keep an accurate picture of the concessions being offered on a lease transaction. The event includes all current concessions, even if only one has changed.

When This Event Triggers

This event fires whenever there is a change to the concessions associated with a lease transaction's current quote. The event fires in the following scenarios:

• Concession Added — When a new concession is added to the lease transaction's quote, whether added manually by a leasing agent or applied automatically (e.g. a unit's default concessions, or a discount rental option).
• Concession Updated — When an existing concession is modified, such as a change to its amount, percentage, duration, or starting month.
• Concession Removed — When a concession is removed from the lease transaction's quote. The removed concession will no longer appear in the concessions list sent with this event.

The event payload includes details about all current concessions on the lease transaction's quote, including their type, amount, and duration. This allows receiving systems to maintain an accurate picture of the concessions associated with the lease transaction without having to diff against a previous payload.

This event is independent of, and fires in addition to, lease_transaction.updated, which also reports a generic "Concessions changed" update when concessions change.

Event Payload

Example payloadJSON200 · application/json

{
  "id": "2c3d4e5f-6789-4a1b-9c0d-1e2f3a4b5c6d",
  "event": "lease_transaction.concessions_updated",
  "timestamp": "2024-10-09T13:49:31.658518+00:00",
  "data": {
    "lease_transaction_id": 74825,
    "lease_transaction_type": "Application",
    "client_id": 12457534,
    "tenant_pms_identifier": "t1234",
    "unit_pms_identifier": "u1234",
    "community_id": 435242,
    "community_pms_identifier": "c1234",
    "lease_id": 12345,
    "concessions": [
      {
        "id": 501,
        "description": "Move-in Special",
        "type": "Rent Concession",
        "amount": 500.0,
        "amount_type": "fixed",
        "is_monthly": true,
        "is_required": false,
        "duration": 2,
        "starting_month": 1,
        "starting_date": "2024-11-01",
        "ending_date": "2024-12-31"
      },
      {
        "id": 502,
        "description": "Application Fee Waiver",
        "type": "Application Fee Reduction or Waiver",
        "amount": 75.0,
        "amount_type": "fixed",
        "is_monthly": false,
        "is_required": false,
        "duration": null,
        "starting_month": null,
        "starting_date": "2024-11-01",
        "ending_date": "2024-11-30"
      }
    ]
  }
}