common API (develop:84871a)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the common stack.

AicService

Confirm AIC support for properties

Confirms AIC support for the given property IDs.

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

{ }

Create a damage report

Creates an AIC damage report with name, module object, user, optional Propbase ticket ID, and detailed damage attributes. Returns the created ticket ID.

Request Body schema: application/json
required

required	object (aicDamageReportAttributes)
id required	integer <int32>
moduleObjectId required	integer <int32>
name required	string
propbaseTicketId required	string
userid required	string

Responses

Request samples

Payload

Content type

application/json

{"attributes": {"accountHolder": "string",
"additionalFileAttributes": [{"fileCaused": "string",
"fileDate": "string",
"fileFirmaName": "string",
"id": 0
}
],
"areInjuriesPresent": "string",
"bankDetailedInfo": "string",
"bankIBAN": "string",
"bankName": "string",
"contacts": [{"Data": {"floor": "string"
},
"Type": "string",
"city": "string",
"email": "string",
"firstname": "string",
"homepage": "string",
"housenumber": "string",
"lastname": "string",
"phone": "string",
"plot": "string",
"region": "string",
"salutation": "string",
"street": "string",
"uid": "string",
"zip": "string"
}
],
"damageAppointment": 0,
"damageCaution": "string",
"damageClaimNumber": "string",
"damageDate": "string",
"damageDetails": "string",
"damageNumberRequested": 0,
"damageState": "string",
"description": "string",
"extentOfDamage": "string",
"injuryDescription": "string",
"insideTheBuilding": 0,
"isDamageRepaired": "string",
"numberOfFlats": "string",
"onsiteRequested": "string",
"outsideTheBuilding": 0,
"regulation": "string"
},
"id": 0,
"moduleObjectId": 0,
"name": "string",
"propbaseTicketId": "string",
"userid": "string"
}

Response samples

200
default

Content type

application/json

{"ticketId": "string"
}

Create an insurance document

Creates a document from the given media file and attaches it to the insurance with the specified name and type. Returns the document ID.

Request Body schema: application/json
required

insuranceId required	string The ID of the insurance this document should be attached to.
mediaId required	string The ID of the media file.
name required	string The name of the document.
type required	string (mediadocumentType) Default: "OTHER" Enum: "OTHER" "APPLICATION_FORM" "HANDOVER_PROTOCOL" "CONTRACT" "BUILDING_PLAN" "INVOICE" "HOUSE_REGULATION" "INSTRUCTION_MANUAL" "CREDIT_CHECK" "OWNERS_MEETING" "PAY_IN_SLIP" "ENERGY_CERTIFICATE" "WARRANTY_CERTIFICATE" "BANK_STATEMENT" "ADDITIONAL_COSTS_BILL" "SEPA_DIRECT_DEBIT_MANDATE" "AGREEMENT" "DEPOSIT_CONFIRMATION" "BUILDING_INSURANCE_POLICY" "KEY_LIST" "TERMINATION_DOC_TYPE" "RENT_ADJUSTMENT_DOC_TYPE" "REFERENCES_DOC_TYPE" "MAINTENANCE_CONTRACT_DOC_TYPE" "REGULATIONS" "REGULATIONS_FOR_USE_AND_MANAGEMENT" "ANNUAL_FINANCIAL_STATEMENT" "PURCHASE_CONTRACT_AND_LAND_REGISTER" "CONDOMINIUM_OWNERSHIP" "RENEWAL_FOND" "MORTGAGE" "ORDER" "OFFER" "IDENTITY" "EXTRACT_FROM_DEBT_COLLECTION_REGISTER" "BANK_ACCOUNT_DETAILS" "PURCHASE_CONTRACT" "LAND_REGISTER" "SITUATION_PLAN" "CONSTRUCTION_LAW_AGREEMENT" "EASEMENT_AGREEMENT" "CADASTRAL_ESTIMATE" "LETTER" "TRADE_REGISTER_EXCERPT" "PAYMENT_REMINDER" "PROTOCOL" "COURT_DOC_TYPE" "HONORARIUM" "BUDGET" "OFFICIAL_ESTIMATE" "BUILDING_DESCRIPTION" "PERMITS" "LEGAL_MATTERS" "TENANT_CHANGE_NOTIFICATION" "LOSS_RATIO" "SHARE_CERTIFICATE_DOCUMENT"

Responses

Request samples

Payload

Content type

application/json

{"insuranceId": "string",
"mediaId": "string",
"name": "string",
"type": "OTHER"
}

Response samples

200
default

Content type

application/json

{"documentId": "string"
}

Add an insurance policy document

Attaches the given media file as an insurance policy document to the specified insurance. Returns the document ID.

Request Body schema: application/json
required

insuranceId required	string The ID of the insurance this file should be attached to.
mediaId required	string The ID of the media file.

Responses

Request samples

Payload

Content type

application/json

{"insuranceId": "string",
"mediaId": "string"
}

Response samples

200
default

Content type

application/json

{"documentId": "string"
}

Add an invoice document

Attaches the given media file as an invoice document to the specified insurance. Returns the document ID.

Request Body schema: application/json
required

insuranceId required	string The ID of the insurance this file should be attached to.
mediaId required	string The ID of the media file.

Responses

Request samples

Payload

Content type

application/json

{"insuranceId": "string",
"mediaId": "string"
}

Response samples

200
default

Content type

application/json

{"documentId": "string"
}

Add a loss ratio document

Attaches the given media file as a loss ratio document to the specified insurance. Returns the document ID.

Request Body schema: application/json
required

insuranceId required	string The ID of the insurance this file should be attached to.
mediaId required	string The ID of the media file.

Responses

Request samples

Payload

Content type

application/json

{"insuranceId": "string",
"mediaId": "string"
}

Response samples

200
default

Content type

application/json

{"documentId": "string"
}

Enable or disable AIC

Enables or disables the AIC integration for the given account.

Request Body schema: application/json
required

accountId required	string <int64>
enable required	boolean

Responses

Request samples

Payload

Content type

application/json

{"accountId": "string",
"enable": true
}

Response samples

200
default

Content type

application/json

{ }

Get AIC sync mode for properties

Returns a map of property ID to AIC sync mode for the given account and property IDs.

Request Body schema: application/json
required

accountId required	string <int64>
propertyIds required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"accountId": "string",
"propertyIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"syncModes": {"property1": "AIC_SYNC_MODE_DISABLED",
"property2": "AIC_SYNC_MODE_DISABLED"
}
}

Get AIC sync modes by property

Returns a map of account ID to AIC sync mode for the given property.

path Parameters

propertyId

required

string

Responses

Response samples

200
default

Content type

application/json

{"syncModes": {"property1": "AIC_SYNC_MODE_DISABLED",
"property2": "AIC_SYNC_MODE_DISABLED"
}
}

Create an AIC insurance

Creates an insurance policy linked to a property (referenceId), including AIC policy ID, type, amounts, excess, and start/end dates. Returns the created insurance.

Request Body schema: application/json
required

