Triggered when any update is made on a lease transaction (e.g lease transaction reached a new milestone, moved to another step, people where added, terms were updated etc)
The “Lease Transaction Reserved Unit” event is triggered when a lease transaction, such as an application, successfully reserves a unit. This event is essential for tracking and managing the reservation process, providing necessary data for integrations to act in real-time.
Internal Funnel Leasing unique ID that points to the lease transaction
Integer
lease_transaction_type
Type of lease transaction (e.g., “Application”, “Lease Revision”, “Renewal”, “Notice to Vacate”, “Lease Confirmation”, “Transfer”)
String
client_id
Internal Funnel Leasing ID that points to the guest card of the client
Integer
guestcard_pms_identifier
External customer identifier for the guest card, if applicable. If missing, it means the guest card has not yet been pushed to the PMS.
String
Nullable
tenant_pms_identifier
External customer identifier for the tenant, if applicable
String
Nullable
unit_id
Internal Funnel Leasing ID that points to the unit
Integer
unit_pms_identifier
External customer identifier for the unit, if applicable
String
Nullable
community_id
Internal Funnel Leasing ID that points to the community
Integer
community_pms_identifier
External customer identifier for the community, if applicable
String
Nullable
{
"id": "8cc87045-1111-4a16-a882-454044e6762a",
"event": "lease_transaction.unit_reserved",
"timestamp": "2024-10-09T13:49:31.658518+00:00",
"data": {
"lease_transaction_id": 74824,
"lease_transaction_type": "Application",
"client_id": 12457533,
"guestcard_pms_identifier": "p1234",
"tenant_pms_identifier": "t1234",
"unit_id": 4352,
"unit_pms_identifier": "u1234",
"community_id": 435242,
"community_pms_identifier": "c1234"
}
}
lease_transaction.unit_released
The “Lease Transaction Released Unit” event is triggered when a leasing professional releases a previously reserved unit by a lease transaction, such as an application. This event is crucial for managing unit availability and updating integrations with the latest status.
Internal Funnel Leasing unique ID that points to the lease transaction
Integer
lease_transaction_type
Type of lease transaction (e.g., “Application”, “Lease Revision”, “Renewal”, “Notice to Vacate”, “Lease Confirmation”, “Transfer”)
String
client_id
Internal Funnel Leasing ID that points to the guest card of the client
Integer
guestcard_pms_identifier
External customer identifier for the guest card, if applicable. If missing, it means the guest card has not yet been pushed to the PMS.
String
Nullable
tenant_pms_identifier
External customer identifier for the tenant, if applicable
String
Nullable
unit_id
Internal Funnel Leasing ID that points to the unit
Integer
unit_pms_identifier
External customer identifier for the unit, if applicable
String
Nullable
community_id
Internal Funnel Leasing ID that points to the community
Integer
community_pms_identifier
External customer identifier for the community, if applicable
String
Nullable
{
"id": "8cc87045-2222-4a16-a882-454044e6762a",
"event": "lease_transaction.unit_released",
"timestamp": "2024-10-09T13:49:31.658518+00:00",
"data": {
"lease_transaction_id": 74825,
"lease_transaction_type": "Application",
"client_id": 12457534,
"guestcard_pms_identifier": "p1234",
"tenant_pms_identifier": "t1234",
"unit_id": 4352,
"unit_pms_identifier": "u1234",
"community_id": 435242,
"community_pms_identifier": "c1234"
}
}
lease_transaction.updated
The “Lease Transaction Updated” event is triggered when a leasing professional or the Funnel Leasing system makes any changes to a lease transaction. This event does not specify the details of the updates made.
Internal Funnel Leasing unique ID that points to the lease transaction
Integer
lease_transaction_type
Type of lease transaction (e.g., “Application”, “Lease Revision”, “Renewal”, “Notice to Vacate”, “Lease Confirmation”, “Transfer”)
String
client_id
Internal Funnel Leasing ID that points to the guest card of the client
Integer
tenant_pms_identifier
External customer identifier for the tenant, if applicable
String
Nullable
unit_pms_identifier
External customer identifier for the unit, if applicable
String
Nullable
community_id
Internal Funnel Leasing ID that points to the community
Integer
community_pms_identifier
External customer identifier for the community, if applicable
String
Nullable
lease_id
Internal Funnel Leasing ID that points to the lease, if applicable.
Integer
Nullable
update_type
The type of update that happened that triggered this event. The possible values are: “Dependent added”, “CoApplicant invited”, “Guarantor invited”, “Occupant invited”, “Applicant Signed Lease”, “User countersigned lease”, “Lease Revision Document Countersigned”, “Offline Lease Document Generated”, “User countersigned notice to vacate”, “Notice to Vacate Completed”, “Application lease sent”, “Application request a guarantor”, “Applicant removed from application”, “Application re-screened”, “Applicant role changed”, “Primary applicant changed”, “Concessions changed”, “Rental options changed”, “Rental options price changed”, “User Overrode move out date for applicant”, “User overrode unit availability”.
String
context
Contains the more details about the specific section that have been updated.
Object
{
"id": "8cc87045-3333-4a16-a882-454044e6762a",
"event": "lease_transaction.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": null,
"update_type": "Agent updated applicant personal details",
"context": {
"email": "josh.doe@funnelleasing.com",
"suffix": "jr",
"has_ssn": true,
"last_name": "Doe",
"first_name": "John",
"middle_name": null,
"address_city": "Atlanta",
"phone_number": "(701) 885-9206",
"address_state": "GA",
"date_of_birth": "1988-08-23",
"address_street": "5530 cherry street",
"address_line_2": "1",
"address_postal_code": "30040",
}
}
}
lease_transaction.fees_updated
The “Lease Transaction Fees Updated” event is triggered when a leasing professional, an applicant, or the Funnel Leasing system makes any changes to a lease transaction fee (e.g., application fee, holding deposit). Updates include, but are not limited to, fees being paid, refunded, waived, amount modifications, or payment failures. Funnel will send all applicable fees with this event, even if only one has been updated.
Internal Funnel Leasing unique ID that points to the lease transaction
Integer
lease_transaction_type
Type of lease transaction (e.g., “Application”, “Lease Revision”, “Renewal”, “Notice to Vacate”, “Lease Confirmation”, “Transfer”)
String
client_id
Internal Funnel Leasing ID that points to the guest card of the client
Integer
tenant_pms_identifier
External customer identifier for the tenant, if applicable
String
Nullable
unit_pms_identifier
External customer identifier for the unit, if applicable
String
Nullable
community_id
Unique internal ID for the community in Funnel Leasing
Integer
community_pms_identifier
External customer identifier for the community, if applicable
String
Nullable
fees
List of fees associated with the lease transaction, including their metadata
Array
Property
Description
Type
Nullable
id
Unique internal ID for the lease transaction fee in Funnel Leasing
Integer
name
Name of the fee, configurable per property
String
fee_type
Type of lease transaction fee (e.g., “Application Fee”, “Holding Deposit”, “Transfer Fee”, “Roommate Fee”)
String
amount
Amount in US dollars
Decimal
paid
Indicates whether the fee has been paid
Boolean
waived
Indicates whether the fee has been waived by a leasing professional
Boolean
status
Current status of the fee, set internally by Funnel Leasing based on events received from Stripe
String
Nullable
charge_success
Indicates whether Funnel Leasing has successfully captured the authorized (paid) charges for the fee
Boolean
is_handled_offline
Indicates whether the fee was paid offline
Boolean
payer
Full name of the applicant who paid the fee
String
Nullable
charged_to
Full name of the applicant to whom this fee was charged
String
{
"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": null,
"fees": [
{
"id": 1,
"name": "Application Fee",
"fee_type": "Application Fee",
"amount": 15.50,
"paid": false,
"waived": false,
"status": "stripe.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": "stripe.charge_created",
"charge_success": false,
"is_handled_offline": false,
"payer": null,
"charged_to": "John Doe"
}
]
}
}
lease_transaction.status_updated
The “Lease Transaction Status Updated” event is triggered when a lease transaction changes its status within Funnel Leasing. This event is vital for keeping systems in sync with the latest transaction statuses.
Internal Funnel Leasing unique ID that points to the lease transaction
Integer
lease_transaction_type
Type of lease transaction (e.g., “Application”, “Lease Revision”, “Renewal”, “Notice to Vacate”, “Lease Confirmation”, “Transfer”)
String
current_status
The current status of the lease transaction. All the possible statuses of a Lease Transaction are: ‘In Progress’, ‘Submitted’, ‘Approved’, ‘Conditionally Approved’, ‘Denied’, ‘Canceled’, ‘Completed’ and ‘Pending Criminal Review’.
String
previous_status
The previous status of the lease transaction, if applicable. All the possible statuses of a Lease Transaction are: ‘In Progress’, ‘Submitted’, ‘Approved’, ‘Conditionally Approved’, ‘Denied’, ‘Canceled’, ‘Completed’ and ‘Pending Criminal Review’.
String
Nullable
client_id
Internal Funnel Leasing ID that points to the guest card of the client
Integer
tenant_pms_identifier
External customer identifier for the tenant, if applicable
String
Nullable
unit_pms_identifier
External customer identifier for the unit, if applicable
String
Nullable
community_id
Internal Funnel Leasing ID that points to the community
Integer
community_pms_identifier
External customer identifier for the community, if applicable
String
Nullable
lease_id
Internal Funnel Leasing ID that points to the lease, if applicable.
Integer
Nullable
{
"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"
}
}
lease_transaction.terms_updated
The “Lease Transaction Terms Updated” event is triggered when a lease transaction terms changes within Funnel Leasing during a lease transaction. This includes changes to Move in date, Lease Term, Unit Number, Unit Price and Lease End.
Internal Funnel Leasing unique ID that points to the lease transaction
Integer
lease_transaction_type
Type of lease transaction (e.g., “Application”, “Lease Revision”, “Renewal”, “Notice to Vacate”, “Lease Confirmation”, “Transfer”)
String
current_status
The current status of the lease transaction. All the possible statuses of a Lease Transaction are: ‘In Progress’, ‘Submitted’, ‘Approved’, ‘Conditionally Approved’, ‘Denied’, ‘Canceled’, ‘Completed’ and ‘Pending Criminal Review’.
String
client_id
Internal Funnel Leasing ID that points to the guest card of the client
Integer
tenant_pms_identifier
External customer identifier for the tenant, if applicable
String
Nullable
unit_pms_identifier
External customer identifier for the unit, if applicable
String
Nullable
community_id
Internal Funnel Leasing ID that points to the community
Integer
community_pms_identifier
External customer identifier for the community, if applicable
String
Nullable
lease_id
Internal Funnel Leasing ID that points to the lease, if applicable.
Integer
Nullable
context
Contains the new_value and old_value for specific terms that have been updated, such as unit number, lease start date, lease end date, base price, and lease term length.
Object
{
"id": "8cc87045-5555-4a16-a882-454044e6762a",
"event": "lease_transaction.terms_updated",
"timestamp": "2024-10-09T13:49:31.658518+00:00",
"data": {
"lease_transaction_id": 74826,
"lease_transaction_type": "Application",
"current_status": "Approved",
"client_id": 12457535,
"tenant_pms_identifier": "t1234",
"unit_pms_identifier": "u1234",
"community_id": 435242,
"community_pms_identifier": "c1234",
"lease_id": null,
"context": {
"new_value": {
"unit": "268",
"lease_end": "2026-03-02",
"base_price": 1997.0,
"lease_term": 14,
"lease_start": "2025-01-03"
},
"old_value": {
"unit": "268",
"lease_end": "2026-02-02",
"base_price": 1997.0,
"lease_term": 13,
"lease_start": "2025-01-03"
}
}
}
}
lease_transaction.rentable_item_selected
The “Lease Transaction Rentable Item Selected” event is triggered when a rentable item, such as a parking space or storage unit, ingested from the PMS, is selected in a lease transaction.
The “Lease Transaction Rentable Item Deselected” event is triggered when a previously selected rentable item, such as a parking space or storage unit, ingested from the PMS, is deselected in a lease transaction.
The “Resident Move In” event is triggered when a future resident moves into a unit. This event is crucial for tracking resident occupancy and updating relevant systems.
Internal Funnel Leasing ID that points to the lease
Integer
tenant_pms_identifier
External customer identifier for the tenant, if applicable
String
Nullable
unit_id
Internal Funnel Leasing ID that points to the unit
Integer
unit_pms_identifier
External customer identifier for the unit, if applicable
String
Nullable
community_id
Internal Funnel Leasing ID that points to the community
Integer
community_pms_identifier
External customer identifier for the community, if applicable
String
Nullable
move_in_date
The date when the resident moves in
Instant
{
"id": "8cc87045-6666-4a16-a882-454044e6762a",
"event": "lease.resident_move_in",
"timestamp": "2024-10-09T13:49:31.658518+00:00",
"data": {
"lease_id": 74827,
"tenant_pms_identifier": "t1234",
"unit_id": 4355,
"unit_pms_identifier": "u1234",
"community_id": 435245,
"community_pms_identifier": "c1234",
"move_in_date": "2023-05-01T12:00:00Z"
}
}
lease.resident_move_in_canceled
The “Resident Move In Canceled” event is triggered when a future resident’s move-in is canceled by a leasing professional. This event is key for maintaining accurate resident status information.
