Leases

Create Lease

Create a lease on your account

POST https://api.zenstrin.com/leases

Request Body

Name	Type	Description
unit*	string	The ID of the unit
startDate*	string	The start date of the lease. The date format is: "YYYY-MM-DD"
endDate*	string	The end date of the lease. The date format is: "YYYY-MM-DD"
amount	integer	The leasePrice for the lease. Defaults to the leasePrice of the unit
frequency	string	The frequency of the rent charge for the lease. Available options include: ["daily", "weekly", "monthly", "every 3 months", "every 4 months", "every 6 months", "annually"]. Defaults to "daily".
serviceCharges	array	An array of stings with each representing a serviceCharge ID
tenants	array	An array of stings with each representing a tenant ID
id	string	The ID of the lease. The id parameter represents the unique identifier of a document in the database. Must be a non-empty string. Must not contain any of the following characters: '/', '.', '*', '[', ']', '(', ')'. Must be less than or equal to 1,500 bytes when UTF-8 encoded.

200 Ok

List Lease

List all leases on your account

GET https://api.zenstrin.com/leases

Query Parameters

Name	Type	Description
filter	string	The item to filter the results with. Available filters include: ["property", "unit", "tenant"]
filterId	string	The ID of the filtered item
startAt	string	The start date to fetch results from. The date format is: "YYYY-MM-DD"

200: OK Ok

Fetch Lease

Get the details of a lease on your account

GET https://api.zenstrin.com/leases/:leaseId

Path Parameters

Name	Type	Description
leaseId*	String	The ID of the lease

200: OK Ok