object API (develop:c14720)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the object stack.

EnergySourceService

EnergySourceService_Create

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

Payload

Content type

application/json

{"co2PerYear": 0.1,
"consumption": 0.1,
"consumptionKwhPerYear": 0.1,
"costDistribution": "COST_DISTRIBUTION_UNDEFINED",
"costDistribution2": "COST_DISTRIBUTION_UNDEFINED",
"documentIds": ["string"
],
"energyReferenceArea": 0.1,
"heatDistribution": "HEAT_DISTRIBUTION_UNDEFINED",
"kind": "ENERGY_SOURCE_KIND_UNDEFINED",
"orders": [{"date": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"quantity": 0.1
}
],
"ownerId": "string",
"photovoltaic": true,
"referenceId": "string",
"selfConsumptionCommunity": true,
"tankReadings": [{"date": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "ENERGY_SOURCE_TYPE_UNDEFINED",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}

Response samples

200
default

Content type

application/json

{"energySource": {"co2PerYear": 0.1,
"consumption": 0.1,
"consumptionKwhPerYear": 0.1,
"costDistribution": "COST_DISTRIBUTION_UNDEFINED",
"costDistribution2": "COST_DISTRIBUTION_UNDEFINED",
"documentIds": ["string"
],
"energyReferenceArea": 0.1,
"heatDistribution": "HEAT_DISTRIBUTION_UNDEFINED",
"id": "string",
"kind": "ENERGY_SOURCE_KIND_UNDEFINED",
"orders": [{"date": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"quantity": 0.1
}
],
"ownerId": "string",
"photovoltaic": true,
"referenceId": "string",
"selfConsumptionCommunity": true,
"tankReadings": [{"date": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "ENERGY_SOURCE_TYPE_UNDEFINED",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
}

EnergySourceService_ListByIds

Request Body schema: application/json
required

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{"energySources": [{"co2PerYear": 0.1,
"consumption": 0.1,
"consumptionKwhPerYear": 0.1,
"costDistribution": "COST_DISTRIBUTION_UNDEFINED",
"costDistribution2": "COST_DISTRIBUTION_UNDEFINED",
"documentIds": ["string"
],
"energyReferenceArea": 0.1,
"heatDistribution": "HEAT_DISTRIBUTION_UNDEFINED",
"id": "string",
"kind": "ENERGY_SOURCE_KIND_UNDEFINED",
"orders": [{"date": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"quantity": 0.1
}
],
"ownerId": "string",
"photovoltaic": true,
"referenceId": "string",
"selfConsumptionCommunity": true,
"tankReadings": [{"date": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "ENERGY_SOURCE_TYPE_UNDEFINED",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
]
}

EnergySourceService_ListByReferenceIds

Request Body schema: application/json
required

referenceIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"referenceIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"energySources": [{"co2PerYear": 0.1,
"consumption": 0.1,
"consumptionKwhPerYear": 0.1,
"costDistribution": "COST_DISTRIBUTION_UNDEFINED",
"costDistribution2": "COST_DISTRIBUTION_UNDEFINED",
"documentIds": ["string"
],
"energyReferenceArea": 0.1,
"heatDistribution": "HEAT_DISTRIBUTION_UNDEFINED",
"id": "string",
"kind": "ENERGY_SOURCE_KIND_UNDEFINED",
"orders": [{"date": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"quantity": 0.1
}
],
"ownerId": "string",
"photovoltaic": true,
"referenceId": "string",
"selfConsumptionCommunity": true,
"tankReadings": [{"date": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "ENERGY_SOURCE_TYPE_UNDEFINED",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
]
}

EnergySourceService_Delete

path Parameters

ids

required

Array of strings non-empty

Responses

Response samples

200
default

Content type

application/json

{ }

EnergySourceService_Update

path Parameters

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

Payload

Content type

application/json

{"co2PerYear": 0.1,
"consumption": 0.1,
"consumptionKwhPerYear": 0.1,
"costDistribution": "COST_DISTRIBUTION_UNDEFINED",
"costDistribution2": "COST_DISTRIBUTION_UNDEFINED",
"documentIds": ["string"
],
"energyReferenceArea": 0.1,
"heatDistribution": "HEAT_DISTRIBUTION_UNDEFINED",
"kind": "ENERGY_SOURCE_KIND_UNDEFINED",
"orders": [{"date": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"quantity": 0.1
}
],
"photovoltaic": true,
"selfConsumptionCommunity": true,
"tankReadings": [{"date": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "ENERGY_SOURCE_TYPE_UNDEFINED",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}

Response samples

200
default

Content type

application/json

{"energySource": {"co2PerYear": 0.1,
"consumption": 0.1,
"consumptionKwhPerYear": 0.1,
"costDistribution": "COST_DISTRIBUTION_UNDEFINED",
"costDistribution2": "COST_DISTRIBUTION_UNDEFINED",
"documentIds": ["string"
],
"energyReferenceArea": 0.1,
"heatDistribution": "HEAT_DISTRIBUTION_UNDEFINED",
"id": "string",
"kind": "ENERGY_SOURCE_KIND_UNDEFINED",
"orders": [{"date": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"quantity": 0.1
}
],
"ownerId": "string",
"photovoltaic": true,
"referenceId": "string",
"selfConsumptionCommunity": true,
"tankReadings": [{"date": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "ENERGY_SOURCE_TYPE_UNDEFINED",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
}

ContractService

Create

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

Payload

Content type

application/json

{"category": "TEMPLATE_CATEGORY_UNDEFINED",
"creatorName": "string",
"mediaId": "string",
"ownerId": "string",
"title": "string"
}

Response samples

200
default

Content type

application/json

{"template": {"category": "TEMPLATE_CATEGORY_UNDEFINED",
"creatorName": "string",
"id": "string",
"mediaId": "string",
"ownerId": "string",
"title": "string"
}
}

Delete

path Parameters

ids

required

Array of strings non-empty

Responses

Response samples

200
default

Content type

application/json

{ }

Read

path Parameters

ownerIds

required

Array of strings <int64> non-empty [ items <int64 > ]

Responses

Response samples

200
default

Content type

application/json

{"templates": [{"category": "TEMPLATE_CATEGORY_UNDEFINED",
"creatorName": "string",
"id": "string",
"mediaId": "string",
"ownerId": "string",
"title": "string"
}
]
}

ContractService_RenderTemplate

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

Payload

Content type

application/json

{"attachAutomatically": true,
"description": "string",
"id": "string",
"signatories": ["string"
],
"tenancyId": "string",
"title": "string"
}

Response samples

200
default

Content type

application/json

{"contract": "string"
}

ContractService_RenderDeviceTemplate

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

Payload

Content type

application/json

{"assigneeContactId": "string",
"contactId": "string",
"description": "string",
"devices": [{"id": "string",
"note": "string"
}
],
"executeFrom": {"day": 0,
"month": 0,
"year": 0
},
"executeUntil": {"day": 0,
"month": 0,
"year": 0
},
"id": "string",
"onSiteContactPersonId": "string",
"orderDescription": "string",
"randomContactData": {"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string"
},
"title": "string"
}

Response samples

200
default

Content type

application/json

{"contract": "string"
}

ContractService_RenderTenanciesTemplate

Request Body schema: application/json
required

description required	string
id required	string
tenancyIds required	Array of strings
title required	string

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"id": "string",
"tenancyIds": ["string"
],
"title": "string"
}

Response samples

200
default

Content type

application/json

{"contract": "string"
}

Update

path Parameters

required

string

Request Body schema: application/json
required

mediaId	string
title	string

Responses

Request samples

Payload

Content type

application/json

{"mediaId": "string",
"title": "string"
}

Response samples

200
default

Content type

application/json

{ }

ContractService_RenderCondominiumTemplate

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

Payload

Content type

application/json

{"attachAutomatically": true,
"condominiumId": "string",
"description": "string",
"id": "string",
"title": "string"
}

Response samples

200
default

Content type

application/json

{"contract": "string"
}

ContractService_RenderCondominiumsTemplate

Request Body schema: application/json
required

condominiumIds required	Array of strings
description required	string
id required	string
title required	string

Responses

Request samples

Payload

Content type

application/json

{"condominiumIds": ["string"
],
"description": "string",
"id": "string",
"title": "string"
}

Response samples

200
default

Content type

application/json

{"contract": "string"
}

ContractService_RenderContactTemplate

Request Body schema: application/json
required

attachAutomatically required	boolean
contactId required	string
description required	string
id required	string
title required	string

Responses

Request samples

Payload

Content type

application/json

{"attachAutomatically": true,
"contactId": "string",
"description": "string",
"id": "string",
"title": "string"
}

Response samples

200
default

Content type

application/json

{"contract": "string"
}

ContractService_RenderContactsTemplate

Request Body schema: application/json
required

contactIds required	Array of strings
description required	string
id required	string
title required	string

Responses

Request samples

Payload

Content type

application/json

{"contactIds": ["string"
],
"description": "string",
"id": "string",
"title": "string"
}

Response samples

200
default

Content type

application/json

{"contract": "string"
}

Create

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

Payload

Content type

application/json

{"category": "TEMPLATE_CATEGORY_UNDEFINED",
"creatorName": "string",
"enforcePdf": true,
"language": "EN",
"mediaId": "string",
"ownerId": "string",
"title": "string"
}

Response samples

200
default

Content type

application/json

{"template": {"category": "TEMPLATE_CATEGORY_UNDEFINED",
"createdAt": "string",
"creatorName": "string",
"enforcePdf": true,
"id": "string",
"language": "EN",
"mediaId": "string",
"ownerId": "string",
"title": "string",
"updatedAt": "string"
}
}

Delete

path Parameters

ids

required

Array of strings non-empty

Responses

Response samples

200
default

Content type

application/json

{ }

ContractService_DeleteRenderFile

path Parameters

renderId

required

string

Responses

Response samples

200
default

Content type

application/json

{ }

ContractService_DeleteRenderFiles

Request Body schema: application/json
required

renderIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"renderIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

ContractService_GetRenderFile

path Parameters

renderId

required

string

Responses

Response samples

200
default

Content type

application/json

{"contract": "string"
}

Async render process

path Parameters

renderId

required

string

Responses

Response samples

200
default

Content type

application/json

{"errorMessage": "string",
"failed": true,
"finished": true
}

Read

path Parameters

ownerIds

required

Array of strings <int64> non-empty [ items <int64 > ]

Responses

Response samples

200
default

Content type

application/json

{"templates": [{"category": "TEMPLATE_CATEGORY_UNDEFINED",
"createdAt": "string",
"creatorName": "string",
"enforcePdf": true,
"id": "string",
"language": "EN",
"mediaId": "string",
"ownerId": "string",
"title": "string",
"updatedAt": "string"
}
]
}

ContractService_ListRenderStatus

Request Body schema: application/json
required

renderIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"renderIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"status": [{"errorMessage": "string",
"failed": true,
"finished": true,
"renderId": "string"
}
]
}

ContractService_RenderDeviceTemplateMixin2

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

Payload

Content type

application/json

{"assigneeContactId": "string",
"attachAutomatically": true,
"contactId": "string",
"description": "string",
"devices": [{"id": "string",
"note": "string"
}
],
"documentName": "string",
"enforcePdf": true,
"executeFrom": {"day": 0,
"month": 0,
"year": 0
},
"executeUntil": {"day": 0,
"month": 0,
"year": 0
},
"id": "string",
"onSiteContactPersonId": "string",
"orderDescription": "string",
"orderNumber": "string",
"randomContactData": {"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string"
},
"showInPortal": true,
"signatories": ["string"
],
"title": "string"
}

Response samples

200
default

Content type

application/json

{"renderId": "string"
}

ContractService_RenderTenanciesTemplateMixin2

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

Payload

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": ["string"
],
"tenancyIds": ["string"
],
"title": "string"
}

Response samples

200
default

Content type

application/json

{"renderId": "string"
}

Render

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

Payload

Content type

application/json

{"attachAutomatically": true,
"description": "string",
"documentName": "string",
"enforcePdf": true,
"id": "string",
"sendingProfile": "string",
"showInPortal": true,
"signatories": ["string"
],
"tenancyId": "string",
"title": "string",
"useGuarantorAddress": true
}

Response samples

200
default

Content type

application/json

{"renderId": "string"
}

Update

path Parameters

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

Payload

Content type

application/json

{"category": "TEMPLATE_CATEGORY_UNDEFINED",
"creatorName": "string",
"enforcePdf": true,
"language": "EN",
"mediaId": "string",
"ownerId": "string",
"title": "string"
}

Response samples

200
default

Content type

application/json

{ }

ContractService_GetRenderFiles

Request Body schema: application/json
required

renderIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"renderIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"contract": "string"
}

ContractService_RenderCondominiumTemplateMixin2

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

Payload

Content type

application/json

{"attachAutomatically": true,
"condominiumId": "string",
"description": "string",
"documentName": "string",
"enforcePdf": true,
"id": "string",
"includeRoommates": true,
"sendingProfile": "string",
"showInPortal": true,
"signatories": ["string"
],
"title": "string"
}

Response samples

200
default

Content type

application/json

{"renderId": "string"
}

ContractService_RenderCondominiumsTemplateMixin2

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

Payload

Content type

application/json

{"attachAutomatically": true,
"condominiumIds": ["string"
],
"description": "string",
"documentName": "string",
"enforcePdf": true,
"id": "string",
"includeRoommates": true,
"order": "RENDER_ORDER_DEFAULT",
"sendingProfile": "string",
"showInPortal": true,
"signatories": ["string"
],
"title": "string"
}

Response samples

200
default

Content type

application/json

{"renderId": "string"
}

ContractService_RenderContactTemplateMixin2

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

Payload

Content type

application/json

{"attachAutomatically": true,
"contactId": "string",
"description": "string",
"documentName": "string",
"enforcePdf": true,
"id": "string",
"sendingProfile": "string",
"showInPortal": true,
"signatories": ["string"
],
"title": "string"
}

Response samples

200
default

Content type

application/json

{"renderId": "string"
}

ContractService_RenderContactsTemplateMixin2

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

Payload

Content type

application/json

{"attachAutomatically": true,
"contactIds": ["string"
],
"description": "string",
"documentName": "string",
"enforcePdf": true,
"id": "string",
"order": "RENDER_ORDER_DEFAULT",
"sendingProfile": "string",
"showInPortal": true,
"signatories": ["string"
],
"title": "string"
}

Response samples

200
default

Content type

application/json

{"renderId": "string"
}

CountryIndexService

CountryIndexService_GetInflation

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

200
default

Content type

application/json

{"inflation": 0.1
}

CountryIndexService_Read

Request Body schema: application/json
required

fileUrl

required

string

Responses

Request samples

Payload

Content type

application/json

{"fileUrl": "string"
}

Response samples

200
default

Content type

application/json

{ }

RoomService

Create

Request Body schema: application/json
required

required

Array of objects (roomRoomCreation)

Responses

Request samples

Payload

Content type

application/json

{"roomCreations": [{"dimensions": {"area": 0.1,
"height": 0.1,
"length": 0.1,
"volume": 0.1,
"width": 0.1
},
"documentIds": ["string"
],
"imageMediaIds": ["string"
],
"name": "string",
"note": "string",
"order": 0,
"ownerId": "string",
"referenceId": "string"
}
]
}

Response samples

200
default

Content type

application/json

{"rooms": [{"dimensions": {"area": 0.1,
"height": 0.1,
"length": 0.1,
"volume": 0.1,
"width": 0.1
},
"documentIds": ["string"
],
"id": "string",
"imageMediaIds": ["string"
],
"name": "string",
"note": "string",
"order": 0,
"ownerId": "string",
"referenceId": "string"
}
]
}

Read

Request Body schema: application/json
required

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{"rooms": [{"dimensions": {"area": 0.1,
"height": 0.1,
"length": 0.1,
"volume": 0.1,
"width": 0.1
},
"documentIds": ["string"
],
"id": "string",
"imageMediaIds": ["string"
],
"name": "string",
"note": "string",
"order": 0,
"ownerId": "string",
"referenceId": "string"
}
]
}

RoomService_ListByReferenceIds

Request Body schema: application/json
required

referenceIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"referenceIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"rooms": [{"dimensions": {"area": 0.1,
"height": 0.1,
"length": 0.1,
"volume": 0.1,
"width": 0.1
},
"documentIds": ["string"
],
"id": "string",
"imageMediaIds": ["string"
],
"name": "string",
"note": "string",
"order": 0,
"ownerId": "string",
"referenceId": "string"
}
]
}

Update

Request Body schema: application/json
required

required

Array of objects (roomRoomUpdate)

Responses

Request samples

Payload

Content type

application/json

{"roomUpdates": [{"dimensions": {"area": 0.1,
"height": 0.1,
"length": 0.1,
"volume": 0.1,
"width": 0.1
},
"documentIds": ["string"
],
"id": "string",
"imageMediaIds": ["string"
],
"name": "string",
"note": "string",
"order": 0
}
]
}

Response samples

200
default

Content type

application/json

{"rooms": [{"dimensions": {"area": 0.1,
"height": 0.1,
"length": 0.1,
"volume": 0.1,
"width": 0.1
},
"documentIds": ["string"
],
"id": "string",
"imageMediaIds": ["string"
],
"name": "string",
"note": "string",
"order": 0,
"ownerId": "string",
"referenceId": "string"
}
]
}

Delete

path Parameters

ids

required

Array of strings non-empty

Responses

Response samples

200
default

Content type

application/json

{ }

GroupService

GroupService_AddBuilding

path Parameters

id required	string
buildingId required	string

Request Body schema: application/json
required

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
default

Content type

application/json

{"group": {"buildingIds": ["string"
],
"id": "string",
"name": "string",
"ownerId": "string"
}
}

GroupService_Create

Request Body schema: application/json
required

buildingIds required	Array of strings
name required	string
ownerId required	string <int64>

Responses

Request samples

Payload

Content type

application/json

{"buildingIds": ["string"
],
"name": "string",
"ownerId": "string"
}

Response samples

200
default

Content type

application/json

{"group": {"buildingIds": ["string"
],
"id": "string",
"name": "string",
"ownerId": "string"
}
}

GroupService_Delete

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{ }

GroupService_Get

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{"group": {"buildingIds": ["string"
],
"id": "string",
"name": "string",
"ownerId": "string"
}
}

GroupService_List

path Parameters

accountId

required

string <int64>

The accountId of the owner of the groups to list

Responses

Response samples

200
default

Content type

application/json

{"groups": [{"buildingIds": ["string"
],
"id": "string",
"name": "string",
"ownerId": "string"
}
]
}

GroupService_RemoveBuilding

path Parameters

id required	string
buildingId required	string

Request Body schema: application/json
required

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
default

Content type

application/json

{"group": {"buildingIds": ["string"
],
"id": "string",
"name": "string",
"ownerId": "string"
}
}

GroupService_Update

path Parameters

required

string

Request Body schema: application/json
required

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200
default

Content type

application/json

{"group": {"buildingIds": ["string"
],
"id": "string",
"name": "string",
"ownerId": "string"
}
}

DemoDataService

DemoDataService_Generate

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

Payload

Content type

application/json

{"accountId": "string",
"dataSet": "DEMO_DATA_SET_1"
}

Response samples

200
default

Content type

application/json

{ }

FahrlaenderService

FahrlaenderService_LoadConfiguration

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"configuration": {"accountId": "string",
"apiPassword": "string",
"apiUser": "string",
"features": ["FAHRLAENDER_FEATURES_UNDEFINED"
]
}
}

FahrlaenderService_SaveConfiguration

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

Payload

Content type

application/json

{"apiPassword": "string",
"apiUser": "string",
"features": ["FAHRLAENDER_FEATURES_UNDEFINED"
]
}

Response samples

200
default

Content type

application/json

{ }

Business logic

path Parameters

accountId

required

string <int64>

Request Body schema: application/json
required

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
default

Content type

application/json

{"commandsPublished": 0
}

FahrlaenderService_UpdateMicroLocationRatings

path Parameters

accountId

required

string <int64>

Request Body schema: application/json
required

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
default

Content type

application/json

{"commandsPublished": 0
}

ObjectService

ObjectService_AddCraftsmen

Request Body schema: application/json
required

contactIdsCraftsman required	Array of strings
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"contactIdsCraftsman": ["string"
],
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_AddJanitors

Request Body schema: application/json
required

contactIdsJanitor required	Array of strings
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"contactIdsJanitor": ["string"
],
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_AddServiceProviders

Request Body schema: application/json
required

contactIdsServiceProvider required	Array of strings
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"contactIdsServiceProvider": ["string"
],
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

Create

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

Payload

Content type

application/json

{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"administrationType": "UNDEFINED_ADMINISTRATION_TYPE",
"assignedSideRooms": "string",
"availability": {"availableFrom": "string",
"availableTo": "string",
"type": "IMMEDIATELY"
},
"awn": "string",
"buildingId": "string",
"category": "UNDEFINED_CATEGORY",
"characteristics": {"additionalRooms": ["ADDITIONAL_ROOM_ATTIC"
],
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"bathrooms": 0,
"ceilingHeight": 0.1,
"commercialFeatures": ["COMMERCIAL_FEATURES_GOODS_LIFT"
],
"condition": "UNDEFINED_CONDITION",
"decimalFloor": 0.1,
"extras": ["EXTRAS_BALCONY"
],
"firstTimeOccupancy": "string",
"flatSharingCommunity": "UNDEFINED_VALUE",
"floor": 0,
"floorLoad": 0.1,
"floorings": ["FLOORING_TILES"
],
"foreignQuota": "UNDEFINED_VALUE",
"furnishing": "UNDEFINED_FURNISHING",
"furnishingType": "UNDEFINED_FURNISHING_TYPE",
"gardenShed": "UNDEFINED_VALUE",
"glazings": ["GLAZING_ACOUSTIC_GLAZING"
],
"grossPremium": 0,
"guestToilets": 0,
"hallHeight": 0.1,
"heatings": ["CENTRAL_HEATING"
],
"kitchens": ["NO_KITCHEN"
],
"locationQualities": ["PARTICULARLY_QUIET"
],
"numberOfFloors": 0.1,
"opted": "UNDEFINED_VALUE",
"petAllowances": ["PETS_ALLOWED"
],
"pets": "UNDEFINED_VALUE",
"photovoltaic": "UNDEFINED_VALUE",
"planned": "UNDEFINED_VALUE",
"rooms": 0.1,
"sanitaries": ["SANITARY_BATHROOM_WITH_WINDOW"
],
"secondaryResidenceAllowed": "UNDEFINED_VALUE",
"separateToilets": 0,
"shellConstruction": "UNDEFINED_VALUE",
"showers": 0,
"smoking": "UNDEFINED_VALUE",
"technologies": ["TECHNOLOGY_ALARM_SYSTEM"
],
"thermalSolarCollector": "UNDEFINED_VALUE",
"toilets": 0,
"underRoof": "UNDEFINED_VALUE",
"volume": 0.1,
"wheelchairAccessible": "UNDEFINED_VALUE",
"windows": ["WINDOW_ALUMINIUM"
],
"yearBuilt": 0,
"yearLastRenovation": 0
},
"contacts": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdministration": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeMarketing": "string",
"contactIdAssigneeOwner": "string",
"contactIdViewingAppointment": "string",
"contactIdsCraftsman": ["string"
],
"contactIdsJanitor": ["string"
],
"contactIdsServiceProvider": ["string"
],
"publishAssigneePhone": true
},
"deposit": {"amount": 0.1,
"bankDepotAccepted": true,
"bankDepotIds": ["string"
],
"bankDepotNames": ["string"
],
"bankGuaranteeAccepted": true,
"bankGuaranteeIds": ["string"
],
"bankGuaranteeNames": ["string"
],
"cashPaymentAccepted": true,
"collectiveInsuranceAccepted": true,
"collectiveInsuranceNames": ["string"
],
"cooperativeShareAccepted": true,
"depositInsurance": "UNDEFINED_DEPOSIT_INSURANCE",
"depositNeeded": true,
"insuranceAccepted": true,
"insuranceNames": ["string"
]
},
"description": "string",
"development": "UNDEFINED_DEVELOPMENT",
"documents": [{"documentId": "string",
"isFloorPlan": true,
"isPublic": true
}
],
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"ewid": "string",
"images": [{"mediaId": "string",
"order": 0,
"title": "string"
}
],
"inactiveBy": {"day": 0,
"month": 0,
"year": 0
},
"marketingLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
"name": "string",
"needsMatching": true,
"note": "string",
"number": "string",
"numericId": "string",
"otoId": "string",
"ownerId": "string",
"parking": [{"amount": 0,
"costs": 0.1,
"parkingType": "UNDEFINED_PARKING_TYPE"
}
],
"positions": ["UNDEFINED_LOCATION"
],
"pricing": {"additional": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"commonDistrictRent": 0.1,
"currency": "string",
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heating": 0.1,
"marketGrossRent": 0.1,
"marketHeatingAndAdditional": 0.1,
"marketNetRent": 0.1,
"marketRent": 0.1,
"paymentInterval": "UNDEFINED_PAYMENT_INTERVAL",
"rentM2PerYear": 0.1,
"rentReserves": 0.1,
"sellingPrice": 0.1,
"sellingPriceM2": 0.1,
"targetAdditional": 0.1,
"targetColdRent": 0.1,
"targetHeating": 0.1,
"targetMarketGrossRent": 0.1,
"targetMarketHeatingAndAdditional": 0.1,
"targetMarketNetRent": 0.1,
"underMarketGrossRent": 0.1,
"underMarketHeatingAndAdditional": 0.1,
"underMarketNetRent": 0.1,
"unit": "ON_REQUEST",
"upperMarketGrossRent": 0.1,
"upperMarketHeatingAndAdditional": 0.1,
"upperMarketNetRent": 0.1
},
"publishAddress": true,
"publishCharacteristicsInDescription": true,
"published": true,
"renovations": [{"end": "string",
"start": "string",
"text": "string"
}
],
"sharedUse": "string",
"specialFeatures": "string",
"subCategories": ["UNDEFINED_SUB_CATEGORY"
],
"tags": ["string"
],
"title": "string",
"type": "RENT",
"unusualAgreement": "string",
"utilizations": ["UNDEFINED_UTILIZATION"
],
"valueQuota": 0.1,
"videoUrl": "string",
"videos": [{"mediaId": "string"
}
],
"virtualTourUrl": "string"
}

Response samples

200
default

Content type

application/json

{"object": {"acceptsCreditTrust": true,
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"administrationType": "UNDEFINED_ADMINISTRATION_TYPE",
"assignedSideRooms": "string",
"availability": {"availableFrom": "string",
"availableTo": "string",
"type": "IMMEDIATELY"
},
"awn": "string",
"buildingId": "string",
"category": "UNDEFINED_CATEGORY",
"characteristics": {"additionalRooms": ["ADDITIONAL_ROOM_ATTIC"
],
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"bathrooms": 0,
"ceilingHeight": 0.1,
"commercialFeatures": ["COMMERCIAL_FEATURES_GOODS_LIFT"
],
"condition": "UNDEFINED_CONDITION",
"decimalFloor": 0.1,
"extras": ["EXTRAS_BALCONY"
],
"firstTimeOccupancy": "string",
"flatSharingCommunity": "UNDEFINED_VALUE",
"floor": 0,
"floorLoad": 0.1,
"floorings": ["FLOORING_TILES"
],
"foreignQuota": "UNDEFINED_VALUE",
"furnishing": "UNDEFINED_FURNISHING",
"furnishingType": "UNDEFINED_FURNISHING_TYPE",
"gardenShed": "UNDEFINED_VALUE",
"glazings": ["GLAZING_ACOUSTIC_GLAZING"
],
"grossPremium": 0,
"guestToilets": 0,
"hallHeight": 0.1,
"heatings": ["CENTRAL_HEATING"
],
"kitchens": ["NO_KITCHEN"
],
"locationQualities": ["PARTICULARLY_QUIET"
],
"numberOfFloors": 0.1,
"opted": "UNDEFINED_VALUE",
"petAllowances": ["PETS_ALLOWED"
],
"pets": "UNDEFINED_VALUE",
"photovoltaic": "UNDEFINED_VALUE",
"planned": "UNDEFINED_VALUE",
"rooms": 0.1,
"sanitaries": ["SANITARY_BATHROOM_WITH_WINDOW"
],
"secondaryResidenceAllowed": "UNDEFINED_VALUE",
"separateToilets": 0,
"shellConstruction": "UNDEFINED_VALUE",
"showers": 0,
"smoking": "UNDEFINED_VALUE",
"technologies": ["TECHNOLOGY_ALARM_SYSTEM"
],
"thermalSolarCollector": "UNDEFINED_VALUE",
"toilets": 0,
"underRoof": "UNDEFINED_VALUE",
"volume": 0.1,
"wheelchairAccessible": "UNDEFINED_VALUE",
"windows": ["WINDOW_ALUMINIUM"
],
"yearBuilt": 0,
"yearLastRenovation": 0
},
"condominiumOwnership": true,
"contacts": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdministration": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeMarketing": "string",
"contactIdAssigneeOwner": "string",
"contactIdViewingAppointment": "string",
"contactIdsCraftsman": ["string"
],
"contactIdsJanitor": ["string"
],
"contactIdsServiceProvider": ["string"
],
"publishAssigneePhone": true
},
"debitUntil": {"day": 0,
"month": 0,
"year": 0
},
"defaultAnswer": {"attachmentMediaIds": ["string"
],
"includeApplicationFormLink": true,
"includeViewingAppointmentContact": true,
"mailboxId": "string",
"subject": "string",
"templateId": "string",
"text": "string"
},
"deposit": {"amount": 0.1,
"bankDepotAccepted": true,
"bankDepotIds": ["string"
],
"bankDepotNames": ["string"
],
"bankGuaranteeAccepted": true,
"bankGuaranteeIds": ["string"
],
"bankGuaranteeNames": ["string"
],
"cashPaymentAccepted": true,
"collectiveInsuranceAccepted": true,
"collectiveInsuranceNames": ["string"
],
"cooperativeShareAccepted": true,
"depositInsurance": "UNDEFINED_DEPOSIT_INSURANCE",
"depositNeeded": true,
"insuranceAccepted": true,
"insuranceNames": ["string"
]
},
"description": "string",
"development": "UNDEFINED_DEVELOPMENT",
"documents": [{"documentId": "string",
"isFloorPlan": true,
"isPublic": true
}
],
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"ewid": "string",
"id": "string",
"images": [{"mediaId": "string",
"order": 0,
"title": "string"
}
],
"inactiveBy": {"day": 0,
"month": 0,
"year": 0
},
"marketingLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
"marketingStatus": {"clearFromMarketingAt": "string",
"markedAsSeenAt": "string",
"markedForMarketingAt": "string",
"marketingNote": "string",
"newInMarketing": true,
"publications": [{"published": "string",
"publishedByAccountId": "string",
"publishedByUserId": "string",
"unPublishAtAmountOfRequests": 0,
"unPublished": "string",
"unPublishedByAccountId": "string",
"unPublishedByUserId": "string"
}
],
"setVacantAt": "string",
"specialPublication": {"exclusiveDays": 0,
"exclusiveUntil": "string",
"exclusivity": true,
"platform": "string",
"promotedAt": "string",
"promotedDays": 0,
"promotedUntil": "string",
"promotion": true,
"promotionType": "PROMOTION_TYPE_UNDEFINED"
},
"startMarketingAt": "string",
"vacantAt": "string"
},
"name": "string",
"needsMatching": true,
"note": "string",
"number": "string",
"numericId": "string",
"onboardingFinished": true,
"otoId": "string",
"ownerId": "string",
"parking": [{"amount": 0,
"costs": 0.1,
"parkingType": "UNDEFINED_PARKING_TYPE"
}
],
"positions": ["UNDEFINED_LOCATION"
],
"pricing": {"additional": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"commonDistrictRent": 0.1,
"currency": "string",
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heating": 0.1,
"marketGrossRent": 0.1,
"marketHeatingAndAdditional": 0.1,
"marketNetRent": 0.1,
"marketRent": 0.1,
"paymentInterval": "UNDEFINED_PAYMENT_INTERVAL",
"rentM2PerYear": 0.1,
"rentReserves": 0.1,
"sellingPrice": 0.1,
"sellingPriceM2": 0.1,
"targetAdditional": 0.1,
"targetColdRent": 0.1,
"targetHeating": 0.1,
"targetMarketGrossRent": 0.1,
"targetMarketHeatingAndAdditional": 0.1,
"targetMarketNetRent": 0.1,
"underMarketGrossRent": 0.1,
"underMarketHeatingAndAdditional": 0.1,
"underMarketNetRent": 0.1,
"unit": "ON_REQUEST",
"upperMarketGrossRent": 0.1,
"upperMarketHeatingAndAdditional": 0.1,
"upperMarketNetRent": 0.1
},
"publicId": "string",
"publishAddress": true,
"publishCharacteristicsInDescription": true,
"renovations": [{"end": "string",
"start": "string",
"text": "string"
}
],
"sharedUse": "string",
"specialFeatures": "string",
"subCategories": ["UNDEFINED_SUB_CATEGORY"
],
"tags": ["string"
],
"title": "string",
"type": "RENT",
"unusualAgreement": "string",
"updatedAt": "string",
"utilizations": ["UNDEFINED_UTILIZATION"
],
"valueQuota": 0.1,
"videoUrl": "string",
"videos": [{"mediaId": "string"
}
],
"viewingAppointment": {"contactType": "UNDEFINED_VIEWING_APPOINTMENT_CONTACT_TYPE",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"publishContact": true,
"remark": "string"
},
"virtualTourUrl": "string"
}
}

ObjectService_CreateBulk

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

Payload

Content type

application/json

{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"administrationType": "UNDEFINED_ADMINISTRATION_TYPE",
"amount": 0,
"buildingId": "string",
"category": "UNDEFINED_CATEGORY",
"marketingLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
"ownerId": "string",
"type": "RENT"
}

Response samples

200
default

Content type

application/json

{ }

