Rental Option Item Created

Overview

·Event key:

lease_transaction.rental_option_item_created

This event enables real-time tracking when rental option items are created on lease transactions. Use it to synchronize add-on creation 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 creates a 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:

• New Item Creation — When a new rental option item is created on a submitted lease transaction. For example, when a leasing agent adds a parking space or storage unit to an existing application after it has been submitted.
• Post-Submission Addition — When a leasing agent adds a rental option item to a lease transaction that has already been submitted. Since applicants cannot make changes after submission, only leasing agent actions trigger this event.

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

• The item's identifier and name from the PMS
• The rental option category and subcategory (parking, storage, pets, etc.)
• The associated lease transaction information
• Start and end dates for the rental option
• Pricing details and charges associated with the item

This event is particularly useful for integrating with Property Management Systems that need to track which specific rental option items are added to 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_created",
"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
    }
  ]
}
}