Lease

The Lease object represents a rental agreement between a landlord (or property manager) and a tenant. It encapsulates crucial information about the terms and conditions of the lease, including rental property details, lease duration, rental payments, executed documents, and various other attributes. This object serves as a comprehensive record of the lease agreement's key aspects, facilitating effective management and tracking throughout its lifecycle.

GET

/api/v2/leases/:id

Request

Example requestGET

curl -X GET \
    --user "YOUR_API_KEY:" \
    "https://api.funnelleasing.com/api/v2/leases/564323"

Response

Example responseJSON200 · application/json

{
  "id": 295135,
  "type": "Funnel Originated",
  "status": "Active",
  "lease_profile": "Standard",
  "guest_card": {
    "client_id": 15209251,
    "pms_guestcard_id": "p5003908",
    "pms_resident_household_id": "t2570581"
  },
  "unit": {
    "id": 3998520,
    "unit_number": "0625",
    "price": 1973,
    "address": "721 E Ridge Dr - #0625",
    "building_number": "721"
  },
  "lease_term": 5,
  "lease_start_date": "2024-06-27",
  "lease_end_date": "2024-11-26",
  "move_in_status": "Not set yet",
  "move_out_date": null,
  "base_rent": "1973.00",
  "is_holdover_eligible": false,
  "is_holdover": false,
  "is_month_to_month": false,
  "month_to_month_rent": "0.00",
  "is_renewed": false,
  "renewed_to": null,
  "is_vacating": false,
  "selected_lease_offer": 10,
  "lease_offers": [
    {
      "id": 960638,
      "rent": "1000.00",
      "is_month_to_month": false,
      "minimum_lease_term": 10,
      "maximum_lease_term": 12,
      "lease_start": "2024-11-24",
      "lease_end": null
    }
  ],
  "holdover_rent": null,
  "original_holdover_end_date": null,
  "termination_option": null,
  "termination_fee": null,
  "renewal_threshold": 90,
  "is_compliant": true,
  "is_below_market_rate": false,
  "residents": [
    {
      "id": 2359922,
      "role": "Primary",
      "first_name": "test",
      "last_name": "elim",
      "start_date": null,
      "end_date": null,
      "account_id": 422424,
      "representative_first_name": "",
      "representative_last_name": "",
      "corporation_name": ""
    }
  ],
  "lease_updates": {
    "midlease_change": [],
    "renewal": [
      {
        "id": 347586,
        "status": "Canceled",
        "type": "Renewal",
        "created_at": "2024-06-27T14:15:08.749579",
        "updated_at": "2024-07-30T05:39:05.154981"
      }
    ],
    "vacate": [
      {
        "id": 347579,
        "status": "Canceled",
        "type": "Notice to Vacate",
        "created_at": "2024-06-27T14:09:20.954958",
        "updated_at": "2024-06-27T14:10:08.879526"
      },
      {
        "id": 352226,
        "status": "Approved",
        "type": "Notice to Vacate",
        "created_at": "2024-07-30T05:39:06.341763",
        "updated_at": "2024-07-30T05:39:09.250540"
      }
    ],
    "reconciliation": [],
    "transfer": [],
    "holdover": [],
    "month_to_month": [],
    "lease_document_regeneration": []
  },
  "created_from_lease_transaction_id": 123,
  "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": null,
      "document_type": "lease_document",
      "url": "https://api.funnelleasing.com/api/v2/documents/255904/lease_document"
    },
    {
      "title": "money.jpeg",
      "document_type": "user_uploaded_document",
      "url": "https://webhooks-chuck-pr27411.nestiostaging.com/api/vgs/v2/242138/user_uploaded_document/10/"
    },
    {
      "title": "AAN - test elim",
      "document_type": "aan_document",
      "url": "https://api.funnelleasing.com/api/v2/documents/44071/aan_document"
    }
  ],
  "created_at": "2024-06-27T14:09:00.526774",
  "updated_at": "2024-07-30T05:55:34.673978"
}