Read

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{"object": {"acceptsCreditTrust": true,
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"administrationType": "UNDEFINED_ADMINISTRATION_TYPE",
"assignedSideRooms": "string",
"availability": {"availableFrom": "string",
"availableTo": "string",
"type": "IMMEDIATELY"
},
"awn": "string",
"buildingId": "string",
"category": "UNDEFINED_CATEGORY",
"characteristics": {"additionalRooms": ["ADDITIONAL_ROOM_ATTIC"
],
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"bathrooms": 0,
"ceilingHeight": 0.1,
"commercialFeatures": ["COMMERCIAL_FEATURES_GOODS_LIFT"
],
"condition": "UNDEFINED_CONDITION",
"decimalFloor": 0.1,
"extras": ["EXTRAS_BALCONY"
],
"firstTimeOccupancy": "string",
"flatSharingCommunity": "UNDEFINED_VALUE",
"floor": 0,
"floorLoad": 0.1,
"floorings": ["FLOORING_TILES"
],
"foreignQuota": "UNDEFINED_VALUE",
"furnishing": "UNDEFINED_FURNISHING",
"furnishingType": "UNDEFINED_FURNISHING_TYPE",
"gardenShed": "UNDEFINED_VALUE",
"glazings": ["GLAZING_ACOUSTIC_GLAZING"
],
"grossPremium": 0,
"guestToilets": 0,
"hallHeight": 0.1,
"heatings": ["CENTRAL_HEATING"
],
"kitchens": ["NO_KITCHEN"
],
"locationQualities": ["PARTICULARLY_QUIET"
],
"numberOfFloors": 0.1,
"opted": "UNDEFINED_VALUE",
"petAllowances": ["PETS_ALLOWED"
],
"pets": "UNDEFINED_VALUE",
"photovoltaic": "UNDEFINED_VALUE",
"planned": "UNDEFINED_VALUE",
"rooms": 0.1,
"sanitaries": ["SANITARY_BATHROOM_WITH_WINDOW"
],
"secondaryResidenceAllowed": "UNDEFINED_VALUE",
"separateToilets": 0,
"shellConstruction": "UNDEFINED_VALUE",
"showers": 0,
"smoking": "UNDEFINED_VALUE",
"technologies": ["TECHNOLOGY_ALARM_SYSTEM"
],
"thermalSolarCollector": "UNDEFINED_VALUE",
"toilets": 0,
"underRoof": "UNDEFINED_VALUE",
"volume": 0.1,
"wheelchairAccessible": "UNDEFINED_VALUE",
"windows": ["WINDOW_ALUMINIUM"
],
"yearBuilt": 0,
"yearLastRenovation": 0
},
"condominiumOwnership": true,
"contacts": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdministration": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeMarketing": "string",
"contactIdAssigneeOwner": "string",
"contactIdViewingAppointment": "string",
"contactIdsCraftsman": ["string"
],
"contactIdsJanitor": ["string"
],
"contactIdsServiceProvider": ["string"
],
"publishAssigneePhone": true
},
"debitUntil": {"day": 0,
"month": 0,
"year": 0
},
"defaultAnswer": {"attachmentMediaIds": ["string"
],
"includeApplicationFormLink": true,
"includeViewingAppointmentContact": true,
"mailboxId": "string",
"subject": "string",
"templateId": "string",
"text": "string"
},
"deposit": {"amount": 0.1,
"bankDepotAccepted": true,
"bankDepotIds": ["string"
],
"bankDepotNames": ["string"
],
"bankGuaranteeAccepted": true,
"bankGuaranteeIds": ["string"
],
"bankGuaranteeNames": ["string"
],
"cashPaymentAccepted": true,
"collectiveInsuranceAccepted": true,
"collectiveInsuranceNames": ["string"
],
"cooperativeShareAccepted": true,
"depositInsurance": "UNDEFINED_DEPOSIT_INSURANCE",
"depositNeeded": true,
"insuranceAccepted": true,
"insuranceNames": ["string"
]
},
"description": "string",
"development": "UNDEFINED_DEVELOPMENT",
"documents": [{"documentId": "string",
"isFloorPlan": true,
"isPublic": true
}
],
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"ewid": "string",
"id": "string",
"images": [{"mediaId": "string",
"order": 0,
"title": "string"
}
],
"inactiveBy": {"day": 0,
"month": 0,
"year": 0
},
"marketingLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
"marketingStatus": {"clearFromMarketingAt": "string",
"markedAsSeenAt": "string",
"markedForMarketingAt": "string",
"marketingNote": "string",
"newInMarketing": true,
"publications": [{"published": "string",
"publishedByAccountId": "string",
"publishedByUserId": "string",
"unPublishAtAmountOfRequests": 0,
"unPublished": "string",
"unPublishedByAccountId": "string",
"unPublishedByUserId": "string"
}
],
"setVacantAt": "string",
"specialPublication": {"exclusiveDays": 0,
"exclusiveUntil": "string",
"exclusivity": true,
"platform": "string",
"promotedAt": "string",
"promotedDays": 0,
"promotedUntil": "string",
"promotion": true,
"promotionType": "PROMOTION_TYPE_UNDEFINED"
},
"startMarketingAt": "string",
"vacantAt": "string"
},
"name": "string",
"needsMatching": true,
"note": "string",
"number": "string",
"numericId": "string",
"onboardingFinished": true,
"otoId": "string",
"ownerId": "string",
"parking": [{"amount": 0,
"costs": 0.1,
"parkingType": "UNDEFINED_PARKING_TYPE"
}
],
"positions": ["UNDEFINED_LOCATION"
],
"pricing": {"additional": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"commonDistrictRent": 0.1,
"currency": "string",
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heating": 0.1,
"marketGrossRent": 0.1,
"marketHeatingAndAdditional": 0.1,
"marketNetRent": 0.1,
"marketRent": 0.1,
"paymentInterval": "UNDEFINED_PAYMENT_INTERVAL",
"rentM2PerYear": 0.1,
"rentReserves": 0.1,
"sellingPrice": 0.1,
"sellingPriceM2": 0.1,
"targetAdditional": 0.1,
"targetColdRent": 0.1,
"targetHeating": 0.1,
"targetMarketGrossRent": 0.1,
"targetMarketHeatingAndAdditional": 0.1,
"targetMarketNetRent": 0.1,
"underMarketGrossRent": 0.1,
"underMarketHeatingAndAdditional": 0.1,
"underMarketNetRent": 0.1,
"unit": "ON_REQUEST",
"upperMarketGrossRent": 0.1,
"upperMarketHeatingAndAdditional": 0.1,
"upperMarketNetRent": 0.1
},
"publicId": "string",
"publishAddress": true,
"publishCharacteristicsInDescription": true,
"renovations": [{"end": "string",
"start": "string",
"text": "string"
}
],
"sharedUse": "string",
"specialFeatures": "string",
"subCategories": ["UNDEFINED_SUB_CATEGORY"
],
"tags": ["string"
],
"title": "string",
"type": "RENT",
"unusualAgreement": "string",
"updatedAt": "string",
"utilizations": ["UNDEFINED_UTILIZATION"
],
"valueQuota": 0.1,
"videoUrl": "string",
"videos": [{"mediaId": "string"
}
],
"viewingAppointment": {"contactType": "UNDEFINED_VIEWING_APPOINTMENT_CONTACT_TYPE",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"publishContact": true,
"remark": "string"
},
"virtualTourUrl": "string"
}
}

ObjectService_GetAccountingStatistics

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

200
default

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
}

ObjectService_GetAdministrationStatistics

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

200
default

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
}

ObjectService_GetAssetStatistics

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

200
default

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
}

ObjectService_GetByPublicId

path Parameters

publicId

required

string

Responses

Response samples

200
default

Content type

application/json

{"object": {"acceptsCreditTrust": true,
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"administrationType": "UNDEFINED_ADMINISTRATION_TYPE",
"assignedSideRooms": "string",
"availability": {"availableFrom": "string",
"availableTo": "string",
"type": "IMMEDIATELY"
},
"awn": "string",
"buildingId": "string",
"category": "UNDEFINED_CATEGORY",
"characteristics": {"additionalRooms": ["ADDITIONAL_ROOM_ATTIC"
],
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"bathrooms": 0,
"ceilingHeight": 0.1,
"commercialFeatures": ["COMMERCIAL_FEATURES_GOODS_LIFT"
],
"condition": "UNDEFINED_CONDITION",
"decimalFloor": 0.1,
"extras": ["EXTRAS_BALCONY"
],
"firstTimeOccupancy": "string",
"flatSharingCommunity": "UNDEFINED_VALUE",
"floor": 0,
"floorLoad": 0.1,
"floorings": ["FLOORING_TILES"
],
"foreignQuota": "UNDEFINED_VALUE",
"furnishing": "UNDEFINED_FURNISHING",
"furnishingType": "UNDEFINED_FURNISHING_TYPE",
"gardenShed": "UNDEFINED_VALUE",
"glazings": ["GLAZING_ACOUSTIC_GLAZING"
],
"grossPremium": 0,
"guestToilets": 0,
"hallHeight": 0.1,
"heatings": ["CENTRAL_HEATING"
],
"kitchens": ["NO_KITCHEN"
],
"locationQualities": ["PARTICULARLY_QUIET"
],
"numberOfFloors": 0.1,
"opted": "UNDEFINED_VALUE",
"petAllowances": ["PETS_ALLOWED"
],
"pets": "UNDEFINED_VALUE",
"photovoltaic": "UNDEFINED_VALUE",
"planned": "UNDEFINED_VALUE",
"rooms": 0.1,
"sanitaries": ["SANITARY_BATHROOM_WITH_WINDOW"
],
"secondaryResidenceAllowed": "UNDEFINED_VALUE",
"separateToilets": 0,
"shellConstruction": "UNDEFINED_VALUE",
"showers": 0,
"smoking": "UNDEFINED_VALUE",
"technologies": ["TECHNOLOGY_ALARM_SYSTEM"
],
"thermalSolarCollector": "UNDEFINED_VALUE",
"toilets": 0,
"underRoof": "UNDEFINED_VALUE",
"volume": 0.1,
"wheelchairAccessible": "UNDEFINED_VALUE",
"windows": ["WINDOW_ALUMINIUM"
],
"yearBuilt": 0,
"yearLastRenovation": 0
},
"condominiumOwnership": true,
"contacts": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdministration": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeMarketing": "string",
"contactIdAssigneeOwner": "string",
"contactIdViewingAppointment": "string",
"contactIdsCraftsman": ["string"
],
"contactIdsJanitor": ["string"
],
"contactIdsServiceProvider": ["string"
],
"publishAssigneePhone": true
},
"debitUntil": {"day": 0,
"month": 0,
"year": 0
},
"defaultAnswer": {"attachmentMediaIds": ["string"
],
"includeApplicationFormLink": true,
"includeViewingAppointmentContact": true,
"mailboxId": "string",
"subject": "string",
"templateId": "string",
"text": "string"
},
"deposit": {"amount": 0.1,
"bankDepotAccepted": true,
"bankDepotIds": ["string"
],
"bankDepotNames": ["string"
],
"bankGuaranteeAccepted": true,
"bankGuaranteeIds": ["string"
],
"bankGuaranteeNames": ["string"
],
"cashPaymentAccepted": true,
"collectiveInsuranceAccepted": true,
"collectiveInsuranceNames": ["string"
],
"cooperativeShareAccepted": true,
"depositInsurance": "UNDEFINED_DEPOSIT_INSURANCE",
"depositNeeded": true,
"insuranceAccepted": true,
"insuranceNames": ["string"
]
},
"description": "string",
"development": "UNDEFINED_DEVELOPMENT",
"documents": [{"documentId": "string",
"isFloorPlan": true,
"isPublic": true
}
],
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"ewid": "string",
"id": "string",
"images": [{"mediaId": "string",
"order": 0,
"title": "string"
}
],
"inactiveBy": {"day": 0,
"month": 0,
"year": 0
},
"marketingLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
"marketingStatus": {"clearFromMarketingAt": "string",
"markedAsSeenAt": "string",
"markedForMarketingAt": "string",
"marketingNote": "string",
"newInMarketing": true,
"publications": [{"published": "string",
"publishedByAccountId": "string",
"publishedByUserId": "string",
"unPublishAtAmountOfRequests": 0,
"unPublished": "string",
"unPublishedByAccountId": "string",
"unPublishedByUserId": "string"
}
],
"setVacantAt": "string",
"specialPublication": {"exclusiveDays": 0,
"exclusiveUntil": "string",
"exclusivity": true,
"platform": "string",
"promotedAt": "string",
"promotedDays": 0,
"promotedUntil": "string",
"promotion": true,
"promotionType": "PROMOTION_TYPE_UNDEFINED"
},
"startMarketingAt": "string",
"vacantAt": "string"
},
"name": "string",
"needsMatching": true,
"note": "string",
"number": "string",
"numericId": "string",
"onboardingFinished": true,
"otoId": "string",
"ownerId": "string",
"parking": [{"amount": 0,
"costs": 0.1,
"parkingType": "UNDEFINED_PARKING_TYPE"
}
],
"positions": ["UNDEFINED_LOCATION"
],
"pricing": {"additional": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"commonDistrictRent": 0.1,
"currency": "string",
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heating": 0.1,
"marketGrossRent": 0.1,
"marketHeatingAndAdditional": 0.1,
"marketNetRent": 0.1,
"marketRent": 0.1,
"paymentInterval": "UNDEFINED_PAYMENT_INTERVAL",
"rentM2PerYear": 0.1,
"rentReserves": 0.1,
"sellingPrice": 0.1,
"sellingPriceM2": 0.1,
"targetAdditional": 0.1,
"targetColdRent": 0.1,
"targetHeating": 0.1,
"targetMarketGrossRent": 0.1,
"targetMarketHeatingAndAdditional": 0.1,
"targetMarketNetRent": 0.1,
"underMarketGrossRent": 0.1,
"underMarketHeatingAndAdditional": 0.1,
"underMarketNetRent": 0.1,
"unit": "ON_REQUEST",
"upperMarketGrossRent": 0.1,
"upperMarketHeatingAndAdditional": 0.1,
"upperMarketNetRent": 0.1
},
"publicId": "string",
"publishAddress": true,
"publishCharacteristicsInDescription": true,
"renovations": [{"end": "string",
"start": "string",
"text": "string"
}
],
"sharedUse": "string",
"specialFeatures": "string",
"subCategories": ["UNDEFINED_SUB_CATEGORY"
],
"tags": ["string"
],
"title": "string",
"type": "RENT",
"unusualAgreement": "string",
"updatedAt": "string",
"utilizations": ["UNDEFINED_UTILIZATION"
],
"valueQuota": 0.1,
"videoUrl": "string",
"videos": [{"mediaId": "string"
}
],
"viewingAppointment": {"contactType": "UNDEFINED_VIEWING_APPOINTMENT_CONTACT_TYPE",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"publishContact": true,
"remark": "string"
},
"virtualTourUrl": "string"
}
}

Marketing

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{"acceptsCreditTrust": true,
"additional": 0.1,
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"availability": {"availableFrom": "string",
"availableTo": "string",
"type": "IMMEDIATELY"
},
"category": "UNDEFINED_CATEGORY",
"coldRent": 0.1,
"currency": "string",
"decimalFloor": 0.1,
"deposit": {"amount": 0.1,
"bankDepotAccepted": true,
"bankDepotIds": ["string"
],
"bankDepotNames": ["string"
],
"bankGuaranteeAccepted": true,
"bankGuaranteeIds": ["string"
],
"bankGuaranteeNames": ["string"
],
"cashPaymentAccepted": true,
"collectiveInsuranceAccepted": true,
"collectiveInsuranceNames": ["string"
],
"cooperativeShareAccepted": true,
"depositInsurance": "UNDEFINED_DEPOSIT_INSURANCE",
"depositNeeded": true,
"insuranceAccepted": true,
"insuranceNames": ["string"
]
},
"description": "string",
"effectiveArea": 0.1,
"floor": 0,
"heating": 0.1,
"id": "string",
"images": [{"mediaId": "string",
"order": 0,
"title": "string"
}
],
"livingArea": 0.1,
"marketingAccountId": "string",
"marketingAssignee": {"email": "string",
"name": "string",
"phone": "string"
},
"marketingLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
"ownerId": "string",
"parking": [{"amount": 0,
"costs": 0.1,
"parkingType": "UNDEFINED_PARKING_TYPE"
}
],
"publicId": "string",
"publishAddress": true,
"rooms": 0.1,
"subCategories": ["UNDEFINED_SUB_CATEGORY"
],
"title": "string",
"unit": "ON_REQUEST"
}

ObjectService_GetMarketingStatistics

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

200
default

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
}

ObjectService_GetObjectTypes

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"hasCondominiumObjects": true,
"hasRentalObjects": true
}

Statistics

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

200
default

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
}

ObjectService_GetTotalValueQuotaForBuilding

path Parameters

buildingId

required

string

Responses

Response samples

200
default

Content type

application/json

{"totalValueQuota": 0.1
}

ObjectService_GetUsedTags

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"tags": ["string"
]
}

ObjectService_IsActive

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{"active": true
}

ObjectService_IsOnePublished

Request Body schema: application/json
required

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{"published": true
}

ObjectService_List

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

200
default

Content type

application/json

{"objects": [{"acceptsCreditTrust": true,
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"administrationType": "UNDEFINED_ADMINISTRATION_TYPE",
"assignedSideRooms": "string",
"availability": {"availableFrom": "string",
"availableTo": "string",
"type": "IMMEDIATELY"
},
"awn": "string",
"buildingId": "string",
"category": "UNDEFINED_CATEGORY",
"characteristics": {"additionalRooms": ["ADDITIONAL_ROOM_ATTIC"
],
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"bathrooms": 0,
"ceilingHeight": 0.1,
"commercialFeatures": ["COMMERCIAL_FEATURES_GOODS_LIFT"
],
"condition": "UNDEFINED_CONDITION",
"decimalFloor": 0.1,
"extras": ["EXTRAS_BALCONY"
],
"firstTimeOccupancy": "string",
"flatSharingCommunity": "UNDEFINED_VALUE",
"floor": 0,
"floorLoad": 0.1,
"floorings": ["FLOORING_TILES"
],
"foreignQuota": "UNDEFINED_VALUE",
"furnishing": "UNDEFINED_FURNISHING",
"furnishingType": "UNDEFINED_FURNISHING_TYPE",
"gardenShed": "UNDEFINED_VALUE",
"glazings": ["GLAZING_ACOUSTIC_GLAZING"
],
"grossPremium": 0,
"guestToilets": 0,
"hallHeight": 0.1,
"heatings": ["CENTRAL_HEATING"
],
"kitchens": ["NO_KITCHEN"
],
"locationQualities": ["PARTICULARLY_QUIET"
],
"numberOfFloors": 0.1,
"opted": "UNDEFINED_VALUE",
"petAllowances": ["PETS_ALLOWED"
],
"pets": "UNDEFINED_VALUE",
"photovoltaic": "UNDEFINED_VALUE",
"planned": "UNDEFINED_VALUE",
"rooms": 0.1,
"sanitaries": ["SANITARY_BATHROOM_WITH_WINDOW"
],
"secondaryResidenceAllowed": "UNDEFINED_VALUE",
"separateToilets": 0,
"shellConstruction": "UNDEFINED_VALUE",
"showers": 0,
"smoking": "UNDEFINED_VALUE",
"technologies": ["TECHNOLOGY_ALARM_SYSTEM"
],
"thermalSolarCollector": "UNDEFINED_VALUE",
"toilets": 0,
"underRoof": "UNDEFINED_VALUE",
"volume": 0.1,
"wheelchairAccessible": "UNDEFINED_VALUE",
"windows": ["WINDOW_ALUMINIUM"
],
"yearBuilt": 0,
"yearLastRenovation": 0
},
"condominiumOwnership": true,
"contacts": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdministration": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeMarketing": "string",
"contactIdAssigneeOwner": "string",
"contactIdViewingAppointment": "string",
"contactIdsCraftsman": ["string"
],
"contactIdsJanitor": ["string"
],
"contactIdsServiceProvider": ["string"
],
"publishAssigneePhone": true
},
"debitUntil": {"day": 0,
"month": 0,
"year": 0
},
"defaultAnswer": {"attachmentMediaIds": ["string"
],
"includeApplicationFormLink": true,
"includeViewingAppointmentContact": true,
"mailboxId": "string",
"subject": "string",
"templateId": "string",
"text": "string"
},
"deposit": {"amount": 0.1,
"bankDepotAccepted": true,
"bankDepotIds": ["string"
],
"bankDepotNames": ["string"
],
"bankGuaranteeAccepted": true,
"bankGuaranteeIds": ["string"
],
"bankGuaranteeNames": ["string"
],
"cashPaymentAccepted": true,
"collectiveInsuranceAccepted": true,
"collectiveInsuranceNames": ["string"
],
"cooperativeShareAccepted": true,
"depositInsurance": "UNDEFINED_DEPOSIT_INSURANCE",
"depositNeeded": true,
"insuranceAccepted": true,
"insuranceNames": ["string"
]
},
"description": "string",
"development": "UNDEFINED_DEVELOPMENT",
"documents": [{"documentId": "string",
"isFloorPlan": true,
"isPublic": true
}
],
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"ewid": "string",
"id": "string",
"images": [{"mediaId": "string",
"order": 0,
"title": "string"
}
],
"inactiveBy": {"day": 0,
"month": 0,
"year": 0
},
"marketingLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
"marketingStatus": {"clearFromMarketingAt": "string",
"markedAsSeenAt": "string",
"markedForMarketingAt": "string",
"marketingNote": "string",
"newInMarketing": true,
"publications": [{"published": "string",
"publishedByAccountId": "string",
"publishedByUserId": "string",
"unPublishAtAmountOfRequests": 0,
"unPublished": "string",
"unPublishedByAccountId": "string",
"unPublishedByUserId": "string"
}
],
"setVacantAt": "string",
"specialPublication": {"exclusiveDays": 0,
"exclusiveUntil": "string",
"exclusivity": true,
"platform": "string",
"promotedAt": "string",
"promotedDays": 0,
"promotedUntil": "string",
"promotion": true,
"promotionType": "PROMOTION_TYPE_UNDEFINED"
},
"startMarketingAt": "string",
"vacantAt": "string"
},
"name": "string",
"needsMatching": true,
"note": "string",
"number": "string",
"numericId": "string",
"onboardingFinished": true,
"otoId": "string",
"ownerId": "string",
"parking": [{"amount": 0,
"costs": 0.1,
"parkingType": "UNDEFINED_PARKING_TYPE"
}
],
"positions": ["UNDEFINED_LOCATION"
],
"pricing": {"additional": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"commonDistrictRent": 0.1,
"currency": "string",
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heating": 0.1,
"marketGrossRent": 0.1,
"marketHeatingAndAdditional": 0.1,
"marketNetRent": 0.1,
"marketRent": 0.1,
"paymentInterval": "UNDEFINED_PAYMENT_INTERVAL",
"rentM2PerYear": 0.1,
"rentReserves": 0.1,
"sellingPrice": 0.1,
"sellingPriceM2": 0.1,
"targetAdditional": 0.1,
"targetColdRent": 0.1,
"targetHeating": 0.1,
"targetMarketGrossRent": 0.1,
"targetMarketHeatingAndAdditional": 0.1,
"targetMarketNetRent": 0.1,
"underMarketGrossRent": 0.1,
"underMarketHeatingAndAdditional": 0.1,
"underMarketNetRent": 0.1,
"unit": "ON_REQUEST",
"upperMarketGrossRent": 0.1,
"upperMarketHeatingAndAdditional": 0.1,
"upperMarketNetRent": 0.1
},
"publicId": "string",
"publishAddress": true,
"publishCharacteristicsInDescription": true,
"renovations": [{"end": "string",
"start": "string",
"text": "string"
}
],
"sharedUse": "string",
"specialFeatures": "string",
"subCategories": ["UNDEFINED_SUB_CATEGORY"
],
"tags": ["string"
],
"title": "string",
"type": "RENT",
"unusualAgreement": "string",
"updatedAt": "string",
"utilizations": ["UNDEFINED_UTILIZATION"
],
"valueQuota": 0.1,
"videoUrl": "string",
"videos": [{"mediaId": "string"
}
],
"viewingAppointment": {"contactType": "UNDEFINED_VIEWING_APPOINTMENT_CONTACT_TYPE",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"publishContact": true,
"remark": "string"
},
"virtualTourUrl": "string"
}
],
"totalObjectCount": 0,
"totalPageCount": 0
}

ObjectService_ListByBuildingIds

Request Body schema: application/json
required

buildingIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"buildingIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"objects": [{"acceptsCreditTrust": true,
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"administrationType": "UNDEFINED_ADMINISTRATION_TYPE",
"assignedSideRooms": "string",
"availability": {"availableFrom": "string",
"availableTo": "string",
"type": "IMMEDIATELY"
},
"awn": "string",
"buildingId": "string",
"category": "UNDEFINED_CATEGORY",
"characteristics": {"additionalRooms": ["ADDITIONAL_ROOM_ATTIC"
],
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"bathrooms": 0,
"ceilingHeight": 0.1,
"commercialFeatures": ["COMMERCIAL_FEATURES_GOODS_LIFT"
],
"condition": "UNDEFINED_CONDITION",
"decimalFloor": 0.1,
"extras": ["EXTRAS_BALCONY"
],
"firstTimeOccupancy": "string",
"flatSharingCommunity": "UNDEFINED_VALUE",
"floor": 0,
"floorLoad": 0.1,
"floorings": ["FLOORING_TILES"
],
"foreignQuota": "UNDEFINED_VALUE",
"furnishing": "UNDEFINED_FURNISHING",
"furnishingType": "UNDEFINED_FURNISHING_TYPE",
"gardenShed": "UNDEFINED_VALUE",
"glazings": ["GLAZING_ACOUSTIC_GLAZING"
],
"grossPremium": 0,
"guestToilets": 0,
"hallHeight": 0.1,
"heatings": ["CENTRAL_HEATING"
],
"kitchens": ["NO_KITCHEN"
],
"locationQualities": ["PARTICULARLY_QUIET"
],
"numberOfFloors": 0.1,
"opted": "UNDEFINED_VALUE",
"petAllowances": ["PETS_ALLOWED"
],
"pets": "UNDEFINED_VALUE",
"photovoltaic": "UNDEFINED_VALUE",
"planned": "UNDEFINED_VALUE",
"rooms": 0.1,
"sanitaries": ["SANITARY_BATHROOM_WITH_WINDOW"
],
"secondaryResidenceAllowed": "UNDEFINED_VALUE",
"separateToilets": 0,
"shellConstruction": "UNDEFINED_VALUE",
"showers": 0,
"smoking": "UNDEFINED_VALUE",
"technologies": ["TECHNOLOGY_ALARM_SYSTEM"
],
"thermalSolarCollector": "UNDEFINED_VALUE",
"toilets": 0,
"underRoof": "UNDEFINED_VALUE",
"volume": 0.1,
"wheelchairAccessible": "UNDEFINED_VALUE",
"windows": ["WINDOW_ALUMINIUM"
],
"yearBuilt": 0,
"yearLastRenovation": 0
},
"condominiumOwnership": true,
"contacts": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdministration": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeMarketing": "string",
"contactIdAssigneeOwner": "string",
"contactIdViewingAppointment": "string",
"contactIdsCraftsman": ["string"
],
"contactIdsJanitor": ["string"
],
"contactIdsServiceProvider": ["string"
],
"publishAssigneePhone": true
},
"debitUntil": {"day": 0,
"month": 0,
"year": 0
},
"defaultAnswer": {"attachmentMediaIds": ["string"
],
"includeApplicationFormLink": true,
"includeViewingAppointmentContact": true,
"mailboxId": "string",
"subject": "string",
"templateId": "string",
"text": "string"
},
"deposit": {"amount": 0.1,
"bankDepotAccepted": true,
"bankDepotIds": ["string"
],
"bankDepotNames": ["string"
],
"bankGuaranteeAccepted": true,
"bankGuaranteeIds": ["string"
],
"bankGuaranteeNames": ["string"
],
"cashPaymentAccepted": true,
"collectiveInsuranceAccepted": true,
"collectiveInsuranceNames": ["string"
],
"cooperativeShareAccepted": true,
"depositInsurance": "UNDEFINED_DEPOSIT_INSURANCE",
"depositNeeded": true,
"insuranceAccepted": true,
"insuranceNames": ["string"
]
},
"description": "string",
"development": "UNDEFINED_DEVELOPMENT",
"documents": [{"documentId": "string",
"isFloorPlan": true,
"isPublic": true
}
],
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"ewid": "string",
"id": "string",
"images": [{"mediaId": "string",
"order": 0,
"title": "string"
}
],
"inactiveBy": {"day": 0,
"month": 0,
"year": 0
},
"marketingLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
"marketingStatus": {"clearFromMarketingAt": "string",
"markedAsSeenAt": "string",
"markedForMarketingAt": "string",
"marketingNote": "string",
"newInMarketing": true,
"publications": [{"published": "string",
"publishedByAccountId": "string",
"publishedByUserId": "string",
"unPublishAtAmountOfRequests": 0,
"unPublished": "string",
"unPublishedByAccountId": "string",
"unPublishedByUserId": "string"
}
],
"setVacantAt": "string",
"specialPublication": {"exclusiveDays": 0,
"exclusiveUntil": "string",
"exclusivity": true,
"platform": "string",
"promotedAt": "string",
"promotedDays": 0,
"promotedUntil": "string",
"promotion": true,
"promotionType": "PROMOTION_TYPE_UNDEFINED"
},
"startMarketingAt": "string",
"vacantAt": "string"
},
"name": "string",
"needsMatching": true,
"note": "string",
"number": "string",
"numericId": "string",
"onboardingFinished": true,
"otoId": "string",
"ownerId": "string",
"parking": [{"amount": 0,
"costs": 0.1,
"parkingType": "UNDEFINED_PARKING_TYPE"
}
],
"positions": ["UNDEFINED_LOCATION"
],
"pricing": {"additional": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"commonDistrictRent": 0.1,
"currency": "string",
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heating": 0.1,
"marketGrossRent": 0.1,
"marketHeatingAndAdditional": 0.1,
"marketNetRent": 0.1,
"marketRent": 0.1,
"paymentInterval": "UNDEFINED_PAYMENT_INTERVAL",
"rentM2PerYear": 0.1,
"rentReserves": 0.1,
"sellingPrice": 0.1,
"sellingPriceM2": 0.1,
"targetAdditional": 0.1,
"targetColdRent": 0.1,
"targetHeating": 0.1,
"targetMarketGrossRent": 0.1,
"targetMarketHeatingAndAdditional": 0.1,
"targetMarketNetRent": 0.1,
"underMarketGrossRent": 0.1,
"underMarketHeatingAndAdditional": 0.1,
"underMarketNetRent": 0.1,
"unit": "ON_REQUEST",
"upperMarketGrossRent": 0.1,
"upperMarketHeatingAndAdditional": 0.1,
"upperMarketNetRent": 0.1
},
"publicId": "string",
"publishAddress": true,
"publishCharacteristicsInDescription": true,
"renovations": [{"end": "string",
"start": "string",
"text": "string"
}
],
"sharedUse": "string",
"specialFeatures": "string",
"subCategories": ["UNDEFINED_SUB_CATEGORY"
],
"tags": ["string"
],
"title": "string",
"type": "RENT",
"unusualAgreement": "string",
"updatedAt": "string",
"utilizations": ["UNDEFINED_UTILIZATION"
],
"valueQuota": 0.1,
"videoUrl": "string",
"videos": [{"mediaId": "string"
}
],
"viewingAppointment": {"contactType": "UNDEFINED_VIEWING_APPOINTMENT_CONTACT_TYPE",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"publishContact": true,
"remark": "string"
},
"virtualTourUrl": "string"
}
]
}

ObjectService_ListByIds

Request Body schema: application/json
required

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{"objects": [{"acceptsCreditTrust": true,
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"administrationType": "UNDEFINED_ADMINISTRATION_TYPE",
"assignedSideRooms": "string",
"availability": {"availableFrom": "string",
"availableTo": "string",
"type": "IMMEDIATELY"
},
"awn": "string",
"buildingId": "string",
"category": "UNDEFINED_CATEGORY",
"characteristics": {"additionalRooms": ["ADDITIONAL_ROOM_ATTIC"
],
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"bathrooms": 0,
"ceilingHeight": 0.1,
"commercialFeatures": ["COMMERCIAL_FEATURES_GOODS_LIFT"
],
"condition": "UNDEFINED_CONDITION",
"decimalFloor": 0.1,
"extras": ["EXTRAS_BALCONY"
],
"firstTimeOccupancy": "string",
"flatSharingCommunity": "UNDEFINED_VALUE",
"floor": 0,
"floorLoad": 0.1,
"floorings": ["FLOORING_TILES"
],
"foreignQuota": "UNDEFINED_VALUE",
"furnishing": "UNDEFINED_FURNISHING",
"furnishingType": "UNDEFINED_FURNISHING_TYPE",
"gardenShed": "UNDEFINED_VALUE",
"glazings": ["GLAZING_ACOUSTIC_GLAZING"
],
"grossPremium": 0,
"guestToilets": 0,
"hallHeight": 0.1,
"heatings": ["CENTRAL_HEATING"
],
"kitchens": ["NO_KITCHEN"
],
"locationQualities": ["PARTICULARLY_QUIET"
],
"numberOfFloors": 0.1,
"opted": "UNDEFINED_VALUE",
"petAllowances": ["PETS_ALLOWED"
],
"pets": "UNDEFINED_VALUE",
"photovoltaic": "UNDEFINED_VALUE",
"planned": "UNDEFINED_VALUE",
"rooms": 0.1,
"sanitaries": ["SANITARY_BATHROOM_WITH_WINDOW"
],
"secondaryResidenceAllowed": "UNDEFINED_VALUE",
"separateToilets": 0,
"shellConstruction": "UNDEFINED_VALUE",
"showers": 0,
"smoking": "UNDEFINED_VALUE",
"technologies": ["TECHNOLOGY_ALARM_SYSTEM"
],
"thermalSolarCollector": "UNDEFINED_VALUE",
"toilets": 0,
"underRoof": "UNDEFINED_VALUE",
"volume": 0.1,
"wheelchairAccessible": "UNDEFINED_VALUE",
"windows": ["WINDOW_ALUMINIUM"
],
"yearBuilt": 0,
"yearLastRenovation": 0
},
"condominiumOwnership": true,
"contacts": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdministration": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeMarketing": "string",
"contactIdAssigneeOwner": "string",
"contactIdViewingAppointment": "string",
"contactIdsCraftsman": ["string"
],
"contactIdsJanitor": ["string"
],
"contactIdsServiceProvider": ["string"
],
"publishAssigneePhone": true
},
"debitUntil": {"day": 0,
"month": 0,
"year": 0
},
"defaultAnswer": {"attachmentMediaIds": ["string"
],
"includeApplicationFormLink": true,
"includeViewingAppointmentContact": true,
"mailboxId": "string",
"subject": "string",
"templateId": "string",
"text": "string"
},
"deposit": {"amount": 0.1,
"bankDepotAccepted": true,
"bankDepotIds": ["string"
],
"bankDepotNames": ["string"
],
"bankGuaranteeAccepted": true,
"bankGuaranteeIds": ["string"
],
"bankGuaranteeNames": ["string"
],
"cashPaymentAccepted": true,
"collectiveInsuranceAccepted": true,
"collectiveInsuranceNames": ["string"
],
"cooperativeShareAccepted": true,
"depositInsurance": "UNDEFINED_DEPOSIT_INSURANCE",
"depositNeeded": true,
"insuranceAccepted": true,
"insuranceNames": ["string"
]
},
"description": "string",
"development": "UNDEFINED_DEVELOPMENT",
"documents": [{"documentId": "string",
"isFloorPlan": true,
"isPublic": true
}
],
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"ewid": "string",
"id": "string",
"images": [{"mediaId": "string",
"order": 0,
"title": "string"
}
],
"inactiveBy": {"day": 0,
"month": 0,
"year": 0
},
"marketingLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
"marketingStatus": {"clearFromMarketingAt": "string",
"markedAsSeenAt": "string",
"markedForMarketingAt": "string",
"marketingNote": "string",
"newInMarketing": true,
"publications": [{"published": "string",
"publishedByAccountId": "string",
"publishedByUserId": "string",
"unPublishAtAmountOfRequests": 0,
"unPublished": "string",
"unPublishedByAccountId": "string",
"unPublishedByUserId": "string"
}
],
"setVacantAt": "string",
"specialPublication": {"exclusiveDays": 0,
"exclusiveUntil": "string",
"exclusivity": true,
"platform": "string",
"promotedAt": "string",
"promotedDays": 0,
"promotedUntil": "string",
"promotion": true,
"promotionType": "PROMOTION_TYPE_UNDEFINED"
},
"startMarketingAt": "string",
"vacantAt": "string"
},
"name": "string",
"needsMatching": true,
"note": "string",
"number": "string",
"numericId": "string",
"onboardingFinished": true,
"otoId": "string",
"ownerId": "string",
"parking": [{"amount": 0,
"costs": 0.1,
"parkingType": "UNDEFINED_PARKING_TYPE"
}
],
"positions": ["UNDEFINED_LOCATION"
],
"pricing": {"additional": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"commonDistrictRent": 0.1,
"currency": "string",
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heating": 0.1,
"marketGrossRent": 0.1,
"marketHeatingAndAdditional": 0.1,
"marketNetRent": 0.1,
"marketRent": 0.1,
"paymentInterval": "UNDEFINED_PAYMENT_INTERVAL",
"rentM2PerYear": 0.1,
"rentReserves": 0.1,
"sellingPrice": 0.1,
"sellingPriceM2": 0.1,
"targetAdditional": 0.1,
"targetColdRent": 0.1,
"targetHeating": 0.1,
"targetMarketGrossRent": 0.1,
"targetMarketHeatingAndAdditional": 0.1,
"targetMarketNetRent": 0.1,
"underMarketGrossRent": 0.1,
"underMarketHeatingAndAdditional": 0.1,
"underMarketNetRent": 0.1,
"unit": "ON_REQUEST",
"upperMarketGrossRent": 0.1,
"upperMarketHeatingAndAdditional": 0.1,
"upperMarketNetRent": 0.1
},
"publicId": "string",
"publishAddress": true,
"publishCharacteristicsInDescription": true,
"renovations": [{"end": "string",
"start": "string",
"text": "string"
}
],
"sharedUse": "string",
"specialFeatures": "string",
"subCategories": ["UNDEFINED_SUB_CATEGORY"
],
"tags": ["string"
],
"title": "string",
"type": "RENT",
"unusualAgreement": "string",
"updatedAt": "string",
"utilizations": ["UNDEFINED_UTILIZATION"
],
"valueQuota": 0.1,
"videoUrl": "string",
"videos": [{"mediaId": "string"
}
],
"viewingAppointment": {"contactType": "UNDEFINED_VIEWING_APPOINTMENT_CONTACT_TYPE",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"publishContact": true,
"remark": "string"
},
"virtualTourUrl": "string"
}
]
}

ObjectService_ListFilterOptions

Responses

Response samples

200
default

Content type

application/json

{"options": [{"id": "string",
"name": "string",
"ownerId": "string"
}
]
}

ObjectService_ListFreeByDate

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

Payload

Content type

application/json

{"buildingIds": ["string"
],
"date": {"day": 0,
"month": 0,
"year": 0
}
}

Response samples

200
default

Content type

application/json