aicId required	string <int64> The AIC policy ID
amount required	number <float>
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>
insuranceWorkspaceId required	string <int64>
policyNumber required	string
referenceId required	string The propbase propertyId (prop_xxxxx) where this insurance should be attached to
required	object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:) A full date, with non-zero year, month, and day values A month and day value, with a zero year, such as an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, such as a credit card expiration date Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`.
type required	string (insuranceInsuranceType) Default: "INSURANCE_TYPE_UNDEFINED" Enum: "INSURANCE_TYPE_UNDEFINED" "INSURANCE_TYPE_FIRE_ELEMENTAL_DAMAGE" "INSURANCE_TYPE_BUILDING_PROPERTY_LIABILITY" "INSURANCE_TYPE_LIABILITY" "INSURANCE_TYPE_BUILDING_PROPERTY_INSURANCE" "INSURANCE_TYPE_LEGAL_EXPENSES" "INSURANCE_TYPE_CONSTRUCTION_LIABILITY" "INSURANCE_TYPE_CANTONAL_BUILDING_INSURANCE" "INSURANCE_TYPE_ACCIDENT_INSURANCE" "INSURANCE_TYPE_ART_IN_ARCHITECTURE" "INSURANCE_TYPE_BUSINESS_INSURANCE" "INSURANCE_TYPE_ACCIDENT_INSURANCE_UVG" "INSURANCE_TYPE_BUILDERS_LIABILITY_INSURANCE" "INSURANCE_TYPE_CONSTRUCTION_INSURANCE" "INSURANCE_TYPE_BUILDERS_LIABILITY_VISITOR_CUSTOMER_ACCIDENT" "INSURANCE_TYPE_CONSTRUCTION_VISITOR_CUSTOMER_ACCIDENT" "INSURANCE_TYPE_BUILDERS_LIABILITY_CONSTRUCTION_VISITOR_CUSTOMER_ACCIDENT" "INSURANCE_TYPE_TENANCY_DEPOSIT" "INSURANCE_TYPE_ENVIRONMENTAL_LIABILITY" "INSURANCE_TYPE_PROFESSIONAL_LIABILITY" "INSURANCE_TYPE_OBJECT" "INSURANCE_TYPE_PERSONAL_LIABILITY" "INSURANCE_TYPE_ADVANCE_PAYMENT_GUARANTEE" "INSURANCE_TYPE_BID_BOND" "INSURANCE_TYPE_PERFORMANCE_GUARANTEE" "INSURANCE_TYPE_WARRANTY_FOR_DEFECTS" "INSURANCE_TYPE_CYBER" "INSURANCE_TYPE_D_AND_O" "INSURANCE_TYPE_PROPERTY_INSURANCE" "INSURANCE_TYPE_ENGINEERING_INSURANCE" "INSURANCE_TYPE_VISITOR_CUSTOMER_ACCIDENT" "INSURANCE_TYPE_OTHER"
yearlyCosts required	number <float>

Responses

Request samples

Payload

Content type

application/json

{"aicId": "string",
"amount": 0.1,
"endDate": {"day": 0,
"month": 0,
"year": 0
},
"excess": 0.1,
"insuranceWorkspaceId": "string",
"policyNumber": "string",
"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
}
}

Update an AIC insurance

Updates an existing insurance by ID, including property reference, type, amounts, excess, and start/end dates. Returns the updated insurance.

path Parameters

id

required

string

Request Body schema: application/json
required

amount	number <float>
	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>
insuranceWorkspaceId	string <int64>
policyNumber	string
referenceId	string The propbase propertyId (prop_xxxxx) where this insurance should be attached to
	object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:) A full date, with non-zero year, month, and day values A month and day value, with a zero year, such as an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, such as a credit card expiration date Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`.
type	string (insuranceInsuranceType) Default: "INSURANCE_TYPE_UNDEFINED" Enum: "INSURANCE_TYPE_UNDEFINED" "INSURANCE_TYPE_FIRE_ELEMENTAL_DAMAGE" "INSURANCE_TYPE_BUILDING_PROPERTY_LIABILITY" "INSURANCE_TYPE_LIABILITY" "INSURANCE_TYPE_BUILDING_PROPERTY_INSURANCE" "INSURANCE_TYPE_LEGAL_EXPENSES" "INSURANCE_TYPE_CONSTRUCTION_LIABILITY" "INSURANCE_TYPE_CANTONAL_BUILDING_INSURANCE" "INSURANCE_TYPE_ACCIDENT_INSURANCE" "INSURANCE_TYPE_ART_IN_ARCHITECTURE" "INSURANCE_TYPE_BUSINESS_INSURANCE" "INSURANCE_TYPE_ACCIDENT_INSURANCE_UVG" "INSURANCE_TYPE_BUILDERS_LIABILITY_INSURANCE" "INSURANCE_TYPE_CONSTRUCTION_INSURANCE" "INSURANCE_TYPE_BUILDERS_LIABILITY_VISITOR_CUSTOMER_ACCIDENT" "INSURANCE_TYPE_CONSTRUCTION_VISITOR_CUSTOMER_ACCIDENT" "INSURANCE_TYPE_BUILDERS_LIABILITY_CONSTRUCTION_VISITOR_CUSTOMER_ACCIDENT" "INSURANCE_TYPE_TENANCY_DEPOSIT" "INSURANCE_TYPE_ENVIRONMENTAL_LIABILITY" "INSURANCE_TYPE_PROFESSIONAL_LIABILITY" "INSURANCE_TYPE_OBJECT" "INSURANCE_TYPE_PERSONAL_LIABILITY" "INSURANCE_TYPE_ADVANCE_PAYMENT_GUARANTEE" "INSURANCE_TYPE_BID_BOND" "INSURANCE_TYPE_PERFORMANCE_GUARANTEE" "INSURANCE_TYPE_WARRANTY_FOR_DEFECTS" "INSURANCE_TYPE_CYBER" "INSURANCE_TYPE_D_AND_O" "INSURANCE_TYPE_PROPERTY_INSURANCE" "INSURANCE_TYPE_ENGINEERING_INSURANCE" "INSURANCE_TYPE_VISITOR_CUSTOMER_ACCIDENT" "INSURANCE_TYPE_OTHER"
yearlyCosts	number <float>

Responses

Request samples

Payload

Content type

application/json

{"amount": 0.1,
"endDate": {"day": 0,
"month": 0,
"year": 0
},
"excess": 0.1,
"insuranceWorkspaceId": "string",
"policyNumber": "string",
"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
}
}

Check if AIC is enabled

Returns whether the AIC integration is enabled for the given account.

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"enabled": true
}

Get AIC JWT public key

Returns the JWT public key in PEM format (base64 encoded) used to verify AIC tokens. The request has no parameters.

Responses

Response samples

200
default

Content type

application/json

{"publicKey": "string"
}

Create a note on a ticket

Creates a note on the given ticket for the specified user, optionally with media attachments. Returns the created note.

Request Body schema: application/json
required

