API docs by Redocly

object API (develop:84871a)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the object stack.

AccountingService

Change a contract relation number

Updates the contract relation number for the contract identified by ownerId and numericId.

Request Body schema: application/json
required
contractRelationNumber
required
string <int64>
numericId
required
string <int64>
ownerId
required
string <int64>

Responses

Request samples

Content type
application/json
{
  • "contractRelationNumber": "string",
  • "numericId": "string",
  • "ownerId": "string"
}

Response samples

Content type
application/json
{ }

Get document sync logs

Returns a paginated list of document sync log entries for the given accountId. Response includes totalLogsCount and totalPageCount.

path Parameters
accountId
required
string <int64>
query Parameters
page
integer <int32>
itemsPerPage
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "logEntries": [
    ],
  • "totalLogsCount": 0,
  • "totalPageCount": 0
}

Get accounting enablement config

Returns accounting enablement and connection configuration for the given accountId. Usernames are returned; passwords are never included.

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "connection": {
    },
  • "directConnectionEnabled": true,
  • "disableBackSync": true,
  • "disableSync": true,
  • "enabled": true,
  • "targetAccountId": "string",
  • "targetEnterpriseId": "string",
  • "targetMainOwnerId": "string",
  • "targetMandantId": "string",
  • "targetProviderId": "string",
  • "targetSystemId": "string"
}

Get accounting sync logs

Returns a paginated list of accounting sync log entries for the given accountId. Response includes totalLogsCount and totalPageCount.

path Parameters
accountId
required
string <int64>
query Parameters
page
integer <int32>
itemsPerPage
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "logEntries": [
    ],
  • "totalLogsCount": 0,
  • "totalPageCount": 0
}

Get accounting sync statistics

Returns accounting sync statistics for the given accountId, including enablement, source/target accounts, contract sync counts, last sync time, and contract errors.

path Parameters
accountId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "statistics": {
    }
}

Check accounting enablement for properties

Returns whether accounting sync is enabled for each of the given property IDs.

Request Body schema: application/json
required
propertyIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "propertyIds": [
    ]
}

Response samples

Content type
application/json
{
  • "isEnabled": [
    ]
}

List all contract sync errors

Returns all contract sync error infos (owner, numeric ID, debtor, messages, last sync time). The request has no parameters.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Configure accounting enablement

Configures accounting enablement for accountId, including target account/mandant/provider/system IDs, sync flags, Abacus connection, and optional credentials (passwords applied when updatePasswords is true or on first provision).

Request Body schema: application/json
required

Configures enablement, account wiring, Inubit routing IDs, and Abacus connection in one RPC. targetMandantId / targetProviderId / targetSystemId stay required for Inubit dual-run.

accountId
required
string <int64>
required
object (accountingAbacusConnectionConfig)
required
object (accountingAbacusCredentials)
disableBackSync
required
boolean
disableSync
required
boolean
enabled
required
boolean
targetAccountId
required
string <int64>
targetEnterpriseId
required
string <int64>
targetMainOwnerId
required
string <int64>
targetMandantId
required
string <int64>
targetProviderId
required
string <int64>
targetSystemId
required
string <int64>
updatePasswords
required
boolean

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "connection": {
    },
  • "credentials": {
    },
  • "disableBackSync": true,
  • "disableSync": true,
  • "enabled": true,
  • "targetAccountId": "string",
  • "targetEnterpriseId": "string",
  • "targetMainOwnerId": "string",
  • "targetMandantId": "string",
  • "targetProviderId": "string",
  • "targetSystemId": "string",
  • "updatePasswords": true
}

Response samples

Content type
application/json
{ }

Skip the next accounting event

Skips the next accounting sync event for the given accountId.

Request Body schema: application/json
required
accountId
required
string <int64>

Responses

Request samples

Content type
application/json
{
  • "accountId": "string"
}

Response samples

Content type
application/json
{ }

Trigger debit-until back-sync

Manually triggers a back-sync of debit-until data from the accounting system for the given accountId.

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{ }

Trigger document back-sync

Manually triggers a back-sync of documents from the accounting system for the given accountId.

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{ }

Trigger rent adjustment back-sync

Manually triggers a back-sync of rent adjustments from the accounting system for the given accountId.

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{ }

BriefbutlerService

Acknowledge Briefbutler errors

Marks the Briefbutler error entries identified by the given IDs as acknowledged.

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{ }

List Briefbutler errors for an owner

Returns Briefbutler error entries for the given ownerId, including error message, media ID, entity ID, timestamp and render ID.

query Parameters
ownerId
string <int64>

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Load Briefbutler settings

Returns whether Briefbutler is enabled for the given accountId and the configured Briefbutler profiles.

query Parameters
accountId
string <int64>

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "profiles": [
    ]
}

Save Briefbutler settings

Saves Briefbutler enabled state and profiles (briefbutlerId and description) for the given accountId.

Request Body schema: application/json
required
accountId
required
string <int64>
enabled
required
boolean
required
Array of objects (briefbutlerBriefbutlerProfile)

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "enabled": true,
  • "profiles": [
    ]
}

Response samples

Content type
application/json
{ }

Send a raw document via Briefbutler

Sends the media document identified by mediaId through the Briefbutler profile identified by briefbutlerId.

Request Body schema: application/json
required
briefbutlerId
required
string
mediaId
required
string

Responses

Request samples

Content type
application/json
{
  • "briefbutlerId": "string",
  • "mediaId": "string"
}

Response samples

Content type
application/json
{ }

BuildingService

Add contacts to buildings

Adds the given building contacts (type and note) to the buildings identified by ids.

Request Body schema: application/json
required
required
Array of objects (objectbuildingBuildingContact)
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "buildingContacts": [
    ],
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Add documents to a building

Appends the given document IDs to the building identified by id. Returns the updated building.

Request Body schema: application/json
required
documentIds
required
Array of strings
id
required
string

Responses

Request samples

Content type
application/json
{
  • "documentIds": [
    ],
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "building": {
    }
}

Count buildings for an account

Returns the number of buildings visible for the given account under the specified share scope.

path Parameters
accountId
required
string <int64>
query Parameters
scope
string
Default: "UNDEFINED_SCOPE"
Enum: "UNDEFINED_SCOPE" "MARKETING_SCOPE" "MANAGEMENT_SCOPE" "ACCOUNTING_SCOPE" "ASSET_SCOPE"

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Create a building

Creates a new building for the given owner. Optional numericId may be supplied; otherwise it can be generated by the service. Accepts address, plots, objects, construction details, energy sources, contacts, and related metadata. Returns the created building.

Request Body schema: application/json
required
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (commonaddressAddress)
buildingArea
required
number <float>
required
object (buildingBuildingStrategy)
buildingValue
required
string <int64>
buildingZone
required
string
required
object (objectbuildingCharacteristics)
constructionTypes
required
Array of strings (buildingConstructionType)
Items Enum: "UNDEFINED_CONSTRUCTION_TYPE" "OLD_BUILDING" "NEW_BUILDING" "HIGH_RISE_BUILDING" "MIDDLE_TERRACED_HOUSE" "RAISED_GROUND_FLOOR" "CORNER_BUILDING" "MINERGIE_CONSTRUCTION" "MINERGIE_CERTIFIED" "LISTED_BUILDING"
constructionYear
required
integer <int32>
required
Array of objects (objectbuildingBuildingContact)
contractAmendments
required
string
required
object (buildingDistances)
documentIds
required
Array of strings
egid
required
string
required
Array of objects (objectbuildingEnergySource)
floors
required
integer <int32>
imageMediaId
required
string
landRegisterNumber
required
string
locationQuality
required
string (- VERY_BAD_QUALITY: sehr schlecht - BAD_QUALITY: schlecht - MODERATE_QUALITY: mässig - AVERAGE_QUALITY: durchschnittlich - GOOD_QUALITY: gut - BETTER_QUALITY: gut bis sehr gut - VERY_GOOD_QUALITY: sehr gut bis ausgezeichnet - TOP_QUALITY: ausgezeichnet - EXCELLENT_QUALITY: allerbeste)
Default: "UNDEFINED_LOCATION_QUALITY"
Enum: "UNDEFINED_LOCATION_QUALITY" "VERY_BAD_QUALITY" "BAD_QUALITY" "MODERATE_QUALITY" "AVERAGE_QUALITY" "GOOD_QUALITY" "BETTER_QUALITY" "VERY_GOOD_QUALITY" "TOP_QUALITY" "EXCELLENT_QUALITY"
name
required
string
note
required
string
number
required
integer <int32>
numericId
required
string <int64>
objectIds
required
Array of strings
ownerId
required
string <int64> (The account ID of the owner)
plotArea
required
number <float>
plotIds
required
Array of strings
required
object (buildingRating)
realEstateNumber
required
string
renovationYear
required
integer <int32>
required
object (https://swissrets.ch/SIA-areas.html)
volume
required
number <float>

Responses

Request samples

Content type
application/json
{
  • "acquisitionDate": {
    },
  • "address": {
    },
  • "buildingArea": 0.1,
  • "buildingStrategy": {
    },
  • "buildingValue": "string",
  • "buildingZone": "string",
  • "characteristics": {
    },
  • "constructionTypes": [
    ],
  • "constructionYear": 0,
  • "contacts": [
    ],
  • "contractAmendments": "string",
  • "distances": {
    },
  • "documentIds": [
    ],
  • "egid": "string",
  • "energySources": [
    ],
  • "floors": 0,
  • "imageMediaId": "string",
  • "landRegisterNumber": "string",
  • "locationQuality": "UNDEFINED_LOCATION_QUALITY",
  • "name": "string",
  • "note": "string",
  • "number": 0,
  • "numericId": "string",
  • "objectIds": [
    ],
  • "ownerId": "string",
  • "plotArea": 0.1,
  • "plotIds": [
    ],
  • "rating": {
    },
  • "realEstateNumber": "string",
  • "renovationYear": 0,
  • "sia": {
    },
  • "volume": 0.1
}

Response samples

Content type
application/json
{
  • "building": {
    }
}

Edit building contact notes

Updates notes on the given building contacts for the buildings identified by ids.

Request Body schema: application/json
required
required
Array of objects (objectbuildingBuildingContact)
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "buildingContacts": [
    ],
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Get a building by ID

Returns the building identified by the given building ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "building": {
    }
}

Get a building by object ID

Returns the building that contains the given object ID.

path Parameters
objectId
required
string

Responses

Response samples

Content type
application/json
{
  • "building": {
    }
}

List buildings for an account

Returns a paginated list of buildings for the given accountId. Supports filtering by name, address, zip range and network partners, and sorting by object count or rent figures. Response includes total object and page counts.

path Parameters
accountId
required
string <int64>

The accountId of the user who wants to list the buildings

query Parameters
page
integer <int32>
itemsPerPage
integer <int32>
name
string
address
string
zipFrom
integer <int32>
zipTo
integer <int32>
networkPartnerIds
Array of strings <int64> [ items <int64 > ]
sortObjectCount
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortGrossTargetRentPerYear
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortGrossActualRentPerYear
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortNetTargetRentPerYear
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortNetActualRentPerYear
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"

Responses

Response samples

Content type
application/json
{
  • "buildings": [
    ],
  • "totalObjectCount": 0,
  • "totalPageCount": 0
}

List all buildings for an account

Returns all buildings visible for the given accountId without pagination.

path Parameters
accountId
required
string <int64>

The accountId of the user who wants to list the buildings

Responses

Response samples

Content type
application/json
{
  • "buildings": [
    ]
}

List buildings by contact IDs

Returns buildings associated with any of the given contact IDs.

Request Body schema: application/json
required
contactIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIds": [
    ]
}

Response samples

Content type
application/json
{
  • "buildings": [
    ]
}

List buildings by map coordinates

Returns buildings within the bounding box defined by southWest and northEast coordinates, filtered by the given share scope.

query Parameters
southWestLat
number <double>
southWestLng
number <double>
northEastLat
number <double>
northEastLng
number <double>
scope
string
Default: "UNDEFINED_SCOPE"
Enum: "UNDEFINED_SCOPE" "MARKETING_SCOPE" "MANAGEMENT_SCOPE" "ACCOUNTING_SCOPE" "ASSET_SCOPE"

Responses

Response samples

Content type
application/json
{
  • "buildings": [
    ]
}

List buildings by IDs

Returns the buildings matching the given building IDs.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "buildings": [
    ]
}

List buildings by object IDs

Returns buildings that contain any of the given object IDs.

Request Body schema: application/json
required
objectIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "objectIds": [
    ]
}

Response samples

Content type
application/json
{
  • "buildings": [
    ]
}

List building filter options

Returns building filter options (id, name, ownerId, objectIds) available to the authenticated caller. Options are determined by authorization data; the request has no parameters.

Responses

Response samples

Content type
application/json
{
  • "options": [
    ]
}

Remove contacts from buildings

Removes the given building contacts from the buildings identified by ids.

Request Body schema: application/json
required
required
Array of objects (objectbuildingBuildingContact)
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "buildingContacts": [
    ],
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Delete a building

Deletes the building identified by id.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Move a building to another property

Moves the building identified by id to newPropertyId. Optionally assigns new contract IDs when newContractIds is true.

path Parameters
id
required
string
Request Body schema: application/json
required
newContractIds
boolean
newPropertyId
string

Responses

Request samples

Content type
application/json
{
  • "newContractIds": true,
  • "newPropertyId": "string"
}

Response samples

Content type
application/json
{ }

Update a building

Updates an existing building by ID, including name, address, plots, objects, construction details, energy sources, contacts, rating, and related metadata. Returns the updated building.

path Parameters
id
required
string
Request Body schema: application/json
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

object (commonaddressAddress)
buildingArea
number <float>
object (buildingBuildingStrategy)
buildingValue
string <int64>
buildingZone
string
object (objectbuildingCharacteristics)
constructionTypes
Array of strings (buildingConstructionType)
Items Enum: "UNDEFINED_CONSTRUCTION_TYPE" "OLD_BUILDING" "NEW_BUILDING" "HIGH_RISE_BUILDING" "MIDDLE_TERRACED_HOUSE" "RAISED_GROUND_FLOOR" "CORNER_BUILDING" "MINERGIE_CONSTRUCTION" "MINERGIE_CERTIFIED" "LISTED_BUILDING"
constructionYear
integer <int32>
Array of objects (objectbuildingBuildingContact)
contractAmendments
string
object (buildingDistances)
documentIds
Array of strings
egid
string
Array of objects (objectbuildingEnergySource)
floors
integer <int32>
imageMediaId
string
landRegisterNumber
string
locationQuality
string (- VERY_BAD_QUALITY: sehr schlecht - BAD_QUALITY: schlecht - MODERATE_QUALITY: mässig - AVERAGE_QUALITY: durchschnittlich - GOOD_QUALITY: gut - BETTER_QUALITY: gut bis sehr gut - VERY_GOOD_QUALITY: sehr gut bis ausgezeichnet - TOP_QUALITY: ausgezeichnet - EXCELLENT_QUALITY: allerbeste)
Default: "UNDEFINED_LOCATION_QUALITY"
Enum: "UNDEFINED_LOCATION_QUALITY" "VERY_BAD_QUALITY" "BAD_QUALITY" "MODERATE_QUALITY" "AVERAGE_QUALITY" "GOOD_QUALITY" "BETTER_QUALITY" "VERY_GOOD_QUALITY" "TOP_QUALITY" "EXCELLENT_QUALITY"
name
string
note
string
number
integer <int32>
objectIds
Array of strings
plotArea
number <float>
plotIds
Array of strings
object (buildingRating)
realEstateNumber
string
renovationYear
integer <int32>
object (https://swissrets.ch/SIA-areas.html)
volume
number <float>

Responses

Request samples

Content type
application/json
{
  • "acquisitionDate": {
    },
  • "address": {
    },
  • "buildingArea": 0.1,
  • "buildingStrategy": {
    },
  • "buildingValue": "string",
  • "buildingZone": "string",
  • "characteristics": {
    },
  • "constructionTypes": [
    ],
  • "constructionYear": 0,
  • "contacts": [
    ],
  • "contractAmendments": "string",
  • "distances": {
    },
  • "documentIds": [
    ],
  • "egid": "string",
  • "energySources": [
    ],
  • "floors": 0,
  • "imageMediaId": "string",
  • "landRegisterNumber": "string",
  • "locationQuality": "UNDEFINED_LOCATION_QUALITY",
  • "name": "string",
  • "note": "string",
  • "number": 0,
  • "objectIds": [
    ],
  • "plotArea": 0.1,
  • "plotIds": [
    ],
  • "rating": {
    },
  • "realEstateNumber": "string",
  • "renovationYear": 0,
  • "sia": {
    },
  • "volume": 0.1
}

Response samples

Content type
application/json
{
  • "building": {
    }
}

Update micro-location rating proposal

Sets the microLocationRatingProposal on the building identified by id. Returns the updated building.

path Parameters
id
required
string
Request Body schema: application/json
required
microLocationRatingProposal
number <float>
motorway
number <float>

Deprecated. Not saved anymore.

publicTransport
number <float>

Deprecated. Not saved anymore.

shop
number <float>

Deprecated. Not saved anymore.

Responses

Request samples

Content type
application/json
{
  • "microLocationRatingProposal": 0.1,
  • "motorway": 0.1,
  • "publicTransport": 0.1,
  • "shop": 0.1
}

Response samples

Content type
application/json
{
  • "building": {
    }
}

CondominiumService

Create a condominium

Creates a new condominium for the given owner and object. Optional numericId may be supplied; otherwise it can be generated by the service. Accepts contract, owner, tenants, rent, documents, and status flags. Returns the created condominium.

Request Body schema: application/json
required
activated
required
boolean
closed
required
boolean
required
object (objectcondominiumContract)
documentIds
required
Array of strings
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

finalInvoiceCreated
required
boolean
required
Array of objects (Deprecated, use rent message)
numericId
required
string <int64>
objectId
required
string
opted
required
boolean
required
object (condominiumOwner)
ownerId
required
string <int64>
required
object (objectcondominiumRent)
secondaryResidence
required
boolean
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

taxable
required
boolean
required
Array of objects (objectcondominiumTenant)

Responses

Request samples

Content type
application/json
{
  • "activated": true,
  • "closed": true,
  • "contract": {
    },
  • "documentIds": [
    ],
  • "endingAt": {
    },
  • "finalInvoiceCreated": true,
  • "flatRateValues": [
    ],
  • "numericId": "string",
  • "objectId": "string",
  • "opted": true,
  • "owner": {
    },
  • "ownerId": "string",
  • "rent": {
    },
  • "secondaryResidence": true,
  • "startingAt": {
    },
  • "taxable": true,
  • "tenants": [
    ]
}

Response samples

Content type
application/json
{
  • "condominium": {
    }
}

Delete condominium rent adjustments

Deletes rent adjustments for the given object IDs that match the specified byDate.

Request Body schema: application/json
required
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

objectIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "byDate": {
    },
  • "objectIds": [
    ]
}

Response samples

Content type
application/json
{ }

Get a condominium by ID

Returns the condominium identified by the given ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "condominium": {
    }
}

Check activated condominiums by object IDs

For each given object ID, returns whether an activated condominium exists.

Request Body schema: application/json
required
objectIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "objectIds": [
    ]
}

Response samples

Content type
application/json
{
  • "entries": [
    ]
}

List condominiums by billing contact

Returns condominiums where the given contact ID is the billing contact.

path Parameters
billingContactId
required
string

Responses

Response samples

Content type
application/json
{
  • "condominiums": [
    ]
}

List condominiums by contact ID

Returns condominiums involving the given contact ID. Role filters (billingContact, owners, correspondence, roommates, tenants) control which contact roles are matched.

path Parameters
contactId
required
string
query Parameters
billingContact
boolean
owners
boolean
correspondence
boolean
roommates
boolean
tenants
boolean

Responses

Response samples

Content type
application/json
{
  • "condominiums": [
    ]
}

List condominiums by IDs

Returns the condominiums matching the given condominium IDs.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "condominiums": [
    ]
}

List condominiums by object IDs

Returns condominiums linked to any of the given object IDs.

Request Body schema: application/json
required
objectIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "objectIds": [
    ]
}

Response samples

Content type
application/json
{
  • "condominiums": [
    ]
}

List condominiums for an owner

Returns all condominiums belonging to the given owner account ID.

path Parameters
ownerId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "condominiums": [
    ]
}

List condominiums by owner contact

Returns condominiums where the given contact ID is an owner contact.

path Parameters
ownerContactId
required
string

Responses

Response samples

Content type
application/json
{
  • "condominiums": [
    ]
}

List condominiums by tenant contacts

Returns condominiums linked to any of the given tenant contact IDs.

path Parameters
tenantContactIds
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{
  • "condominiums": [
    ]
}

List current condominiums by object IDs

Returns the current condominiums for the given object IDs.

Request Body schema: application/json
required
objectIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "objectIds": [
    ]
}

Response samples

Content type
application/json
{
  • "condominiums": [
    ]
}

Publish condominium updated events

Publishes updated events for condominiums belonging to the given owner account IDs.

Request Body schema: application/json
required
ownerIds
required
Array of strings <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "ownerIds": [
    ]
}

Response samples

Content type
application/json
{ }

Update condominiums in bulk

Updates multiple condominiums in one request via the given entries. Returns the updated condominiums.

Request Body schema: application/json
required
required
Array of objects (objectcondominiumUpdateBulkEntry)

Responses

Request samples

Content type
application/json
{
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "condominiums": [
    ]
}

Delete a condominium

Deletes the condominium with the given ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Activate a condominium

Activates the condominium identified by ID. Optional document IDs may be attached. Returns the updated condominium.

path Parameters
id
required
string
Request Body schema: application/json
required
documentIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "documentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "condominium": {
    }
}

Add documents to a condominium

Appends document IDs to the condominium identified by ID. Returns the updated condominium.

path Parameters
id
required
string
Request Body schema: application/json
required
documentIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "documentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "condominium": {
    }
}

Deactivate a condominium

Deactivates the condominium identified by ID. Returns the updated condominium.

path Parameters
id
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "condominium": {
    }
}

Remove documents from a condominium

Removes the given document IDs from the condominium identified by ID. Returns the updated condominium.

path Parameters
id
required
string
Request Body schema: application/json
required
documentIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "documentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "condominium": {
    }
}

Update a condominium

Updates an existing condominium by ID (dates, contract, owner, tenants, rent, documents, and status flags). Returns the updated condominium.

path Parameters
id
required
string
Request Body schema: application/json
required
activated
boolean
closed
boolean
object (objectcondominiumContract)
documentIds
Array of strings
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

finalInvoiceCreated
boolean
Array of objects (objectcondominiumFlatRateValues)
opted
boolean
object (condominiumOwner)
object (objectcondominiumRent)
secondaryResidence
boolean
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

taxable
boolean
Array of objects (objectcondominiumTenant)

Responses

Request samples

Content type
application/json
{
  • "activated": true,
  • "closed": true,
  • "contract": {
    },
  • "documentIds": [
    ],
  • "endingAt": {
    },
  • "finalInvoiceCreated": true,
  • "flatRateValues": [
    ],
  • "opted": true,
  • "owner": {
    },
  • "rent": {
    },
  • "secondaryResidence": true,
  • "startingAt": {
    },
  • "taxable": true,
  • "tenants": [
    ]
}

Response samples

Content type
application/json
{
  • "condominium": {
    }
}

Deactivate a condominium by numeric ID

Deactivates the condominium identified by owner account ID and numeric ID. Returns the updated condominium.

path Parameters
numericId
required
string <int64>
Request Body schema: application/json
required
ownerId
string <int64>

Responses

Request samples

Content type
application/json
{
  • "ownerId": "string"
}

Response samples

Content type
application/json
{
  • "condominium": {
    }
}

ContractService

Create a contract template

Creates a new contract template for the given owner. Accepts creatorName, title, mediaId, and category. Returns the created template.

Request Body schema: application/json
required
category
required
string (objectcontractTemplateCategory)
Default: "TEMPLATE_CATEGORY_UNDEFINED"
Enum: "TEMPLATE_CATEGORY_UNDEFINED" "TEMPLATE_CATEGORY_GENERAL" "TEMPLATE_CATEGORY_ORDERS" "TEMPLATE_CATEGORY_TERMINATION" "TEMPLATE_CATEGORY_CONTRACTS" "TEMPLATE_CATEGORY_PAYMENTS" "TEMPLATE_CATEGORY_OFFER" "TEMPLATE_CATEGORY_LETTER"
creatorName
required
string
mediaId
required
string
ownerId
required
string <int64>
title
required
string

Responses

Request samples

Content type
application/json
{
  • "category": "TEMPLATE_CATEGORY_UNDEFINED",
  • "creatorName": "string",
  • "mediaId": "string",
  • "ownerId": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "template": {
    }
}

Delete contract templates

Deletes the contract templates with the given IDs.

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{ }

List contract templates by owner IDs

Returns the contract templates belonging to any of the given owner IDs.

path Parameters
ownerIds
required
Array of strings <int64> non-empty [ items <int64 > ]

Responses

Response samples

Content type
application/json
{
  • "templates": [
    ]
}

Render a contract template for a tenancy

Renders the contract template identified by ID for the given tenancyId. Optional attachAutomatically, title, description, and signatories may be supplied. Returns the rendered contract bytes.

Request Body schema: application/json
required
attachAutomatically
required
boolean
description
required
string
id
required
string
signatories
required
Array of strings
tenancyId
required
string (The ID of the tenancy for which a new contract should be rendered)
title
required
string

Responses

Request samples

Content type
application/json
{
  • "attachAutomatically": true,
  • "description": "string",
  • "id": "string",
  • "signatories": [
    ],
  • "tenancyId": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "contract": "string"
}

Render a contract template for devices

Renders the contract template identified by ID for the given devices. Accepts order description, contact/assignee, on-site contact (onSiteContactPersonId or randomContactData), execution dates, title, and description. Returns the rendered contract bytes.

Request Body schema: application/json
required
assigneeContactId
required
string
contactId
required
string
description
required
string
required
Array of objects (objectcontractDeviceData)
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

id
required
string
onSiteContactPersonId
required
string

Either provide this or randomContactData, but not both!

orderDescription
required
string
required
object (objectcontractContactData)
title
required
string

Responses

Request samples

Content type
application/json
{
  • "assigneeContactId": "string",
  • "contactId": "string",
  • "description": "string",
  • "devices": [
    ],
  • "executeFrom": {
    },
  • "executeUntil": {
    },
  • "id": "string",
  • "onSiteContactPersonId": "string",
  • "orderDescription": "string",
  • "randomContactData": {
    },
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "contract": "string"
}

Render a contract template for multiple tenancies

Renders the contract template identified by ID for the given tenancy IDs. Optional title and description may be supplied. Returns the rendered contract bytes.

Request Body schema: application/json
required
description
required
string
id
required
string
tenancyIds
required
Array of strings
title
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": "string",
  • "tenancyIds": [
    ],
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "contract": "string"
}

Update a contract template

Updates an existing contract template by ID. Accepts title and mediaId.

path Parameters
id
required
string
Request Body schema: application/json
required
mediaId
string
title
string

Responses

Request samples

Content type
application/json
{
  • "mediaId": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{ }

Render a contract template for a condominium

Renders the contract template identified by ID for the given condominiumId. Optional attachAutomatically, title, and description may be supplied. Returns the rendered contract bytes.

Request Body schema: application/json
required
attachAutomatically
required
boolean
condominiumId
required
string (The ID of the condominium for which a new contract should be rendered)
description
required
string
id
required
string
title
required
string

Responses

Request samples

Content type
application/json
{
  • "attachAutomatically": true,
  • "condominiumId": "string",
  • "description": "string",
  • "id": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "contract": "string"
}

Render a contract template for multiple condominiums

Renders the contract template identified by ID for the given condominium IDs. Optional title and description may be supplied. Returns the rendered contract bytes.

Request Body schema: application/json
required
condominiumIds
required
Array of strings
description
required
string
id
required
string
title
required
string

Responses

Request samples

Content type
application/json
{
  • "condominiumIds": [
    ],
  • "description": "string",
  • "id": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "contract": "string"
}

Render a contract template for a contact

Renders the contract template identified by ID for the given contactId. Optional attachAutomatically, title, and description may be supplied. Returns the rendered contract bytes.

Request Body schema: application/json
required
attachAutomatically
required
boolean
contactId
required
string
description
required
string
id
required
string
title
required
string

Responses

Request samples

Content type
application/json
{
  • "attachAutomatically": true,
  • "contactId": "string",
  • "description": "string",
  • "id": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "contract": "string"
}

Render a contract template for multiple contacts

Renders the contract template identified by ID for the given contact IDs. Optional title and description may be supplied. Returns the rendered contract bytes.

Request Body schema: application/json
required
contactIds
required
Array of strings
description
required
string
id
required
string
title
required
string

Responses

Request samples

Content type
application/json
{
  • "contactIds": [
    ],
  • "description": "string",
  • "id": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "contract": "string"
}

Create a contract template

Creates a new contract template for the given owner. Accepts creatorName, title, mediaId, category, enforcePdf, and language. Returns the created template.

Request Body schema: application/json
required
category
required
string (contractv2TemplateCategory)
Default: "TEMPLATE_CATEGORY_UNDEFINED"
Enum: "TEMPLATE_CATEGORY_UNDEFINED" "TEMPLATE_CATEGORY_GENERAL" "TEMPLATE_CATEGORY_ORDERS" "TEMPLATE_CATEGORY_TERMINATION" "TEMPLATE_CATEGORY_CONTRACTS" "TEMPLATE_CATEGORY_PAYMENTS" "TEMPLATE_CATEGORY_OFFER" "TEMPLATE_CATEGORY_LETTER"
creatorName
required
string
enforcePdf
required
boolean
language
required
string (v2Language)
Default: "EN"
Enum: "EN" "DE" "FR" "IT"
mediaId
required
string
ownerId
required
string <int64>
title
required
string

Responses

Request samples

Content type
application/json
{
  • "category": "TEMPLATE_CATEGORY_UNDEFINED",
  • "creatorName": "string",
  • "enforcePdf": true,
  • "language": "EN",
  • "mediaId": "string",
  • "ownerId": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "template": {
    }
}

Delete contract templates

Deletes the contract templates with the given IDs.

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{ }

Delete a rendered contract file

Deletes the rendered contract file for the given renderId.

path Parameters
renderId
required
string

Responses

Response samples

Content type
application/json
{ }

Delete multiple rendered contract files

Deletes the rendered contract files for the given render IDs.

Request Body schema: application/json
required
renderIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "renderIds": [
    ]
}

Response samples

Content type
application/json
{ }

Get a rendered contract file

Returns the rendered contract bytes for the given renderId once the async render has finished.

path Parameters
renderId
required
string

Responses

Response samples

Content type
application/json
{
  • "contract": "string"
}

Get async contract render status

Returns whether the async render identified by renderId has finished or failed, including an optional errorMessage.

path Parameters
renderId
required
string

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "failed": true,
  • "finished": true
}

List contract templates by owner IDs

Returns the contract templates belonging to any of the given owner IDs.

path Parameters
ownerIds
required
Array of strings <int64> non-empty [ items <int64 > ]

Responses

Response samples

Content type
application/json
{
  • "templates": [
    ]
}

List async contract render statuses

Returns finished/failed status and optional errorMessage for each of the given render IDs.

Request Body schema: application/json
required
renderIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "renderIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": [
    ]
}

Start async render of a device contract template

Starts an asynchronous render of the contract template identified by ID for the given devices. Accepts order description, contact/assignee, on-site contact (onSiteContactPersonId or randomContactData), execution dates, title, description, attachAutomatically, showInPortal, enforcePdf, signatories, orderNumber, and documentName. Returns a renderId.

Request Body schema: application/json
required
assigneeContactId
required
string
attachAutomatically
required
boolean
contactId
required
string
description
required
string
required
Array of objects (contractv2DeviceData)
documentName
required
string
enforcePdf
required
boolean
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

id
required
string
onSiteContactPersonId
required
string

Either provide this or randomContactData, but not both!

orderDescription
required
string
orderNumber
required
string
required
object (contractv2ContactData)
showInPortal
required
boolean

Only used when attachAutomatically=true

signatories
required
Array of strings
title
required
string

Responses

Request samples

Content type
application/json
{
  • "assigneeContactId": "string",
  • "attachAutomatically": true,
  • "contactId": "string",
  • "description": "string",
  • "devices": [
    ],
  • "documentName": "string",
  • "enforcePdf": true,
  • "executeFrom": {
    },
  • "executeUntil": {
    },
  • "id": "string",
  • "onSiteContactPersonId": "string",
  • "orderDescription": "string",
  • "orderNumber": "string",
  • "randomContactData": {
    },
  • "showInPortal": true,
  • "signatories": [
    ],
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "renderId": "string"
}

Start async render of a contract template for multiple tenancies

Starts an asynchronous render of the contract template identified by ID for the given tenancy IDs. Optional attachAutomatically, showInPortal, title, description, signatories, order, sendingProfile, enforcePdf, documentName, and oneDocumentPerTenancy may be supplied. Returns a renderId.

Request Body schema: application/json
required
attachAutomatically
required
boolean
description
required
string
documentName
required
string
enforcePdf
required
boolean
id
required
string
oneDocumentPerTenancy
required
boolean
order
required
string (v2RenderOrder)
Default: "RENDER_ORDER_DEFAULT"
Enum: "RENDER_ORDER_DEFAULT" "RENDER_ORDER_NUMERIC_ID" "RENDER_ORDER_OBJECT_NUMBER_ASC" "RENDER_ORDER_OBJECT_NUMBER_DESC"
sendingProfile
required
string
showInPortal
required
boolean

Only used when attachAutomatically=true

signatories
required
Array of strings
tenancyIds
required
Array of strings
title
required
string

Responses

Request samples

Content type
application/json
{
  • "attachAutomatically": true,
  • "description": "string",
  • "documentName": "string",
  • "enforcePdf": true,
  • "id": "string",
  • "oneDocumentPerTenancy": true,
  • "order": "RENDER_ORDER_DEFAULT",
  • "sendingProfile": "string",
  • "showInPortal": true,
  • "signatories": [
    ],
  • "tenancyIds": [
    ],
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "renderId": "string"
}

Start async render of a tenancy contract template

Starts an asynchronous render of the contract template identified by ID for the given tenancyId. Optional attachAutomatically, showInPortal, title, description, signatories, useGuarantorAddress, sendingProfile, enforcePdf, and documentName may be supplied. Returns a renderId to poll for status and download the file.

Request Body schema: application/json
required
attachAutomatically
required
boolean
description
required
string
documentName
required
string
enforcePdf
required
boolean
id
required
string
sendingProfile
required
string
showInPortal
required
boolean

Only used when attachAutomatically=true

signatories
required
Array of strings
tenancyId
required
string
title
required
string
useGuarantorAddress
required
boolean

Responses

Request samples

Content type
application/json
{
  • "attachAutomatically": true,
  • "description": "string",
  • "documentName": "string",
  • "enforcePdf": true,
  • "id": "string",
  • "sendingProfile": "string",
  • "showInPortal": true,
  • "signatories": [
    ],
  • "tenancyId": "string",
  • "title": "string",
  • "useGuarantorAddress": true
}

Response samples

Content type
application/json
{
  • "renderId": "string"
}

Update a contract template

Updates an existing contract template by ID. Accepts ownerId, creatorName, title, mediaId, category, enforcePdf, and language.

path Parameters
id
required
string
Request Body schema: application/json
required
category
string (contractv2TemplateCategory)
Default: "TEMPLATE_CATEGORY_UNDEFINED"
Enum: "TEMPLATE_CATEGORY_UNDEFINED" "TEMPLATE_CATEGORY_GENERAL" "TEMPLATE_CATEGORY_ORDERS" "TEMPLATE_CATEGORY_TERMINATION" "TEMPLATE_CATEGORY_CONTRACTS" "TEMPLATE_CATEGORY_PAYMENTS" "TEMPLATE_CATEGORY_OFFER" "TEMPLATE_CATEGORY_LETTER"
creatorName
string
enforcePdf
boolean
language
string (v2Language)
Default: "EN"
Enum: "EN" "DE" "FR" "IT"
mediaId
string
ownerId
string <int64>
title
string

Responses

Request samples

Content type
application/json
{
  • "category": "TEMPLATE_CATEGORY_UNDEFINED",
  • "creatorName": "string",
  • "enforcePdf": true,
  • "language": "EN",
  • "mediaId": "string",
  • "ownerId": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{ }

Get multiple rendered contract files

Returns rendered contract bytes for the given render IDs (combined into a single response payload).

Request Body schema: application/json
required
renderIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "renderIds": [
    ]
}

Response samples

Content type
application/json
{
  • "contract": "string"
}

Start async render of a condominium contract template

Starts an asynchronous render of the contract template identified by ID for the given condominiumId. Optional includeRoommates, attachAutomatically, showInPortal, title, description, signatories, sendingProfile, enforcePdf, and documentName may be supplied. Returns a renderId.

Request Body schema: application/json
required
attachAutomatically
required
boolean
condominiumId
required
string
description
required
string
documentName
required
string
enforcePdf
required
boolean
id
required
string
includeRoommates
required
boolean
sendingProfile
required
string
showInPortal
required
boolean

Only used when attachAutomatically=true

signatories
required
Array of strings
title
required
string

Responses

Request samples

Content type
application/json
{
  • "attachAutomatically": true,
  • "condominiumId": "string",
  • "description": "string",
  • "documentName": "string",
  • "enforcePdf": true,
  • "id": "string",
  • "includeRoommates": true,
  • "sendingProfile": "string",
  • "showInPortal": true,
  • "signatories": [
    ],
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "renderId": "string"
}

Start async render of a contract template for multiple condominiums

Starts an asynchronous render of the contract template identified by ID for the given condominium IDs. Optional includeRoommates, attachAutomatically, showInPortal, title, description, signatories, order, sendingProfile, enforcePdf, and documentName may be supplied. Returns a renderId.

Request Body schema: application/json
required
attachAutomatically
required
boolean
condominiumIds
required
Array of strings
description
required
string
documentName
required
string
enforcePdf
required
boolean
id
required
string
includeRoommates
required
boolean
order
required
string (v2RenderOrder)
Default: "RENDER_ORDER_DEFAULT"
Enum: "RENDER_ORDER_DEFAULT" "RENDER_ORDER_NUMERIC_ID" "RENDER_ORDER_OBJECT_NUMBER_ASC" "RENDER_ORDER_OBJECT_NUMBER_DESC"
sendingProfile
required
string
showInPortal
required
boolean

Only used when attachAutomatically=true

signatories
required
Array of strings
title
required
string

Responses

Request samples

