Skip to content

Lease Transaction (GET)

A Lease Transaction represents any operation within Funnel Leasing that creates or updates a Lease. Examples include “Application”, “Lease Revision”, “Renewal”, “Notice to Vacate”, “Lease Confirmation”, and “Transfer”.

API
GET /api/v2/lease-transactions/:id

Attributes

  • Name
    ID
    Type
    integer
    Description
  • Name
    type
    Type
    string
    Description
  • Name
    profile_type
    Type
    string
    Description
  • Name
    community
    Type
    object
    Description
  • Name
    status
    Type
    string
    Description
  • Name
    quote
    Type
    object
    Description
  • Name
    unit
    Type
    object
    Description
  • Name
    guest_card
    Type
    object
    Description
  • Name
    applicants
    Type
    array
    Description
  • Name
    invitees
    Type
    array
    Description
  • Name
    dependents
    Type
    array
    Description
  • Name
    security_deposit
    Type
    number
    Description
  • Name
    fees_itemized
    Type
    array
    Description
  • Name
    concessions
    Type
    array
    Description
  • Name
    rentable_items
    Type
    array
    Description
  • Name
    pets
    Type
    array
    Description
  • Name
    vehicles
    Type
    array
    Description
  • Name
    documents
    Type
    array
    Description
  • Name
    created_at
    Type
    string
    Description
  • Name
    updated_at
    Type
    string
    Description
Example request payload
{
"id": 347612,
"type": "Application",
"profile_type": "Standard",
"community": {
"id": 3521,
"display_name": "Magnolia View UAT"
},
"status": "Approved",
"quote": {
"id": 4421921,
"price": "1571.00",
"base_price": "1571.00",
"lease_start": "2024-06-27",
"lease_end": "2024-12-26",
"lease_term": 6,
"expiration": "2024-08-29 07:04:45.034937",
"total_monthly_fees": "1745.00",
"total_move_in_fees": "1082.68"
},
"unit": {
"id": 3998557,
"unit_number": "826",
"raw_unit_number": "0826",
"unit_pms_identifier": "132314",
"price": 1571,
"address": "721 E Ridge Dr - #0826",
"building_number": "721",
},
"guest_card": {
"client_id": 15209922,
"pms_guestcard_id": "p5003909",
"pms_resident_household_id": "t2570582"
},
"applicants": [
{
"id": 564323,
"full_name": "test elim two",
"role_name": "Primary Applicant"
}
],
"invitees": [
{
"id": 564323,
"full_name": "test elim two",
"email": "john.doe@gmail.com",
"phone_number": "+13120984673"
}
],
"dependents": [
{
"first_name": "Johnny",
"last_name": "The Dependent",
"email": "demo@test.com",
"date_of_birth": "2010-10-08",
"move_in_date": "2024-01-13",
"move_out_date": "2025-01-13",
},
],
"security_deposit": "600.00",
"concessions": [
{
"id": 1,
"type": "Rent Concession",
"amount": 550.0,
"amount_type": "fixed",
"description": "Test Concession",
"is_monthly": true,
"is_required": false,
"starting_month": 1,
"duration": 3,
"starting_date": "2024-07-01",
"ending_date": "2024-08-01"
}
],
"fees_itemized": [
{
"id": 292498,
"name": "App Fee",
"fee_type": "Application Fee",
"amount": 60,
"paid": true,
"waived": false,
"charge_success": true,
"is_handled_offline": false,
"payer": "test elim two",
"paid_for": "test elim two"
},
{
"id": 292499,
"name": "Administrative Fee",
"fee_type": "Holding Deposit",
"amount": 125,
"paid": true,
"waived": false,
"charge_success": true,
"is_handled_offline": false,
"payer": "test elim two",
"paid_for": "test elim two"
}
],
"rentable_items": [
{
"id": 21532501,
"item_id": "12",
"item_name": "#10",
"item_type_name": "Garage",
"item_type_id": "99",
"name": "Garage",
"start_date": "2024-06-27",
"end_date": null,
"charges": [
{
"id": 21949362,
"name": "Rent",
"amount": "95.00",
"refundable": false,
"due_at": "Monthly",
"start_date": "2024-06-27",
"end_date": null
}
]
}
],
"pets": [
{
"id": 21532499,
"name": "Bob",
"start_date": "2024-06-27",
"end_date": null,
"charges": [
{
"id": 21949356,
"name": "Dog Rent",
"amount": "25.00",
"refundable": false,
"due_at": "Monthly",
"start_date": "2024-06-27",
"end_date": null
},
{
"id": 21949357,
"name": "Dog Deposit",
"amount": "400.00",
"refundable": true,
"due_at": "At move-in",
"start_date": "2024-06-27",
"end_date": null
}
],
"type": "Dog",
"breed": "Pitbull",
"weight": "25",
"description": null,
"is_service_animal": false
},
{
"id": 21532500,
"name": null,
"start_date": "2024-06-27",
"end_date": null,
"charges": [
{
"id": 21949359,
"name": "Rent",
"amount": "0.00",
"refundable": false,
"due_at": "Monthly",
"start_date": "2024-06-27",
"end_date": null
},
{
"id": 21949360,
"name": "Pet Fee",
"amount": "00.00",
"refundable": false,
"due_at": "At move-in",
"start_date": "2024-06-27",
"end_date": null
}
],
"type": "Other",
"breed": null,
"weight": null,
"description": "Dragon",
"is_service_animal": true
}
],
"vehicles": [
{
"id": 21532503,
"start_date": "2024-06-27",
"end_date": null,
"make": "Toyota",
"model": "Rav4",
"color": "Blue",
"year": 2007,
"state": "TX",
"plate": "TX1342",
"permit": "12345"
}
],
"documents": [
{
"title": "scan_1.png",
"document_type": "user_uploaded_document",
"url": "https://webhooks-chuck-pr27411.nestiostaging.com/api/vgs/v2/242143/user_uploaded_document/10/"
}
],
"created_at": "2024-06-27T14:36:50.765136",
"updated_at": "2024-07-30T07:04:19.119826"
}