mediaIds required	Array of strings
note required	string
ticketId required	string
userId required	string

Responses

Request samples

Payload

Content type

application/json

{"mediaIds": ["string"
],
"note": "string",
"ticketId": "string",
"userId": "string"
}

Response samples

200
default

Content type

application/json

{"note": {"accountInternal": true,
"createdAt": "string",
"creator": {"creatorId": "string",
"email": "string",
"name": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"historyEntries": [{"editedAt": "string",
"previousMediaIds": ["string"
],
"previousNote": "string"
}
],
"id": "string",
"mediaIds": ["string"
],
"mentions": [{"accountId": "string",
"userId": "string"
}
],
"note": "string",
"ownerId": "string",
"referenceIds": ["string"
],
"updatedAt": "string"
}
}

Set AIC sync mode for properties

Sets AIC sync modes for properties of the given account using buckets of syncMode and property IDs.

Request Body schema: application/json
required

accountId required	string <int64>
required	Array of objects (aicSetSyncModeBucket)

Responses

Request samples

Payload

Content type

application/json

{"accountId": "string",
"buckets": [{"propertyIds": ["string"
],
"syncMode": "AIC_SYNC_MODE_DISABLED"
}
]
}

Response samples

200
default

Content type

application/json

{ }

Get AIC SSO URL

Returns a single sign-on URL for AIC, targeting the given landing page and optional entity or ticket ID.

query Parameters

landingPage	string Default: "AIC_LANDING_PAGE_DASHBOARD" Enum: "AIC_LANDING_PAGE_DASHBOARD" "AIC_LANDING_PAGE_PROPERTY_OVERVIEW" "AIC_LANDING_PAGE_PROPERTY_DETAILS" "AIC_LANDING_PAGE_DAMAGES_OVERVIEW" "AIC_LANDING_PAGE_DAMAGES_DETAILS" "AIC_LANDING_PAGE_CREATE_DAMAGE_REPORT" "AIC_LANDING_PAGE_INSURANCE" "AIC_LANDING_PAGE_FASTLANE"
entityId	string Optional. The ID of the entity to open. For example the propertyId, insuranceId or ticketId of the damage report.
ticketId	string Optional and used only on AIC_LANDING_PAGE_CREATE_DAMAGE_REPORT. The ticketId of which this damage report originates from.

Responses

Response samples

200
default

Content type

application/json

{"url": "string"
}

AileanService

Activate properties for Ailean

Activates the given property IDs for Ailean under the specified account.

Request Body schema: application/json
required

accountId required	string <int64>
propertyIds required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"accountId": "string",
"propertyIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

Create an Ailean ticket

Creates a ticket for the given account using the nested ticket create request and returns the create response.

Request Body schema: application/json
required

accountId required	string <int64>
required	object (ticketticketCreateRequest)

Responses

Request samples

Payload

Content type

application/json

{"accountId": "string",
"createRequest": {"additionalData": [{"key": "string",
"value": "string"
}
],
"assignee": {"accountId": "string",
"userId": "string"
},
"checklist": [{"assignee": {"accountId": "string",
"accountLogoUrl": "string",
"accountName": "string",
"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"
},
"email": "string",
"name": "string",
"phone": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"id": "string",
"note": "string",
"order": 0,
"status": "CHECKLIST_ITEM_STATUS_OPEN",
"title": "string"
}
],
"correspondences": [{"contactId": "string"
}
],
"costs": {"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"room": "string"
},
"costsEntries": [{"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"room": "string"
}
],
"description": "string",
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"externalTicketWatchers": [{"contactId": "string",
"email": "string",
"includeCorrespondenceContact": true,
"name": "string",
"notifyOnlyStatusChanges": true
}
],
"key": "string",
"links": [{"ticketId": "string",
"type": "TICKET_LINK_TYPE_RELATES"
}
],
"mediaIds": ["string"
],
"onSiteContact": {"contactId": "string",
"includeCorrespondenceContact": true,
"notify": true,
"notifyOnlyStatusChanges": true
},
"onSiteContacts": [{"contactId": "string",
"includeCorrespondenceContact": true,
"notify": true,
"notifyOnlyStatusChanges": true
}
],
"ownerId": "string",
"priority": "DEFAULT",
"recurrence": {"createAtAmount": 0,
"createAtUnit": "SCHEDULE_UNIT_UNDEFINED",
"repeatAmount": 0,
"repeatUnit": "SCHEDULE_UNIT_UNDEFINED"
},
"references": [{"id": "string",
"relatedIds": ["string"
]
}
],
"startDate": {"day": 0,
"month": 0,
"year": 0
},
"status": "TICKET_STATUS_OPEN",
"title": "string",
"type": "TICKET_TYPE_UNDEFINED",
"watchers": [{"accountId": "string",
"userId": "string"
}
]
}
}

Response samples

200
default

Content type

application/json

{"createResponse": {"ticket": {"additionalData": [{"key": "string",
"value": "string"
}
],
"assignee": {"accountId": "string",
"accountLogoUrl": "string",
"accountName": "string",
"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"
},
"email": "string",
"name": "string",
"phone": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"checklist": [{"assignee": {"accountId": "string",
"accountLogoUrl": "string",
"accountName": "string",
"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"
},
"email": "string",
"name": "string",
"phone": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"id": "string",
"note": "string",
"order": 0,
"status": "CHECKLIST_ITEM_STATUS_OPEN",
"title": "string"
}
],
"correspondences": [{"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"
},
"companyName": "string",
"contactId": "string",
"email": "string",
"name": "string",
"phone": "string"
}
],
"costs": {"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"room": "string"
},
"costsEntries": [{"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"room": "string"
}
],
"createdAt": "string",
"creator": {"accountId": "string",
"accountLogoUrl": "string",
"accountName": "string",
"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"
},
"email": "string",
"name": "string",
"phone": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"description": "string",
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"externalTicketWatchers": [{"contactId": "string",
"email": "string",
"includeCorrespondenceContact": true,
"name": "string",
"notifyOnlyStatusChanges": true
}
],
"id": "string",
"invoiceDocumentId": "string",
"key": "string",
"links": [{"ticketId": "string",
"type": "TICKET_LINK_TYPE_RELATES"
}
],
"mediaIds": ["string"
],
"onSiteContact": {"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"
},
"companyName": "string",
"contactId": "string",
"email": "string",
"name": "string",
"phone": "string",
"phoneNumbers": [{"number": "string",
"type": "PHONE_NUMBER_TYPE_OTHER"
}
]
},
"onSiteContacts": [{"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"
},
"companyName": "string",
"contactId": "string",
"email": "string",
"name": "string",
"phone": "string",
"phoneNumbers": [{"number": "string",
"type": "PHONE_NUMBER_TYPE_OTHER"
}
]
}
],
"ownerId": "string",
"priority": "DEFAULT",
"publicId": "string",
"readStatus": {"assignee": true
},
"recurrence": {"createAtAmount": 0,
"createAtUnit": "SCHEDULE_UNIT_UNDEFINED",
"repeatAmount": 0,
"repeatUnit": "SCHEDULE_UNIT_UNDEFINED"
},
"references": [{"id": "string",
"relatedIds": ["string"
]
}
],
"startDate": {"day": 0,
"month": 0,
"year": 0
},
"status": "TICKET_STATUS_OPEN",
"title": "string",
"type": "TICKET_TYPE_UNDEFINED",
"updatedAt": "string",
"watchers": [{"accountId": "string",
"accountName": "string",
"name": "string",
"profilePictureUrl": "string",
"userId": "string"
}
]
}
}
}