Content type
application/json
{
  • "attachAutomatically": true,
  • "condominiumIds": [
    ],
  • "description": "string",
  • "documentName": "string",
  • "enforcePdf": true,
  • "id": "string",
  • "includeRoommates": true,
  • "order": "RENDER_ORDER_DEFAULT",
  • "sendingProfile": "string",
  • "showInPortal": true,
  • "signatories": [
    ],
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "renderId": "string"
}

Start async render of a contact contract template

Starts an asynchronous render of the contract template identified by ID for the given contactId. Optional attachAutomatically, showInPortal, title, description, signatories, sendingProfile, enforcePdf, and documentName may be supplied. Returns a renderId.

Request Body schema: application/json
required
attachAutomatically
required
boolean
contactId
required
string
description
required
string
documentName
required
string
enforcePdf
required
boolean
id
required
string
sendingProfile
required
string
showInPortal
required
boolean

Only used when attachAutomatically=true

signatories
required
Array of strings
title
required
string

Responses

Request samples

Content type
application/json
{
  • "attachAutomatically": true,
  • "contactId": "string",
  • "description": "string",
  • "documentName": "string",
  • "enforcePdf": true,
  • "id": "string",
  • "sendingProfile": "string",
  • "showInPortal": true,
  • "signatories": [
    ],
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "renderId": "string"
}

Start async render of a contract template for multiple contacts

Starts an asynchronous render of the contract template identified by ID for the given contact IDs. Optional attachAutomatically, showInPortal, title, description, signatories, order, sendingProfile, enforcePdf, and documentName may be supplied. Returns a renderId.

Request Body schema: application/json
required
attachAutomatically
required
boolean
contactIds
required
Array of strings
description
required
string
documentName
required
string
enforcePdf
required
boolean
id
required
string
order
required
string (v2RenderOrder)
Default: "RENDER_ORDER_DEFAULT"
Enum: "RENDER_ORDER_DEFAULT" "RENDER_ORDER_NUMERIC_ID" "RENDER_ORDER_OBJECT_NUMBER_ASC" "RENDER_ORDER_OBJECT_NUMBER_DESC"
sendingProfile
required
string
showInPortal
required
boolean

Only used when attachAutomatically=true

signatories
required
Array of strings
title
required
string

Responses

Request samples

Content type
application/json
{
  • "attachAutomatically": true,
  • "contactIds": [
    ],
  • "description": "string",
  • "documentName": "string",
  • "enforcePdf": true,
  • "id": "string",
  • "order": "RENDER_ORDER_DEFAULT",
  • "sendingProfile": "string",
  • "showInPortal": true,
  • "signatories": [
    ],
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "renderId": "string"
}

CountryIndexService

Get inflation for a base year

Returns the inflation value for the given country index base year, month, and year.

query Parameters
baseYear
string
Default: "COUNTRY_INDEX_BASE_YEAR_1914"
Enum: "COUNTRY_INDEX_BASE_YEAR_1914" "COUNTRY_INDEX_BASE_YEAR_1939" "COUNTRY_INDEX_BASE_YEAR_1966" "COUNTRY_INDEX_BASE_YEAR_1977" "COUNTRY_INDEX_BASE_YEAR_1982" "COUNTRY_INDEX_BASE_YEAR_1993" "COUNTRY_INDEX_BASE_YEAR_2000" "COUNTRY_INDEX_BASE_YEAR_2005" "COUNTRY_INDEX_BASE_YEAR_2010" "COUNTRY_INDEX_BASE_YEAR_2015" "COUNTRY_INDEX_BASE_YEAR_2020" "COUNTRY_INDEX_BASE_YEAR_2025"
month
integer <int32>
year
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "inflation": 0.1
}

Read a country index file

Reads and processes a country index file from the given fileUrl.

Request Body schema: application/json
required
fileUrl
required
string

Responses

Request samples

Content type
application/json
{
  • "fileUrl": "string"
}

Response samples

Content type
application/json
{ }

DemoDataService

Generate demo data

Generates demo data for the given accountId using the selected DemoDataSet (1, 2, or 3).

Request Body schema: application/json
required
accountId
required
string <int64>
dataSet
required
string (demo_dataDemoDataSet)
Default: "DEMO_DATA_SET_1"
Enum: "DEMO_DATA_SET_1" "DEMO_DATA_SET_2" "DEMO_DATA_SET_3"

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "dataSet": "DEMO_DATA_SET_1"
}

Response samples

Content type
application/json
{ }

DeviceService

Create a device

Creates a new device for the given ownerId and referenceId, including facility plant, system, type, manufacturer details, costs, condition, maintenance/inspection/revision data, and optional documents and images. Returns the created device.

Request Body schema: application/json
required
acquisitionCosts
required
number <float>
amount
required
integer <int32>
assetNumberFm
required
string
bkpH
required
string (Construction costs plan for heating (German: Baukostenplan Heizung))
brand
required
string
cataloguePrice
required
number <float>
condition
required
string (- DEVICE_CONDITION_REPAIR_NEEDED: Deprecated. Will be moved to action value - DEVICE_CONDITION_REPLACEMENT_NEEDED: Deprecated. Will be moved to action value)
Default: "DEVICE_CONDITION_UNDEFINED"
Enum: "DEVICE_CONDITION_UNDEFINED" "DEVICE_CONDITION_NORMAL_WEAR" "DEVICE_CONDITION_REPAIR_NEEDED" "DEVICE_CONDITION_REPLACEMENT_NEEDED" "DEVICE_CONDITION_PERFECT" "DEVICE_CONDITION_DEFICIENCY"
conditionNote
required
string
documentIds
required
Array of strings
facilityPlant
required
string (deviceDeviceFacilityPlant)
Default: "DEVICE_FACILITY_PLANT_UNDEFINED"
Enum: "DEVICE_FACILITY_PLANT_UNDEFINED" "DEVICE_FACILITY_SHELL_CONSTRUCTION1" "DEVICE_FACILITY_SHELL_CONSTRUCTION2" "DEVICE_FACILITY_PLANT_ELECTRICITY" "DEVICE_FACILITY_PLANT_AIR_CONDITIONING" "DEVICE_FACILITY_PLANT_SANITARY" "DEVICE_FACILITY_PLANT_TRANSPORT_WAREHOUSE" "DEVICE_FACILITY_PLANT_INTERIOR1" "DEVICE_FACILITY_PLANT_INTERIOR2" "DEVICE_FACILITY_PLANT_GARDEN" "DEVICE_FACILITY_PLANT_DEVICE" "DEVICE_FACILITY_PLANT_FURNITURE" "DEVICE_FACILITY_PLANT_ELECTRONICS" "DEVICE_FACILITY_PLANT_TEXTILES" "DEVICE_FACILITY_PLANT_DECORATION" "DEVICE_FACILITY_PLANT_HOUSEHOLD_GOODS" "DEVICE_FACILITY_PLANT_OTHER"
required
Array of objects (objectdeviceImage)
required
object (deviceInspection)
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

lifeSpan
required
integer <int32>
required
object (deviceLockingKey)
required
object (deviceMaintenance)
manufacturer
required
string
measure
required
string (deviceDeviceMeasure)
Default: "DEVICE_MEASURE_UNDEFINED"
Enum: "DEVICE_MEASURE_UNDEFINED" "DEVICE_MEASURE_IMPLEMENTATION_PERIOD" "DEVICE_MEASURE_IMMEDIATELY"
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

model
required
string
note
required
string
order
required
integer <int32>
ownerId
required
string <int64>
referenceId
required
string
required
object (deviceRevision)
roomId
required
string
serialNumber
required
string
system
required
string (deviceDeviceSystem)
Default: "DEVICE_SYSTEM_UNDEFINED"
Enum: "DEVICE_SYSTEM_UNDEFINED" "DEVICE_SYSTEM_MASTER_BUILDER_WORK" "DEVICE_SYSTEM_WINDOW_DOOR" "DEVICE_SYSTEM_ROOFING" "DEVICE_SYSTEM_SEALING_INSULATION" "DEVICE_SYSTEM_FACADE_PLASTER" "DEVICE_SYSTEM_OUTER_FINISHES" "DEVICE_SYSTEM_HEAVY_CURRENT_INSTALLATION" "DEVICE_SYSTEM_LIGHTS" "DEVICE_SYSTEM_TELEPHONE" "DEVICE_SYSTEM_LOW_CURRENT_INSTALLATION" "DEVICE_SYSTEM_OTHER_ELECTRICITY" "DEVICE_SYSTEM_HEATING_TRANSITION_POSITION" "DEVICE_SYSTEM_ENERGY_SUPPLY" "DEVICE_SYSTEM_HEAT_GENERATION" "DEVICE_SYSTEM_HEAT_DISTRIBUTION" "DEVICE_SYSTEM_VENTILATION" "DEVICE_SYSTEM_AIR_CONDITIONING" "DEVICE_SYSTEM_COOLING" "DEVICE_SYSTEM_SPECIAL_FACILITY" "DEVICE_SYSTEM_INSULATION" "DEVICE_SYSTEM_OTHER_HEATING" "DEVICE_SYSTEM_SANITARY" "DEVICE_SYSTEM_SPECIAL_SANITARY" "DEVICE_SYSTEM_SANITARY_SUPPLY_DISPOSAL" "DEVICE_SYSTEM_SANITARY_PIPING" "DEVICE_SYSTEM_SANITARY_INSULATION" "DEVICE_SYSTEM_SANITARY_EQUIPMENT" "DEVICE_SYSTEM_ELECTRIC_PNEUMATIC_BOARD" "DEVICE_SYSTEM_KITCHEN_EQUIPMENT" "DEVICE_SYSTEM_OTHER_SANITARY" "DEVICE_SYSTEM_ELEVATOR" "DEVICE_SYSTEM_MOVING_STAIRCASE" "DEVICE_SYSTEM_FACADE_CLEANING" "DEVICE_SYSTEM_GOODS_CONVEYING" "DEVICE_SYSTEM_LIFTING" "DEVICE_SYSTEM_PARKING" "DEVICE_SYSTEM_TRANSPORT_OTHER" "DEVICE_SYSTEM_PLASTERER" "DEVICE_SYSTEM_METAL" "DEVICE_SYSTEM_CARPENTER" "DEVICE_SYSTEM_WINDOW" "DEVICE_SYSTEM_LOCKING" "DEVICE_SYSTEM_INTERIOR_FINISHES" "DEVICE_SYSTEM_ELEMENT_WALL" "DEVICE_SYSTEM_CHROME_STEEL_FACILITY" "DEVICE_SYSTEM_OTHER_INTERIOR1" "DEVICE_SYSTEM_FLOORING" "DEVICE_SYSTEM_WALL_COVERING" "DEVICE_SYSTEM_CEILING" "DEVICE_SYSTEM_INTERIOR_SURFACE_TREATMENTS" "DEVICE_SYSTEM_OTHER_INTERIOR2" "DEVICE_SYSTEM_OTHER_TRANSPORT" "DEVICE_SYSTEM_GARDEN_TRANSITION_POSITION" "DEVICE_SYSTEM_GARDENING" "DEVICE_SYSTEM_FENCING" "DEVICE_SYSTEM_SUPERSTRUCTURE" "DEVICE_SYSTEM_PLAYGROUND" "DEVICE_SYSTEM_GARDEN_OTHER" "DEVICE_SYSTEM_DEVICE_TRANSITION_POSITION" "DEVICE_SYSTEM_ELECTRONICS_DESIGN" "DEVICE_SYSTEM_MEDICAL_DEVICES" "DEVICE_SYSTEM_LABELS_MARKINGS_SIGNAGE"
type
required
string (- DEVICE_TYPE_CHROME_STEEP_FINISH: Not used)
Default: "DEVICE_TYPE_UNDEFINED"
Enum: "DEVICE_TYPE_UNDEFINED" "DEVICE_TYPE_MASTER_BUILDER_WORK_DOWN_PIPES" "DEVICE_TYPE_MASTER_BUILDER_WORK_BASIC_LINE" "DEVICE_TYPE_MASTER_BUILDER_WORK_DRAINAGE_LINE" "DEVICE_TYPE_MASTER_BUILDER_WORK_PUMP_CHAMBER" "DEVICE_TYPE_MASTER_BUILDER_WORK_TERRACE_DRAIN" "DEVICE_TYPE_WINDOW_DOOR_AUTOMATIC_SLIDING_DOOR" "DEVICE_TYPE_WINDOW_DOOR_EXTERIOR_DOOR" "DEVICE_TYPE_WINDOW_DOOR_FIRE_GATE" "DEVICE_TYPE_WINDOW_DOOR_ROOF_WINDOW" "DEVICE_TYPE_WINDOW_DOOR_WINDOW" "DEVICE_TYPE_WINDOW_DOOR_GATE_DRIVE" "DEVICE_TYPE_WINDOW_DOOR_GARAGE_DOOR" "DEVICE_TYPE_WINDOW_DOOR_DOOR_AUTOMATION" "DEVICE_TYPE_WINDOW_DOOR_EXTERIOR_DOOR_SOLID_WOOD" "DEVICE_TYPE_WINDOW_DOOR_EXTERIOR_DOOR_WOOD_MATERIAL" "DEVICE_TYPE_WINDOW_DOOR_EXTERIOR_DOOR_METAL" "DEVICE_TYPE_WINDOW_DOOR_WINDOW_WOOD_DOUBLE_GLAZING" "DEVICE_TYPE_WINDOW_DOOR_WINDOW_PLASTIC" "DEVICE_TYPE_WINDOW_DOOR_WINDOW_WOOD" "DEVICE_TYPE_WINDOW_DOOR_WINDOW_WOOD_METAL" "DEVICE_TYPE_WINDOW_DOOR_WINDOW_METAL" "DEVICE_TYPE_ROOFING_PENT_ROOF" "DEVICE_TYPE_ROOFING_SADDLE_ROOF" "DEVICE_TYPE_ROOFING_TERRACE" "DEVICE_TYPE_ROOFING_HIPPED_ROOF" "DEVICE_TYPE_ROOFING_TENT_ROOF" "DEVICE_TYPE_ROOFING_FLAT_ROOF" "DEVICE_TYPE_ROOFING_SHEARING_ROOF" "DEVICE_TYPE_ROOFING_FRONT_PANEL" "DEVICE_TYPE_SEALING_INSULATION_FACADE" "DEVICE_TYPE_SEALING_INSULATION_INTERIOR" "DEVICE_TYPE_SEALING_INSULATION_FACADE_WOOD" "DEVICE_TYPE_SEALING_INSULATION_FACADE_PLATES" "DEVICE_TYPE_SEALING_INSULATION_FACADE_ETERNIT" "DEVICE_TYPE_FACADE_PLASTER_PAINTING" "DEVICE_TYPE_FACADE_PLASTER" "DEVICE_TYPE_OUTER_FINISHES_FOLDING_SHUTTERS" "DEVICE_TYPE_OUTER_FINISHES_SHUTTERS" "DEVICE_TYPE_OUTER_FINISHES_SUN_BLINDS" "DEVICE_TYPE_OUTER_FINISHES_SUN_BLINDS_VOLANT" "DEVICE_TYPE_OUTER_FINISHES_GLARE_PROTECTION" "DEVICE_TYPE_OUTER_FINISHES_SHUTTERS_WOOD" "DEVICE_TYPE_OUTER_FINISHES_SHUTTERS_METAL" "DEVICE_TYPE_OUTER_FINISHES_SLAT_TOWERS" "DEVICE_TYPE_OUTER_FINISHES_SLAT_TOWERS_OUTSIDE_ALUMINIUM" "DEVICE_TYPE_OUTER_FINISHES_SLAT_TOWERS_INSIDE" "DEVICE_TYPE_OUTER_FINISHES_BLIND_SHOPS" "DEVICE_TYPE_OUTER_FINISHES_BLIND_SHOPS_WOOD" "DEVICE_TYPE_OUTER_FINISHES_BLIND_SHOPS_METAL" "DEVICE_TYPE_OUTER_FINISHES" "DEVICE_TYPE_OUTER_FINISHES_PRIVACY_SCREEN" "DEVICE_TYPE_OUTER_FINISHES_PRIVACY_SCREEN_GLASS" "DEVICE_TYPE_OUTER_FINISHES_PRIVACY_SCREEN_WOOD" "DEVICE_TYPE_OUTER_FINISHES_PRIVACY_SCREEN_METAL" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_LIGHTING" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_CO2" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_SINA" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_SMOKE_VENT" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_PROOF_OF_SAFETY_SINA" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_SWITCHGEAR_COMBINATION" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_PHOTOVOLTAIC" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_LOW_VOLTAGE_SYSTEM" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_CABLE" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_SWITCH" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_SWITCHBOARD" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_SOCKET" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_UPS" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_INFRASTRUCTURE_ELECTRIC_CHARGING" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_ELECTRIC_CHARGING_STATION" "DEVICE_TYPE_LIGHTS_ILLUMINANT" "DEVICE_TYPE_LIGHTS" "DEVICE_TYPE_LIGHTS_CEILING" "DEVICE_TYPE_LIGHTS_CABINET" "DEVICE_TYPE_LIGHTS_SPOTS" "DEVICE_TYPE_LIGHTS_MIRROR_CABINET" "DEVICE_TYPE_TELEPHONE_CENTER" "DEVICE_TYPE_TELEPHONE_DISTRIBUTOR" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_INTERCOM" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_INTERCOM_VIDEO" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_BELL" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_DOOR_OPENER" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_FIBERGLASS" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_EMERGENCY_PHONE_LIFT" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_INTERPHONE" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_MULTIMEDIA" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_INTRUSION_DETECTION" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_ISDN" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_CABLE" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_SWITCH" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_SWITCHBOARD" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_SOCKET" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_TV_ANTENNA" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_TV_CABLE" "DEVICE_TYPE_OTHER_ELECTRICITY_BATTERY" "DEVICE_TYPE_OTHER_ELECTRICITY_OTHER" "DEVICE_TYPE_OTHER_ELECTRICITY_LIGHTNING_PROTECTION" "DEVICE_TYPE_OTHER_ELECTRICITY" "DEVICE_TYPE_OTHER_ELECTRICITY_SOCKET" "DEVICE_TYPE_OTHER_ELECTRICITY_FUSEBOX" "DEVICE_TYPE_HEATING_TRANSITION_POSITION_ROOF_VENTILATION" "DEVICE_TYPE_HEATING_TRANSITION_POSITION_FILTER_REPLACEMENT" "DEVICE_TYPE_HEATING_TRANSITION_POSITION_AIR_CONDITIONING" "DEVICE_TYPE_HEATING_TRANSITION_POSITION_VENTILATION" "DEVICE_TYPE_ENERGY_SUPPLY_SUPPLY" "DEVICE_TYPE_ENERGY_SUPPLY_LEAKAGE_WARNING" "DEVICE_TYPE_ENERGY_SUPPLY_TANK" "DEVICE_TYPE_ENERGY_SUPPLY_STORAGE" "DEVICE_TYPE_ENERGY_SUPPLY_GAS_LINE" "DEVICE_TYPE_ENERGY_SUPPLY_FUEL_TANK_INSIDE" "DEVICE_TYPE_ENERGY_SUPPLY_FUEL_TANK_EARTH_LOADED" "DEVICE_TYPE_HEAT_GENERATION" "DEVICE_TYPE_HEAT_GENERATION_BOILER" "DEVICE_TYPE_HEAT_GENERATION_BURNER" "DEVICE_TYPE_HEAT_GENERATION_EARTH_PROBE" "DEVICE_TYPE_HEAT_GENERATION_ELECTRIC_STORAGE_STOVE" "DEVICE_TYPE_HEAT_GENERATION_EXPANSION_DEVICE" "DEVICE_TYPE_HEAT_GENERATION_DISTRICT_HEATING" "DEVICE_TYPE_HEAT_GENERATION_DISTRICT_HEATING_SUBSTATION" "DEVICE_TYPE_HEAT_GENERATION_HEATING_BOILER" "DEVICE_TYPE_HEAT_GENERATION_THERMAL_SOLAR_SYSTEM" "DEVICE_TYPE_HEAT_GENERATION_HEAT_EXCHANGER" "DEVICE_TYPE_HEAT_GENERATION_HEAT_PUMP" "DEVICE_TYPE_HEAT_GENERATION_FIREPLACE" "DEVICE_TYPE_HEAT_GENERATION_HEAT_ACCUMULATOR" "DEVICE_TYPE_HEAT_GENERATION_SINGLE_WATER_BOILER" "DEVICE_TYPE_HEAT_GENERATION_COMBIBOILER_HEATING" "DEVICE_TYPE_HEAT_GENERATION_ELECTRIC_BOILER" "DEVICE_TYPE_HEAT_GENERATION_BOILER_GAS_APPLIANCES" "DEVICE_TYPE_HEAT_GENERATION_COMBINED_BOILER" "DEVICE_TYPE_HEAT_GENERATION_SOLAR_PANELS" "DEVICE_TYPE_HEAT_GENERATION_RADIATORS" "DEVICE_TYPE_HEAT_GENERATION_RADIATORS_HEATWALLS" "DEVICE_TYPE_HEAT_GENERATION_TOWEL_RADIATORS" "DEVICE_TYPE_HEAT_GENERATION_FLOOR_HEATING" "DEVICE_TYPE_HEAT_GENERATION_HEATING_ELEMENT" "DEVICE_TYPE_HEAT_GENERATION_ELECTRIC_STOVE" "DEVICE_TYPE_HEAT_GENERATION_ROOF_HEATING" "DEVICE_TYPE_HEAT_DISTRIBUTION" "DEVICE_TYPE_HEAT_DISTRIBUTION_HEAT_METER" "DEVICE_TYPE_HEAT_DISTRIBUTION_CIRCULATING_PUMP" "DEVICE_TYPE_HEAT_DISTRIBUTION_HEAT_QUANTITY_FLOW_METERS" "DEVICE_TYPE_HEAT_DISTRIBUTION_HEATING_COST_ALLOCATOR" "DEVICE_TYPE_HEAT_DISTRIBUTION_FLOOR_HEATING" "DEVICE_TYPE_VENTILATION_VENTILATION_CONTROL_CENTER" "DEVICE_TYPE_VENTILATION_VENTILATION" "DEVICE_TYPE_VENTILATION_SUPPLY_AIR_FAN" "DEVICE_TYPE_VENTILATION_EXHAUST_AIR_FAN" "DEVICE_TYPE_VENTILATION_SMOKE_EXTRACTION_SYSTEM" "DEVICE_TYPE_VENTILATION" "DEVICE_TYPE_VENTILATION_CONTROLLED_HOME" "DEVICE_TYPE_VENTILATION_CHANNELS" "DEVICE_TYPE_AIR_CONDITIONING_RECOOLING" "DEVICE_TYPE_AIR_CONDITIONING" "DEVICE_TYPE_AIR_CONDITIONING_INDIVIDUAL_ROOMS" "DEVICE_TYPE_COOLING_CHILLERS" "DEVICE_TYPE_COOLING_COLD_RESERVOIR" "DEVICE_TYPE_COOLING_COLD_WATER_TANK" "DEVICE_TYPE_COOLING_COLD_STORAGE_CELL" "DEVICE_TYPE_COOLING" "DEVICE_TYPE_SPECIAL_FACILITY" "DEVICE_TYPE_INSULATION" "DEVICE_TYPE_INSULATION_CHIMNEY" "DEVICE_TYPE_SPECIAL_FACILITY_MEASUREMENT_CONTROL_TECHNOLOGY_BUILDING_MANAGEMENT_SYSTEM" "DEVICE_TYPE_SPECIAL_FACILITY_MEASUREMENT_CONTROL_TECHNOLOGY_CONTROL_SYSTEM" "DEVICE_TYPE_SPECIAL_FACILITY_MEASUREMENT_CONTROL_TECHNOLOGY" "DEVICE_TYPE_SPECIAL_FACILITY_MEASUREMENT_CONTROL_TECHNOLOGY_VALVES" "DEVICE_TYPE_SANITARY_BATHTUB" "DEVICE_TYPE_SANITARY_RENOVATION" "DEVICE_TYPE_SANITARY_CONTROL_FITTINGS" "DEVICE_TYPE_SANITARY_WASHBASIN" "DEVICE_TYPE_SANITARY_WASHBASIN_CERAMIC" "DEVICE_TYPE_SANITARY_MIRROR_CABINET" "DEVICE_TYPE_SANITARY_BIDET" "DEVICE_TYPE_SANITARY_SHOWER" "DEVICE_TYPE_SANITARY_LAVABO" "DEVICE_TYPE_SANITARY_URINAL" "DEVICE_TYPE_SANITARY_FLUSH_TANK" "DEVICE_TYPE_SANITARY_TOILET" "DEVICE_TYPE_SANITARY_TOILET_CERAMIC" "DEVICE_TYPE_SANITARY_TOILET_CLOSOMAT" "DEVICE_TYPE_SANITARY_TOILET_COVER" "DEVICE_TYPE_SANITARY_TOILET_COVER_SOFT_CLOSE" "DEVICE_TYPE_SANITARY_BATHTUB_ACRYLIC" "DEVICE_TYPE_SANITARY_BATHTUB_STEEL" "DEVICE_TYPE_SANITARY_MIRROR_CABINET_PLASTIC" "DEVICE_TYPE_SANITARY_MIRROR_CABINET_WOODEN" "DEVICE_TYPE_SANITARY_MIRROR_CABINET_METAL" "DEVICE_TYPE_SANITARY_FLUSH_TANK_FLUSH_MOUNTED" "DEVICE_TYPE_SANITARY_FLUSH_TANK_PLASTIC" "DEVICE_TYPE_SANITARY_FLUSH_TANK_CERAMIC" "DEVICE_TYPE_SANITARY_LAVABO_TOILET_BIDET_URINAL" "DEVICE_TYPE_SANITARY_LAVABO_TOILET_BIDET_URINAL_CERAMIC" "DEVICE_TYPE_SANITARY_LAVABO_TOILET_BIDET_URINAL_CLOSOMAT" "DEVICE_TYPE_SANITARY_SHOWER_CABIN" "DEVICE_TYPE_SANITARY_SHOWER_CABIN_PLASTIC" "DEVICE_TYPE_SANITARY_SHOWER_CABIN_GLASWALLS" "DEVICE_TYPE_SPECIAL_SANITARY_WATER_SOFTENER" "DEVICE_TYPE_SPECIAL_SANITARY_LIMESCALE_PROTECTION" "DEVICE_TYPE_SPECIAL_SANITARY_DEHUMIDIFIER" "DEVICE_TYPE_SPECIAL_SANITARY_WASHING_MACHINE" "DEVICE_TYPE_SPECIAL_SANITARY_COMBI_WASHER_DRYER" "DEVICE_TYPE_SPECIAL_SANITARY_WASHING_ELECTRICITY_METER" "DEVICE_TYPE_SPECIAL_SANITARY_TUMBLER" "DEVICE_TYPE_SPECIAL_SANITARY_VACUUM_DEGASSING_DEVICE" "DEVICE_TYPE_SPECIAL_SANITARY" "DEVICE_TYPE_SPECIAL_SANITARY_WATER_TAP" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_SUPPLY" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_DISPOSAL" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_WATER_TREATMENT" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_SEWAGE_PUMP" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_WATER_DISTRIBUTION_BATTERY" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_SEWAGE_TANK" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_PIPING_COLD_WATER" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_FINE_FILTER" "DEVICE_TYPE_SANITARY_PIPING_RAIN_WATER" "DEVICE_TYPE_SANITARY_PIPING_WARM_WATER" "DEVICE_TYPE_SANITARY_PIPING" "DEVICE_TYPE_SANITARY_INSULATION" "DEVICE_TYPE_SANITARY_EQUIPMENT_MIRROR_CABINETS" "DEVICE_TYPE_SANITARY_EQUIPMENT_MIRROR_CABINETS_ONE_DOOR" "DEVICE_TYPE_SANITARY_EQUIPMENT_MIRROR_CABINETS_TWO_DOOR" "DEVICE_TYPE_SANITARY_EQUIPMENT_MIRROR" "DEVICE_TYPE_SANITARY_EQUIPMENT_BATHROOM_FURNITURE" "DEVICE_TYPE_SANITARY_EQUIPMENT_SHOWER_CABIN" "DEVICE_TYPE_SANITARY_EQUIPMENT" "DEVICE_TYPE_SANITARY_SHOWER_HEAD_HOSE" "DEVICE_TYPE_SANITARY_SHOWER_ROD" "DEVICE_TYPE_SANITARY_SHOWER_ROD_CHROME_STEEL" "DEVICE_TYPE_SANITARY_SHOWER_HEAD_HOLDER" "DEVICE_TYPE_ELECTRIC_PNEUMATIC_BOARD" "DEVICE_TYPE_KITCHEN_EQUIPMENT_REFRIGERATOR" "DEVICE_TYPE_KITCHEN_EQUIPMENT_REFRIGERATOR_ACCESSORIES" "DEVICE_TYPE_KITCHEN_EQUIPMENT_REFRIGERATOR_ACCESSORIES_COMPARTMENT" "DEVICE_TYPE_KITCHEN_EQUIPMENT_WASTE" "DEVICE_TYPE_KITCHEN_EQUIPMENT_WASTE_SEPARATING_SYSTEM" "DEVICE_TYPE_KITCHEN_EQUIPMENT_WASTE_HOLDER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FREEZER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_OVEN" "DEVICE_TYPE_KITCHEN_EQUIPMENT_OVEN_ACCESSORIES" "DEVICE_TYPE_KITCHEN_EQUIPMENT_OVEN_ACCESSORIES_BLECH" "DEVICE_TYPE_KITCHEN_EQUIPMENT_OVEN_ACCESSORIES_GRID" "DEVICE_TYPE_KITCHEN_EQUIPMENT_OVEN_ACCESSORIES_THERMOMETER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_OVEN_ACCESSORIES_GRILL" "DEVICE_TYPE_KITCHEN_EQUIPMENT_STEAM_EXHAUST_HOOD" "DEVICE_TYPE_KITCHEN_EQUIPMENT_STEAMER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_STEAMER_ACCESSORIES" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DISH_WASHER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DISH_WASHER_CUTLERY_TRAY" "DEVICE_TYPE_KITCHEN_EQUIPMENT_HOB" "DEVICE_TYPE_KITCHEN_EQUIPMENT_INDUCTION_HOB" "DEVICE_TYPE_KITCHEN_EQUIPMENT_GLASS_CERAMIC_HOB" "DEVICE_TYPE_KITCHEN_EQUIPMENT_HOT_PLATES_HOB" "DEVICE_TYPE_KITCHEN_EQUIPMENT_GAS_HOB" "DEVICE_TYPE_KITCHEN_EQUIPMENT_MINOR_KITCHEN" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FURNITURE" "DEVICE_TYPE_KITCHEN_EQUIPMENT_MICROWAVE" "DEVICE_TYPE_KITCHEN_EQUIPMENT_STOVE_WITH_OVEN" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FILTER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_CARBON_FILTER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_ALUMINIUM_FILTER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DRYER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COMBINATION_FURNITURE" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COVER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_SEALING" "DEVICE_TYPE_KITCHEN_EQUIPMENT_VENTILATION_GRILLE" "DEVICE_TYPE_KITCHEN_EQUIPMENT" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COVER_CHROME_STEEL" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COVER_GRANITE" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COVER_GLASS" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COVER_SYNTHETIC_RESIN" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COVER_WOODEN" "DEVICE_TYPE_KITCHEN_EQUIPMENT_TOP_CABINET" "DEVICE_TYPE_KITCHEN_EQUIPMENT_TOP_CABINET_HIGH_GLOSS" "DEVICE_TYPE_KITCHEN_EQUIPMENT_TOP_CABINET_WOOD" "DEVICE_TYPE_KITCHEN_EQUIPMENT_UNDER_CABINET" "DEVICE_TYPE_KITCHEN_EQUIPMENT_UNDER_CABINET_HIGH_GLOSS" "DEVICE_TYPE_KITCHEN_EQUIPMENT_UNDER_CABINET_WOOD" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DRAWER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DRAWER_WITH_CUTLERY" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DRAWER_WITH_BOTTLE_HOLDER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DRAWER_WITH_SLIPS_MAT" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FLUSHING_BASIN" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FLUSHING_BASIN_CHROME_STEEL" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FLUSHING_BASIN_PLASTIC" "DEVICE_TYPE_OTHER_SANITARY" "DEVICE_TYPE_ELEVATOR_HANDICAP_LIFT" "DEVICE_TYPE_ELEVATOR_BED_LIFT" "DEVICE_TYPE_ELEVATOR" "DEVICE_TYPE_ELEVATOR_MERCHANDISE_LIFT" "DEVICE_TYPE_MOVING_STAIRCASE" "DEVICE_TYPE_FACADE_CLEANING" "DEVICE_TYPE_GOODS_CONVEYING_OTHER" "DEVICE_TYPE_GOODS_CONVEYING_PNEUMATIC_TUBE" "DEVICE_TYPE_GOODS_CONVEYING_FILE_LIFT" "DEVICE_TYPE_GOODS_CONVEYING" "DEVICE_TYPE_LIFTING" "DEVICE_TYPE_PARKING" "DEVICE_TYPE_TRANSPORT_OTHER" "DEVICE_TYPE_PLASTERER" "DEVICE_TYPE_METAL" "DEVICE_TYPE_METAL_CAR_SHELTER" "DEVICE_TYPE_METAL_MAILBOX" "DEVICE_TYPE_METAL_BALCONY_ENLARGEMENT" "DEVICE_TYPE_CARPENTER_SCREED_EXTENSION_LADDER" "DEVICE_TYPE_CARPENTER_CELLAR_DOOR" "DEVICE_TYPE_CARPENTER_APARTMENT_DOOR" "DEVICE_TYPE_CARPENTER_DOOR" "DEVICE_TYPE_CARPENTER_DOOR_FRAME" "DEVICE_TYPE_CARPENTER_LOCKS" "DEVICE_TYPE_CARPENTER_BUILT_IN_CLOSETS" "DEVICE_TYPE_CARPENTER_SLIDING_DOOR" "DEVICE_TYPE_CARPENTER" "DEVICE_TYPE_CARPENTER_DOOR_WOODEN" "DEVICE_TYPE_CARPENTER_DOOR_WOOD_MATERIAL" "DEVICE_TYPE_CARPENTER_DOOR_METAL" "DEVICE_TYPE_CARPENTER_DOOR_FRAME_WOOD" "DEVICE_TYPE_CARPENTER_DOOR_FRAME_METAL_STONE" "DEVICE_TYPE_CARPENTER_DOOR_FRAME_METAL" "DEVICE_TYPE_CARPENTER_LOCKS_APARTMENT_DOOR" "DEVICE_TYPE_CARPENTER_LOCKS_ROOM_DOOR" "DEVICE_TYPE_CARPENTER_LOCKS_KITT_JOINT" "DEVICE_TYPE_CARPENTER_BUILT_IN_CLOSETS_CHANNELBOARDS" "DEVICE_TYPE_CARPENTER_BUILT_IN_CLOSETS_WOODEN" "DEVICE_TYPE_CARPENTER_BUILT_IN_CLOSETS_HIGH_GLOSS" "DEVICE_TYPE_CARPENTER_SLIDING_DOOR_WOODEN_MATERIAL" "DEVICE_TYPE_CARPENTER_SLIDING_DOOR_ROLLS" "DEVICE_TYPE_CARPENTER_DOOR_FRAME_COLOR_OIL" "DEVICE_TYPE_CARPENTER_GLASS_INSERT_DOOR" "DEVICE_TYPE_CARPENTER_FITTINGS_FOR_DOOR" "DEVICE_TYPE_CARPENTER_RUBBER_SEALS_DOOR" "DEVICE_TYPE_CARPENTER_SHELF" "DEVICE_TYPE_CARPENTER_SHELF_WOOD" "DEVICE_TYPE_CARPENTER_SHELF_METAL" "DEVICE_TYPE_CARPENTER_CLOSET" "DEVICE_TYPE_CARPENTER_CLOSET_WOOD" "DEVICE_TYPE_CARPENTER_CLOSET_METAL" "DEVICE_TYPE_WINDOW_DOUBLE_GLAZING" "DEVICE_TYPE_WINDOW_INSULATING_GLAZING" "DEVICE_TYPE_WINDOW_FITTINGS" "DEVICE_TYPE_WINDOW_WINDOW_FRAME" "DEVICE_TYPE_WINDOW_SPECIAL_GLAZING" "DEVICE_TYPE_WINDOW_WINDOW_SILL" "DEVICE_TYPE_WINDOW" "DEVICE_TYPE_WINDOW_DOUBLE" "DEVICE_TYPE_WINDOW_TRIPLE" "DEVICE_TYPE_WINDOW_WINDOW_SILL_WOOD" "DEVICE_TYPE_WINDOW_WINDOW_SILL_WOOD_PAINTED" "DEVICE_TYPE_WINDOW_WINDOW_SILL_TILES" "DEVICE_TYPE_WINDOW_WINDOW_SILL_STONE" "DEVICE_TYPE_LOCKING_LOCK" "DEVICE_TYPE_LOCKING_KEY" "DEVICE_TYPE_LOCKING_WIRELESS_TRANSMITTER" "DEVICE_TYPE_LOCKING" "DEVICE_TYPE_INTERIOR_FINISHES" "DEVICE_TYPE_ELEMENT_WALL" "DEVICE_TYPE_CHROME_STEEP_FINISH" "DEVICE_TYPE_OTHER_INTERIOR1" "DEVICE_TYPE_FLOORING_COVERING" "DEVICE_TYPE_FLOORING_BALL_YARN" "DEVICE_TYPE_FLOORING_LAMINATE" "DEVICE_TYPE_FLOORING_LINOLEUM" "DEVICE_TYPE_FLOORING_VINYL" "DEVICE_TYPE_FLOORING_DIRT_TRAP_CARPET" "DEVICE_TYPE_FLOORING_PARQUET" "DEVICE_TYPE_FLOORING_PARQUET_SEALING" "DEVICE_TYPE_FLOORING_FLOOR_UNDERLAY" "DEVICE_TYPE_FLOORING_INSTALLATION_FLOOR" "DEVICE_TYPE_FLOORING_TILES" "DEVICE_TYPE_FLOORING_CARPET" "DEVICE_TYPE_FLOORING_SKIRTING" "DEVICE_TYPE_FLOORING_JOINT" "DEVICE_TYPE_FLOORING" "DEVICE_TYPE_FLOORING_PVC" "DEVICE_TYPE_FLOORING_RUBBER" "DEVICE_TYPE_FLOORING_CORK" "DEVICE_TYPE_FLOORING_LAMINATE_MEDIUM_QUALITY" "DEVICE_TYPE_FLOORING_LAMINATE_HIGH_QUALITY" "DEVICE_TYPE_FLOORING_TILES_SOUND_PLATES" "DEVICE_TYPE_FLOORING_TILES_NATURAL_STONE_SOFT" "DEVICE_TYPE_FLOORING_TILES_NATURAL_STONE_HARD" "DEVICE_TYPE_FLOORING_TILES_CERAMIC" "DEVICE_TYPE_FLOORING_TILES_STONEWARE" "DEVICE_TYPE_FLOORING_TILES_ARTIFICIAL_STONE" "DEVICE_TYPE_FLOORING_PARQUET_ADHESIVE" "DEVICE_TYPE_FLOORING_PARQUET_HARDWOOD" "DEVICE_TYPE_FLOORING_PARQUET_SOFTWOOD" "DEVICE_TYPE_FLOORING_PARQUET_FOURNIER" "DEVICE_TYPE_FLOORING_CARPET_NATURAL_FIBER" "DEVICE_TYPE_FLOORING_CARPET_BALL_YARN" "DEVICE_TYPE_FLOORING_CARPET_NEEDLE_FELT" "DEVICE_TYPE_FLOORING_CARPET_MEDIUM_QUALITY" "DEVICE_TYPE_FLOORING_SKIRTING_PLASTIC" "DEVICE_TYPE_FLOORING_SKIRTING_WOOD" "DEVICE_TYPE_FLOORING_RAW" "DEVICE_TYPE_FLOORING_COATED" "DEVICE_TYPE_WALL_COVERING_WORK" "DEVICE_TYPE_WALL_COVERING_WALLPAPER" "DEVICE_TYPE_WALL_COVERING_PLASTER" "DEVICE_TYPE_WALL_COVERING_ABRASION" "DEVICE_TYPE_WALL_COVERING_WOOD_WORKER" "DEVICE_TYPE_WALL_COVERING" "DEVICE_TYPE_WALL_COVERING_WALLPAPER_MEDIUM_QUALITY" "DEVICE_TYPE_WALL_COVERING_WALLPAPER_GOOD_QUALITY" "DEVICE_TYPE_WALL_COVERING_WALLPAPER_GLASS_FIBER" "DEVICE_TYPE_WALL_COVERING_PLASTER_GLUE_COLOR" "DEVICE_TYPE_WALL_COVERING_PLASTER_ACRYL" "DEVICE_TYPE_WALL_COVERING_PLASTER_MINERALS" "DEVICE_TYPE_WALL_COVERING_PLASTER_PLASTIC" "DEVICE_TYPE_WALL_COVERING_PLASTER_SILICATE_COATING" "DEVICE_TYPE_WALL_COVERING_PLASTER_DISPERSION_PAINT" "DEVICE_TYPE_WALL_COVERING_ABRASION_PLASTIC" "DEVICE_TYPE_WALL_COVERING_ABRASION_ROUGH_PUTT" "DEVICE_TYPE_WALL_COVERING_ABRASION_WHITE_PLASTER" "DEVICE_TYPE_WALL_COVERING_WOOD_WORKER_WALL_ROUGH" "DEVICE_TYPE_WALL_COVERING_WOOD_WORKER_LASED" "DEVICE_TYPE_WALL_COVERING_WOOD_WORKER_PAINTED_OPAQUE" "DEVICE_TYPE_WALL_COVERING_WOOD_WORKER_GLAZE" "DEVICE_TYPE_WALL_COVERING_CERAMIC" "DEVICE_TYPE_WALL_COVERING_STONEWORK" "DEVICE_TYPE_WALL_COVERING_STONEWARE" "DEVICE_TYPE_WALL_COVERING_TILES" "DEVICE_TYPE_CEILING_WORK" "DEVICE_TYPE_CEILING_WALLPAPER" "DEVICE_TYPE_CEILING_PLASTER" "DEVICE_TYPE_CEILING_ABRASION" "DEVICE_TYPE_CEILING_WOOD_WORKER" "DEVICE_TYPE_CEILING" "DEVICE_TYPE_CEILING_REGULAR" "DEVICE_TYPE_CEILING_REGULAR_METAL" "DEVICE_TYPE_CEILING_REGULAR_WOOD" "DEVICE_TYPE_CEILING_COVERING_ABRASION_PLASTIC" "DEVICE_TYPE_CEILING_COVERING_ABRASION_ROUGH_PUTT" "DEVICE_TYPE_CEILING_COVERING_ABRASION_WHITE_PLASTER" "DEVICE_TYPE_INTERIOR_SURFACE_TREATMENTS_PAINTING" "DEVICE_TYPE_OTHER_INTERIOR2_SHUTTER" "DEVICE_TYPE_OTHER_INTERIOR2_SHUTTER_MOTOR" "DEVICE_TYPE_OTHER_INTERIOR2_BLADE" "DEVICE_TYPE_OTHER_INTERIOR2_BLIND" "DEVICE_TYPE_OTHER_INTERIOR2_LETTER_BOX" "DEVICE_TYPE_OTHER_INTERIOR2" "DEVICE_TYPE_OTHER_INTERIOR2_SETS" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_SOAP_HOLDER" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_TOOTH_GLASS" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_GLASS_SHELF" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_TOWEL_BARS" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_HOLDING_RACK" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_CURTAIN_ROD" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_PACKAGE" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_WASHBASIN_BOWL" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_BATH_TOWEL_HOLDER" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_BATH_TOWEL_HOLDER_CHROME_STEEL" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_BATH_TOWEL_HOLDER_PLASTIC" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_BATH_TOWEL_HOLDER_HOOK" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_PAPER_HOLDER" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_PAPER_HOLDER_CHROME_STEEL" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_PAPER_HOLDER_PLASTIC" "DEVICE_TYPE_OTHER_INTERIOR2_ARMATURE" "DEVICE_TYPE_OTHER_INTERIOR2_ARMATURE_SINGLE_LEVER" "DEVICE_TYPE_OTHER_INTERIOR2_DOUBLE_LEVER" "DEVICE_TYPE_OTHER_INTERIOR2_ARMATURE_SWIVEL" "DEVICE_TYPE_OTHER_INTERIOR2_ARMATURE_PULL_OUT_SPRAY" "DEVICE_TYPE_OTHER_INTERIOR2_ARMATURE_THERMAL_MIXER" "DEVICE_TYPE_OTHER_INTERIOR2_OPERATING_GARNITURE" "DEVICE_TYPE_OTHER_INTERIOR2_CRANK" "DEVICE_TYPE_OTHER_INTERIOR2_BELT" "DEVICE_TYPE_OTHER_INTERIOR2_ELECTRIC" "DEVICE_TYPE_OTHER_TRANSPORT_CONTAINER" "DEVICE_TYPE_OTHER_TRANSPORT_CONTAINER_PLASTIC_GREEN" "DEVICE_TYPE_OTHER_TRANSPORT_CONTAINER_PLASTIC_BLACK" "DEVICE_TYPE_OTHER_TRANSPORT_CONTAINER_METAL" "DEVICE_TYPE_GARDENING_TRANSITION_POSITION_OUTDOOR_PARKING" "DEVICE_TYPE_GARDENING_TRANSITION_POSITION_PLANTING" "DEVICE_TYPE_GARDENING_TRANSITION_POSITION_GROUND_MARKING" "DEVICE_TYPE_GARDENING_TRANSITION_POSITION_CONTAINER_SITE" "DEVICE_TYPE_GARDENING_TRANSITION_POSITION_BIKE_SHELTER" "DEVICE_TYPE_GARDENING_TRANSITION_POSITION_ACCESS_PATH" "DEVICE_TYPE_GARDENING_FENCE" "DEVICE_TYPE_GARDENING_WALLS" "DEVICE_TYPE_GARDENING_CEMENT_BOARD" "DEVICE_TYPE_GARDENING_ACCESS_PATH" "DEVICE_TYPE_GARDENING_LAWN" "DEVICE_TYPE_GARDENING" "DEVICE_TYPE_FENCING" "DEVICE_TYPE_SUPERSTRUCTURE_TERRANCE" "DEVICE_TYPE_SUPERSTRUCTURE_BIKE_STAND" "DEVICE_TYPE_SUPERSTRUCTURE" "DEVICE_TYPE_SUPERSTRUCTURE_RAILING" "DEVICE_TYPE_SUPERSTRUCTURE_RAILING_SAFETY_GLASS" "DEVICE_TYPE_SUPERSTRUCTURE_RAILING_METAL" "DEVICE_TYPE_SUPERSTRUCTURE_RAILING_CHROME_STEEL" "DEVICE_TYPE_SUPERSTRUCTURE_RAILING_CONCRETE" "DEVICE_TYPE_PLAYGROUND" "DEVICE_TYPE_PLAYGROUND_DEVICE" "DEVICE_TYPE_GARDEN_OTHER" "DEVICE_TYPE_DEVICE_TRANSITION_POSITION_FIRE_EXTINGUISHER" "DEVICE_TYPE_DEVICE_TRANSITION_POSITION_LAWN_MOWER" "DEVICE_TYPE_DEVICE_TRANSITION_POSITION_SECURITY_CAMERA" "DEVICE_TYPE_DEVICE_TRANSITION_POSITION_INDOOR_BIKE_SHELTER" "DEVICE_TYPE_AIR_COMPRESSOR" "DEVICE_TYPE_GAS_SYSTEM_LABORATORY" "DEVICE_TYPE_HOIST_CRANE" "DEVICE_TYPE_HEATING_DISTRIBUTOR" "DEVICE_TYPE_INTERIOR_METAL_DOORS" "DEVICE_TYPE_INTERIOR_METAL_BALCONY_GLAZING" "DEVICE_TYPE_REFRIGERATING_MACHINE" "DEVICE_TYPE_REFRIGERATED_CEILING" "DEVICE_TYPE_COOLING_DISTRIBUTOR" "DEVICE_TYPE_VENTILATION_MONOBLOCK" "DEVICE_TYPE_NEUTRALIZATION_SYSTEM" "DEVICE_TYPE_PURE_WATER_SYSTEM" "DEVICE_TYPE_WATER_SYSTEM_SEPARATOR" "DEVICE_TYPE_RECIRCULATING_AIR_COOLING_UNIT" "DEVICE_TYPE_RECIRCULATING_AIR_COOLER" "DEVICE_TYPE_STAIR" "DEVICE_TYPE_WARDROBE" "DEVICE_TYPE_COAT_HOOKS" "DEVICE_TYPE_GATE" "DEVICE_TYPE_CURTAIN_RAIL" "DEVICE_TYPE_FURNITURE_BEDROOM_BED" "DEVICE_TYPE_FURNITURE_BEDROOM_BEDSIDE_TABLE" "DEVICE_TYPE_FURNITURE_BEDROOM_DRESSER" "DEVICE_TYPE_FURNITURE_BEDROOM_WARDROBE" "DEVICE_TYPE_FURNITURE_LIVING_ROOM_TABLE" "DEVICE_TYPE_FURNITURE_LIVING_ROOM_DINING_TABLE" "DEVICE_TYPE_FURNITURE_OFFICE_DESK" "DEVICE_TYPE_FURNITURE_OFFICE_CHAIR" "DEVICE_TYPE_FURNITURE_OFFICE_STOOL" "DEVICE_TYPE_FURNITURE_LIVING_ROOM_CHAIR" "DEVICE_TYPE_FURNITURE_LIVING_ROOM_ARMCHAIR" "DEVICE_TYPE_FURNITURE_BEDROOM_MATTRESS" "DEVICE_TYPE_FURNITURE_LIVING_ROOM_SOFA" "DEVICE_TYPE_ELECTRONICS_ENTERTAINMENT_TELEVISION" "DEVICE_TYPE_ELECTRONICS_ENTERTAINMENT_REMOTE_CONTROL" "DEVICE_TYPE_TEXTILES_BEDROOM_BED_LINEN" "DEVICE_TYPE_TEXTILES_BATHROOM_TOWELS" "DEVICE_TYPE_DECORATION_WALL_DECORATION_PICTURE" "DEVICE_TYPE_DECORATION_BATHROOM_WALL_MIRROR" "DEVICE_TYPE_HOUSEHOLD_GOODS_BATHROOM_LAUNDRY_BASKET" "DEVICE_TYPE_HOUSEHOLD_GOODS_OFFICE_WASTE_PAPER_BASKET" "DEVICE_TYPE_HOUSEHOLD_GOODS_KITCHEN_DISHES" "DEVICE_TYPE_OUTER_FINISHES_HAIL_PROTECTION" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_FIRE_ALARM_SYSTEM" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_EMERGENCY_LIGHT" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_ALARM_NET" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_ZEV_METER" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_ELECTRICITY_METER" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_CONTROL_UNIT" "DEVICE_TYPE_CARPENTER_HALLWAY_WARDROBE" "DEVICE_TYPE_SUPERSTRUCTURE_OUTDOOR_SEATING_AREA" "DEVICE_TYPE_MEDICAL_DEVICES_DEFIBRILLATOR_AED" "DEVICE_TYPE_ELECTRONICS_DESIGN_TABLET" "DEVICE_TYPE_LABELS_MARKINGS_SIGNAGE" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_MODEM_ROUTER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_REFRIGERATOR_ACCESSORIES_EGG_CONTAINER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FREEZER_ACCESSORIES_ICE_CUBE_TRAY" "DEVICE_TYPE_KITCHEN_EQUIPMENT_COMBI_STEAMER" "DEVICE_TYPE_LOCKING_CARD_READER" "DEVICE_TYPE_ENERGY_SUPPLY_GAS_METER" "DEVICE_TYPE_COOLING_ENERGY_METER" "DEVICE_TYPE_OTHER_INTERIOR1_COIN_COUNTER" "DEVICE_TYPE_HEAT_GENERATION_HEAT_TRACING" "DEVICE_TYPE_OTHER_SANITARY_SPRINKLER_SYSTEM" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_WATER_FILTER" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_WATER_METER" "DEVICE_TYPE_CIRCULATION_PUMP"
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

