Rentable Item Selected

Overview

·Event key:

lease_transaction.rentable_item_selected

This event enables real-time tracking when rentable items (parking spots, storage units, pet registrations, etc.) are added to lease transactions. Use it to synchronize add-on selections with your PMS, update lease pricing calculations, trigger inventory updates, track amenity usage, and maintain accurate lease add-on records.

When This Event Triggers

This event fires when a leasing agent selects a specific rentable item as part of 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:

• New Item Selection — When an agent adds a new rentable item to the lease transaction. For example, when an agent selects a specific parking spot (like "Parking Space #42") or registers a pet with specific details.
• Item Details Changed — When the specific item being selected changes. For example, if an agent originally selected "Parking Space #42" but then changes to "Parking Space #15," this triggers the event for the new selection (and a corresponding rentable_item_deselected event for the old one).

The event only triggers when the item has 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 selected 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
• Pricing details for the item

This event is particularly useful for integrating with Property Management Systems that need to track which specific rentable items (like numbered parking spaces or storage units) are assigned to which lease.

Event Payload

Example payloadJSON200 · application/json

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