The tenancy object

Attributes

Tenancy Object

string

The unique identifier for the tenancy

Address Object

The address details of the tenancy

Show properties of Address Object

string

The full street name and number

string

The name of the street

string

The number of the property on the street

string

The floor of the address if applicable

string

The door of the address if applicable

string

The subdivision of the address if applicable

string

The postal code for the address

string

The city of the address

string

The country code of the address

map[string -> string]

Categories mapped to the corresponding groups

Current Lease Object

The details of the Current Lease Object for the tenancy

Show properties

string

The unique identifier for the lease

string

The identifier for the tenancy associated with the lease

string

The operational state of the lease (e.g., “Draft”)

string

The state of the contract period (e.g., “Active”)

string

The name of the primary tenant contact

Array of string

The identifiers for the tenants

Array of string

The identifiers for the associated contacts

string

The identifier for the primary tenant

string

The identifier for the billing contact

Amount Object

The balance for the lease

Show properties of Amount Object

string

The currency code for the balance amount (e.g., “DKK”)

number

The amount of balance amount (e.g., 100.00)

Amount Object

The deposit balance for the lease

Show properties of Amount Object

string

The currency code for the deposit balance amount (e.g., “DKK”)

number

The amount of the prepaid balance amount (e.g., 100.00)

Amount Object

The prepaid balance for the lease

Show properties of Amount Object

string

The currency code for the balance amount (e.g., “DKK”)

number

The amount of prepaid balance amount (e.g., 100.00)

date

The start date of the contract in ISO 8601 format

date

The end date of the contract in ISO 8601 format

string

The purpose of the lease (e.g., “key:residential”)

Amount Object

The monthly rent level details for the lease

Show properties of Amount Object

string

The currency code for the monthly rent level (e.g., “DKK”)

number

The amount of the monthly rent level

date

The date-time in ISO 8601 format of archiving the lease

Array of string

The identifiers for all leases associated with the tenancy

string

The type of the unit (e.g., “PARKING”)

string

The description of unit type, if unit type is “OTHER”

Array of Room Count Objects

Show properties of Room Count Object

string

The type of the room (e.g., “ROOM”)

integer

The count of the room type

Area Object

The total area of the tenancy

Show properties of Area Object

number

The value of the total area

string

The unit of measurement for the area (e.g., “m²”)

Area Object

The business area of the tenancy

Show properties of Area Object

number

The value of the business area

string

The unit of measurement for the area (e.g., “m²”)

date

The date-time in ISO 8601 format of archiving the tenancy

API reference

Resources

Attributes

​Attributes

Attributes