{"objects": [{"acceptsCreditTrust": true,
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"administrationType": "UNDEFINED_ADMINISTRATION_TYPE",
"assignedSideRooms": "string",
"availability": {"availableFrom": "string",
"availableTo": "string",
"type": "IMMEDIATELY"
},
"awn": "string",
"buildingId": "string",
"category": "UNDEFINED_CATEGORY",
"characteristics": {"additionalRooms": ["ADDITIONAL_ROOM_ATTIC"
],
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"bathrooms": 0,
"ceilingHeight": 0.1,
"commercialFeatures": ["COMMERCIAL_FEATURES_GOODS_LIFT"
],
"condition": "UNDEFINED_CONDITION",
"decimalFloor": 0.1,
"extras": ["EXTRAS_BALCONY"
],
"firstTimeOccupancy": "string",
"flatSharingCommunity": "UNDEFINED_VALUE",
"floor": 0,
"floorLoad": 0.1,
"floorings": ["FLOORING_TILES"
],
"foreignQuota": "UNDEFINED_VALUE",
"furnishing": "UNDEFINED_FURNISHING",
"furnishingType": "UNDEFINED_FURNISHING_TYPE",
"gardenShed": "UNDEFINED_VALUE",
"glazings": ["GLAZING_ACOUSTIC_GLAZING"
],
"grossPremium": 0,
"guestToilets": 0,
"hallHeight": 0.1,
"heatings": ["CENTRAL_HEATING"
],
"kitchens": ["NO_KITCHEN"
],
"locationQualities": ["PARTICULARLY_QUIET"
],
"numberOfFloors": 0.1,
"opted": "UNDEFINED_VALUE",
"petAllowances": ["PETS_ALLOWED"
],
"pets": "UNDEFINED_VALUE",
"photovoltaic": "UNDEFINED_VALUE",
"planned": "UNDEFINED_VALUE",
"rooms": 0.1,
"sanitaries": ["SANITARY_BATHROOM_WITH_WINDOW"
],
"secondaryResidenceAllowed": "UNDEFINED_VALUE",
"separateToilets": 0,
"shellConstruction": "UNDEFINED_VALUE",
"showers": 0,
"smoking": "UNDEFINED_VALUE",
"technologies": ["TECHNOLOGY_ALARM_SYSTEM"
],
"thermalSolarCollector": "UNDEFINED_VALUE",
"toilets": 0,
"underRoof": "UNDEFINED_VALUE",
"volume": 0.1,
"wheelchairAccessible": "UNDEFINED_VALUE",
"windows": ["WINDOW_ALUMINIUM"
],
"yearBuilt": 0,
"yearLastRenovation": 0
},
"condominiumOwnership": true,
"contacts": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdministration": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeMarketing": "string",
"contactIdAssigneeOwner": "string",
"contactIdViewingAppointment": "string",
"contactIdsCraftsman": ["string"
],
"contactIdsJanitor": ["string"
],
"contactIdsServiceProvider": ["string"
],
"publishAssigneePhone": true
},
"debitUntil": {"day": 0,
"month": 0,
"year": 0
},
"defaultAnswer": {"attachmentMediaIds": ["string"
],
"includeApplicationFormLink": true,
"includeViewingAppointmentContact": true,
"mailboxId": "string",
"subject": "string",
"templateId": "string",
"text": "string"
},
"deposit": {"amount": 0.1,
"bankDepotAccepted": true,
"bankDepotIds": ["string"
],
"bankDepotNames": ["string"
],
"bankGuaranteeAccepted": true,
"bankGuaranteeIds": ["string"
],
"bankGuaranteeNames": ["string"
],
"cashPaymentAccepted": true,
"collectiveInsuranceAccepted": true,
"collectiveInsuranceNames": ["string"
],
"cooperativeShareAccepted": true,
"depositInsurance": "UNDEFINED_DEPOSIT_INSURANCE",
"depositNeeded": true,
"insuranceAccepted": true,
"insuranceNames": ["string"
]
},
"description": "string",
"development": "UNDEFINED_DEVELOPMENT",
"documents": [{"documentId": "string",
"isFloorPlan": true,
"isPublic": true
}
],
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"ewid": "string",
"id": "string",
"images": [{"mediaId": "string",
"order": 0,
"title": "string"
}
],
"inactiveBy": {"day": 0,
"month": 0,
"year": 0
},
"marketingLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
"marketingStatus": {"clearFromMarketingAt": "string",
"markedAsSeenAt": "string",
"markedForMarketingAt": "string",
"marketingNote": "string",
"newInMarketing": true,
"publications": [{"published": "string",
"publishedByAccountId": "string",
"publishedByUserId": "string",
"unPublishAtAmountOfRequests": 0,
"unPublished": "string",
"unPublishedByAccountId": "string",
"unPublishedByUserId": "string"
}
],
"setVacantAt": "string",
"specialPublication": {"exclusiveDays": 0,
"exclusiveUntil": "string",
"exclusivity": true,
"platform": "string",
"promotedAt": "string",
"promotedDays": 0,
"promotedUntil": "string",
"promotion": true,
"promotionType": "PROMOTION_TYPE_UNDEFINED"
},
"startMarketingAt": "string",
"vacantAt": "string"
},
"name": "string",
"needsMatching": true,
"note": "string",
"number": "string",
"numericId": "string",
"onboardingFinished": true,
"otoId": "string",
"ownerId": "string",
"parking": [{"amount": 0,
"costs": 0.1,
"parkingType": "UNDEFINED_PARKING_TYPE"
}
],
"positions": ["UNDEFINED_LOCATION"
],
"pricing": {"additional": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"commonDistrictRent": 0.1,
"currency": "string",
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heating": 0.1,
"marketGrossRent": 0.1,
"marketHeatingAndAdditional": 0.1,
"marketNetRent": 0.1,
"marketRent": 0.1,
"paymentInterval": "UNDEFINED_PAYMENT_INTERVAL",
"rentM2PerYear": 0.1,
"rentReserves": 0.1,
"sellingPrice": 0.1,
"sellingPriceM2": 0.1,
"targetAdditional": 0.1,
"targetColdRent": 0.1,
"targetHeating": 0.1,
"targetMarketGrossRent": 0.1,
"targetMarketHeatingAndAdditional": 0.1,
"targetMarketNetRent": 0.1,
"underMarketGrossRent": 0.1,
"underMarketHeatingAndAdditional": 0.1,
"underMarketNetRent": 0.1,
"unit": "ON_REQUEST",
"upperMarketGrossRent": 0.1,
"upperMarketHeatingAndAdditional": 0.1,
"upperMarketNetRent": 0.1
},
"publicId": "string",
"publishAddress": true,
"publishCharacteristicsInDescription": true,
"renovations": [{"end": "string",
"start": "string",
"text": "string"
}
],
"sharedUse": "string",
"specialFeatures": "string",
"subCategories": ["UNDEFINED_SUB_CATEGORY"
],
"tags": ["string"
],
"title": "string",
"type": "RENT",
"unusualAgreement": "string",
"updatedAt": "string",
"utilizations": ["UNDEFINED_UTILIZATION"
],
"valueQuota": 0.1,
"videoUrl": "string",
"videos": [{"mediaId": "string"
}
],
"viewingAppointment": {"contactType": "UNDEFINED_VIEWING_APPOINTMENT_CONTACT_TYPE",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"publishContact": true,
"remark": "string"
},
"virtualTourUrl": "string"
}
]
}

ObjectService_ListIdsInMarketing

path Parameters

marketerAccountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"ids": ["string"
]
}

ObjectService_ListMarketing

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

200
default

Content type

application/json

{"objects": [{"acceptsCreditTrust": true,
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"administrationType": "UNDEFINED_ADMINISTRATION_TYPE",
"assignedSideRooms": "string",
"availability": {"availableFrom": "string",
"availableTo": "string",
"type": "IMMEDIATELY"
},
"awn": "string",
"buildingId": "string",
"category": "UNDEFINED_CATEGORY",
"characteristics": {"additionalRooms": ["ADDITIONAL_ROOM_ATTIC"
],
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"bathrooms": 0,
"ceilingHeight": 0.1,
"commercialFeatures": ["COMMERCIAL_FEATURES_GOODS_LIFT"
],
"condition": "UNDEFINED_CONDITION",
"decimalFloor": 0.1,
"extras": ["EXTRAS_BALCONY"
],
"firstTimeOccupancy": "string",
"flatSharingCommunity": "UNDEFINED_VALUE",
"floor": 0,
"floorLoad": 0.1,
"floorings": ["FLOORING_TILES"
],
"foreignQuota": "UNDEFINED_VALUE",
"furnishing": "UNDEFINED_FURNISHING",
"furnishingType": "UNDEFINED_FURNISHING_TYPE",
"gardenShed": "UNDEFINED_VALUE",
"glazings": ["GLAZING_ACOUSTIC_GLAZING"
],
"grossPremium": 0,
"guestToilets": 0,
"hallHeight": 0.1,
"heatings": ["CENTRAL_HEATING"
],
"kitchens": ["NO_KITCHEN"
],
"locationQualities": ["PARTICULARLY_QUIET"
],
"numberOfFloors": 0.1,
"opted": "UNDEFINED_VALUE",
"petAllowances": ["PETS_ALLOWED"
],
"pets": "UNDEFINED_VALUE",
"photovoltaic": "UNDEFINED_VALUE",
"planned": "UNDEFINED_VALUE",
"rooms": 0.1,
"sanitaries": ["SANITARY_BATHROOM_WITH_WINDOW"
],
"secondaryResidenceAllowed": "UNDEFINED_VALUE",
"separateToilets": 0,
"shellConstruction": "UNDEFINED_VALUE",
"showers": 0,
"smoking": "UNDEFINED_VALUE",
"technologies": ["TECHNOLOGY_ALARM_SYSTEM"
],
"thermalSolarCollector": "UNDEFINED_VALUE",
"toilets": 0,
"underRoof": "UNDEFINED_VALUE",
"volume": 0.1,
"wheelchairAccessible": "UNDEFINED_VALUE",
"windows": ["WINDOW_ALUMINIUM"
],
"yearBuilt": 0,
"yearLastRenovation": 0
},
"condominiumOwnership": true,
"contacts": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdministration": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeMarketing": "string",
"contactIdAssigneeOwner": "string",
"contactIdViewingAppointment": "string",
"contactIdsCraftsman": ["string"
],
"contactIdsJanitor": ["string"
],
"contactIdsServiceProvider": ["string"
],
"publishAssigneePhone": true
},
"debitUntil": {"day": 0,
"month": 0,
"year": 0
},
"defaultAnswer": {"attachmentMediaIds": ["string"
],
"includeApplicationFormLink": true,
"includeViewingAppointmentContact": true,
"mailboxId": "string",
"subject": "string",
"templateId": "string",
"text": "string"
},
"deposit": {"amount": 0.1,
"bankDepotAccepted": true,
"bankDepotIds": ["string"
],
"bankDepotNames": ["string"
],
"bankGuaranteeAccepted": true,
"bankGuaranteeIds": ["string"
],
"bankGuaranteeNames": ["string"
],
"cashPaymentAccepted": true,
"collectiveInsuranceAccepted": true,
"collectiveInsuranceNames": ["string"
],
"cooperativeShareAccepted": true,
"depositInsurance": "UNDEFINED_DEPOSIT_INSURANCE",
"depositNeeded": true,
"insuranceAccepted": true,
"insuranceNames": ["string"
]
},
"description": "string",
"development": "UNDEFINED_DEVELOPMENT",
"documents": [{"documentId": "string",
"isFloorPlan": true,
"isPublic": true
}
],
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"ewid": "string",
"id": "string",
"images": [{"mediaId": "string",
"order": 0,
"title": "string"
}
],
"inactiveBy": {"day": 0,
"month": 0,
"year": 0
},
"marketingLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
"marketingStatus": {"clearFromMarketingAt": "string",
"markedAsSeenAt": "string",
"markedForMarketingAt": "string",
"marketingNote": "string",
"newInMarketing": true,
"publications": [{"published": "string",
"publishedByAccountId": "string",
"publishedByUserId": "string",
"unPublishAtAmountOfRequests": 0,
"unPublished": "string",
"unPublishedByAccountId": "string",
"unPublishedByUserId": "string"
}
],
"setVacantAt": "string",
"specialPublication": {"exclusiveDays": 0,
"exclusiveUntil": "string",
"exclusivity": true,
"platform": "string",
"promotedAt": "string",
"promotedDays": 0,
"promotedUntil": "string",
"promotion": true,
"promotionType": "PROMOTION_TYPE_UNDEFINED"
},
"startMarketingAt": "string",
"vacantAt": "string"
},
"name": "string",
"needsMatching": true,
"note": "string",
"number": "string",
"numericId": "string",
"onboardingFinished": true,
"otoId": "string",
"ownerId": "string",
"parking": [{"amount": 0,
"costs": 0.1,
"parkingType": "UNDEFINED_PARKING_TYPE"
}
],
"positions": ["UNDEFINED_LOCATION"
],
"pricing": {"additional": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"commonDistrictRent": 0.1,
"currency": "string",
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heating": 0.1,
"marketGrossRent": 0.1,
"marketHeatingAndAdditional": 0.1,
"marketNetRent": 0.1,
"marketRent": 0.1,
"paymentInterval": "UNDEFINED_PAYMENT_INTERVAL",
"rentM2PerYear": 0.1,
"rentReserves": 0.1,
"sellingPrice": 0.1,
"sellingPriceM2": 0.1,
"targetAdditional": 0.1,
"targetColdRent": 0.1,
"targetHeating": 0.1,
"targetMarketGrossRent": 0.1,
"targetMarketHeatingAndAdditional": 0.1,
"targetMarketNetRent": 0.1,
"underMarketGrossRent": 0.1,
"underMarketHeatingAndAdditional": 0.1,
"underMarketNetRent": 0.1,
"unit": "ON_REQUEST",
"upperMarketGrossRent": 0.1,
"upperMarketHeatingAndAdditional": 0.1,
"upperMarketNetRent": 0.1
},
"publicId": "string",
"publishAddress": true,
"publishCharacteristicsInDescription": true,
"renovations": [{"end": "string",
"start": "string",
"text": "string"
}
],
"sharedUse": "string",
"specialFeatures": "string",
"subCategories": ["UNDEFINED_SUB_CATEGORY"
],
"tags": ["string"
],
"title": "string",
"type": "RENT",
"unusualAgreement": "string",
"updatedAt": "string",
"utilizations": ["UNDEFINED_UTILIZATION"
],
"valueQuota": 0.1,
"videoUrl": "string",
"videos": [{"mediaId": "string"
}
],
"viewingAppointment": {"contactType": "UNDEFINED_VIEWING_APPOINTMENT_CONTACT_TYPE",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"publishContact": true,
"remark": "string"
},
"virtualTourUrl": "string"
}
],
"totalObjectCount": 0,
"totalPageCount": 0
}

ObjectService_ListPublished

path Parameters

ownerId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"objects": [{"acceptsCreditTrust": true,
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"administrationType": "UNDEFINED_ADMINISTRATION_TYPE",
"assignedSideRooms": "string",
"availability": {"availableFrom": "string",
"availableTo": "string",
"type": "IMMEDIATELY"
},
"awn": "string",
"buildingId": "string",
"category": "UNDEFINED_CATEGORY",
"characteristics": {"additionalRooms": ["ADDITIONAL_ROOM_ATTIC"
],
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"bathrooms": 0,
"ceilingHeight": 0.1,
"commercialFeatures": ["COMMERCIAL_FEATURES_GOODS_LIFT"
],
"condition": "UNDEFINED_CONDITION",
"decimalFloor": 0.1,
"extras": ["EXTRAS_BALCONY"
],
"firstTimeOccupancy": "string",
"flatSharingCommunity": "UNDEFINED_VALUE",
"floor": 0,
"floorLoad": 0.1,
"floorings": ["FLOORING_TILES"
],
"foreignQuota": "UNDEFINED_VALUE",
"furnishing": "UNDEFINED_FURNISHING",
"furnishingType": "UNDEFINED_FURNISHING_TYPE",
"gardenShed": "UNDEFINED_VALUE",
"glazings": ["GLAZING_ACOUSTIC_GLAZING"
],
"grossPremium": 0,
"guestToilets": 0,
"hallHeight": 0.1,
"heatings": ["CENTRAL_HEATING"
],
"kitchens": ["NO_KITCHEN"
],
"locationQualities": ["PARTICULARLY_QUIET"
],
"numberOfFloors": 0.1,
"opted": "UNDEFINED_VALUE",
"petAllowances": ["PETS_ALLOWED"
],
"pets": "UNDEFINED_VALUE",
"photovoltaic": "UNDEFINED_VALUE",
"planned": "UNDEFINED_VALUE",
"rooms": 0.1,
"sanitaries": ["SANITARY_BATHROOM_WITH_WINDOW"
],
"secondaryResidenceAllowed": "UNDEFINED_VALUE",
"separateToilets": 0,
"shellConstruction": "UNDEFINED_VALUE",
"showers": 0,
"smoking": "UNDEFINED_VALUE",
"technologies": ["TECHNOLOGY_ALARM_SYSTEM"
],
"thermalSolarCollector": "UNDEFINED_VALUE",
"toilets": 0,
"underRoof": "UNDEFINED_VALUE",
"volume": 0.1,
"wheelchairAccessible": "UNDEFINED_VALUE",
"windows": ["WINDOW_ALUMINIUM"
],
"yearBuilt": 0,
"yearLastRenovation": 0
},
"condominiumOwnership": true,
"contacts": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdministration": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeMarketing": "string",
"contactIdAssigneeOwner": "string",
"contactIdViewingAppointment": "string",
"contactIdsCraftsman": ["string"
],
"contactIdsJanitor": ["string"
],
"contactIdsServiceProvider": ["string"
],
"publishAssigneePhone": true
},
"debitUntil": {"day": 0,
"month": 0,
"year": 0
},
"defaultAnswer": {"attachmentMediaIds": ["string"
],
"includeApplicationFormLink": true,
"includeViewingAppointmentContact": true,
"mailboxId": "string",
"subject": "string",
"templateId": "string",
"text": "string"
},
"deposit": {"amount": 0.1,
"bankDepotAccepted": true,
"bankDepotIds": ["string"
],
"bankDepotNames": ["string"
],
"bankGuaranteeAccepted": true,
"bankGuaranteeIds": ["string"
],
"bankGuaranteeNames": ["string"
],
"cashPaymentAccepted": true,
"collectiveInsuranceAccepted": true,
"collectiveInsuranceNames": ["string"
],
"cooperativeShareAccepted": true,
"depositInsurance": "UNDEFINED_DEPOSIT_INSURANCE",
"depositNeeded": true,
"insuranceAccepted": true,
"insuranceNames": ["string"
]
},
"description": "string",
"development": "UNDEFINED_DEVELOPMENT",
"documents": [{"documentId": "string",
"isFloorPlan": true,
"isPublic": true
}
],
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"ewid": "string",
"id": "string",
"images": [{"mediaId": "string",
"order": 0,
"title": "string"
}
],
"inactiveBy": {"day": 0,
"month": 0,
"year": 0
},
"marketingLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
"marketingStatus": {"clearFromMarketingAt": "string",
"markedAsSeenAt": "string",
"markedForMarketingAt": "string",
"marketingNote": "string",
"newInMarketing": true,
"publications": [{"published": "string",
"publishedByAccountId": "string",
"publishedByUserId": "string",
"unPublishAtAmountOfRequests": 0,
"unPublished": "string",
"unPublishedByAccountId": "string",
"unPublishedByUserId": "string"
}
],
"setVacantAt": "string",
"specialPublication": {"exclusiveDays": 0,
"exclusiveUntil": "string",
"exclusivity": true,
"platform": "string",
"promotedAt": "string",
"promotedDays": 0,
"promotedUntil": "string",
"promotion": true,
"promotionType": "PROMOTION_TYPE_UNDEFINED"
},
"startMarketingAt": "string",
"vacantAt": "string"
},
"name": "string",
"needsMatching": true,
"note": "string",
"number": "string",
"numericId": "string",
"onboardingFinished": true,
"otoId": "string",
"ownerId": "string",
"parking": [{"amount": 0,
"costs": 0.1,
"parkingType": "UNDEFINED_PARKING_TYPE"
}
],
"positions": ["UNDEFINED_LOCATION"
],
"pricing": {"additional": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"commonDistrictRent": 0.1,
"currency": "string",
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heating": 0.1,
"marketGrossRent": 0.1,
"marketHeatingAndAdditional": 0.1,
"marketNetRent": 0.1,
"marketRent": 0.1,
"paymentInterval": "UNDEFINED_PAYMENT_INTERVAL",
"rentM2PerYear": 0.1,
"rentReserves": 0.1,
"sellingPrice": 0.1,
"sellingPriceM2": 0.1,
"targetAdditional": 0.1,
"targetColdRent": 0.1,
"targetHeating": 0.1,
"targetMarketGrossRent": 0.1,
"targetMarketHeatingAndAdditional": 0.1,
"targetMarketNetRent": 0.1,
"underMarketGrossRent": 0.1,
"underMarketHeatingAndAdditional": 0.1,
"underMarketNetRent": 0.1,
"unit": "ON_REQUEST",
"upperMarketGrossRent": 0.1,
"upperMarketHeatingAndAdditional": 0.1,
"upperMarketNetRent": 0.1
},
"publicId": "string",
"publishAddress": true,
"publishCharacteristicsInDescription": true,
"renovations": [{"end": "string",
"start": "string",
"text": "string"
}
],
"sharedUse": "string",
"specialFeatures": "string",
"subCategories": ["UNDEFINED_SUB_CATEGORY"
],
"tags": ["string"
],
"title": "string",
"type": "RENT",
"unusualAgreement": "string",
"updatedAt": "string",
"utilizations": ["UNDEFINED_UTILIZATION"
],
"valueQuota": 0.1,
"videoUrl": "string",
"videos": [{"mediaId": "string"
}
],
"viewingAppointment": {"contactType": "UNDEFINED_VIEWING_APPOINTMENT_CONTACT_TYPE",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"publishContact": true,
"remark": "string"
},
"virtualTourUrl": "string"
}
]
}

ObjectService_MarkForMarketing

path Parameters

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

Payload

Content type

application/json

{"availability": {"availableFrom": "string",
"availableTo": "string",
"type": "IMMEDIATELY"
},
"deposit": {"amount": 0.1,
"bankDepotAccepted": true,
"bankDepotIds": ["string"
],
"bankDepotNames": ["string"
],
"bankGuaranteeAccepted": true,
"bankGuaranteeIds": ["string"
],
"bankGuaranteeNames": ["string"
],
"cashPaymentAccepted": true,
"collectiveInsuranceAccepted": true,
"collectiveInsuranceNames": ["string"
],
"cooperativeShareAccepted": true,
"depositInsurance": "UNDEFINED_DEPOSIT_INSURANCE",
"depositNeeded": true,
"insuranceAccepted": true,
"insuranceNames": ["string"
]
},
"description": "string",
"documents": [{"documentId": "string",
"isFloorPlan": true,
"isPublic": true
}
],
"images": [{"mediaId": "string",
"order": 0,
"title": "string"
}
],
"marketingNote": "string",
"parking": [{"amount": 0,
"costs": 0.1,
"parkingType": "UNDEFINED_PARKING_TYPE"
}
],
"pricing": {"additional": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"commonDistrictRent": 0.1,
"currency": "string",
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heating": 0.1,
"marketGrossRent": 0.1,
"marketHeatingAndAdditional": 0.1,
"marketNetRent": 0.1,
"marketRent": 0.1,
"paymentInterval": "UNDEFINED_PAYMENT_INTERVAL",
"rentM2PerYear": 0.1,
"rentReserves": 0.1,
"sellingPrice": 0.1,
"sellingPriceM2": 0.1,
"targetAdditional": 0.1,
"targetColdRent": 0.1,
"targetHeating": 0.1,
"targetMarketGrossRent": 0.1,
"targetMarketHeatingAndAdditional": 0.1,
"targetMarketNetRent": 0.1,
"underMarketGrossRent": 0.1,
"underMarketHeatingAndAdditional": 0.1,
"underMarketNetRent": 0.1,
"unit": "ON_REQUEST",
"upperMarketGrossRent": 0.1,
"upperMarketHeatingAndAdditional": 0.1,
"upperMarketNetRent": 0.1
},
"publishAddress": true,
"publishCharacteristicsInDescription": true,
"startMarketingAt": "string",
"title": "string",
"videoUrl": "string",
"videos": [{"mediaId": "string"
}
],
"virtualTourUrl": "string"
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_MarketingMarkSeen

path Parameters

required

string

Request Body schema: application/json
required

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
default

Content type

application/json

{ }

ObjectService_MoveObjects

Request Body schema: application/json
required

ids required	Array of strings
newBuildingId required	string

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
],
"newBuildingId": "string"
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_Publish

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

Payload

Content type

application/json

{"ids": ["string"
],
"publishAt": "string",
"specialPublication": {"exclusiveDays": 0,
"exclusiveUntil": "string",
"exclusivity": true,
"platform": "string",
"promotedAt": "string",
"promotedDays": 0,
"promotedUntil": "string",
"promotion": true,
"promotionType": "PROMOTION_TYPE_UNDEFINED"
},
"unPublishAt": "string",
"unPublishAtAmountOfRequests": 0
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_PublishUpdatedEvents

Request Body schema: application/json
required

ownerIds

required

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

Responses

Request samples

Payload

Content type

application/json

{"ownerIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_RemoveCraftsmen

Request Body schema: application/json
required

contactIdsCraftsman required	Array of strings
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"contactIdsCraftsman": ["string"
],
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_RemoveFromMarketing

Request Body schema: application/json
required

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_RemoveJanitors

Request Body schema: application/json
required

contactIdsJanitor required	Array of strings
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"contactIdsJanitor": ["string"
],
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_RemoveServiceProviders

Request Body schema: application/json
required

contactIdsServiceProvider required	Array of strings
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"contactIdsServiceProvider": ["string"
],
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_SetAccountingAssignee

Request Body schema: application/json
required

contactIdAssigneeAccounting required	string
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"contactIdAssigneeAccounting": "string",
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_SetAdminAssignee

Request Body schema: application/json
required

contactIdAssigneeAdministration required	string
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"contactIdAssigneeAdministration": "string",
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_SetAssetAssignee

Request Body schema: application/json
required

contactIdAssigneeAsset required	string
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"contactIdAssigneeAsset": "string",
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_SetContacts

Request Body schema: application/json
required

required	object (objectContacts)
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"contacts": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdministration": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeMarketing": "string",
"contactIdAssigneeOwner": "string",
"contactIdViewingAppointment": "string",
"contactIdsCraftsman": ["string"
],
"contactIdsJanitor": ["string"
],
"contactIdsServiceProvider": ["string"
],
"publishAssigneePhone": true
},
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_SetMarketingAssignee

Request Body schema: application/json
required

contactIdAssigneeMarketing required	string
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"contactIdAssigneeMarketing": "string",
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_SetOwnerAssignee

Request Body schema: application/json
required

contactIdAssigneeOwner required	string
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"contactIdAssigneeOwner": "string",
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_SetViewingAppointmentContact

Request Body schema: application/json
required

contactIdViewingAppointment required	string
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"contactIdViewingAppointment": "string",
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_UnPublish

Request Body schema: application/json
required

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_UpdateMarketingInfo

path Parameters

required

string

Request Body schema: application/json
required

marketingNote	string
startMarketingAt	string <int64> (UNIX timestamp in seconds)

Responses

Request samples

Payload

Content type

application/json

{"marketingNote": "string",
"startMarketingAt": "string"
}

Response samples

200
default

Content type

application/json

{ }

Delete

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{ }

ObjectService_GetApplicationInfo

path Parameters

required

string

query Parameters

language

string

Responses

Response samples

200
default

Content type

application/json

{"pdf": "string"
}

ObjectService_GetApplicationLink

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{"link": "string"
}

ObjectService_GetDefaultAnswer

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{"defaultAnswer": {"attachmentMediaIds": ["string"
],
"includeApplicationFormLink": true,
"includeViewingAppointmentContact": true,
"mailboxId": "string",
"subject": "string",
"templateId": "string",
"text": "string"
}
}

ObjectService_GetMarketingExpose

path Parameters

required

string

query Parameters

language

string

Responses

Response samples

200
default

Content type

application/json

{"pdf": "string"
}

ObjectService_GetViewingAppointment

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{"viewingAppointment": {"contactType": "UNDEFINED_VIEWING_APPOINTMENT_CONTACT_TYPE",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"publishContact": true,
"remark": "string"
}
}

ObjectService_SetDefaultAnswer

path Parameters

required

string

Request Body schema: application/json
required

object (objectDefaultAnswer)

Responses

Request samples

Payload

Content type

application/json

{"defaultAnswer": {"attachmentMediaIds": ["string"
],
"includeApplicationFormLink": true,
"includeViewingAppointmentContact": true,
"mailboxId": "string",
"subject": "string",
"templateId": "string",
"text": "string"
}
}

Response samples

200
default

Content type

application/json

{ }

ObjectService_SetViewingAppointment

path Parameters

required

string

Request Body schema: application/json
required

object (objectViewingAppointment)

Responses

Request samples

Payload

Content type

application/json

{"viewingAppointment": {"contactType": "UNDEFINED_VIEWING_APPOINTMENT_CONTACT_TYPE",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"publishContact": true,
"remark": "string"
}
}

Response samples

200
default

Content type

application/json

{ }

Update

path Parameters

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
	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
	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

Payload

Content type

application/json

{"acceptsCreditTrust": true,
"administrationType": "UNDEFINED_ADMINISTRATION_TYPE",
"assignedSideRooms": "string",
"availability": {"availableFrom": "string",
"availableTo": "string",
"type": "IMMEDIATELY"
},
"awn": "string",
"category": "UNDEFINED_CATEGORY",
"characteristics": {"additionalRooms": ["ADDITIONAL_ROOM_ATTIC"
],
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"bathrooms": 0,
"ceilingHeight": 0.1,
"commercialFeatures": ["COMMERCIAL_FEATURES_GOODS_LIFT"
],
"condition": "UNDEFINED_CONDITION",
"decimalFloor": 0.1,
"extras": ["EXTRAS_BALCONY"
],
"firstTimeOccupancy": "string",
"flatSharingCommunity": "UNDEFINED_VALUE",
"floor": 0,
"floorLoad": 0.1,
"floorings": ["FLOORING_TILES"
],
"foreignQuota": "UNDEFINED_VALUE",
"furnishing": "UNDEFINED_FURNISHING",
"furnishingType": "UNDEFINED_FURNISHING_TYPE",
"gardenShed": "UNDEFINED_VALUE",
"glazings": ["GLAZING_ACOUSTIC_GLAZING"
],
"grossPremium": 0,
"guestToilets": 0,
"hallHeight": 0.1,
"heatings": ["CENTRAL_HEATING"
],
"kitchens": ["NO_KITCHEN"
],
"locationQualities": ["PARTICULARLY_QUIET"
],
"numberOfFloors": 0.1,
"opted": "UNDEFINED_VALUE",
"petAllowances": ["PETS_ALLOWED"
],
"pets": "UNDEFINED_VALUE",
"photovoltaic": "UNDEFINED_VALUE",
"planned": "UNDEFINED_VALUE",
"rooms": 0.1,
"sanitaries": ["SANITARY_BATHROOM_WITH_WINDOW"
],
"secondaryResidenceAllowed": "UNDEFINED_VALUE",
"separateToilets": 0,
"shellConstruction": "UNDEFINED_VALUE",
"showers": 0,
"smoking": "UNDEFINED_VALUE",
"technologies": ["TECHNOLOGY_ALARM_SYSTEM"
],
"thermalSolarCollector": "UNDEFINED_VALUE",
"toilets": 0,
"underRoof": "UNDEFINED_VALUE",
"volume": 0.1,
"wheelchairAccessible": "UNDEFINED_VALUE",
"windows": ["WINDOW_ALUMINIUM"
],
"yearBuilt": 0,
"yearLastRenovation": 0
},
"contacts": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdministration": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeMarketing": "string",
"contactIdAssigneeOwner": "string",
"contactIdViewingAppointment": "string",
"contactIdsCraftsman": ["string"
],
"contactIdsJanitor": ["string"
],
"contactIdsServiceProvider": ["string"
],
"publishAssigneePhone": true
},
"defaultAnswer": {"attachmentMediaIds": ["string"
],
"includeApplicationFormLink": true,
"includeViewingAppointmentContact": true,
"mailboxId": "string",
"subject": "string",
"templateId": "string",
"text": "string"
},
"deposit": {"amount": 0.1,
"bankDepotAccepted": true,
"bankDepotIds": ["string"
],
"bankDepotNames": ["string"
],
"bankGuaranteeAccepted": true,
"bankGuaranteeIds": ["string"
],
"bankGuaranteeNames": ["string"
],
"cashPaymentAccepted": true,
"collectiveInsuranceAccepted": true,
"collectiveInsuranceNames": ["string"
],
"cooperativeShareAccepted": true,
"depositInsurance": "UNDEFINED_DEPOSIT_INSURANCE",
"depositNeeded": true,
"insuranceAccepted": true,
"insuranceNames": ["string"
]
},
"description": "string",
"development": "UNDEFINED_DEVELOPMENT",
"documents": [{"documentId": "string",
"isFloorPlan": true,
"isPublic": true
}
],
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"ewid": "string",
"images": [{"mediaId": "string",
"order": 0,
"title": "string"
}
],
"inactiveBy": {"day": 0,
"month": 0,
"year": 0
},
"marketingLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
"name": "string",
"needsMatching": true,
"note": "string",
"number": "string",
"otoId": "string",
"parking": [{"amount": 0,
"costs": 0.1,
"parkingType": "UNDEFINED_PARKING_TYPE"
}
],
"positions": ["UNDEFINED_LOCATION"
],
"pricing": {"additional": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"commonDistrictRent": 0.1,
"currency": "string",
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heating": 0.1,
"marketGrossRent": 0.1,
"marketHeatingAndAdditional": 0.1,
"marketNetRent": 0.1,
"marketRent": 0.1,
"paymentInterval": "UNDEFINED_PAYMENT_INTERVAL",
"rentM2PerYear": 0.1,
"rentReserves": 0.1,
"sellingPrice": 0.1,
"sellingPriceM2": 0.1,
"targetAdditional": 0.1,
"targetColdRent": 0.1,
"targetHeating": 0.1,
"targetMarketGrossRent": 0.1,
"targetMarketHeatingAndAdditional": 0.1,
"targetMarketNetRent": 0.1,
"underMarketGrossRent": 0.1,
"underMarketHeatingAndAdditional": 0.1,
"underMarketNetRent": 0.1,
"unit": "ON_REQUEST",
"upperMarketGrossRent": 0.1,
"upperMarketHeatingAndAdditional": 0.1,
"upperMarketNetRent": 0.1
},
"publishAddress": true,
"publishCharacteristicsInDescription": true,
"renovations": [{"end": "string",
"start": "string",
"text": "string"
}
],
"sharedUse": "string",
"specialFeatures": "string",
"subCategories": ["UNDEFINED_SUB_CATEGORY"
],
"tags": ["string"
],
"title": "string",
"type": "RENT",
"unusualAgreement": "string",
"utilizations": ["UNDEFINED_UTILIZATION"
],
"valueQuota": 0.1,
"videoUrl": "string",
"videos": [{"mediaId": "string"
}
],
"viewingAppointment": {"contactType": "UNDEFINED_VIEWING_APPOINTMENT_CONTACT_TYPE",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"publishContact": true,
"remark": "string"
},
"virtualTourUrl": "string"
}

Response samples

200
default

Content type

application/json

