Proper Docs home page
Search...
⌘K
Support
Platform
Platform
Search...
Navigation
Leases
The lease object
Documentation
API reference
API reference
Introduction
Authentication
Errors
Logs
Pagination
Versioning
Resources
Tenancies
Leases
The lease object
GET
List leases
GET
Retrieve a lease
Bills
Pending bills
Payments
Payouts
Recurring bill items
One time bill items
Transactions
Products
Contacts
Rent adjustment
Categories
On this page
Attributes
Leases
The lease object
Attributes
id
string
The unique identifier for the lease
tenancyId
string
The identifier for the tenancy associated with the lease
operationalState
string
The operational state of the lease (e.g., “Draft”)
contractPeriodState
string
The state of the contract period (e.g., “Active”)
primaryTenantContactName
string
The name of the primary tenant contact
tenantIds
Array of string
The identifiers for the tenants
associatedContactIds
Array of string
The identifiers for the associated contacts
primaryTenantId
string
The identifier for the primary tenant
billingContactId
string
The identifier for the billing contact
balance
Amount Object
The balance details for the lease
Show properties of Amount Object
currency
string
The currency code for the balance (e.g., “DKK”)
amount
number
The amount of the balance
depositBalance
Amount Object
The deposit balance details for the lease
Show properties of Amount Object
currency
string
The currency code for the deposit balance (e.g., “DKK”)
amount
number
The amount of the deposit balance
prepaidBalance
Amount Object
The prepaid balance details for the lease
Show properties of Amount Object
currency
string
The currency code for the prepaid balance (e.g., “DKK”)
amount
number
The amount of the prepaid balance
contractStart
date
The start date of the contract in ISO 8601 format
contractEnd
date
The end date of the contract in ISO 8601 format
purpose
string
The purpose of the lease (e.g., “key:residential”)
monthlyRentLevel
Amount Object
The monthly rent level details for the lease
Show properties of Amount Object
currency
string
The currency code for the monthly rent level (e.g., “DKK”)
amount
number
The amount of the monthly rent level
archivedAt
date
The date-time in ISO 8601 format of archiving the lease
Creates a tenancy
List leases
Assistant
Responses are generated using AI and may contain mistakes.