unit
required
string (objectdeviceDeviceUnit)
Default: "DEVICE_UNIT_UNDEFINED"
Enum: "DEVICE_UNIT_UNDEFINED" "DEVICE_UNIT_L" "DEVICE_UNIT_KG" "DEVICE_UNIT_M2" "DEVICE_UNIT_M3" "DEVICE_UNIT_PCS" "DEVICE_UNIT_M" "DEVICE_UNIT_FLAT_RATE"
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

Responses

Request samples

Content type
application/json
{
  • "acquisitionCosts": 0.1,
  • "amount": 0,
  • "assetNumberFm": "string",
  • "bkpH": "string",
  • "brand": "string",
  • "cataloguePrice": 0.1,
  • "condition": "DEVICE_CONDITION_UNDEFINED",
  • "conditionNote": "string",
  • "documentIds": [
    ],
  • "facilityPlant": "DEVICE_FACILITY_PLANT_UNDEFINED",
  • "images": [
    ],
  • "inspection": {
    },
  • "installation": {
    },
  • "lifeSpan": 0,
  • "lockingKey": {
    },
  • "maintenance": {
    },
  • "manufacturer": "string",
  • "measure": "DEVICE_MEASURE_UNDEFINED",
  • "measureUntil": {
    },
  • "model": "string",
  • "note": "string",
  • "order": 0,
  • "ownerId": "string",
  • "referenceId": "string",
  • "revision": {
    },
  • "roomId": "string",
  • "serialNumber": "string",
  • "system": "DEVICE_SYSTEM_UNDEFINED",
  • "type": "DEVICE_TYPE_UNDEFINED",
  • "uninstallation": {
    },
  • "unit": "DEVICE_UNIT_UNDEFINED",
  • "warrantyEnd": {
    }
}

Response samples

Content type
application/json
{
  • "device": {
    }
}

Get default device data

Returns default data entries (facility plant, system, bkpH, catalogue price, unit, life span) for the optional device type, or for all device types when type is omitted.

query Parameters
type
string
Default: "DEVICE_TYPE_UNDEFINED"
Enum: "DEVICE_TYPE_UNDEFINED" "DEVICE_TYPE_MASTER_BUILDER_WORK_DOWN_PIPES" "DEVICE_TYPE_MASTER_BUILDER_WORK_BASIC_LINE" "DEVICE_TYPE_MASTER_BUILDER_WORK_DRAINAGE_LINE" "DEVICE_TYPE_MASTER_BUILDER_WORK_PUMP_CHAMBER" "DEVICE_TYPE_MASTER_BUILDER_WORK_TERRACE_DRAIN" "DEVICE_TYPE_WINDOW_DOOR_AUTOMATIC_SLIDING_DOOR" "DEVICE_TYPE_WINDOW_DOOR_EXTERIOR_DOOR" "DEVICE_TYPE_WINDOW_DOOR_FIRE_GATE" "DEVICE_TYPE_WINDOW_DOOR_ROOF_WINDOW" "DEVICE_TYPE_WINDOW_DOOR_WINDOW" "DEVICE_TYPE_WINDOW_DOOR_GATE_DRIVE" "DEVICE_TYPE_WINDOW_DOOR_GARAGE_DOOR" "DEVICE_TYPE_WINDOW_DOOR_DOOR_AUTOMATION" "DEVICE_TYPE_WINDOW_DOOR_EXTERIOR_DOOR_SOLID_WOOD" "DEVICE_TYPE_WINDOW_DOOR_EXTERIOR_DOOR_WOOD_MATERIAL" "DEVICE_TYPE_WINDOW_DOOR_EXTERIOR_DOOR_METAL" "DEVICE_TYPE_WINDOW_DOOR_WINDOW_WOOD_DOUBLE_GLAZING" "DEVICE_TYPE_WINDOW_DOOR_WINDOW_PLASTIC" "DEVICE_TYPE_WINDOW_DOOR_WINDOW_WOOD" "DEVICE_TYPE_WINDOW_DOOR_WINDOW_WOOD_METAL" "DEVICE_TYPE_WINDOW_DOOR_WINDOW_METAL" "DEVICE_TYPE_ROOFING_PENT_ROOF" "DEVICE_TYPE_ROOFING_SADDLE_ROOF" "DEVICE_TYPE_ROOFING_TERRACE" "DEVICE_TYPE_ROOFING_HIPPED_ROOF" "DEVICE_TYPE_ROOFING_TENT_ROOF" "DEVICE_TYPE_ROOFING_FLAT_ROOF" "DEVICE_TYPE_ROOFING_SHEARING_ROOF" "DEVICE_TYPE_ROOFING_FRONT_PANEL" "DEVICE_TYPE_SEALING_INSULATION_FACADE" "DEVICE_TYPE_SEALING_INSULATION_INTERIOR" "DEVICE_TYPE_SEALING_INSULATION_FACADE_WOOD" "DEVICE_TYPE_SEALING_INSULATION_FACADE_PLATES" "DEVICE_TYPE_SEALING_INSULATION_FACADE_ETERNIT" "DEVICE_TYPE_FACADE_PLASTER_PAINTING" "DEVICE_TYPE_FACADE_PLASTER" "DEVICE_TYPE_OUTER_FINISHES_FOLDING_SHUTTERS" "DEVICE_TYPE_OUTER_FINISHES_SHUTTERS" "DEVICE_TYPE_OUTER_FINISHES_SUN_BLINDS" "DEVICE_TYPE_OUTER_FINISHES_SUN_BLINDS_VOLANT" "DEVICE_TYPE_OUTER_FINISHES_GLARE_PROTECTION" "DEVICE_TYPE_OUTER_FINISHES_SHUTTERS_WOOD" "DEVICE_TYPE_OUTER_FINISHES_SHUTTERS_METAL" "DEVICE_TYPE_OUTER_FINISHES_SLAT_TOWERS" "DEVICE_TYPE_OUTER_FINISHES_SLAT_TOWERS_OUTSIDE_ALUMINIUM" "DEVICE_TYPE_OUTER_FINISHES_SLAT_TOWERS_INSIDE" "DEVICE_TYPE_OUTER_FINISHES_BLIND_SHOPS" "DEVICE_TYPE_OUTER_FINISHES_BLIND_SHOPS_WOOD" "DEVICE_TYPE_OUTER_FINISHES_BLIND_SHOPS_METAL" "DEVICE_TYPE_OUTER_FINISHES" "DEVICE_TYPE_OUTER_FINISHES_PRIVACY_SCREEN" "DEVICE_TYPE_OUTER_FINISHES_PRIVACY_SCREEN_GLASS" "DEVICE_TYPE_OUTER_FINISHES_PRIVACY_SCREEN_WOOD" "DEVICE_TYPE_OUTER_FINISHES_PRIVACY_SCREEN_METAL" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_LIGHTING" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_CO2" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_SINA" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_SMOKE_VENT" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_PROOF_OF_SAFETY_SINA" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_SWITCHGEAR_COMBINATION" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_PHOTOVOLTAIC" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_LOW_VOLTAGE_SYSTEM" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_CABLE" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_SWITCH" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_SWITCHBOARD" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_SOCKET" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_UPS" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_INFRASTRUCTURE_ELECTRIC_CHARGING" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_ELECTRIC_CHARGING_STATION" "DEVICE_TYPE_LIGHTS_ILLUMINANT" "DEVICE_TYPE_LIGHTS" "DEVICE_TYPE_LIGHTS_CEILING" "DEVICE_TYPE_LIGHTS_CABINET" "DEVICE_TYPE_LIGHTS_SPOTS" "DEVICE_TYPE_LIGHTS_MIRROR_CABINET" "DEVICE_TYPE_TELEPHONE_CENTER" "DEVICE_TYPE_TELEPHONE_DISTRIBUTOR" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_INTERCOM" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_INTERCOM_VIDEO" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_BELL" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_DOOR_OPENER" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_FIBERGLASS" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_EMERGENCY_PHONE_LIFT" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_INTERPHONE" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_MULTIMEDIA" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_INTRUSION_DETECTION" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_ISDN" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_CABLE" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_SWITCH" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_SWITCHBOARD" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_SOCKET" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_TV_ANTENNA" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_TV_CABLE" "DEVICE_TYPE_OTHER_ELECTRICITY_BATTERY" "DEVICE_TYPE_OTHER_ELECTRICITY_OTHER" "DEVICE_TYPE_OTHER_ELECTRICITY_LIGHTNING_PROTECTION" "DEVICE_TYPE_OTHER_ELECTRICITY" "DEVICE_TYPE_OTHER_ELECTRICITY_SOCKET" "DEVICE_TYPE_OTHER_ELECTRICITY_FUSEBOX" "DEVICE_TYPE_HEATING_TRANSITION_POSITION_ROOF_VENTILATION" "DEVICE_TYPE_HEATING_TRANSITION_POSITION_FILTER_REPLACEMENT" "DEVICE_TYPE_HEATING_TRANSITION_POSITION_AIR_CONDITIONING" "DEVICE_TYPE_HEATING_TRANSITION_POSITION_VENTILATION" "DEVICE_TYPE_ENERGY_SUPPLY_SUPPLY" "DEVICE_TYPE_ENERGY_SUPPLY_LEAKAGE_WARNING" "DEVICE_TYPE_ENERGY_SUPPLY_TANK" "DEVICE_TYPE_ENERGY_SUPPLY_STORAGE" "DEVICE_TYPE_ENERGY_SUPPLY_GAS_LINE" "DEVICE_TYPE_ENERGY_SUPPLY_FUEL_TANK_INSIDE" "DEVICE_TYPE_ENERGY_SUPPLY_FUEL_TANK_EARTH_LOADED" "DEVICE_TYPE_HEAT_GENERATION" "DEVICE_TYPE_HEAT_GENERATION_BOILER" "DEVICE_TYPE_HEAT_GENERATION_BURNER" "DEVICE_TYPE_HEAT_GENERATION_EARTH_PROBE" "DEVICE_TYPE_HEAT_GENERATION_ELECTRIC_STORAGE_STOVE" "DEVICE_TYPE_HEAT_GENERATION_EXPANSION_DEVICE" "DEVICE_TYPE_HEAT_GENERATION_DISTRICT_HEATING" "DEVICE_TYPE_HEAT_GENERATION_DISTRICT_HEATING_SUBSTATION" "DEVICE_TYPE_HEAT_GENERATION_HEATING_BOILER" "DEVICE_TYPE_HEAT_GENERATION_THERMAL_SOLAR_SYSTEM" "DEVICE_TYPE_HEAT_GENERATION_HEAT_EXCHANGER" "DEVICE_TYPE_HEAT_GENERATION_HEAT_PUMP" "DEVICE_TYPE_HEAT_GENERATION_FIREPLACE" "DEVICE_TYPE_HEAT_GENERATION_HEAT_ACCUMULATOR" "DEVICE_TYPE_HEAT_GENERATION_SINGLE_WATER_BOILER" "DEVICE_TYPE_HEAT_GENERATION_COMBIBOILER_HEATING" "DEVICE_TYPE_HEAT_GENERATION_ELECTRIC_BOILER" "DEVICE_TYPE_HEAT_GENERATION_BOILER_GAS_APPLIANCES" "DEVICE_TYPE_HEAT_GENERATION_COMBINED_BOILER" "DEVICE_TYPE_HEAT_GENERATION_SOLAR_PANELS" "DEVICE_TYPE_HEAT_GENERATION_RADIATORS" "DEVICE_TYPE_HEAT_GENERATION_RADIATORS_HEATWALLS" "DEVICE_TYPE_HEAT_GENERATION_TOWEL_RADIATORS" "DEVICE_TYPE_HEAT_GENERATION_FLOOR_HEATING" "DEVICE_TYPE_HEAT_GENERATION_HEATING_ELEMENT" "DEVICE_TYPE_HEAT_GENERATION_ELECTRIC_STOVE" "DEVICE_TYPE_HEAT_GENERATION_ROOF_HEATING" "DEVICE_TYPE_HEAT_DISTRIBUTION" "DEVICE_TYPE_HEAT_DISTRIBUTION_HEAT_METER" "DEVICE_TYPE_HEAT_DISTRIBUTION_CIRCULATING_PUMP" "DEVICE_TYPE_HEAT_DISTRIBUTION_HEAT_QUANTITY_FLOW_METERS" "DEVICE_TYPE_HEAT_DISTRIBUTION_HEATING_COST_ALLOCATOR" "DEVICE_TYPE_HEAT_DISTRIBUTION_FLOOR_HEATING" "DEVICE_TYPE_VENTILATION_VENTILATION_CONTROL_CENTER" "DEVICE_TYPE_VENTILATION_VENTILATION" "DEVICE_TYPE_VENTILATION_SUPPLY_AIR_FAN" "DEVICE_TYPE_VENTILATION_EXHAUST_AIR_FAN" "DEVICE_TYPE_VENTILATION_SMOKE_EXTRACTION_SYSTEM" "DEVICE_TYPE_VENTILATION" "DEVICE_TYPE_VENTILATION_CONTROLLED_HOME" "DEVICE_TYPE_VENTILATION_CHANNELS" "DEVICE_TYPE_AIR_CONDITIONING_RECOOLING" "DEVICE_TYPE_AIR_CONDITIONING" "DEVICE_TYPE_AIR_CONDITIONING_INDIVIDUAL_ROOMS" "DEVICE_TYPE_COOLING_CHILLERS" "DEVICE_TYPE_COOLING_COLD_RESERVOIR" "DEVICE_TYPE_COOLING_COLD_WATER_TANK" "DEVICE_TYPE_COOLING_COLD_STORAGE_CELL" "DEVICE_TYPE_COOLING" "DEVICE_TYPE_SPECIAL_FACILITY" "DEVICE_TYPE_INSULATION" "DEVICE_TYPE_INSULATION_CHIMNEY" "DEVICE_TYPE_SPECIAL_FACILITY_MEASUREMENT_CONTROL_TECHNOLOGY_BUILDING_MANAGEMENT_SYSTEM" "DEVICE_TYPE_SPECIAL_FACILITY_MEASUREMENT_CONTROL_TECHNOLOGY_CONTROL_SYSTEM" "DEVICE_TYPE_SPECIAL_FACILITY_MEASUREMENT_CONTROL_TECHNOLOGY" "DEVICE_TYPE_SPECIAL_FACILITY_MEASUREMENT_CONTROL_TECHNOLOGY_VALVES" "DEVICE_TYPE_SANITARY_BATHTUB" "DEVICE_TYPE_SANITARY_RENOVATION" "DEVICE_TYPE_SANITARY_CONTROL_FITTINGS" "DEVICE_TYPE_SANITARY_WASHBASIN" "DEVICE_TYPE_SANITARY_WASHBASIN_CERAMIC" "DEVICE_TYPE_SANITARY_MIRROR_CABINET" "DEVICE_TYPE_SANITARY_BIDET" "DEVICE_TYPE_SANITARY_SHOWER" "DEVICE_TYPE_SANITARY_LAVABO" "DEVICE_TYPE_SANITARY_URINAL" "DEVICE_TYPE_SANITARY_FLUSH_TANK" "DEVICE_TYPE_SANITARY_TOILET" "DEVICE_TYPE_SANITARY_TOILET_CERAMIC" "DEVICE_TYPE_SANITARY_TOILET_CLOSOMAT" "DEVICE_TYPE_SANITARY_TOILET_COVER" "DEVICE_TYPE_SANITARY_TOILET_COVER_SOFT_CLOSE" "DEVICE_TYPE_SANITARY_BATHTUB_ACRYLIC" "DEVICE_TYPE_SANITARY_BATHTUB_STEEL" "DEVICE_TYPE_SANITARY_MIRROR_CABINET_PLASTIC" "DEVICE_TYPE_SANITARY_MIRROR_CABINET_WOODEN" "DEVICE_TYPE_SANITARY_MIRROR_CABINET_METAL" "DEVICE_TYPE_SANITARY_FLUSH_TANK_FLUSH_MOUNTED" "DEVICE_TYPE_SANITARY_FLUSH_TANK_PLASTIC" "DEVICE_TYPE_SANITARY_FLUSH_TANK_CERAMIC" "DEVICE_TYPE_SANITARY_LAVABO_TOILET_BIDET_URINAL" "DEVICE_TYPE_SANITARY_LAVABO_TOILET_BIDET_URINAL_CERAMIC" "DEVICE_TYPE_SANITARY_LAVABO_TOILET_BIDET_URINAL_CLOSOMAT" "DEVICE_TYPE_SANITARY_SHOWER_CABIN" "DEVICE_TYPE_SANITARY_SHOWER_CABIN_PLASTIC" "DEVICE_TYPE_SANITARY_SHOWER_CABIN_GLASWALLS" "DEVICE_TYPE_SPECIAL_SANITARY_WATER_SOFTENER" "DEVICE_TYPE_SPECIAL_SANITARY_LIMESCALE_PROTECTION" "DEVICE_TYPE_SPECIAL_SANITARY_DEHUMIDIFIER" "DEVICE_TYPE_SPECIAL_SANITARY_WASHING_MACHINE" "DEVICE_TYPE_SPECIAL_SANITARY_COMBI_WASHER_DRYER" "DEVICE_TYPE_SPECIAL_SANITARY_WASHING_ELECTRICITY_METER" "DEVICE_TYPE_SPECIAL_SANITARY_TUMBLER" "DEVICE_TYPE_SPECIAL_SANITARY_VACUUM_DEGASSING_DEVICE" "DEVICE_TYPE_SPECIAL_SANITARY" "DEVICE_TYPE_SPECIAL_SANITARY_WATER_TAP" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_SUPPLY" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_DISPOSAL" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_WATER_TREATMENT" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_SEWAGE_PUMP" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_WATER_DISTRIBUTION_BATTERY" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_SEWAGE_TANK" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_PIPING_COLD_WATER" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_FINE_FILTER" "DEVICE_TYPE_SANITARY_PIPING_RAIN_WATER" "DEVICE_TYPE_SANITARY_PIPING_WARM_WATER" "DEVICE_TYPE_SANITARY_PIPING" "DEVICE_TYPE_SANITARY_INSULATION" "DEVICE_TYPE_SANITARY_EQUIPMENT_MIRROR_CABINETS" "DEVICE_TYPE_SANITARY_EQUIPMENT_MIRROR_CABINETS_ONE_DOOR" "DEVICE_TYPE_SANITARY_EQUIPMENT_MIRROR_CABINETS_TWO_DOOR" "DEVICE_TYPE_SANITARY_EQUIPMENT_MIRROR" "DEVICE_TYPE_SANITARY_EQUIPMENT_BATHROOM_FURNITURE" "DEVICE_TYPE_SANITARY_EQUIPMENT_SHOWER_CABIN" "DEVICE_TYPE_SANITARY_EQUIPMENT" "DEVICE_TYPE_SANITARY_SHOWER_HEAD_HOSE" "DEVICE_TYPE_SANITARY_SHOWER_ROD" "DEVICE_TYPE_SANITARY_SHOWER_ROD_CHROME_STEEL" "DEVICE_TYPE_SANITARY_SHOWER_HEAD_HOLDER" "DEVICE_TYPE_ELECTRIC_PNEUMATIC_BOARD" "DEVICE_TYPE_KITCHEN_EQUIPMENT_REFRIGERATOR" "DEVICE_TYPE_KITCHEN_EQUIPMENT_REFRIGERATOR_ACCESSORIES" "DEVICE_TYPE_KITCHEN_EQUIPMENT_REFRIGERATOR_ACCESSORIES_COMPARTMENT" "DEVICE_TYPE_KITCHEN_EQUIPMENT_WASTE" "DEVICE_TYPE_KITCHEN_EQUIPMENT_WASTE_SEPARATING_SYSTEM" "DEVICE_TYPE_KITCHEN_EQUIPMENT_WASTE_HOLDER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FREEZER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_OVEN" "DEVICE_TYPE_KITCHEN_EQUIPMENT_OVEN_ACCESSORIES" "DEVICE_TYPE_KITCHEN_EQUIPMENT_OVEN_ACCESSORIES_BLECH" "DEVICE_TYPE_KITCHEN_EQUIPMENT_OVEN_ACCESSORIES_GRID" "DEVICE_TYPE_KITCHEN_EQUIPMENT_OVEN_ACCESSORIES_THERMOMETER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_OVEN_ACCESSORIES_GRILL" "DEVICE_TYPE_KITCHEN_EQUIPMENT_STEAM_EXHAUST_HOOD" "DEVICE_TYPE_KITCHEN_EQUIPMENT_STEAMER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_STEAMER_ACCESSORIES" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DISH_WASHER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DISH_WASHER_CUTLERY_TRAY" "DEVICE_TYPE_KITCHEN_EQUIPMENT_HOB" "DEVICE_TYPE_KITCHEN_EQUIPMENT_INDUCTION_HOB" "DEVICE_TYPE_KITCHEN_EQUIPMENT_GLASS_CERAMIC_HOB" "DEVICE_TYPE_KITCHEN_EQUIPMENT_HOT_PLATES_HOB" "DEVICE_TYPE_KITCHEN_EQUIPMENT_GAS_HOB" "DEVICE_TYPE_KITCHEN_EQUIPMENT_MINOR_KITCHEN" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FURNITURE" "DEVICE_TYPE_KITCHEN_EQUIPMENT_MICROWAVE" "DEVICE_TYPE_KITCHEN_EQUIPMENT_STOVE_WITH_OVEN" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FILTER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_CARBON_FILTER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_ALUMINIUM_FILTER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DRYER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COMBINATION_FURNITURE" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COVER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_SEALING" "DEVICE_TYPE_KITCHEN_EQUIPMENT_VENTILATION_GRILLE" "DEVICE_TYPE_KITCHEN_EQUIPMENT" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COVER_CHROME_STEEL" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COVER_GRANITE" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COVER_GLASS" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COVER_SYNTHETIC_RESIN" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COVER_WOODEN" "DEVICE_TYPE_KITCHEN_EQUIPMENT_TOP_CABINET" "DEVICE_TYPE_KITCHEN_EQUIPMENT_TOP_CABINET_HIGH_GLOSS" "DEVICE_TYPE_KITCHEN_EQUIPMENT_TOP_CABINET_WOOD" "DEVICE_TYPE_KITCHEN_EQUIPMENT_UNDER_CABINET" "DEVICE_TYPE_KITCHEN_EQUIPMENT_UNDER_CABINET_HIGH_GLOSS" "DEVICE_TYPE_KITCHEN_EQUIPMENT_UNDER_CABINET_WOOD" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DRAWER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DRAWER_WITH_CUTLERY" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DRAWER_WITH_BOTTLE_HOLDER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DRAWER_WITH_SLIPS_MAT" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FLUSHING_BASIN" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FLUSHING_BASIN_CHROME_STEEL" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FLUSHING_BASIN_PLASTIC" "DEVICE_TYPE_OTHER_SANITARY" "DEVICE_TYPE_ELEVATOR_HANDICAP_LIFT" "DEVICE_TYPE_ELEVATOR_BED_LIFT" "DEVICE_TYPE_ELEVATOR" "DEVICE_TYPE_ELEVATOR_MERCHANDISE_LIFT" "DEVICE_TYPE_MOVING_STAIRCASE" "DEVICE_TYPE_FACADE_CLEANING" "DEVICE_TYPE_GOODS_CONVEYING_OTHER" "DEVICE_TYPE_GOODS_CONVEYING_PNEUMATIC_TUBE" "DEVICE_TYPE_GOODS_CONVEYING_FILE_LIFT" "DEVICE_TYPE_GOODS_CONVEYING" "DEVICE_TYPE_LIFTING" "DEVICE_TYPE_PARKING" "DEVICE_TYPE_TRANSPORT_OTHER" "DEVICE_TYPE_PLASTERER" "DEVICE_TYPE_METAL" "DEVICE_TYPE_METAL_CAR_SHELTER" "DEVICE_TYPE_METAL_MAILBOX" "DEVICE_TYPE_METAL_BALCONY_ENLARGEMENT" "DEVICE_TYPE_CARPENTER_SCREED_EXTENSION_LADDER" "DEVICE_TYPE_CARPENTER_CELLAR_DOOR" "DEVICE_TYPE_CARPENTER_APARTMENT_DOOR" "DEVICE_TYPE_CARPENTER_DOOR" "DEVICE_TYPE_CARPENTER_DOOR_FRAME" "DEVICE_TYPE_CARPENTER_LOCKS" "DEVICE_TYPE_CARPENTER_BUILT_IN_CLOSETS" "DEVICE_TYPE_CARPENTER_SLIDING_DOOR" "DEVICE_TYPE_CARPENTER" "DEVICE_TYPE_CARPENTER_DOOR_WOODEN" "DEVICE_TYPE_CARPENTER_DOOR_WOOD_MATERIAL" "DEVICE_TYPE_CARPENTER_DOOR_METAL" "DEVICE_TYPE_CARPENTER_DOOR_FRAME_WOOD" "DEVICE_TYPE_CARPENTER_DOOR_FRAME_METAL_STONE" "DEVICE_TYPE_CARPENTER_DOOR_FRAME_METAL" "DEVICE_TYPE_CARPENTER_LOCKS_APARTMENT_DOOR" "DEVICE_TYPE_CARPENTER_LOCKS_ROOM_DOOR" "DEVICE_TYPE_CARPENTER_LOCKS_KITT_JOINT" "DEVICE_TYPE_CARPENTER_BUILT_IN_CLOSETS_CHANNELBOARDS" "DEVICE_TYPE_CARPENTER_BUILT_IN_CLOSETS_WOODEN" "DEVICE_TYPE_CARPENTER_BUILT_IN_CLOSETS_HIGH_GLOSS" "DEVICE_TYPE_CARPENTER_SLIDING_DOOR_WOODEN_MATERIAL" "DEVICE_TYPE_CARPENTER_SLIDING_DOOR_ROLLS" "DEVICE_TYPE_CARPENTER_DOOR_FRAME_COLOR_OIL" "DEVICE_TYPE_CARPENTER_GLASS_INSERT_DOOR" "DEVICE_TYPE_CARPENTER_FITTINGS_FOR_DOOR" "DEVICE_TYPE_CARPENTER_RUBBER_SEALS_DOOR" "DEVICE_TYPE_CARPENTER_SHELF" "DEVICE_TYPE_CARPENTER_SHELF_WOOD" "DEVICE_TYPE_CARPENTER_SHELF_METAL" "DEVICE_TYPE_CARPENTER_CLOSET" "DEVICE_TYPE_CARPENTER_CLOSET_WOOD" "DEVICE_TYPE_CARPENTER_CLOSET_METAL" "DEVICE_TYPE_WINDOW_DOUBLE_GLAZING" "DEVICE_TYPE_WINDOW_INSULATING_GLAZING" "DEVICE_TYPE_WINDOW_FITTINGS" "DEVICE_TYPE_WINDOW_WINDOW_FRAME" "DEVICE_TYPE_WINDOW_SPECIAL_GLAZING" "DEVICE_TYPE_WINDOW_WINDOW_SILL" "DEVICE_TYPE_WINDOW" "DEVICE_TYPE_WINDOW_DOUBLE" "DEVICE_TYPE_WINDOW_TRIPLE" "DEVICE_TYPE_WINDOW_WINDOW_SILL_WOOD" "DEVICE_TYPE_WINDOW_WINDOW_SILL_WOOD_PAINTED" "DEVICE_TYPE_WINDOW_WINDOW_SILL_TILES" "DEVICE_TYPE_WINDOW_WINDOW_SILL_STONE" "DEVICE_TYPE_LOCKING_LOCK" "DEVICE_TYPE_LOCKING_KEY" "DEVICE_TYPE_LOCKING_WIRELESS_TRANSMITTER" "DEVICE_TYPE_LOCKING" "DEVICE_TYPE_INTERIOR_FINISHES" "DEVICE_TYPE_ELEMENT_WALL" "DEVICE_TYPE_CHROME_STEEP_FINISH" "DEVICE_TYPE_OTHER_INTERIOR1" "DEVICE_TYPE_FLOORING_COVERING" "DEVICE_TYPE_FLOORING_BALL_YARN" "DEVICE_TYPE_FLOORING_LAMINATE" "DEVICE_TYPE_FLOORING_LINOLEUM" "DEVICE_TYPE_FLOORING_VINYL" "DEVICE_TYPE_FLOORING_DIRT_TRAP_CARPET" "DEVICE_TYPE_FLOORING_PARQUET" "DEVICE_TYPE_FLOORING_PARQUET_SEALING" "DEVICE_TYPE_FLOORING_FLOOR_UNDERLAY" "DEVICE_TYPE_FLOORING_INSTALLATION_FLOOR" "DEVICE_TYPE_FLOORING_TILES" "DEVICE_TYPE_FLOORING_CARPET" "DEVICE_TYPE_FLOORING_SKIRTING" "DEVICE_TYPE_FLOORING_JOINT" "DEVICE_TYPE_FLOORING" "DEVICE_TYPE_FLOORING_PVC" "DEVICE_TYPE_FLOORING_RUBBER" "DEVICE_TYPE_FLOORING_CORK" "DEVICE_TYPE_FLOORING_LAMINATE_MEDIUM_QUALITY" "DEVICE_TYPE_FLOORING_LAMINATE_HIGH_QUALITY" "DEVICE_TYPE_FLOORING_TILES_SOUND_PLATES" "DEVICE_TYPE_FLOORING_TILES_NATURAL_STONE_SOFT" "DEVICE_TYPE_FLOORING_TILES_NATURAL_STONE_HARD" "DEVICE_TYPE_FLOORING_TILES_CERAMIC" "DEVICE_TYPE_FLOORING_TILES_STONEWARE" "DEVICE_TYPE_FLOORING_TILES_ARTIFICIAL_STONE" "DEVICE_TYPE_FLOORING_PARQUET_ADHESIVE" "DEVICE_TYPE_FLOORING_PARQUET_HARDWOOD" "DEVICE_TYPE_FLOORING_PARQUET_SOFTWOOD" "DEVICE_TYPE_FLOORING_PARQUET_FOURNIER" "DEVICE_TYPE_FLOORING_CARPET_NATURAL_FIBER" "DEVICE_TYPE_FLOORING_CARPET_BALL_YARN" "DEVICE_TYPE_FLOORING_CARPET_NEEDLE_FELT" "DEVICE_TYPE_FLOORING_CARPET_MEDIUM_QUALITY" "DEVICE_TYPE_FLOORING_SKIRTING_PLASTIC" "DEVICE_TYPE_FLOORING_SKIRTING_WOOD" "DEVICE_TYPE_FLOORING_RAW" "DEVICE_TYPE_FLOORING_COATED" "DEVICE_TYPE_WALL_COVERING_WORK" "DEVICE_TYPE_WALL_COVERING_WALLPAPER" "DEVICE_TYPE_WALL_COVERING_PLASTER" "DEVICE_TYPE_WALL_COVERING_ABRASION" "DEVICE_TYPE_WALL_COVERING_WOOD_WORKER" "DEVICE_TYPE_WALL_COVERING" "DEVICE_TYPE_WALL_COVERING_WALLPAPER_MEDIUM_QUALITY" "DEVICE_TYPE_WALL_COVERING_WALLPAPER_GOOD_QUALITY" "DEVICE_TYPE_WALL_COVERING_WALLPAPER_GLASS_FIBER" "DEVICE_TYPE_WALL_COVERING_PLASTER_GLUE_COLOR" "DEVICE_TYPE_WALL_COVERING_PLASTER_ACRYL" "DEVICE_TYPE_WALL_COVERING_PLASTER_MINERALS" "DEVICE_TYPE_WALL_COVERING_PLASTER_PLASTIC" "DEVICE_TYPE_WALL_COVERING_PLASTER_SILICATE_COATING" "DEVICE_TYPE_WALL_COVERING_PLASTER_DISPERSION_PAINT" "DEVICE_TYPE_WALL_COVERING_ABRASION_PLASTIC" "DEVICE_TYPE_WALL_COVERING_ABRASION_ROUGH_PUTT" "DEVICE_TYPE_WALL_COVERING_ABRASION_WHITE_PLASTER" "DEVICE_TYPE_WALL_COVERING_WOOD_WORKER_WALL_ROUGH" "DEVICE_TYPE_WALL_COVERING_WOOD_WORKER_LASED" "DEVICE_TYPE_WALL_COVERING_WOOD_WORKER_PAINTED_OPAQUE" "DEVICE_TYPE_WALL_COVERING_WOOD_WORKER_GLAZE" "DEVICE_TYPE_WALL_COVERING_CERAMIC" "DEVICE_TYPE_WALL_COVERING_STONEWORK" "DEVICE_TYPE_WALL_COVERING_STONEWARE" "DEVICE_TYPE_WALL_COVERING_TILES" "DEVICE_TYPE_CEILING_WORK" "DEVICE_TYPE_CEILING_WALLPAPER" "DEVICE_TYPE_CEILING_PLASTER" "DEVICE_TYPE_CEILING_ABRASION" "DEVICE_TYPE_CEILING_WOOD_WORKER" "DEVICE_TYPE_CEILING" "DEVICE_TYPE_CEILING_REGULAR" "DEVICE_TYPE_CEILING_REGULAR_METAL" "DEVICE_TYPE_CEILING_REGULAR_WOOD" "DEVICE_TYPE_CEILING_COVERING_ABRASION_PLASTIC" "DEVICE_TYPE_CEILING_COVERING_ABRASION_ROUGH_PUTT" "DEVICE_TYPE_CEILING_COVERING_ABRASION_WHITE_PLASTER" "DEVICE_TYPE_INTERIOR_SURFACE_TREATMENTS_PAINTING" "DEVICE_TYPE_OTHER_INTERIOR2_SHUTTER" "DEVICE_TYPE_OTHER_INTERIOR2_SHUTTER_MOTOR" "DEVICE_TYPE_OTHER_INTERIOR2_BLADE" "DEVICE_TYPE_OTHER_INTERIOR2_BLIND" "DEVICE_TYPE_OTHER_INTERIOR2_LETTER_BOX" "DEVICE_TYPE_OTHER_INTERIOR2" "DEVICE_TYPE_OTHER_INTERIOR2_SETS" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_SOAP_HOLDER" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_TOOTH_GLASS" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_GLASS_SHELF" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_TOWEL_BARS" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_HOLDING_RACK" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_CURTAIN_ROD" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_PACKAGE" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_WASHBASIN_BOWL" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_BATH_TOWEL_HOLDER" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_BATH_TOWEL_HOLDER_CHROME_STEEL" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_BATH_TOWEL_HOLDER_PLASTIC" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_BATH_TOWEL_HOLDER_HOOK" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_PAPER_HOLDER" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_PAPER_HOLDER_CHROME_STEEL" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_PAPER_HOLDER_PLASTIC" "DEVICE_TYPE_OTHER_INTERIOR2_ARMATURE" "DEVICE_TYPE_OTHER_INTERIOR2_ARMATURE_SINGLE_LEVER" "DEVICE_TYPE_OTHER_INTERIOR2_DOUBLE_LEVER" "DEVICE_TYPE_OTHER_INTERIOR2_ARMATURE_SWIVEL" "DEVICE_TYPE_OTHER_INTERIOR2_ARMATURE_PULL_OUT_SPRAY" "DEVICE_TYPE_OTHER_INTERIOR2_ARMATURE_THERMAL_MIXER" "DEVICE_TYPE_OTHER_INTERIOR2_OPERATING_GARNITURE" "DEVICE_TYPE_OTHER_INTERIOR2_CRANK" "DEVICE_TYPE_OTHER_INTERIOR2_BELT" "DEVICE_TYPE_OTHER_INTERIOR2_ELECTRIC" "DEVICE_TYPE_OTHER_TRANSPORT_CONTAINER" "DEVICE_TYPE_OTHER_TRANSPORT_CONTAINER_PLASTIC_GREEN" "DEVICE_TYPE_OTHER_TRANSPORT_CONTAINER_PLASTIC_BLACK" "DEVICE_TYPE_OTHER_TRANSPORT_CONTAINER_METAL" "DEVICE_TYPE_GARDENING_TRANSITION_POSITION_OUTDOOR_PARKING" "DEVICE_TYPE_GARDENING_TRANSITION_POSITION_PLANTING" "DEVICE_TYPE_GARDENING_TRANSITION_POSITION_GROUND_MARKING" "DEVICE_TYPE_GARDENING_TRANSITION_POSITION_CONTAINER_SITE" "DEVICE_TYPE_GARDENING_TRANSITION_POSITION_BIKE_SHELTER" "DEVICE_TYPE_GARDENING_TRANSITION_POSITION_ACCESS_PATH" "DEVICE_TYPE_GARDENING_FENCE" "DEVICE_TYPE_GARDENING_WALLS" "DEVICE_TYPE_GARDENING_CEMENT_BOARD" "DEVICE_TYPE_GARDENING_ACCESS_PATH" "DEVICE_TYPE_GARDENING_LAWN" "DEVICE_TYPE_GARDENING" "DEVICE_TYPE_FENCING" "DEVICE_TYPE_SUPERSTRUCTURE_TERRANCE" "DEVICE_TYPE_SUPERSTRUCTURE_BIKE_STAND" "DEVICE_TYPE_SUPERSTRUCTURE" "DEVICE_TYPE_SUPERSTRUCTURE_RAILING" "DEVICE_TYPE_SUPERSTRUCTURE_RAILING_SAFETY_GLASS" "DEVICE_TYPE_SUPERSTRUCTURE_RAILING_METAL" "DEVICE_TYPE_SUPERSTRUCTURE_RAILING_CHROME_STEEL" "DEVICE_TYPE_SUPERSTRUCTURE_RAILING_CONCRETE" "DEVICE_TYPE_PLAYGROUND" "DEVICE_TYPE_PLAYGROUND_DEVICE" "DEVICE_TYPE_GARDEN_OTHER" "DEVICE_TYPE_DEVICE_TRANSITION_POSITION_FIRE_EXTINGUISHER" "DEVICE_TYPE_DEVICE_TRANSITION_POSITION_LAWN_MOWER" "DEVICE_TYPE_DEVICE_TRANSITION_POSITION_SECURITY_CAMERA" "DEVICE_TYPE_DEVICE_TRANSITION_POSITION_INDOOR_BIKE_SHELTER" "DEVICE_TYPE_AIR_COMPRESSOR" "DEVICE_TYPE_GAS_SYSTEM_LABORATORY" "DEVICE_TYPE_HOIST_CRANE" "DEVICE_TYPE_HEATING_DISTRIBUTOR" "DEVICE_TYPE_INTERIOR_METAL_DOORS" "DEVICE_TYPE_INTERIOR_METAL_BALCONY_GLAZING" "DEVICE_TYPE_REFRIGERATING_MACHINE" "DEVICE_TYPE_REFRIGERATED_CEILING" "DEVICE_TYPE_COOLING_DISTRIBUTOR" "DEVICE_TYPE_VENTILATION_MONOBLOCK" "DEVICE_TYPE_NEUTRALIZATION_SYSTEM" "DEVICE_TYPE_PURE_WATER_SYSTEM" "DEVICE_TYPE_WATER_SYSTEM_SEPARATOR" "DEVICE_TYPE_RECIRCULATING_AIR_COOLING_UNIT" "DEVICE_TYPE_RECIRCULATING_AIR_COOLER" "DEVICE_TYPE_STAIR" "DEVICE_TYPE_WARDROBE" "DEVICE_TYPE_COAT_HOOKS" "DEVICE_TYPE_GATE" "DEVICE_TYPE_CURTAIN_RAIL" "DEVICE_TYPE_FURNITURE_BEDROOM_BED" "DEVICE_TYPE_FURNITURE_BEDROOM_BEDSIDE_TABLE" "DEVICE_TYPE_FURNITURE_BEDROOM_DRESSER" "DEVICE_TYPE_FURNITURE_BEDROOM_WARDROBE" "DEVICE_TYPE_FURNITURE_LIVING_ROOM_TABLE" "DEVICE_TYPE_FURNITURE_LIVING_ROOM_DINING_TABLE" "DEVICE_TYPE_FURNITURE_OFFICE_DESK" "DEVICE_TYPE_FURNITURE_OFFICE_CHAIR" "DEVICE_TYPE_FURNITURE_OFFICE_STOOL" "DEVICE_TYPE_FURNITURE_LIVING_ROOM_CHAIR" "DEVICE_TYPE_FURNITURE_LIVING_ROOM_ARMCHAIR" "DEVICE_TYPE_FURNITURE_BEDROOM_MATTRESS" "DEVICE_TYPE_FURNITURE_LIVING_ROOM_SOFA" "DEVICE_TYPE_ELECTRONICS_ENTERTAINMENT_TELEVISION" "DEVICE_TYPE_ELECTRONICS_ENTERTAINMENT_REMOTE_CONTROL" "DEVICE_TYPE_TEXTILES_BEDROOM_BED_LINEN" "DEVICE_TYPE_TEXTILES_BATHROOM_TOWELS" "DEVICE_TYPE_DECORATION_WALL_DECORATION_PICTURE" "DEVICE_TYPE_DECORATION_BATHROOM_WALL_MIRROR" "DEVICE_TYPE_HOUSEHOLD_GOODS_BATHROOM_LAUNDRY_BASKET" "DEVICE_TYPE_HOUSEHOLD_GOODS_OFFICE_WASTE_PAPER_BASKET" "DEVICE_TYPE_HOUSEHOLD_GOODS_KITCHEN_DISHES" "DEVICE_TYPE_OUTER_FINISHES_HAIL_PROTECTION" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_FIRE_ALARM_SYSTEM" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_EMERGENCY_LIGHT" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_ALARM_NET" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_ZEV_METER" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_ELECTRICITY_METER" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_CONTROL_UNIT" "DEVICE_TYPE_CARPENTER_HALLWAY_WARDROBE" "DEVICE_TYPE_SUPERSTRUCTURE_OUTDOOR_SEATING_AREA" "DEVICE_TYPE_MEDICAL_DEVICES_DEFIBRILLATOR_AED" "DEVICE_TYPE_ELECTRONICS_DESIGN_TABLET" "DEVICE_TYPE_LABELS_MARKINGS_SIGNAGE" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_MODEM_ROUTER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_REFRIGERATOR_ACCESSORIES_EGG_CONTAINER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FREEZER_ACCESSORIES_ICE_CUBE_TRAY" "DEVICE_TYPE_KITCHEN_EQUIPMENT_COMBI_STEAMER" "DEVICE_TYPE_LOCKING_CARD_READER" "DEVICE_TYPE_ENERGY_SUPPLY_GAS_METER" "DEVICE_TYPE_COOLING_ENERGY_METER" "DEVICE_TYPE_OTHER_INTERIOR1_COIN_COUNTER" "DEVICE_TYPE_HEAT_GENERATION_HEAT_TRACING" "DEVICE_TYPE_OTHER_SANITARY_SPRINKLER_SYSTEM" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_WATER_FILTER" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_WATER_METER" "DEVICE_TYPE_CIRCULATION_PUMP"