{"object": {"acceptsCreditTrust": true,
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"administrationType": "UNDEFINED_ADMINISTRATION_TYPE",
"assignedSideRooms": "string",
"availability": {"availableFrom": "string",
"availableTo": "string",
"type": "IMMEDIATELY"
},
"awn": "string",
"buildingId": "string",
"category": "UNDEFINED_CATEGORY",
"characteristics": {"additionalRooms": ["ADDITIONAL_ROOM_ATTIC"
],
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"bathrooms": 0,
"ceilingHeight": 0.1,
"commercialFeatures": ["COMMERCIAL_FEATURES_GOODS_LIFT"
],
"condition": "UNDEFINED_CONDITION",
"decimalFloor": 0.1,
"extras": ["EXTRAS_BALCONY"
],
"firstTimeOccupancy": "string",
"flatSharingCommunity": "UNDEFINED_VALUE",
"floor": 0,
"floorLoad": 0.1,
"floorings": ["FLOORING_TILES"
],
"foreignQuota": "UNDEFINED_VALUE",
"furnishing": "UNDEFINED_FURNISHING",
"furnishingType": "UNDEFINED_FURNISHING_TYPE",
"gardenShed": "UNDEFINED_VALUE",
"glazings": ["GLAZING_ACOUSTIC_GLAZING"
],
"grossPremium": 0,
"guestToilets": 0,
"hallHeight": 0.1,
"heatings": ["CENTRAL_HEATING"
],
"kitchens": ["NO_KITCHEN"
],
"locationQualities": ["PARTICULARLY_QUIET"
],
"numberOfFloors": 0.1,
"opted": "UNDEFINED_VALUE",
"petAllowances": ["PETS_ALLOWED"
],
"pets": "UNDEFINED_VALUE",
"photovoltaic": "UNDEFINED_VALUE",
"planned": "UNDEFINED_VALUE",
"rooms": 0.1,
"sanitaries": ["SANITARY_BATHROOM_WITH_WINDOW"
],
"secondaryResidenceAllowed": "UNDEFINED_VALUE",
"separateToilets": 0,
"shellConstruction": "UNDEFINED_VALUE",
"showers": 0,
"smoking": "UNDEFINED_VALUE",
"technologies": ["TECHNOLOGY_ALARM_SYSTEM"
],
"thermalSolarCollector": "UNDEFINED_VALUE",
"toilets": 0,
"underRoof": "UNDEFINED_VALUE",
"volume": 0.1,
"wheelchairAccessible": "UNDEFINED_VALUE",
"windows": ["WINDOW_ALUMINIUM"
],
"yearBuilt": 0,
"yearLastRenovation": 0
},
"condominiumOwnership": true,
"contacts": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdministration": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeMarketing": "string",
"contactIdAssigneeOwner": "string",
"contactIdViewingAppointment": "string",
"contactIdsCraftsman": ["string"
],
"contactIdsJanitor": ["string"
],
"contactIdsServiceProvider": ["string"
],
"publishAssigneePhone": true
},
"debitUntil": {"day": 0,
"month": 0,
"year": 0
},
"defaultAnswer": {"attachmentMediaIds": ["string"
],
"includeApplicationFormLink": true,
"includeViewingAppointmentContact": true,
"mailboxId": "string",
"subject": "string",
"templateId": "string",
"text": "string"
},
"deposit": {"amount": 0.1,
"bankDepotAccepted": true,
"bankDepotIds": ["string"
],
"bankDepotNames": ["string"
],
"bankGuaranteeAccepted": true,
"bankGuaranteeIds": ["string"
],
"bankGuaranteeNames": ["string"
],
"cashPaymentAccepted": true,
"collectiveInsuranceAccepted": true,
"collectiveInsuranceNames": ["string"
],
"cooperativeShareAccepted": true,
"depositInsurance": "UNDEFINED_DEPOSIT_INSURANCE",
"depositNeeded": true,
"insuranceAccepted": true,
"insuranceNames": ["string"
]
},
"description": "string",
"development": "UNDEFINED_DEVELOPMENT",
"documents": [{"documentId": "string",
"isFloorPlan": true,
"isPublic": true
}
],
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"ewid": "string",
"id": "string",
"images": [{"mediaId": "string",
"order": 0,
"title": "string"
}
],
"inactiveBy": {"day": 0,
"month": 0,
"year": 0
},
"marketingLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
"marketingStatus": {"clearFromMarketingAt": "string",
"markedAsSeenAt": "string",
"markedForMarketingAt": "string",
"marketingNote": "string",
"newInMarketing": true,
"publications": [{"published": "string",
"publishedByAccountId": "string",
"publishedByUserId": "string",
"unPublishAtAmountOfRequests": 0,
"unPublished": "string",
"unPublishedByAccountId": "string",
"unPublishedByUserId": "string"
}
],
"setVacantAt": "string",
"specialPublication": {"exclusiveDays": 0,
"exclusiveUntil": "string",
"exclusivity": true,
"platform": "string",
"promotedAt": "string",
"promotedDays": 0,
"promotedUntil": "string",
"promotion": true,
"promotionType": "PROMOTION_TYPE_UNDEFINED"
},
"startMarketingAt": "string",
"vacantAt": "string"
},
"name": "string",
"needsMatching": true,
"note": "string",
"number": "string",
"numericId": "string",
"onboardingFinished": true,
"otoId": "string",
"ownerId": "string",
"parking": [{"amount": 0,
"costs": 0.1,
"parkingType": "UNDEFINED_PARKING_TYPE"
}
],
"positions": ["UNDEFINED_LOCATION"
],
"pricing": {"additional": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"commonDistrictRent": 0.1,
"currency": "string",
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heating": 0.1,
"marketGrossRent": 0.1,
"marketHeatingAndAdditional": 0.1,
"marketNetRent": 0.1,
"marketRent": 0.1,
"paymentInterval": "UNDEFINED_PAYMENT_INTERVAL",
"rentM2PerYear": 0.1,
"rentReserves": 0.1,
"sellingPrice": 0.1,
"sellingPriceM2": 0.1,
"targetAdditional": 0.1,
"targetColdRent": 0.1,
"targetHeating": 0.1,
"targetMarketGrossRent": 0.1,
"targetMarketHeatingAndAdditional": 0.1,
"targetMarketNetRent": 0.1,
"underMarketGrossRent": 0.1,
"underMarketHeatingAndAdditional": 0.1,
"underMarketNetRent": 0.1,
"unit": "ON_REQUEST",
"upperMarketGrossRent": 0.1,
"upperMarketHeatingAndAdditional": 0.1,
"upperMarketNetRent": 0.1
},
"publicId": "string",
"publishAddress": true,
"publishCharacteristicsInDescription": true,
"renovations": [{"end": "string",
"start": "string",
"text": "string"
}
],
"sharedUse": "string",
"specialFeatures": "string",
"subCategories": ["UNDEFINED_SUB_CATEGORY"
],
"tags": ["string"
],
"title": "string",
"type": "RENT",
"unusualAgreement": "string",
"updatedAt": "string",
"utilizations": ["UNDEFINED_UTILIZATION"
],
"valueQuota": 0.1,
"videoUrl": "string",
"videos": [{"mediaId": "string"
}
],
"viewingAppointment": {"contactType": "UNDEFINED_VIEWING_APPOINTMENT_CONTACT_TYPE",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"publishContact": true,
"remark": "string"
},
"virtualTourUrl": "string"
}
}

ObjectService_UpdatePricing

path Parameters

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

Payload

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

200
default

Content type

application/json

{"pricing": {"additional": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"commonDistrictRent": 0.1,
"currency": "string",
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heating": 0.1,
"marketGrossRent": 0.1,
"marketHeatingAndAdditional": 0.1,
"marketNetRent": 0.1,
"marketRent": 0.1,
"paymentInterval": "UNDEFINED_PAYMENT_INTERVAL",
"rentM2PerYear": 0.1,
"rentReserves": 0.1,
"sellingPrice": 0.1,
"sellingPriceM2": 0.1,
"targetAdditional": 0.1,
"targetColdRent": 0.1,
"targetHeating": 0.1,
"targetMarketGrossRent": 0.1,
"targetMarketHeatingAndAdditional": 0.1,
"targetMarketNetRent": 0.1,
"underMarketGrossRent": 0.1,
"underMarketHeatingAndAdditional": 0.1,
"underMarketNetRent": 0.1,
"unit": "ON_REQUEST",
"upperMarketGrossRent": 0.1,
"upperMarketHeatingAndAdditional": 0.1,
"upperMarketNetRent": 0.1
}
}

PlotService

Create

Request Body schema: application/json
required

required

Array of objects (plotPlotCreation)

Responses

Request samples

Payload

Content type

application/json

{"plotCreations": [{"cadastralValue": 0.1,
"category": "PLOT_CATEGORY_UNDEFINED",
"constructionZone": "string",
"documentIds": ["string"
],
"easements": "string",
"egrid": "string",
"formOfOwnership": "string",
"inventories": "string",
"landRegisterNumber": "string",
"loads": "string",
"noiseSensitivity": "string",
"note": "string",
"operation": "PLOT_OPERATION_UNDEFINED",
"ownerId": "string",
"plotArea": 0.1,
"plotType": "string",
"priorityNotices": "string",
"promissoryNote": 0.1,
"propertyId": "string",
"purchaseDate": {"day": 0,
"month": 0,
"year": 0
},
"purchasePrice": 0.1,
"realEstateRights": "string",
"reviewStrategyDate": {"day": 0,
"month": 0,
"year": 0
},
"strategy": "PLOT_STRATEGY_UNDEFINED",
"termUntil": {"day": 0,
"month": 0,
"year": 0
},
"utilizationZone": "string"
}
]
}

Response samples

200
default

Content type

application/json

{"plots": [{"cadastralValue": 0.1,
"category": "PLOT_CATEGORY_UNDEFINED",
"constructionZone": "string",
"documentIds": ["string"
],
"easements": "string",
"egrid": "string",
"formOfOwnership": "string",
"id": "string",
"inventories": "string",
"landRegisterNumber": "string",
"loads": "string",
"noiseSensitivity": "string",
"note": "string",
"numericId": "string",
"operation": "PLOT_OPERATION_UNDEFINED",
"ownerId": "string",
"plotArea": 0.1,
"plotType": "string",
"priorityNotices": "string",
"promissoryNote": 0.1,
"propertyId": "string",
"purchaseDate": {"day": 0,
"month": 0,
"year": 0
},
"purchasePrice": 0.1,
"realEstateRights": "string",
"reviewStrategyDate": {"day": 0,
"month": 0,
"year": 0
},
"strategy": "PLOT_STRATEGY_UNDEFINED",
"termUntil": {"day": 0,
"month": 0,
"year": 0
},
"utilizationZone": "string"
}
]
}

PlotService_ListByIds

path Parameters

ids

required

Array of strings non-empty

Responses

Response samples

200
default

Content type

application/json

{"plots": [{"cadastralValue": 0.1,
"category": "PLOT_CATEGORY_UNDEFINED",
"constructionZone": "string",
"documentIds": ["string"
],
"easements": "string",
"egrid": "string",
"formOfOwnership": "string",
"id": "string",
"inventories": "string",
"landRegisterNumber": "string",
"loads": "string",
"noiseSensitivity": "string",
"note": "string",
"numericId": "string",
"operation": "PLOT_OPERATION_UNDEFINED",
"ownerId": "string",
"plotArea": 0.1,
"plotType": "string",
"priorityNotices": "string",
"promissoryNote": 0.1,
"propertyId": "string",
"purchaseDate": {"day": 0,
"month": 0,
"year": 0
},
"purchasePrice": 0.1,
"realEstateRights": "string",
"reviewStrategyDate": {"day": 0,
"month": 0,
"year": 0
},
"strategy": "PLOT_STRATEGY_UNDEFINED",
"termUntil": {"day": 0,
"month": 0,
"year": 0
},
"utilizationZone": "string"
}
]
}

Read

path Parameters

ownerId

required

string <int64>

query Parameters

page	integer <int32>
itemsPerPage	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"plots": [{"cadastralValue": 0.1,
"category": "PLOT_CATEGORY_UNDEFINED",
"constructionZone": "string",
"documentIds": ["string"
],
"easements": "string",
"egrid": "string",
"formOfOwnership": "string",
"id": "string",
"inventories": "string",
"landRegisterNumber": "string",
"loads": "string",
"noiseSensitivity": "string",
"note": "string",
"numericId": "string",
"operation": "PLOT_OPERATION_UNDEFINED",
"ownerId": "string",
"plotArea": 0.1,
"plotType": "string",
"priorityNotices": "string",
"promissoryNote": 0.1,
"propertyId": "string",
"purchaseDate": {"day": 0,
"month": 0,
"year": 0
},
"purchasePrice": 0.1,
"realEstateRights": "string",
"reviewStrategyDate": {"day": 0,
"month": 0,
"year": 0
},
"strategy": "PLOT_STRATEGY_UNDEFINED",
"termUntil": {"day": 0,
"month": 0,
"year": 0
},
"utilizationZone": "string"
}
],
"totalPageCount": 0,
"totalPlotCount": 0
}

PlotService_ListByPropertyId

path Parameters

propertyId

required

string

Responses

Response samples

200
default

Content type

application/json

{"plots": [{"cadastralValue": 0.1,
"category": "PLOT_CATEGORY_UNDEFINED",
"constructionZone": "string",
"documentIds": ["string"
],
"easements": "string",
"egrid": "string",
"formOfOwnership": "string",
"id": "string",
"inventories": "string",
"landRegisterNumber": "string",
"loads": "string",
"noiseSensitivity": "string",
"note": "string",
"numericId": "string",
"operation": "PLOT_OPERATION_UNDEFINED",
"ownerId": "string",
"plotArea": 0.1,
"plotType": "string",
"priorityNotices": "string",
"promissoryNote": 0.1,
"propertyId": "string",
"purchaseDate": {"day": 0,
"month": 0,
"year": 0
},
"purchasePrice": 0.1,
"realEstateRights": "string",
"reviewStrategyDate": {"day": 0,
"month": 0,
"year": 0
},
"strategy": "PLOT_STRATEGY_UNDEFINED",
"termUntil": {"day": 0,
"month": 0,
"year": 0
},
"utilizationZone": "string"
}
]
}

PlotService_ListByReferenceIds

Request Body schema: application/json
required

referenceIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"referenceIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"plots": [{"cadastralValue": 0.1,
"category": "PLOT_CATEGORY_UNDEFINED",
"constructionZone": "string",
"documentIds": ["string"
],
"easements": "string",
"egrid": "string",
"formOfOwnership": "string",
"id": "string",
"inventories": "string",
"landRegisterNumber": "string",
"loads": "string",
"noiseSensitivity": "string",
"note": "string",
"numericId": "string",
"operation": "PLOT_OPERATION_UNDEFINED",
"ownerId": "string",
"plotArea": 0.1,
"plotType": "string",
"priorityNotices": "string",
"promissoryNote": 0.1,
"propertyId": "string",
"purchaseDate": {"day": 0,
"month": 0,
"year": 0
},
"purchasePrice": 0.1,
"realEstateRights": "string",
"reviewStrategyDate": {"day": 0,
"month": 0,
"year": 0
},
"strategy": "PLOT_STRATEGY_UNDEFINED",
"termUntil": {"day": 0,
"month": 0,
"year": 0
},
"utilizationZone": "string"
}
]
}

Update

Request Body schema: application/json
required

required

Array of objects (plotPlotUpdate)

Responses

Request samples

Payload

Content type

application/json

{"plotUpdates": [{"cadastralValue": 0.1,
"category": "PLOT_CATEGORY_UNDEFINED",
"constructionZone": "string",
"documentIds": ["string"
],
"easements": "string",
"egrid": "string",
"formOfOwnership": "string",
"id": "string",
"inventories": "string",
"landRegisterNumber": "string",
"loads": "string",
"noiseSensitivity": "string",
"note": "string",
"operation": "PLOT_OPERATION_UNDEFINED",
"plotArea": 0.1,
"plotType": "string",
"priorityNotices": "string",
"promissoryNote": 0.1,
"purchaseDate": {"day": 0,
"month": 0,
"year": 0
},
"purchasePrice": 0.1,
"realEstateRights": "string",
"reviewStrategyDate": {"day": 0,
"month": 0,
"year": 0
},
"strategy": "PLOT_STRATEGY_UNDEFINED",
"termUntil": {"day": 0,
"month": 0,
"year": 0
},
"utilizationZone": "string"
}
]
}

Response samples

200
default

Content type

application/json

{"plots": [{"cadastralValue": 0.1,
"category": "PLOT_CATEGORY_UNDEFINED",
"constructionZone": "string",
"documentIds": ["string"
],
"easements": "string",
"egrid": "string",
"formOfOwnership": "string",
"id": "string",
"inventories": "string",
"landRegisterNumber": "string",
"loads": "string",
"noiseSensitivity": "string",
"note": "string",
"numericId": "string",
"operation": "PLOT_OPERATION_UNDEFINED",
"ownerId": "string",
"plotArea": 0.1,
"plotType": "string",
"priorityNotices": "string",
"promissoryNote": 0.1,
"propertyId": "string",
"purchaseDate": {"day": 0,
"month": 0,
"year": 0
},
"purchasePrice": 0.1,
"realEstateRights": "string",
"reviewStrategyDate": {"day": 0,
"month": 0,
"year": 0
},
"strategy": "PLOT_STRATEGY_UNDEFINED",
"termUntil": {"day": 0,
"month": 0,
"year": 0
},
"utilizationZone": "string"
}
]
}

Delete

path Parameters

ids

required

Array of strings non-empty

Responses

Response samples

200
default

Content type

application/json

{ }

InsuranceService

Create

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"
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"
yearlyCosts required	number <float>

Responses

Request samples

Payload

Content type

application/json

{"amount": 0.1,
"benefits": ["INSURANCE_BENEFIT_UNDEFINED"
],
"documentIds": ["string"
],
"earliestTerminationDate": {"day": 0,
"month": 0,
"year": 0
},
"editedByAic": true,
"endDate": {"day": 0,
"month": 0,
"year": 0
},
"excess": 0.1,
"indexYear": 0,
"insuranceCompany": "string",
"notes": "string",
"ownerId": "string",
"policyNumber": "string",
"premiumPaidUntil": {"day": 0,
"month": 0,
"year": 0
},
"referenceId": "string",
"startDate": {"day": 0,
"month": 0,
"year": 0
},
"type": "INSURANCE_TYPE_UNDEFINED",
"yearlyCosts": 0.1
}

Response samples

200
default

Content type

application/json

{"insurance": {"amount": 0.1,
"benefits": ["INSURANCE_BENEFIT_UNDEFINED"
],
"documentIds": ["string"
],
"earliestTerminationDate": {"day": 0,
"month": 0,
"year": 0
},
"editedByAic": true,
"endDate": {"day": 0,
"month": 0,
"year": 0
},
"excess": 0.1,
"id": "string",
"indexYear": 0,
"insuranceCompany": "string",
"notes": "string",
"numericId": "string",
"ownerId": "string",
"policyNumber": "string",
"premiumPaidUntil": {"day": 0,
"month": 0,
"year": 0
},
"referenceId": "string",
"startDate": {"day": 0,
"month": 0,
"year": 0
},
"type": "INSURANCE_TYPE_UNDEFINED",
"yearlyCosts": 0.1
}
}

InsuranceService_ListByIds

path Parameters

ids

required

Array of strings non-empty

Responses

Response samples

200
default

Content type

application/json

{"insurances": [{"amount": 0.1,
"benefits": ["INSURANCE_BENEFIT_UNDEFINED"
],
"documentIds": ["string"
],
"earliestTerminationDate": {"day": 0,
"month": 0,
"year": 0
},
"editedByAic": true,
"endDate": {"day": 0,
"month": 0,
"year": 0
},
"excess": 0.1,
"id": "string",
"indexYear": 0,
"insuranceCompany": "string",
"notes": "string",
"numericId": "string",
"ownerId": "string",
"policyNumber": "string",
"premiumPaidUntil": {"day": 0,
"month": 0,
"year": 0
},
"referenceId": "string",
"startDate": {"day": 0,
"month": 0,
"year": 0
},
"type": "INSURANCE_TYPE_UNDEFINED",
"yearlyCosts": 0.1
}
]
}

Read

path Parameters

referenceIds

required

Array of strings non-empty

Responses

Response samples

200
default

Content type

application/json

{"insurances": [{"amount": 0.1,
"benefits": ["INSURANCE_BENEFIT_UNDEFINED"
],
"documentIds": ["string"
],
"earliestTerminationDate": {"day": 0,
"month": 0,
"year": 0
},
"editedByAic": true,
"endDate": {"day": 0,
"month": 0,
"year": 0
},
"excess": 0.1,
"id": "string",
"indexYear": 0,
"insuranceCompany": "string",
"notes": "string",
"numericId": "string",
"ownerId": "string",
"policyNumber": "string",
"premiumPaidUntil": {"day": 0,
"month": 0,
"year": 0
},
"referenceId": "string",
"startDate": {"day": 0,
"month": 0,
"year": 0
},
"type": "INSURANCE_TYPE_UNDEFINED",
"yearlyCosts": 0.1
}
]
}

Delete

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{ }

InsuranceService_AddDocumentIds

path Parameters

required

string

Request Body schema: application/json
required

documentIds

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"documentIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"insurance": {"amount": 0.1,
"benefits": ["INSURANCE_BENEFIT_UNDEFINED"
],
"documentIds": ["string"
],
"earliestTerminationDate": {"day": 0,
"month": 0,
"year": 0
},
"editedByAic": true,
"endDate": {"day": 0,
"month": 0,
"year": 0
},
"excess": 0.1,
"id": "string",
"indexYear": 0,
"insuranceCompany": "string",
"notes": "string",
"numericId": "string",
"ownerId": "string",
"policyNumber": "string",
"premiumPaidUntil": {"day": 0,
"month": 0,
"year": 0
},
"referenceId": "string",
"startDate": {"day": 0,
"month": 0,
"year": 0
},
"type": "INSURANCE_TYPE_UNDEFINED",
"yearlyCosts": 0.1
}
}

Update

path Parameters

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"
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"
yearlyCosts	number <float>

Responses

Request samples

Payload

Content type

application/json

{"amount": 0.1,
"benefits": ["INSURANCE_BENEFIT_UNDEFINED"
],
"documentIds": ["string"
],
"earliestTerminationDate": {"day": 0,
"month": 0,
"year": 0
},
"editedByAic": true,
"endDate": {"day": 0,
"month": 0,
"year": 0
},
"excess": 0.1,
"indexYear": 0,
"insuranceCompany": "string",
"notes": "string",
"policyNumber": "string",
"premiumPaidUntil": {"day": 0,
"month": 0,
"year": 0
},
"referenceId": "string",
"startDate": {"day": 0,
"month": 0,
"year": 0
},
"type": "INSURANCE_TYPE_UNDEFINED",
"yearlyCosts": 0.1
}

Response samples

200
default

Content type

application/json

{"insurance": {"amount": 0.1,
"benefits": ["INSURANCE_BENEFIT_UNDEFINED"
],
"documentIds": ["string"
],
"earliestTerminationDate": {"day": 0,
"month": 0,
"year": 0
},
"editedByAic": true,
"endDate": {"day": 0,
"month": 0,
"year": 0
},
"excess": 0.1,
"id": "string",
"indexYear": 0,
"insuranceCompany": "string",
"notes": "string",
"numericId": "string",
"ownerId": "string",
"policyNumber": "string",
"premiumPaidUntil": {"day": 0,
"month": 0,
"year": 0
},
"referenceId": "string",
"startDate": {"day": 0,
"month": 0,
"year": 0
},
"type": "INSURANCE_TYPE_UNDEFINED",
"yearlyCosts": 0.1
}
}

CondominiumService

Create

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

Payload

Content type

application/json

{"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"numericId": "string",
"objectId": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"ownerId": "string",
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
]
}

Response samples

200
default

Content type

application/json

{"condominium": {"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"id": "string",
"isLatest": true,
"numericId": "string",
"objectId": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"ownerId": "string",
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "CONDOMINIUM_STATUS_NOT_ACTIVATED",
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"updatedAt": "string"
}
}

CondominiumService_DeleteRentAdjustments

Request Body schema: application/json
required

required

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

Payload

Content type

application/json

{"byDate": {"day": 0,
"month": 0,
"year": 0
},
"objectIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

Read

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{"condominium": {"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"id": "string",
"isLatest": true,
"numericId": "string",
"objectId": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"ownerId": "string",
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "CONDOMINIUM_STATUS_NOT_ACTIVATED",
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"updatedAt": "string"
}
}

CondominiumService_HasActivatedCondominium

Request Body schema: application/json
required

objectIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"objectIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"entries": [{"hasActivatedCondominium": true,
"objectId": "string"
}
]
}

CondominiumService_ListByBillingContactId

path Parameters

billingContactId

required

string

Responses

Response samples

200
default

Content type

application/json

{"condominiums": [{"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"id": "string",
"isLatest": true,
"numericId": "string",
"objectId": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"ownerId": "string",
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "CONDOMINIUM_STATUS_NOT_ACTIVATED",
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"updatedAt": "string"
}
]
}

CondominiumService_ListByContactId

path Parameters

contactId

required

string

query Parameters

billingContact	boolean
owners	boolean
correspondence	boolean
roommates	boolean
tenants	boolean

Responses

Response samples

200
default

Content type

application/json

{"condominiums": [{"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"id": "string",
"isLatest": true,
"numericId": "string",
"objectId": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"ownerId": "string",
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "CONDOMINIUM_STATUS_NOT_ACTIVATED",
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"updatedAt": "string"
}
]
}

CondominiumService_ListByIds

Request Body schema: application/json
required

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{"condominiums": [{"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"id": "string",
"isLatest": true,
"numericId": "string",
"objectId": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"ownerId": "string",
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "CONDOMINIUM_STATUS_NOT_ACTIVATED",
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"updatedAt": "string"
}
]
}

CondominiumService_ListByObjectIds

Request Body schema: application/json
required

objectIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"objectIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"condominiums": [{"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"id": "string",
"isLatest": true,
"numericId": "string",
"objectId": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"ownerId": "string",
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "CONDOMINIUM_STATUS_NOT_ACTIVATED",
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"updatedAt": "string"
}
]
}

CondominiumService_ListByOwner

path Parameters

ownerId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"condominiums": [{"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"id": "string",
"isLatest": true,
"numericId": "string",
"objectId": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"ownerId": "string",
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "CONDOMINIUM_STATUS_NOT_ACTIVATED",
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"updatedAt": "string"
}
]
}

CondominiumService_ListByOwnerContact

path Parameters

ownerContactId

required

string

Responses

Response samples

200
default

Content type

application/json

{"condominiums": [{"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"id": "string",
"isLatest": true,
"numericId": "string",
"objectId": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"ownerId": "string",
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "CONDOMINIUM_STATUS_NOT_ACTIVATED",
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"updatedAt": "string"
}
]
}

CondominiumService_ListByTenantContacts

path Parameters

tenantContactIds

required

Array of strings non-empty

Responses

Response samples

200
default

Content type

application/json

{"condominiums": [{"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"id": "string",
"isLatest": true,
"numericId": "string",
"objectId": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"ownerId": "string",
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "CONDOMINIUM_STATUS_NOT_ACTIVATED",
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"updatedAt": "string"
}
]
}

CondominiumService_ListCurrentByObjectIds

Request Body schema: application/json
required

objectIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"objectIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"condominiums": [{"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"id": "string",
"isLatest": true,
"numericId": "string",
"objectId": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"ownerId": "string",
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "CONDOMINIUM_STATUS_NOT_ACTIVATED",
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"updatedAt": "string"
}
]
}

CondominiumService_PublishUpdatedEvents

Request Body schema: application/json
required

ownerIds

required

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

Responses

Request samples

Payload

Content type

application/json

{"ownerIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

CondominiumService_UpdateBulk

Request Body schema: application/json
required

required

Array of objects (objectcondominiumUpdateBulkEntry)

Responses

Request samples

Payload

Content type

application/json

{"entries": [{"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"id": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
]
}
]
}

Response samples

200
default

Content type

application/json

{"condominiums": [{"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"id": "string",
"isLatest": true,
"numericId": "string",
"objectId": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"ownerId": "string",
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "CONDOMINIUM_STATUS_NOT_ACTIVATED",
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"updatedAt": "string"
}
]
}

Delete

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{ }

CondominiumService_Activate

path Parameters

required

string

Request Body schema: application/json
required

documentIds

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"documentIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"condominium": {"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"id": "string",
"isLatest": true,
"numericId": "string",
"objectId": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"ownerId": "string",
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "CONDOMINIUM_STATUS_NOT_ACTIVATED",
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"updatedAt": "string"
}
}

Document

path Parameters

required

string

Request Body schema: application/json
required

documentIds

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"documentIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"condominium": {"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"id": "string",
"isLatest": true,
"numericId": "string",
"objectId": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"ownerId": "string",
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "CONDOMINIUM_STATUS_NOT_ACTIVATED",
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"updatedAt": "string"
}
}

CondominiumService_Deactivate

path Parameters

required

string

Request Body schema: application/json
required

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
default

Content type

application/json

{"condominium": {"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"id": "string",
"isLatest": true,
"numericId": "string",
"objectId": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"ownerId": "string",
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "CONDOMINIUM_STATUS_NOT_ACTIVATED",
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"updatedAt": "string"
}
}

CondominiumService_RemoveDocuments

path Parameters

required

string

Request Body schema: application/json
required

documentIds

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"documentIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"condominium": {"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"id": "string",
"isLatest": true,
"numericId": "string",
"objectId": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"ownerId": "string",
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "CONDOMINIUM_STATUS_NOT_ACTIVATED",
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"updatedAt": "string"
}
}

Update

path Parameters

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

Payload

Content type

application/json

{"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
]
}

Response samples

200
default

Content type

application/json

{"condominium": {"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"id": "string",
"isLatest": true,
"numericId": "string",
"objectId": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"ownerId": "string",
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "CONDOMINIUM_STATUS_NOT_ACTIVATED",
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"updatedAt": "string"
}
}

CondominiumService_DeactivateByNumericId

path Parameters

numericId

required

string <int64>

Request Body schema: application/json
required

ownerId

string <int64>

Responses

Request samples

Payload

Content type

application/json

{"ownerId": "string"
}

Response samples

200
default

Content type

application/json

{"condominium": {"activated": true,
"closed": true,
"contract": {"amendments": "string",
"intendedUse": "string",
"licensePlate": "string",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"documentIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"finalInvoiceCreated": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"id": "string",
"isLatest": true,
"numericId": "string",
"objectId": "string",
"opted": true,
"owner": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"numberOfPersons": 0,
"roommateContactIds": ["string"
]
},
"ownerId": "string",
"rent": {"adjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
]
}
]
},
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "CONDOMINIUM_STATUS_NOT_ACTIVATED",
"taxable": true,
"tenants": [{"contactIds": ["string"
],
"correspondenceContactId": "string",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"updatedAt": "string"
}
}

TenancyService

TenancyService_CloseTenancies

Request Body schema: application/json
required

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

Create

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

Payload

Content type

application/json

{"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}

Response samples

200
default

Content type

application/json

{"tenancy": {"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
}

TenancyService_DeleteRentAdjustments

Request Body schema: application/json
required

required

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

Payload

Content type

application/json

{"byDate": {"day": 0,
"month": 0,
"year": 0
},
"objectIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

Read

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{"tenancy": {"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
}

TenancyService_HasActivatedTenancy

Request Body schema: application/json
required

objectIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"objectIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"entries": [{"hasActivatedTenancy": true,
"objectId": "string"
}
]
}

TenancyService_List

Request Body schema: application/json
required

objectIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"objectIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"tenancies": [{"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
]
}

TenancyService_ListByBillingContactId

path Parameters

billingContactId

required

string

Responses

Response samples

200
default

Content type

application/json

