Documentation Index
Fetch the complete documentation index at: https://docs.helloproper.com/llms.txt
Use this file to discover all available pages before exploring further.
Attributes
The unique identifier for the tenancy
The address details of the tenancyShow properties of Address Object
The full street name and number
The number of the property on the street
The floor of the address if applicable
The door of the address if applicable
The subdivision of the address if applicable
The postal code for the address
The country code of the address
Categories mapped to the corresponding groups
The details of the Current Lease Object for the tenancy
The unique identifier for the lease
The identifier for the tenancy associated with the lease
The operational state of the lease (e.g., “Draft”)
The state of the contract period (e.g., “Active”)
The name of the primary tenant contact
The identifiers for the tenants
The identifiers for the associated contacts
The identifier for the primary tenant
The identifier for the billing contact
The balance for the leaseShow properties of Amount Object
The currency code for the balance amount (e.g., “DKK”)
The amount of balance amount (e.g., 100.00)
The deposit balance for the leaseShow properties of Amount Object
The currency code for the deposit balance amount (e.g., “DKK”)
The amount of the prepaid balance amount (e.g., 100.00)
The prepaid balance for the leaseShow properties of Amount Object
The currency code for the balance amount (e.g., “DKK”)
The amount of prepaid balance amount (e.g., 100.00)
The start date of the contract in ISO 8601 format
The end date of the contract in ISO 8601 format
The purpose of the lease (e.g., “key:residential”)
The monthly rent level details for the leaseShow properties of Amount Object
The currency code for the monthly rent level (e.g., “DKK”)
The amount of the monthly rent level
The date-time in ISO 8601 format of archiving the lease
The identifiers for all leases associated with the tenancy
The type of the unit (e.g., “PARKING”)
The description of unit type, if unit type is “OTHER”
roomCounts
Array of Room Count Objects
Show properties of Room Count Object
The type of the room (e.g., “ROOM”)
The count of the room type
The total area of the tenancyShow properties of Area Object
The value of the total area
The unit of measurement for the area (e.g., “m²”)
The business area of the tenancyShow properties of Area Object
The value of the business area
The unit of measurement for the area (e.g., “m²”)
The date-time in ISO 8601 format of archiving the tenancy
