API ReferenceLeases

Create Lease

<Badge>Available by Request</Badge> Create a new lease agreement. This endpoint allows you to establish a lease contract with terms, rent amounts, start and end dates, and associate it with customers and units. <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

Request

This endpoint expects an object.
applicationIdstringRequiredformat: "uuid"
The application ID to create the lease for
move_in_datedatetimeOptional

The move-in date in ISO 8601 format

lease_termdoubleOptional1-100
The lease term in months
lease_start_datedatetimeOptional
The lease start date in ISO 8601 format
lease_end_datedatetimeOptional

The lease end date in ISO 8601 format (must be after start date)

base_rentstringOptional
The base rent amount

Response

The created lease
successboolean or null
applicationIdstring or nullformat: "uuid"
dataobject or null