{"tenancies": [{"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
]
}

TenancyService_ListByContactId

path Parameters

contactId

required

string

query Parameters

billingContact	boolean
tenants	boolean
correspondence	boolean
guarantors	boolean
subTenants	boolean

Responses

Response samples

200
default

Content type

application/json

{"tenancies": [{"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
]
}

TenancyService_ListByDateAndObjectIds

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

Payload

Content type

application/json

{"endDate": {"day": 0,
"month": 0,
"year": 0
},
"includeTenancies": true,
"includeVacancies": true,
"objectIds": ["string"
],
"startDate": {"day": 0,
"month": 0,
"year": 0
}
}

Response samples

200
default

Content type

application/json

{"tenancies": [{"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
]
}

TenancyService_ListByGuarantor

path Parameters

guarantorContactId

required

string

Responses

Response samples

200
default

Content type

application/json

{"tenancies": [{"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
]
}

TenancyService_ListByIds

Request Body schema: application/json
required

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{"tenancies": [{"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
]
}

TenancyService_ListByOwner

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

200
default

Content type

application/json

{"tenancies": [{"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
],
"totalPageCount": 0,
"totalTenanciesCount": 0
}

TenancyService_ListByTenant

path Parameters

ownerId required	string <int64>
tenantContactId required	string

Responses

Response samples

200
default

Content type

application/json

{"tenancies": [{"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
]
}

TenancyService_ListCurrentByObjectIds

Request Body schema: application/json
required

objectIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"objectIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"tenancies": [{"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
]
}

TenancyService_PublishUpdatedEvents

Request Body schema: application/json
required

ownerIds

required

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

Responses

Request samples

Payload

Content type

application/json

{"ownerIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

TenancyService_UpdateBulk

Request Body schema: application/json
required

required

Array of objects (objecttenancyUpdateBulkEntry)

Responses

Request samples

Payload

Content type

application/json

{"entries": [{"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"objectId": "string",
"opted": true,
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
]
}

Response samples

200
default

Content type

application/json

{"tenancies": [{"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
]
}

Delete

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{ }

TenancyService_Activate

path Parameters

required

string

Request Body schema: application/json
required

documentIds

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"documentIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"tenancy": {"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
}

Document

path Parameters

required

string

Request Body schema: application/json
required

documentIds

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"documentIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"tenancy": {"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
}

TenancyService_Deactivate

path Parameters

required

string

Request Body schema: application/json
required

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
default

Content type

application/json

{"tenancy": {"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
}

TenancyService_RemoveDocuments

path Parameters

required

string

Request Body schema: application/json
required

documentIds

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"documentIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"tenancy": {"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
}

TenancyService_SetTermination

path Parameters

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

Payload

Content type

application/json

{"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"reasonForTermination": "string",
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"terminateAt": {"day": 0,
"month": 0,
"year": 0
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationType": "TERMINATION_TYPE_UNDEFINED"
}

Response samples

200
default

Content type

application/json

{"tenancy": {"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
}

Update

path Parameters

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

Payload

Content type

application/json

{"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"objectId": "string",
"opted": true,
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}

Response samples

200
default

Content type

application/json

{"tenancy": {"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
}

TenancyService_DeactivateByNumericId

path Parameters

numericId

required

string <int64>

Request Body schema: application/json
required

ownerId

string <int64>

Responses

Request samples

Payload

Content type

application/json

{"ownerId": "string"
}

Response samples

200
default

Content type

application/json

{"tenancy": {"activated": true,
"closed": true,
"contract": {"activationDate": {"day": 0,
"month": 0,
"year": 0
},
"creationDate": {"day": 0,
"month": 0,
"year": 0
},
"intendedUse": "string",
"licensePlate": "string",
"number": "string",
"rentType": "RENT_TYPE_UNDEFINED",
"type": "UNDEFINED_CONTRACT_TYPE",
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
},
"contractAmendments": "string",
"deposit": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"amount": 0.1,
"bankAccount": "string",
"bankName": "string",
"bic": "string",
"certificateReceivedAt": {"day": 0,
"month": 0,
"year": 0
},
"clearingNumber": 0,
"depositShares": [{"amount": 0.1,
"contactId": "string"
}
],
"dividedBySeveralPersons": true,
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"insuranceCompany": "string",
"note": "string",
"paidAmount": 0.1,
"paidAt": {"day": 0,
"month": 0,
"year": 0
},
"paidOut": true,
"paidOutAmount": 0.1,
"paidOutAt": {"day": 0,
"month": 0,
"year": 0
},
"policyNumber": "string",
"type": "DEPOSIT_TYPE_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
},
"validUntil": {"day": 0,
"month": 0,
"year": 0
}
},
"desiredMoveOutAt": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"earlyRightOfTerminationOptions": [{"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
}
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"familyFlat": true,
"finalInvoiceCreated": true,
"id": "string",
"indexData": {"additionalCostsAdjustmentAllowed": true,
"belowInitialRentAllowed": true,
"contractPercentImputedAtIndex": 0.1,
"maximumRate": 0.1,
"referenceMonthForIndex": 0,
"rentAdjustmentAdditionalBenefit": true,
"rentAdjustmentByMonths": 0,
"rentAdjustmentByPoints": 0,
"rentAdjustmentMonths": [0
],
"rentAdjustmentNotification": {"unit": "RENT_ADJUSTMENT_NOTIFICATION_DAYS",
"value": 0
}
},
"isLatest": true,
"liabilityEndsAt": {"day": 0,
"month": 0,
"year": 0
},
"movedOutAt": {"day": 0,
"month": 0,
"year": 0
},
"nextPossibleMoveInAt": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"numericId": "string",
"objectId": "string",
"opted": true,
"ownerId": "string",
"reasonForTermination": "string",
"renewalOptions": [{"automaticExtending": true,
"exerciseUntil": {"day": 0,
"month": 0,
"year": 0
},
"from": {"day": 0,
"month": 0,
"year": 0
},
"type": "RENEWAL_OPTION_TYPE_UNDEFINED",
"until": {"day": 0,
"month": 0,
"year": 0
},
"used": true
}
],
"rent": {"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"adjustments": [{"additionalCosts": 0.1,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"additionalCostsPerMonth": 0.1,
"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"calculationBasis": "TENANCY_CALCULATION_BASIS_DEFAULT",
"clearJustificationInitialRent": "string",
"coldRent": 0.1,
"coldRentM2PerYear": 0.1,
"coldRentPerMonth": 0.1,
"costIncreaseDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreasePossibleDate": {"day": 0,
"month": 0,
"year": 0
},
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"documentIds": ["string"
],
"dueDates": [0
],
"finalized": true,
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"grossRent": 0.1,
"grossRentPerMonth": 0.1,
"heatingCosts": 0.1,
"inArrears": true,
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
},
"retentionOfRents": [{"actual": 0.1,
"inPercent": true,
"possible": 0.1,
"remark": "string",
"type": "RETENTION_OF_RENT_INSUFFICIENT_GROSS_RENT"
}
]
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"coldRent": 0.1,
"costIncreaseDate": "string",
"costIncreaseType": "COST_INCREASE_TYPE_UNDEFINED",
"costIncreaseValue": 0.1,
"countryIndex": {"baseDate": "string",
"date": {"day": 0,
"month": 0,
"year": 0
},
"inflation": 0.1,
"possibleDate": {"day": 0,
"month": 0,
"year": 0
},
"possibleInflation": 0.1
},
"dueDates": [0
],
"firstRentAdjustmentPossibleAt": {"day": 0,
"month": 0,
"year": 0
},
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"heatingCosts": 0.1,
"inArrears": true,
"interval": "UNDEFINED_TENANCY_PAYMENT_INTERVAL",
"monthlyRentDueBy": 0,
"referenceInterestRate": {"date": {"day": 0,
"month": 0,
"year": 0
},
"rate": 0.1,
"ratePossible": 0.1
}
},
"returningAt": {"day": 0,
"month": 0,
"year": 0
},
"roommates": [{"birthday": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
}
],
"secondaryResidence": true,
"startingAt": {"day": 0,
"month": 0,
"year": 0
},
"status": "TENANCY_STATUS_NOT_ACTIVATED",
"subTenants": [{"contactIds": ["string"
],
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
}
],
"taxable": true,
"tenant": {"billingContactId": "string",
"contactIds": ["string"
],
"correspondenceContactId": "string",
"guarantorContactIds": ["string"
],
"industryCode": 0,
"industryName": "string",
"numberOfPersons": 0,
"type": "UNDEFINED_TENANT_TYPE"
},
"terminatedBy": "TERMINATED_BY_UNDEFINED",
"terminatedOn": {"day": 0,
"month": 0,
"year": 0
},
"terminationCreatedAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationJustification": "string",
"terminationLandlord": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationReason": ["TERMINATION_REASON_UNDEFINED"
],
"terminationSentByTenantAt": {"day": 0,
"month": 0,
"year": 0
},
"terminationTenant": {"earliestDate": {"day": 0,
"month": 0,
"year": 0
},
"periodInMonths": 0,
"possibleMonths": [0
],
"tacitContractRenewal": "TACIT_CONTRACT_RENEWAL_UNDEFINED"
},
"terminationType": "TERMINATION_TYPE_UNDEFINED",
"unjustifiedUse": {"from": {"day": 0,
"month": 0,
"year": 0
},
"until": {"day": 0,
"month": 0,
"year": 0
}
},
"updatedAt": "string",
"vacancy": true,
"vacancyReason": "VACANCY_REASON_UNDEFINED"
}
}

MortgageService

Create

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

Payload

Content type

application/json

{"amortisationAmount": 0.1,
"amortizationFrom": {"day": 0,
"month": 0,
"year": 0
},
"amortizations": [{"amount": 0.1,
"byDate": {"day": 0,
"month": 0,
"year": 0
}
}
],
"amount": 0.1,
"bankCountry": "string",
"bankName": "string",
"bankNumber": "string",
"bic": "string",
"carryingAmount": 0.1,
"debitAccount": "string",
"designation": "string",
"documentIds": ["string"
],
"dueDateMonthsAmortization": [0
],
"dueDateMonthsInterestRate": [0
],
"enableAmortizations": true,
"expiresAt": {"day": 0,
"month": 0,
"year": 0
},
"interestRate": 0.1,
"mortgageDesignation": "MORTGAGE_DESIGNATION_UNDEFINED",
"mortgageeAddress": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"number": "string",
"ownerId": "string",
"referenceId": "string",
"terminableOn": "MORTGAGE_TERMINABLE_ON_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}

Response samples

200
default

Content type

application/json

{"mortgage": {"amortisationAmount": 0.1,
"amortizationFrom": {"day": 0,
"month": 0,
"year": 0
},
"amortizations": [{"amount": 0.1,
"byDate": {"day": 0,
"month": 0,
"year": 0
}
}
],
"amount": 0.1,
"bankCountry": "string",
"bankName": "string",
"bankNumber": "string",
"bic": "string",
"carryingAmount": 0.1,
"debitAccount": "string",
"designation": "string",
"documentIds": ["string"
],
"dueDateMonthsAmortization": [0
],
"dueDateMonthsInterestRate": [0
],
"enableAmortizations": true,
"expiresAt": {"day": 0,
"month": 0,
"year": 0
},
"id": "string",
"interestRate": 0.1,
"mortgageDesignation": "MORTGAGE_DESIGNATION_UNDEFINED",
"mortgageeAddress": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"number": "string",
"numericId": "string",
"ownerId": "string",
"referenceId": "string",
"terminableOn": "MORTGAGE_TERMINABLE_ON_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
}

Read

Request Body schema: application/json
required

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{"mortgages": [{"amortisationAmount": 0.1,
"amortizationFrom": {"day": 0,
"month": 0,
"year": 0
},
"amortizations": [{"amount": 0.1,
"byDate": {"day": 0,
"month": 0,
"year": 0
}
}
],
"amount": 0.1,
"bankCountry": "string",
"bankName": "string",
"bankNumber": "string",
"bic": "string",
"carryingAmount": 0.1,
"debitAccount": "string",
"designation": "string",
"documentIds": ["string"
],
"dueDateMonthsAmortization": [0
],
"dueDateMonthsInterestRate": [0
],
"enableAmortizations": true,
"expiresAt": {"day": 0,
"month": 0,
"year": 0
},
"id": "string",
"interestRate": 0.1,
"mortgageDesignation": "MORTGAGE_DESIGNATION_UNDEFINED",
"mortgageeAddress": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"number": "string",
"numericId": "string",
"ownerId": "string",
"referenceId": "string",
"terminableOn": "MORTGAGE_TERMINABLE_ON_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
]
}

MortgageService_ListByReferenceIds

Request Body schema: application/json
required

referenceIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"referenceIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"mortgages": [{"amortisationAmount": 0.1,
"amortizationFrom": {"day": 0,
"month": 0,
"year": 0
},
"amortizations": [{"amount": 0.1,
"byDate": {"day": 0,
"month": 0,
"year": 0
}
}
],
"amount": 0.1,
"bankCountry": "string",
"bankName": "string",
"bankNumber": "string",
"bic": "string",
"carryingAmount": 0.1,
"debitAccount": "string",
"designation": "string",
"documentIds": ["string"
],
"dueDateMonthsAmortization": [0
],
"dueDateMonthsInterestRate": [0
],
"enableAmortizations": true,
"expiresAt": {"day": 0,
"month": 0,
"year": 0
},
"id": "string",
"interestRate": 0.1,
"mortgageDesignation": "MORTGAGE_DESIGNATION_UNDEFINED",
"mortgageeAddress": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"number": "string",
"numericId": "string",
"ownerId": "string",
"referenceId": "string",
"terminableOn": "MORTGAGE_TERMINABLE_ON_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
]
}

Delete

path Parameters

ids

required

Array of strings non-empty

Responses

Response samples

200
default

Content type

application/json

{ }

MortgageService_AddDocuments

path Parameters

required

string

Request Body schema: application/json
required

documentIds

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"documentIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

Update

path Parameters

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

Payload

Content type

application/json

{"amortisationAmount": 0.1,
"amortizationFrom": {"day": 0,
"month": 0,
"year": 0
},
"amortizations": [{"amount": 0.1,
"byDate": {"day": 0,
"month": 0,
"year": 0
}
}
],
"amount": 0.1,
"bankCountry": "string",
"bankName": "string",
"bankNumber": "string",
"bic": "string",
"carryingAmount": 0.1,
"debitAccount": "string",
"designation": "string",
"documentIds": ["string"
],
"dueDateMonthsAmortization": [0
],
"dueDateMonthsInterestRate": [0
],
"enableAmortizations": true,
"expiresAt": {"day": 0,
"month": 0,
"year": 0
},
"interestRate": 0.1,
"mortgageDesignation": "MORTGAGE_DESIGNATION_UNDEFINED",
"mortgageeAddress": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"number": "string",
"referenceId": "string",
"terminableOn": "MORTGAGE_TERMINABLE_ON_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}

Response samples

200
default

Content type

application/json

{"mortgage": {"amortisationAmount": 0.1,
"amortizationFrom": {"day": 0,
"month": 0,
"year": 0
},
"amortizations": [{"amount": 0.1,
"byDate": {"day": 0,
"month": 0,
"year": 0
}
}
],
"amount": 0.1,
"bankCountry": "string",
"bankName": "string",
"bankNumber": "string",
"bic": "string",
"carryingAmount": 0.1,
"debitAccount": "string",
"designation": "string",
"documentIds": ["string"
],
"dueDateMonthsAmortization": [0
],
"dueDateMonthsInterestRate": [0
],
"enableAmortizations": true,
"expiresAt": {"day": 0,
"month": 0,
"year": 0
},
"id": "string",
"interestRate": 0.1,
"mortgageDesignation": "MORTGAGE_DESIGNATION_UNDEFINED",
"mortgageeAddress": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"number": "string",
"numericId": "string",
"ownerId": "string",
"referenceId": "string",
"terminableOn": "MORTGAGE_TERMINABLE_ON_UNDEFINED",
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
}

InvestPlanService

InvestPlanService_CreateBulk

Request Body schema: application/json
required

required	Array of objects (invest_planCreateBulkEntry)
required	Array of objects (invest_planCreateBulkPlanEntry)

Responses

Request samples

Payload

Content type

application/json

{"entries": [{"bkp": "string",
"costs": 0.1,
"futurePercentage": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"name": "string",
"note": "string",
"optionalValueEnhancingComponent": true,
"ownerId": "string",
"percentage": 0.1,
"plannedCosts": 0.1,
"plannedReplacementDate": {"day": 0,
"month": 0,
"year": 0
},
"referenceId": "string"
}
],
"plans": [{"bkp": "string",
"costs": 0.1,
"date": {"day": 0,
"month": 0,
"year": 0
},
"name": "string",
"ownerId": "string",
"referenceId": "string"
}
]
}

Response samples

200
default

Content type

application/json

{"components": [{"bkp": "string",
"costs": 0.1,
"futurePercentage": 0.1,
"id": "string",
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"name": "string",
"note": "string",
"optionalValueEnhancingComponent": true,
"ownerId": "string",
"percentage": 0.1,
"plannedCosts": 0.1,
"plannedReplacementDate": {"day": 0,
"month": 0,
"year": 0
},
"referenceId": "string"
}
],
"plans": [{"bkp": "string",
"costs": 0.1,
"date": {"day": 0,
"month": 0,
"year": 0
},
"id": "string",
"name": "string",
"ownerId": "string",
"referenceId": "string"
}
]
}

InvestPlanService_Delete

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{ }

InvestPlanService_Enable

Request Body schema: application/json
required

required

Array of objects (invest_planEnableEntry)

Responses

Request samples

Payload

Content type

application/json

{"entries": [{"buildingId": "string",
"enable": true
}
]
}

Response samples

200
default

Content type

application/json

{ }

Feature enabling

Request Body schema: application/json
required

buildingIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"buildingIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"entries": [{"buildingId": "string",
"enabled": true
}
]
}

InvestPlanService_ListByReferenceIds

Request Body schema: application/json
required

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{"components": [{"bkp": "string",
"costs": 0.1,
"futurePercentage": 0.1,
"id": "string",
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"name": "string",
"note": "string",
"optionalValueEnhancingComponent": true,
"ownerId": "string",
"percentage": 0.1,
"plannedCosts": 0.1,
"plannedReplacementDate": {"day": 0,
"month": 0,
"year": 0
},
"referenceId": "string"
}
],
"plans": [{"bkp": "string",
"costs": 0.1,
"date": {"day": 0,
"month": 0,
"year": 0
},
"id": "string",
"name": "string",
"ownerId": "string",
"referenceId": "string"
}
]
}

InvestPlanService_UpdateBulk

Request Body schema: application/json
required

required	Array of objects (objectinvest_planUpdateBulkEntry)
required	Array of objects (invest_planUpdateBulkPlanEntry)

Responses

Request samples

Payload

Content type

application/json

{"entries": [{"bkp": "string",
"costs": 0.1,
"futurePercentage": 0.1,
"id": "string",
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"name": "string",
"note": "string",
"optionalValueEnhancingComponent": true,
"percentage": 0.1,
"plannedCosts": 0.1,
"plannedReplacementDate": {"day": 0,
"month": 0,
"year": 0
}
}
],
"plans": [{"bkp": "string",
"costs": 0.1,
"date": {"day": 0,
"month": 0,
"year": 0
},
"id": "string",
"name": "string"
}
]
}

Response samples

200
default

Content type

application/json

{"components": [{"bkp": "string",
"costs": 0.1,
"futurePercentage": 0.1,
"id": "string",
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"name": "string",
"note": "string",
"optionalValueEnhancingComponent": true,
"ownerId": "string",
"percentage": 0.1,
"plannedCosts": 0.1,
"plannedReplacementDate": {"day": 0,
"month": 0,
"year": 0
},
"referenceId": "string"
}
],
"plans": [{"bkp": "string",
"costs": 0.1,
"date": {"day": 0,
"month": 0,
"year": 0
},
"id": "string",
"name": "string",
"ownerId": "string",
"referenceId": "string"
}
]
}

BriefbutlerService

BriefbutlerService_AcknowledgeErrors

query Parameters

ids	Array of strings

Responses

Response samples

200
default

Content type

application/json

{ }

BriefbutlerService_ListErrorsByAccountId

query Parameters

ownerId

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"errors": [{"entityId": "string",
"errorMessage": "string",
"id": "string",
"mediaId": "string",
"renderId": "string",
"timestamp": "string"
}
]
}

Settings

query Parameters

accountId

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"enabled": true,
"profiles": [{"briefbutlerId": "string",
"description": "string"
}
]
}

BriefbutlerService_SaveSettings

Request Body schema: application/json
required

accountId required	string <int64>
enabled required	boolean
required	Array of objects (briefbutlerBriefbutlerProfile)

Responses

Request samples

Payload

Content type

application/json

{"accountId": "string",
"enabled": true,
"profiles": [{"briefbutlerId": "string",
"description": "string"
}
]
}

Response samples

200
default

Content type

application/json

{ }

BriefbutlerService_SendRawDocument

Request Body schema: application/json
required

briefbutlerId required	string
mediaId required	string

Responses

Request samples

Payload

Content type

application/json

{"briefbutlerId": "string",
"mediaId": "string"
}

Response samples

200
default

Content type

application/json

{ }

BuildingService

BuildingService_AddBuildingContacts

Request Body schema: application/json
required

required	Array of objects (buildingBuildingContact)
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"buildingContacts": [{"id": "string",
"note": "string",
"type": "BUILDING_CONTACT_TYPE_UNDEFINED"
}
],
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

BuildingService_AddDocuments

Request Body schema: application/json
required

documentIds required	Array of strings
id required	string

Responses

Request samples

Payload

Content type

application/json

{"documentIds": ["string"
],
"id": "string"
}

Response samples

200
default

Content type

application/json

{"building": {"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"buildingArea": 0.1,
"buildingStrategy": {"reviewAt": {"day": 0,
"month": 0,
"year": 0
},
"type": "BUILDING_STRATEGY_TYPE_UNDEFINED"
},
"buildingValue": "string",
"buildingZone": "string",
"characteristics": {"broadbandInternet": true,
"cableTv": true,
"chargingStation": true,
"childFriendly": true,
"communityGarden": true,
"conciergeService": true,
"elevator": true,
"fiberGlass": true,
"intercom": true,
"isdn": true,
"park": true,
"playground": true,
"satellite": true
},
"constructionTypes": ["UNDEFINED_CONSTRUCTION_TYPE"
],
"constructionYear": 0,
"contacts": [{"id": "string",
"note": "string",
"type": "BUILDING_CONTACT_TYPE_UNDEFINED"
}
],
"contractAmendments": "string",
"distances": {"kindergarten": 0.1,
"motorway": 0.1,
"primarySchool": 0.1,
"publicTransport": 0.1,
"shop": 0.1,
"upperSchool": 0.1
},
"documentIds": ["string"
],
"egid": "string",
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"floors": 0,
"id": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"locationQuality": "UNDEFINED_LOCATION_QUALITY",
"name": "string",
"note": "string",
"number": 0,
"numericId": "string",
"objectIds": ["string"
],
"onboardingFinished": true,
"ownerId": "string",
"plotArea": 0.1,
"plotIds": ["string"
],
"rating": {"microLocationRating": 0.1,
"microLocationRatingProposal": 0.1
},
"realEstateNumber": "string",
"renovationYear": 0,
"sia": {"siaAff": 0.1,
"siaAgf": 0.1,
"siaAkf": 0.1,
"siaAkfn": 0.1,
"siaAkft": 0.1,
"siaAnf": 0.1,
"siaAngf": 0.1,
"siaAvf": 0.1,
"siaBuf": 0.1,
"siaFf": 0.1,
"siaGf": 0.1,
"siaGgf": 0.1,
"siaGsf": 0.1,
"siaHnf": 0.1,
"siaHnf1": 0.1,
"siaHnf2": 0.1,
"siaHnf3": 0.1,
"siaHnf4": 0.1,
"siaHnf5": 0.1,
"siaHnf6": 0.1,
"siaKf": 0.1,
"siaKfn": 0.1,
"siaKft": 0.1,
"siaNf": 0.1,
"siaNgf": 0.1,
"siaNnf": 0.1,
"siaUf": 0.1,
"siaUuf": 0.1,
"siaVf": 0.1
},
"volume": 0.1
}
}

BuildingService_Count

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

200
default

Content type

application/json

{"count": 0
}

Create

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 (buildingBuildingContact)
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

Payload

Content type

application/json

{"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"buildingArea": 0.1,
"buildingStrategy": {"reviewAt": {"day": 0,
"month": 0,
"year": 0
},
"type": "BUILDING_STRATEGY_TYPE_UNDEFINED"
},
"buildingValue": "string",
"buildingZone": "string",
"characteristics": {"broadbandInternet": true,
"cableTv": true,
"chargingStation": true,
"childFriendly": true,
"communityGarden": true,
"conciergeService": true,
"elevator": true,
"fiberGlass": true,
"intercom": true,
"isdn": true,
"park": true,
"playground": true,
"satellite": true
},
"constructionTypes": ["UNDEFINED_CONSTRUCTION_TYPE"
],
"constructionYear": 0,
"contacts": [{"id": "string",
"note": "string",
"type": "BUILDING_CONTACT_TYPE_UNDEFINED"
}
],
"contractAmendments": "string",
"distances": {"kindergarten": 0.1,
"motorway": 0.1,
"primarySchool": 0.1,
"publicTransport": 0.1,
"shop": 0.1,
"upperSchool": 0.1
},
"documentIds": ["string"
],
"egid": "string",
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"floors": 0,
"imageMediaId": "string",
"landRegisterNumber": "string",
"locationQuality": "UNDEFINED_LOCATION_QUALITY",
"name": "string",
"note": "string",
"number": 0,
"numericId": "string",
"objectIds": ["string"
],
"ownerId": "string",
"plotArea": 0.1,
"plotIds": ["string"
],
"rating": {"microLocationRating": 0.1,
"microLocationRatingProposal": 0.1
},
"realEstateNumber": "string",
"renovationYear": 0,
"sia": {"siaAff": 0.1,
"siaAgf": 0.1,
"siaAkf": 0.1,
"siaAkfn": 0.1,
"siaAkft": 0.1,
"siaAnf": 0.1,
"siaAngf": 0.1,
"siaAvf": 0.1,
"siaBuf": 0.1,
"siaFf": 0.1,
"siaGf": 0.1,
"siaGgf": 0.1,
"siaGsf": 0.1,
"siaHnf": 0.1,
"siaHnf1": 0.1,
"siaHnf2": 0.1,
"siaHnf3": 0.1,
"siaHnf4": 0.1,
"siaHnf5": 0.1,
"siaHnf6": 0.1,
"siaKf": 0.1,
"siaKfn": 0.1,
"siaKft": 0.1,
"siaNf": 0.1,
"siaNgf": 0.1,
"siaNnf": 0.1,
"siaUf": 0.1,
"siaUuf": 0.1,
"siaVf": 0.1
},
"volume": 0.1
}

Response samples

200
default

Content type

application/json

{"building": {"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"buildingArea": 0.1,
"buildingStrategy": {"reviewAt": {"day": 0,
"month": 0,
"year": 0
},
"type": "BUILDING_STRATEGY_TYPE_UNDEFINED"
},
"buildingValue": "string",
"buildingZone": "string",
"characteristics": {"broadbandInternet": true,
"cableTv": true,
"chargingStation": true,
"childFriendly": true,
"communityGarden": true,
"conciergeService": true,
"elevator": true,
"fiberGlass": true,
"intercom": true,
"isdn": true,
"park": true,
"playground": true,
"satellite": true
},
"constructionTypes": ["UNDEFINED_CONSTRUCTION_TYPE"
],
"constructionYear": 0,
"contacts": [{"id": "string",
"note": "string",
"type": "BUILDING_CONTACT_TYPE_UNDEFINED"
}
],
"contractAmendments": "string",
"distances": {"kindergarten": 0.1,
"motorway": 0.1,
"primarySchool": 0.1,
"publicTransport": 0.1,
"shop": 0.1,
"upperSchool": 0.1
},
"documentIds": ["string"
],
"egid": "string",
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"floors": 0,
"id": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"locationQuality": "UNDEFINED_LOCATION_QUALITY",
"name": "string",
"note": "string",
"number": 0,
"numericId": "string",
"objectIds": ["string"
],
"onboardingFinished": true,
"ownerId": "string",
"plotArea": 0.1,
"plotIds": ["string"
],
"rating": {"microLocationRating": 0.1,
"microLocationRatingProposal": 0.1
},
"realEstateNumber": "string",
"renovationYear": 0,
"sia": {"siaAff": 0.1,
"siaAgf": 0.1,
"siaAkf": 0.1,
"siaAkfn": 0.1,
"siaAkft": 0.1,
"siaAnf": 0.1,
"siaAngf": 0.1,
"siaAvf": 0.1,
"siaBuf": 0.1,
"siaFf": 0.1,
"siaGf": 0.1,
"siaGgf": 0.1,
"siaGsf": 0.1,
"siaHnf": 0.1,
"siaHnf1": 0.1,
"siaHnf2": 0.1,
"siaHnf3": 0.1,
"siaHnf4": 0.1,
"siaHnf5": 0.1,
"siaHnf6": 0.1,
"siaKf": 0.1,
"siaKfn": 0.1,
"siaKft": 0.1,
"siaNf": 0.1,
"siaNgf": 0.1,
"siaNnf": 0.1,
"siaUf": 0.1,
"siaUuf": 0.1,
"siaVf": 0.1
},
"volume": 0.1
}
}

BuildingService_EditContactNote

Request Body schema: application/json
required

required	Array of objects (buildingBuildingContact)
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"buildingContacts": [{"id": "string",
"note": "string",
"type": "BUILDING_CONTACT_TYPE_UNDEFINED"
}
],
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

Read

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{"building": {"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"buildingArea": 0.1,
"buildingStrategy": {"reviewAt": {"day": 0,
"month": 0,
"year": 0
},
"type": "BUILDING_STRATEGY_TYPE_UNDEFINED"
},
"buildingValue": "string",
"buildingZone": "string",
"characteristics": {"broadbandInternet": true,
"cableTv": true,
"chargingStation": true,
"childFriendly": true,
"communityGarden": true,
"conciergeService": true,
"elevator": true,
"fiberGlass": true,
"intercom": true,
"isdn": true,
"park": true,
"playground": true,
"satellite": true
},
"constructionTypes": ["UNDEFINED_CONSTRUCTION_TYPE"
],
"constructionYear": 0,
"contacts": [{"id": "string",
"note": "string",
"type": "BUILDING_CONTACT_TYPE_UNDEFINED"
}
],
"contractAmendments": "string",
"distances": {"kindergarten": 0.1,
"motorway": 0.1,
"primarySchool": 0.1,
"publicTransport": 0.1,
"shop": 0.1,
"upperSchool": 0.1
},
"documentIds": ["string"
],
"egid": "string",
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"floors": 0,
"id": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"locationQuality": "UNDEFINED_LOCATION_QUALITY",
"name": "string",
"note": "string",
"number": 0,
"numericId": "string",
"objectIds": ["string"
],
"onboardingFinished": true,
"ownerId": "string",
"plotArea": 0.1,
"plotIds": ["string"
],
"rating": {"microLocationRating": 0.1,
"microLocationRatingProposal": 0.1
},
"realEstateNumber": "string",
"renovationYear": 0,
"sia": {"siaAff": 0.1,
"siaAgf": 0.1,
"siaAkf": 0.1,
"siaAkfn": 0.1,
"siaAkft": 0.1,
"siaAnf": 0.1,
"siaAngf": 0.1,
"siaAvf": 0.1,
"siaBuf": 0.1,
"siaFf": 0.1,
"siaGf": 0.1,
"siaGgf": 0.1,
"siaGsf": 0.1,
"siaHnf": 0.1,
"siaHnf1": 0.1,
"siaHnf2": 0.1,
"siaHnf3": 0.1,
"siaHnf4": 0.1,
"siaHnf5": 0.1,
"siaHnf6": 0.1,
"siaKf": 0.1,
"siaKfn": 0.1,
"siaKft": 0.1,
"siaNf": 0.1,
"siaNgf": 0.1,
"siaNnf": 0.1,
"siaUf": 0.1,
"siaUuf": 0.1,
"siaVf": 0.1
},
"volume": 0.1
}
}

BuildingService_GetByObjectId

path Parameters

objectId

required

string

Responses

Response samples

200
default

Content type

application/json

{"building": {"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"buildingArea": 0.1,
"buildingStrategy": {"reviewAt": {"day": 0,
"month": 0,
"year": 0
},
"type": "BUILDING_STRATEGY_TYPE_UNDEFINED"
},
"buildingValue": "string",
"buildingZone": "string",
"characteristics": {"broadbandInternet": true,
"cableTv": true,
"chargingStation": true,
"childFriendly": true,
"communityGarden": true,
"conciergeService": true,
"elevator": true,
"fiberGlass": true,
"intercom": true,
"isdn": true,
"park": true,
"playground": true,
"satellite": true
},
"constructionTypes": ["UNDEFINED_CONSTRUCTION_TYPE"
],
"constructionYear": 0,
"contacts": [{"id": "string",
"note": "string",
"type": "BUILDING_CONTACT_TYPE_UNDEFINED"
}
],
"contractAmendments": "string",
"distances": {"kindergarten": 0.1,
"motorway": 0.1,
"primarySchool": 0.1,
"publicTransport": 0.1,
"shop": 0.1,
"upperSchool": 0.1
},
"documentIds": ["string"
],
"egid": "string",
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"floors": 0,
"id": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"locationQuality": "UNDEFINED_LOCATION_QUALITY",
"name": "string",
"note": "string",
"number": 0,
"numericId": "string",
"objectIds": ["string"
],
"onboardingFinished": true,
"ownerId": "string",
"plotArea": 0.1,
"plotIds": ["string"
],
"rating": {"microLocationRating": 0.1,
"microLocationRatingProposal": 0.1
},
"realEstateNumber": "string",
"renovationYear": 0,
"sia": {"siaAff": 0.1,
"siaAgf": 0.1,
"siaAkf": 0.1,
"siaAkfn": 0.1,
"siaAkft": 0.1,
"siaAnf": 0.1,
"siaAngf": 0.1,
"siaAvf": 0.1,
"siaBuf": 0.1,
"siaFf": 0.1,
"siaGf": 0.1,
"siaGgf": 0.1,
"siaGsf": 0.1,
"siaHnf": 0.1,
"siaHnf1": 0.1,
"siaHnf2": 0.1,
"siaHnf3": 0.1,
"siaHnf4": 0.1,
"siaHnf5": 0.1,
"siaHnf6": 0.1,
"siaKf": 0.1,
"siaKfn": 0.1,
"siaKft": 0.1,
"siaNf": 0.1,
"siaNgf": 0.1,
"siaNnf": 0.1,
"siaUf": 0.1,
"siaUuf": 0.1,
"siaVf": 0.1
},
"volume": 0.1
}
}

BuildingService_List

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

200
default

Content type

application/json

{"buildings": [{"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"buildingArea": 0.1,
"buildingStrategy": {"reviewAt": {"day": 0,
"month": 0,
"year": 0
},
"type": "BUILDING_STRATEGY_TYPE_UNDEFINED"
},
"buildingValue": "string",
"buildingZone": "string",
"characteristics": {"broadbandInternet": true,
"cableTv": true,
"chargingStation": true,
"childFriendly": true,
"communityGarden": true,
"conciergeService": true,
"elevator": true,
"fiberGlass": true,
"intercom": true,
"isdn": true,
"park": true,
"playground": true,
"satellite": true
},
"constructionTypes": ["UNDEFINED_CONSTRUCTION_TYPE"
],
"constructionYear": 0,
"contacts": [{"id": "string",
"note": "string",
"type": "BUILDING_CONTACT_TYPE_UNDEFINED"
}
],
"contractAmendments": "string",
"distances": {"kindergarten": 0.1,
"motorway": 0.1,
"primarySchool": 0.1,
"publicTransport": 0.1,
"shop": 0.1,
"upperSchool": 0.1
},
"documentIds": ["string"
],
"egid": "string",
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"floors": 0,
"id": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"locationQuality": "UNDEFINED_LOCATION_QUALITY",
"name": "string",
"note": "string",
"number": 0,
"numericId": "string",
"objectIds": ["string"
],
"onboardingFinished": true,
"ownerId": "string",
"plotArea": 0.1,
"plotIds": ["string"
],
"rating": {"microLocationRating": 0.1,
"microLocationRatingProposal": 0.1
},
"realEstateNumber": "string",
"renovationYear": 0,
"sia": {"siaAff": 0.1,
"siaAgf": 0.1,
"siaAkf": 0.1,
"siaAkfn": 0.1,
"siaAkft": 0.1,
"siaAnf": 0.1,
"siaAngf": 0.1,
"siaAvf": 0.1,
"siaBuf": 0.1,
"siaFf": 0.1,
"siaGf": 0.1,
"siaGgf": 0.1,
"siaGsf": 0.1,
"siaHnf": 0.1,
"siaHnf1": 0.1,
"siaHnf2": 0.1,
"siaHnf3": 0.1,
"siaHnf4": 0.1,
"siaHnf5": 0.1,
"siaHnf6": 0.1,
"siaKf": 0.1,
"siaKfn": 0.1,
"siaKft": 0.1,
"siaNf": 0.1,
"siaNgf": 0.1,
"siaNnf": 0.1,
"siaUf": 0.1,
"siaUuf": 0.1,
"siaVf": 0.1
},
"volume": 0.1
}
],
"totalObjectCount": 0,
"totalPageCount": 0
}

BuildingService_ListAll

path Parameters

accountId

required

string <int64>

The accountId of the user who wants to list the buildings

Responses

Response samples

200
default

Content type

application/json

{"buildings": [{"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"buildingArea": 0.1,
"buildingStrategy": {"reviewAt": {"day": 0,
"month": 0,
"year": 0
},
"type": "BUILDING_STRATEGY_TYPE_UNDEFINED"
},
"buildingValue": "string",
"buildingZone": "string",
"characteristics": {"broadbandInternet": true,
"cableTv": true,
"chargingStation": true,
"childFriendly": true,
"communityGarden": true,
"conciergeService": true,
"elevator": true,
"fiberGlass": true,
"intercom": true,
"isdn": true,
"park": true,
"playground": true,
"satellite": true
},
"constructionTypes": ["UNDEFINED_CONSTRUCTION_TYPE"
],
"constructionYear": 0,
"contacts": [{"id": "string",
"note": "string",
"type": "BUILDING_CONTACT_TYPE_UNDEFINED"
}
],
"contractAmendments": "string",
"distances": {"kindergarten": 0.1,
"motorway": 0.1,
"primarySchool": 0.1,
"publicTransport": 0.1,
"shop": 0.1,
"upperSchool": 0.1
},
"documentIds": ["string"
],
"egid": "string",
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"floors": 0,
"id": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"locationQuality": "UNDEFINED_LOCATION_QUALITY",
"name": "string",
"note": "string",
"number": 0,
"numericId": "string",
"objectIds": ["string"
],
"onboardingFinished": true,
"ownerId": "string",
"plotArea": 0.1,
"plotIds": ["string"
],
"rating": {"microLocationRating": 0.1,
"microLocationRatingProposal": 0.1
},
"realEstateNumber": "string",
"renovationYear": 0,
"sia": {"siaAff": 0.1,
"siaAgf": 0.1,
"siaAkf": 0.1,
"siaAkfn": 0.1,
"siaAkft": 0.1,
"siaAnf": 0.1,
"siaAngf": 0.1,
"siaAvf": 0.1,
"siaBuf": 0.1,
"siaFf": 0.1,
"siaGf": 0.1,
"siaGgf": 0.1,
"siaGsf": 0.1,
"siaHnf": 0.1,
"siaHnf1": 0.1,
"siaHnf2": 0.1,
"siaHnf3": 0.1,
"siaHnf4": 0.1,
"siaHnf5": 0.1,
"siaHnf6": 0.1,
"siaKf": 0.1,
"siaKfn": 0.1,
"siaKft": 0.1,
"siaNf": 0.1,
"siaNgf": 0.1,
"siaNnf": 0.1,
"siaUf": 0.1,
"siaUuf": 0.1,
"siaVf": 0.1
},
"volume": 0.1
}
]
}

BuildingService_ListByContactIds

Request Body schema: application/json
required

contactIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"contactIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"buildings": [{"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"buildingArea": 0.1,
"buildingStrategy": {"reviewAt": {"day": 0,
"month": 0,
"year": 0
},
"type": "BUILDING_STRATEGY_TYPE_UNDEFINED"
},
"buildingValue": "string",
"buildingZone": "string",
"characteristics": {"broadbandInternet": true,
"cableTv": true,
"chargingStation": true,
"childFriendly": true,
"communityGarden": true,
"conciergeService": true,
"elevator": true,
"fiberGlass": true,
"intercom": true,
"isdn": true,
"park": true,
"playground": true,
"satellite": true
},
"constructionTypes": ["UNDEFINED_CONSTRUCTION_TYPE"
],
"constructionYear": 0,
"contacts": [{"id": "string",
"note": "string",
"type": "BUILDING_CONTACT_TYPE_UNDEFINED"
}
],
"contractAmendments": "string",
"distances": {"kindergarten": 0.1,
"motorway": 0.1,
"primarySchool": 0.1,
"publicTransport": 0.1,
"shop": 0.1,
"upperSchool": 0.1
},
"documentIds": ["string"
],
"egid": "string",
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"floors": 0,
"id": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"locationQuality": "UNDEFINED_LOCATION_QUALITY",
"name": "string",
"note": "string",
"number": 0,
"numericId": "string",
"objectIds": ["string"
],
"onboardingFinished": true,
"ownerId": "string",
"plotArea": 0.1,
"plotIds": ["string"
],
"rating": {"microLocationRating": 0.1,
"microLocationRatingProposal": 0.1
},
"realEstateNumber": "string",
"renovationYear": 0,
"sia": {"siaAff": 0.1,
"siaAgf": 0.1,
"siaAkf": 0.1,
"siaAkfn": 0.1,
"siaAkft": 0.1,
"siaAnf": 0.1,
"siaAngf": 0.1,
"siaAvf": 0.1,
"siaBuf": 0.1,
"siaFf": 0.1,
"siaGf": 0.1,
"siaGgf": 0.1,
"siaGsf": 0.1,
"siaHnf": 0.1,
"siaHnf1": 0.1,
"siaHnf2": 0.1,
"siaHnf3": 0.1,
"siaHnf4": 0.1,
"siaHnf5": 0.1,
"siaHnf6": 0.1,
"siaKf": 0.1,
"siaKfn": 0.1,
"siaKft": 0.1,
"siaNf": 0.1,
"siaNgf": 0.1,
"siaNnf": 0.1,
"siaUf": 0.1,
"siaUuf": 0.1,
"siaVf": 0.1
},
"volume": 0.1
}
]
}

BuildingService_ListByCoordinates

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

200
default

Content type

application/json

{"buildings": [{"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"buildingArea": 0.1,
"buildingStrategy": {"reviewAt": {"day": 0,
"month": 0,
"year": 0
},
"type": "BUILDING_STRATEGY_TYPE_UNDEFINED"
},
"buildingValue": "string",
"buildingZone": "string",
"characteristics": {"broadbandInternet": true,
"cableTv": true,
"chargingStation": true,
"childFriendly": true,
"communityGarden": true,
"conciergeService": true,
"elevator": true,
"fiberGlass": true,
"intercom": true,
"isdn": true,
"park": true,
"playground": true,
"satellite": true
},
"constructionTypes": ["UNDEFINED_CONSTRUCTION_TYPE"
],
"constructionYear": 0,
"contacts": [{"id": "string",
"note": "string",
"type": "BUILDING_CONTACT_TYPE_UNDEFINED"
}
],
"contractAmendments": "string",
"distances": {"kindergarten": 0.1,
"motorway": 0.1,
"primarySchool": 0.1,
"publicTransport": 0.1,
"shop": 0.1,
"upperSchool": 0.1
},
"documentIds": ["string"
],
"egid": "string",
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"floors": 0,
"id": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"locationQuality": "UNDEFINED_LOCATION_QUALITY",
"name": "string",
"note": "string",
"number": 0,
"numericId": "string",
"objectIds": ["string"
],
"onboardingFinished": true,
"ownerId": "string",
"plotArea": 0.1,
"plotIds": ["string"
],
"rating": {"microLocationRating": 0.1,
"microLocationRatingProposal": 0.1
},
"realEstateNumber": "string",
"renovationYear": 0,
"sia": {"siaAff": 0.1,
"siaAgf": 0.1,
"siaAkf": 0.1,
"siaAkfn": 0.1,
"siaAkft": 0.1,
"siaAnf": 0.1,
"siaAngf": 0.1,
"siaAvf": 0.1,
"siaBuf": 0.1,
"siaFf": 0.1,
"siaGf": 0.1,
"siaGgf": 0.1,
"siaGsf": 0.1,
"siaHnf": 0.1,
"siaHnf1": 0.1,
"siaHnf2": 0.1,
"siaHnf3": 0.1,
"siaHnf4": 0.1,
"siaHnf5": 0.1,
"siaHnf6": 0.1,
"siaKf": 0.1,
"siaKfn": 0.1,
"siaKft": 0.1,
"siaNf": 0.1,
"siaNgf": 0.1,
"siaNnf": 0.1,
"siaUf": 0.1,
"siaUuf": 0.1,
"siaVf": 0.1
},
"volume": 0.1
}
]
}

BuildingService_ListByIds

Request Body schema: application/json
required

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{"buildings": [{"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"buildingArea": 0.1,
"buildingStrategy": {"reviewAt": {"day": 0,
"month": 0,
"year": 0
},
"type": "BUILDING_STRATEGY_TYPE_UNDEFINED"
},
"buildingValue": "string",
"buildingZone": "string",
"characteristics": {"broadbandInternet": true,
"cableTv": true,
"chargingStation": true,
"childFriendly": true,
"communityGarden": true,
"conciergeService": true,
"elevator": true,
"fiberGlass": true,
"intercom": true,
"isdn": true,
"park": true,
"playground": true,
"satellite": true
},
"constructionTypes": ["UNDEFINED_CONSTRUCTION_TYPE"
],
"constructionYear": 0,
"contacts": [{"id": "string",
"note": "string",
"type": "BUILDING_CONTACT_TYPE_UNDEFINED"
}
],
"contractAmendments": "string",
"distances": {"kindergarten": 0.1,
"motorway": 0.1,
"primarySchool": 0.1,
"publicTransport": 0.1,
"shop": 0.1,
"upperSchool": 0.1
},
"documentIds": ["string"
],
"egid": "string",
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"floors": 0,
"id": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"locationQuality": "UNDEFINED_LOCATION_QUALITY",
"name": "string",
"note": "string",
"number": 0,
"numericId": "string",
"objectIds": ["string"
],
"onboardingFinished": true,
"ownerId": "string",
"plotArea": 0.1,
"plotIds": ["string"
],
"rating": {"microLocationRating": 0.1,
"microLocationRatingProposal": 0.1
},
"realEstateNumber": "string",
"renovationYear": 0,
"sia": {"siaAff": 0.1,
"siaAgf": 0.1,
"siaAkf": 0.1,
"siaAkfn": 0.1,
"siaAkft": 0.1,
"siaAnf": 0.1,
"siaAngf": 0.1,
"siaAvf": 0.1,
"siaBuf": 0.1,
"siaFf": 0.1,
"siaGf": 0.1,
"siaGgf": 0.1,
"siaGsf": 0.1,
"siaHnf": 0.1,
"siaHnf1": 0.1,
"siaHnf2": 0.1,
"siaHnf3": 0.1,
"siaHnf4": 0.1,
"siaHnf5": 0.1,
"siaHnf6": 0.1,
"siaKf": 0.1,
"siaKfn": 0.1,
"siaKft": 0.1,
"siaNf": 0.1,
"siaNgf": 0.1,
"siaNnf": 0.1,
"siaUf": 0.1,
"siaUuf": 0.1,
"siaVf": 0.1
},
"volume": 0.1
}
]
}

BuildingService_ListByObjectIds

Request Body schema: application/json
required

objectIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"objectIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"buildings": [{"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"buildingArea": 0.1,
"buildingStrategy": {"reviewAt": {"day": 0,
"month": 0,
"year": 0
},
"type": "BUILDING_STRATEGY_TYPE_UNDEFINED"
},
"buildingValue": "string",
"buildingZone": "string",
"characteristics": {"broadbandInternet": true,
"cableTv": true,
"chargingStation": true,
"childFriendly": true,
"communityGarden": true,
"conciergeService": true,
"elevator": true,
"fiberGlass": true,
"intercom": true,
"isdn": true,
"park": true,
"playground": true,
"satellite": true
},
"constructionTypes": ["UNDEFINED_CONSTRUCTION_TYPE"
],
"constructionYear": 0,
"contacts": [{"id": "string",
"note": "string",
"type": "BUILDING_CONTACT_TYPE_UNDEFINED"
}
],
"contractAmendments": "string",
"distances": {"kindergarten": 0.1,
"motorway": 0.1,
"primarySchool": 0.1,
"publicTransport": 0.1,
"shop": 0.1,
"upperSchool": 0.1
},
"documentIds": ["string"
],
"egid": "string",
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"floors": 0,
"id": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"locationQuality": "UNDEFINED_LOCATION_QUALITY",
"name": "string",
"note": "string",
"number": 0,
"numericId": "string",
"objectIds": ["string"
],
"onboardingFinished": true,
"ownerId": "string",
"plotArea": 0.1,
"plotIds": ["string"
],
"rating": {"microLocationRating": 0.1,
"microLocationRatingProposal": 0.1
},
"realEstateNumber": "string",
"renovationYear": 0,
"sia": {"siaAff": 0.1,
"siaAgf": 0.1,
"siaAkf": 0.1,
"siaAkfn": 0.1,
"siaAkft": 0.1,
"siaAnf": 0.1,
"siaAngf": 0.1,
"siaAvf": 0.1,
"siaBuf": 0.1,
"siaFf": 0.1,
"siaGf": 0.1,
"siaGgf": 0.1,
"siaGsf": 0.1,
"siaHnf": 0.1,
"siaHnf1": 0.1,
"siaHnf2": 0.1,
"siaHnf3": 0.1,
"siaHnf4": 0.1,
"siaHnf5": 0.1,
"siaHnf6": 0.1,
"siaKf": 0.1,
"siaKfn": 0.1,
"siaKft": 0.1,
"siaNf": 0.1,
"siaNgf": 0.1,
"siaNnf": 0.1,
"siaUf": 0.1,
"siaUuf": 0.1,
"siaVf": 0.1
},
"volume": 0.1
}
]
}

