Rental Option Item Updated

Overview

·Event key:

lease_transaction.rental_option_item_updated

This event enables real-time tracking when rental option items are updated on lease transactions. Use it to synchronize add-on changes with your PMS, update lease pricing calculations, track amenity modifications, and maintain accurate lease add-on records when items are modified.

When This Event Triggers

This event fires when a leasing agent updates an existing rental option item on a lease transaction. Rental option items are additional amenities or services that can be added to a lease, such as parking spaces, storage units, pet registrations, or other optional add-ons that are tracked individually in the Property Management System (PMS). Important: This event is only published if the change happens after the transaction is submitted. Once an applicant submits the transaction, only leasing agents can make changes. The event fires in the following scenarios:

• Item Details Changed — When a leasing agent modifies details of an existing rental option item on a submitted lease transaction. For example, when the start date, end date, or item name is changed.
• Charges Updated — When a leasing agent modifies charges associated with a rental option item, such as when amounts change or new charges are added to an existing item.
• Item Information Modified — When a leasing agent updates any property of the rental option item, including category, subcategory, context, or other metadata.

The event payload includes the complete updated state of the rental option item, including:

• The item's identifier and name from the PMS
• The rental option category and subcategory
• Updated start and end dates
• The associated lease transaction information
• All charges associated with the item, including any updates

This event is particularly useful for integrating with Property Management Systems that need to track changes to rental option items on lease transactions after they have been submitted.

Event Payload

Example payloadJSON200 · application/json

{
"id": "9gg87045-1111-4a16-a882-454044e6762a",
"event": "lease_transaction.rental_option_item_updated",
"timestamp": "2024-10-09T13:49:31.658518+00:00",
"data": {
  "id": 50877188,
  "category": "Parking Fee",
  "subcategory": "Carport",
  "item_id": null,
  "item_name": "123",
  "item_type_id": null,
  "item_type_name": "",
  "context": {
    "item": "123"
  },
  "start_date": "2026-01-15",
  "end_date": null,
  "lease_transaction_id": 1188651,
  "lease_transaction_type": "Application",
  "client_id": 25895738,
  "guestcard_pms_identifier": null,
  "tenant_pms_identifier": null,
  "community_id": 831,
  "community_pms_identifier": "1",
  "charges": [
    {
      "id": 52074688,
      "name": "Covered Parking Rent",
      "amount": 30.0,
      "refundable": false,
      "due_at": "Monthly",
      "charge_code": "cpre",
      "start_date": "2026-01-15",
      "end_date": null
    },
    {
      "id": 52074689,
      "name": "Covered Parking Setup Fee",
      "amount": 13.0,
      "refundable": false,
      "due_at": "At application",
      "charge_code": "cpse",
      "start_date": "2026-01-15",
      "end_date": null
    }
  ]
}
}