Create a ticket comment

Adds a comment to the given ticket for the account, optionally with media attachments. When accountInternal is true, the comment is only visible within the account.

Request Body schema: application/json
required

accountId required	string <int64>
accountInternal required	boolean If true, the comment is only visible within the account (internal note).
comment required	string
mediaIds required	Array of strings
ticketId required	string

Responses

Request samples

Payload

Content type

application/json

{"accountId": "string",
"accountInternal": true,
"comment": "string",
"mediaIds": ["string"
],
"ticketId": "string"
}

Response samples

200
default

Content type

application/json

{"comment": {"accountInternal": true,
"createdAt": "string",
"creator": {"creatorId": "string",
"email": "string",
"name": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"historyEntries": [{"editedAt": "string",
"previousMediaIds": ["string"
],
"previousNote": "string"
}
],
"id": "string",
"mediaIds": ["string"
],
"mentions": [{"accountId": "string",
"userId": "string"
}
],
"note": "string",
"ownerId": "string",
"referenceIds": ["string"
],
"updatedAt": "string"
}
}

Deactivate properties for Ailean

Deactivates the given property IDs for Ailean under the specified account.

Request Body schema: application/json
required

accountId required	string <int64>
propertyIds required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"accountId": "string",
"propertyIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{ }

Enable or disable Ailean

Enables or disables the Ailean integration for the given account.

Request Body schema: application/json
required

accountId required	string <int64>
enable required	boolean

Responses

Request samples

Payload

Content type

application/json

{"accountId": "string",
"enable": true
}

Response samples

200
default

Content type

application/json

{ }

Get tenants by account ID

Returns tenants for the given account, including contact details and their contracts with object, building, and property context.

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"tenants": [{"contracts": [{"additionalCostsPerMonthChf": 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"
},
"building": {"id": "string"
},
"depositChf": 0.1,
"endDate": {"day": 0,
"month": 0,
"year": 0
},
"id": "string",
"isVacancy": true,
"netRentPerMonthChf": 0.1,
"object": {"awn": "string",
"category": "UNDEFINED_CATEGORY",
"ewid": "string",
"floor": 0.1,
"id": "string",
"livingArea": 0.1,
"name": "string",
"number": "string",
"subCategories": ["UNDEFINED_SUB_CATEGORY"
]
},
"property": {"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"
},
"id": "string",
"name": "string",
"ownerId": "string",
"ownerName": "string"
},
"startDate": {"day": 0,
"month": 0,
"year": 0
},
"typeOfUse": "TYPE_OF_USE_UNDEFINED"
}
],
"emails": ["string"
],
"id": "string",
"name": "string",
"phoneNumbers": ["string"
]
}
]
}

Get an Ailean ticket

Returns the ticket identified by the given ticket ID.

path Parameters

ticketId

required

string

Responses

Response samples

200
default

Content type

application/json

{"ticket": {"additionalData": [{"key": "string",
"value": "string"
}
],
"assignee": {"accountId": "string",
"accountLogoUrl": "string",
"accountName": "string",
"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"
},
"email": "string",
"name": "string",
"phone": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"checklist": [{"assignee": {"accountId": "string",
"accountLogoUrl": "string",
"accountName": "string",
"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"
},
"email": "string",
"name": "string",
"phone": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"id": "string",
"note": "string",
"order": 0,
"status": "CHECKLIST_ITEM_STATUS_OPEN",
"title": "string"
}
],
"correspondences": [{"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"
},
"companyName": "string",
"contactId": "string",
"email": "string",
"name": "string",
"phone": "string"
}
],
"costs": {"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"room": "string"
},
"costsEntries": [{"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"room": "string"
}
],
"createdAt": "string",
"creator": {"accountId": "string",
"accountLogoUrl": "string",
"accountName": "string",
"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"
},
"email": "string",
"name": "string",
"phone": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"description": "string",
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"externalTicketWatchers": [{"contactId": "string",
"email": "string",
"includeCorrespondenceContact": true,
"name": "string",
"notifyOnlyStatusChanges": true
}
],
"id": "string",
"invoiceDocumentId": "string",
"key": "string",
"links": [{"ticketId": "string",
"type": "TICKET_LINK_TYPE_RELATES"
}
],
"mediaIds": ["string"
],
"onSiteContact": {"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"
},
"companyName": "string",
"contactId": "string",
"email": "string",
"name": "string",
"phone": "string",
"phoneNumbers": [{"number": "string",
"type": "PHONE_NUMBER_TYPE_OTHER"
}
]
},
"onSiteContacts": [{"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"
},
"companyName": "string",
"contactId": "string",
"email": "string",
"name": "string",
"phone": "string",
"phoneNumbers": [{"number": "string",
"type": "PHONE_NUMBER_TYPE_OTHER"
}
]
}
],
"ownerId": "string",
"priority": "DEFAULT",
"publicId": "string",
"readStatus": {"assignee": true
},
"recurrence": {"createAtAmount": 0,
"createAtUnit": "SCHEDULE_UNIT_UNDEFINED",
"repeatAmount": 0,
"repeatUnit": "SCHEDULE_UNIT_UNDEFINED"
},
"references": [{"id": "string",
"relatedIds": ["string"
]
}
],
"startDate": {"day": 0,
"month": 0,
"year": 0
},
"status": "TICKET_STATUS_OPEN",
"title": "string",
"type": "TICKET_TYPE_UNDEFINED",
"updatedAt": "string",
"watchers": [{"accountId": "string",
"accountName": "string",
"name": "string",
"profilePictureUrl": "string",
"userId": "string"
}
]
}
}

Check if Ailean is enabled

Returns whether the Ailean integration is enabled for the given account.

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"enabled": true
}

Get Ailean JWT public key

Returns the JWT public key in PEM format (base64 encoded) used to verify Ailean tokens. The request has no parameters.

Responses

Response samples

200
default

Content type

application/json

{"publicKey": "string"
}

List employees by account ID

Returns employees for the given account with name, email, and roles.

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"employees": [{"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"roles": ["string"
]
}
]
}

List properties by account ID