BuildingService_ListFilterOptions

Responses

Response samples

200
default

Content type

application/json

{"options": [{"id": "string",
"name": "string",
"objectIds": ["string"
],
"ownerId": "string"
}
]
}

BuildingService_RemoveBuildingContacts

Request Body schema: application/json
required

required	Array of objects (buildingBuildingContact)
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"buildingContacts": [{"id": "string",
"note": "string",
"type": "BUILDING_CONTACT_TYPE_UNDEFINED"
}
],
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

Delete

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{ }

BuildingService_MoveBuilding

path Parameters

required

string

Request Body schema: application/json
required

newContractIds	boolean
newPropertyId	string

Responses

Request samples

Payload

Content type

application/json

{"newContractIds": true,
"newPropertyId": "string"
}

Response samples

200
default

Content type

application/json

{ }

Update

path Parameters

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 (buildingBuildingContact)
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

Payload

Content type

application/json

{"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"buildingArea": 0.1,
"buildingStrategy": {"reviewAt": {"day": 0,
"month": 0,
"year": 0
},
"type": "BUILDING_STRATEGY_TYPE_UNDEFINED"
},
"buildingValue": "string",
"buildingZone": "string",
"characteristics": {"broadbandInternet": true,
"cableTv": true,
"chargingStation": true,
"childFriendly": true,
"communityGarden": true,
"conciergeService": true,
"elevator": true,
"fiberGlass": true,
"intercom": true,
"isdn": true,
"park": true,
"playground": true,
"satellite": true
},
"constructionTypes": ["UNDEFINED_CONSTRUCTION_TYPE"
],
"constructionYear": 0,
"contacts": [{"id": "string",
"note": "string",
"type": "BUILDING_CONTACT_TYPE_UNDEFINED"
}
],
"contractAmendments": "string",
"distances": {"kindergarten": 0.1,
"motorway": 0.1,
"primarySchool": 0.1,
"publicTransport": 0.1,
"shop": 0.1,
"upperSchool": 0.1
},
"documentIds": ["string"
],
"egid": "string",
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"floors": 0,
"imageMediaId": "string",
"landRegisterNumber": "string",
"locationQuality": "UNDEFINED_LOCATION_QUALITY",
"name": "string",
"note": "string",
"number": 0,
"objectIds": ["string"
],
"plotArea": 0.1,
"plotIds": ["string"
],
"rating": {"microLocationRating": 0.1,
"microLocationRatingProposal": 0.1
},
"realEstateNumber": "string",
"renovationYear": 0,
"sia": {"siaAff": 0.1,
"siaAgf": 0.1,
"siaAkf": 0.1,
"siaAkfn": 0.1,
"siaAkft": 0.1,
"siaAnf": 0.1,
"siaAngf": 0.1,
"siaAvf": 0.1,
"siaBuf": 0.1,
"siaFf": 0.1,
"siaGf": 0.1,
"siaGgf": 0.1,
"siaGsf": 0.1,
"siaHnf": 0.1,
"siaHnf1": 0.1,
"siaHnf2": 0.1,
"siaHnf3": 0.1,
"siaHnf4": 0.1,
"siaHnf5": 0.1,
"siaHnf6": 0.1,
"siaKf": 0.1,
"siaKfn": 0.1,
"siaKft": 0.1,
"siaNf": 0.1,
"siaNgf": 0.1,
"siaNnf": 0.1,
"siaUf": 0.1,
"siaUuf": 0.1,
"siaVf": 0.1
},
"volume": 0.1
}

Response samples

200
default

Content type

application/json

{"building": {"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"buildingArea": 0.1,
"buildingStrategy": {"reviewAt": {"day": 0,
"month": 0,
"year": 0
},
"type": "BUILDING_STRATEGY_TYPE_UNDEFINED"
},
"buildingValue": "string",
"buildingZone": "string",
"characteristics": {"broadbandInternet": true,
"cableTv": true,
"chargingStation": true,
"childFriendly": true,
"communityGarden": true,
"conciergeService": true,
"elevator": true,
"fiberGlass": true,
"intercom": true,
"isdn": true,
"park": true,
"playground": true,
"satellite": true
},
"constructionTypes": ["UNDEFINED_CONSTRUCTION_TYPE"
],
"constructionYear": 0,
"contacts": [{"id": "string",
"note": "string",
"type": "BUILDING_CONTACT_TYPE_UNDEFINED"
}
],
"contractAmendments": "string",
"distances": {"kindergarten": 0.1,
"motorway": 0.1,
"primarySchool": 0.1,
"publicTransport": 0.1,
"shop": 0.1,
"upperSchool": 0.1
},
"documentIds": ["string"
],
"egid": "string",
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"floors": 0,
"id": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"locationQuality": "UNDEFINED_LOCATION_QUALITY",
"name": "string",
"note": "string",
"number": 0,
"numericId": "string",
"objectIds": ["string"
],
"onboardingFinished": true,
"ownerId": "string",
"plotArea": 0.1,
"plotIds": ["string"
],
"rating": {"microLocationRating": 0.1,
"microLocationRatingProposal": 0.1
},
"realEstateNumber": "string",
"renovationYear": 0,
"sia": {"siaAff": 0.1,
"siaAgf": 0.1,
"siaAkf": 0.1,
"siaAkfn": 0.1,
"siaAkft": 0.1,
"siaAnf": 0.1,
"siaAngf": 0.1,
"siaAvf": 0.1,
"siaBuf": 0.1,
"siaFf": 0.1,
"siaGf": 0.1,
"siaGgf": 0.1,
"siaGsf": 0.1,
"siaHnf": 0.1,
"siaHnf1": 0.1,
"siaHnf2": 0.1,
"siaHnf3": 0.1,
"siaHnf4": 0.1,
"siaHnf5": 0.1,
"siaHnf6": 0.1,
"siaKf": 0.1,
"siaKfn": 0.1,
"siaKft": 0.1,
"siaNf": 0.1,
"siaNgf": 0.1,
"siaNnf": 0.1,
"siaUf": 0.1,
"siaUuf": 0.1,
"siaVf": 0.1
},
"volume": 0.1
}
}

BuildingService_UpdateMicroLocationRatingProposal

path Parameters

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

Payload

Content type

application/json

{"microLocationRatingProposal": 0.1,
"motorway": 0.1,
"publicTransport": 0.1,
"shop": 0.1
}

Response samples

200
default

Content type

application/json

{"building": {"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"buildingArea": 0.1,
"buildingStrategy": {"reviewAt": {"day": 0,
"month": 0,
"year": 0
},
"type": "BUILDING_STRATEGY_TYPE_UNDEFINED"
},
"buildingValue": "string",
"buildingZone": "string",
"characteristics": {"broadbandInternet": true,
"cableTv": true,
"chargingStation": true,
"childFriendly": true,
"communityGarden": true,
"conciergeService": true,
"elevator": true,
"fiberGlass": true,
"intercom": true,
"isdn": true,
"park": true,
"playground": true,
"satellite": true
},
"constructionTypes": ["UNDEFINED_CONSTRUCTION_TYPE"
],
"constructionYear": 0,
"contacts": [{"id": "string",
"note": "string",
"type": "BUILDING_CONTACT_TYPE_UNDEFINED"
}
],
"contractAmendments": "string",
"distances": {"kindergarten": 0.1,
"motorway": 0.1,
"primarySchool": 0.1,
"publicTransport": 0.1,
"shop": 0.1,
"upperSchool": 0.1
},
"documentIds": ["string"
],
"egid": "string",
"energySources": [{"documentIds": ["string"
],
"hasStorage": true,
"orderDate": "string",
"orderQuantity": 0.1,
"tankContent": 0.1,
"tankReadings": [{"date": "string",
"documentIds": ["string"
],
"value": 0.1
}
],
"tankSize": 0.1,
"type": "UNDEFINED_ENERGY_SOURCE_TYPE",
"unit": "ENERGY_SOURCE_UNIT_UNDEFINED"
}
],
"floors": 0,
"id": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"locationQuality": "UNDEFINED_LOCATION_QUALITY",
"name": "string",
"note": "string",
"number": 0,
"numericId": "string",
"objectIds": ["string"
],
"onboardingFinished": true,
"ownerId": "string",
"plotArea": 0.1,
"plotIds": ["string"
],
"rating": {"microLocationRating": 0.1,
"microLocationRatingProposal": 0.1
},
"realEstateNumber": "string",
"renovationYear": 0,
"sia": {"siaAff": 0.1,
"siaAgf": 0.1,
"siaAkf": 0.1,
"siaAkfn": 0.1,
"siaAkft": 0.1,
"siaAnf": 0.1,
"siaAngf": 0.1,
"siaAvf": 0.1,
"siaBuf": 0.1,
"siaFf": 0.1,
"siaGf": 0.1,
"siaGgf": 0.1,
"siaGsf": 0.1,
"siaHnf": 0.1,
"siaHnf1": 0.1,
"siaHnf2": 0.1,
"siaHnf3": 0.1,
"siaHnf4": 0.1,
"siaHnf5": 0.1,
"siaHnf6": 0.1,
"siaKf": 0.1,
"siaKfn": 0.1,
"siaKft": 0.1,
"siaNf": 0.1,
"siaNgf": 0.1,
"siaNnf": 0.1,
"siaUf": 0.1,
"siaUuf": 0.1,
"siaVf": 0.1
},
"volume": 0.1
}
}

DeviceService

DeviceService_Create

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

Payload

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": ["string"
],
"facilityPlant": "DEVICE_FACILITY_PLANT_UNDEFINED",
"images": [{"mediaId": "string",
"order": 0
}
],
"inspection": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastOfficialControl": {"day": 0,
"month": 0,
"year": 0
},
"nextOfficialControl": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"installation": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"lockingKey": {"combinedKeys": true,
"combinedKeysNote": "string",
"description": "string",
"lockingPlanNumber": "string"
},
"maintenance": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastMaintenance": {"day": 0,
"month": 0,
"year": 0
},
"nextMaintenance": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"manufacturer": "string",
"measure": "DEVICE_MEASURE_UNDEFINED",
"measureUntil": {"day": 0,
"month": 0,
"year": 0
},
"model": "string",
"note": "string",
"order": 0,
"ownerId": "string",
"referenceId": "string",
"revision": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastOfficialRevision": {"day": 0,
"month": 0,
"year": 0
},
"nextOfficialRevision": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"roomId": "string",
"serialNumber": "string",
"system": "DEVICE_SYSTEM_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED",
"uninstallation": {"day": 0,
"month": 0,
"year": 0
},
"unit": "DEVICE_UNIT_UNDEFINED",
"warrantyEnd": {"day": 0,
"month": 0,
"year": 0
}
}

Response samples

200
default

Content type

application/json

{"device": {"acquisitionCosts": 0.1,
"amount": 0,
"assetNumberFm": "string",
"bkpH": "string",
"brand": "string",
"cataloguePrice": 0.1,
"condition": "DEVICE_CONDITION_UNDEFINED",
"conditionNote": "string",
"documentIds": ["string"
],
"facilityPlant": "DEVICE_FACILITY_PLANT_UNDEFINED",
"id": "string",
"images": [{"mediaId": "string",
"order": 0
}
],
"inspection": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastOfficialControl": {"day": 0,
"month": 0,
"year": 0
},
"nextOfficialControl": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"installation": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"lockingKey": {"combinedKeys": true,
"combinedKeysNote": "string",
"description": "string",
"lockingPlanNumber": "string"
},
"maintenance": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastMaintenance": {"day": 0,
"month": 0,
"year": 0
},
"nextMaintenance": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"manufacturer": "string",
"measure": "DEVICE_MEASURE_UNDEFINED",
"measureUntil": {"day": 0,
"month": 0,
"year": 0
},
"model": "string",
"note": "string",
"numericId": "string",
"order": 0,
"ownerId": "string",
"referenceId": "string",
"revision": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastOfficialRevision": {"day": 0,
"month": 0,
"year": 0
},
"nextOfficialRevision": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"roomId": "string",
"serialNumber": "string",
"system": "DEVICE_SYSTEM_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED",
"uninstallation": {"day": 0,
"month": 0,
"year": 0
},
"unit": "DEVICE_UNIT_UNDEFINED",
"warrantyEnd": {"day": 0,
"month": 0,
"year": 0
}
}
}

DeviceService_GetDefaultData

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

200
default

Content type

application/json

{"data": [{"bkpH": "string",
"cataloguePrice": 0.1,
"facilityPlant": "DEVICE_FACILITY_PLANT_UNDEFINED",
"lifeSpan": 0,
"system": "DEVICE_SYSTEM_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED",
"unit": "DEVICE_UNIT_UNDEFINED"
}
]
}

DeviceService_ListByIds

Request Body schema: application/json
required

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{"devices": [{"acquisitionCosts": 0.1,
"amount": 0,
"assetNumberFm": "string",
"bkpH": "string",
"brand": "string",
"cataloguePrice": 0.1,
"condition": "DEVICE_CONDITION_UNDEFINED",
"conditionNote": "string",
"documentIds": ["string"
],
"facilityPlant": "DEVICE_FACILITY_PLANT_UNDEFINED",
"id": "string",
"images": [{"mediaId": "string",
"order": 0
}
],
"inspection": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastOfficialControl": {"day": 0,
"month": 0,
"year": 0
},
"nextOfficialControl": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"installation": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"lockingKey": {"combinedKeys": true,
"combinedKeysNote": "string",
"description": "string",
"lockingPlanNumber": "string"
},
"maintenance": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastMaintenance": {"day": 0,
"month": 0,
"year": 0
},
"nextMaintenance": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"manufacturer": "string",
"measure": "DEVICE_MEASURE_UNDEFINED",
"measureUntil": {"day": 0,
"month": 0,
"year": 0
},
"model": "string",
"note": "string",
"numericId": "string",
"order": 0,
"ownerId": "string",
"referenceId": "string",
"revision": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastOfficialRevision": {"day": 0,
"month": 0,
"year": 0
},
"nextOfficialRevision": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"roomId": "string",
"serialNumber": "string",
"system": "DEVICE_SYSTEM_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED",
"uninstallation": {"day": 0,
"month": 0,
"year": 0
},
"unit": "DEVICE_UNIT_UNDEFINED",
"warrantyEnd": {"day": 0,
"month": 0,
"year": 0
}
}
]
}

DeviceService_ListByReferenceIds

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

Payload

Content type

application/json

{"itemsPerPage": 0,
"page": 0,
"referenceIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"devices": [{"acquisitionCosts": 0.1,
"amount": 0,
"assetNumberFm": "string",
"bkpH": "string",
"brand": "string",
"cataloguePrice": 0.1,
"condition": "DEVICE_CONDITION_UNDEFINED",
"conditionNote": "string",
"documentIds": ["string"
],
"facilityPlant": "DEVICE_FACILITY_PLANT_UNDEFINED",
"id": "string",
"images": [{"mediaId": "string",
"order": 0
}
],
"inspection": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastOfficialControl": {"day": 0,
"month": 0,
"year": 0
},
"nextOfficialControl": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"installation": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"lockingKey": {"combinedKeys": true,
"combinedKeysNote": "string",
"description": "string",
"lockingPlanNumber": "string"
},
"maintenance": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastMaintenance": {"day": 0,
"month": 0,
"year": 0
},
"nextMaintenance": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"manufacturer": "string",
"measure": "DEVICE_MEASURE_UNDEFINED",
"measureUntil": {"day": 0,
"month": 0,
"year": 0
},
"model": "string",
"note": "string",
"numericId": "string",
"order": 0,
"ownerId": "string",
"referenceId": "string",
"revision": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastOfficialRevision": {"day": 0,
"month": 0,
"year": 0
},
"nextOfficialRevision": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"roomId": "string",
"serialNumber": "string",
"system": "DEVICE_SYSTEM_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED",
"uninstallation": {"day": 0,
"month": 0,
"year": 0
},
"unit": "DEVICE_UNIT_UNDEFINED",
"warrantyEnd": {"day": 0,
"month": 0,
"year": 0
}
}
],
"totalDevices": 0,
"totalPages": 0
}

DeviceService_Delete

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{ }

DeviceService_AddDocuments

path Parameters

required

string

query Parameters

documentIds

Array of strings

Responses

Response samples

200
default

Content type

application/json

{"device": {"acquisitionCosts": 0.1,
"amount": 0,
"assetNumberFm": "string",
"bkpH": "string",
"brand": "string",
"cataloguePrice": 0.1,
"condition": "DEVICE_CONDITION_UNDEFINED",
"conditionNote": "string",
"documentIds": ["string"
],
"facilityPlant": "DEVICE_FACILITY_PLANT_UNDEFINED",
"id": "string",
"images": [{"mediaId": "string",
"order": 0
}
],
"inspection": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastOfficialControl": {"day": 0,
"month": 0,
"year": 0
},
"nextOfficialControl": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"installation": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"lockingKey": {"combinedKeys": true,
"combinedKeysNote": "string",
"description": "string",
"lockingPlanNumber": "string"
},
"maintenance": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastMaintenance": {"day": 0,
"month": 0,
"year": 0
},
"nextMaintenance": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"manufacturer": "string",
"measure": "DEVICE_MEASURE_UNDEFINED",
"measureUntil": {"day": 0,
"month": 0,
"year": 0
},
"model": "string",
"note": "string",
"numericId": "string",
"order": 0,
"ownerId": "string",
"referenceId": "string",
"revision": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastOfficialRevision": {"day": 0,
"month": 0,
"year": 0
},
"nextOfficialRevision": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"roomId": "string",
"serialNumber": "string",
"system": "DEVICE_SYSTEM_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED",
"uninstallation": {"day": 0,
"month": 0,
"year": 0
},
"unit": "DEVICE_UNIT_UNDEFINED",
"warrantyEnd": {"day": 0,
"month": 0,
"year": 0
}
}
}

DeviceService_Update

path Parameters

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

Payload

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": ["string"
],
"facilityPlant": "DEVICE_FACILITY_PLANT_UNDEFINED",
"images": [{"mediaId": "string",
"order": 0
}
],
"inspection": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastOfficialControl": {"day": 0,
"month": 0,
"year": 0
},
"nextOfficialControl": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"installation": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"lockingKey": {"combinedKeys": true,
"combinedKeysNote": "string",
"description": "string",
"lockingPlanNumber": "string"
},
"maintenance": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastMaintenance": {"day": 0,
"month": 0,
"year": 0
},
"nextMaintenance": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"manufacturer": "string",
"measure": "DEVICE_MEASURE_UNDEFINED",
"measureUntil": {"day": 0,
"month": 0,
"year": 0
},
"model": "string",
"note": "string",
"order": 0,
"referenceId": "string",
"revision": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastOfficialRevision": {"day": 0,
"month": 0,
"year": 0
},
"nextOfficialRevision": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"roomId": "string",
"serialNumber": "string",
"system": "DEVICE_SYSTEM_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED",
"uninstallation": {"day": 0,
"month": 0,
"year": 0
},
"unit": "DEVICE_UNIT_UNDEFINED",
"warrantyEnd": {"day": 0,
"month": 0,
"year": 0
}
}

Response samples

200
default

Content type

application/json

{"device": {"acquisitionCosts": 0.1,
"amount": 0,
"assetNumberFm": "string",
"bkpH": "string",
"brand": "string",
"cataloguePrice": 0.1,
"condition": "DEVICE_CONDITION_UNDEFINED",
"conditionNote": "string",
"documentIds": ["string"
],
"facilityPlant": "DEVICE_FACILITY_PLANT_UNDEFINED",
"id": "string",
"images": [{"mediaId": "string",
"order": 0
}
],
"inspection": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastOfficialControl": {"day": 0,
"month": 0,
"year": 0
},
"nextOfficialControl": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"installation": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"lockingKey": {"combinedKeys": true,
"combinedKeysNote": "string",
"description": "string",
"lockingPlanNumber": "string"
},
"maintenance": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastMaintenance": {"day": 0,
"month": 0,
"year": 0
},
"nextMaintenance": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"manufacturer": "string",
"measure": "DEVICE_MEASURE_UNDEFINED",
"measureUntil": {"day": 0,
"month": 0,
"year": 0
},
"model": "string",
"note": "string",
"numericId": "string",
"order": 0,
"ownerId": "string",
"referenceId": "string",
"revision": {"contact": {"accountId": "string",
"name": "string",
"userReference": "string"
},
"contract": "string",
"costs": {"amount": 0.1,
"currency": "string",
"interval": "UNDEFINED_INTERVAL"
},
"lastOfficialRevision": {"day": 0,
"month": 0,
"year": 0
},
"nextOfficialRevision": {"day": 0,
"month": 0,
"year": 0
},
"note": "string",
"subscriptionEnd": {"day": 0,
"month": 0,
"year": 0
},
"subscriptionStart": {"day": 0,
"month": 0,
"year": 0
}
},
"roomId": "string",
"serialNumber": "string",
"system": "DEVICE_SYSTEM_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED",
"uninstallation": {"day": 0,
"month": 0,
"year": 0
},
"unit": "DEVICE_UNIT_UNDEFINED",
"warrantyEnd": {"day": 0,
"month": 0,
"year": 0
}
}
}

RentalIndexService

CRUD

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

Payload

Content type

application/json

{"compositionLinesOrColumns": "COMPOSITION_LINES_OR_COLUMNS_UNDEFINED",
"compositionType": "COMPOSITION_TYPE_UNDEFINED",
"fields": [{"name": "string",
"order": 0
}
],
"language": "PREFERRED_LANGUAGE_UNDEFINED",
"name": "string",
"onlyMovingInOutTenancies": true,
"ownerId": "string",
"sortingType": "SORTING_TYPE_UNDEFINED",
"tenancyType": "TENANCY_TYPE_UNDEFINED"
}

Response samples

200
default

Content type

application/json

{"template": {"compositionLinesOrColumns": "COMPOSITION_LINES_OR_COLUMNS_UNDEFINED",
"compositionType": "COMPOSITION_TYPE_UNDEFINED",
"fields": [{"name": "string",
"order": 0
}
],
"id": "string",
"language": "PREFERRED_LANGUAGE_UNDEFINED",
"name": "string",
"onlyMovingInOutTenancies": true,
"ownerId": "string",
"sortingType": "SORTING_TYPE_UNDEFINED",
"tenancyType": "TENANCY_TYPE_UNDEFINED"
}
}

RentalIndexService_List

query Parameters

accountId

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"templates": [{"compositionLinesOrColumns": "COMPOSITION_LINES_OR_COLUMNS_UNDEFINED",
"compositionType": "COMPOSITION_TYPE_UNDEFINED",
"fields": [{"name": "string",
"order": 0
}
],
"id": "string",
"language": "PREFERRED_LANGUAGE_UNDEFINED",
"name": "string",
"onlyMovingInOutTenancies": true,
"ownerId": "string",
"sortingType": "SORTING_TYPE_UNDEFINED",
"tenancyType": "TENANCY_TYPE_UNDEFINED"
}
]
}

RentalIndexService_Render

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

Payload

Content type

application/json

{"buildingIds": ["string"
],
"compositionLinesOrColumns": "COMPOSITION_LINES_OR_COLUMNS_UNDEFINED",
"compositionType": "COMPOSITION_TYPE_UNDEFINED",
"customHeader": "string",
"endDate": {"day": 0,
"month": 0,
"year": 0
},
"fields": [{"name": "string",
"order": 0
}
],
"hideInactiveObjects": true,
"language": "PREFERRED_LANGUAGE_UNDEFINED",
"onlyMovingInOutTenancies": true,
"sortingType": "SORTING_TYPE_UNDEFINED",
"startDate": {"day": 0,
"month": 0,
"year": 0
},
"tenancyType": "TENANCY_TYPE_UNDEFINED"
}

Response samples

200
default

Content type

application/json

{"file": "string"
}

RentalIndexService_RenderPdf

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

Payload

Content type

application/json

{"buildingBreakPage": true,
"buildingIds": ["string"
],
"displayHeaderEveryPage": true,
"displayPropertySummary": true,
"endDate": {"day": 0,
"month": 0,
"year": 0
},
"hideInactiveObjects": true,
"language": "PREFERRED_LANGUAGE_UNDEFINED",
"sortingType": "SORTING_TYPE_UNDEFINED",
"startDate": {"day": 0,
"month": 0,
"year": 0
},
"withoutTenantsNames": true
}

Response samples

200
default

Content type

application/json

{"file": "string"
}

RentalIndexService_Delete

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{ }

RentalIndexService_Update

path Parameters

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

Payload

Content type

application/json

{"compositionLinesOrColumns": "COMPOSITION_LINES_OR_COLUMNS_UNDEFINED",
"compositionType": "COMPOSITION_TYPE_UNDEFINED",
"fields": [{"name": "string",
"order": 0
}
],
"language": "PREFERRED_LANGUAGE_UNDEFINED",
"name": "string",
"onlyMovingInOutTenancies": true,
"sortingType": "SORTING_TYPE_UNDEFINED",
"tenancyType": "TENANCY_TYPE_UNDEFINED"
}

Response samples

200
default

Content type

application/json

{"template": {"compositionLinesOrColumns": "COMPOSITION_LINES_OR_COLUMNS_UNDEFINED",
"compositionType": "COMPOSITION_TYPE_UNDEFINED",
"fields": [{"name": "string",
"order": 0
}
],
"id": "string",
"language": "PREFERRED_LANGUAGE_UNDEFINED",
"name": "string",
"onlyMovingInOutTenancies": true,
"ownerId": "string",
"sortingType": "SORTING_TYPE_UNDEFINED",
"tenancyType": "TENANCY_TYPE_UNDEFINED"
}
}

SettlementObjectService

Create

Request Body schema: application/json
required

