common API (develop:c14720)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the common stack.

EvorestService

EvorestService_Enable

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

{ }

EvorestService_GetAccountSettings

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

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

EvorestService_GetDepositInfo

path Parameters

tenancyId

required

string

Responses

Response samples

200
default

Content type

application/json

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

EvorestService_GetOwnerConfig

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"allowInvestment": "UNDEFINED_VALUE"
}

EvorestService_HasEnabled

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

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

EvorestService_OpenDeposit

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

{ }

EvorestService_SetOwnerConfig

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

{ }

NoteService

NoteService_Create

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

NoteService_CreateFromMail

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

NoteService_CreateUnregistered

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

NoteService_Delete

path Parameters

id

required

string

Responses

Response samples

200
default

Content type

application/json

{ }

NoteService_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

{"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"
}
]
}

NoteService_Update

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

Health

CertifactionService

CertifactionService_EnableDocumentSignature

query Parameters

accountId	string <int64>
enable	boolean

Responses

Response samples

200
default

Content type

application/json

{ }

Misc

query Parameters

accountId

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"enabled": true
}

CertifactionService_ListSignRequests

query Parameters

accountId

string <int64>

Responses

Response samples

200
default

Content type

application/json

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

CertifactionService_SignDocument

query Parameters

accountId	string <int64>
name	string
mediaIds	Array of strings
language	string Default: "PREFERRED_LANGUAGE_UNDEFINED" Enum: "PREFERRED_LANGUAGE_UNDEFINED" "PREFERRED_LANGUAGE_GERMAN" "PREFERRED_LANGUAGE_ENGLISH" "PREFERRED_LANGUAGE_ITALIAN" "PREFERRED_LANGUAGE_FRENCH"
attachToReferenceIds	Array of strings

Responses

Response samples

200
default

Content type

application/json

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

CertifactionService_DownloadFile

path Parameters

id

required

string

Responses

Response samples

200
default

Content type

application/json

{"pdf": "string"
}

ZipService

ZipService_GetInfo

path Parameters

zip

required

string

Responses

Response samples

200
default

Content type

application/json

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

CredittrustService

CredittrustService_GetCertificate

query Parameters

orderId

string

Responses

Response samples

200
default

Content type

application/json

{"certificate": "string"
}

CredittrustService_OrderCertificate

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

CredittrustService_VerifyCertificate

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

DeepoService_AnalyseNodeStatus

path Parameters

fileTransmissionId

required

string

Responses

Response samples

200
default

Content type

application/json

{"finished": true
}

DeepoService_GetFileTransmissionsByReferenceId

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"
]
}
]
}

DeepoService_GetPartnerAccessUrl

query Parameters

accountId

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"url": "string"
}

Misc

query Parameters

accountId

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"enabled": true
}

DeepoService_RepairServiceAccount

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
}

DeepoService_SendFile

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"
]
}
}

NylasAuthService

NylasAuthService_GetMyConfig

Responses

Response samples

200
default

Content type

application/json

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

NylasAuthService_StartAuth

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

NylasAuthService_Unlink

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

{ }

AicService

AicService_ConfirmAicSupport

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

{ }

AicService_CreateDamageReport

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

AicService_CreateDocument

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

AicService_AddInsurancePoliceDocument

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

AicService_AddInvoiceDocument

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

AicService_AddLossRatioDocument

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

AicService_EnableAic

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

{ }

AicService_GetSyncModeForProperties

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

AicService_GetSyncModeForAccountsByPropertyId

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

AicService_CreateInsurance

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

AicService_UpdateInsurance

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

AicService_HasAicEnabled

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"enabled": true
}

AicService_GetJwtPublicKey

Responses

Response samples

200
default

Content type

application/json

{"publicKey": "string"
}

AicService_CreateNote

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

AicService_SetSyncModeForProperties

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

{ }

AicService_GetSsoUrl

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

DeepsignService

DeepsignService_CountOpenSignRequests

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"amount": 0
}

DeepsignService_GetPartnerAccessUrl

query Parameters

accountId

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"url": "string"
}

Misc

query Parameters

accountId

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"enabled": true
}

DeepsignService_ListSignRequests

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

DeepsignService_ListSignRequestsByAttachToReferenceIds

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

DeepsignService_SignDocument

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 (commondeepsignLegalWeight) 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 (commondeepsignSignerEntry)

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

DeepsignService_CancelSignRequest

path Parameters

id

required

string

query Parameters

message

string

Responses

Response samples

200
default

Content type

application/json

{ }

DeepsignService_DownloadFile

path Parameters

id

required

string

Responses

Response samples

200
default

Content type

application/json

{"pdf": "string"
}

M2MService

Get an access token for machine-to-machine communication with client-credentials

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

PolicyService

GocautionService

GocautionService_Enable

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

{ }

GocautionService_GetAccountSettings

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

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

GocautionService_GetDepositInfo

path Parameters

tenancyId

required

string

Responses

Response samples

200
default

Content type

application/json

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

GocautionService_HasEnabled

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"enabled": true
}

GocautionService_OpenDeposit

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

{ }

AileanService

AileanService_ActivateProperties

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

{ }

AileanService_CreateTicket

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"
}
]
}
}
}

AileanService_CreateTicketComment

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

AileanService_DeactivateProperties

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

{ }

AileanService_EnableAilean

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

{ }

AileanService_GetTenantsByAccountId

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"
]
}
]
}

AileanService_GetTicket

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"
}
]
}
}

AileanService_HasAileanEnabled

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"enabled": true
}

AileanService_GetJwtPublicKey

Responses

Response samples

200
default

Content type

application/json

{"publicKey": "string"
}

AileanService_ListEmployeesByAccountId

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"
]
}
]
}

AileanService_ListPropertiesByAccountId

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"
}
]
}

AileanService_ListPropertyActivations

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"
}
]
}

AileanService_ListTicketComments

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"
}
]
}

AileanService_GetSsoUrl

Responses

Response samples

200
default

Content type

application/json

{"url": "string"
}

AileanService_UpdateTicket

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"
}
]
}
}
}

FirstcautionService

FirstcautionService_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

{ }

FirstcautionService_GetDepositInfo

path Parameters

tenancyId

required

string

Responses

Response samples

200
default

Content type

application/json

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

FirstcautionService_HasEnabled

path Parameters

accountId

required

string <int64>

Responses

Response samples

200
default

Content type

application/json

{"enabled": true
}

FirstcautionService_OpenDeposit

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

{ }

common API (develop:c14720)

EvorestService

EvorestService_Enable

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

EvorestService_GetAccountSettings

path Parameters

Responses

Response samples

EvorestService_GetDepositInfo

path Parameters

Responses

Response samples

EvorestService_GetOwnerConfig

path Parameters

Responses

Response samples

EvorestService_HasEnabled

path Parameters

Responses

Response samples

EvorestService_OpenDeposit

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

EvorestService_SetOwnerConfig

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

NoteService

NoteService_Create

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

NoteService_CreateFromMail

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

NoteService_CreateUnregistered

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

NoteService_Delete

path Parameters

Responses

Response samples

NoteService_ListByReferenceIds

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

NoteService_Update

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Health

CertifactionService

CertifactionService_EnableDocumentSignature

query Parameters

Responses

Response samples

Misc

query Parameters

Responses

Response samples

CertifactionService_ListSignRequests

query Parameters

Responses

Response samples

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