Optional. If not provided the whole list for all device types will be returned.

  • DEVICE_TYPE_CHROME_STEEP_FINISH: Not used

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List devices by IDs

Returns the devices matching the given device IDs.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "devices": [
    ]
}

List devices by reference IDs

Returns devices for the given reference IDs. Optional page and itemsPerPage enable pagination; response includes totalDevices and totalPages.

Request Body schema: application/json
required
itemsPerPage
required
integer <int32>

Only used when page is set

page
integer <int32>

Optional. Leave out or set to 0 to disable pagination

referenceIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "itemsPerPage": 0,
  • "page": 0,
  • "referenceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "devices": [
    ],
  • "totalDevices": 0,
  • "totalPages": 0
}

Delete a device

Deletes the device identified by id.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Add documents to a device

Appends the given document IDs to the device identified by id. Returns the updated device.

path Parameters
id
required
string
query Parameters
documentIds
Array of strings

Responses

Response samples

Content type
application/json
{
  • "device": {
    }
}

Update a device

Updates an existing device by ID, including reference, room, facility plant, system, type, manufacturer details, costs, condition, maintenance/inspection/revision data, documents, and images. Returns the updated device.

path Parameters
id
required
string
Request Body schema: application/json
required
acquisitionCosts
number <float>
amount
integer <int32>
assetNumberFm
string
bkpH
string (Construction costs plan for heating (German: Baukostenplan Heizung))
brand
string
cataloguePrice
number <float>
condition
string (- DEVICE_CONDITION_REPAIR_NEEDED: Deprecated. Will be moved to action value - DEVICE_CONDITION_REPLACEMENT_NEEDED: Deprecated. Will be moved to action value)
Default: "DEVICE_CONDITION_UNDEFINED"
Enum: "DEVICE_CONDITION_UNDEFINED" "DEVICE_CONDITION_NORMAL_WEAR" "DEVICE_CONDITION_REPAIR_NEEDED" "DEVICE_CONDITION_REPLACEMENT_NEEDED" "DEVICE_CONDITION_PERFECT" "DEVICE_CONDITION_DEFICIENCY"
conditionNote
string
documentIds
Array of strings
facilityPlant
string (deviceDeviceFacilityPlant)
Default: "DEVICE_FACILITY_PLANT_UNDEFINED"
Enum: "DEVICE_FACILITY_PLANT_UNDEFINED" "DEVICE_FACILITY_SHELL_CONSTRUCTION1" "DEVICE_FACILITY_SHELL_CONSTRUCTION2" "DEVICE_FACILITY_PLANT_ELECTRICITY" "DEVICE_FACILITY_PLANT_AIR_CONDITIONING" "DEVICE_FACILITY_PLANT_SANITARY" "DEVICE_FACILITY_PLANT_TRANSPORT_WAREHOUSE" "DEVICE_FACILITY_PLANT_INTERIOR1" "DEVICE_FACILITY_PLANT_INTERIOR2" "DEVICE_FACILITY_PLANT_GARDEN" "DEVICE_FACILITY_PLANT_DEVICE" "DEVICE_FACILITY_PLANT_FURNITURE" "DEVICE_FACILITY_PLANT_ELECTRONICS" "DEVICE_FACILITY_PLANT_TEXTILES" "DEVICE_FACILITY_PLANT_DECORATION" "DEVICE_FACILITY_PLANT_HOUSEHOLD_GOODS" "DEVICE_FACILITY_PLANT_OTHER"
Array of objects (objectdeviceImage)
object (deviceInspection)
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

lifeSpan
integer <int32>
object (deviceLockingKey)
object (deviceMaintenance)
manufacturer
string
measure
string (deviceDeviceMeasure)
Default: "DEVICE_MEASURE_UNDEFINED"
Enum: "DEVICE_MEASURE_UNDEFINED" "DEVICE_MEASURE_IMPLEMENTATION_PERIOD" "DEVICE_MEASURE_IMMEDIATELY"
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

