Skip to main content

Lease Transaction Status Updated

Overview

·Event key:
lease_transaction.status_updated

This event enables real-time tracking of lease transaction status changes throughout the application and lease lifecycle. Use it to synchronize your systems with transaction states, trigger status-based workflows, update CRM records, send notifications to stakeholders, and maintain accurate status displays across your platform.

When This Event Triggers

This event fires whenever the status of a lease transaction changes from one state to another. A lease transaction can be any of the following types: Application (new lease), Renewal, Transfer, Notice to Vacate, Mid-Lease Change, Lease Confirmation, Holdover, or Lease Document Generation. The event fires for any of the following status transitions across all transaction types:

  • Transaction Submitted — When an applicant or resident completes and submits their transaction (whether it's a new application, renewal offer acceptance, transfer request, or notice to vacate), the status changes from "In Progress" to "Submitted." This indicates the transaction is ready for review.
  • Transaction Approved — When a leasing agent approves the transaction (or it is auto-approved based on screening results or configured rules), the status changes to "Approved" or "Conditionally Approved." This means the transaction has passed the review process.
  • Transaction Denied — When a leasing agent denies the transaction based on screening results or other factors, the status changes to "Denied."
  • Transaction Canceled — When a transaction is canceled (by the resident, agent, or system), the status changes to "Canceled." This can happen for various reasons such as the resident withdrawing their request or the transaction expiring.
  • Pending Criminal Review — When screening results require additional manual review of criminal background information, the status changes to "Pending Criminal Review."
  • Transaction Completed — When all steps are finished (documents signed, countersigned, and finalized), the status changes to "Completed." This marks the successful conclusion of the lease transaction.
  • Status Reversal — When a decision is undone (e.g., un-denying, un-canceling, or voiding a completed transaction), the status reverts to a previous state, which also triggers this event.

The event includes both the previous status and the new status, allowing receiving systems to understand exactly what transition occurred and take appropriate action.

Event Payload

Example payloadJSON200 · application/json
{
"id": "8cc87045-0e02-4a16-a882-454044e6762a",
"event": "lease_transaction.status_updated",
"timestamp": "2024-10-09T13:49:31.658518+00:00",
"data": {
  "lease_id": null,
  "client_id": 16167303,
  "community_id": 831,
  "current_status": "Conditionally Approved",
  "previous_status": "Submitted",
  "unit_pms_identifier": "u1234",
  "lease_transaction_id": 413513,
  "tenant_pms_identifier": "t1234",
  "lease_transaction_type": "Application",
  "community_pms_identifier": "c1234"
}
}