Returns properties for the given account, including address, linked contacts, and the admin assignee.

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"properties": [{"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"
},
"assigneeAdmin": {"emails": ["string"
],
"id": "string",
"name": "string",
"phoneNumbers": ["string"
],
"userId": "string"
},
"contacts": [{"emails": ["string"
],
"id": "string",
"industries": ["INDUSTRY_UNDEFINED_VALUE"
],
"isCompany": true,
"linkedAs": "BUILDING_CONTACT_TYPE_UNDEFINED",
"name": "string",
"phoneNumbers": ["string"
],
"preferredLanguage": "PREFERRED_LANGUAGE_UNDEFINED"
}
],
"id": "string",
"name": "string",
"ownerId": "string",
"ownerName": "string"
}
]
}

List Ailean property activations

Returns activation entries (accountId and propertyId) for the given property IDs. Properties missing from the response are not activated.

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

{"entries": [{"accountId": "string",
"propertyId": "string"
}
]
}

List ticket comments

Returns all comments for the given ticket.

path Parameters

ticketId

required

string

Responses

Response samples

200
default

Content type

application/json

{"comments": [{"accountInternal": true,
"createdAt": "string",
"creator": {"creatorId": "string",
"email": "string",
"name": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"historyEntries": [{"editedAt": "string",
"previousMediaIds": ["string"
],
"previousNote": "string"
}
],
"id": "string",
"mediaIds": ["string"
],
"mentions": [{"accountId": "string",
"userId": "string"
}
],
"note": "string",
"ownerId": "string",
"referenceIds": ["string"
],
"updatedAt": "string"
}
]
}

Get Ailean SSO URL

Returns a single sign-on URL for accessing Ailean. The request has no parameters.

Responses

Response samples

200
default

Content type

application/json

{"url": "string"
}

Update an Ailean ticket

Updates an existing ticket using the nested ticket update request and returns the update response.

Request Body schema: application/json
required

required

object (ticketticketUpdateRequest)

Responses

Request samples

Payload

Content type

application/json

{"updateRequest": {"omitCorrespondenceNotification": true,
"update": {"additionalData": [{"key": "string",
"value": "string"
}
],
"assignee": {"accountId": "string",
"userId": "string"
},
"checklist": [{"assignee": {"accountId": "string",
"accountLogoUrl": "string",
"accountName": "string",
"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"
},
"email": "string",
"name": "string",
"phone": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"id": "string",
"note": "string",
"order": 0,
"status": "CHECKLIST_ITEM_STATUS_OPEN",
"title": "string"
}
],
"correspondences": [{"contactId": "string"
}
],
"costs": {"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"room": "string"
},
"costsEntries": [{"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"room": "string"
}
],
"description": "string",
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"externalTicketWatchers": [{"contactId": "string",
"email": "string",
"includeCorrespondenceContact": true,
"name": "string",
"notifyOnlyStatusChanges": true
}
],
"id": "string",
"links": [{"ticketId": "string",
"type": "TICKET_LINK_TYPE_RELATES"
}
],
"mediaIds": ["string"
],
"onSiteContact": {"contactId": "string",
"includeCorrespondenceContact": true,
"notify": true,
"notifyOnlyStatusChanges": true
},
"onSiteContacts": [{"contactId": "string",
"includeCorrespondenceContact": true,
"notify": true,
"notifyOnlyStatusChanges": true
}
],
"ownerId": "string",
"priority": "DEFAULT",
"recurrence": {"createAtAmount": 0,
"createAtUnit": "SCHEDULE_UNIT_UNDEFINED",
"repeatAmount": 0,
"repeatUnit": "SCHEDULE_UNIT_UNDEFINED"
},
"references": [{"id": "string",
"relatedIds": ["string"
]
}
],
"startDate": {"day": 0,
"month": 0,
"year": 0
},
"status": "TICKET_STATUS_OPEN",
"title": "string",
"type": "TICKET_TYPE_UNDEFINED",
"watchers": [{"accountId": "string",
"userId": "string"
}
]
},
"updateMask": "string",
"updateRecurrenceFields": true
}
}

Response samples

200
default

Content type

application/json

{"updateResponse": {"ticket": {"additionalData": [{"key": "string",
"value": "string"
}
],
"assignee": {"accountId": "string",
"accountLogoUrl": "string",
"accountName": "string",
"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"
},
"email": "string",
"name": "string",
"phone": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"checklist": [{"assignee": {"accountId": "string",
"accountLogoUrl": "string",
"accountName": "string",
"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"
},
"email": "string",
"name": "string",
"phone": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"id": "string",
"note": "string",
"order": 0,
"status": "CHECKLIST_ITEM_STATUS_OPEN",
"title": "string"
}
],
"correspondences": [{"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"
},
"companyName": "string",
"contactId": "string",
"email": "string",
"name": "string",
"phone": "string"
}
],
"costs": {"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"room": "string"
},
"costsEntries": [{"costAbsorption": "COST_ABSORPTION_UNDEFINED",
"costShareUnit": "COST_SHARE_UNIT_UNDEFINED",
"costShareValue": 0.1,
"room": "string"
}
],
"createdAt": "string",
"creator": {"accountId": "string",
"accountLogoUrl": "string",
"accountName": "string",
"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"
},
"email": "string",
"name": "string",
"phone": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"description": "string",
"dueDate": {"day": 0,
"month": 0,
"year": 0
},
"externalTicketWatchers": [{"contactId": "string",
"email": "string",
"includeCorrespondenceContact": true,
"name": "string",
"notifyOnlyStatusChanges": true
}
],
"id": "string",
"invoiceDocumentId": "string",
"key": "string",
"links": [{"ticketId": "string",
"type": "TICKET_LINK_TYPE_RELATES"
}
],
"mediaIds": ["string"
],
"onSiteContact": {"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"
},
"companyName": "string",
"contactId": "string",
"email": "string",
"name": "string",
"phone": "string",
"phoneNumbers": [{"number": "string",
"type": "PHONE_NUMBER_TYPE_OTHER"
}
]
},
"onSiteContacts": [{"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"
},
"companyName": "string",
"contactId": "string",
"email": "string",
"name": "string",
"phone": "string",
"phoneNumbers": [{"number": "string",
"type": "PHONE_NUMBER_TYPE_OTHER"
}
]
}
],
"ownerId": "string",
"priority": "DEFAULT",
"publicId": "string",
"readStatus": {"assignee": true
},
"recurrence": {"createAtAmount": 0,
"createAtUnit": "SCHEDULE_UNIT_UNDEFINED",
"repeatAmount": 0,
"repeatUnit": "SCHEDULE_UNIT_UNDEFINED"
},
"references": [{"id": "string",
"relatedIds": ["string"
]
}
],
"startDate": {"day": 0,
"month": 0,
"year": 0
},
"status": "TICKET_STATUS_OPEN",
"title": "string",
"type": "TICKET_TYPE_UNDEFINED",
"updatedAt": "string",
"watchers": [{"accountId": "string",
"accountName": "string",
"name": "string",
"profilePictureUrl": "string",
"userId": "string"
}
]
}
}
}

CredittrustService

Get a credit certificate

Returns the certificate bytes for the given order ID.

query Parameters

orderId

string

Responses

Response samples

200
default

Content type

application/json

{"certificate": "string"
}

Order a credit certificate