model
string
note
string
order
integer <int32>
referenceId
string
object (deviceRevision)
roomId
string
serialNumber
string
system
string (deviceDeviceSystem)
Default: "DEVICE_SYSTEM_UNDEFINED"
Enum: "DEVICE_SYSTEM_UNDEFINED" "DEVICE_SYSTEM_MASTER_BUILDER_WORK" "DEVICE_SYSTEM_WINDOW_DOOR" "DEVICE_SYSTEM_ROOFING" "DEVICE_SYSTEM_SEALING_INSULATION" "DEVICE_SYSTEM_FACADE_PLASTER" "DEVICE_SYSTEM_OUTER_FINISHES" "DEVICE_SYSTEM_HEAVY_CURRENT_INSTALLATION" "DEVICE_SYSTEM_LIGHTS" "DEVICE_SYSTEM_TELEPHONE" "DEVICE_SYSTEM_LOW_CURRENT_INSTALLATION" "DEVICE_SYSTEM_OTHER_ELECTRICITY" "DEVICE_SYSTEM_HEATING_TRANSITION_POSITION" "DEVICE_SYSTEM_ENERGY_SUPPLY" "DEVICE_SYSTEM_HEAT_GENERATION" "DEVICE_SYSTEM_HEAT_DISTRIBUTION" "DEVICE_SYSTEM_VENTILATION" "DEVICE_SYSTEM_AIR_CONDITIONING" "DEVICE_SYSTEM_COOLING" "DEVICE_SYSTEM_SPECIAL_FACILITY" "DEVICE_SYSTEM_INSULATION" "DEVICE_SYSTEM_OTHER_HEATING" "DEVICE_SYSTEM_SANITARY" "DEVICE_SYSTEM_SPECIAL_SANITARY" "DEVICE_SYSTEM_SANITARY_SUPPLY_DISPOSAL" "DEVICE_SYSTEM_SANITARY_PIPING" "DEVICE_SYSTEM_SANITARY_INSULATION" "DEVICE_SYSTEM_SANITARY_EQUIPMENT" "DEVICE_SYSTEM_ELECTRIC_PNEUMATIC_BOARD" "DEVICE_SYSTEM_KITCHEN_EQUIPMENT" "DEVICE_SYSTEM_OTHER_SANITARY" "DEVICE_SYSTEM_ELEVATOR" "DEVICE_SYSTEM_MOVING_STAIRCASE" "DEVICE_SYSTEM_FACADE_CLEANING" "DEVICE_SYSTEM_GOODS_CONVEYING" "DEVICE_SYSTEM_LIFTING" "DEVICE_SYSTEM_PARKING" "DEVICE_SYSTEM_TRANSPORT_OTHER" "DEVICE_SYSTEM_PLASTERER" "DEVICE_SYSTEM_METAL" "DEVICE_SYSTEM_CARPENTER" "DEVICE_SYSTEM_WINDOW" "DEVICE_SYSTEM_LOCKING" "DEVICE_SYSTEM_INTERIOR_FINISHES" "DEVICE_SYSTEM_ELEMENT_WALL" "DEVICE_SYSTEM_CHROME_STEEL_FACILITY" "DEVICE_SYSTEM_OTHER_INTERIOR1" "DEVICE_SYSTEM_FLOORING" "DEVICE_SYSTEM_WALL_COVERING" "DEVICE_SYSTEM_CEILING" "DEVICE_SYSTEM_INTERIOR_SURFACE_TREATMENTS" "DEVICE_SYSTEM_OTHER_INTERIOR2" "DEVICE_SYSTEM_OTHER_TRANSPORT" "DEVICE_SYSTEM_GARDEN_TRANSITION_POSITION" "DEVICE_SYSTEM_GARDENING" "DEVICE_SYSTEM_FENCING" "DEVICE_SYSTEM_SUPERSTRUCTURE" "DEVICE_SYSTEM_PLAYGROUND" "DEVICE_SYSTEM_GARDEN_OTHER" "DEVICE_SYSTEM_DEVICE_TRANSITION_POSITION" "DEVICE_SYSTEM_ELECTRONICS_DESIGN" "DEVICE_SYSTEM_MEDICAL_DEVICES" "DEVICE_SYSTEM_LABELS_MARKINGS_SIGNAGE"
type
string (- DEVICE_TYPE_CHROME_STEEP_FINISH: Not used)
Default: "DEVICE_TYPE_UNDEFINED"
Enum: "DEVICE_TYPE_UNDEFINED" "DEVICE_TYPE_MASTER_BUILDER_WORK_DOWN_PIPES" "DEVICE_TYPE_MASTER_BUILDER_WORK_BASIC_LINE" "DEVICE_TYPE_MASTER_BUILDER_WORK_DRAINAGE_LINE" "DEVICE_TYPE_MASTER_BUILDER_WORK_PUMP_CHAMBER" "DEVICE_TYPE_MASTER_BUILDER_WORK_TERRACE_DRAIN" "DEVICE_TYPE_WINDOW_DOOR_AUTOMATIC_SLIDING_DOOR" "DEVICE_TYPE_WINDOW_DOOR_EXTERIOR_DOOR" "DEVICE_TYPE_WINDOW_DOOR_FIRE_GATE" "DEVICE_TYPE_WINDOW_DOOR_ROOF_WINDOW" "DEVICE_TYPE_WINDOW_DOOR_WINDOW" "DEVICE_TYPE_WINDOW_DOOR_GATE_DRIVE" "DEVICE_TYPE_WINDOW_DOOR_GARAGE_DOOR" "DEVICE_TYPE_WINDOW_DOOR_DOOR_AUTOMATION" "DEVICE_TYPE_WINDOW_DOOR_EXTERIOR_DOOR_SOLID_WOOD" "DEVICE_TYPE_WINDOW_DOOR_EXTERIOR_DOOR_WOOD_MATERIAL" "DEVICE_TYPE_WINDOW_DOOR_EXTERIOR_DOOR_METAL" "DEVICE_TYPE_WINDOW_DOOR_WINDOW_WOOD_DOUBLE_GLAZING" "DEVICE_TYPE_WINDOW_DOOR_WINDOW_PLASTIC" "DEVICE_TYPE_WINDOW_DOOR_WINDOW_WOOD" "DEVICE_TYPE_WINDOW_DOOR_WINDOW_WOOD_METAL" "DEVICE_TYPE_WINDOW_DOOR_WINDOW_METAL" "DEVICE_TYPE_ROOFING_PENT_ROOF" "DEVICE_TYPE_ROOFING_SADDLE_ROOF" "DEVICE_TYPE_ROOFING_TERRACE" "DEVICE_TYPE_ROOFING_HIPPED_ROOF" "DEVICE_TYPE_ROOFING_TENT_ROOF" "DEVICE_TYPE_ROOFING_FLAT_ROOF" "DEVICE_TYPE_ROOFING_SHEARING_ROOF" "DEVICE_TYPE_ROOFING_FRONT_PANEL" "DEVICE_TYPE_SEALING_INSULATION_FACADE" "DEVICE_TYPE_SEALING_INSULATION_INTERIOR" "DEVICE_TYPE_SEALING_INSULATION_FACADE_WOOD" "DEVICE_TYPE_SEALING_INSULATION_FACADE_PLATES" "DEVICE_TYPE_SEALING_INSULATION_FACADE_ETERNIT" "DEVICE_TYPE_FACADE_PLASTER_PAINTING" "DEVICE_TYPE_FACADE_PLASTER" "DEVICE_TYPE_OUTER_FINISHES_FOLDING_SHUTTERS" "DEVICE_TYPE_OUTER_FINISHES_SHUTTERS" "DEVICE_TYPE_OUTER_FINISHES_SUN_BLINDS" "DEVICE_TYPE_OUTER_FINISHES_SUN_BLINDS_VOLANT" "DEVICE_TYPE_OUTER_FINISHES_GLARE_PROTECTION" "DEVICE_TYPE_OUTER_FINISHES_SHUTTERS_WOOD" "DEVICE_TYPE_OUTER_FINISHES_SHUTTERS_METAL" "DEVICE_TYPE_OUTER_FINISHES_SLAT_TOWERS" "DEVICE_TYPE_OUTER_FINISHES_SLAT_TOWERS_OUTSIDE_ALUMINIUM" "DEVICE_TYPE_OUTER_FINISHES_SLAT_TOWERS_INSIDE" "DEVICE_TYPE_OUTER_FINISHES_BLIND_SHOPS" "DEVICE_TYPE_OUTER_FINISHES_BLIND_SHOPS_WOOD" "DEVICE_TYPE_OUTER_FINISHES_BLIND_SHOPS_METAL" "DEVICE_TYPE_OUTER_FINISHES" "DEVICE_TYPE_OUTER_FINISHES_PRIVACY_SCREEN" "DEVICE_TYPE_OUTER_FINISHES_PRIVACY_SCREEN_GLASS" "DEVICE_TYPE_OUTER_FINISHES_PRIVACY_SCREEN_WOOD" "DEVICE_TYPE_OUTER_FINISHES_PRIVACY_SCREEN_METAL" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_LIGHTING" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_CO2" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_SINA" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_SMOKE_VENT" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_PROOF_OF_SAFETY_SINA" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_SWITCHGEAR_COMBINATION" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_PHOTOVOLTAIC" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_LOW_VOLTAGE_SYSTEM" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_CABLE" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_SWITCH" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_SWITCHBOARD" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_SOCKET" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_UPS" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_INFRASTRUCTURE_ELECTRIC_CHARGING" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_ELECTRIC_CHARGING_STATION" "DEVICE_TYPE_LIGHTS_ILLUMINANT" "DEVICE_TYPE_LIGHTS" "DEVICE_TYPE_LIGHTS_CEILING" "DEVICE_TYPE_LIGHTS_CABINET" "DEVICE_TYPE_LIGHTS_SPOTS" "DEVICE_TYPE_LIGHTS_MIRROR_CABINET" "DEVICE_TYPE_TELEPHONE_CENTER" "DEVICE_TYPE_TELEPHONE_DISTRIBUTOR" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_INTERCOM" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_INTERCOM_VIDEO" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_BELL" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_DOOR_OPENER" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_FIBERGLASS" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_EMERGENCY_PHONE_LIFT" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_INTERPHONE" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_MULTIMEDIA" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_INTRUSION_DETECTION" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_ISDN" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_CABLE" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_SWITCH" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_SWITCHBOARD" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_SOCKET" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_TV_ANTENNA" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_TV_CABLE" "DEVICE_TYPE_OTHER_ELECTRICITY_BATTERY" "DEVICE_TYPE_OTHER_ELECTRICITY_OTHER" "DEVICE_TYPE_OTHER_ELECTRICITY_LIGHTNING_PROTECTION" "DEVICE_TYPE_OTHER_ELECTRICITY" "DEVICE_TYPE_OTHER_ELECTRICITY_SOCKET" "DEVICE_TYPE_OTHER_ELECTRICITY_FUSEBOX" "DEVICE_TYPE_HEATING_TRANSITION_POSITION_ROOF_VENTILATION" "DEVICE_TYPE_HEATING_TRANSITION_POSITION_FILTER_REPLACEMENT" "DEVICE_TYPE_HEATING_TRANSITION_POSITION_AIR_CONDITIONING" "DEVICE_TYPE_HEATING_TRANSITION_POSITION_VENTILATION" "DEVICE_TYPE_ENERGY_SUPPLY_SUPPLY" "DEVICE_TYPE_ENERGY_SUPPLY_LEAKAGE_WARNING" "DEVICE_TYPE_ENERGY_SUPPLY_TANK" "DEVICE_TYPE_ENERGY_SUPPLY_STORAGE" "DEVICE_TYPE_ENERGY_SUPPLY_GAS_LINE" "DEVICE_TYPE_ENERGY_SUPPLY_FUEL_TANK_INSIDE" "DEVICE_TYPE_ENERGY_SUPPLY_FUEL_TANK_EARTH_LOADED" "DEVICE_TYPE_HEAT_GENERATION" "DEVICE_TYPE_HEAT_GENERATION_BOILER" "DEVICE_TYPE_HEAT_GENERATION_BURNER" "DEVICE_TYPE_HEAT_GENERATION_EARTH_PROBE" "DEVICE_TYPE_HEAT_GENERATION_ELECTRIC_STORAGE_STOVE" "DEVICE_TYPE_HEAT_GENERATION_EXPANSION_DEVICE" "DEVICE_TYPE_HEAT_GENERATION_DISTRICT_HEATING" "DEVICE_TYPE_HEAT_GENERATION_DISTRICT_HEATING_SUBSTATION" "DEVICE_TYPE_HEAT_GENERATION_HEATING_BOILER" "DEVICE_TYPE_HEAT_GENERATION_THERMAL_SOLAR_SYSTEM" "DEVICE_TYPE_HEAT_GENERATION_HEAT_EXCHANGER" "DEVICE_TYPE_HEAT_GENERATION_HEAT_PUMP" "DEVICE_TYPE_HEAT_GENERATION_FIREPLACE" "DEVICE_TYPE_HEAT_GENERATION_HEAT_ACCUMULATOR" "DEVICE_TYPE_HEAT_GENERATION_SINGLE_WATER_BOILER" "DEVICE_TYPE_HEAT_GENERATION_COMBIBOILER_HEATING" "DEVICE_TYPE_HEAT_GENERATION_ELECTRIC_BOILER" "DEVICE_TYPE_HEAT_GENERATION_BOILER_GAS_APPLIANCES" "DEVICE_TYPE_HEAT_GENERATION_COMBINED_BOILER" "DEVICE_TYPE_HEAT_GENERATION_SOLAR_PANELS" "DEVICE_TYPE_HEAT_GENERATION_RADIATORS" "DEVICE_TYPE_HEAT_GENERATION_RADIATORS_HEATWALLS" "DEVICE_TYPE_HEAT_GENERATION_TOWEL_RADIATORS" "DEVICE_TYPE_HEAT_GENERATION_FLOOR_HEATING" "DEVICE_TYPE_HEAT_GENERATION_HEATING_ELEMENT" "DEVICE_TYPE_HEAT_GENERATION_ELECTRIC_STOVE" "DEVICE_TYPE_HEAT_GENERATION_ROOF_HEATING" "DEVICE_TYPE_HEAT_DISTRIBUTION" "DEVICE_TYPE_HEAT_DISTRIBUTION_HEAT_METER" "DEVICE_TYPE_HEAT_DISTRIBUTION_CIRCULATING_PUMP" "DEVICE_TYPE_HEAT_DISTRIBUTION_HEAT_QUANTITY_FLOW_METERS" "DEVICE_TYPE_HEAT_DISTRIBUTION_HEATING_COST_ALLOCATOR" "DEVICE_TYPE_HEAT_DISTRIBUTION_FLOOR_HEATING" "DEVICE_TYPE_VENTILATION_VENTILATION_CONTROL_CENTER" "DEVICE_TYPE_VENTILATION_VENTILATION" "DEVICE_TYPE_VENTILATION_SUPPLY_AIR_FAN" "DEVICE_TYPE_VENTILATION_EXHAUST_AIR_FAN" "DEVICE_TYPE_VENTILATION_SMOKE_EXTRACTION_SYSTEM" "DEVICE_TYPE_VENTILATION" "DEVICE_TYPE_VENTILATION_CONTROLLED_HOME" "DEVICE_TYPE_VENTILATION_CHANNELS" "DEVICE_TYPE_AIR_CONDITIONING_RECOOLING" "DEVICE_TYPE_AIR_CONDITIONING" "DEVICE_TYPE_AIR_CONDITIONING_INDIVIDUAL_ROOMS" "DEVICE_TYPE_COOLING_CHILLERS" "DEVICE_TYPE_COOLING_COLD_RESERVOIR" "DEVICE_TYPE_COOLING_COLD_WATER_TANK" "DEVICE_TYPE_COOLING_COLD_STORAGE_CELL" "DEVICE_TYPE_COOLING" "DEVICE_TYPE_SPECIAL_FACILITY" "DEVICE_TYPE_INSULATION" "DEVICE_TYPE_INSULATION_CHIMNEY" "DEVICE_TYPE_SPECIAL_FACILITY_MEASUREMENT_CONTROL_TECHNOLOGY_BUILDING_MANAGEMENT_SYSTEM" "DEVICE_TYPE_SPECIAL_FACILITY_MEASUREMENT_CONTROL_TECHNOLOGY_CONTROL_SYSTEM" "DEVICE_TYPE_SPECIAL_FACILITY_MEASUREMENT_CONTROL_TECHNOLOGY" "DEVICE_TYPE_SPECIAL_FACILITY_MEASUREMENT_CONTROL_TECHNOLOGY_VALVES" "DEVICE_TYPE_SANITARY_BATHTUB" "DEVICE_TYPE_SANITARY_RENOVATION" "DEVICE_TYPE_SANITARY_CONTROL_FITTINGS" "DEVICE_TYPE_SANITARY_WASHBASIN" "DEVICE_TYPE_SANITARY_WASHBASIN_CERAMIC" "DEVICE_TYPE_SANITARY_MIRROR_CABINET" "DEVICE_TYPE_SANITARY_BIDET" "DEVICE_TYPE_SANITARY_SHOWER" "DEVICE_TYPE_SANITARY_LAVABO" "DEVICE_TYPE_SANITARY_URINAL" "DEVICE_TYPE_SANITARY_FLUSH_TANK" "DEVICE_TYPE_SANITARY_TOILET" "DEVICE_TYPE_SANITARY_TOILET_CERAMIC" "DEVICE_TYPE_SANITARY_TOILET_CLOSOMAT" "DEVICE_TYPE_SANITARY_TOILET_COVER" "DEVICE_TYPE_SANITARY_TOILET_COVER_SOFT_CLOSE" "DEVICE_TYPE_SANITARY_BATHTUB_ACRYLIC" "DEVICE_TYPE_SANITARY_BATHTUB_STEEL" "DEVICE_TYPE_SANITARY_MIRROR_CABINET_PLASTIC" "DEVICE_TYPE_SANITARY_MIRROR_CABINET_WOODEN" "DEVICE_TYPE_SANITARY_MIRROR_CABINET_METAL" "DEVICE_TYPE_SANITARY_FLUSH_TANK_FLUSH_MOUNTED" "DEVICE_TYPE_SANITARY_FLUSH_TANK_PLASTIC" "DEVICE_TYPE_SANITARY_FLUSH_TANK_CERAMIC" "DEVICE_TYPE_SANITARY_LAVABO_TOILET_BIDET_URINAL" "DEVICE_TYPE_SANITARY_LAVABO_TOILET_BIDET_URINAL_CERAMIC" "DEVICE_TYPE_SANITARY_LAVABO_TOILET_BIDET_URINAL_CLOSOMAT" "DEVICE_TYPE_SANITARY_SHOWER_CABIN" "DEVICE_TYPE_SANITARY_SHOWER_CABIN_PLASTIC" "DEVICE_TYPE_SANITARY_SHOWER_CABIN_GLASWALLS" "DEVICE_TYPE_SPECIAL_SANITARY_WATER_SOFTENER" "DEVICE_TYPE_SPECIAL_SANITARY_LIMESCALE_PROTECTION" "DEVICE_TYPE_SPECIAL_SANITARY_DEHUMIDIFIER" "DEVICE_TYPE_SPECIAL_SANITARY_WASHING_MACHINE" "DEVICE_TYPE_SPECIAL_SANITARY_COMBI_WASHER_DRYER" "DEVICE_TYPE_SPECIAL_SANITARY_WASHING_ELECTRICITY_METER" "DEVICE_TYPE_SPECIAL_SANITARY_TUMBLER" "DEVICE_TYPE_SPECIAL_SANITARY_VACUUM_DEGASSING_DEVICE" "DEVICE_TYPE_SPECIAL_SANITARY" "DEVICE_TYPE_SPECIAL_SANITARY_WATER_TAP" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_SUPPLY" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_DISPOSAL" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_WATER_TREATMENT" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_SEWAGE_PUMP" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_WATER_DISTRIBUTION_BATTERY" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_SEWAGE_TANK" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_PIPING_COLD_WATER" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_FINE_FILTER" "DEVICE_TYPE_SANITARY_PIPING_RAIN_WATER" "DEVICE_TYPE_SANITARY_PIPING_WARM_WATER" "DEVICE_TYPE_SANITARY_PIPING" "DEVICE_TYPE_SANITARY_INSULATION" "DEVICE_TYPE_SANITARY_EQUIPMENT_MIRROR_CABINETS" "DEVICE_TYPE_SANITARY_EQUIPMENT_MIRROR_CABINETS_ONE_DOOR" "DEVICE_TYPE_SANITARY_EQUIPMENT_MIRROR_CABINETS_TWO_DOOR" "DEVICE_TYPE_SANITARY_EQUIPMENT_MIRROR" "DEVICE_TYPE_SANITARY_EQUIPMENT_BATHROOM_FURNITURE" "DEVICE_TYPE_SANITARY_EQUIPMENT_SHOWER_CABIN" "DEVICE_TYPE_SANITARY_EQUIPMENT" "DEVICE_TYPE_SANITARY_SHOWER_HEAD_HOSE" "DEVICE_TYPE_SANITARY_SHOWER_ROD" "DEVICE_TYPE_SANITARY_SHOWER_ROD_CHROME_STEEL" "DEVICE_TYPE_SANITARY_SHOWER_HEAD_HOLDER" "DEVICE_TYPE_ELECTRIC_PNEUMATIC_BOARD" "DEVICE_TYPE_KITCHEN_EQUIPMENT_REFRIGERATOR" "DEVICE_TYPE_KITCHEN_EQUIPMENT_REFRIGERATOR_ACCESSORIES" "DEVICE_TYPE_KITCHEN_EQUIPMENT_REFRIGERATOR_ACCESSORIES_COMPARTMENT" "DEVICE_TYPE_KITCHEN_EQUIPMENT_WASTE" "DEVICE_TYPE_KITCHEN_EQUIPMENT_WASTE_SEPARATING_SYSTEM" "DEVICE_TYPE_KITCHEN_EQUIPMENT_WASTE_HOLDER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FREEZER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_OVEN" "DEVICE_TYPE_KITCHEN_EQUIPMENT_OVEN_ACCESSORIES" "DEVICE_TYPE_KITCHEN_EQUIPMENT_OVEN_ACCESSORIES_BLECH" "DEVICE_TYPE_KITCHEN_EQUIPMENT_OVEN_ACCESSORIES_GRID" "DEVICE_TYPE_KITCHEN_EQUIPMENT_OVEN_ACCESSORIES_THERMOMETER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_OVEN_ACCESSORIES_GRILL" "DEVICE_TYPE_KITCHEN_EQUIPMENT_STEAM_EXHAUST_HOOD" "DEVICE_TYPE_KITCHEN_EQUIPMENT_STEAMER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_STEAMER_ACCESSORIES" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DISH_WASHER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DISH_WASHER_CUTLERY_TRAY" "DEVICE_TYPE_KITCHEN_EQUIPMENT_HOB" "DEVICE_TYPE_KITCHEN_EQUIPMENT_INDUCTION_HOB" "DEVICE_TYPE_KITCHEN_EQUIPMENT_GLASS_CERAMIC_HOB" "DEVICE_TYPE_KITCHEN_EQUIPMENT_HOT_PLATES_HOB" "DEVICE_TYPE_KITCHEN_EQUIPMENT_GAS_HOB" "DEVICE_TYPE_KITCHEN_EQUIPMENT_MINOR_KITCHEN" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FURNITURE" "DEVICE_TYPE_KITCHEN_EQUIPMENT_MICROWAVE" "DEVICE_TYPE_KITCHEN_EQUIPMENT_STOVE_WITH_OVEN" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FILTER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_CARBON_FILTER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_ALUMINIUM_FILTER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DRYER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COMBINATION_FURNITURE" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COVER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_SEALING" "DEVICE_TYPE_KITCHEN_EQUIPMENT_VENTILATION_GRILLE" "DEVICE_TYPE_KITCHEN_EQUIPMENT" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COVER_CHROME_STEEL" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COVER_GRANITE" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COVER_GLASS" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COVER_SYNTHETIC_RESIN" "DEVICE_TYPE_KITCHEN_EQUIPMENT_KITCHEN_COVER_WOODEN" "DEVICE_TYPE_KITCHEN_EQUIPMENT_TOP_CABINET" "DEVICE_TYPE_KITCHEN_EQUIPMENT_TOP_CABINET_HIGH_GLOSS" "DEVICE_TYPE_KITCHEN_EQUIPMENT_TOP_CABINET_WOOD" "DEVICE_TYPE_KITCHEN_EQUIPMENT_UNDER_CABINET" "DEVICE_TYPE_KITCHEN_EQUIPMENT_UNDER_CABINET_HIGH_GLOSS" "DEVICE_TYPE_KITCHEN_EQUIPMENT_UNDER_CABINET_WOOD" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DRAWER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DRAWER_WITH_CUTLERY" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DRAWER_WITH_BOTTLE_HOLDER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_DRAWER_WITH_SLIPS_MAT" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FLUSHING_BASIN" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FLUSHING_BASIN_CHROME_STEEL" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FLUSHING_BASIN_PLASTIC" "DEVICE_TYPE_OTHER_SANITARY" "DEVICE_TYPE_ELEVATOR_HANDICAP_LIFT" "DEVICE_TYPE_ELEVATOR_BED_LIFT" "DEVICE_TYPE_ELEVATOR" "DEVICE_TYPE_ELEVATOR_MERCHANDISE_LIFT" "DEVICE_TYPE_MOVING_STAIRCASE" "DEVICE_TYPE_FACADE_CLEANING" "DEVICE_TYPE_GOODS_CONVEYING_OTHER" "DEVICE_TYPE_GOODS_CONVEYING_PNEUMATIC_TUBE" "DEVICE_TYPE_GOODS_CONVEYING_FILE_LIFT" "DEVICE_TYPE_GOODS_CONVEYING" "DEVICE_TYPE_LIFTING" "DEVICE_TYPE_PARKING" "DEVICE_TYPE_TRANSPORT_OTHER" "DEVICE_TYPE_PLASTERER" "DEVICE_TYPE_METAL" "DEVICE_TYPE_METAL_CAR_SHELTER" "DEVICE_TYPE_METAL_MAILBOX" "DEVICE_TYPE_METAL_BALCONY_ENLARGEMENT" "DEVICE_TYPE_CARPENTER_SCREED_EXTENSION_LADDER" "DEVICE_TYPE_CARPENTER_CELLAR_DOOR" "DEVICE_TYPE_CARPENTER_APARTMENT_DOOR" "DEVICE_TYPE_CARPENTER_DOOR" "DEVICE_TYPE_CARPENTER_DOOR_FRAME" "DEVICE_TYPE_CARPENTER_LOCKS" "DEVICE_TYPE_CARPENTER_BUILT_IN_CLOSETS" "DEVICE_TYPE_CARPENTER_SLIDING_DOOR" "DEVICE_TYPE_CARPENTER" "DEVICE_TYPE_CARPENTER_DOOR_WOODEN" "DEVICE_TYPE_CARPENTER_DOOR_WOOD_MATERIAL" "DEVICE_TYPE_CARPENTER_DOOR_METAL" "DEVICE_TYPE_CARPENTER_DOOR_FRAME_WOOD" "DEVICE_TYPE_CARPENTER_DOOR_FRAME_METAL_STONE" "DEVICE_TYPE_CARPENTER_DOOR_FRAME_METAL" "DEVICE_TYPE_CARPENTER_LOCKS_APARTMENT_DOOR" "DEVICE_TYPE_CARPENTER_LOCKS_ROOM_DOOR" "DEVICE_TYPE_CARPENTER_LOCKS_KITT_JOINT" "DEVICE_TYPE_CARPENTER_BUILT_IN_CLOSETS_CHANNELBOARDS" "DEVICE_TYPE_CARPENTER_BUILT_IN_CLOSETS_WOODEN" "DEVICE_TYPE_CARPENTER_BUILT_IN_CLOSETS_HIGH_GLOSS" "DEVICE_TYPE_CARPENTER_SLIDING_DOOR_WOODEN_MATERIAL" "DEVICE_TYPE_CARPENTER_SLIDING_DOOR_ROLLS" "DEVICE_TYPE_CARPENTER_DOOR_FRAME_COLOR_OIL" "DEVICE_TYPE_CARPENTER_GLASS_INSERT_DOOR" "DEVICE_TYPE_CARPENTER_FITTINGS_FOR_DOOR" "DEVICE_TYPE_CARPENTER_RUBBER_SEALS_DOOR" "DEVICE_TYPE_CARPENTER_SHELF" "DEVICE_TYPE_CARPENTER_SHELF_WOOD" "DEVICE_TYPE_CARPENTER_SHELF_METAL" "DEVICE_TYPE_CARPENTER_CLOSET" "DEVICE_TYPE_CARPENTER_CLOSET_WOOD" "DEVICE_TYPE_CARPENTER_CLOSET_METAL" "DEVICE_TYPE_WINDOW_DOUBLE_GLAZING" "DEVICE_TYPE_WINDOW_INSULATING_GLAZING" "DEVICE_TYPE_WINDOW_FITTINGS" "DEVICE_TYPE_WINDOW_WINDOW_FRAME" "DEVICE_TYPE_WINDOW_SPECIAL_GLAZING" "DEVICE_TYPE_WINDOW_WINDOW_SILL" "DEVICE_TYPE_WINDOW" "DEVICE_TYPE_WINDOW_DOUBLE" "DEVICE_TYPE_WINDOW_TRIPLE" "DEVICE_TYPE_WINDOW_WINDOW_SILL_WOOD" "DEVICE_TYPE_WINDOW_WINDOW_SILL_WOOD_PAINTED" "DEVICE_TYPE_WINDOW_WINDOW_SILL_TILES" "DEVICE_TYPE_WINDOW_WINDOW_SILL_STONE" "DEVICE_TYPE_LOCKING_LOCK" "DEVICE_TYPE_LOCKING_KEY" "DEVICE_TYPE_LOCKING_WIRELESS_TRANSMITTER" "DEVICE_TYPE_LOCKING" "DEVICE_TYPE_INTERIOR_FINISHES" "DEVICE_TYPE_ELEMENT_WALL" "DEVICE_TYPE_CHROME_STEEP_FINISH" "DEVICE_TYPE_OTHER_INTERIOR1" "DEVICE_TYPE_FLOORING_COVERING" "DEVICE_TYPE_FLOORING_BALL_YARN" "DEVICE_TYPE_FLOORING_LAMINATE" "DEVICE_TYPE_FLOORING_LINOLEUM" "DEVICE_TYPE_FLOORING_VINYL" "DEVICE_TYPE_FLOORING_DIRT_TRAP_CARPET" "DEVICE_TYPE_FLOORING_PARQUET" "DEVICE_TYPE_FLOORING_PARQUET_SEALING" "DEVICE_TYPE_FLOORING_FLOOR_UNDERLAY" "DEVICE_TYPE_FLOORING_INSTALLATION_FLOOR" "DEVICE_TYPE_FLOORING_TILES" "DEVICE_TYPE_FLOORING_CARPET" "DEVICE_TYPE_FLOORING_SKIRTING" "DEVICE_TYPE_FLOORING_JOINT" "DEVICE_TYPE_FLOORING" "DEVICE_TYPE_FLOORING_PVC" "DEVICE_TYPE_FLOORING_RUBBER" "DEVICE_TYPE_FLOORING_CORK" "DEVICE_TYPE_FLOORING_LAMINATE_MEDIUM_QUALITY" "DEVICE_TYPE_FLOORING_LAMINATE_HIGH_QUALITY" "DEVICE_TYPE_FLOORING_TILES_SOUND_PLATES" "DEVICE_TYPE_FLOORING_TILES_NATURAL_STONE_SOFT" "DEVICE_TYPE_FLOORING_TILES_NATURAL_STONE_HARD" "DEVICE_TYPE_FLOORING_TILES_CERAMIC" "DEVICE_TYPE_FLOORING_TILES_STONEWARE" "DEVICE_TYPE_FLOORING_TILES_ARTIFICIAL_STONE" "DEVICE_TYPE_FLOORING_PARQUET_ADHESIVE" "DEVICE_TYPE_FLOORING_PARQUET_HARDWOOD" "DEVICE_TYPE_FLOORING_PARQUET_SOFTWOOD" "DEVICE_TYPE_FLOORING_PARQUET_FOURNIER" "DEVICE_TYPE_FLOORING_CARPET_NATURAL_FIBER" "DEVICE_TYPE_FLOORING_CARPET_BALL_YARN" "DEVICE_TYPE_FLOORING_CARPET_NEEDLE_FELT" "DEVICE_TYPE_FLOORING_CARPET_MEDIUM_QUALITY" "DEVICE_TYPE_FLOORING_SKIRTING_PLASTIC" "DEVICE_TYPE_FLOORING_SKIRTING_WOOD" "DEVICE_TYPE_FLOORING_RAW" "DEVICE_TYPE_FLOORING_COATED" "DEVICE_TYPE_WALL_COVERING_WORK" "DEVICE_TYPE_WALL_COVERING_WALLPAPER" "DEVICE_TYPE_WALL_COVERING_PLASTER" "DEVICE_TYPE_WALL_COVERING_ABRASION" "DEVICE_TYPE_WALL_COVERING_WOOD_WORKER" "DEVICE_TYPE_WALL_COVERING" "DEVICE_TYPE_WALL_COVERING_WALLPAPER_MEDIUM_QUALITY" "DEVICE_TYPE_WALL_COVERING_WALLPAPER_GOOD_QUALITY" "DEVICE_TYPE_WALL_COVERING_WALLPAPER_GLASS_FIBER" "DEVICE_TYPE_WALL_COVERING_PLASTER_GLUE_COLOR" "DEVICE_TYPE_WALL_COVERING_PLASTER_ACRYL" "DEVICE_TYPE_WALL_COVERING_PLASTER_MINERALS" "DEVICE_TYPE_WALL_COVERING_PLASTER_PLASTIC" "DEVICE_TYPE_WALL_COVERING_PLASTER_SILICATE_COATING" "DEVICE_TYPE_WALL_COVERING_PLASTER_DISPERSION_PAINT" "DEVICE_TYPE_WALL_COVERING_ABRASION_PLASTIC" "DEVICE_TYPE_WALL_COVERING_ABRASION_ROUGH_PUTT" "DEVICE_TYPE_WALL_COVERING_ABRASION_WHITE_PLASTER" "DEVICE_TYPE_WALL_COVERING_WOOD_WORKER_WALL_ROUGH" "DEVICE_TYPE_WALL_COVERING_WOOD_WORKER_LASED" "DEVICE_TYPE_WALL_COVERING_WOOD_WORKER_PAINTED_OPAQUE" "DEVICE_TYPE_WALL_COVERING_WOOD_WORKER_GLAZE" "DEVICE_TYPE_WALL_COVERING_CERAMIC" "DEVICE_TYPE_WALL_COVERING_STONEWORK" "DEVICE_TYPE_WALL_COVERING_STONEWARE" "DEVICE_TYPE_WALL_COVERING_TILES" "DEVICE_TYPE_CEILING_WORK" "DEVICE_TYPE_CEILING_WALLPAPER" "DEVICE_TYPE_CEILING_PLASTER" "DEVICE_TYPE_CEILING_ABRASION" "DEVICE_TYPE_CEILING_WOOD_WORKER" "DEVICE_TYPE_CEILING" "DEVICE_TYPE_CEILING_REGULAR" "DEVICE_TYPE_CEILING_REGULAR_METAL" "DEVICE_TYPE_CEILING_REGULAR_WOOD" "DEVICE_TYPE_CEILING_COVERING_ABRASION_PLASTIC" "DEVICE_TYPE_CEILING_COVERING_ABRASION_ROUGH_PUTT" "DEVICE_TYPE_CEILING_COVERING_ABRASION_WHITE_PLASTER" "DEVICE_TYPE_INTERIOR_SURFACE_TREATMENTS_PAINTING" "DEVICE_TYPE_OTHER_INTERIOR2_SHUTTER" "DEVICE_TYPE_OTHER_INTERIOR2_SHUTTER_MOTOR" "DEVICE_TYPE_OTHER_INTERIOR2_BLADE" "DEVICE_TYPE_OTHER_INTERIOR2_BLIND" "DEVICE_TYPE_OTHER_INTERIOR2_LETTER_BOX" "DEVICE_TYPE_OTHER_INTERIOR2" "DEVICE_TYPE_OTHER_INTERIOR2_SETS" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_SOAP_HOLDER" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_TOOTH_GLASS" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_GLASS_SHELF" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_TOWEL_BARS" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_HOLDING_RACK" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_CURTAIN_ROD" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_PACKAGE" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_WASHBASIN_BOWL" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_BATH_TOWEL_HOLDER" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_BATH_TOWEL_HOLDER_CHROME_STEEL" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_BATH_TOWEL_HOLDER_PLASTIC" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_BATH_TOWEL_HOLDER_HOOK" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_PAPER_HOLDER" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_PAPER_HOLDER_CHROME_STEEL" "DEVICE_TYPE_OTHER_INTERIOR2_SETS_PAPER_HOLDER_PLASTIC" "DEVICE_TYPE_OTHER_INTERIOR2_ARMATURE" "DEVICE_TYPE_OTHER_INTERIOR2_ARMATURE_SINGLE_LEVER" "DEVICE_TYPE_OTHER_INTERIOR2_DOUBLE_LEVER" "DEVICE_TYPE_OTHER_INTERIOR2_ARMATURE_SWIVEL" "DEVICE_TYPE_OTHER_INTERIOR2_ARMATURE_PULL_OUT_SPRAY" "DEVICE_TYPE_OTHER_INTERIOR2_ARMATURE_THERMAL_MIXER" "DEVICE_TYPE_OTHER_INTERIOR2_OPERATING_GARNITURE" "DEVICE_TYPE_OTHER_INTERIOR2_CRANK" "DEVICE_TYPE_OTHER_INTERIOR2_BELT" "DEVICE_TYPE_OTHER_INTERIOR2_ELECTRIC" "DEVICE_TYPE_OTHER_TRANSPORT_CONTAINER" "DEVICE_TYPE_OTHER_TRANSPORT_CONTAINER_PLASTIC_GREEN" "DEVICE_TYPE_OTHER_TRANSPORT_CONTAINER_PLASTIC_BLACK" "DEVICE_TYPE_OTHER_TRANSPORT_CONTAINER_METAL" "DEVICE_TYPE_GARDENING_TRANSITION_POSITION_OUTDOOR_PARKING" "DEVICE_TYPE_GARDENING_TRANSITION_POSITION_PLANTING" "DEVICE_TYPE_GARDENING_TRANSITION_POSITION_GROUND_MARKING" "DEVICE_TYPE_GARDENING_TRANSITION_POSITION_CONTAINER_SITE" "DEVICE_TYPE_GARDENING_TRANSITION_POSITION_BIKE_SHELTER" "DEVICE_TYPE_GARDENING_TRANSITION_POSITION_ACCESS_PATH" "DEVICE_TYPE_GARDENING_FENCE" "DEVICE_TYPE_GARDENING_WALLS" "DEVICE_TYPE_GARDENING_CEMENT_BOARD" "DEVICE_TYPE_GARDENING_ACCESS_PATH" "DEVICE_TYPE_GARDENING_LAWN" "DEVICE_TYPE_GARDENING" "DEVICE_TYPE_FENCING" "DEVICE_TYPE_SUPERSTRUCTURE_TERRANCE" "DEVICE_TYPE_SUPERSTRUCTURE_BIKE_STAND" "DEVICE_TYPE_SUPERSTRUCTURE" "DEVICE_TYPE_SUPERSTRUCTURE_RAILING" "DEVICE_TYPE_SUPERSTRUCTURE_RAILING_SAFETY_GLASS" "DEVICE_TYPE_SUPERSTRUCTURE_RAILING_METAL" "DEVICE_TYPE_SUPERSTRUCTURE_RAILING_CHROME_STEEL" "DEVICE_TYPE_SUPERSTRUCTURE_RAILING_CONCRETE" "DEVICE_TYPE_PLAYGROUND" "DEVICE_TYPE_PLAYGROUND_DEVICE" "DEVICE_TYPE_GARDEN_OTHER" "DEVICE_TYPE_DEVICE_TRANSITION_POSITION_FIRE_EXTINGUISHER" "DEVICE_TYPE_DEVICE_TRANSITION_POSITION_LAWN_MOWER" "DEVICE_TYPE_DEVICE_TRANSITION_POSITION_SECURITY_CAMERA" "DEVICE_TYPE_DEVICE_TRANSITION_POSITION_INDOOR_BIKE_SHELTER" "DEVICE_TYPE_AIR_COMPRESSOR" "DEVICE_TYPE_GAS_SYSTEM_LABORATORY" "DEVICE_TYPE_HOIST_CRANE" "DEVICE_TYPE_HEATING_DISTRIBUTOR" "DEVICE_TYPE_INTERIOR_METAL_DOORS" "DEVICE_TYPE_INTERIOR_METAL_BALCONY_GLAZING" "DEVICE_TYPE_REFRIGERATING_MACHINE" "DEVICE_TYPE_REFRIGERATED_CEILING" "DEVICE_TYPE_COOLING_DISTRIBUTOR" "DEVICE_TYPE_VENTILATION_MONOBLOCK" "DEVICE_TYPE_NEUTRALIZATION_SYSTEM" "DEVICE_TYPE_PURE_WATER_SYSTEM" "DEVICE_TYPE_WATER_SYSTEM_SEPARATOR" "DEVICE_TYPE_RECIRCULATING_AIR_COOLING_UNIT" "DEVICE_TYPE_RECIRCULATING_AIR_COOLER" "DEVICE_TYPE_STAIR" "DEVICE_TYPE_WARDROBE" "DEVICE_TYPE_COAT_HOOKS" "DEVICE_TYPE_GATE" "DEVICE_TYPE_CURTAIN_RAIL" "DEVICE_TYPE_FURNITURE_BEDROOM_BED" "DEVICE_TYPE_FURNITURE_BEDROOM_BEDSIDE_TABLE" "DEVICE_TYPE_FURNITURE_BEDROOM_DRESSER" "DEVICE_TYPE_FURNITURE_BEDROOM_WARDROBE" "DEVICE_TYPE_FURNITURE_LIVING_ROOM_TABLE" "DEVICE_TYPE_FURNITURE_LIVING_ROOM_DINING_TABLE" "DEVICE_TYPE_FURNITURE_OFFICE_DESK" "DEVICE_TYPE_FURNITURE_OFFICE_CHAIR" "DEVICE_TYPE_FURNITURE_OFFICE_STOOL" "DEVICE_TYPE_FURNITURE_LIVING_ROOM_CHAIR" "DEVICE_TYPE_FURNITURE_LIVING_ROOM_ARMCHAIR" "DEVICE_TYPE_FURNITURE_BEDROOM_MATTRESS" "DEVICE_TYPE_FURNITURE_LIVING_ROOM_SOFA" "DEVICE_TYPE_ELECTRONICS_ENTERTAINMENT_TELEVISION" "DEVICE_TYPE_ELECTRONICS_ENTERTAINMENT_REMOTE_CONTROL" "DEVICE_TYPE_TEXTILES_BEDROOM_BED_LINEN" "DEVICE_TYPE_TEXTILES_BATHROOM_TOWELS" "DEVICE_TYPE_DECORATION_WALL_DECORATION_PICTURE" "DEVICE_TYPE_DECORATION_BATHROOM_WALL_MIRROR" "DEVICE_TYPE_HOUSEHOLD_GOODS_BATHROOM_LAUNDRY_BASKET" "DEVICE_TYPE_HOUSEHOLD_GOODS_OFFICE_WASTE_PAPER_BASKET" "DEVICE_TYPE_HOUSEHOLD_GOODS_KITCHEN_DISHES" "DEVICE_TYPE_OUTER_FINISHES_HAIL_PROTECTION" "DEVICE_TYPE_HEAVY_CURRENT_INSTALLATION_FIRE_ALARM_SYSTEM" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_EMERGENCY_LIGHT" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_ALARM_NET" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_ZEV_METER" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_ELECTRICITY_METER" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_CONTROL_UNIT" "DEVICE_TYPE_CARPENTER_HALLWAY_WARDROBE" "DEVICE_TYPE_SUPERSTRUCTURE_OUTDOOR_SEATING_AREA" "DEVICE_TYPE_MEDICAL_DEVICES_DEFIBRILLATOR_AED" "DEVICE_TYPE_ELECTRONICS_DESIGN_TABLET" "DEVICE_TYPE_LABELS_MARKINGS_SIGNAGE" "DEVICE_TYPE_LOW_CURRENT_INSTALLATION_MODEM_ROUTER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_REFRIGERATOR_ACCESSORIES_EGG_CONTAINER" "DEVICE_TYPE_KITCHEN_EQUIPMENT_FREEZER_ACCESSORIES_ICE_CUBE_TRAY" "DEVICE_TYPE_KITCHEN_EQUIPMENT_COMBI_STEAMER" "DEVICE_TYPE_LOCKING_CARD_READER" "DEVICE_TYPE_ENERGY_SUPPLY_GAS_METER" "DEVICE_TYPE_COOLING_ENERGY_METER" "DEVICE_TYPE_OTHER_INTERIOR1_COIN_COUNTER" "DEVICE_TYPE_HEAT_GENERATION_HEAT_TRACING" "DEVICE_TYPE_OTHER_SANITARY_SPRINKLER_SYSTEM" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_WATER_FILTER" "DEVICE_TYPE_SANITARY_SUPPLY_DISPOSAL_WATER_METER" "DEVICE_TYPE_CIRCULATION_PUMP"
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

unit
string (objectdeviceDeviceUnit)
Default: "DEVICE_UNIT_UNDEFINED"
Enum: "DEVICE_UNIT_UNDEFINED" "DEVICE_UNIT_L" "DEVICE_UNIT_KG" "DEVICE_UNIT_M2" "DEVICE_UNIT_M3" "DEVICE_UNIT_PCS" "DEVICE_UNIT_M" "DEVICE_UNIT_FLAT_RATE"
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

Responses

Request samples

Content type
application/json
{
  • "acquisitionCosts": 0.1,
  • "amount": 0,
  • "assetNumberFm": "string",
  • "bkpH": "string",
  • "brand": "string",
  • "cataloguePrice": 0.1,
  • "condition": "DEVICE_CONDITION_UNDEFINED",
  • "conditionNote": "string",
  • "documentIds": [
    ],
  • "facilityPlant": "DEVICE_FACILITY_PLANT_UNDEFINED",
  • "images": [
    ],
  • "inspection": {
    },
  • "installation": {
    },
  • "lifeSpan": 0,
  • "lockingKey": {
    },
  • "maintenance": {
    },
  • "manufacturer": "string",
  • "measure": "DEVICE_MEASURE_UNDEFINED",
  • "measureUntil": {
    },
  • "model": "string",
  • "note": "string",
  • "order": 0,
  • "referenceId": "string",
  • "revision": {
    },
  • "roomId": "string",
  • "serialNumber": "string",
  • "system": "DEVICE_SYSTEM_UNDEFINED",
  • "type": "DEVICE_TYPE_UNDEFINED",
  • "uninstallation": {
    },
  • "unit": "DEVICE_UNIT_UNDEFINED",
  • "warrantyEnd": {
    }
}

Response samples

Content type
application/json
{
  • "device": {
    }
}

EnergySourceService

Create an energy source

Creates a new energy source for the given owner and referenceId. Accepts kind, type, heat/cost distribution, consumption metrics, tank readings, orders, and document IDs. Returns the created energy source.

Request Body schema: application/json
required
co2PerYear
required
number <float>
consumption
required
number <float>
consumptionKwhPerYear
required
number <float>
costDistribution
required
string (energy_sourceCostDistribution)
Default: "COST_DISTRIBUTION_UNDEFINED"
Enum: "COST_DISTRIBUTION_UNDEFINED" "COST_DISTRIBUTION_NONE" "COST_DISTRIBUTION_CONSUMPTION" "COST_DISTRIBUTION_FIXED_KEY"
costDistribution2
required
string (energy_sourceCostDistribution)
Default: "COST_DISTRIBUTION_UNDEFINED"
Enum: "COST_DISTRIBUTION_UNDEFINED" "COST_DISTRIBUTION_NONE" "COST_DISTRIBUTION_CONSUMPTION" "COST_DISTRIBUTION_FIXED_KEY"
documentIds
required
Array of strings
energyReferenceArea
required
number <float>
heatDistribution
required
string (energy_sourceHeatDistribution)
Default: "HEAT_DISTRIBUTION_UNDEFINED"
Enum: "HEAT_DISTRIBUTION_UNDEFINED" "HEAT_DISTRIBUTION_RADIATORS" "HEAT_DISTRIBUTION_FLOOR_HEATING" "HEAT_DISTRIBUTION_CEILING_HEATING"
kind
required
string (energy_sourceEnergySourceKind)
Default: "ENERGY_SOURCE_KIND_UNDEFINED"
Enum: "ENERGY_SOURCE_KIND_UNDEFINED" "ENERGY_SOURCE_KIND_HEATER" "ENERGY_SOURCE_KIND_HOT_WATER" "ENERGY_SOURCE_KIND_HEATER_AND_HOT_WATER"
required
Array of objects (energy_sourceOrder)
ownerId
required
string <int64>
photovoltaic
required
boolean
referenceId
required
string
selfConsumptionCommunity
required
boolean
required
Array of objects (objectenergy_sourceTankReading)
tankSize
required
number <float>
type
required
string (objectenergy_sourceEnergySourceType)
Default: "ENERGY_SOURCE_TYPE_UNDEFINED"
Enum: "ENERGY_SOURCE_TYPE_UNDEFINED" "ENERGY_SOURCE_NO" "ENERGY_SOURCE_AIR" "ENERGY_SOURCE_GEOTHERMAL_ENERGY" "ENERGY_SOURCE_GEOTHERMAL_PROBE" "ENERGY_SOURCE_EARTH_TUBE" "ENERGY_SOURCE_WATER" "ENERGY_SOURCE_GAS" "ENERGY_SOURCE_OIL" "ENERGY_SOURCE_WOOD_GENERIC" "ENERGY_SOURCE_WOOD" "ENERGY_SOURCE_WOOD_PELLETS" "ENERGY_SOURCE_WOOD_CHIPS" "ENERGY_SOURCE_WASTE_HEAT" "ENERGY_SOURCE_ELECTRICITY" "ENERGY_SOURCE_SUN" "ENERGY_SOURCE_DISTRICT_HEATING_GENERIC" "ENERGY_SOURCE_DISTRICT_HEATING_HIGH" "ENERGY_SOURCE_DISTRICT_HEATING_LOW" "ENERGY_SOURCE_HEAT_PUMP" "ENERGY_SOURCE_OTHER"
unit
required
string (objectenergy_sourceEnergySourceUnit)
Default: "ENERGY_SOURCE_UNIT_UNDEFINED"
Enum: "ENERGY_SOURCE_UNIT_UNDEFINED" "ENERGY_SOURCE_UNIT_L" "ENERGY_SOURCE_UNIT_KG" "ENERGY_SOURCE_UNIT_M3" "ENERGY_SOURCE_UNIT_KWH"

Responses

Request samples

Content type
application/json
{
  • "co2PerYear": 0.1,
  • "consumption": 0.1,
  • "consumptionKwhPerYear": 0.1,
  • "costDistribution": "COST_DISTRIBUTION_UNDEFINED",
  • "costDistribution2": "COST_DISTRIBUTION_UNDEFINED",
  • "documentIds": [
    ],
  • "energyReferenceArea": 0.1,
  • "heatDistribution": "HEAT_DISTRIBUTION_UNDEFINED",
  • "kind": "ENERGY_SOURCE_KIND_UNDEFINED",
  • "orders": [
    ],
  • "ownerId": "string",
  • "photovoltaic": true,
  • "referenceId": "string",
  • "selfConsumptionCommunity": true,
  • "tankReadings": [
    ],
  • "tankSize": 0.1,
  • "type": "ENERGY_SOURCE_TYPE_UNDEFINED",
  • "unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}

Response samples

Content type
application/json
{
  • "energySource": {
    }
}

List energy sources by IDs

Returns the energy sources matching the given IDs.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "energySources": [
    ]
}

List energy sources by reference IDs

Returns the energy sources matching the given reference IDs.

Request Body schema: application/json
required
referenceIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "referenceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "energySources": [
    ]
}

Delete energy sources

Deletes the energy sources with the given IDs.

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{ }

Update an energy source

Updates an existing energy source by ID. Accepts kind, type, heat/cost distribution, consumption metrics, tank readings, orders, and document IDs. Returns the updated energy source.

path Parameters
id
required
string
Request Body schema: application/json
required
co2PerYear
number <float>
consumption
number <float>
consumptionKwhPerYear
number <float>
costDistribution
string (energy_sourceCostDistribution)
Default: "COST_DISTRIBUTION_UNDEFINED"
Enum: "COST_DISTRIBUTION_UNDEFINED" "COST_DISTRIBUTION_NONE" "COST_DISTRIBUTION_CONSUMPTION" "COST_DISTRIBUTION_FIXED_KEY"
costDistribution2
string (energy_sourceCostDistribution)
Default: "COST_DISTRIBUTION_UNDEFINED"
Enum: "COST_DISTRIBUTION_UNDEFINED" "COST_DISTRIBUTION_NONE" "COST_DISTRIBUTION_CONSUMPTION" "COST_DISTRIBUTION_FIXED_KEY"
documentIds
Array of strings
energyReferenceArea
number <float>
heatDistribution
string (energy_sourceHeatDistribution)
Default: "HEAT_DISTRIBUTION_UNDEFINED"
Enum: "HEAT_DISTRIBUTION_UNDEFINED" "HEAT_DISTRIBUTION_RADIATORS" "HEAT_DISTRIBUTION_FLOOR_HEATING" "HEAT_DISTRIBUTION_CEILING_HEATING"
kind
string (energy_sourceEnergySourceKind)
Default: "ENERGY_SOURCE_KIND_UNDEFINED"
Enum: "ENERGY_SOURCE_KIND_UNDEFINED" "ENERGY_SOURCE_KIND_HEATER" "ENERGY_SOURCE_KIND_HOT_WATER" "ENERGY_SOURCE_KIND_HEATER_AND_HOT_WATER"
Array of objects (energy_sourceOrder)
photovoltaic
boolean
selfConsumptionCommunity
boolean
Array of objects (objectenergy_sourceTankReading)
tankSize
number <float>
type
string (objectenergy_sourceEnergySourceType)
Default: "ENERGY_SOURCE_TYPE_UNDEFINED"
Enum: "ENERGY_SOURCE_TYPE_UNDEFINED" "ENERGY_SOURCE_NO" "ENERGY_SOURCE_AIR" "ENERGY_SOURCE_GEOTHERMAL_ENERGY" "ENERGY_SOURCE_GEOTHERMAL_PROBE" "ENERGY_SOURCE_EARTH_TUBE" "ENERGY_SOURCE_WATER" "ENERGY_SOURCE_GAS" "ENERGY_SOURCE_OIL" "ENERGY_SOURCE_WOOD_GENERIC" "ENERGY_SOURCE_WOOD" "ENERGY_SOURCE_WOOD_PELLETS" "ENERGY_SOURCE_WOOD_CHIPS" "ENERGY_SOURCE_WASTE_HEAT" "ENERGY_SOURCE_ELECTRICITY" "ENERGY_SOURCE_SUN" "ENERGY_SOURCE_DISTRICT_HEATING_GENERIC" "ENERGY_SOURCE_DISTRICT_HEATING_HIGH" "ENERGY_SOURCE_DISTRICT_HEATING_LOW" "ENERGY_SOURCE_HEAT_PUMP" "ENERGY_SOURCE_OTHER"
unit
string (objectenergy_sourceEnergySourceUnit)
Default: "ENERGY_SOURCE_UNIT_UNDEFINED"
Enum: "ENERGY_SOURCE_UNIT_UNDEFINED" "ENERGY_SOURCE_UNIT_L" "ENERGY_SOURCE_UNIT_KG" "ENERGY_SOURCE_UNIT_M3" "ENERGY_SOURCE_UNIT_KWH"