activated required	boolean
additionalCostsBillingType required	string (objectsettlement_objectAdditionalCostsBillingType) Default: "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE" Enum: "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE" "FLATRATE_ADDITIONAL_COSTS_BILLING_TYPE" "ADVANCE_PAYMENT_ADDITIONAL_COSTS_BILLING_TYPE"
billingContactId 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	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`.
correspondenceContactId required	string
description required	string
opted required	boolean
ownerId required	string <int64>
ownerIsDebtor required	boolean
referenceId required	string
required	Array of objects (objectsettlement_objectRentAdjustment)

Responses

Request samples

Payload

Content type

application/json

{"activated": true,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"billingContactId": "string",
"billingEnd": {"day": 0,
"month": 0,
"year": 0
},
"billingStart": {"day": 0,
"month": 0,
"year": 0
},
"correspondenceContactId": "string",
"description": "string",
"opted": true,
"ownerId": "string",
"ownerIsDebtor": true,
"referenceId": "string",
"rentAdjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"netRent": 0.1
}
]
}

Response samples

200
default

Content type

application/json

{"settlementObject": {"activated": true,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"billingContactId": "string",
"billingEnd": {"day": 0,
"month": 0,
"year": 0
},
"billingStart": {"day": 0,
"month": 0,
"year": 0
},
"correspondenceContactId": "string",
"debitUntil": {"day": 0,
"month": 0,
"year": 0
},
"description": "string",
"id": "string",
"numericContractId": "string",
"numericId": "string",
"opted": true,
"ownerId": "string",
"ownerIsDebtor": true,
"referenceId": "string",
"rentAdjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"netRent": 0.1
}
]
}
}

Read

Request Body schema: application/json
required

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{"settlementObjects": [{"activated": true,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"billingContactId": "string",
"billingEnd": {"day": 0,
"month": 0,
"year": 0
},
"billingStart": {"day": 0,
"month": 0,
"year": 0
},
"correspondenceContactId": "string",
"debitUntil": {"day": 0,
"month": 0,
"year": 0
},
"description": "string",
"id": "string",
"numericContractId": "string",
"numericId": "string",
"opted": true,
"ownerId": "string",
"ownerIsDebtor": true,
"referenceId": "string",
"rentAdjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"netRent": 0.1
}
]
}
]
}

SettlementObjectService_ListByReferenceId

path Parameters

referenceId

required

string

Responses

Response samples

200
default

Content type

application/json

{"settlementObjects": [{"activated": true,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"billingContactId": "string",
"billingEnd": {"day": 0,
"month": 0,
"year": 0
},
"billingStart": {"day": 0,
"month": 0,
"year": 0
},
"correspondenceContactId": "string",
"debitUntil": {"day": 0,
"month": 0,
"year": 0
},
"description": "string",
"id": "string",
"numericContractId": "string",
"numericId": "string",
"opted": true,
"ownerId": "string",
"ownerIsDebtor": true,
"referenceId": "string",
"rentAdjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"netRent": 0.1
}
]
}
]
}

Delete

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{ }

Update

path Parameters

required

string

Request Body schema: application/json
required

activated	boolean
additionalCostsBillingType	string (objectsettlement_objectAdditionalCostsBillingType) Default: "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE" Enum: "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE" "FLATRATE_ADDITIONAL_COSTS_BILLING_TYPE" "ADVANCE_PAYMENT_ADDITIONAL_COSTS_BILLING_TYPE"
billingContactId	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`.
	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`.
correspondenceContactId	string
description	string
opted	boolean
ownerIsDebtor	boolean
	Array of objects (objectsettlement_objectRentAdjustment)

Responses

Request samples

Payload

Content type

application/json

{"activated": true,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"billingContactId": "string",
"billingEnd": {"day": 0,
"month": 0,
"year": 0
},
"billingStart": {"day": 0,
"month": 0,
"year": 0
},
"correspondenceContactId": "string",
"description": "string",
"opted": true,
"ownerIsDebtor": true,
"rentAdjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"netRent": 0.1
}
]
}

Response samples

200
default

Content type

application/json

{"settlementObject": {"activated": true,
"additionalCostsBillingType": "UNDEFINED_ADDITIONAL_COSTS_BILLING_TYPE",
"billingContactId": "string",
"billingEnd": {"day": 0,
"month": 0,
"year": 0
},
"billingStart": {"day": 0,
"month": 0,
"year": 0
},
"correspondenceContactId": "string",
"debitUntil": {"day": 0,
"month": 0,
"year": 0
},
"description": "string",
"id": "string",
"numericContractId": "string",
"numericId": "string",
"opted": true,
"ownerId": "string",
"ownerIsDebtor": true,
"referenceId": "string",
"rentAdjustments": [{"additionalValues": [{"type": "ADDITIONAL_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"advancePaymentValues": [{"type": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"byDate": {"day": 0,
"month": 0,
"year": 0
},
"documentIds": ["string"
],
"dueDates": [0
],
"flatRateValues": [{"type": "FLAT_RATE_RENT_COMPONENT_UNDEFINED",
"value": 0.1
}
],
"netRent": 0.1
}
]
}
}

PropertyService

PropertyService_Count

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

200
default

Content type

application/json

{"count": 0
}

Create

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`.
additionalRentComponents required	Array of strings (- ADDITIONAL_RENT_COMPONENT_RENT: Added for COOZ-10074) Items Enum: "ADDITIONAL_RENT_COMPONENT_UNDEFINED" "ADDITIONAL_RENT_COMPONENT_RENT_REDUCTION" "ADDITIONAL_RENT_COMPONENT_ADDED_VALUE_E_CHARGING_STATION" "ADDITIONAL_RENT_COMPONENT_TENANT_IMPROVEMENT" "ADDITIONAL_RENT_COMPONENT_AMORTIZATION" "ADDITIONAL_RENT_COMPONENT_RENT"
required	object (commonaddressAddress)
advancePaymentRentComponents required	Array of strings (propertyAdvancePaymentRentComponents) Items Enum: "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED" "ADVANCE_PAYMENT_RENT_COMPONENT_GENERAL_ELECTRICITY" "ADVANCE_PAYMENT_RENT_COMPONENT_MAINTENANCE_GARDEN_SURROUNDING" "ADVANCE_PAYMENT_RENT_COMPONENT_MAINTENANCE_ELECTRICITY_WATER_SEWAGE" "ADVANCE_PAYMENT_RENT_COMPONENT_HEATING_HOT_WATER" "ADVANCE_PAYMENT_RENT_COMPONENT_HEATING" "ADVANCE_PAYMENT_RENT_COMPONENT_GARBAGE" "ADVANCE_PAYMENT_RENT_COMPONENT_GARBAGE_MAINTENANCE" "ADVANCE_PAYMENT_RENT_COMPONENT_TV" "ADVANCE_PAYMENT_RENT_COMPONENT_ELECTRICITY_MAINTENANCE_GARBAGE" "ADVANCE_PAYMENT_RENT_COMPONENT_ELECTRICITY_WATER_SEWAGE" "ADVANCE_PAYMENT_RENT_COMPONENT_ELECTRICITY_WATER_SEWAGE_MAINTENANCE" "ADVANCE_PAYMENT_RENT_COMPONENT_ELECTRICITY_WATER_SEWAGE_GARBAGE" "ADVANCE_PAYMENT_RENT_COMPONENT_ELECTRICITY_WATER_SEWAGE_GARBAGE_MAINTENANCE" "ADVANCE_PAYMENT_RENT_COMPONENT_ELECTRICITY_WATER_SEWAGE_GARBAGE_ELEVATOR" "ADVANCE_PAYMENT_RENT_COMPONENT_WATER_SEWAGE" "ADVANCE_PAYMENT_RENT_COMPONENT_WATER_SEWAGE_MAINTENANCE" "ADVANCE_PAYMENT_RENT_COMPONENT_WATER_SEWAGE_GARBAGE" "ADVANCE_PAYMENT_RENT_COMPONENT_ADDITIONAL_COSTS" "ADVANCE_PAYMENT_RENT_COMPONENT_HEATING_ADDITIONAL_COSTS" "ADVANCE_PAYMENT_RENT_COMPONENT_MAINTENANCE" "ADVANCE_PAYMENT_RENT_COMPONENT_ELECTRICITY_WATER" "ADVANCE_PAYMENT_RENT_COMPONENT_ELEVATOR" "ADVANCE_PAYMENT_RENT_COMPONENT_SERVICE_MINERGIE_VENTILATION" "ADVANCE_PAYMENT_RENT_COMPONENT_SEE_CONTRACT" "ADVANCE_PAYMENT_RENT_COMPONENT_E_CHARGING_STATION"
advancePaymentSeeContractDescription required	string
buildingIds required	Array of strings
constructionZone required	string
development required	string (objectpropertyDevelopment) Default: "UNDEFINED_DEVELOPMENT" Enum: "UNDEFINED_DEVELOPMENT" "FULL" "PARTIAL" "UNDEVELOPED"
required	object (propertyDistributionKeys)
documentIds required	Array of strings
egrid required	string
flatRateRentComponents required	Array of strings (propertyFlatRateRentComponents) Items Enum: "FLAT_RATE_RENT_COMPONENT_UNDEFINED" "FLAT_RATE_RENT_COMPONENT_MAINTENANCE_GARDEN_SURROUNDING" "FLAT_RATE_RENT_COMPONENT_HEATING_HOT_WATER" "FLAT_RATE_RENT_COMPONENT_HEATING" "FLAT_RATE_RENT_COMPONENT_GARBAGE" "FLAT_RATE_RENT_COMPONENT_ELEVATOR" "FLAT_RATE_RENT_COMPONENT_TV" "FLAT_RATE_RENT_COMPONENT_ELECTRICITY" "FLAT_RATE_RENT_COMPONENT_ELECTRICITY_GARBAGE" "FLAT_RATE_RENT_COMPONENT_ELECTRICITY_WATER_SEWAGE" "FLAT_RATE_RENT_COMPONENT_ELECTRICITY_WATER_SEWAGE_GARBAGE" "FLAT_RATE_RENT_COMPONENT_WATER_SEWAGE" "FLAT_RATE_RENT_COMPONENT_WATER_SEWAGE_GARBAGE" "FLAT_RATE_RENT_COMPONENT_ADDITIONAL_COSTS" "FLAT_RATE_RENT_COMPONENT_WATER" "FLAT_RATE_RENT_COMPONENT_MAINTENANCE" "FLAT_RATE_RENT_COMPONENT_SERVICE_MINERGIE_VENTILATION" "FLAT_RATE_RENT_COMPONENT_DISH_WASHER" "FLAT_RATE_RENT_COMPONENT_FREEZER" "FLAT_RATE_RENT_COMPONENT_SEE_CONTRACT" "FLAT_RATE_RENT_COMPONENT_BUDGET_EXPECTATIONS" "FLAT_RATE_RENT_COMPONENT_RENOVATION_FUND" "FLAT_RATE_RENT_COMPONENT_IN_FAVOR_OF_PROPERTY_1" "FLAT_RATE_RENT_COMPONENT_IN_FAVOR_OF_PROPERTY_2" "FLAT_RATE_RENT_COMPONENT_IN_FAVOR_OF_PROPERTY_3" "FLAT_RATE_RENT_COMPONENT_IN_FAVOR_OF_ADDITIONAL_COSTS_1" "FLAT_RATE_RENT_COMPONENT_IN_FAVOR_OF_ADDITIONAL_COSTS_2" "FLAT_RATE_RENT_COMPONENT_IN_FAVOR_OF_ADDITIONAL_COSTS_3"
flatRateSeeContractDescription required	string
imageMediaId required	string
landRegisterNumber required	string
name required	string
note required	string
number required	integer <int32>
opted required	boolean
optedPortionKey required	string (objectpropertyOptedPortionKey) 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>
transferToAccounting required	boolean
type required	string (objectpropertyPropertyType) Default: "PROPERTY_TYPE_UNDEFINED" Enum: "PROPERTY_TYPE_UNDEFINED" "PROPERTY_TYPE_RENTAL" "PROPERTY_TYPE_CONDOMINIUM_OWNERSHIP" "PROPERTY_TYPE_COOPERATIVE"

Responses

Request samples

Payload

Content type

application/json

{"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"additionalRentComponents": ["ADDITIONAL_RENT_COMPONENT_UNDEFINED"
],
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"advancePaymentRentComponents": ["ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED"
],
"advancePaymentSeeContractDescription": "string",
"buildingIds": ["string"
],
"constructionZone": "string",
"development": "UNDEFINED_DEVELOPMENT",
"distributionKeys": {"elevator": {"activated": true,
"value": 0.1
},
"locationCompensation": {"activated": true,
"value": 0.1
},
"m2": {"activated": true,
"value": 0.1
},
"m3": {"activated": true,
"value": 0.1
},
"tv": {"activated": true,
"value": 0.1
},
"valueRatio": {"activated": true,
"value": 0.1
}
},
"documentIds": ["string"
],
"egrid": "string",
"flatRateRentComponents": ["FLAT_RATE_RENT_COMPONENT_UNDEFINED"
],
"flatRateSeeContractDescription": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"name": "string",
"note": "string",
"number": 0,
"opted": true,
"optedPortionKey": "OPTED_PORTION_KEY_UNDEFINED",
"ownerId": "string",
"plotArea": 0.1,
"transferToAccounting": true,
"type": "PROPERTY_TYPE_UNDEFINED"
}

Response samples

200
default

Content type

application/json

{"property": {"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"additionalRentComponents": ["ADDITIONAL_RENT_COMPONENT_UNDEFINED"
],
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"advancePaymentRentComponents": ["ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED"
],
"advancePaymentSeeContractDescription": "string",
"buildingIds": ["string"
],
"constructionZone": "string",
"development": "UNDEFINED_DEVELOPMENT",
"distributionKeys": {"elevator": {"activated": true,
"value": 0.1
},
"locationCompensation": {"activated": true,
"value": 0.1
},
"m2": {"activated": true,
"value": 0.1
},
"m3": {"activated": true,
"value": 0.1
},
"tv": {"activated": true,
"value": 0.1
},
"valueRatio": {"activated": true,
"value": 0.1
}
},
"documentIds": ["string"
],
"egrid": "string",
"flatRateRentComponents": ["FLAT_RATE_RENT_COMPONENT_UNDEFINED"
],
"flatRateSeeContractDescription": "string",
"id": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"name": "string",
"note": "string",
"number": 0,
"numericId": "string",
"onboardingFinished": true,
"opted": true,
"optedPortionKey": "OPTED_PORTION_KEY_UNDEFINED",
"ownerId": "string",
"plotArea": 0.1,
"transferToAccounting": true,
"type": "PROPERTY_TYPE_UNDEFINED"
}
}

Read

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

200
default

Content type

application/json

{"properties": [{"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"additionalRentComponents": ["ADDITIONAL_RENT_COMPONENT_UNDEFINED"
],
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"advancePaymentRentComponents": ["ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED"
],
"advancePaymentSeeContractDescription": "string",
"buildingIds": ["string"
],
"constructionZone": "string",
"development": "UNDEFINED_DEVELOPMENT",
"distributionKeys": {"elevator": {"activated": true,
"value": 0.1
},
"locationCompensation": {"activated": true,
"value": 0.1
},
"m2": {"activated": true,
"value": 0.1
},
"m3": {"activated": true,
"value": 0.1
},
"tv": {"activated": true,
"value": 0.1
},
"valueRatio": {"activated": true,
"value": 0.1
}
},
"documentIds": ["string"
],
"egrid": "string",
"flatRateRentComponents": ["FLAT_RATE_RENT_COMPONENT_UNDEFINED"
],
"flatRateSeeContractDescription": "string",
"id": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"name": "string",
"note": "string",
"number": 0,
"numericId": "string",
"onboardingFinished": true,
"opted": true,
"optedPortionKey": "OPTED_PORTION_KEY_UNDEFINED",
"ownerId": "string",
"plotArea": 0.1,
"transferToAccounting": true,
"type": "PROPERTY_TYPE_UNDEFINED"
}
],
"totalPageCount": 0,
"totalPropertiesCount": 0
}

PropertyService_ListByBuildingIds

path Parameters

buildingIds

required

Array of strings non-empty

Responses

Response samples

200
default

Content type

application/json

{"properties": [{"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"additionalRentComponents": ["ADDITIONAL_RENT_COMPONENT_UNDEFINED"
],
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"advancePaymentRentComponents": ["ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED"
],
"advancePaymentSeeContractDescription": "string",
"buildingIds": ["string"
],
"constructionZone": "string",
"development": "UNDEFINED_DEVELOPMENT",
"distributionKeys": {"elevator": {"activated": true,
"value": 0.1
},
"locationCompensation": {"activated": true,
"value": 0.1
},
"m2": {"activated": true,
"value": 0.1
},
"m3": {"activated": true,
"value": 0.1
},
"tv": {"activated": true,
"value": 0.1
},
"valueRatio": {"activated": true,
"value": 0.1
}
},
"documentIds": ["string"
],
"egrid": "string",
"flatRateRentComponents": ["FLAT_RATE_RENT_COMPONENT_UNDEFINED"
],
"flatRateSeeContractDescription": "string",
"id": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"name": "string",
"note": "string",
"number": 0,
"numericId": "string",
"onboardingFinished": true,
"opted": true,
"optedPortionKey": "OPTED_PORTION_KEY_UNDEFINED",
"ownerId": "string",
"plotArea": 0.1,
"transferToAccounting": true,
"type": "PROPERTY_TYPE_UNDEFINED"
}
]
}

PropertyService_ListByIds

path Parameters

ids

required

Array of strings non-empty

Responses

Response samples

200
default

Content type

application/json

{"properties": [{"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"additionalRentComponents": ["ADDITIONAL_RENT_COMPONENT_UNDEFINED"
],
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"advancePaymentRentComponents": ["ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED"
],
"advancePaymentSeeContractDescription": "string",
"buildingIds": ["string"
],
"constructionZone": "string",
"development": "UNDEFINED_DEVELOPMENT",
"distributionKeys": {"elevator": {"activated": true,
"value": 0.1
},
"locationCompensation": {"activated": true,
"value": 0.1
},
"m2": {"activated": true,
"value": 0.1
},
"m3": {"activated": true,
"value": 0.1
},
"tv": {"activated": true,
"value": 0.1
},
"valueRatio": {"activated": true,
"value": 0.1
}
},
"documentIds": ["string"
],
"egrid": "string",
"flatRateRentComponents": ["FLAT_RATE_RENT_COMPONENT_UNDEFINED"
],
"flatRateSeeContractDescription": "string",
"id": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"name": "string",
"note": "string",
"number": 0,
"numericId": "string",
"onboardingFinished": true,
"opted": true,
"optedPortionKey": "OPTED_PORTION_KEY_UNDEFINED",
"ownerId": "string",
"plotArea": 0.1,
"transferToAccounting": true,
"type": "PROPERTY_TYPE_UNDEFINED"
}
]
}

PropertyService_TransferToAccounting

Request Body schema: application/json
required

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

Delete

path Parameters

ids

required

Array of strings non-empty

Responses

Response samples

200
default

Content type

application/json

{ }

Update

