Lease Transaction Fees Updated

Overview

·Event key:

lease_transaction.fees_updated

This event enables real-time tracking of fee changes, payments, waivers, and refunds for lease transactions. Use it to synchronize payment systems, update accounting records, trigger receipt generation, notify stakeholders of fee status changes, and maintain accurate financial records. The event includes all applicable fees, even if only one has been updated.

When This Event Triggers

This event fires whenever there is a change to the fees associated with a lease transaction. Fees include application fees, holding deposits, administrative fees, pet fees, parking fees, and other charges that applicants or residents must pay. The event fires in the following scenarios:

Fee Created — When a new fee is added to the lease transaction, such as when an applicant selects a rental option that has an associated fee (e.g., adding a pet or reserving a parking spot).
Fee Updated — When an existing fee is modified, such as when the amount changes or when the fee's payment status is updated.
Fee Deleted — When a fee is removed from the lease transaction, such as when an applicant removes a rental option or when a leasing agent removes a charge.
Fee Waived — When a leasing agent waives a fee for an applicant, marking it as no longer required for payment.
Fee Unwaived — When a previously waived fee is reinstated and the applicant is once again required to pay it.
Payment Status Changed — When the payment status of a fee changes due to Stripe payment events, such as: a charge being created; a charge being captured (payment successfully processed); a charge failing; a charge being refunded; a payment dispute being created or resolved.

The event payload includes details about all current fees on the lease transaction, including their type, amount, payment status, and who is responsible for paying them. This allows receiving systems to maintain an accurate picture of the financial obligations associated with the lease transaction.

This event applies to all lease transaction types including Applications, Renewals, Transfers, and other transaction types where fees may be charged.

Event Payload

Example payloadJSON200 · application/json

{
"id": "8cc87045-4444-4a16-a882-454044e6762a",
"event": "lease_transaction.fees_updated",
"timestamp": "2024-10-09T13:49:31.658518+00:00",
"data": {
  "lease_transaction_id": 74825,
  "lease_transaction_type": "Application",
  "client_id": 12457534,
  "tenant_pms_identifier": "t1234",
  "unit_pms_identifier": "u1234",
  "community_id": 435242,
  "community_pms_identifier": "c1234",
  "lease_id": 12345,
  "fees": [
    {
      "id": 1,
      "name": "Application Fee",
      "fee_type": "Application Fee",
      "amount": 15.50,
      "paid": false,
      "waived": false,
      "status": "charge.created",
      "charge_success": false,
      "is_handled_offline": false,
      "payer": null,
      "charged_to": "John Doe"
    },
    {
      "id": 2,
      "name": "Unit Holding Deposit",
      "fee_type": "Holding Deposit",
      "amount": 200.00,
      "paid": false,
      "waived": false,
      "status": "charge.created",
      "charge_success": false,
      "is_handled_offline": false,
      "payer": null,
      "charged_to": "John Doe"
    }
  ]
}
}