Rentable Item Deselected

Overview

·Event key:

lease_transaction.rentable_item_deselected

This event enables real-time tracking when rentable 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 deselected.

When This Event Triggers

This event fires when a leasing agent removes or changes a previously selected rentable item on a lease transaction. Rentable 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 rentable item from the lease transaction. For example, when a leasing agent removes a parking space or pet from an application after it has been submitted.
• Item Changed — When the specific item being selected changes to a different item. For example, if an agent originally selected "Parking Space #42" but then changes to "Parking Space #15," this triggers the deselected event for the old item ("Parking Space #42") and a corresponding rentable_item_selected event for the new one.
• Bulk Item Removal — When a leasing agent deselects multiple items at once, such as when a rental option category is removed entirely from the lease transaction.

The event only triggers when the item that was removed had specific identifying information (such as a PMS code or item details). Generic selections without specific item details do not trigger this event.

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

• The item's identifier and name from the PMS
• The rental option category (parking, storage, pets, etc.)
• The associated lease transaction information

This event is particularly useful for integrating with Property Management Systems that need to know when specific rentable items (like numbered parking spaces or storage units) are released and become available for other residents.

Event Payload

Example payloadJSON200 · application/json

{
"id": "8cc87045-1111-4a16-a882-454044e6762a",
"event": "lease_transaction.rentable_item_deselected",
"timestamp": "2024-10-09T13:49:31.658518+00:00",
"data": {
  "id": 1,
  "category": "Parking Fee",
  "subcategory": "Carport",
  "item_id": "item1",
  "item_name": "#12",
  "item_type_id": "type1",
  "item_type_name": "Parking",
  "context": {
    "item": "123"
  },
  "start_date": "2026-01-15",
  "end_date": null,
  "lease_transaction_id": 1,
  "lease_transaction_type": "Application",
  "client_id": 1,
  "guestcard_pms_identifier": "g123",
  "tenant_pms_identifier": "t123",
  "community_id": 1,
  "community_pms_identifier": "c123"
  "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
    }
  ]
}
}