Responses

Request samples

Content type
application/json
{
  • "co2PerYear": 0.1,
  • "consumption": 0.1,
  • "consumptionKwhPerYear": 0.1,
  • "costDistribution": "COST_DISTRIBUTION_UNDEFINED",
  • "costDistribution2": "COST_DISTRIBUTION_UNDEFINED",
  • "documentIds": [
    ],
  • "energyReferenceArea": 0.1,
  • "heatDistribution": "HEAT_DISTRIBUTION_UNDEFINED",
  • "kind": "ENERGY_SOURCE_KIND_UNDEFINED",
  • "orders": [
    ],
  • "photovoltaic": true,
  • "selfConsumptionCommunity": true,
  • "tankReadings": [
    ],
  • "tankSize": 0.1,
  • "type": "ENERGY_SOURCE_TYPE_UNDEFINED",
  • "unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}

Response samples

Content type
application/json
{
  • "energySource": {
    }
}

FahrlaenderService

Load Fahrlaender configuration

Returns the Fahrlaender API configuration for the given account, including credentials and enabled features.

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "configuration": {
    }
}

Save Fahrlaender configuration

Saves the Fahrlaender API configuration for the given account, including apiUser, apiPassword, and enabled features (micro location and/or market rent).

path Parameters
accountId
required
string <int64>
Request Body schema: application/json
required
apiPassword
string
apiUser
string
features
Array of strings (fahrlaenderFahrlaenderFeatures)
Items Enum: "FAHRLAENDER_FEATURES_UNDEFINED" "FAHRLAENDER_FEATURES_MICRO_LOCATION" "FAHRLAENDER_FEATURES_MARKET_RENT"

Responses

Request samples

Content type
application/json
{
  • "apiPassword": "string",
  • "apiUser": "string",
  • "features": [
    ]
}

Response samples

Content type
application/json
{ }

Update market rents via Fahrlaender

Triggers market rent update commands for the given account. Returns the number of commands published.

path Parameters
accountId
required
string <int64>
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "commandsPublished": 0
}

Update micro location ratings via Fahrlaender

Triggers micro location rating update commands for the given account. Returns the number of commands published.

path Parameters
accountId
required
string <int64>
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "commandsPublished": 0
}

HandoverProtocolService

Count my draft handover protocols

Returns the number of draft handover protocols assigned to the authenticated caller.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Create a handover protocol

Creates a new handover protocol for the given owner. Accepts move-out/move-in tenancy references, assignee, participants, schedule, rooms, devices without a room, an optional note, draft flag, and optional templateId. Returns the created protocol.

Request Body schema: application/json
required
assigneeContactId
required
string
required
Array of objects (objecthandover_protocolDevice)
draft
required
boolean
required
Array of objects (handover_protocolWriteTenancyReference)
required
Array of objects (handover_protocolWriteTenancyReference)
note
required
string
ownerId
required
string <int64>
required
Array of objects (handover_protocolWriteParticipant)
required
Array of objects (objecthandover_protocolRoom)
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (typeTimeOfDay)

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

templateId
required
string

Responses

Request samples

Content type
application/json
{
  • "assigneeContactId": "string",
  • "devicesWithoutRoom": [
    ],
  • "draft": true,
  • "movingInTenancyReferences": [
    ],
  • "movingOutTenancyReferences": [
    ],
  • "note": "string",
  • "ownerId": "string",
  • "participants": [
    ],
  • "rooms": [
    ],
  • "scheduledDate": {
    },
  • "scheduledTime": {
    },
  • "templateId": "string"
}

Response samples

Content type
application/json
{
  • "protocol": {
    }
}

Enable or disable handover protocol

Enables or disables the handover protocol feature for the given account according to the enable flag.

path Parameters
accountId
required
string <int64>
Request Body schema: application/json
required
enable
boolean

Responses

Request samples

Content type
application/json
{
  • "enable": true
}

Response samples

Content type
application/json
{ }

Check if handover protocol is enabled

Returns whether the handover protocol feature is enabled for the given account.

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "enabled": true
}

List all handover protocols

Returns a paginated list of all handover protocols visible to the authenticated caller. Supports optional filtering by protocol status. Set page to 0 to disable pagination. Response includes total protocol and page counts.

query Parameters
page
integer <int32>

Optional. If set to 0 then no pagination is enabled.

itemsPerPage
integer <int32>
statuses
Array of strings
Items Enum: "PROTOCOL_STATUS_UNDEFINED" "PROTOCOL_STATUS_DRAFT" "PROTOCOL_STATUS_SENT_TO_APP" "PROTOCOL_STATUS_FINISHED"

Optional filter.

Responses

Response samples

Content type
application/json
{
  • "protocols": [
    ],
  • "totalPages": 0,
  • "totalProtocols": 0
}

List handover protocols by IDs

Returns the handover protocols matching the given protocol IDs.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "protocols": [
    ]
}

List handover protocols by object IDs

Returns handover protocols linked to any of the given object IDs via move-out or move-in tenancy references.

Request Body schema: application/json
required
objectIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "objectIds": [
    ]
}

Response samples

Content type
application/json
{
  • "protocols": [
    ]
}

List my handover protocols

Returns a paginated list of handover protocols assigned to the authenticated caller. Supports optional filtering by protocol status. Set page to 0 to disable pagination. Response includes total protocol and page counts.

query Parameters
page
integer <int32>

Optional. If set to 0 then no pagination is enabled.

itemsPerPage
integer <int32>
statuses
Array of strings
Items Enum: "PROTOCOL_STATUS_UNDEFINED" "PROTOCOL_STATUS_DRAFT" "PROTOCOL_STATUS_SENT_TO_APP" "PROTOCOL_STATUS_FINISHED"

Optional filter.

Responses

Response samples

Content type
application/json
{
  • "protocols": [
    ],
  • "totalPages": 0,
  • "totalProtocols": 0
}

List other users' handover protocols

Returns a paginated list of handover protocols assigned to other users (not the authenticated caller). Supports optional filtering by protocol status. Set page to 0 to disable pagination. Response includes total protocol and page counts.

query Parameters
page
integer <int32>

Optional. If set to 0 then no pagination is enabled.

itemsPerPage
integer <int32>
statuses
Array of strings
Items Enum: "PROTOCOL_STATUS_UNDEFINED" "PROTOCOL_STATUS_DRAFT" "PROTOCOL_STATUS_SENT_TO_APP" "PROTOCOL_STATUS_FINISHED"

Optional filter.

Responses

Response samples

Content type
application/json
{
  • "protocols": [
    ],
  • "totalPages": 0,
  • "totalProtocols": 0
}

Create a handover protocol template

Creates a new handover protocol template for the given owner with name, property references, room/device layout, and devices without a room. Returns the created template.

Request Body schema: application/json
required
devicesWithoutRoomIds
required
Array of strings
name
required
string
ownerId
required
string <int64>
required
Array of objects (handover_protocolTemplateRoom)
required
Array of objects (handover_protocolTemplateReference)

Responses

Request samples

Content type
application/json
{
  • "devicesWithoutRoomIds": [
    ],
  • "name": "string",
  • "ownerId": "string",
  • "rooms": [
    ],
  • "templateReferences": [
    ]
}

Response samples

Content type
application/json
{
  • "template": {
    }
}

List handover protocol templates for an account

Returns all handover protocol templates belonging to the given account.

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "templates": [
    ]
}

List handover protocol templates by property ID

Returns handover protocol templates linked to the given property ID.

path Parameters
propertyId
required
string

Responses

Response samples

Content type
application/json
{
  • "templates": [
    ]
}

Delete handover protocol templates

Deletes the handover protocol templates with the given IDs.

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{ }

Get a handover protocol template by ID

Returns the handover protocol template identified by the given ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "template": {
    }
}

Set favorite flag on a handover protocol template

Sets or clears the favorite flag on the handover protocol template identified by ID. Returns the updated template.

path Parameters
id
required
string
Request Body schema: application/json
required
favorite
boolean

Responses

Request samples

Content type
application/json
{
  • "favorite": true
}

Response samples

Content type
application/json
{
  • "template": {
    }
}

Update a handover protocol template

Updates an existing handover protocol template by ID (name, property references, rooms, and devices without a room). Returns the updated template.

path Parameters
id
required
string
Request Body schema: application/json
required
devicesWithoutRoomIds
Array of strings
name
string
Array of objects (handover_protocolTemplateRoom)
Array of objects (handover_protocolTemplateReference)

Responses

Request samples

Content type
application/json
{
  • "devicesWithoutRoomIds": [
    ],
  • "name": "string",
  • "rooms": [
    ],
  • "templateReferences": [
    ]
}

Response samples

Content type
application/json
{
  • "template": {
    }
}

Delete a handover protocol

Deletes the handover protocol with the given ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get handover protocol PDF preview

Generates and returns a PDF preview of the handover protocol identified by ID, rendered in the requested preferred language.

path Parameters
id
required
string
query Parameters
language
string
Default: "PREFERRED_LANGUAGE_UNDEFINED"
Enum: "PREFERRED_LANGUAGE_UNDEFINED" "PREFERRED_LANGUAGE_GERMAN" "PREFERRED_LANGUAGE_ENGLISH" "PREFERRED_LANGUAGE_ITALIAN" "PREFERRED_LANGUAGE_FRENCH"

Responses

Response samples

Content type
application/json
{
  • "pdf": "string"
}

Save handover protocol inspection data

Persists inspection data for an existing handover protocol by ID: participants (including new contacts), rooms, devices without a room, and note. Rooms and devices can be created, updated, or marked deleted. Returns the updated protocol.

path Parameters
id
required
string
Request Body schema: application/json
required
Array of objects (handover_protocolSaveDataDevice)
note
string
Array of objects (handover_protocolSaveDataParticipant)
Array of objects (handover_protocolSaveDataRoom)

Responses

Request samples

Content type
application/json
{
  • "devicesWithoutRoom": [
    ],
  • "note": "string",
  • "participants": [
    ],
  • "rooms": [
    ]
}

Response samples

Content type
application/json
{
  • "protocol": {
    }
}

Sign a handover protocol

Applies participant signatures to the handover protocol identified by ID and finalizes signing in the requested preferred language. Returns the updated protocol.

path Parameters
id
required
string
Request Body schema: application/json
required
language
string (languagePreferredLanguage)
Default: "PREFERRED_LANGUAGE_UNDEFINED"
Enum: "PREFERRED_LANGUAGE_UNDEFINED" "PREFERRED_LANGUAGE_GERMAN" "PREFERRED_LANGUAGE_ENGLISH" "PREFERRED_LANGUAGE_ITALIAN" "PREFERRED_LANGUAGE_FRENCH"
Array of objects (objecthandover_protocolSignature)

Responses

Request samples

Content type
application/json
{
  • "language": "PREFERRED_LANGUAGE_UNDEFINED",
  • "signatures": [
    ]
}

Response samples

Content type
application/json
{
  • "protocol": {
    }
}

Update a handover protocol

Updates an existing handover protocol by ID. Accepts move-out/move-in tenancy references, assignee, participants, schedule, rooms, devices without a room, note, draft flag, and optional templateId. Returns the updated protocol.

path Parameters
id
required
string
Request Body schema: application/json
required
assigneeContactId
string
Array of objects (objecthandover_protocolDevice)
draft
boolean
Array of objects (handover_protocolWriteTenancyReference)
Array of objects (handover_protocolWriteTenancyReference)
note
string
Array of objects (handover_protocolWriteParticipant)
Array of objects (objecthandover_protocolRoom)
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

object (typeTimeOfDay)

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

templateId
string

Responses

Request samples

Content type
application/json
{
  • "assigneeContactId": "string",
  • "devicesWithoutRoom": [
    ],
  • "draft": true,
  • "movingInTenancyReferences": [
    ],
  • "movingOutTenancyReferences": [
    ],
  • "note": "string",
  • "participants": [
    ],
  • "rooms": [
    ],
  • "scheduledDate": {
    },
  • "scheduledTime": {
    },
  • "templateId": "string"
}

Response samples

Content type
application/json
{
  • "protocol": {
    }
}

InsuranceService

Create an insurance

Creates a new insurance for the given owner, attached to a reference (e.g. property or building). Accepts type, benefits, company, policy details, amounts, dates, notes, and document IDs. Returns the created insurance.

Request Body schema: application/json
required
amount
required
number <float>
benefits
required
Array of strings (insuranceInsuranceBenefit)
Items Enum: "INSURANCE_BENEFIT_UNDEFINED" "INSURANCE_BENEFIT_LIABILITY" "INSURANCE_BENEFIT_WATER" "INSURANCE_BENEFIT_LOSS_OF_RENTAL_INCOME" "INSURANCE_BENEFIT_BURGLARY_ROBBERY" "INSURANCE_BENEFIT_GLASS_BREAKAGE" "INSURANCE_BENEFIT_EXTENDED_COVERAGE" "INSURANCE_BENEFIT_BUILDING_SERVICES_FAILURE" "INSURANCE_BENEFIT_CONVERSIONS_AND_RENOVATIONS" "INSURANCE_BENEFIT_NATURAL_HAZARDS" "INSURANCE_BENEFIT_ACCIDENT_AND_SICKNESS"
documentIds
required
Array of strings
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

editedByAic
required
boolean
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

excess
required
number <float>
indexYear
required
integer <int32>
insuranceCompany
required
string
notes
required
string
ownerId
required
string <int64> (Account ID of owner (who owns the stuff in real life))
policyNumber
required
string
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

referenceId
required
string (Some opaque ID where this entity is attached to (e.g. propertyId or buildingId))
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

type
required
string (insuranceInsuranceType)
Default: "INSURANCE_TYPE_UNDEFINED"
Enum: "INSURANCE_TYPE_UNDEFINED" "INSURANCE_TYPE_FIRE_ELEMENTAL_DAMAGE" "INSURANCE_TYPE_BUILDING_PROPERTY_LIABILITY" "INSURANCE_TYPE_LIABILITY" "INSURANCE_TYPE_BUILDING_PROPERTY_INSURANCE" "INSURANCE_TYPE_LEGAL_EXPENSES" "INSURANCE_TYPE_CONSTRUCTION_LIABILITY" "INSURANCE_TYPE_CANTONAL_BUILDING_INSURANCE" "INSURANCE_TYPE_ACCIDENT_INSURANCE" "INSURANCE_TYPE_ART_IN_ARCHITECTURE" "INSURANCE_TYPE_BUSINESS_INSURANCE" "INSURANCE_TYPE_ACCIDENT_INSURANCE_UVG" "INSURANCE_TYPE_BUILDERS_LIABILITY_INSURANCE" "INSURANCE_TYPE_CONSTRUCTION_INSURANCE" "INSURANCE_TYPE_BUILDERS_LIABILITY_VISITOR_CUSTOMER_ACCIDENT" "INSURANCE_TYPE_CONSTRUCTION_VISITOR_CUSTOMER_ACCIDENT" "INSURANCE_TYPE_BUILDERS_LIABILITY_CONSTRUCTION_VISITOR_CUSTOMER_ACCIDENT" "INSURANCE_TYPE_TENANCY_DEPOSIT" "INSURANCE_TYPE_ENVIRONMENTAL_LIABILITY" "INSURANCE_TYPE_PROFESSIONAL_LIABILITY" "INSURANCE_TYPE_OBJECT" "INSURANCE_TYPE_PERSONAL_LIABILITY" "INSURANCE_TYPE_ADVANCE_PAYMENT_GUARANTEE" "INSURANCE_TYPE_BID_BOND" "INSURANCE_TYPE_PERFORMANCE_GUARANTEE" "INSURANCE_TYPE_WARRANTY_FOR_DEFECTS" "INSURANCE_TYPE_CYBER" "INSURANCE_TYPE_D_AND_O" "INSURANCE_TYPE_PROPERTY_INSURANCE" "INSURANCE_TYPE_ENGINEERING_INSURANCE" "INSURANCE_TYPE_VISITOR_CUSTOMER_ACCIDENT" "INSURANCE_TYPE_OTHER"
yearlyCosts
required
number <float>

Responses

Request samples

Content type
application/json
{
  • "amount": 0.1,
  • "benefits": [
    ],
  • "documentIds": [
    ],
  • "earliestTerminationDate": {
    },
  • "editedByAic": true,
  • "endDate": {
    },
  • "excess": 0.1,
  • "indexYear": 0,
  • "insuranceCompany": "string",
  • "notes": "string",
  • "ownerId": "string",
  • "policyNumber": "string",
  • "premiumPaidUntil": {
    },
  • "referenceId": "string",
  • "startDate": {
    },
  • "type": "INSURANCE_TYPE_UNDEFINED",
  • "yearlyCosts": 0.1
}

Response samples

Content type
application/json
{
  • "insurance": {
    }
}

List insurances by IDs

Returns the insurances matching the given insurance IDs.

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{
  • "insurances": [
    ]
}

List insurances by reference IDs

Returns insurances attached to any of the given reference IDs (e.g. property or building IDs).

path Parameters
referenceIds
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{
  • "insurances": [
    ]
}

Delete an insurance

Deletes the insurance with the given ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Add documents to an insurance

Appends document IDs to the insurance identified by ID. Returns the updated insurance.

path Parameters
id
required
string
Request Body schema: application/json
required
documentIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "documentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "insurance": {
    }
}

Update an insurance

Updates an existing insurance by ID. Accepts reference, type, benefits, company, policy details, amounts, dates, notes, and document IDs. Returns the updated insurance.

path Parameters
id
required
string
Request Body schema: application/json
required
amount
number <float>
benefits
Array of strings (insuranceInsuranceBenefit)
Items Enum: "INSURANCE_BENEFIT_UNDEFINED" "INSURANCE_BENEFIT_LIABILITY" "INSURANCE_BENEFIT_WATER" "INSURANCE_BENEFIT_LOSS_OF_RENTAL_INCOME" "INSURANCE_BENEFIT_BURGLARY_ROBBERY" "INSURANCE_BENEFIT_GLASS_BREAKAGE" "INSURANCE_BENEFIT_EXTENDED_COVERAGE" "INSURANCE_BENEFIT_BUILDING_SERVICES_FAILURE" "INSURANCE_BENEFIT_CONVERSIONS_AND_RENOVATIONS" "INSURANCE_BENEFIT_NATURAL_HAZARDS" "INSURANCE_BENEFIT_ACCIDENT_AND_SICKNESS"
documentIds
Array of strings
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

editedByAic
boolean
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

excess
number <float>
indexYear
integer <int32>
insuranceCompany
string
notes
string
policyNumber
string
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

referenceId
string (Some opaque ID where this entity is attached to (e.g. propertyId or buildingId))
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

type
string (insuranceInsuranceType)
Default: "INSURANCE_TYPE_UNDEFINED"
Enum: "INSURANCE_TYPE_UNDEFINED" "INSURANCE_TYPE_FIRE_ELEMENTAL_DAMAGE" "INSURANCE_TYPE_BUILDING_PROPERTY_LIABILITY" "INSURANCE_TYPE_LIABILITY" "INSURANCE_TYPE_BUILDING_PROPERTY_INSURANCE" "INSURANCE_TYPE_LEGAL_EXPENSES" "INSURANCE_TYPE_CONSTRUCTION_LIABILITY" "INSURANCE_TYPE_CANTONAL_BUILDING_INSURANCE" "INSURANCE_TYPE_ACCIDENT_INSURANCE" "INSURANCE_TYPE_ART_IN_ARCHITECTURE" "INSURANCE_TYPE_BUSINESS_INSURANCE" "INSURANCE_TYPE_ACCIDENT_INSURANCE_UVG" "INSURANCE_TYPE_BUILDERS_LIABILITY_INSURANCE" "INSURANCE_TYPE_CONSTRUCTION_INSURANCE" "INSURANCE_TYPE_BUILDERS_LIABILITY_VISITOR_CUSTOMER_ACCIDENT" "INSURANCE_TYPE_CONSTRUCTION_VISITOR_CUSTOMER_ACCIDENT" "INSURANCE_TYPE_BUILDERS_LIABILITY_CONSTRUCTION_VISITOR_CUSTOMER_ACCIDENT" "INSURANCE_TYPE_TENANCY_DEPOSIT" "INSURANCE_TYPE_ENVIRONMENTAL_LIABILITY" "INSURANCE_TYPE_PROFESSIONAL_LIABILITY" "INSURANCE_TYPE_OBJECT" "INSURANCE_TYPE_PERSONAL_LIABILITY" "INSURANCE_TYPE_ADVANCE_PAYMENT_GUARANTEE" "INSURANCE_TYPE_BID_BOND" "INSURANCE_TYPE_PERFORMANCE_GUARANTEE" "INSURANCE_TYPE_WARRANTY_FOR_DEFECTS" "INSURANCE_TYPE_CYBER" "INSURANCE_TYPE_D_AND_O" "INSURANCE_TYPE_PROPERTY_INSURANCE" "INSURANCE_TYPE_ENGINEERING_INSURANCE" "INSURANCE_TYPE_VISITOR_CUSTOMER_ACCIDENT" "INSURANCE_TYPE_OTHER"
yearlyCosts
number <float>

Responses

Request samples

Content type
application/json
{
  • "amount": 0.1,
  • "benefits": [
    ],
  • "documentIds": [
    ],
  • "earliestTerminationDate": {
    },
  • "editedByAic": true,
  • "endDate": {
    },
  • "excess": 0.1,
  • "indexYear": 0,
  • "insuranceCompany": "string",
  • "notes": "string",
  • "policyNumber": "string",
  • "premiumPaidUntil": {
    },
  • "referenceId": "string",
  • "startDate": {
    },
  • "type": "INSURANCE_TYPE_UNDEFINED",
  • "yearlyCosts": 0.1
}

Response samples

Content type
application/json
{
  • "insurance": {
    }
}

InvestPlanService

Create invest plan components and planned costs in bulk

Creates multiple invest plan components and planned cost entries for the given owners and references. Returns the created components and plans.

Request Body schema: application/json
required
required
Array of objects (invest_planCreateBulkEntry)
required
Array of objects (invest_planCreateBulkPlanEntry)

Responses

Request samples

Content type
application/json
{
  • "entries": [
    ],
  • "plans": [
    ]
}

Response samples

Content type
application/json
{
  • "components": [
    ],
  • "plans": [
    ]
}

Delete an invest plan item

Deletes the invest plan component or planned cost entry with the given ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Enable or disable invest plan for buildings

Enables or disables the invest plan feature for the given buildings according to each entry's enable flag.

Request Body schema: application/json
required
required
Array of objects (invest_planEnableEntry)

Responses

Request samples

Content type
application/json
{
  • "entries": [
    ]
}

Response samples

Content type
application/json
{ }

Check if invest plan is enabled for buildings

For each given building ID, returns whether the invest plan feature is enabled.

Request Body schema: application/json
required
buildingIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "buildingIds": [
    ]
}

Response samples

Content type
application/json
{
  • "entries": [
    ]
}

List invest plan items by reference IDs

Returns invest plan components and planned costs linked to any of the given reference IDs.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "components": [
    ],
  • "plans": [
    ]
}

Update invest plan components and planned costs in bulk

Updates multiple invest plan components and planned cost entries by ID. Returns the updated components and plans.

Request Body schema: application/json
required
required
Array of objects (objectinvest_planUpdateBulkEntry)
required
Array of objects (invest_planUpdateBulkPlanEntry)

Responses

Request samples

Content type
application/json
{
  • "entries": [
    ],
  • "plans": [
    ]
}

Response samples

Content type
application/json
{
  • "components": [
    ],
  • "plans": [
    ]
}

MortgageService

Create a mortgage

Creates a new mortgage for the given owner and reference (property, building, or object). Accepts bank details, amounts, interest and amortization settings, and optional documents. Returns the created mortgage.

Request Body schema: application/json
required
amortisationAmount
required
number <double>
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
Array of objects (mortgageAmortization)
amount
required
number <double>
bankCountry
required
string
bankName
required
string
bankNumber
required
string
bic
required
string
carryingAmount
required
number <double>
debitAccount
required
string
designation
required
string
documentIds
required
Array of strings
dueDateMonthsAmortization
required
Array of integers <int32> [ items <int32 > ]
dueDateMonthsInterestRate
required
Array of integers <int32> [ items <int32 > ]
enableAmortizations
required
boolean
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

interestRate
required
number <float>
mortgageDesignation
required
string (mortgageMortgageDesignation)
Default: "MORTGAGE_DESIGNATION_UNDEFINED"
Enum: "MORTGAGE_DESIGNATION_UNDEFINED" "MORTGAGE_DESIGNATION_FIXED_1_YEAR" "MORTGAGE_DESIGNATION_FIXED_2_YEAR" "MORTGAGE_DESIGNATION_FIXED_3_YEAR" "MORTGAGE_DESIGNATION_FIXED_4_YEAR" "MORTGAGE_DESIGNATION_FIXED_5_YEAR" "MORTGAGE_DESIGNATION_FIXED_6_YEAR" "MORTGAGE_DESIGNATION_FIXED_7_YEAR" "MORTGAGE_DESIGNATION_FIXED_8_YEAR" "MORTGAGE_DESIGNATION_FIXED_9_YEAR" "MORTGAGE_DESIGNATION_FIXED_10_YEAR" "MORTGAGE_DESIGNATION_FIXED_11_YEAR" "MORTGAGE_DESIGNATION_FIXED_12_YEAR" "MORTGAGE_DESIGNATION_FIXED_13_YEAR" "MORTGAGE_DESIGNATION_FIXED_14_YEAR" "MORTGAGE_DESIGNATION_FIXED_15_YEAR" "MORTGAGE_DESIGNATION_FIXED_16_YEAR" "MORTGAGE_DESIGNATION_FIXED_17_YEAR" "MORTGAGE_DESIGNATION_FIXED_18_YEAR" "MORTGAGE_DESIGNATION_FIXED_19_YEAR" "MORTGAGE_DESIGNATION_FIXED_20_YEAR" "MORTGAGE_DESIGNATION_FIXED_21_YEAR" "MORTGAGE_DESIGNATION_FIXED_22_YEAR" "MORTGAGE_DESIGNATION_FIXED_23_YEAR" "MORTGAGE_DESIGNATION_FIXED_24_YEAR" "MORTGAGE_DESIGNATION_FIXED_25_YEAR" "MORTGAGE_DESIGNATION_VARIABLE" "MORTGAGE_DESIGNATION_LIBOR" "MORTGAGE_DESIGNATION_SARON"
required
object (commonaddressAddress)
number
required
string
ownerId
required
string <int64> (The account ID of the owner)
referenceId
required
string (Could be property, building or object ID)
terminableOn
required
string (mortgageMortgageTerminableOn)
Default: "MORTGAGE_TERMINABLE_ON_UNDEFINED"
Enum: "MORTGAGE_TERMINABLE_ON_UNDEFINED" "MORTGAGE_TERMINABLE_ON_1_MONTH" "MORTGAGE_TERMINABLE_ON_2_MONTHS" "MORTGAGE_TERMINABLE_ON_3_MONTHS" "MORTGAGE_TERMINABLE_ON_6_MONTHS" "MORTGAGE_TERMINABLE_ON_12_MONTHS"
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

Responses

Request samples

Content type
application/json
{
  • "amortisationAmount": 0.1,
  • "amortizationFrom": {
    },
  • "amortizations": [
    ],
  • "amount": 0.1,
  • "bankCountry": "string",
  • "bankName": "string",
  • "bankNumber": "string",
  • "bic": "string",
  • "carryingAmount": 0.1,
  • "debitAccount": "string",
  • "designation": "string",
  • "documentIds": [
    ],
  • "dueDateMonthsAmortization": [
    ],
  • "dueDateMonthsInterestRate": [
    ],
  • "enableAmortizations": true,
  • "expiresAt": {
    },
  • "interestRate": 0.1,
  • "mortgageDesignation": "MORTGAGE_DESIGNATION_UNDEFINED",
  • "mortgageeAddress": {
    },
  • "number": "string",
  • "ownerId": "string",
  • "referenceId": "string",
  • "terminableOn": "MORTGAGE_TERMINABLE_ON_UNDEFINED",
  • "validFrom": {
    }
}

Response samples

Content type
application/json
{
  • "mortgage": {
    }
}

List mortgages by IDs

Returns the mortgages matching the given mortgage IDs.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "mortgages": [
    ]
}

List mortgages by reference IDs

Returns mortgages linked to any of the given reference IDs (property, building, or object).

Request Body schema: application/json
required
referenceIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "referenceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "mortgages": [
    ]
}

Delete mortgages

Deletes the mortgages with the given IDs.

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{ }

Add documents to a mortgage

Appends document IDs to the mortgage identified by ID.

path Parameters
id
required
string
Request Body schema: application/json
required
documentIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "documentIds": [
    ]
}

Response samples

Content type
application/json
{ }

Update a mortgage

Updates an existing mortgage by ID (reference, bank details, amounts, interest and amortization settings, and documents). Returns the updated mortgage.

path Parameters
id
required
string
Request Body schema: application/json
required
amortisationAmount
number <double>
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

Array of objects (mortgageAmortization)
amount
number <double>
bankCountry
string
bankName
string
bankNumber
string
bic
string
carryingAmount
number <double>
debitAccount
string
designation
string
documentIds
Array of strings
dueDateMonthsAmortization
Array of integers <int32> [ items <int32 > ]
dueDateMonthsInterestRate
Array of integers <int32> [ items <int32 > ]
enableAmortizations
boolean
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

interestRate
number <float>
mortgageDesignation
string (mortgageMortgageDesignation)
Default: "MORTGAGE_DESIGNATION_UNDEFINED"
Enum: "MORTGAGE_DESIGNATION_UNDEFINED" "MORTGAGE_DESIGNATION_FIXED_1_YEAR" "MORTGAGE_DESIGNATION_FIXED_2_YEAR" "MORTGAGE_DESIGNATION_FIXED_3_YEAR" "MORTGAGE_DESIGNATION_FIXED_4_YEAR" "MORTGAGE_DESIGNATION_FIXED_5_YEAR" "MORTGAGE_DESIGNATION_FIXED_6_YEAR" "MORTGAGE_DESIGNATION_FIXED_7_YEAR" "MORTGAGE_DESIGNATION_FIXED_8_YEAR" "MORTGAGE_DESIGNATION_FIXED_9_YEAR" "MORTGAGE_DESIGNATION_FIXED_10_YEAR" "MORTGAGE_DESIGNATION_FIXED_11_YEAR" "MORTGAGE_DESIGNATION_FIXED_12_YEAR" "MORTGAGE_DESIGNATION_FIXED_13_YEAR" "MORTGAGE_DESIGNATION_FIXED_14_YEAR" "MORTGAGE_DESIGNATION_FIXED_15_YEAR" "MORTGAGE_DESIGNATION_FIXED_16_YEAR" "MORTGAGE_DESIGNATION_FIXED_17_YEAR" "MORTGAGE_DESIGNATION_FIXED_18_YEAR" "MORTGAGE_DESIGNATION_FIXED_19_YEAR" "MORTGAGE_DESIGNATION_FIXED_20_YEAR" "MORTGAGE_DESIGNATION_FIXED_21_YEAR" "MORTGAGE_DESIGNATION_FIXED_22_YEAR" "MORTGAGE_DESIGNATION_FIXED_23_YEAR" "MORTGAGE_DESIGNATION_FIXED_24_YEAR" "MORTGAGE_DESIGNATION_FIXED_25_YEAR" "MORTGAGE_DESIGNATION_VARIABLE" "MORTGAGE_DESIGNATION_LIBOR" "MORTGAGE_DESIGNATION_SARON"
object (commonaddressAddress)
number
string
referenceId
string (Could be property, building or object ID)
terminableOn
string (mortgageMortgageTerminableOn)
Default: "MORTGAGE_TERMINABLE_ON_UNDEFINED"
Enum: "MORTGAGE_TERMINABLE_ON_UNDEFINED" "MORTGAGE_TERMINABLE_ON_1_MONTH" "MORTGAGE_TERMINABLE_ON_2_MONTHS" "MORTGAGE_TERMINABLE_ON_3_MONTHS" "MORTGAGE_TERMINABLE_ON_6_MONTHS" "MORTGAGE_TERMINABLE_ON_12_MONTHS"
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

Responses

Request samples

Content type
application/json
{
  • "amortisationAmount": 0.1,
  • "amortizationFrom": {
    },
  • "amortizations": [
    ],
  • "amount": 0.1,
  • "bankCountry": "string",
  • "bankName": "string",
  • "bankNumber": "string",
  • "bic": "string",
  • "carryingAmount": 0.1,
  • "debitAccount": "string",
  • "designation": "string",
  • "documentIds": [
    ],
  • "dueDateMonthsAmortization": [
    ],
  • "dueDateMonthsInterestRate": [
    ],
  • "enableAmortizations": true,
  • "expiresAt": {
    },
  • "interestRate": 0.1,
  • "mortgageDesignation": "MORTGAGE_DESIGNATION_UNDEFINED",
  • "mortgageeAddress": {
    },
  • "number": "string",
  • "referenceId": "string",
  • "terminableOn": "MORTGAGE_TERMINABLE_ON_UNDEFINED",
  • "validFrom": {
    }
}

Response samples

Content type
application/json
{
  • "mortgage": {
    }
}

ObjectService

Add craftsmen to objects

Adds the given craftsman contact IDs to the specified objects.

Request Body schema: application/json
required
contactIdsCraftsman
required
Array of strings
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIdsCraftsman": [
    ],
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Add documents to an object

Appends document IDs to the object identified by ID. Returns the updated object.

Request Body schema: application/json
required
documentIds
required
Array of strings
id
required
string

Responses

Request samples

Content type
application/json
{
  • "documentIds": [
    ],
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Add janitors to objects

Adds the given janitor contact IDs to the specified objects.

Request Body schema: application/json
required
contactIdsJanitor
required
Array of strings
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIdsJanitor": [
    ],
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Add service providers to objects

Adds the given service provider contact IDs to the specified objects.

Request Body schema: application/json
required
contactIdsServiceProvider
required
Array of strings
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIdsServiceProvider": [
    ],
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Create an object

Creates a new object for the given owner and building. Optional numericId may be supplied; otherwise it can be generated by the service. Accepts type, category, address, contacts, media, characteristics, pricing, and marketing fields. Returns the created object.

Request Body schema: application/json
required
required
object (commonaddressAddress)
administrationType
required
string (objectAdministrationType)
Default: "UNDEFINED_ADMINISTRATION_TYPE"
Enum: "UNDEFINED_ADMINISTRATION_TYPE" "LETTING" "INITIAL_LETTING" "PARTIAL_LETTING" "CONDOMINIUM_OWNERSHIP" "OWNERS_CORPORATION"
assignedSideRooms
required
string
required
object (objectAvailability)
awn
required
string <int64>
buildingId
required
string
category
required
string (objectCategory)
Default: "UNDEFINED_CATEGORY"
Enum: "UNDEFINED_CATEGORY" "APARTMENT" "HOUSE" "COMMERCIAL" "GASTRONOMY" "GARDEN" "PARKING_SPACE" "SECONDARY_ROOM" "PLOT" "AGRICULTURE"
required
object (objectobjectCharacteristics)
required
object (objectContacts)
required
object (objectobjectDeposit)
description
required
string
development
required
string (The state of development of the plot)
Default: "UNDEFINED_DEVELOPMENT"
Enum: "UNDEFINED_DEVELOPMENT" "FULL" "PARTIAL" "UNDEVELOPED"
required
Array of objects (objectobjectDocument)
required
Array of objects (objectobjectEnergySource)
ewid
required
string
required
Array of objects (objectobjectImage)
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

marketingLanguage
required
string (languagePreferredLanguage)
Default: "PREFERRED_LANGUAGE_UNDEFINED"
Enum: "PREFERRED_LANGUAGE_UNDEFINED" "PREFERRED_LANGUAGE_GERMAN" "PREFERRED_LANGUAGE_ENGLISH" "PREFERRED_LANGUAGE_ITALIAN" "PREFERRED_LANGUAGE_FRENCH"
name
required
string
needsMatching
required
boolean
note
required
string
number
required
string
numericId
required
string <int64>
otoId
required
string
ownerId
required
string <int64>
required
Array of objects (objectParking)
positions
required
Array of strings (objectPosition)
Items Enum: "UNDEFINED_LOCATION" "LEFT" "RIGHT" "MIDDLE" "MIDDLE_LEFT" "MIDDLE_RIGHT" "NORTH" "SOUTH" "WEST" "EAST" "NORTH_WEST" "NORTH_EAST" "SOUTH_WEST" "SOUTH_EAST" "MIDDLE_FRONT" "MIDDLE_LEFT_LEFT" "MIDDLE_RIGHT_RIGHT"

Do only use first array element. Others are ignored