Orders a credit certificate for the given person (name, email, address, date of birth, and optional previous address and affiliate data). Returns whether a certificate is issuable, the order ID, and CRIF/Intrum match and approval flags.

Request Body schema: application/json
required

affiliateOrderId required	string
city 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`.
email required	string
firstName required	string
houseNumber required	string
lastName required	string
locale required	string
oldCity required	string
oldHouseNumber required	string
oldPostalCode required	integer <int32>
oldStreet required	string
postalCode required	integer <int32>
referrerUrl required	string
street required	string
subAffiliate required	string

Responses

Request samples

Payload

Content type

application/json

{"affiliateOrderId": "string",
"city": "string",
"dateOfBirth": {"day": 0,
"month": 0,
"year": 0
},
"email": "string",
"firstName": "string",
"houseNumber": "string",
"lastName": "string",
"locale": "string",
"oldCity": "string",
"oldHouseNumber": "string",
"oldPostalCode": 0,
"oldStreet": "string",
"postalCode": 0,
"referrerUrl": "string",
"street": "string",
"subAffiliate": "string"
}

Response samples

200
default

Content type

application/json

{"certificateIssuable": true,
"crifApproval": true,
"crifMatch": true,
"intrumApproval": true,
"intrumMatch": true,
"orderId": "string"
}

Verify a credit certificate

Verifies the given certificate and returns issuer verification details plus the identified person's name and date of birth.

Request Body schema: application/json
required

certificate

required

string

Responses

Request samples

Payload

Content type

application/json

{"certificate": "string"
}

Response samples

200
default

Content type

application/json

{"identification": {"dateOfBirth": {"day": 0,
"month": 0,
"year": 0
},
"firstName": "string",
"lastName": "string"
},
"verification": {"fileHash": "string",
"issuerName": "string",
"issuerVerified": true,
"registeredAt": {"day": 0,
"month": 0,
"year": 0
}
}
}

DeepoService

Analyse Deepo node status

Checks whether processing has finished for the Deepo file transmission identified by fileTransmissionId.

path Parameters

fileTransmissionId

required

string

Responses

Response samples

200
default

Content type

application/json

{"finished": true
}

Get file transmissions by reference ID

Returns Deepo file transmissions associated with the given reference ID.

path Parameters

referenceId

required

string

Responses

Response samples

200
default

Content type

application/json

{"fileTransmissions": [{"created": "string",
"editorUrl": "string",
"id": "string",
"issuer": {"accountId": "string",
"userId": "string"
},
"mediaId": "string",
"processed": true,
"referenceIds": ["string"
]
}
]
}

Get partner access URL

Returns the Deepo partner access URL for the given account.

query Parameters

accountId

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"url": "string"
}

Check if Deepo is enabled

Returns whether Deepo is enabled for the given account.

query Parameters

accountId

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"enabled": true
}

Repair Deepo service account

Attempts to repair the Deepo service account for the given account ID. Returns success and an optional message.

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

{"message": "string",
"success": true
}

Send a file to Deepo

Sends the given media ID to Deepo with optional reference IDs. Returns the created file transmission.

Request Body schema: application/json
required

mediaId required	string
referenceIds required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"mediaId": "string",
"referenceIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"fileTransmission": {"created": "string",
"editorUrl": "string",
"id": "string",
"issuer": {"accountId": "string",
"userId": "string"
},
"mediaId": "string",
"processed": true,
"referenceIds": ["string"
]
}
}

DeepsignService

Count open sign requests

Returns the number of open (incomplete and not cancelled) Deepsign signature requests for the given account.

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"amount": 0
}

Get partner access URL

Returns the Deepsign partner access URL for the given account.

query Parameters

accountId

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"url": "string"
}

Check if document signature is enabled

Returns whether Deepsign document signature is enabled for the given account.

query Parameters

accountId

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"enabled": true
}

List sign requests

Returns all Deepsign signature requests for the given account.

query Parameters

accountId

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"signRequests": [{"attachToReferenceIds": ["string"
],
"cancelled": true,
"cancelledMessage": "string",
"completed": true,
"created": "string",
"documentType": "OTHER",
"id": "string",
"issuer": {"accountId": "string",
"userId": "string"
},
"legalWeight": "LEGAL_WEIGHT_STANDARD",
"mediaIds": ["string"
],
"name": "string",
"note": "string",
"signedMediaId": "string",
"signers": [{"contactId": "string",
"order": 0,
"signed": true
}
]
}
]
}

List sign requests by attach-to reference IDs

Returns Deepsign signature requests that are attached to any of the given reference IDs.

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

{"signRequests": [{"attachToReferenceIds": ["string"
],
"cancelled": true,
"cancelledMessage": "string",
"completed": true,
"created": "string",
"documentType": "OTHER",
"id": "string",
"issuer": {"accountId": "string",
"userId": "string"
},
"legalWeight": "LEGAL_WEIGHT_STANDARD",
"mediaIds": ["string"
],
"name": "string",
"note": "string",
"signedMediaId": "string",
"signers": [{"contactId": "string",
"order": 0,
"signed": true
}
]
}
]
}

Sign a document

Creates a Deepsign signature request for the given account using the supplied media IDs, signers, legal weight, and optional note and attach-to reference IDs. Returns the created sign request.

Request Body schema: application/json
required

accountId required	string <int64>
attachToReferenceIds required	Array of strings
documentType required	string (mediadocumentType) Default: "OTHER" Enum: "OTHER" "APPLICATION_FORM" "HANDOVER_PROTOCOL" "CONTRACT" "BUILDING_PLAN" "INVOICE" "HOUSE_REGULATION" "INSTRUCTION_MANUAL" "CREDIT_CHECK" "OWNERS_MEETING" "PAY_IN_SLIP" "ENERGY_CERTIFICATE" "WARRANTY_CERTIFICATE" "BANK_STATEMENT" "ADDITIONAL_COSTS_BILL" "SEPA_DIRECT_DEBIT_MANDATE" "AGREEMENT" "DEPOSIT_CONFIRMATION" "BUILDING_INSURANCE_POLICY" "KEY_LIST" "TERMINATION_DOC_TYPE" "RENT_ADJUSTMENT_DOC_TYPE" "REFERENCES_DOC_TYPE" "MAINTENANCE_CONTRACT_DOC_TYPE" "REGULATIONS" "REGULATIONS_FOR_USE_AND_MANAGEMENT" "ANNUAL_FINANCIAL_STATEMENT" "PURCHASE_CONTRACT_AND_LAND_REGISTER" "CONDOMINIUM_OWNERSHIP" "RENEWAL_FOND" "MORTGAGE" "ORDER" "OFFER" "IDENTITY" "EXTRACT_FROM_DEBT_COLLECTION_REGISTER" "BANK_ACCOUNT_DETAILS" "PURCHASE_CONTRACT" "LAND_REGISTER" "SITUATION_PLAN" "CONSTRUCTION_LAW_AGREEMENT" "EASEMENT_AGREEMENT" "CADASTRAL_ESTIMATE" "LETTER" "TRADE_REGISTER_EXCERPT" "PAYMENT_REMINDER" "PROTOCOL" "COURT_DOC_TYPE" "HONORARIUM" "BUDGET" "OFFICIAL_ESTIMATE" "BUILDING_DESCRIPTION" "PERMITS" "LEGAL_MATTERS" "TENANT_CHANGE_NOTIFICATION" "LOSS_RATIO" "SHARE_CERTIFICATE_DOCUMENT"
legalWeight required	string (deepsignLegalWeight) Default: "LEGAL_WEIGHT_STANDARD" Enum: "LEGAL_WEIGHT_STANDARD" "LEGAL_WEIGHT_PROFESSIONAL" "LEGAL_WEIGHT_QUALIFIED"
mediaIds required	Array of strings
name required	string
note required	string
required	Array of objects (deepsignSignerEntry)

Responses

Request samples

Payload

Content type

application/json

{"accountId": "string",
"attachToReferenceIds": ["string"
],
"documentType": "OTHER",
"legalWeight": "LEGAL_WEIGHT_STANDARD",
"mediaIds": ["string"
],
"name": "string",
"note": "string",
"signers": [{"contactId": "string",
"order": 0
}
]
}

Response samples

200
default

Content type

application/json

{"signRequest": {"attachToReferenceIds": ["string"
],
"cancelled": true,
"cancelledMessage": "string",
"completed": true,
"created": "string",
"documentType": "OTHER",
"id": "string",
"issuer": {"accountId": "string",
"userId": "string"
},
"legalWeight": "LEGAL_WEIGHT_STANDARD",
"mediaIds": ["string"
],
"name": "string",
"note": "string",
"signedMediaId": "string",
"signers": [{"contactId": "string",
"order": 0,
"signed": true
}
]
}
}

Cancel a sign request

Cancels the Deepsign signature request identified by ID. An optional cancellation message may be supplied.

path Parameters

id

required

string

query Parameters

message

string

Responses

Response samples

200
default

Content type

application/json

{ }

Download signed file

Downloads the PDF for the Deepsign signature request identified by ID.

path Parameters

id

required

string

Responses

Response samples

200
default

Content type

application/json

{"pdf": "string"
}

EvorestService

Enable or disable Evorest

Enables or disables the Evorest integration for the given account, including API key and whether Swiss Caution is allowed.

path Parameters

accountId

required

string <int64>

Request Body schema: application/json
required

allowSwissCaution	boolean
apiKey	string
enable	boolean

Responses

Request samples

Payload

Content type

application/json

{"allowSwissCaution": true,
"apiKey": "string",
"enable": true
}

Response samples

200
default

Content type

application/json

{ }

Get Evorest account settings

Returns Evorest settings for the given account: enabled flag, allowInvestment, API key, and whether Swiss Caution is allowed.

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"allowInvestment": "UNDEFINED_VALUE",
"allowSwissCaution": true,
"apiKey": "string",
"enabled": true
}

Get Evorest deposit info

Returns whether the given tenancy has an open Evorest deposit and the Evorest link when available.

path Parameters

tenancyId

required

string

Responses

Response samples

200
default

Content type

application/json

{"evorestLink": "string",
"hasDeposit": true
}

Get Evorest owner config

Returns the Evorest owner configuration for the given account, including the allowInvestment applicability setting.

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"allowInvestment": "UNDEFINED_VALUE"
}

Check if Evorest is enabled

Returns whether Evorest is enabled for the given account and whether Swiss Caution is allowed.

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"allowSwissCaution": true,
"enabled": true
}

Open an Evorest deposit

Opens an Evorest rental deposit for the given object and tenancy. Optionally allows investment and requires contactPersonId when the tenant is a company.

Request Body schema: application/json
required

allowInvestment required	boolean
contactPersonId required	string Only required if tenant is a company.
objectId required	string
tenancyId required	string

Responses

Request samples

Payload

Content type

application/json

{"allowInvestment": true,
"contactPersonId": "string",
"objectId": "string",
"tenancyId": "string"
}

Response samples

200
default

Content type

application/json

{ }

Set Evorest owner config

Sets the owner configuration for the given account, including the allowInvestment applicability setting.

path Parameters

accountId

required

string <int64>

Request Body schema: application/json
required

allowInvestment

string (applicableApplicable)

Default: "UNDEFINED_VALUE"

Enum: "UNDEFINED_VALUE" "APPLIES" "DOES_NOT_APPLY"

Responses

Request samples

Payload

Content type

application/json

{"allowInvestment": "UNDEFINED_VALUE"
}

Response samples

200
default

Content type

application/json

{ }

FirstcautionService

Enable or disable Firstcaution

Enables or disables the Firstcaution integration for the given account.

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

{ }

Get Firstcaution deposit info

Returns whether the given tenancy has an open Firstcaution deposit and the Firstcaution link when available.

path Parameters

tenancyId

required

string

Responses

Response samples

200
default

Content type

application/json

{"firstcautionLink": "string",
"hasDeposit": true
}

Check if Firstcaution is enabled

Returns whether the Firstcaution integration is enabled for the given account.

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"enabled": true
}

Open a Firstcaution deposit

Opens a Firstcaution rental deposit for the given object and tenancy. contactPersonId is required when the tenant is a company.

Request Body schema: application/json
required

contactPersonId required	string Only required if tenant is a company.
objectId required	string
tenancyId required	string

Responses

Request samples

Payload

Content type

application/json

{"contactPersonId": "string",
"objectId": "string",
"tenancyId": "string"
}

Response samples

200
default

Content type

application/json

{ }

GocautionService

Enable or disable Gocaution

Enables or disables the Gocaution integration for the given account, including client ID, client secret, and login URL.

path Parameters

accountId

required

string <int64>

Request Body schema: application/json
required

clientId	string
clientSecret	string
enable	boolean
loginUrl	string

Responses

Request samples

Payload

Content type

application/json

{"clientId": "string",
"clientSecret": "string",
"enable": true,
"loginUrl": "string"
}

Response samples

200
default

Content type

application/json

{ }

Get Gocaution account settings

Returns Gocaution settings for the given account: enabled flag, login URL, and client credentials (credentials only for platform employees).

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"clientId": "string",
"clientSecret": "string",
"enabled": true,
"loginUrl": "string"
}

Get Gocaution deposit info

Returns whether the given tenancy has an open Gocaution deposit and the Gocaution link when available.

path Parameters

tenancyId

required

string

Responses

Response samples

200
default

Content type

application/json

{"gocautionLink": "string",
"hasDeposit": true
}

Check if Gocaution is enabled

Returns whether the Gocaution integration is enabled for the given account.

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"enabled": true
}

Open a Gocaution deposit

Opens a Gocaution rental deposit for the given object and tenancy. contactPersonId is required when the tenant is a company.

Request Body schema: application/json
required

contactPersonId required	string Only required if tenant is a company.
objectId required	string
tenancyId required	string

Responses

Request samples

Payload

Content type

application/json

{"contactPersonId": "string",
"objectId": "string",
"tenancyId": "string"
}

Response samples

200
default

Content type

application/json

{ }

Health

M2MService

Get machine-to-machine access token

Exchanges client credentials (client_id, client_secret, and audience) for an OAuth access token. Returns the access token, scope, expires_in, and token_type.

Request Body schema: application/json
required

audience required	string
clientId required	string
clientSecret required	string

Responses

Request samples

Payload

Content type

application/json

{"audience": "string",
"clientId": "string",
"clientSecret": "string"
}

Response samples

200
default

Content type

application/json

{"accessToken": "string",
"expiresIn": "string",
"scope": "string",
"tokenType": "string"
}

NoteService

Create a note

Creates a note for the given owner with reference IDs, text, optional media IDs, mentions, and account-internal flag. Returns the created note.

Request Body schema: application/json
required

accountInternal required	boolean
mediaIds required	Array of strings
required	Array of objects (noteMention)
note required	string
ownerId required	string <int64>
referenceIds required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"accountInternal": true,
"mediaIds": ["string"
],
"mentions": [{"accountId": "string",
"userId": "string"
}
],
"note": "string",
"ownerId": "string",
"referenceIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"note": {"accountInternal": true,
"createdAt": "string",
"creator": {"creatorId": "string",
"email": "string",
"name": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"historyEntries": [{"editedAt": "string",
"previousMediaIds": ["string"
],
"previousNote": "string"
}
],
"id": "string",
"mediaIds": ["string"
],
"mentions": [{"accountId": "string",
"userId": "string"
}
],
"note": "string",
"ownerId": "string",
"referenceIds": ["string"
],
"updatedAt": "string"
}
}

Create a note from mail

Creates a note from the given mail ID for the owner, with reference IDs and optional account-internal flag. Returns the created note.

Request Body schema: application/json
required

accountInternal required	boolean
mailId required	string
ownerId required	string <int64>
referenceIds required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"accountInternal": true,
"mailId": "string",
"ownerId": "string",
"referenceIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"note": {"accountInternal": true,
"createdAt": "string",
"creator": {"creatorId": "string",
"email": "string",
"name": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"historyEntries": [{"editedAt": "string",
"previousMediaIds": ["string"
],
"previousNote": "string"
}
],
"id": "string",
"mediaIds": ["string"
],
"mentions": [{"accountId": "string",
"userId": "string"
}
],
"note": "string",
"ownerId": "string",
"referenceIds": ["string"
],
"updatedAt": "string"
}
}

Create a note as unregistered user

Creates a note from an unregistered creator identified by name and email, with reference IDs, text, and optional media IDs. Returns the created note.

Request Body schema: application/json
required

email required	string
mediaIds required	Array of strings
name required	string
note required	string
referenceIds required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"mediaIds": ["string"
],
"name": "string",
"note": "string",
"referenceIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"note": {"accountInternal": true,
"createdAt": "string",
"creator": {"creatorId": "string",
"email": "string",
"name": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"historyEntries": [{"editedAt": "string",
"previousMediaIds": ["string"
],
"previousNote": "string"
}
],
"id": "string",
"mediaIds": ["string"
],
"mentions": [{"accountId": "string",
"userId": "string"
}
],
"note": "string",
"ownerId": "string",
"referenceIds": ["string"
],
"updatedAt": "string"
}
}

Delete a note

Deletes the note identified by the given ID.

path Parameters

id

required

string

Responses

Response samples

200
default

Content type

application/json

{ }

List notes by reference IDs

Returns all notes linked to any of the given reference IDs.

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

{"notes": [{"accountInternal": true,
"createdAt": "string",
"creator": {"creatorId": "string",
"email": "string",
"name": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"historyEntries": [{"editedAt": "string",
"previousMediaIds": ["string"
],
"previousNote": "string"
}
],
"id": "string",
"mediaIds": ["string"
],
"mentions": [{"accountId": "string",
"userId": "string"
}
],
"note": "string",
"ownerId": "string",
"referenceIds": ["string"
],
"updatedAt": "string"
}
]
}

Update a note

Updates the note text, media IDs, and mentions for the given note ID. Returns the updated note.

path Parameters

id

required

string

Request Body schema: application/json
required

mediaIds	Array of strings
	Array of objects (noteMention)
note	string

Responses

Request samples

Payload

Content type

application/json

{"mediaIds": ["string"
],
"mentions": [{"accountId": "string",
"userId": "string"
}
],
"note": "string"
}

Response samples

200
default

Content type

application/json

{"note": {"accountInternal": true,
"createdAt": "string",
"creator": {"creatorId": "string",
"email": "string",
"name": "string",
"profilePictureUrl": "string",
"userId": "string"
},
"historyEntries": [{"editedAt": "string",
"previousMediaIds": ["string"
],
"previousNote": "string"
}
],
"id": "string",
"mediaIds": ["string"
],
"mentions": [{"accountId": "string",
"userId": "string"
}
],
"note": "string",
"ownerId": "string",
"referenceIds": ["string"
],
"updatedAt": "string"
}
}

NylasAuthService

Get my Nylas config

Returns the authenticated caller's Nylas grant configuration (id, account, user, email, provider, and scopes). The request has no parameters.

Responses

Response samples

200
default

Content type

application/json

{"accountId": "string",
"email": "string",
"id": "string",
"provider": "PROVIDER_UNDEFINED",
"scopes": ["SCOPE_UNDEFINED"
],
"userId": "string"
}

Start Nylas authentication

Starts the Nylas OAuth flow for the requested scopes and initial URL. Returns the authentication URL to redirect the user to.

query Parameters

scopes	Array of strings Items Enum: "SCOPE_UNDEFINED" "SCOPE_EMAIL" "SCOPE_CALENDAR" The scopes to request during authentication.
initialUrl	string The URL where authentication process was started.

Responses

Response samples

200
default

Content type

application/json

{"authUrl": "string"
}

Unlink Nylas grant

Unlinks the authenticated caller's Nylas grant. The request has no parameters.

Request Body schema: application/json
required

object (nylas_authUnlinkRequest)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
default

Content type

application/json

{ }

ZipService

Get zip code info

Returns city and state entries for the given zip code.

path Parameters

zip

required

string

Responses

Response samples

200
default

Content type

application/json

{"entries": [{"city": "string",
"state": "string"
}
]
}

common API (develop:84871a)

AicService

Confirm AIC support for properties

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create a damage report

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create an insurance document

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Add an insurance policy document

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Add an invoice document

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Add a loss ratio document

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Enable or disable AIC

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get AIC sync mode for properties

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get AIC sync modes by property

path Parameters

Responses

Response samples

Create an AIC insurance

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update an AIC insurance

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Check if AIC is enabled

path Parameters

Responses

Response samples

Get AIC JWT public key

Responses

Response samples

Create a note on a ticket

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Set AIC sync mode for properties

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get AIC SSO URL

query Parameters

Responses

Response samples

AileanService

Activate properties for Ailean

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