Rental Option Item Removed

Overview

·Event key:

lease_transaction.rental_option_item_removed

This event enables real-time tracking when rental option items are removed from lease transactions. Use it to synchronize add-on removals with your PMS, update lease pricing calculations, trigger inventory releases, track amenity changes, and maintain accurate lease add-on records when items are removed.

When This Event Triggers

This event fires when a leasing agent removes a rental option item from 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 Removed — When a leasing agent removes a rental option item from a submitted lease transaction. For example, when a leasing agent removes a parking space or pet from an application after it has been submitted.
• Post-Submission Removal — When a leasing agent removes a rental option item from a lease transaction that has already been submitted. Since applicants cannot make changes after submission, only leasing agent actions trigger this event.
• Bulk Item Removal — When a leasing agent removes multiple items at once, such as when a rental option category is removed entirely from the lease transaction after submission.

The event payload includes details about the removed item such as:

• The item's identifier and name from the PMS
• The rental option category and subcategory
• The associated lease transaction information
• Charges that were associated with the removed item

This event is particularly useful for integrating with Property Management Systems that need to know when specific rental option items are removed from lease transactions after they have been submitted, allowing the PMS to release inventory and update pricing accordingly.

Event Payload

Example payloadJSON200 · application/json

{
"id": "8cc87045-1111-4a16-a882-454044e6762a",
"event": "lease_transaction.rental_option_item_removed",
"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
    }
  ]
}
}