required
object (objectPricing)
publishAddress
required
boolean
publishCharacteristicsInDescription
required
boolean
published
required
boolean
required
Array of objects (objectRenovation)
sharedUse
required
string
specialFeatures
required
string
subCategories
required
Array of strings (- ATELIER: SwissRETS fields (can also contain IDX fields) - AGRICULTURAL_INSTALLATION: IDX fields)
Items Enum: "UNDEFINED_SUB_CATEGORY" "ATELIER" "ATTIC_FLAT" "BAR" "CAFE" "CAR_REPAIR_SHOP" "CASTLE" "CHALET" "EARTH_SHELTERED_DWELLING" "DETACHED_HOUSE" "DOCTORS_OFFICE" "DUPLEX_HOUSE" "FARM_HOUSE" "FURNISHED_FLAT" "GRANNY_FLAT" "HOBBY_ROOM" "HOTEL" "LOFT" "MAISONETTE" "MULTIPLEX_HOUSE" "OFFICE" "ONE_ROOM_FLAT" "RESTAURANT" "RETAIL_LOCATION" "ROOF_FLAT" "ROW_HOUSE" "RUSTICO" "SINGLE_ROOM" "STOECKLI" "STEPPED_FLAT" "STEPPED_HOUSE" "VILLA" "WORKSHOP" "AGRICULTURAL_INSTALLATION" "MOUNTAIN_FARM" "FARM" "DUPLEX" "STUDIO" "TERRACE_FLAT" "BACHELOR_FLAT" "ATTIC" "ALOTTMENT_GARDEN" "CLUB" "CASINO" "MOVIE" "SQUASH" "INDOOR_TENNIS" "TENNIS" "SPORTS_HALL" "CAMP_GROUND" "OUTDOOR_SWIMMING_POOL" "INDOOR_SWIMMING_POOL" "GOLF_COURSE" "MOTEL" "PUB" "SINGLE_HOUSE" "BIFAMILIAR_HOUSE" "TERRANCE_HOUSE" "MULTIPLE_DWELLING" "CAVE_HOUSE" "SHOP" "ADVERTISING_AREA" "COMMERCIAL_SUB_CATEGORY" "STORAGE_ROOM" "PRACTICE" "KIOSK" "GARDENING" "FUEL_STATION" "CHEESE_FACTORY" "BUTCHER" "BAKERY" "HAIRDRESSER" "SHOPPING_CENTER" "FACTORY" "INDUSTRIAL_OBJECT" "ARCADE" "LIVING_COMMERCIAL_BUILDING" "LIBRARY" "HOSPITAL" "LABORATORY" "MINI_GOLD_COURSE" "NURSING_HOME" "RIDING_HALL" "SANATORIUM" "PARTY_ROOM" "SAUNA" "SOLARIUM" "CARPENTRY_SHOP" "OLD_AGE_HOME" "DEPARTMENT_STORE" "HOME" "DISPLAY_WINDOW" "PARKING_GARAGE" "PARKING_SURFACE" "OPEN_SLOT" "COVERED_SLOT" "SINGLE_GARAGE" "DOUBLE_GARAGE" "UNDERGROUND_SLOT" "BOAT_DRY_DOCK" "BOAT_LANDING_STAGE" "COVERED_PARKING_PLACE_BIKE" "OUTDOOR_PARKING_PLACE_BIKE" "HORSE_BOX" "BOAT_MOORING" "BUILDING_LAND" "AGRICULTURAL_LAND" "COMMERCIAL_LAND" "INDUSTRIAL_LAND" "CELLAR_COMPARTMENT" "ATTIC_COMPARTMENT" "OTHER" "VISITOR_PARKING_LOT" "CARETAKER_ROOM" "FITNESS_CENTER" "ARCHIVE_ROOM" "ANTENNA_SYSTEM" "TRAINING_ROOM" "TOILET_FACILITY" "BICYCLE_PARKING" "HANDICAPPED_INDOOR_PARKING" "HANDICAPPED_OUTDOOR_PARKING" "DOUBLE_OUTDOOR_PARKING" "DOUBLE_INDOOR_PARKING" "JANITOR_ROOM" "LAUNDRY_ROOM" "CUSTOMER_PARKING" "RETIREMENT_APARTMENT" "STAFF_ROOM" "SERVER_ROOM" "MEETING_ROOM" "BUILDING_SERVICES" "COMMERCIAL_STORAGE_ROOM" "ELECTRIC_PARKING_SPACE"
tags
required
Array of strings
title
required
string
type
required
string (objectobjectType)
Default: "RENT"
Enum: "RENT" "SALE"
unusualAgreement
required
string
utilizations
required
Array of strings (objectUtilization)
Items Enum: "UNDEFINED_UTILIZATION" "AGRICULTURAL" "COMMERCIAL_UTILIZATION" "CONSTRUCTION" "GASTRONOMY_UTILIZATION" "INDUSTRIAL" "INVESTMENT" "PARKING" "RESIDENTIAL" "STORAGE" "VACATION"
valueQuota
required
number <float>
videoUrl
required
string
required
Array of objects (objectVideo)
virtualTourUrl
required
string

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "administrationType": "UNDEFINED_ADMINISTRATION_TYPE",
  • "assignedSideRooms": "string",
  • "availability": {
    },
  • "awn": "string",
  • "buildingId": "string",
  • "category": "UNDEFINED_CATEGORY",
  • "characteristics": {
    },
  • "contacts": {
    },
  • "deposit": {
    },
  • "description": "string",
  • "development": "UNDEFINED_DEVELOPMENT",
  • "documents": [
    ],
  • "energySources": [
    ],
  • "ewid": "string",
  • "images": [
    ],
  • "inactiveBy": {
    },
  • "marketingLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
  • "name": "string",
  • "needsMatching": true,
  • "note": "string",
  • "number": "string",
  • "numericId": "string",
  • "otoId": "string",
  • "ownerId": "string",
  • "parking": [
    ],
  • "positions": [
    ],
  • "pricing": {
    },
  • "publishAddress": true,
  • "publishCharacteristicsInDescription": true,
  • "published": true,
  • "renovations": [
    ],
  • "sharedUse": "string",
  • "specialFeatures": "string",
  • "subCategories": [
    ],
  • "tags": [
    ],
  • "title": "string",
  • "type": "RENT",
  • "unusualAgreement": "string",
  • "utilizations": [
    ],
  • "valueQuota": 0.1,
  • "videoUrl": "string",
  • "videos": [
    ],
  • "virtualTourUrl": "string"
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Create objects in bulk

Creates multiple objects for the given owner and building. Shared fields include address, type, category, administration type, marketing language, and the number of objects to create (amount).

Request Body schema: application/json
required
required
object (commonaddressAddress)
administrationType
required
string (objectAdministrationType)
Default: "UNDEFINED_ADMINISTRATION_TYPE"
Enum: "UNDEFINED_ADMINISTRATION_TYPE" "LETTING" "INITIAL_LETTING" "PARTIAL_LETTING" "CONDOMINIUM_OWNERSHIP" "OWNERS_CORPORATION"
amount
required
integer <int32>
buildingId
required
string
category
required
string (objectCategory)
Default: "UNDEFINED_CATEGORY"
Enum: "UNDEFINED_CATEGORY" "APARTMENT" "HOUSE" "COMMERCIAL" "GASTRONOMY" "GARDEN" "PARKING_SPACE" "SECONDARY_ROOM" "PLOT" "AGRICULTURE"
marketingLanguage
required
string (languagePreferredLanguage)
Default: "PREFERRED_LANGUAGE_UNDEFINED"
Enum: "PREFERRED_LANGUAGE_UNDEFINED" "PREFERRED_LANGUAGE_GERMAN" "PREFERRED_LANGUAGE_ENGLISH" "PREFERRED_LANGUAGE_ITALIAN" "PREFERRED_LANGUAGE_FRENCH"
ownerId
required
string <int64>
type
required
string (objectobjectType)
Default: "RENT"
Enum: "RENT" "SALE"

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "administrationType": "UNDEFINED_ADMINISTRATION_TYPE",
  • "amount": 0,
  • "buildingId": "string",
  • "category": "UNDEFINED_CATEGORY",
  • "marketingLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
  • "ownerId": "string",
  • "type": "RENT"
}

Response samples

Content type
application/json
{ }

Get an object by ID

Returns the object identified by the given ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "object": {
    }
}

Get accounting statistics for an account

Returns vacancy, marketing, and publication statistics for objects shared with the given account under accounting scope.

path Parameters
accountId
required
string <int64>

The ID of the account whose accounting statistics are to be calculated (objects he got with share-scope=ACCOUNTING)

Responses

Response samples

Content type
application/json
{
  • "countOverall": 0,
  • "inMarketingOverall": 0,
  • "inMarketingSince12Weeks": 0,
  • "inMarketingSince4Weeks": 0,
  • "inMarketingSince8Weeks": 0,
  • "notInMarketingOverall": 0,
  • "notInMarketingSince12Weeks": 0,
  • "notInMarketingSince4Weeks": 0,
  • "notInMarketingSince8Weeks": 0,
  • "publishedOverall": 0,
  • "publishedSince12Weeks": 0,
  • "publishedSince4Weeks": 0,
  • "publishedSince8Weeks": 0,
  • "vacancyRate": 0.1,
  • "vacantOverall": 0,
  • "vacantSince12Weeks": 0,
  • "vacantSince4Weeks": 0,
  • "vacantSince8Weeks": 0
}

Get administration statistics for an account

Returns vacancy, marketing, and publication statistics for objects shared with the given account under management scope.

path Parameters
accountId
required
string <int64>

The ID of the account whose admin statistics are to be calculated (objects he got with share-scope=MANAGEMENT)

Responses

Response samples

Content type
application/json
{
  • "countOverall": 0,
  • "inMarketingOverall": 0,
  • "inMarketingSince12Weeks": 0,
  • "inMarketingSince4Weeks": 0,
  • "inMarketingSince8Weeks": 0,
  • "notInMarketingOverall": 0,
  • "notInMarketingSince12Weeks": 0,
  • "notInMarketingSince4Weeks": 0,
  • "notInMarketingSince8Weeks": 0,
  • "publishedOverall": 0,
  • "publishedSince12Weeks": 0,
  • "publishedSince4Weeks": 0,
  • "publishedSince8Weeks": 0,
  • "vacancyRate": 0.1,
  • "vacantOverall": 0,
  • "vacantSince12Weeks": 0,
  • "vacantSince4Weeks": 0,
  • "vacantSince8Weeks": 0
}

Get asset statistics for an account

Returns vacancy, marketing, and publication statistics for objects shared with the given account under asset scope.

path Parameters
accountId
required
string <int64>

The ID of the account whose asset statistics are to be calculated (objects he got with share-scope=ASSET)

Responses

Response samples

Content type
application/json
{
  • "countOverall": 0,
  • "inMarketingOverall": 0,
  • "inMarketingSince12Weeks": 0,
  • "inMarketingSince4Weeks": 0,
  • "inMarketingSince8Weeks": 0,
  • "notInMarketingOverall": 0,
  • "notInMarketingSince12Weeks": 0,
  • "notInMarketingSince4Weeks": 0,
  • "notInMarketingSince8Weeks": 0,
  • "publishedOverall": 0,
  • "publishedSince12Weeks": 0,
  • "publishedSince4Weeks": 0,
  • "publishedSince8Weeks": 0,
  • "vacancyRate": 0.1,
  • "vacantOverall": 0,
  • "vacantSince12Weeks": 0,
  • "vacantSince4Weeks": 0,
  • "vacantSince8Weeks": 0
}

Get object by public ID

Returns the object identified by the given public marketing ID.

path Parameters
publicId
required
string

Responses

Response samples

Content type
application/json
{
  • "object": {
    }
}

Get marketing data for an object

Returns marketing-facing details for the object identified by ID, including title, description, address, availability, pricing, media, and marketing assignee.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "acceptsCreditTrust": true,
  • "additional": 0.1,
  • "address": {
    },
  • "availability": {
    },
  • "category": "UNDEFINED_CATEGORY",
  • "coldRent": 0.1,
  • "currency": "string",
  • "decimalFloor": 0.1,
  • "deposit": {
    },
  • "description": "string",
  • "effectiveArea": 0.1,
  • "floor": 0,
  • "heating": 0.1,
  • "id": "string",
  • "images": [
    ],
  • "livingArea": 0.1,
  • "marketingAccountId": "string",
  • "marketingAssignee": {
    },
  • "marketingLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
  • "ownerId": "string",
  • "parking": [
    ],
  • "publicId": "string",
  • "publishAddress": true,
  • "rooms": 0.1,
  • "subCategories": [
    ],
  • "title": "string",
  • "unit": "ON_REQUEST"
}

Get marketing statistics for an account

Returns marketing and online statistics for objects shared with the given account under marketing scope. Optional contactIdAssigneeMarketing filters employee-based counts.

path Parameters
accountId
required
string <int64>

The ID of the account whose marketing statistics are to be calculated (objects he got with share-scope=MARKETING)

query Parameters
contactIdAssigneeMarketing
string

The contactId which should be used for employee based statistics

Responses

Response samples

Content type
application/json
{
  • "employeeInMarketing": 0,
  • "employeeInMarketingFor12Weeks": 0,
  • "employeeInMarketingFor4Weeks": 0,
  • "employeeInMarketingFor8Weeks": 0,
  • "employeeOnline": 0,
  • "employeeOnlineFor12Weeks": 0,
  • "employeeOnlineFor4Weeks": 0,
  • "employeeOnlineFor8Weeks": 0,
  • "overallInMarketing": 0,
  • "overallInMarketingFor12Weeks": 0,
  • "overallInMarketingFor4Weeks": 0,
  • "overallInMarketingFor8Weeks": 0,
  • "overallNewInMarketing": 0,
  • "overallOnline": 0,
  • "overallOnlineFor12Weeks": 0,
  • "overallOnlineFor4Weeks": 0,
  • "overallOnlineFor8Weeks": 0
}

Get object types for an account

Returns whether the given account has rental and/or condominium objects.

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "hasCondominiumObjects": true,
  • "hasRentalObjects": true
}

Get owner statistics for an account

Returns vacancy, marketing, and publication statistics for objects owned by the given account.

path Parameters
accountId
required
string <int64>

The ID of the account whose owner statistics are to be calculated (objects with ownerId=accountId)

Responses

Response samples

Content type
application/json
{
  • "countOverall": 0,
  • "inMarketingOverall": 0,
  • "inMarketingSince12Weeks": 0,
  • "inMarketingSince4Weeks": 0,
  • "inMarketingSince8Weeks": 0,
  • "notInMarketingOverall": 0,
  • "notInMarketingSince12Weeks": 0,
  • "notInMarketingSince4Weeks": 0,
  • "notInMarketingSince8Weeks": 0,
  • "publishedOverall": 0,
  • "publishedSince12Weeks": 0,
  • "publishedSince4Weeks": 0,
  • "publishedSince8Weeks": 0,
  • "vacancyRate": 0.1,
  • "vacantOverall": 0,
  • "vacantSince12Weeks": 0,
  • "vacantSince4Weeks": 0,
  • "vacantSince8Weeks": 0
}

Get total value quota for a building

Returns the summed value quota of objects in the given building.

path Parameters
buildingId
required
string

Responses

Response samples

Content type
application/json
{
  • "totalValueQuota": 0.1
}

Get used object tags for an account

Returns the tags currently used on objects for the given account.

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "tags": [
    ]
}

Check if an object is active

Returns whether the object with the given ID is active.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "active": true
}

Check if any object is published

Returns whether at least one of the given object IDs is currently published.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "published": true
}

List objects for an account

Returns a paginated list of objects for the given account. Supports page and itemsPerPage. Response includes total object and page counts.

path Parameters
accountId
required
string <int64>
query Parameters
page
integer <int32>
itemsPerPage
integer <int32>
address
string

DO NOT USE! Deprecated.

categories
Array of strings
Items Enum: "UNDEFINED_CATEGORY" "APARTMENT" "HOUSE" "COMMERCIAL" "GASTRONOMY" "GARDEN" "PARKING_SPACE" "SECONDARY_ROOM" "PLOT" "AGRICULTURE"

DO NOT USE! Deprecated.

zipFrom
integer <int32>

DO NOT USE! Deprecated.

zipTo
integer <int32>

DO NOT USE! Deprecated.

tenantContactIds
Array of strings

DO NOT USE! Deprecated.

networkPartnerIds
Array of strings <int64> [ items <int64 > ]

DO NOT USE! Deprecated.

sortFloor
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"

DO NOT USE! Deprecated.

sortRentPrice
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"

DO NOT USE! Deprecated.

Responses

Response samples

Content type
application/json
{
  • "objects": [
    ],
  • "totalObjectCount": 0,
  • "totalPageCount": 0
}

List objects by building IDs

Returns objects belonging to any of the given building IDs.

Request Body schema: application/json
required
buildingIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "buildingIds": [
    ]
}

Response samples

Content type
application/json
{
  • "objects": [
    ]
}

List objects by IDs

Returns the objects matching the given object IDs.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "objects": [
    ]
}

List object filter options

Returns object filter options (id, name, ownerId) available to the authenticated caller. Options are determined by authorization data; the request has no parameters.

Responses

Response samples

Content type
application/json
{
  • "options": [
    ]
}

List free objects by date

Returns objects in the given buildings that are free (available) on the specified date.

Request Body schema: application/json
required
buildingIds
required
Array of strings
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

Responses

Request samples

Content type
application/json
{
  • "buildingIds": [
    ],
  • "date": {
    }
}

Response samples

Content type
application/json
{
  • "objects": [
    ]
}

List object IDs in marketing for a marketer

Returns the IDs of objects currently in marketing for the given marketer account.

path Parameters
marketerAccountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ]
}

List objects in marketing for an account

Returns a paginated list of objects owned by or shared with the given account that are in marketing. Supports filtering by status, publicId, address, categories, rooms, and marketing assignees, plus sorting. Response includes total object and page counts.

path Parameters
accountId
required
string <int64>

Get all objects with this as ownerId AND all objects that are shared with this accountId

query Parameters
page
integer <int32>
itemsPerPage
integer <int32>
statuses
Array of strings
Items Enum: "NO_MARKETING_STATUS_FILTER" "NEW" "OFFLINE" "ONLINE" "RENTED"
publicId
string

Optional: Only partial match needed

address
string

Optional

categories
Array of strings
Items Enum: "UNDEFINED_CATEGORY" "APARTMENT" "HOUSE" "COMMERCIAL" "GASTRONOMY" "GARDEN" "PARKING_SPACE" "SECONDARY_ROOM" "PLOT" "AGRICULTURE"
roomsFrom
number <float>

Optional: If -1 then do not filter for it

roomsTo
number <float>

Optional: If -1 then do not filter for it

contactIdAssigneeMarketing
Array of strings

Optional

sortUnreadRequests
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortViewingAppointments
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortApplicationForms
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"

Responses

Response samples

Content type
application/json
{
  • "objects": [
    ],
  • "totalObjectCount": 0,
  • "totalPageCount": 0
}

List published objects for an owner

Returns all currently published objects belonging to the given owner.

path Parameters
ownerId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "objects": [
    ]
}

Mark an object for marketing

Marks the object for marketing with optional start time, note, pricing, title, description, availability, deposit, parking, and media.

path Parameters
id
required
string
Request Body schema: application/json
required
object (objectAvailability)
object (objectobjectDeposit)
description
string
Array of objects (objectobjectDocument)
Array of objects (objectobjectImage)
marketingNote
string
Array of objects (objectParking)
object (objectPricing)
publishAddress
boolean
publishCharacteristicsInDescription
boolean
startMarketingAt
string <int64> (UNIX timestamp in seconds)
title
string
videoUrl
string
Array of objects (objectVideo)
virtualTourUrl
string

Responses

Request samples

Content type
application/json
{
  • "availability": {
    },
  • "deposit": {
    },
  • "description": "string",
  • "documents": [
    ],
  • "images": [
    ],
  • "marketingNote": "string",
  • "parking": [
    ],
  • "pricing": {
    },
  • "publishAddress": true,
  • "publishCharacteristicsInDescription": true,
  • "startMarketingAt": "string",
  • "title": "string",
  • "videoUrl": "string",
  • "videos": [
    ],
  • "virtualTourUrl": "string"
}

Response samples

Content type
application/json
{ }

Mark marketing object as seen

Marks the marketing entry for the object identified by ID as seen.

path Parameters
id
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Move objects to another building

Moves the given objects to the specified new building ID.

Request Body schema: application/json
required
ids
required
Array of strings
newBuildingId
required
string

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "newBuildingId": "string"
}

Response samples

Content type
application/json
{ }

Publish objects

Publishes the given objects. Optional publishAt schedules publication; optional unPublishAt or unPublishAtAmountOfRequests can auto-unpublish. SpecialPublication may also be supplied.

Request Body schema: application/json
required
ids
required
Array of strings
publishAt
string <int64>

Optional timestamp in seconds if the user wants to schedule publish time. If left empty it's marked as publish immediately.

required
object (objectSpecialPublication)
unPublishAt
string <int64>

Optional timestamp in seconds if user wants to schedule unPublish

unPublishAtAmountOfRequests
integer <int32>

Optional parameter if user wants to automatically unPublish

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "publishAt": "string",
  • "specialPublication": {
    },
  • "unPublishAt": "string",
  • "unPublishAtAmountOfRequests": 0
}

Response samples

Content type
application/json
{ }

Publish updated events for owners

Publishes object-updated events for the given owner account IDs.

Request Body schema: application/json
required
ownerIds
required
Array of strings <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "ownerIds": [
    ]
}

Response samples

Content type
application/json
{ }

Remove craftsmen from objects

Removes the given craftsman contact IDs from the specified objects.

Request Body schema: application/json
required
contactIdsCraftsman
required
Array of strings
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIdsCraftsman": [
    ],
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Remove objects from marketing

Removes the given objects from marketing.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Remove janitors from objects

Removes the given janitor contact IDs from the specified objects.

Request Body schema: application/json
required
contactIdsJanitor
required
Array of strings
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIdsJanitor": [
    ],
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Remove service providers from objects

Removes the given service provider contact IDs from the specified objects.

Request Body schema: application/json
required
contactIdsServiceProvider
required
Array of strings
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIdsServiceProvider": [
    ],
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Set accounting assignee on objects

Sets the accounting assignee contact for the given object IDs.

Request Body schema: application/json
required
contactIdAssigneeAccounting
required
string
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIdAssigneeAccounting": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Set admin assignee on objects

Sets the administration assignee contact for the given object IDs.

Request Body schema: application/json
required
contactIdAssigneeAdministration
required
string
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIdAssigneeAdministration": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Set asset assignee on objects

Sets the asset assignee contact for the given object IDs.

Request Body schema: application/json
required
contactIdAssigneeAsset
required
string
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIdAssigneeAsset": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Set contacts on objects

Sets the contacts structure for the given object IDs.

Request Body schema: application/json
required
required
object (objectContacts)
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contacts": {
    },
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Set marketing assignee on objects

Sets the marketing assignee contact for the given object IDs.

Request Body schema: application/json
required
contactIdAssigneeMarketing
required
string
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIdAssigneeMarketing": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Set owner assignee on objects

Sets the owner assignee contact for the given object IDs.

Request Body schema: application/json
required
contactIdAssigneeOwner
required
string
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIdAssigneeOwner": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Set viewing appointment contact on objects

Sets the viewing appointment contact for the given object IDs.

Request Body schema: application/json
required
contactIdViewingAppointment
required
string
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIdViewingAppointment": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Unpublish objects

Unpublishes the objects with the given IDs.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Update marketing info for an object

Updates the marketing start time and marketing note for the object identified by ID.

path Parameters
id
required
string
Request Body schema: application/json
required
marketingNote
string
startMarketingAt
string <int64> (UNIX timestamp in seconds)

Responses

Request samples

Content type
application/json
{
  • "marketingNote": "string",
  • "startMarketingAt": "string"
}

Response samples

Content type
application/json
{ }

Delete an object

Deletes the object with the given ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get application info PDF for an object

Generates and returns an application info PDF for the object identified by ID, rendered in the requested language.

path Parameters
id
required
string
query Parameters
language
string

Responses

Response samples

Content type
application/json
{
  • "pdf": "string"
}

Get default answer for an object

Returns the default answer configuration for the object identified by ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "defaultAnswer": {
    }
}

Get marketing expose PDF for an object

Generates and returns a marketing expose PDF for the object identified by ID, rendered in the requested language.

path Parameters
id
required
string
query Parameters
language
string

Responses

Response samples

Content type
application/json
{
  • "pdf": "string"
}

Get viewing appointment for an object

Returns the viewing appointment configuration for the object identified by ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "viewingAppointment": {
    }
}

Set default answer for an object

Sets the default answer configuration for the object identified by ID.

path Parameters
id
required
string
Request Body schema: application/json
required
object (objectDefaultAnswer)

Responses

Request samples

Content type
application/json
{
  • "defaultAnswer": {
    }
}

Response samples

Content type
application/json
{ }

Set viewing appointment for an object

Sets the viewing appointment configuration for the object identified by ID.

path Parameters
id
required
string
Request Body schema: application/json
required
object (objectViewingAppointment)

Responses

Request samples

Content type
application/json
{
  • "viewingAppointment": {
    }
}

Response samples

Content type
application/json
{ }

Update an object

Updates an existing object by ID. Accepts type, category, contacts, media, characteristics, pricing, availability, tags, and marketing-related fields. Returns the updated object.

path Parameters
id
required
string
Request Body schema: application/json
required
acceptsCreditTrust
boolean
administrationType
string (objectAdministrationType)
Default: "UNDEFINED_ADMINISTRATION_TYPE"
Enum: "UNDEFINED_ADMINISTRATION_TYPE" "LETTING" "INITIAL_LETTING" "PARTIAL_LETTING" "CONDOMINIUM_OWNERSHIP" "OWNERS_CORPORATION"
assignedSideRooms
string
automaticReferenceCheck
string (marketbaseAutomaticReferenceCheckMode)
Default: "AUTOMATIC_REFERENCE_CHECK_MODE_UNDEFINED"
Enum: "AUTOMATIC_REFERENCE_CHECK_MODE_UNDEFINED" "AUTOMATIC_REFERENCE_CHECK_MODE_DO_NOT_CHECK" "AUTOMATIC_REFERENCE_CHECK_MODE_IF_AFFORDABILITY_APPROPRIATE" "AUTOMATIC_REFERENCE_CHECK_MODE_IF_COMPLETE_DOSSIER_AND_AFFORDABILITY"
object (objectAvailability)
awn
string <int64>
category
string (objectCategory)
Default: "UNDEFINED_CATEGORY"
Enum: "UNDEFINED_CATEGORY" "APARTMENT" "HOUSE" "COMMERCIAL" "GASTRONOMY" "GARDEN" "PARKING_SPACE" "SECONDARY_ROOM" "PLOT" "AGRICULTURE"
object (objectobjectCharacteristics)
object (objectContacts)
object (objectDefaultAnswer)
object (objectobjectDeposit)
description
string
development
string (The state of development of the plot)
Default: "UNDEFINED_DEVELOPMENT"
Enum: "UNDEFINED_DEVELOPMENT" "FULL" "PARTIAL" "UNDEVELOPED"
Array of objects (objectobjectDocument)
Array of objects (objectobjectEnergySource)
ewid
string
Array of objects (objectobjectImage)
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

marketingLanguage
string (languagePreferredLanguage)
Default: "PREFERRED_LANGUAGE_UNDEFINED"
Enum: "PREFERRED_LANGUAGE_UNDEFINED" "PREFERRED_LANGUAGE_GERMAN" "PREFERRED_LANGUAGE_ENGLISH" "PREFERRED_LANGUAGE_ITALIAN" "PREFERRED_LANGUAGE_FRENCH"
name
string
needsMatching
boolean
note
string
number
string
otoId
string
Array of objects (objectParking)
positions
Array of strings (objectPosition)
Items Enum: "UNDEFINED_LOCATION" "LEFT" "RIGHT" "MIDDLE" "MIDDLE_LEFT" "MIDDLE_RIGHT" "NORTH" "SOUTH" "WEST" "EAST" "NORTH_WEST" "NORTH_EAST" "SOUTH_WEST" "SOUTH_EAST" "MIDDLE_FRONT" "MIDDLE_LEFT_LEFT" "MIDDLE_RIGHT_RIGHT"

Do only use first array element. Others are ignored

object (objectPricing)
publishAddress
boolean
publishCharacteristicsInDescription
boolean
referenceSenderMailboxId
string

Per-advert override for mailbox ID used as sender for digital reference request emails. Empty means use account settings.

Array of objects (objectRenovation)
sharedUse
string
specialFeatures
string
subCategories
Array of strings (- ATELIER: SwissRETS fields (can also contain IDX fields) - AGRICULTURAL_INSTALLATION: IDX fields)
Items Enum: "UNDEFINED_SUB_CATEGORY" "ATELIER" "ATTIC_FLAT" "BAR" "CAFE" "CAR_REPAIR_SHOP" "CASTLE" "CHALET" "EARTH_SHELTERED_DWELLING" "DETACHED_HOUSE" "DOCTORS_OFFICE" "DUPLEX_HOUSE" "FARM_HOUSE" "FURNISHED_FLAT" "GRANNY_FLAT" "HOBBY_ROOM" "HOTEL" "LOFT" "MAISONETTE" "MULTIPLEX_HOUSE" "OFFICE" "ONE_ROOM_FLAT" "RESTAURANT" "RETAIL_LOCATION" "ROOF_FLAT" "ROW_HOUSE" "RUSTICO" "SINGLE_ROOM" "STOECKLI" "STEPPED_FLAT" "STEPPED_HOUSE" "VILLA" "WORKSHOP" "AGRICULTURAL_INSTALLATION" "MOUNTAIN_FARM" "FARM" "DUPLEX" "STUDIO" "TERRACE_FLAT" "BACHELOR_FLAT" "ATTIC" "ALOTTMENT_GARDEN" "CLUB" "CASINO" "MOVIE" "SQUASH" "INDOOR_TENNIS" "TENNIS" "SPORTS_HALL" "CAMP_GROUND" "OUTDOOR_SWIMMING_POOL" "INDOOR_SWIMMING_POOL" "GOLF_COURSE" "MOTEL" "PUB" "SINGLE_HOUSE" "BIFAMILIAR_HOUSE" "TERRANCE_HOUSE" "MULTIPLE_DWELLING" "CAVE_HOUSE" "SHOP" "ADVERTISING_AREA" "COMMERCIAL_SUB_CATEGORY" "STORAGE_ROOM" "PRACTICE" "KIOSK" "GARDENING" "FUEL_STATION" "CHEESE_FACTORY" "BUTCHER" "BAKERY" "HAIRDRESSER" "SHOPPING_CENTER" "FACTORY" "INDUSTRIAL_OBJECT" "ARCADE" "LIVING_COMMERCIAL_BUILDING" "LIBRARY" "HOSPITAL" "LABORATORY" "MINI_GOLD_COURSE" "NURSING_HOME" "RIDING_HALL" "SANATORIUM" "PARTY_ROOM" "SAUNA" "SOLARIUM" "CARPENTRY_SHOP" "OLD_AGE_HOME" "DEPARTMENT_STORE" "HOME" "DISPLAY_WINDOW" "PARKING_GARAGE" "PARKING_SURFACE" "OPEN_SLOT" "COVERED_SLOT" "SINGLE_GARAGE" "DOUBLE_GARAGE" "UNDERGROUND_SLOT" "BOAT_DRY_DOCK" "BOAT_LANDING_STAGE" "COVERED_PARKING_PLACE_BIKE" "OUTDOOR_PARKING_PLACE_BIKE" "HORSE_BOX" "BOAT_MOORING" "BUILDING_LAND" "AGRICULTURAL_LAND" "COMMERCIAL_LAND" "INDUSTRIAL_LAND" "CELLAR_COMPARTMENT" "ATTIC_COMPARTMENT" "OTHER" "VISITOR_PARKING_LOT" "CARETAKER_ROOM" "FITNESS_CENTER" "ARCHIVE_ROOM" "ANTENNA_SYSTEM" "TRAINING_ROOM" "TOILET_FACILITY" "BICYCLE_PARKING" "HANDICAPPED_INDOOR_PARKING" "HANDICAPPED_OUTDOOR_PARKING" "DOUBLE_OUTDOOR_PARKING" "DOUBLE_INDOOR_PARKING" "JANITOR_ROOM" "LAUNDRY_ROOM" "CUSTOMER_PARKING" "RETIREMENT_APARTMENT" "STAFF_ROOM" "SERVER_ROOM" "MEETING_ROOM" "BUILDING_SERVICES" "COMMERCIAL_STORAGE_ROOM" "ELECTRIC_PARKING_SPACE"
tags
Array of strings
title
string
type
string (objectobjectType)
Default: "RENT"
Enum: "RENT" "SALE"
unusualAgreement
string
utilizations
Array of strings (objectUtilization)
Items Enum: "UNDEFINED_UTILIZATION" "AGRICULTURAL" "COMMERCIAL_UTILIZATION" "CONSTRUCTION" "GASTRONOMY_UTILIZATION" "INDUSTRIAL" "INVESTMENT" "PARKING" "RESIDENTIAL" "STORAGE" "VACATION"
valueQuota
number <float>
videoUrl
string
Array of objects (objectVideo)
object (objectViewingAppointment)
virtualTourUrl
string

Responses

Request samples

Content type
application/json
{
  • "acceptsCreditTrust": true,
  • "administrationType": "UNDEFINED_ADMINISTRATION_TYPE",
  • "assignedSideRooms": "string",
  • "automaticReferenceCheck": "AUTOMATIC_REFERENCE_CHECK_MODE_UNDEFINED",
  • "availability": {
    },
  • "awn": "string",
  • "category": "UNDEFINED_CATEGORY",
  • "characteristics": {
    },
  • "contacts": {
    },
  • "defaultAnswer": {
    },
  • "deposit": {
    },
  • "description": "string",
  • "development": "UNDEFINED_DEVELOPMENT",
  • "documents": [
    ],
  • "energySources": [
    ],
  • "ewid": "string",
  • "images": [
    ],
  • "inactiveBy": {
    },
  • "marketingLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
  • "name": "string",
  • "needsMatching": true,
  • "note": "string",
  • "number": "string",
  • "otoId": "string",
  • "parking": [
    ],
  • "positions": [
    ],
  • "pricing": {
    },
  • "publishAddress": true,
  • "publishCharacteristicsInDescription": true,
  • "referenceSenderMailboxId": "string",
  • "renovations": [
    ],
  • "sharedUse": "string",
  • "specialFeatures": "string",
  • "subCategories": [
    ],
  • "tags": [
    ],
  • "title": "string",
  • "type": "RENT",
  • "unusualAgreement": "string",
  • "utilizations": [
    ],
  • "valueQuota": 0.1,
  • "videoUrl": "string",
  • "videos": [
    ],
  • "viewingAppointment": {
    },
  • "virtualTourUrl": "string"
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Update object market pricing

Updates upper/market/under market rent pricing fields for the object identified by ID. Returns the updated pricing.

path Parameters
id
required
string
Request Body schema: application/json
required
marketGrossRent
number <float>
marketHeatingAndAdditional
number <float>
marketNetRent
number <float>
underMarketGrossRent
number <float>
underMarketHeatingAndAdditional
number <float>
underMarketNetRent
number <float>
upperMarketGrossRent
number <float>
upperMarketHeatingAndAdditional
number <float>
upperMarketNetRent
number <float>

Responses

Request samples

Content type
application/json
{
  • "marketGrossRent": 0.1,
  • "marketHeatingAndAdditional": 0.1,
  • "marketNetRent": 0.1,
  • "underMarketGrossRent": 0.1,
  • "underMarketHeatingAndAdditional": 0.1,
  • "underMarketNetRent": 0.1,
  • "upperMarketGrossRent": 0.1,
  • "upperMarketHeatingAndAdditional": 0.1,
  • "upperMarketNetRent": 0.1
}

Response samples

Content type
application/json
{
  • "pricing": {
    }
}

PlotService

Create plots

Creates one or more plots for the given owner and property. Accepts land register data, area, values, category, operation, strategy, dates, and document IDs. Returns the created plots.

Request Body schema: application/json
required
required
Array of objects (plotPlotCreation)

Responses

Request samples

Content type
application/json
{
  • "plotCreations": [
    ]
}

Response samples

Content type
application/json
{
  • "plots": [
    ]
}

List plots by IDs

Returns the plots matching the given plot IDs.

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{
  • "plots": [
    ]
}

List plots for an owner

Returns a paginated list of plots for the given owner. Supports page and itemsPerPage. Response includes total plot and page counts.

path Parameters
ownerId
required
string <int64>
query Parameters
page
integer <int32>
itemsPerPage
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "plots": [
    ],
  • "totalPageCount": 0,
  • "totalPlotCount": 0
}

List plots by property ID

Returns all plots associated with the given property ID.

path Parameters
propertyId
required
string

Responses

Response samples

Content type
application/json
{
  • "plots": [
    ]
}

List plots by reference IDs

Returns plots matching any of the given reference IDs.

Request Body schema: application/json
required
referenceIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "referenceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "plots": [
    ]
}

Update plots

Updates one or more existing plots by ID. Accepts land register data, area, values, category, operation, strategy, dates, and document IDs. Returns the updated plots.

Request Body schema: application/json
required
required
Array of objects (plotPlotUpdate)

Responses

Request samples

Content type
application/json
{
  • "plotUpdates": [
    ]
}

Response samples

Content type
application/json
{
  • "plots": [
    ]
}

Delete plots

Deletes the plots with the given IDs.

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{ }

PropertyService

Count properties for an account

Returns the number of properties visible for the given account under the specified share scope.

path Parameters
accountId
required
string <int64>
query Parameters
scope
string
Default: "UNDEFINED_SCOPE"
Enum: "UNDEFINED_SCOPE" "MARKETING_SCOPE" "MANAGEMENT_SCOPE" "ACCOUNTING_SCOPE" "ASSET_SCOPE"

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Create a property

Creates a new property for the given owner. Optional numericId may be supplied; otherwise it can be generated by the service. Address requires zip, city and state.

Request Body schema: application/json
required
required
Array of objects (v2AdditionalRentComponentEntry)
required
object (commonaddressAddress)
required
Array of objects (v2AdvancePaymentRentComponentEntry)
required
object (v2Assignees)
required
Array of objects (v2BankInfo)
buildingIds
required
Array of strings
constructionZone
required
string
development
required
string (propertyv2Development)
Default: "PROPERTY_DEVELOPMENT_UNDEFINED"
Enum: "PROPERTY_DEVELOPMENT_UNDEFINED" "PROPERTY_DEVELOPMENT_FULL" "PROPERTY_DEVELOPMENT_PARTIAL" "PROPERTY_DEVELOPMENT_UNDEVELOPED"
documentIds
required
Array of strings
egrid
required
string
required
Array of objects (v2FlatRateRentComponentEntry)
imageMediaId
required
string
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

landRegisterNumber
required
string
name
required
string
note
required
string
numericId
required
string <int64>
onboardingFinished
required
boolean
opted
required
boolean
optedPortionKey
required
string (propertyv2OptedPortionKey)
Default: "OPTED_PORTION_KEY_UNDEFINED"
Enum: "OPTED_PORTION_KEY_UNDEFINED" "OPTED_PORTION_KEY_M2" "OPTED_PORTION_KEY_M3" "OPTED_PORTION_KEY_VALUE_RATIO" "OPTED_PORTION_KEY_TV" "OPTED_PORTION_KEY_ELEVATOR" "OPTED_PORTION_KEY_LOCATION_COMPENSATION" "OPTED_PORTION_KEY_UNIT" "OPTED_PORTION_KEY_NUMBER_OF_INHABITANTS" "OPTED_PORTION_KEY_SHARE"
ownerId
required
string <int64> (The account ID of the owner)
plotArea
required
number <float>
propertyValue
required
string <int64>
transferToAccounting
required
boolean
type
required
string (propertyv2PropertyType)
Default: "PROPERTY_TYPE_UNDEFINED"
Enum: "PROPERTY_TYPE_UNDEFINED" "PROPERTY_TYPE_RENTAL" "PROPERTY_TYPE_CONDOMINIUM_OWNERSHIP" "PROPERTY_TYPE_COOPERATIVE"

