The tenancy object

Attributes

tenancy

Tenancy Object

string

The unique identifier for the tenancy

address

Address Object

The address details of the tenancy

Show properties of Address Object

street

string

The full street name and number

streetName

string

The name of the street

streetNumber

string

The number of the property on the street

floor

string

The floor of the address if applicable

door

string

The door of the address if applicable

subdivision

string

The subdivision of the address if applicable

postalCode

string

The postal code for the address

city

string

The city of the address

country

string

The country code of the address

groupId

map[string -> string]

Categories mapped to the corresponding groups

currentLease

Current Lease Object

The details of the Current Lease Object for the tenancy

Show properties

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 for the lease

Show properties of Amount Object

currency

string

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

amount

number

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

depositBalance

Amount Object

The deposit balance for the lease

Show properties of Amount Object

currency

string

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

amount

number

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

prepaidBalance

Amount Object

The prepaid balance for the lease

Show properties of Amount Object

currency

string

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

amount

number

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

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

leaseIds

Array of string

The identifiers for all leases associated with the tenancy

unitType

string

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

unitTypeName

string

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

roomCounts

Array of Room Count Objects

Show properties of Room Count Object

type

string

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

count

integer

The count of the room type

totalArea

Area Object

The total area of the tenancy

Show properties of Area Object

value

number

The value of the total area

unit

string

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

businessArea

Area Object

The business area of the tenancy

Show properties of Area Object

value

number

The value of the business area

unit

string

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

archivedAt

date

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

API reference

Resources

Attributes

API reference

Resources

​Attributes

Attributes