path Parameters

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`.
additionalRentComponents	Array of strings (- ADDITIONAL_RENT_COMPONENT_RENT: Added for COOZ-10074) Items Enum: "ADDITIONAL_RENT_COMPONENT_UNDEFINED" "ADDITIONAL_RENT_COMPONENT_RENT_REDUCTION" "ADDITIONAL_RENT_COMPONENT_ADDED_VALUE_E_CHARGING_STATION" "ADDITIONAL_RENT_COMPONENT_TENANT_IMPROVEMENT" "ADDITIONAL_RENT_COMPONENT_AMORTIZATION" "ADDITIONAL_RENT_COMPONENT_RENT"
	object (commonaddressAddress)
advancePaymentRentComponents	Array of strings (propertyAdvancePaymentRentComponents) Items Enum: "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED" "ADVANCE_PAYMENT_RENT_COMPONENT_GENERAL_ELECTRICITY" "ADVANCE_PAYMENT_RENT_COMPONENT_MAINTENANCE_GARDEN_SURROUNDING" "ADVANCE_PAYMENT_RENT_COMPONENT_MAINTENANCE_ELECTRICITY_WATER_SEWAGE" "ADVANCE_PAYMENT_RENT_COMPONENT_HEATING_HOT_WATER" "ADVANCE_PAYMENT_RENT_COMPONENT_HEATING" "ADVANCE_PAYMENT_RENT_COMPONENT_GARBAGE" "ADVANCE_PAYMENT_RENT_COMPONENT_GARBAGE_MAINTENANCE" "ADVANCE_PAYMENT_RENT_COMPONENT_TV" "ADVANCE_PAYMENT_RENT_COMPONENT_ELECTRICITY_MAINTENANCE_GARBAGE" "ADVANCE_PAYMENT_RENT_COMPONENT_ELECTRICITY_WATER_SEWAGE" "ADVANCE_PAYMENT_RENT_COMPONENT_ELECTRICITY_WATER_SEWAGE_MAINTENANCE" "ADVANCE_PAYMENT_RENT_COMPONENT_ELECTRICITY_WATER_SEWAGE_GARBAGE" "ADVANCE_PAYMENT_RENT_COMPONENT_ELECTRICITY_WATER_SEWAGE_GARBAGE_MAINTENANCE" "ADVANCE_PAYMENT_RENT_COMPONENT_ELECTRICITY_WATER_SEWAGE_GARBAGE_ELEVATOR" "ADVANCE_PAYMENT_RENT_COMPONENT_WATER_SEWAGE" "ADVANCE_PAYMENT_RENT_COMPONENT_WATER_SEWAGE_MAINTENANCE" "ADVANCE_PAYMENT_RENT_COMPONENT_WATER_SEWAGE_GARBAGE" "ADVANCE_PAYMENT_RENT_COMPONENT_ADDITIONAL_COSTS" "ADVANCE_PAYMENT_RENT_COMPONENT_HEATING_ADDITIONAL_COSTS" "ADVANCE_PAYMENT_RENT_COMPONENT_MAINTENANCE" "ADVANCE_PAYMENT_RENT_COMPONENT_ELECTRICITY_WATER" "ADVANCE_PAYMENT_RENT_COMPONENT_ELEVATOR" "ADVANCE_PAYMENT_RENT_COMPONENT_SERVICE_MINERGIE_VENTILATION" "ADVANCE_PAYMENT_RENT_COMPONENT_SEE_CONTRACT" "ADVANCE_PAYMENT_RENT_COMPONENT_E_CHARGING_STATION"
advancePaymentSeeContractDescription	string
buildingIds	Array of strings
constructionZone	string
development	string (objectpropertyDevelopment) Default: "UNDEFINED_DEVELOPMENT" Enum: "UNDEFINED_DEVELOPMENT" "FULL" "PARTIAL" "UNDEVELOPED"
	object (propertyDistributionKeys)
documentIds	Array of strings
egrid	string
flatRateRentComponents	Array of strings (propertyFlatRateRentComponents) Items Enum: "FLAT_RATE_RENT_COMPONENT_UNDEFINED" "FLAT_RATE_RENT_COMPONENT_MAINTENANCE_GARDEN_SURROUNDING" "FLAT_RATE_RENT_COMPONENT_HEATING_HOT_WATER" "FLAT_RATE_RENT_COMPONENT_HEATING" "FLAT_RATE_RENT_COMPONENT_GARBAGE" "FLAT_RATE_RENT_COMPONENT_ELEVATOR" "FLAT_RATE_RENT_COMPONENT_TV" "FLAT_RATE_RENT_COMPONENT_ELECTRICITY" "FLAT_RATE_RENT_COMPONENT_ELECTRICITY_GARBAGE" "FLAT_RATE_RENT_COMPONENT_ELECTRICITY_WATER_SEWAGE" "FLAT_RATE_RENT_COMPONENT_ELECTRICITY_WATER_SEWAGE_GARBAGE" "FLAT_RATE_RENT_COMPONENT_WATER_SEWAGE" "FLAT_RATE_RENT_COMPONENT_WATER_SEWAGE_GARBAGE" "FLAT_RATE_RENT_COMPONENT_ADDITIONAL_COSTS" "FLAT_RATE_RENT_COMPONENT_WATER" "FLAT_RATE_RENT_COMPONENT_MAINTENANCE" "FLAT_RATE_RENT_COMPONENT_SERVICE_MINERGIE_VENTILATION" "FLAT_RATE_RENT_COMPONENT_DISH_WASHER" "FLAT_RATE_RENT_COMPONENT_FREEZER" "FLAT_RATE_RENT_COMPONENT_SEE_CONTRACT" "FLAT_RATE_RENT_COMPONENT_BUDGET_EXPECTATIONS" "FLAT_RATE_RENT_COMPONENT_RENOVATION_FUND" "FLAT_RATE_RENT_COMPONENT_IN_FAVOR_OF_PROPERTY_1" "FLAT_RATE_RENT_COMPONENT_IN_FAVOR_OF_PROPERTY_2" "FLAT_RATE_RENT_COMPONENT_IN_FAVOR_OF_PROPERTY_3" "FLAT_RATE_RENT_COMPONENT_IN_FAVOR_OF_ADDITIONAL_COSTS_1" "FLAT_RATE_RENT_COMPONENT_IN_FAVOR_OF_ADDITIONAL_COSTS_2" "FLAT_RATE_RENT_COMPONENT_IN_FAVOR_OF_ADDITIONAL_COSTS_3"
flatRateSeeContractDescription	string
imageMediaId	string
landRegisterNumber	string
name	string
note	string
number	integer <int32>
opted	boolean
optedPortionKey	string (objectpropertyOptedPortionKey) 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>
transferToAccounting	boolean
type	string (objectpropertyPropertyType) Default: "PROPERTY_TYPE_UNDEFINED" Enum: "PROPERTY_TYPE_UNDEFINED" "PROPERTY_TYPE_RENTAL" "PROPERTY_TYPE_CONDOMINIUM_OWNERSHIP" "PROPERTY_TYPE_COOPERATIVE"

Responses

Request samples

Payload

Content type

application/json

{"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"additionalRentComponents": ["ADDITIONAL_RENT_COMPONENT_UNDEFINED"
],
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"advancePaymentRentComponents": ["ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED"
],
"advancePaymentSeeContractDescription": "string",
"buildingIds": ["string"
],
"constructionZone": "string",
"development": "UNDEFINED_DEVELOPMENT",
"distributionKeys": {"elevator": {"activated": true,
"value": 0.1
},
"locationCompensation": {"activated": true,
"value": 0.1
},
"m2": {"activated": true,
"value": 0.1
},
"m3": {"activated": true,
"value": 0.1
},
"tv": {"activated": true,
"value": 0.1
},
"valueRatio": {"activated": true,
"value": 0.1
}
},
"documentIds": ["string"
],
"egrid": "string",
"flatRateRentComponents": ["FLAT_RATE_RENT_COMPONENT_UNDEFINED"
],
"flatRateSeeContractDescription": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"name": "string",
"note": "string",
"number": 0,
"opted": true,
"optedPortionKey": "OPTED_PORTION_KEY_UNDEFINED",
"plotArea": 0.1,
"transferToAccounting": true,
"type": "PROPERTY_TYPE_UNDEFINED"
}

Response samples

200
default

Content type

application/json

{"property": {"acquisitionDate": {"day": 0,
"month": 0,
"year": 0
},
"additionalRentComponents": ["ADDITIONAL_RENT_COMPONENT_UNDEFINED"
],
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"advancePaymentRentComponents": ["ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED"
],
"advancePaymentSeeContractDescription": "string",
"buildingIds": ["string"
],
"constructionZone": "string",
"development": "UNDEFINED_DEVELOPMENT",
"distributionKeys": {"elevator": {"activated": true,
"value": 0.1
},
"locationCompensation": {"activated": true,
"value": 0.1
},
"m2": {"activated": true,
"value": 0.1
},
"m3": {"activated": true,
"value": 0.1
},
"tv": {"activated": true,
"value": 0.1
},
"valueRatio": {"activated": true,
"value": 0.1
}
},
"documentIds": ["string"
],
"egrid": "string",
"flatRateRentComponents": ["FLAT_RATE_RENT_COMPONENT_UNDEFINED"
],
"flatRateSeeContractDescription": "string",
"id": "string",
"imageMediaId": "string",
"landRegisterNumber": "string",
"name": "string",
"note": "string",
"number": 0,
"numericId": "string",
"onboardingFinished": true,
"opted": true,
"optedPortionKey": "OPTED_PORTION_KEY_UNDEFINED",
"ownerId": "string",
"plotArea": 0.1,
"transferToAccounting": true,
"type": "PROPERTY_TYPE_UNDEFINED"
}
}

PropertyService_CountMixin21

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

200
default

Content type

application/json

{"count": 0
}

Create

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

Payload

Content type

application/json

{"additionalRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADDITIONAL_RENT_COMPONENT_UNDEFINED"
}
],
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"advancePaymentRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED"
}
],
"assignees": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdmin": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeOwner": "string"
},
"bankInfo": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"bankName": "string",
"clearingNumber": "string",
"documentIds": ["string"
],
"expiresAt": {"day": 0,
"month": 0,
"year": 0
},
"iban": "string",
"inTheNameOf": "string",
"note": "string",
"typeOfUseForInsurance": "TYPE_OF_USE_FOR_INSURANCE_UNDEFINED",
"useForInsurancePurposes": true,
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"buildingIds": ["string"
],
"constructionZone": "string",
"development": "PROPERTY_DEVELOPMENT_UNDEFINED",
"documentIds": ["string"
],
"egrid": "string",
"flatRateRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "FLAT_RATE_RENT_COMPONENT_UNDEFINED"
}
],
"imageMediaId": "string",
"keyDateServiceChargeSettlement": {"day": 0,
"month": 0,
"year": 0
},
"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

200
default

Content type

application/json

{"property": {"additionalRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADDITIONAL_RENT_COMPONENT_UNDEFINED"
}
],
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"advancePaymentRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED"
}
],
"assignees": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdmin": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeOwner": "string"
},
"bankInfo": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"bankName": "string",
"clearingNumber": "string",
"documentIds": ["string"
],
"expiresAt": {"day": 0,
"month": 0,
"year": 0
},
"iban": "string",
"inTheNameOf": "string",
"note": "string",
"typeOfUseForInsurance": "TYPE_OF_USE_FOR_INSURANCE_UNDEFINED",
"useForInsurancePurposes": true,
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"buildingIds": ["string"
],
"constructionZone": "string",
"development": "PROPERTY_DEVELOPMENT_UNDEFINED",
"documentIds": ["string"
],
"egrid": "string",
"flatRateRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "FLAT_RATE_RENT_COMPONENT_UNDEFINED"
}
],
"id": "string",
"imageMediaId": "string",
"keyDateServiceChargeSettlement": {"day": 0,
"month": 0,
"year": 0
},
"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"
}
}

PropertyService_GetAllowedPropertyTypes

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"types": ["PROPERTY_TYPE_UNDEFINED"
]
}

Read

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

200
default

Content type

application/json

{"properties": [{"additionalRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADDITIONAL_RENT_COMPONENT_UNDEFINED"
}
],
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"advancePaymentRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED"
}
],
"assignees": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdmin": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeOwner": "string"
},
"bankInfo": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"bankName": "string",
"clearingNumber": "string",
"documentIds": ["string"
],
"expiresAt": {"day": 0,
"month": 0,
"year": 0
},
"iban": "string",
"inTheNameOf": "string",
"note": "string",
"typeOfUseForInsurance": "TYPE_OF_USE_FOR_INSURANCE_UNDEFINED",
"useForInsurancePurposes": true,
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"buildingIds": ["string"
],
"constructionZone": "string",
"development": "PROPERTY_DEVELOPMENT_UNDEFINED",
"documentIds": ["string"
],
"egrid": "string",
"flatRateRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "FLAT_RATE_RENT_COMPONENT_UNDEFINED"
}
],
"id": "string",
"imageMediaId": "string",
"keyDateServiceChargeSettlement": {"day": 0,
"month": 0,
"year": 0
},
"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"
}
],
"totalPageCount": 0,
"totalPropertiesCount": 0
}

PropertyService_ListByBuildingIdsMixin21

path Parameters

buildingIds

required

Array of strings non-empty

Responses

Response samples

200
default

Content type

application/json

{"properties": [{"additionalRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADDITIONAL_RENT_COMPONENT_UNDEFINED"
}
],
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"advancePaymentRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED"
}
],
"assignees": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdmin": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeOwner": "string"
},
"bankInfo": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"bankName": "string",
"clearingNumber": "string",
"documentIds": ["string"
],
"expiresAt": {"day": 0,
"month": 0,
"year": 0
},
"iban": "string",
"inTheNameOf": "string",
"note": "string",
"typeOfUseForInsurance": "TYPE_OF_USE_FOR_INSURANCE_UNDEFINED",
"useForInsurancePurposes": true,
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"buildingIds": ["string"
],
"constructionZone": "string",
"development": "PROPERTY_DEVELOPMENT_UNDEFINED",
"documentIds": ["string"
],
"egrid": "string",
"flatRateRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "FLAT_RATE_RENT_COMPONENT_UNDEFINED"
}
],
"id": "string",
"imageMediaId": "string",
"keyDateServiceChargeSettlement": {"day": 0,
"month": 0,
"year": 0
},
"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"
}
]
}

PropertyService_ListByIdsMixin21

path Parameters

ids

required

Array of strings non-empty

Responses

Response samples

200
default

Content type

application/json

{"properties": [{"additionalRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADDITIONAL_RENT_COMPONENT_UNDEFINED"
}
],
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"advancePaymentRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED"
}
],
"assignees": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdmin": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeOwner": "string"
},
"bankInfo": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"bankName": "string",
"clearingNumber": "string",
"documentIds": ["string"
],
"expiresAt": {"day": 0,
"month": 0,
"year": 0
},
"iban": "string",
"inTheNameOf": "string",
"note": "string",
"typeOfUseForInsurance": "TYPE_OF_USE_FOR_INSURANCE_UNDEFINED",
"useForInsurancePurposes": true,
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"buildingIds": ["string"
],
"constructionZone": "string",
"development": "PROPERTY_DEVELOPMENT_UNDEFINED",
"documentIds": ["string"
],
"egrid": "string",
"flatRateRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "FLAT_RATE_RENT_COMPONENT_UNDEFINED"
}
],
"id": "string",
"imageMediaId": "string",
"keyDateServiceChargeSettlement": {"day": 0,
"month": 0,
"year": 0
},
"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"
}
]
}

PropertyService_GetByOwnerIdAndNumericId

path Parameters

ownerId required	string <int64>
numericId required	string <int64>

Responses

Response samples

200
default

Content type

application/json

{"property": {"additionalRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADDITIONAL_RENT_COMPONENT_UNDEFINED"
}
],
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"advancePaymentRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED"
}
],
"assignees": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdmin": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeOwner": "string"
},
"bankInfo": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"bankName": "string",
"clearingNumber": "string",
"documentIds": ["string"
],
"expiresAt": {"day": 0,
"month": 0,
"year": 0
},
"iban": "string",
"inTheNameOf": "string",
"note": "string",
"typeOfUseForInsurance": "TYPE_OF_USE_FOR_INSURANCE_UNDEFINED",
"useForInsurancePurposes": true,
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"buildingIds": ["string"
],
"constructionZone": "string",
"development": "PROPERTY_DEVELOPMENT_UNDEFINED",
"documentIds": ["string"
],
"egrid": "string",
"flatRateRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "FLAT_RATE_RENT_COMPONENT_UNDEFINED"
}
],
"id": "string",
"imageMediaId": "string",
"keyDateServiceChargeSettlement": {"day": 0,
"month": 0,
"year": 0
},
"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"
}
}

PropertyService_ListFilterOptions

Responses

Response samples

200
default

Content type

application/json

{"options": [{"buildingIds": ["string"
],
"id": "string",
"name": "string",
"ownerId": "string"
}
]
}

PropertyService_ListIds

path Parameters

ownerId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"numericIds": ["string"
]
}

PropertyService_Sell

Request Body schema: application/json
required

id required	string
keepNetworkPartners required	boolean
targetOwnerId required	string <int64>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"keepNetworkPartners": true,
"targetOwnerId": "string"
}

Response samples

200
default

Content type

application/json

{"property": {"additionalRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADDITIONAL_RENT_COMPONENT_UNDEFINED"
}
],
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"advancePaymentRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED"
}
],
"assignees": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdmin": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeOwner": "string"
},
"bankInfo": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"bankName": "string",
"clearingNumber": "string",
"documentIds": ["string"
],
"expiresAt": {"day": 0,
"month": 0,
"year": 0
},
"iban": "string",
"inTheNameOf": "string",
"note": "string",
"typeOfUseForInsurance": "TYPE_OF_USE_FOR_INSURANCE_UNDEFINED",
"useForInsurancePurposes": true,
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"buildingIds": ["string"
],
"constructionZone": "string",
"development": "PROPERTY_DEVELOPMENT_UNDEFINED",
"documentIds": ["string"
],
"egrid": "string",
"flatRateRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "FLAT_RATE_RENT_COMPONENT_UNDEFINED"
}
],
"id": "string",
"imageMediaId": "string",
"keyDateServiceChargeSettlement": {"day": 0,
"month": 0,
"year": 0
},
"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"
}
}

PropertyService_SetAccountingAssignee

Request Body schema: application/json
required

contactIdAssigneeAccounting required	string
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"contactIdAssigneeAccounting": "string",
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

PropertyService_SetAdminAssignee

Request Body schema: application/json
required

contactIdAssigneeAdministration required	string
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"contactIdAssigneeAdministration": "string",
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

PropertyService_SetAssetAssignee

Request Body schema: application/json
required

contactIdAssigneeAsset required	string
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"contactIdAssigneeAsset": "string",
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

PropertyService_SetOwnerAssignee

Request Body schema: application/json
required

contactIdAssigneeOwner required	string
ids required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"contactIdAssigneeOwner": "string",
"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

PropertyService_TransferToAccountingMixin21

Request Body schema: application/json
required

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

Delete

path Parameters

ids

required

Array of strings non-empty

Responses

Response samples

200
default

Content type

application/json

{ }

PropertyService_AddBuilding

path Parameters

required

string

Request Body schema: application/json
required

buildingId

string

Responses

Request samples

Payload

Content type

application/json

{"buildingId": "string"
}

Response samples

200
default

Content type

application/json

{"property": {"additionalRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADDITIONAL_RENT_COMPONENT_UNDEFINED"
}
],
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"advancePaymentRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED"
}
],
"assignees": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdmin": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeOwner": "string"
},
"bankInfo": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"bankName": "string",
"clearingNumber": "string",
"documentIds": ["string"
],
"expiresAt": {"day": 0,
"month": 0,
"year": 0
},
"iban": "string",
"inTheNameOf": "string",
"note": "string",
"typeOfUseForInsurance": "TYPE_OF_USE_FOR_INSURANCE_UNDEFINED",
"useForInsurancePurposes": true,
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"buildingIds": ["string"
],
"constructionZone": "string",
"development": "PROPERTY_DEVELOPMENT_UNDEFINED",
"documentIds": ["string"
],
"egrid": "string",
"flatRateRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "FLAT_RATE_RENT_COMPONENT_UNDEFINED"
}
],
"id": "string",
"imageMediaId": "string",
"keyDateServiceChargeSettlement": {"day": 0,
"month": 0,
"year": 0
},
"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"
}
}

Update

path Parameters

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

Payload

Content type

application/json

{"additionalRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADDITIONAL_RENT_COMPONENT_UNDEFINED"
}
],
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"advancePaymentRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED"
}
],
"assignees": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdmin": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeOwner": "string"
},
"bankInfo": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"bankName": "string",
"clearingNumber": "string",
"documentIds": ["string"
],
"expiresAt": {"day": 0,
"month": 0,
"year": 0
},
"iban": "string",
"inTheNameOf": "string",
"note": "string",
"typeOfUseForInsurance": "TYPE_OF_USE_FOR_INSURANCE_UNDEFINED",
"useForInsurancePurposes": true,
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"buildingIds": ["string"
],
"constructionZone": "string",
"development": "PROPERTY_DEVELOPMENT_UNDEFINED",
"documentIds": ["string"
],
"egrid": "string",
"flatRateRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "FLAT_RATE_RENT_COMPONENT_UNDEFINED"
}
],
"imageMediaId": "string",
"keyDateServiceChargeSettlement": {"day": 0,
"month": 0,
"year": 0
},
"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

200
default

Content type

application/json

{"property": {"additionalRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADDITIONAL_RENT_COMPONENT_UNDEFINED"
}
],
"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"advancePaymentRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "ADVANCE_PAYMENT_RENT_COMPONENT_UNDEFINED"
}
],
"assignees": {"contactIdAssigneeAccounting": "string",
"contactIdAssigneeAdmin": "string",
"contactIdAssigneeAsset": "string",
"contactIdAssigneeOwner": "string"
},
"bankInfo": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"bankName": "string",
"clearingNumber": "string",
"documentIds": ["string"
],
"expiresAt": {"day": 0,
"month": 0,
"year": 0
},
"iban": "string",
"inTheNameOf": "string",
"note": "string",
"typeOfUseForInsurance": "TYPE_OF_USE_FOR_INSURANCE_UNDEFINED",
"useForInsurancePurposes": true,
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"buildingIds": ["string"
],
"constructionZone": "string",
"development": "PROPERTY_DEVELOPMENT_UNDEFINED",
"documentIds": ["string"
],
"egrid": "string",
"flatRateRentComponents": [{"description": "string",
"inactive": true,
"rentComponent": "FLAT_RATE_RENT_COMPONENT_UNDEFINED"
}
],
"id": "string",
"imageMediaId": "string",
"keyDateServiceChargeSettlement": {"day": 0,
"month": 0,
"year": 0
},
"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"
}
}

AccountingService

AccountingService_ChangeContractRelation

Request Body schema: application/json
required

contractRelationNumber required	string <int64>
numericId required	string <int64>
ownerId required	string <int64>

Responses

Request samples

Payload

Content type

application/json

{"contractRelationNumber": "string",
"numericId": "string",
"ownerId": "string"
}

Response samples

200
default

Content type

application/json

{ }

AccountingService_GetDocSyncLogs

path Parameters

accountId

required

string <int64>

query Parameters

page	integer <int32>
itemsPerPage	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"logEntries": [{"attachedToEntityId": "string",
"attachedToEntityNumericId": "string",
"documentId": "string",
"documentName": "string",
"timestamp": "string"
}
],
"totalLogsCount": 0,
"totalPageCount": 0
}

AccountingService_GetEnabled

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"accountId": "string",
"disableBackSync": true,
"disableSync": true,
"enabled": true,
"targetAccountId": "string",
"targetEnterpriseId": "string",
"targetMainOwnerId": "string",
"targetMandantId": "string",
"targetProviderId": "string",
"targetSystemId": "string"
}

AccountingService_GetLogs

path Parameters

accountId

required

string <int64>

query Parameters

page	integer <int32>
itemsPerPage	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"logEntries": [{"entityId": "string",
"entityNumericId": "string",
"errorMessage": "string",
"success": true,
"timestamp": "string",
"triggeredBy": {"name": "string",
"userId": "string"
}
}
],
"totalLogsCount": 0,
"totalPageCount": 0
}

AccountingService_GetStatistics

path Parameters

accountId

required

integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"statistics": {"contractErrors": [{"debtorId": "string",
"errorMessages": ["string"
],
"lastTimeSynced": "string",
"numericId": "string",
"ownerId": "string"
}
],
"enabled": true,
"invalidPayloadContractNumericIds": ["string"
],
"invalidPayloadContracts": 0,
"lastContractSync": "string",
"sourceAccountIds": ["string"
],
"successfulContractSync": 0,
"targetAccountId": "string"
}
}

AccountingService_IsEnabled

Request Body schema: application/json
required

propertyIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"propertyIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"isEnabled": [{"enabled": true,
"propertyId": "string"
}
]
}

AccountingService_ListAllContractErrors

Responses

Response samples

200
default

Content type

application/json

{"errors": [{"debtorId": "string",
"errorMessages": ["string"
],
"lastTimeSynced": "string",
"numericId": "string",
"ownerId": "string"
}
]
}

AccountingService_SetEnabled

Request Body schema: application/json
required

accountId required	string <int64>
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>

Responses

Request samples

Payload

Content type

application/json

{"accountId": "string",
"disableBackSync": true,
"disableSync": true,
"enabled": true,
"targetAccountId": "string",
"targetEnterpriseId": "string",
"targetMainOwnerId": "string",
"targetMandantId": "string",
"targetProviderId": "string",
"targetSystemId": "string"
}

Response samples

200
default

Content type

application/json

{ }

AccountingService_SkipNextEvent

Request Body schema: application/json
required

accountId

required

string <int64>

Responses

Request samples

Payload

Content type

application/json

{"accountId": "string"
}

Response samples

200
default

Content type

application/json

{ }

RPCs to trigger back-sync from accounting system to propbase manually

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{ }

AccountingService_TriggerDocumentSync

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{ }

AccountingService_TriggerRentAdjustmentSync

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{ }

HandoverProtocolService

HandoverProtocolService_CountMyDrafts

Responses

Response samples

200
default

Content type

application/json

{"count": 0
}

HandoverProtocolService_Create

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

Payload

Content type

application/json

{"assigneeContactId": "string",
"devicesWithoutRoom": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"draft": true,
"movingInTenancyReferences": [{"objectId": "string",
"tenancyId": "string"
}
],
"movingOutTenancyReferences": [{"objectId": "string",
"tenancyId": "string"
}
],
"note": "string",
"ownerId": "string",
"participants": [{"attending": true,
"contactId": "string",
"powerOfAttorneyMediaIds": ["string"
],
"signed": true,
"type": "PARTICIPANT_TYPE_UNDEFINED"
}
],
"rooms": [{"cleanliness": "CLEANLINESS_ROOM_UNDEFINED",
"cleanlinessAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"cleanlinessCost": 0.1,
"cleanlinessCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"devices": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"name": "string",
"note": "string",
"order": 0,
"referenceId": "string"
}
],
"scheduledDate": {"day": 0,
"month": 0,
"year": 0
},
"scheduledTime": {"hours": 0,
"minutes": 0,
"nanos": 0,
"seconds": 0
},
"templateId": "string"
}

Response samples

200
default

Content type

application/json

{"protocol": {"assigneeContactId": "string",
"creator": {"accountId": "string",
"userId": "string"
},
"devicesWithoutRoom": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"finished": true,
"id": "string",
"movingInTenancyReferences": [{"buildingData": {"name": "string",
"numericId": "string"
},
"objectData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"category": "UNDEFINED_CATEGORY",
"decimalFloor": 0.1,
"name": "string",
"numericId": "string"
},
"objectId": "string",
"propertyData": {"name": "string",
"numericId": "string"
},
"tenancyData": {"contactIds": ["string"
],
"depositAmount": 0.1,
"depositType": "DEPOSIT_TYPE_UNDEFINED",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
},
"tenancyId": "string"
}
],
"movingOutTenancyReferences": [{"buildingData": {"name": "string",
"numericId": "string"
},
"objectData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"category": "UNDEFINED_CATEGORY",
"decimalFloor": 0.1,
"name": "string",
"numericId": "string"
},
"objectId": "string",
"propertyData": {"name": "string",
"numericId": "string"
},
"tenancyData": {"contactIds": ["string"
],
"depositAmount": 0.1,
"depositType": "DEPOSIT_TYPE_UNDEFINED",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
},
"tenancyId": "string"
}
],
"note": "string",
"ownerData": {"name": "string"
},
"ownerId": "string",
"participants": [{"attending": true,
"contactData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"addressHistory": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"contactPersonIds": ["string"
],
"email": "string",
"firstName": "string",
"lastName": "string",
"name": "string",
"phoneNumbers": [{"number": "string",
"type": "PHONE_NUMBER_TYPE_OTHER"
}
]
},
"contactId": "string",
"powerOfAttorneyMediaIds": ["string"
],
"signed": true,
"type": "PARTICIPANT_TYPE_UNDEFINED"
}
],
"protocolMediaId": "string",
"rooms": [{"cleanliness": "CLEANLINESS_ROOM_UNDEFINED",
"cleanlinessAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"cleanlinessCost": 0.1,
"cleanlinessCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"devices": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"name": "string",
"note": "string",
"order": 0,
"referenceId": "string"
}
],
"scheduledDate": {"day": 0,
"month": 0,
"year": 0
},
"scheduledTime": {"hours": 0,
"minutes": 0,
"nanos": 0,
"seconds": 0
},
"status": "PROTOCOL_STATUS_UNDEFINED",
"templateId": "string"
}
}

HandoverProtocolService_Enable

path Parameters

accountId

required

string <int64>

Request Body schema: application/json
required

enable

boolean

Responses

Request samples

Payload

Content type

application/json

{"enable": true
}

Response samples

200
default

Content type

application/json

{ }

Feature enabling

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"enabled": true
}

HandoverProtocolService_ListAllProtocols

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

200
default

Content type

application/json

{"protocols": [{"assigneeContactId": "string",
"creator": {"accountId": "string",
"userId": "string"
},
"devicesWithoutRoom": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"finished": true,
"id": "string",
"movingInTenancyReferences": [{"buildingData": {"name": "string",
"numericId": "string"
},
"objectData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"category": "UNDEFINED_CATEGORY",
"decimalFloor": 0.1,
"name": "string",
"numericId": "string"
},
"objectId": "string",
"propertyData": {"name": "string",
"numericId": "string"
},
"tenancyData": {"contactIds": ["string"
],
"depositAmount": 0.1,
"depositType": "DEPOSIT_TYPE_UNDEFINED",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
},
"tenancyId": "string"
}
],
"movingOutTenancyReferences": [{"buildingData": {"name": "string",
"numericId": "string"
},
"objectData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"category": "UNDEFINED_CATEGORY",
"decimalFloor": 0.1,
"name": "string",
"numericId": "string"
},
"objectId": "string",
"propertyData": {"name": "string",
"numericId": "string"
},
"tenancyData": {"contactIds": ["string"
],
"depositAmount": 0.1,
"depositType": "DEPOSIT_TYPE_UNDEFINED",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
},
"tenancyId": "string"
}
],
"note": "string",
"ownerData": {"name": "string"
},
"ownerId": "string",
"participants": [{"attending": true,
"contactData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"addressHistory": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": null,
"latitude": null,
"longitude": null
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"contactPersonIds": ["string"
],
"email": "string",
"firstName": "string",
"lastName": "string",
"name": "string",
"phoneNumbers": [{"number": "string",
"type": "PHONE_NUMBER_TYPE_OTHER"
}
]
},
"contactId": "string",
"powerOfAttorneyMediaIds": ["string"
],
"signed": true,
"type": "PARTICIPANT_TYPE_UNDEFINED"
}
],
"protocolMediaId": "string",
"rooms": [{"cleanliness": "CLEANLINESS_ROOM_UNDEFINED",
"cleanlinessAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"cleanlinessCost": 0.1,
"cleanlinessCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"devices": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"name": "string",
"note": "string",
"order": 0,
"referenceId": "string"
}
],
"scheduledDate": {"day": 0,
"month": 0,
"year": 0
},
"scheduledTime": {"hours": 0,
"minutes": 0,
"nanos": 0,
"seconds": 0
},
"status": "PROTOCOL_STATUS_UNDEFINED",
"templateId": "string"
}
],
"totalPages": 0,
"totalProtocols": 0
}

HandoverProtocolService_ListByIds

Request Body schema: application/json
required

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
default

Content type

application/json

{"protocols": [{"assigneeContactId": "string",
"creator": {"accountId": "string",
"userId": "string"
},
"devicesWithoutRoom": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"finished": true,
"id": "string",
"movingInTenancyReferences": [{"buildingData": {"name": "string",
"numericId": "string"
},
"objectData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"category": "UNDEFINED_CATEGORY",
"decimalFloor": 0.1,
"name": "string",
"numericId": "string"
},
"objectId": "string",
"propertyData": {"name": "string",
"numericId": "string"
},
"tenancyData": {"contactIds": ["string"
],
"depositAmount": 0.1,
"depositType": "DEPOSIT_TYPE_UNDEFINED",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
},
"tenancyId": "string"
}
],
"movingOutTenancyReferences": [{"buildingData": {"name": "string",
"numericId": "string"
},
"objectData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"category": "UNDEFINED_CATEGORY",
"decimalFloor": 0.1,
"name": "string",
"numericId": "string"
},
"objectId": "string",
"propertyData": {"name": "string",
"numericId": "string"
},
"tenancyData": {"contactIds": ["string"
],
"depositAmount": 0.1,
"depositType": "DEPOSIT_TYPE_UNDEFINED",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
},
"tenancyId": "string"
}
],
"note": "string",
"ownerData": {"name": "string"
},
"ownerId": "string",
"participants": [{"attending": true,
"contactData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"addressHistory": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": null,
"latitude": null,
"longitude": null
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"contactPersonIds": ["string"
],
"email": "string",
"firstName": "string",
"lastName": "string",
"name": "string",
"phoneNumbers": [{"number": "string",
"type": "PHONE_NUMBER_TYPE_OTHER"
}
]
},
"contactId": "string",
"powerOfAttorneyMediaIds": ["string"
],
"signed": true,
"type": "PARTICIPANT_TYPE_UNDEFINED"
}
],
"protocolMediaId": "string",
"rooms": [{"cleanliness": "CLEANLINESS_ROOM_UNDEFINED",
"cleanlinessAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"cleanlinessCost": 0.1,
"cleanlinessCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"devices": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"name": "string",
"note": "string",
"order": 0,
"referenceId": "string"
}
],
"scheduledDate": {"day": 0,
"month": 0,
"year": 0
},
"scheduledTime": {"hours": 0,
"minutes": 0,
"nanos": 0,
"seconds": 0
},
"status": "PROTOCOL_STATUS_UNDEFINED",
"templateId": "string"
}
]
}

HandoverProtocolService_ListByObjectIds

Request Body schema: application/json
required

objectIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"objectIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"protocols": [{"assigneeContactId": "string",
"creator": {"accountId": "string",
"userId": "string"
},
"devicesWithoutRoom": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"finished": true,
"id": "string",
"movingInTenancyReferences": [{"buildingData": {"name": "string",
"numericId": "string"
},
"objectData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"category": "UNDEFINED_CATEGORY",
"decimalFloor": 0.1,
"name": "string",
"numericId": "string"
},
"objectId": "string",
"propertyData": {"name": "string",
"numericId": "string"
},
"tenancyData": {"contactIds": ["string"
],
"depositAmount": 0.1,
"depositType": "DEPOSIT_TYPE_UNDEFINED",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
},
"tenancyId": "string"
}
],
"movingOutTenancyReferences": [{"buildingData": {"name": "string",
"numericId": "string"
},
"objectData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"category": "UNDEFINED_CATEGORY",
"decimalFloor": 0.1,
"name": "string",
"numericId": "string"
},
"objectId": "string",
"propertyData": {"name": "string",
"numericId": "string"
},
"tenancyData": {"contactIds": ["string"
],
"depositAmount": 0.1,
"depositType": "DEPOSIT_TYPE_UNDEFINED",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
},
"tenancyId": "string"
}
],
"note": "string",
"ownerData": {"name": "string"
},
"ownerId": "string",
"participants": [{"attending": true,
"contactData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"addressHistory": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": null,
"latitude": null,
"longitude": null
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"contactPersonIds": ["string"
],
"email": "string",
"firstName": "string",
"lastName": "string",
"name": "string",
"phoneNumbers": [{"number": "string",
"type": "PHONE_NUMBER_TYPE_OTHER"
}
]
},
"contactId": "string",
"powerOfAttorneyMediaIds": ["string"
],
"signed": true,
"type": "PARTICIPANT_TYPE_UNDEFINED"
}
],
"protocolMediaId": "string",
"rooms": [{"cleanliness": "CLEANLINESS_ROOM_UNDEFINED",
"cleanlinessAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"cleanlinessCost": 0.1,
"cleanlinessCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"devices": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"name": "string",
"note": "string",
"order": 0,
"referenceId": "string"
}
],
"scheduledDate": {"day": 0,
"month": 0,
"year": 0
},
"scheduledTime": {"hours": 0,
"minutes": 0,
"nanos": 0,
"seconds": 0
},
"status": "PROTOCOL_STATUS_UNDEFINED",
"templateId": "string"
}
]
}

HandoverProtocolService_ListMyProtocols

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

200
default

Content type

application/json

{"protocols": [{"assigneeContactId": "string",
"creator": {"accountId": "string",
"userId": "string"
},
"devicesWithoutRoom": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"finished": true,
"id": "string",
"movingInTenancyReferences": [{"buildingData": {"name": "string",
"numericId": "string"
},
"objectData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"category": "UNDEFINED_CATEGORY",
"decimalFloor": 0.1,
"name": "string",
"numericId": "string"
},
"objectId": "string",
"propertyData": {"name": "string",
"numericId": "string"
},
"tenancyData": {"contactIds": ["string"
],
"depositAmount": 0.1,
"depositType": "DEPOSIT_TYPE_UNDEFINED",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
},
"tenancyId": "string"
}
],
"movingOutTenancyReferences": [{"buildingData": {"name": "string",
"numericId": "string"
},
"objectData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"category": "UNDEFINED_CATEGORY",
"decimalFloor": 0.1,
"name": "string",
"numericId": "string"
},
"objectId": "string",
"propertyData": {"name": "string",
"numericId": "string"
},
"tenancyData": {"contactIds": ["string"
],
"depositAmount": 0.1,
"depositType": "DEPOSIT_TYPE_UNDEFINED",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
},
"tenancyId": "string"
}
],
"note": "string",
"ownerData": {"name": "string"
},
"ownerId": "string",
"participants": [{"attending": true,
"contactData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"addressHistory": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": null,
"latitude": null,
"longitude": null
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"contactPersonIds": ["string"
],
"email": "string",
"firstName": "string",
"lastName": "string",
"name": "string",
"phoneNumbers": [{"number": "string",
"type": "PHONE_NUMBER_TYPE_OTHER"
}
]
},
"contactId": "string",
"powerOfAttorneyMediaIds": ["string"
],
"signed": true,
"type": "PARTICIPANT_TYPE_UNDEFINED"
}
],
"protocolMediaId": "string",
"rooms": [{"cleanliness": "CLEANLINESS_ROOM_UNDEFINED",
"cleanlinessAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"cleanlinessCost": 0.1,
"cleanlinessCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"devices": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"name": "string",
"note": "string",
"order": 0,
"referenceId": "string"
}
],
"scheduledDate": {"day": 0,
"month": 0,
"year": 0
},
"scheduledTime": {"hours": 0,
"minutes": 0,
"nanos": 0,
"seconds": 0
},
"status": "PROTOCOL_STATUS_UNDEFINED",
"templateId": "string"
}
],
"totalPages": 0,
"totalProtocols": 0
}

HandoverProtocolService_ListOtherProtocols

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

200
default

Content type

application/json

{"protocols": [{"assigneeContactId": "string",
"creator": {"accountId": "string",
"userId": "string"
},
"devicesWithoutRoom": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"finished": true,
"id": "string",
"movingInTenancyReferences": [{"buildingData": {"name": "string",
"numericId": "string"
},
"objectData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"category": "UNDEFINED_CATEGORY",
"decimalFloor": 0.1,
"name": "string",
"numericId": "string"
},
"objectId": "string",
"propertyData": {"name": "string",
"numericId": "string"
},
"tenancyData": {"contactIds": ["string"
],
"depositAmount": 0.1,
"depositType": "DEPOSIT_TYPE_UNDEFINED",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
},
"tenancyId": "string"
}
],
"movingOutTenancyReferences": [{"buildingData": {"name": "string",
"numericId": "string"
},
"objectData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"category": "UNDEFINED_CATEGORY",
"decimalFloor": 0.1,
"name": "string",
"numericId": "string"
},
"objectId": "string",
"propertyData": {"name": "string",
"numericId": "string"
},
"tenancyData": {"contactIds": ["string"
],
"depositAmount": 0.1,
"depositType": "DEPOSIT_TYPE_UNDEFINED",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
},
"tenancyId": "string"
}
],
"note": "string",
"ownerData": {"name": "string"
},
"ownerId": "string",
"participants": [{"attending": true,
"contactData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"addressHistory": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": null,
"latitude": null,
"longitude": null
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"contactPersonIds": ["string"
],
"email": "string",
"firstName": "string",
"lastName": "string",
"name": "string",
"phoneNumbers": [{"number": "string",
"type": "PHONE_NUMBER_TYPE_OTHER"
}
]
},
"contactId": "string",
"powerOfAttorneyMediaIds": ["string"
],
"signed": true,
"type": "PARTICIPANT_TYPE_UNDEFINED"
}
],
"protocolMediaId": "string",
"rooms": [{"cleanliness": "CLEANLINESS_ROOM_UNDEFINED",
"cleanlinessAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"cleanlinessCost": 0.1,
"cleanlinessCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"devices": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"name": "string",
"note": "string",
"order": 0,
"referenceId": "string"
}
],
"scheduledDate": {"day": 0,
"month": 0,
"year": 0
},
"scheduledTime": {"hours": 0,
"minutes": 0,
"nanos": 0,
"seconds": 0
},
"status": "PROTOCOL_STATUS_UNDEFINED",
"templateId": "string"
}
],
"totalPages": 0,
"totalProtocols": 0
}

Templates

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

Payload

Content type

application/json

{"devicesWithoutRoomIds": ["string"
],
"name": "string",
"ownerId": "string",
"rooms": [{"deviceIds": ["string"
],
"id": "string"
}
],
"templateReferences": [{"propertyId": "string",
"propertyName": "string"
}
]
}

Response samples

200
default

Content type

application/json

{"template": {"devicesWithoutRoomIds": ["string"
],
"favorite": true,
"id": "string",
"name": "string",
"ownerId": "string",
"rooms": [{"deviceIds": ["string"
],
"id": "string"
}
],
"templateReferences": [{"propertyId": "string",
"propertyName": "string"
}
]
}
}

HandoverProtocolService_ListTemplates

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"templates": [{"devicesWithoutRoomIds": ["string"
],
"favorite": true,
"id": "string",
"name": "string",
"ownerId": "string",
"rooms": [{"deviceIds": ["string"
],
"id": "string"
}
],
"templateReferences": [{"propertyId": "string",
"propertyName": "string"
}
]
}
]
}

HandoverProtocolService_ListTemplatesByPropertyId

path Parameters

propertyId

required

string

Responses

Response samples

200
default

Content type

application/json

{"templates": [{"devicesWithoutRoomIds": ["string"
],
"favorite": true,
"id": "string",
"name": "string",
"ownerId": "string",
"rooms": [{"deviceIds": ["string"
],
"id": "string"
}
],
"templateReferences": [{"propertyId": "string",
"propertyName": "string"
}
]
}
]
}

HandoverProtocolService_DeleteTemplates

path Parameters

ids

required

Array of strings non-empty

Responses

Response samples

200
default

Content type

application/json

{ }

HandoverProtocolService_GetTemplateById

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{"template": {"devicesWithoutRoomIds": ["string"
],
"favorite": true,
"id": "string",
"name": "string",
"ownerId": "string",
"rooms": [{"deviceIds": ["string"
],
"id": "string"
}
],
"templateReferences": [{"propertyId": "string",
"propertyName": "string"
}
]
}
}

HandoverProtocolService_SetFavoriteTemplate

path Parameters

required

string

Request Body schema: application/json
required

favorite

boolean

Responses

Request samples

Payload

Content type

application/json

{"favorite": true
}

Response samples

200
default

Content type

application/json

{"template": {"devicesWithoutRoomIds": ["string"
],
"favorite": true,
"id": "string",
"name": "string",
"ownerId": "string",
"rooms": [{"deviceIds": ["string"
],
"id": "string"
}
],
"templateReferences": [{"propertyId": "string",
"propertyName": "string"
}
]
}
}

HandoverProtocolService_UpdateTemplate

path Parameters

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

Payload

Content type

application/json

{"devicesWithoutRoomIds": ["string"
],
"name": "string",
"rooms": [{"deviceIds": ["string"
],
"id": "string"
}
],
"templateReferences": [{"propertyId": "string",
"propertyName": "string"
}
]
}

Response samples

200
default

Content type

application/json

{"template": {"devicesWithoutRoomIds": ["string"
],
"favorite": true,
"id": "string",
"name": "string",
"ownerId": "string",
"rooms": [{"deviceIds": ["string"
],
"id": "string"
}
],
"templateReferences": [{"propertyId": "string",
"propertyName": "string"
}
]
}
}

HandoverProtocolService_Delete

path Parameters

required

string

Responses

Response samples

200
default

Content type

application/json

{ }

HandoverProtocolService_GetPdfPreview

path Parameters

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

200
default

Content type

application/json

{"pdf": "string"
}

HandoverProtocolService_SaveData

path Parameters

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

Payload

Content type

application/json

{"devicesWithoutRoom": [{"acquisitionCosts": 0.1,
"action": "ACTION_UNDEFINED",
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deleted": true,
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"note": "string",
"objectId": "string",
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"serialNumber": "string",
"type": "DEVICE_TYPE_UNDEFINED",
"unit": "DEVICE_UNIT_UNDEFINED"
}
],
"note": "string",
"participants": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"addressHistory": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"oldValidFrom": {"day": 0,
"month": 0,
"year": 0
},
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"attending": true,
"companyContactId": "string",
"contactId": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"name": "string",
"phoneNumbers": [{"number": "string",
"type": "PHONE_NUMBER_TYPE_OTHER"
}
],
"powerOfAttorneyMediaIds": ["string"
],
"type": "PARTICIPANT_TYPE_UNDEFINED"
}
],
"rooms": [{"cleanliness": "CLEANLINESS_ROOM_UNDEFINED",
"cleanlinessAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"cleanlinessCost": 0.1,
"cleanlinessCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"deleted": true,
"devices": [{"acquisitionCosts": 0.1,
"action": "ACTION_UNDEFINED",
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deleted": true,
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"note": "string",
"objectId": "string",
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"serialNumber": "string",
"type": "DEVICE_TYPE_UNDEFINED",
"unit": "DEVICE_UNIT_UNDEFINED"
}
],
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"name": "string",
"note": "string",
"objectId": "string"
}
]
}

Response samples

200
default

Content type

application/json

{"protocol": {"assigneeContactId": "string",
"creator": {"accountId": "string",
"userId": "string"
},
"devicesWithoutRoom": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"finished": true,
"id": "string",
"movingInTenancyReferences": [{"buildingData": {"name": "string",
"numericId": "string"
},
"objectData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"category": "UNDEFINED_CATEGORY",
"decimalFloor": 0.1,
"name": "string",
"numericId": "string"
},
"objectId": "string",
"propertyData": {"name": "string",
"numericId": "string"
},
"tenancyData": {"contactIds": ["string"
],
"depositAmount": 0.1,
"depositType": "DEPOSIT_TYPE_UNDEFINED",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
},
"tenancyId": "string"
}
],
"movingOutTenancyReferences": [{"buildingData": {"name": "string",
"numericId": "string"
},
"objectData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"category": "UNDEFINED_CATEGORY",
"decimalFloor": 0.1,
"name": "string",
"numericId": "string"
},
"objectId": "string",
"propertyData": {"name": "string",
"numericId": "string"
},
"tenancyData": {"contactIds": ["string"
],
"depositAmount": 0.1,
"depositType": "DEPOSIT_TYPE_UNDEFINED",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
},
"tenancyId": "string"
}
],
"note": "string",
"ownerData": {"name": "string"
},
"ownerId": "string",
"participants": [{"attending": true,
"contactData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"addressHistory": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"contactPersonIds": ["string"
],
"email": "string",
"firstName": "string",
"lastName": "string",
"name": "string",
"phoneNumbers": [{"number": "string",
"type": "PHONE_NUMBER_TYPE_OTHER"
}
]
},
"contactId": "string",
"powerOfAttorneyMediaIds": ["string"
],
"signed": true,
"type": "PARTICIPANT_TYPE_UNDEFINED"
}
],
"protocolMediaId": "string",
"rooms": [{"cleanliness": "CLEANLINESS_ROOM_UNDEFINED",
"cleanlinessAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"cleanlinessCost": 0.1,
"cleanlinessCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"devices": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"name": "string",
"note": "string",
"order": 0,
"referenceId": "string"
}
],
"scheduledDate": {"day": 0,
"month": 0,
"year": 0
},
"scheduledTime": {"hours": 0,
"minutes": 0,
"nanos": 0,
"seconds": 0
},
"status": "PROTOCOL_STATUS_UNDEFINED",
"templateId": "string"
}
}

HandoverProtocolService_Sign

path Parameters

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

Payload

Content type

application/json

{"language": "PREFERRED_LANGUAGE_UNDEFINED",
"signatures": [{"contactId": "string",
"hasSigned": true,
"signature": "string",
"type": "PARTICIPANT_TYPE_UNDEFINED"
}
]
}

Response samples

200
default

Content type

application/json

{"protocol": {"assigneeContactId": "string",
"creator": {"accountId": "string",
"userId": "string"
},
"devicesWithoutRoom": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"finished": true,
"id": "string",
"movingInTenancyReferences": [{"buildingData": {"name": "string",
"numericId": "string"
},
"objectData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"category": "UNDEFINED_CATEGORY",
"decimalFloor": 0.1,
"name": "string",
"numericId": "string"
},
"objectId": "string",
"propertyData": {"name": "string",
"numericId": "string"
},
"tenancyData": {"contactIds": ["string"
],
"depositAmount": 0.1,
"depositType": "DEPOSIT_TYPE_UNDEFINED",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
},
"tenancyId": "string"
}
],
"movingOutTenancyReferences": [{"buildingData": {"name": "string",
"numericId": "string"
},
"objectData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"category": "UNDEFINED_CATEGORY",
"decimalFloor": 0.1,
"name": "string",
"numericId": "string"
},
"objectId": "string",
"propertyData": {"name": "string",
"numericId": "string"
},
"tenancyData": {"contactIds": ["string"
],
"depositAmount": 0.1,
"depositType": "DEPOSIT_TYPE_UNDEFINED",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
},
"tenancyId": "string"
}
],
"note": "string",
"ownerData": {"name": "string"
},
"ownerId": "string",
"participants": [{"attending": true,
"contactData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"addressHistory": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"contactPersonIds": ["string"
],
"email": "string",
"firstName": "string",
"lastName": "string",
"name": "string",
"phoneNumbers": [{"number": "string",
"type": "PHONE_NUMBER_TYPE_OTHER"
}
]
},
"contactId": "string",
"powerOfAttorneyMediaIds": ["string"
],
"signed": true,
"type": "PARTICIPANT_TYPE_UNDEFINED"
}
],
"protocolMediaId": "string",
"rooms": [{"cleanliness": "CLEANLINESS_ROOM_UNDEFINED",
"cleanlinessAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"cleanlinessCost": 0.1,
"cleanlinessCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"devices": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"name": "string",
"note": "string",
"order": 0,
"referenceId": "string"
}
],
"scheduledDate": {"day": 0,
"month": 0,
"year": 0
},
"scheduledTime": {"hours": 0,
"minutes": 0,
"nanos": 0,
"seconds": 0
},
"status": "PROTOCOL_STATUS_UNDEFINED",
"templateId": "string"
}
}

HandoverProtocolService_Update

path Parameters

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

Payload

Content type

application/json

{"assigneeContactId": "string",
"devicesWithoutRoom": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"draft": true,
"movingInTenancyReferences": [{"objectId": "string",
"tenancyId": "string"
}
],
"movingOutTenancyReferences": [{"objectId": "string",
"tenancyId": "string"
}
],
"note": "string",
"participants": [{"attending": true,
"contactId": "string",
"powerOfAttorneyMediaIds": ["string"
],
"signed": true,
"type": "PARTICIPANT_TYPE_UNDEFINED"
}
],
"rooms": [{"cleanliness": "CLEANLINESS_ROOM_UNDEFINED",
"cleanlinessAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"cleanlinessCost": 0.1,
"cleanlinessCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"devices": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"name": "string",
"note": "string",
"order": 0,
"referenceId": "string"
}
],
"scheduledDate": {"day": 0,
"month": 0,
"year": 0
},
"scheduledTime": {"hours": 0,
"minutes": 0,
"nanos": 0,
"seconds": 0
},
"templateId": "string"
}

Response samples

200
default

Content type

application/json

{"protocol": {"assigneeContactId": "string",
"creator": {"accountId": "string",
"userId": "string"
},
"devicesWithoutRoom": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"finished": true,
"id": "string",
"movingInTenancyReferences": [{"buildingData": {"name": "string",
"numericId": "string"
},
"objectData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"category": "UNDEFINED_CATEGORY",
"decimalFloor": 0.1,
"name": "string",
"numericId": "string"
},
"objectId": "string",
"propertyData": {"name": "string",
"numericId": "string"
},
"tenancyData": {"contactIds": ["string"
],
"depositAmount": 0.1,
"depositType": "DEPOSIT_TYPE_UNDEFINED",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
},
"tenancyId": "string"
}
],
"movingOutTenancyReferences": [{"buildingData": {"name": "string",
"numericId": "string"
},
"objectData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"areas": {"effectiveArea": 0.1,
"livingArea": 0.1,
"netLivingArea": 0.1,
"plotArea": 0.1
},
"category": "UNDEFINED_CATEGORY",
"decimalFloor": 0.1,
"name": "string",
"numericId": "string"
},
"objectId": "string",
"propertyData": {"name": "string",
"numericId": "string"
},
"tenancyData": {"contactIds": ["string"
],
"depositAmount": 0.1,
"depositType": "DEPOSIT_TYPE_UNDEFINED",
"endingAt": {"day": 0,
"month": 0,
"year": 0
},
"startingAt": {"day": 0,
"month": 0,
"year": 0
}
},
"tenancyId": "string"
}
],
"note": "string",
"ownerData": {"name": "string"
},
"ownerId": "string",
"participants": [{"attending": true,
"contactData": {"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"addressHistory": [{"address": {"careOf": "string",
"city": "string",
"country": "string",
"geo": {"elevation": 0.1,
"latitude": 0.1,
"longitude": 0.1
},
"mailbox": "string",
"state": "string",
"street": "string",
"streetAddition": "string",
"streetNumber": "string",
"subUnit": "string",
"zip": "string"
},
"validFrom": {"day": 0,
"month": 0,
"year": 0
}
}
],
"contactPersonIds": ["string"
],
"email": "string",
"firstName": "string",
"lastName": "string",
"name": "string",
"phoneNumbers": [{"number": "string",
"type": "PHONE_NUMBER_TYPE_OTHER"
}
]
},
"contactId": "string",
"powerOfAttorneyMediaIds": ["string"
],
"signed": true,
"type": "PARTICIPANT_TYPE_UNDEFINED"
}
],
"protocolMediaId": "string",
"rooms": [{"cleanliness": "CLEANLINESS_ROOM_UNDEFINED",
"cleanlinessAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"cleanlinessCost": 0.1,
"cleanlinessCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"devices": [{"action": "ACTION_UNDEFINED",
"cleaningNecessary": true,
"condition": "CONDITION_UNDEFINED",
"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"costShareValueCalculated": 0.1,
"deviceData": {"acquisitionCosts": 0.1,
"amount": 0,
"brand": "string",
"cataloguePrice": 0.1,
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"lifeSpan": 0,
"manufacturer": "string",
"model": "string",
"referenceId": "string",
"serialNumber": "string",
"unit": "DEVICE_UNIT_UNDEFINED"
},
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"installationDate": {"day": 0,
"month": 0,
"year": 0
},
"keyData": {"amount": 0,
"combinedKeys": true,
"combinedKeysDescription": "string",
"description": "string",
"keyNumber": "string",
"lockingPlanNumber": "string",
"returnedAmount": 0
},
"note": "string",
"order": 0,
"postCleaningAction": "CLEANLINESS_ROOM_ACTION_UNDEFINED",
"postCleaningCostShareValue": 0.1,
"postCleaningCostUnit": "COST_SHARE_UNIT_UNDEFINED",
"previousCondition": "CONDITION_UNDEFINED",
"type": "DEVICE_TYPE_UNDEFINED"
}
],
"id": "string",
"images": [{"attachTo": "ATTACH_TO_HANDOVER_ONLY",
"mediaId": "string"
}
],
"name": "string",
"note": "string",
"order": 0,
"referenceId": "string"
}
],
"scheduledDate": {"day": 0,
"month": 0,
"year": 0
},
"scheduledTime": {"hours": 0,
"minutes": 0,
"nanos": 0,
"seconds": 0
},
"status": "PROTOCOL_STATUS_UNDEFINED",
"templateId": "string"
}
}

object API (develop:c14720)

EnergySourceService

EnergySourceService_Create

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

EnergySourceService_ListByIds

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

EnergySourceService_ListByReferenceIds

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

EnergySourceService_Delete

path Parameters

Responses

Response samples

EnergySourceService_Update

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ContractService

Create

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete

path Parameters

Responses

Response samples

Read

path Parameters

Responses

Response samples

ContractService_RenderTemplate

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ContractService_RenderDeviceTemplate

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ContractService_RenderTenanciesTemplate

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ContractService_RenderCondominiumTemplate

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ContractService_RenderCondominiumsTemplate

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ContractService_RenderContactTemplate

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ContractService_RenderContactsTemplate

Request Body schema: application/jsonrequired

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required