Responses

Request samples

Content type
application/json
{
  • "additionalRentComponents": [
    ],
  • "address": {
    },
  • "advancePaymentRentComponents": [
    ],
  • "assignees": {
    },
  • "bankInfo": [
    ],
  • "buildingIds": [
    ],
  • "constructionZone": "string",
  • "development": "PROPERTY_DEVELOPMENT_UNDEFINED",
  • "documentIds": [
    ],
  • "egrid": "string",
  • "flatRateRentComponents": [
    ],
  • "imageMediaId": "string",
  • "keyDateServiceChargeSettlement": {
    },
  • "landRegisterNumber": "string",
  • "name": "string",
  • "note": "string",
  • "numericId": "string",
  • "onboardingFinished": true,
  • "opted": true,
  • "optedPortionKey": "OPTED_PORTION_KEY_UNDEFINED",
  • "ownerId": "string",
  • "plotArea": 0.1,
  • "propertyValue": "string",
  • "transferToAccounting": true,
  • "type": "PROPERTY_TYPE_UNDEFINED"
}

Response samples

Content type
application/json
{
  • "property": {
    }
}

Get allowed property types

Returns the property types the given account is allowed to use (e.g. rental, condominium ownership, cooperative).

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "types": [
    ]
}

List properties for an owner

Returns a paginated list of properties for the given owner. Supports filtering by name, numeric number, zip range and city, and sorting by number, land register number, building count, or rent figures. Response includes total property and page counts.

path Parameters
ownerId
required
string <int64>
query Parameters
page
integer <int32>
itemsPerPage
integer <int32>
name
string
number
integer <int32>
zipFrom
integer <int32>
zipTo
integer <int32>
city
string
sortNumber
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortLandRegisterNumber
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortBuildingCount
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortGrossTargetRentPerYear
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortGrossActualRentPerYear
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortNetTargetRentPerYear
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortNetActualRentPerYear
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "totalPageCount": 0,
  • "totalPropertiesCount": 0
}

List properties by building IDs

Returns properties that contain any of the given building IDs.

path Parameters
buildingIds
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ]
}

List properties by IDs

Returns the properties matching the given property IDs.

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ]
}

Get property by owner and numeric ID

Returns a single property identified by owner account ID and property numeric ID.

path Parameters
ownerId
required
string <int64>
numericId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "property": {
    }
}

List property filter options

Returns property filter options (id, name, ownerId, buildingIds) available to the authenticated caller. Options are determined by authorization data; the request has no parameters.

Responses

Response samples

Content type
application/json
{
  • "options": [
    ]
}

List property numeric IDs for an owner

Returns the numeric IDs of all properties belonging to the given owner.

path Parameters
ownerId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "numericIds": [
    ]
}

Sell a property to a new owner

Transfers ownership of the property to targetOwnerId. Optionally keeps existing network partners.

Request Body schema: application/json
required
id
required
string
keepNetworkPartners
required
boolean
targetOwnerId
required
string <int64>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "keepNetworkPartners": true,
  • "targetOwnerId": "string"
}

Response samples

Content type
application/json
{
  • "property": {
    }
}

Set accounting assignee on properties

Sets the accounting assignee contact for the given property IDs.

Request Body schema: application/json
required
contactIdAssigneeAccounting
required
string
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIdAssigneeAccounting": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Set admin assignee on properties

Sets the administration assignee contact for the given property IDs.

Request Body schema: application/json
required
contactIdAssigneeAdministration
required
string
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIdAssigneeAdministration": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Set asset assignee on properties

Sets the asset assignee contact for the given property IDs.

Request Body schema: application/json
required
contactIdAssigneeAsset
required
string
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIdAssigneeAsset": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Set owner assignee on properties

Sets the owner assignee contact for the given property IDs.

Request Body schema: application/json
required
contactIdAssigneeOwner
required
string
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIdAssigneeOwner": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Transfer properties to accounting

Marks the given properties as transferred to accounting (sets transferToAccounting).

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Delete properties

Deletes the properties with the given IDs.

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{ }

Add a building to a property

Associates an additional building ID with the given property.

path Parameters
id
required
string
Request Body schema: application/json
required
buildingId
string

Responses

Request samples

Content type
application/json
{
  • "buildingId": "string"
}

Response samples

Content type
application/json
{
  • "property": {
    }
}

Update a property

Updates an existing property by ID. Address requires zip, city and state when set.

path Parameters
id
required
string
Request Body schema: application/json
required
Array of objects (v2AdditionalRentComponentEntry)
object (commonaddressAddress)
Array of objects (v2AdvancePaymentRentComponentEntry)
object (v2Assignees)
Array of objects (v2BankInfo)
buildingIds
Array of strings
constructionZone
string
development
string (propertyv2Development)
Default: "PROPERTY_DEVELOPMENT_UNDEFINED"
Enum: "PROPERTY_DEVELOPMENT_UNDEFINED" "PROPERTY_DEVELOPMENT_FULL" "PROPERTY_DEVELOPMENT_PARTIAL" "PROPERTY_DEVELOPMENT_UNDEVELOPED"
documentIds
Array of strings
egrid
string
Array of objects (v2FlatRateRentComponentEntry)
imageMediaId
string
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

landRegisterNumber
string
name
string
note
string
onboardingFinished
boolean
opted
boolean
optedPortionKey
string (propertyv2OptedPortionKey)
Default: "OPTED_PORTION_KEY_UNDEFINED"
Enum: "OPTED_PORTION_KEY_UNDEFINED" "OPTED_PORTION_KEY_M2" "OPTED_PORTION_KEY_M3" "OPTED_PORTION_KEY_VALUE_RATIO" "OPTED_PORTION_KEY_TV" "OPTED_PORTION_KEY_ELEVATOR" "OPTED_PORTION_KEY_LOCATION_COMPENSATION" "OPTED_PORTION_KEY_UNIT" "OPTED_PORTION_KEY_NUMBER_OF_INHABITANTS" "OPTED_PORTION_KEY_SHARE"
plotArea
number <float>
propertyValue
string <int64>
transferToAccounting
boolean
type
string (propertyv2PropertyType)
Default: "PROPERTY_TYPE_UNDEFINED"
Enum: "PROPERTY_TYPE_UNDEFINED" "PROPERTY_TYPE_RENTAL" "PROPERTY_TYPE_CONDOMINIUM_OWNERSHIP" "PROPERTY_TYPE_COOPERATIVE"

Responses

Request samples

Content type
application/json
{
  • "additionalRentComponents": [
    ],
  • "address": {
    },
  • "advancePaymentRentComponents": [
    ],
  • "assignees": {
    },
  • "bankInfo": [
    ],
  • "buildingIds": [
    ],
  • "constructionZone": "string",
  • "development": "PROPERTY_DEVELOPMENT_UNDEFINED",
  • "documentIds": [
    ],
  • "egrid": "string",
  • "flatRateRentComponents": [
    ],
  • "imageMediaId": "string",
  • "keyDateServiceChargeSettlement": {
    },
  • "landRegisterNumber": "string",
  • "name": "string",
  • "note": "string",
  • "onboardingFinished": true,
  • "opted": true,
  • "optedPortionKey": "OPTED_PORTION_KEY_UNDEFINED",
  • "plotArea": 0.1,
  • "propertyValue": "string",
  • "transferToAccounting": true,
  • "type": "PROPERTY_TYPE_UNDEFINED"
}

Response samples

Content type
application/json
{
  • "property": {
    }
}

RentalIndexService

Create a rental index template

Creates a rental index template for the given owner with name, language, tenancy type, fields, sorting, composition options, and onlyMovingInOutTenancies. Returns the created template.

Request Body schema: application/json
required
compositionLinesOrColumns
required
string (rental_indexCompositionLinesOrColumns)
Default: "COMPOSITION_LINES_OR_COLUMNS_UNDEFINED"
Enum: "COMPOSITION_LINES_OR_COLUMNS_UNDEFINED" "COMPOSITION_LINES_OR_COLUMNS_VERTICAL" "COMPOSITION_LINES_OR_COLUMNS_HORIZONTAL" "COMPOSITION_LINES_OR_COLUMNS_VERTICAL_WITH_DETAILS"
compositionType
required
string (rental_indexCompositionType)
Default: "COMPOSITION_TYPE_UNDEFINED"
Enum: "COMPOSITION_TYPE_UNDEFINED" "COMPOSITION_TYPE_SEPARATELY" "COMPOSITION_TYPE_CONSOLIDATE"
required
Array of objects (rental_indexTemplateField)
language
required
string (languagePreferredLanguage)
Default: "PREFERRED_LANGUAGE_UNDEFINED"
Enum: "PREFERRED_LANGUAGE_UNDEFINED" "PREFERRED_LANGUAGE_GERMAN" "PREFERRED_LANGUAGE_ENGLISH" "PREFERRED_LANGUAGE_ITALIAN" "PREFERRED_LANGUAGE_FRENCH"
name
required
string
onlyMovingInOutTenancies
required
boolean
ownerId
required
string <int64>
sortingType
required
string (rental_indexSortingType)
Default: "SORTING_TYPE_UNDEFINED"
Enum: "SORTING_TYPE_UNDEFINED" "SORTING_TYPE_OBJECT_ID" "SORTING_TYPE_OBJECT_NUMBER" "SORTING_TYPE_STANDARD"
tenancyType
required
string (rental_indexTenancyType)
Default: "TENANCY_TYPE_UNDEFINED"
Enum: "TENANCY_TYPE_UNDEFINED" "TENANCY_TYPE_ALL" "TENANCY_TYPE_RENTED" "TENANCY_TYPE_VACANT"

Responses

Request samples

Content type
application/json
{
  • "compositionLinesOrColumns": "COMPOSITION_LINES_OR_COLUMNS_UNDEFINED",
  • "compositionType": "COMPOSITION_TYPE_UNDEFINED",
  • "fields": [
    ],
  • "language": "PREFERRED_LANGUAGE_UNDEFINED",
  • "name": "string",
  • "onlyMovingInOutTenancies": true,
  • "ownerId": "string",
  • "sortingType": "SORTING_TYPE_UNDEFINED",
  • "tenancyType": "TENANCY_TYPE_UNDEFINED"
}

Response samples

Content type
application/json
{
  • "template": {
    }
}

List rental index templates

Returns all rental index templates available for the given accountId.

query Parameters
accountId
string <int64>

Responses

Response samples

Content type
application/json
{
  • "templates": [
    ]
}

Render a rental index file

Renders a rental index for the given buildingIds using language, tenancy type, date range, fields, sorting, composition options, custom header, and hideInactiveObjects. Returns the rendered file bytes.

Request Body schema: application/json
required
buildingIds
required
Array of strings
compositionLinesOrColumns
required
string (rental_indexCompositionLinesOrColumns)
Default: "COMPOSITION_LINES_OR_COLUMNS_UNDEFINED"
Enum: "COMPOSITION_LINES_OR_COLUMNS_UNDEFINED" "COMPOSITION_LINES_OR_COLUMNS_VERTICAL" "COMPOSITION_LINES_OR_COLUMNS_HORIZONTAL" "COMPOSITION_LINES_OR_COLUMNS_VERTICAL_WITH_DETAILS"
compositionType
required
string (rental_indexCompositionType)
Default: "COMPOSITION_TYPE_UNDEFINED"
Enum: "COMPOSITION_TYPE_UNDEFINED" "COMPOSITION_TYPE_SEPARATELY" "COMPOSITION_TYPE_CONSOLIDATE"
customHeader
required
string
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
Array of objects (rental_indexTemplateField)
hideInactiveObjects
required
boolean
language
required
string (languagePreferredLanguage)
Default: "PREFERRED_LANGUAGE_UNDEFINED"
Enum: "PREFERRED_LANGUAGE_UNDEFINED" "PREFERRED_LANGUAGE_GERMAN" "PREFERRED_LANGUAGE_ENGLISH" "PREFERRED_LANGUAGE_ITALIAN" "PREFERRED_LANGUAGE_FRENCH"
onlyMovingInOutTenancies
required
boolean
sortingType
required
string (rental_indexSortingType)
Default: "SORTING_TYPE_UNDEFINED"
Enum: "SORTING_TYPE_UNDEFINED" "SORTING_TYPE_OBJECT_ID" "SORTING_TYPE_OBJECT_NUMBER" "SORTING_TYPE_STANDARD"
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

tenancyType
required
string (rental_indexTenancyType)
Default: "TENANCY_TYPE_UNDEFINED"
Enum: "TENANCY_TYPE_UNDEFINED" "TENANCY_TYPE_ALL" "TENANCY_TYPE_RENTED" "TENANCY_TYPE_VACANT"

Responses

Request samples

Content type
application/json
{
  • "buildingIds": [
    ],
  • "compositionLinesOrColumns": "COMPOSITION_LINES_OR_COLUMNS_UNDEFINED",
  • "compositionType": "COMPOSITION_TYPE_UNDEFINED",
  • "customHeader": "string",
  • "endDate": {
    },
  • "fields": [
    ],
  • "hideInactiveObjects": true,
  • "language": "PREFERRED_LANGUAGE_UNDEFINED",
  • "onlyMovingInOutTenancies": true,
  • "sortingType": "SORTING_TYPE_UNDEFINED",
  • "startDate": {
    },
  • "tenancyType": "TENANCY_TYPE_UNDEFINED"
}

Response samples

Content type
application/json
{
  • "file": "string"
}

Render a rental index PDF

Renders a rental index PDF for the given buildingIds with language, date range, sorting, and layout flags (buildingBreakPage, displayPropertySummary, displayHeaderEveryPage, withoutTenantsNames, hideInactiveObjects). Returns the PDF file bytes.

Request Body schema: application/json
required
buildingBreakPage
required
boolean
buildingIds
required
Array of strings
displayHeaderEveryPage
required
boolean
displayPropertySummary
required
boolean
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

hideInactiveObjects
required
boolean
language
required
string (languagePreferredLanguage)
Default: "PREFERRED_LANGUAGE_UNDEFINED"
Enum: "PREFERRED_LANGUAGE_UNDEFINED" "PREFERRED_LANGUAGE_GERMAN" "PREFERRED_LANGUAGE_ENGLISH" "PREFERRED_LANGUAGE_ITALIAN" "PREFERRED_LANGUAGE_FRENCH"
sortingType
required
string (rental_indexSortingType)
Default: "SORTING_TYPE_UNDEFINED"
Enum: "SORTING_TYPE_UNDEFINED" "SORTING_TYPE_OBJECT_ID" "SORTING_TYPE_OBJECT_NUMBER" "SORTING_TYPE_STANDARD"
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

withoutTenantsNames
required
boolean

Responses

Request samples

Content type
application/json
{
  • "buildingBreakPage": true,
  • "buildingIds": [
    ],
  • "displayHeaderEveryPage": true,
  • "displayPropertySummary": true,
  • "endDate": {
    },
  • "hideInactiveObjects": true,
  • "language": "PREFERRED_LANGUAGE_UNDEFINED",
  • "sortingType": "SORTING_TYPE_UNDEFINED",
  • "startDate": {
    },
  • "withoutTenantsNames": true
}

Response samples

Content type
application/json
{
  • "file": "string"
}

Delete a rental index template

Deletes the rental index template identified by id.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Update a rental index template

Updates the rental index template identified by id (name, language, tenancy type, fields, sorting, composition, and onlyMovingInOutTenancies). Returns the updated template.

path Parameters
id
required
string
Request Body schema: application/json
required
compositionLinesOrColumns
string (rental_indexCompositionLinesOrColumns)
Default: "COMPOSITION_LINES_OR_COLUMNS_UNDEFINED"
Enum: "COMPOSITION_LINES_OR_COLUMNS_UNDEFINED" "COMPOSITION_LINES_OR_COLUMNS_VERTICAL" "COMPOSITION_LINES_OR_COLUMNS_HORIZONTAL" "COMPOSITION_LINES_OR_COLUMNS_VERTICAL_WITH_DETAILS"
compositionType
string (rental_indexCompositionType)
Default: "COMPOSITION_TYPE_UNDEFINED"
Enum: "COMPOSITION_TYPE_UNDEFINED" "COMPOSITION_TYPE_SEPARATELY" "COMPOSITION_TYPE_CONSOLIDATE"
Array of objects (rental_indexTemplateField)
language
string (languagePreferredLanguage)
Default: "PREFERRED_LANGUAGE_UNDEFINED"
Enum: "PREFERRED_LANGUAGE_UNDEFINED" "PREFERRED_LANGUAGE_GERMAN" "PREFERRED_LANGUAGE_ENGLISH" "PREFERRED_LANGUAGE_ITALIAN" "PREFERRED_LANGUAGE_FRENCH"
name
string
onlyMovingInOutTenancies
boolean
sortingType
string (rental_indexSortingType)
Default: "SORTING_TYPE_UNDEFINED"
Enum: "SORTING_TYPE_UNDEFINED" "SORTING_TYPE_OBJECT_ID" "SORTING_TYPE_OBJECT_NUMBER" "SORTING_TYPE_STANDARD"
tenancyType
string (rental_indexTenancyType)
Default: "TENANCY_TYPE_UNDEFINED"
Enum: "TENANCY_TYPE_UNDEFINED" "TENANCY_TYPE_ALL" "TENANCY_TYPE_RENTED" "TENANCY_TYPE_VACANT"

Responses

Request samples

Content type
application/json
{
  • "compositionLinesOrColumns": "COMPOSITION_LINES_OR_COLUMNS_UNDEFINED",
  • "compositionType": "COMPOSITION_TYPE_UNDEFINED",
  • "fields": [
    ],
  • "language": "PREFERRED_LANGUAGE_UNDEFINED",
  • "name": "string",
  • "onlyMovingInOutTenancies": true,
  • "sortingType": "SORTING_TYPE_UNDEFINED",
  • "tenancyType": "TENANCY_TYPE_UNDEFINED"
}

Response samples

Content type
application/json
{
  • "template": {
    }
}

RoomService

Create rooms

Creates one or more rooms from the given roomCreations. Each creation includes ownerId, referenceId, name, dimensions, note, documents, images, and order. Returns the created rooms.

Request Body schema: application/json
required
required
Array of objects (roomRoomCreation)

Responses

Request samples

Content type
application/json
{
  • "roomCreations": [
    ]
}

Response samples

Content type
application/json
{
  • "rooms": [
    ]
}

List rooms by IDs

Returns the rooms matching the given IDs.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "rooms": [
    ]
}

List rooms by reference IDs

Returns the rooms matching the given reference IDs.

Request Body schema: application/json
required
referenceIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "referenceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "rooms": [
    ]
}

Update rooms

Updates one or more rooms by ID via roomUpdates. Accepts name, dimensions, note, documents, images, and order. Returns the updated rooms.

Request Body schema: application/json
required
required
Array of objects (roomRoomUpdate)

Responses

Request samples

Content type
application/json
{
  • "roomUpdates": [
    ]
}

Response samples

Content type
application/json
{
  • "rooms": [
    ]
}

Delete rooms

Deletes the rooms with the given IDs.

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{ }

TenancyService

Close tenancies

Closes the tenancies with the given IDs.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Create a tenancy

Creates a new tenancy for the given owner and object. Optional numericId may be supplied; otherwise it can be generated by the service. Accepts contract, tenant, rent, deposit, dates, termination data, and status flags. Returns the created tenancy.

Request Body schema: application/json
required
activated
required
boolean
closed
required
boolean
required
object (objecttenancyContract)
contractAmendments
required
string
required
object (objecttenancyDeposit)
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

documentIds
required
Array of strings
required
Array of objects (tenancyEarlyRightOfTerminationOption)
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

familyFlat
required
boolean
finalInvoiceCreated
required
boolean
required
object (tenancyIndexData)
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

note
required
string
numericId
required
string <int64>
objectId
required
string
opted
required
boolean
ownerId
required
string <int64> (The account ID of the owner)
reasonForTermination
required
string

DO NOT USE! Deprecated and ignored.

required
Array of objects (tenancyRenewalOption)
required
object (objecttenancyRent)
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
Array of objects (tenancyRoommate)
secondaryResidence
required
boolean
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
Array of objects (tenancySubTenant)
taxable
required
boolean
required
object (objecttenancyTenant)
terminatedBy
required
string (tenancyTerminatedBy)
Default: "TERMINATED_BY_UNDEFINED"
Enum: "TERMINATED_BY_UNDEFINED" "TERMINATED_BY_LANDLORD" "TERMINATED_BY_TENANT"
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

terminationJustification
required
string
required
object (tenancyTermination)
terminationReason
required
Array of strings (tenancyTerminationReason)
Items Enum: "TERMINATION_REASON_UNDEFINED" "TERMINATION_REASON_IMPORTANT_REASONS" "TERMINATION_REASON_DEATH" "TERMINATION_REASON_TOO_SMALL" "TERMINATION_REASON_TOO_BIG" "TERMINATION_REASON_TOO_EXPENSIVE" "TERMINATION_REASON_IMMISSIONS_TOO_HIGH" "TERMINATION_REASON_FAMILY" "TERMINATION_REASON_JOB" "TERMINATION_REASON_VIOLATION_OF_DUE_DILIGENCE" "TERMINATION_REASON_BANKRUPTCY_OF_TENANT" "TERMINATION_REASON_OWN_NEED" "TERMINATION_REASON_RENOVATION" "TERMINATION_REASON_TEMPORARY_CONTRACT" "TERMINATION_REASON_ARREARS" "TERMINATION_REASON_ECONOMIC_REASONS" "TERMINATION_REASON_AREA_TOO_SMALL" "TERMINATION_REASON_AREA_TOO_LARGE" "TERMINATION_REASON_HOME_PURCHASE" "TERMINATION_REASON_SALE" "TERMINATION_REASON_UNAUTHORISED_SUBLETTING" "TERMINATION_REASON_PAYMENT_DEFAULT" "TERMINATION_REASON_POSTSCRIPT" "TERMINATION_REASON_INTERNAL_CHANGE" "TERMINATION_REASON_CONTRACT_OVERRIDE"
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (tenancyTermination)
terminationType
required
string (tenancyTerminationType)
Default: "TERMINATION_TYPE_UNDEFINED"
Enum: "TERMINATION_TYPE_UNDEFINED" "TERMINATION_TYPE_TERM" "TERMINATION_TYPE_OFF_TERM" "TERMINATION_TYPE_EXCEPTIONAL"
required
object (tenancyUnjustifiedUse)
vacancy
required
boolean
vacancyReason
required
string (tenancyVacancyReason)
Default: "VACANCY_REASON_UNDEFINED"
Enum: "VACANCY_REASON_UNDEFINED" "VACANCY_REASON_NO_NEXT_TENANT" "VACANCY_REASON_INITIAL_LETTING" "VACANCY_REASON_RENOVATION" "VACANCY_REASON_TEMPORARY_TENANCY" "VACANCY_REASON_SALE" "VACANCY_REASON_TERMINATION_UNDER_OR_257D" "VACANCY_REASON_EVICTION"

Responses

Request samples

Content type
application/json
{
  • "activated": true,
  • "closed": true,
  • "contract": {
    },
  • "contractAmendments": "string",
  • "deposit": {
    },
  • "desiredMoveOutAt": {
    },
  • "documentIds": [
    ],
  • "earlyRightOfTerminationOptions": [
    ],
  • "endingAt": {
    },
  • "familyFlat": true,
  • "finalInvoiceCreated": true,
  • "indexData": {
    },
  • "liabilityEndsAt": {
    },
  • "movedOutAt": {
    },
  • "nextPossibleMoveInAt": {
    },
  • "note": "string",
  • "numericId": "string",
  • "objectId": "string",
  • "opted": true,
  • "ownerId": "string",
  • "reasonForTermination": "string",
  • "renewalOptions": [
    ],
  • "rent": {
    },
  • "returningAt": {
    },
  • "roommates": [
    ],
  • "secondaryResidence": true,
  • "startingAt": {
    },
  • "subTenants": [
    ],
  • "taxable": true,
  • "tenant": {
    },
  • "terminatedBy": "TERMINATED_BY_UNDEFINED",
  • "terminatedOn": {
    },
  • "terminationCreatedAt": {
    },
  • "terminationJustification": "string",
  • "terminationLandlord": {
    },
  • "terminationReason": [
    ],
  • "terminationSentByTenantAt": {
    },
  • "terminationTenant": {
    },
  • "terminationType": "TERMINATION_TYPE_UNDEFINED",
  • "unjustifiedUse": {
    },
  • "vacancy": true,
  • "vacancyReason": "VACANCY_REASON_UNDEFINED"
}

Response samples

Content type
application/json
{
  • "tenancy": {
    }
}

Delete tenancy rent adjustments

Deletes rent adjustments for the given object IDs that match the specified byDate.

Request Body schema: application/json
required
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

objectIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "byDate": {
    },
  • "objectIds": [
    ]
}

Response samples

Content type
application/json
{ }

Get a tenancy by ID

Returns the tenancy identified by the given ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "tenancy": {
    }
}

Check activated tenancies by object IDs

For each given object ID, returns whether an activated tenancy exists.

Request Body schema: application/json
required
objectIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "objectIds": [
    ]
}

Response samples

Content type
application/json
{
  • "entries": [
    ]
}

List tenancies by object IDs

Returns tenancies linked to any of the given object IDs.

Request Body schema: application/json
required
objectIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "objectIds": [
    ]
}

Response samples

Content type
application/json
{
  • "tenancies": [
    ]
}

List tenancies by billing contact

Returns tenancies where the given contact ID is the billing contact.

path Parameters
billingContactId
required
string

Responses

Response samples

Content type
application/json
{
  • "tenancies": [
    ]
}

List tenancies by contact ID

Returns tenancies involving the given contact ID. Role filters (billingContact, tenants, correspondence, guarantors, subTenants) control which contact roles are matched.

path Parameters
contactId
required
string
query Parameters
billingContact
boolean
tenants
boolean
correspondence
boolean
guarantors
boolean
subTenants
boolean

Responses

Response samples

Content type
application/json
{
  • "tenancies": [
    ]
}

List tenancies by date and object IDs

Returns tenancies for the given object IDs overlapping the optional startDate/endDate range. includeTenancies and includeVacancies control whether real tenancies and vacancies are returned.

Request Body schema: application/json
required
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

includeTenancies
required
boolean
includeVacancies
required
boolean
objectIds
required
Array of strings
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

Responses

Request samples

Content type
application/json
{
  • "endDate": {
    },
  • "includeTenancies": true,
  • "includeVacancies": true,
  • "objectIds": [
    ],
  • "startDate": {
    }
}

Response samples

Content type
application/json
{
  • "tenancies": [
    ]
}

List tenancies by guarantor contact

Returns tenancies where the given contact ID is a guarantor.

path Parameters
guarantorContactId
required
string

Responses

Response samples

Content type
application/json
{
  • "tenancies": [
    ]
}

List tenancies by IDs

Returns the tenancies matching the given tenancy IDs.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "tenancies": [
    ]
}

List tenancies for an owner

Returns a paginated list of tenancies for the given owner. Supports filtering by address, categories, zip range, tenant contacts, and start/end date ranges, plus sorting by cold rent, additional costs, or total rent. Response includes total tenancy and page counts.

path Parameters
ownerId
required
string <int64>
query Parameters
page
integer <int32>
itemsPerPage
integer <int32>
address
string
categories
Array of strings
Items Enum: "UNDEFINED_CATEGORY" "APARTMENT" "HOUSE" "COMMERCIAL" "GASTRONOMY" "GARDEN" "PARKING_SPACE" "SECONDARY_ROOM" "PLOT" "AGRICULTURE"
zipFrom
integer <int32>
zipTo
integer <int32>
tenantContactIds
Array of strings
startingAtFrom
string <int64>

Int64 Unix Timestamp, NOT string!

startingAtTo
string <int64>

Int64 Unix Timestamp, NOT string!

endingAtFrom
string <int64>

Int64 Unix Timestamp, NOT string!

endingAtTo
string <int64>

Int64 Unix Timestamp, NOT string!

sortColdRent
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortAdditionalCosts
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortTotalRent
string
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"

Responses

Response samples

Content type
application/json
{
  • "tenancies": [
    ],
  • "totalPageCount": 0,
  • "totalTenanciesCount": 0
}

List tenancies by tenant contact

Returns tenancies for the given owner account ID where the given contact ID is a tenant.

path Parameters
ownerId
required
string <int64>
tenantContactId
required
string

Responses

Response samples

Content type
application/json
{
  • "tenancies": [
    ]
}

List current tenancies by object IDs

Returns the current tenancies for the given object IDs.

Request Body schema: application/json
required
objectIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "objectIds": [
    ]
}

Response samples

Content type
application/json
{
  • "tenancies": [
    ]
}

Publish tenancy updated events

Publishes updated events for tenancies belonging to the given owner account IDs.

Request Body schema: application/json
required
ownerIds
required
Array of strings <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "ownerIds": [
    ]
}

Response samples

Content type
application/json
{ }

Update tenancies in bulk

Updates multiple tenancies in one request via the given entries. Returns the updated tenancies.

Request Body schema: application/json
required
required
Array of objects (objecttenancyUpdateBulkEntry)

Responses

Request samples

Content type
application/json
{
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "tenancies": [
    ]
}

Delete a tenancy

Deletes the tenancy with the given ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Activate a tenancy

Activates the tenancy identified by ID. Optional document IDs may be attached. Returns the updated tenancy.

path Parameters
id
required
string
Request Body schema: application/json
required
documentIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "documentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "tenancy": {
    }
}

Add documents to a tenancy

Appends document IDs to the tenancy identified by ID. Returns the updated tenancy.

path Parameters
id
required
string
Request Body schema: application/json
required
documentIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "documentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "tenancy": {
    }
}

Deactivate a tenancy

Deactivates the tenancy identified by ID. Returns the updated tenancy.

path Parameters
id
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "tenancy": {
    }
}

Remove documents from a tenancy

Removes the given document IDs from the tenancy identified by ID. Returns the updated tenancy.

path Parameters
id
required
string
Request Body schema: application/json
required
documentIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "documentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "tenancy": {
    }
}

Set termination on a tenancy

Sets termination details on the tenancy identified by ID, including terminateAt, return/move-out dates, terminatedBy, type, reasons, and optional documents. Returns the updated tenancy.

path Parameters
id
required
string
Request Body schema: application/json
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

documentIds
Array of strings
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

reasonForTermination
string

DO NOT USE! Deprecated and ignored.

object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

terminatedBy
string (tenancyTerminatedBy)
Default: "TERMINATED_BY_UNDEFINED"
Enum: "TERMINATED_BY_UNDEFINED" "TERMINATED_BY_LANDLORD" "TERMINATED_BY_TENANT"
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

terminationJustification
string
terminationReason
Array of strings (tenancyTerminationReason)
Items Enum: "TERMINATION_REASON_UNDEFINED" "TERMINATION_REASON_IMPORTANT_REASONS" "TERMINATION_REASON_DEATH" "TERMINATION_REASON_TOO_SMALL" "TERMINATION_REASON_TOO_BIG" "TERMINATION_REASON_TOO_EXPENSIVE" "TERMINATION_REASON_IMMISSIONS_TOO_HIGH" "TERMINATION_REASON_FAMILY" "TERMINATION_REASON_JOB" "TERMINATION_REASON_VIOLATION_OF_DUE_DILIGENCE" "TERMINATION_REASON_BANKRUPTCY_OF_TENANT" "TERMINATION_REASON_OWN_NEED" "TERMINATION_REASON_RENOVATION" "TERMINATION_REASON_TEMPORARY_CONTRACT" "TERMINATION_REASON_ARREARS" "TERMINATION_REASON_ECONOMIC_REASONS" "TERMINATION_REASON_AREA_TOO_SMALL" "TERMINATION_REASON_AREA_TOO_LARGE" "TERMINATION_REASON_HOME_PURCHASE" "TERMINATION_REASON_SALE" "TERMINATION_REASON_UNAUTHORISED_SUBLETTING" "TERMINATION_REASON_PAYMENT_DEFAULT" "TERMINATION_REASON_POSTSCRIPT" "TERMINATION_REASON_INTERNAL_CHANGE" "TERMINATION_REASON_CONTRACT_OVERRIDE"
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

terminationType
string (tenancyTerminationType)
Default: "TERMINATION_TYPE_UNDEFINED"
Enum: "TERMINATION_TYPE_UNDEFINED" "TERMINATION_TYPE_TERM" "TERMINATION_TYPE_OFF_TERM" "TERMINATION_TYPE_EXCEPTIONAL"

Responses

Request samples

Content type
application/json
{
  • "desiredMoveOutAt": {
    },
  • "documentIds": [
    ],
  • "liabilityEndsAt": {
    },
  • "movedOutAt": {
    },
  • "nextPossibleMoveInAt": {
    },
  • "reasonForTermination": "string",
  • "returningAt": {
    },
  • "terminateAt": {
    },
  • "terminatedBy": "TERMINATED_BY_UNDEFINED",
  • "terminatedOn": {
    },
  • "terminationCreatedAt": {
    },
  • "terminationJustification": "string",
  • "terminationReason": [
    ],
  • "terminationSentByTenantAt": {
    },
  • "terminationType": "TERMINATION_TYPE_UNDEFINED"
}

Response samples

Content type
application/json
{
  • "tenancy": {
    }
}

Update a tenancy

Updates an existing tenancy by ID (contract, tenant, rent, deposit, dates, termination data, and status flags). Returns the updated tenancy.

path Parameters
id
required
string
Request Body schema: application/json
required
activated
boolean
closed
boolean
object (objecttenancyContract)
contractAmendments
string
object (objecttenancyDeposit)
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

documentIds
Array of strings
Array of objects (tenancyEarlyRightOfTerminationOption)
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

familyFlat
boolean
finalInvoiceCreated
boolean
object (tenancyIndexData)
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

note
string
objectId
string
opted
boolean
reasonForTermination
string

DO NOT USE! Deprecated and ignored.

Array of objects (tenancyRenewalOption)
object (objecttenancyRent)
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

Array of objects (tenancyRoommate)
secondaryResidence
boolean
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

Array of objects (tenancySubTenant)
taxable
boolean
object (objecttenancyTenant)
terminatedBy
string (tenancyTerminatedBy)
Default: "TERMINATED_BY_UNDEFINED"
Enum: "TERMINATED_BY_UNDEFINED" "TERMINATED_BY_LANDLORD" "TERMINATED_BY_TENANT"
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

terminationJustification
string
object (tenancyTermination)
terminationReason
Array of strings (tenancyTerminationReason)
Items Enum: "TERMINATION_REASON_UNDEFINED" "TERMINATION_REASON_IMPORTANT_REASONS" "TERMINATION_REASON_DEATH" "TERMINATION_REASON_TOO_SMALL" "TERMINATION_REASON_TOO_BIG" "TERMINATION_REASON_TOO_EXPENSIVE" "TERMINATION_REASON_IMMISSIONS_TOO_HIGH" "TERMINATION_REASON_FAMILY" "TERMINATION_REASON_JOB" "TERMINATION_REASON_VIOLATION_OF_DUE_DILIGENCE" "TERMINATION_REASON_BANKRUPTCY_OF_TENANT" "TERMINATION_REASON_OWN_NEED" "TERMINATION_REASON_RENOVATION" "TERMINATION_REASON_TEMPORARY_CONTRACT" "TERMINATION_REASON_ARREARS" "TERMINATION_REASON_ECONOMIC_REASONS" "TERMINATION_REASON_AREA_TOO_SMALL" "TERMINATION_REASON_AREA_TOO_LARGE" "TERMINATION_REASON_HOME_PURCHASE" "TERMINATION_REASON_SALE" "TERMINATION_REASON_UNAUTHORISED_SUBLETTING" "TERMINATION_REASON_PAYMENT_DEFAULT" "TERMINATION_REASON_POSTSCRIPT" "TERMINATION_REASON_INTERNAL_CHANGE" "TERMINATION_REASON_CONTRACT_OVERRIDE"
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

object (tenancyTermination)
terminationType
string (tenancyTerminationType)
Default: "TERMINATION_TYPE_UNDEFINED"
Enum: "TERMINATION_TYPE_UNDEFINED" "TERMINATION_TYPE_TERM" "TERMINATION_TYPE_OFF_TERM" "TERMINATION_TYPE_EXCEPTIONAL"
object (tenancyUnjustifiedUse)
vacancyReason
string (tenancyVacancyReason)
Default: "VACANCY_REASON_UNDEFINED"
Enum: "VACANCY_REASON_UNDEFINED" "VACANCY_REASON_NO_NEXT_TENANT" "VACANCY_REASON_INITIAL_LETTING" "VACANCY_REASON_RENOVATION" "VACANCY_REASON_TEMPORARY_TENANCY" "VACANCY_REASON_SALE" "VACANCY_REASON_TERMINATION_UNDER_OR_257D" "VACANCY_REASON_EVICTION"

Responses

Request samples

Content type
application/json
{
  • "activated": true,
  • "closed": true,
  • "contract": {
    },
  • "contractAmendments": "string",
  • "deposit": {
    },
  • "desiredMoveOutAt": {
    },
  • "documentIds": [
    ],
  • "earlyRightOfTerminationOptions": [
    ],
  • "endingAt": {
    },
  • "familyFlat": true,
  • "finalInvoiceCreated": true,
  • "indexData": {
    },
  • "liabilityEndsAt": {
    },
  • "movedOutAt": {
    },
  • "nextPossibleMoveInAt": {
    },
  • "note": "string",
  • "objectId": "string",
  • "opted": true,
  • "reasonForTermination": "string",
  • "renewalOptions": [
    ],
  • "rent": {
    },
  • "returningAt": {
    },
  • "roommates": [
    ],
  • "secondaryResidence": true,
  • "startingAt": {
    },
  • "subTenants": [
    ],
  • "taxable": true,
  • "tenant": {
    },
  • "terminatedBy": "TERMINATED_BY_UNDEFINED",
  • "terminatedOn": {
    },
  • "terminationCreatedAt": {
    },
  • "terminationJustification": "string",
  • "terminationLandlord": {
    },
  • "terminationReason": [
    ],
  • "terminationSentByTenantAt": {
    },
  • "terminationTenant": {
    },
  • "terminationType": "TERMINATION_TYPE_UNDEFINED",
  • "unjustifiedUse": {
    },
  • "vacancyReason": "VACANCY_REASON_UNDEFINED"
}

Response samples

Content type
application/json
{
  • "tenancy": {
    }
}

Deactivate a tenancy by numeric ID

Deactivates the tenancy identified by owner account ID and numeric ID. Returns the updated tenancy.

path Parameters
numericId
required
string <int64>
Request Body schema: application/json
required
ownerId
string <int64>

Responses

Request samples

Content type
application/json
{
  • "ownerId": "string"
}

Response samples

Content type
application/json
{
  • "tenancy": {
    }
}