Download OpenAPI specification:
Automatically generated swagger spec for the common stack.
Confirms AIC support for the given property IDs.
| propertyIds required | Array of strings |
{- "propertyIds": [
- "string"
]
}{ }Queues an AIC damage report for asynchronous processing. The ticket is created by the AMQP handler. The response does not contain the ticket ID.
required | object (aicDamageReportAttributes) |
| id required | integer <int32> |
| moduleObjectId required | integer <int32> |
| name required | string |
| propbaseTicketId required | string |
| userid required | string |
{- "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"
}{- "ticketId": "string"
}Creates a document from the given media file and attaches it to the insurance with the specified name and type. Returns the document ID.
| 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" "CERTIFICATE_OF_APPOINTMENT" "REPORT_DOC_TYPE" "INTEREST_ON_CAPITAL" |
{- "insuranceId": "string",
- "mediaId": "string",
- "name": "string",
- "type": "OTHER"
}{- "documentId": "string"
}Attaches the given media file as an insurance policy document to the specified insurance. Returns the document ID.
| insuranceId required | string The ID of the insurance this file should be attached to. |
| mediaId required | string The ID of the media file. |
{- "insuranceId": "string",
- "mediaId": "string"
}{- "documentId": "string"
}Attaches the given media file as an invoice document to the specified insurance. Returns the document ID.
| insuranceId required | string The ID of the insurance this file should be attached to. |
| mediaId required | string The ID of the media file. |
{- "insuranceId": "string",
- "mediaId": "string"
}{- "documentId": "string"
}Attaches the given media file as a loss ratio document to the specified insurance. Returns the document ID.
| insuranceId required | string The ID of the insurance this file should be attached to. |
| mediaId required | string The ID of the media file. |
{- "insuranceId": "string",
- "mediaId": "string"
}{- "documentId": "string"
}Enables or disables the AIC integration for the given account.
| accountId required | string <int64> |
| enable required | boolean |
{- "accountId": "string",
- "enable": true
}{ }Returns a map of property ID to AIC sync mode for the given account and property IDs.
| accountId required | string <int64> |
| propertyIds required | Array of strings |
{- "accountId": "string",
- "propertyIds": [
- "string"
]
}{- "syncModes": {
- "property1": "AIC_SYNC_MODE_DISABLED",
- "property2": "AIC_SYNC_MODE_DISABLED"
}
}Creates an insurance policy linked to a property (referenceId), including AIC policy ID, type, amounts, excess, and start/end dates. Returns the created insurance.
| 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:)
Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and
|
| 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:)
Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and
|
| 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> |
{- "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
}{- "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
}
}Updates an existing insurance by ID, including property reference, type, amounts, excess, and start/end dates. Returns the updated insurance.
| id required | string |
| 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:)
Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and
| |
| 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:)
Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and
| |
| 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> |
{- "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
}{- "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
}
}Creates a note on the given ticket for the specified user, optionally with media attachments. Returns the created note.
| mediaIds required | Array of strings |
| note required | string |
| ticketId required | string |
| userId required | string |
{- "mediaIds": [
- "string"
], - "note": "string",
- "ticketId": "string",
- "userId": "string"
}{- "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"
}
}Sets AIC sync modes for properties of the given account using buckets of syncMode and property IDs.
| accountId required | string <int64> |
required | Array of objects (aicSetSyncModeBucket) |
{- "accountId": "string",
- "buckets": [
- {
- "propertyIds": [
- "string"
], - "syncMode": "AIC_SYNC_MODE_DISABLED"
}
]
}{ }Returns a single sign-on URL for AIC, targeting the given landing page and optional entity or ticket ID.
| 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. |
{- "url": "string"
}Activates the given property IDs for Ailean under the specified account.
| accountId required | string <int64> |
| propertyIds required | Array of strings |
{- "accountId": "string",
- "propertyIds": [
- "string"
]
}{ }Creates a ticket for the given account using the nested ticket create request and returns the create response.
| accountId required | string <int64> |
required | object (ticketticketCreateRequest) |
{- "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"
}
]
}
}{- "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"
}
]
}
}
}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.
| 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 |
{- "accountId": "string",
- "accountInternal": true,
- "comment": "string",
- "mediaIds": [
- "string"
], - "ticketId": "string"
}{- "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"
}
}Deactivates the given property IDs for Ailean under the specified account.
| accountId required | string <int64> |
| propertyIds required | Array of strings |
{- "accountId": "string",
- "propertyIds": [
- "string"
]
}{ }Enables or disables the Ailean integration for the given account.
| accountId required | string <int64> |
| enable required | boolean |
{- "accountId": "string",
- "enable": true
}{ }Returns tenants for the given account, including contact details and their contracts with object, building, and property context.
| accountId required | string <int64> |
{- "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"
}, - "bankNames": [
- "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"
]
}
]
}Returns the ticket identified by the given ticket ID.
| ticketId required | string |
{- "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"
}
]
}
}Returns employees for the given account with name, email, roles, and language.
| accountId required | string <int64> |
{- "employees": [
- {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "language": "string",
- "lastName": "string",
- "roles": [
- "string"
]
}
]
}Returns properties for the given account, including address, linked contacts, and the admin assignee.
| accountId required | string <int64> |
{- "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"
}, - "bankNames": [
- "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"
}
]
}Returns activation entries (accountId and propertyId) for the given property IDs. Properties missing from the response are not activated.
| propertyIds required | Array of strings |
{- "propertyIds": [
- "string"
]
}{- "entries": [
- {
- "accountId": "string",
- "propertyId": "string"
}
]
}Returns all comments for the given ticket.
| ticketId required | string |
{- "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"
}
]
}Updates an existing ticket using the nested ticket update request and returns the update response.
required | object (ticketticketUpdateRequest) |
{- "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
}
}{- "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"
}
]
}
}
}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.
| 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:)
Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and
|
| 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 |
{- "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"
}{- "certificateIssuable": true,
- "crifApproval": true,
- "crifMatch": true,
- "intrumApproval": true,
- "intrumMatch": true,
- "orderId": "string"
}Verifies the given certificate and returns issuer verification details plus the identified person's name and date of birth.
| certificate required | string |
{- "certificate": "string"
}{- "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
}
}
}Returns Deepo file transmissions associated with the given reference ID.
| referenceId required | string |
{- "fileTransmissions": [
- {
- "created": "string",
- "editorUrl": "string",
- "id": "string",
- "issuer": {
- "accountId": "string",
- "userId": "string"
}, - "mediaId": "string",
- "processed": true,
- "referenceIds": [
- "string"
]
}
]
}Attempts to repair the Deepo service account for the given account ID. Returns success and an optional message.
| accountId required | string <int64> |
{- "accountId": "string"
}{- "message": "string",
- "success": true
}Sends the given media ID to Deepo with optional reference IDs. Returns the created file transmission.
| mediaId required | string |
| referenceIds required | Array of strings |
{- "mediaId": "string",
- "referenceIds": [
- "string"
]
}{- "fileTransmission": {
- "created": "string",
- "editorUrl": "string",
- "id": "string",
- "issuer": {
- "accountId": "string",
- "userId": "string"
}, - "mediaId": "string",
- "processed": true,
- "referenceIds": [
- "string"
]
}
}Returns all Deepsign signature requests for the given account.
| accountId | string <int64> |
{- "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
}
]
}
]
}Returns Deepsign signature requests that are attached to any of the given reference IDs.
| referenceIds required | Array of strings |
{- "referenceIds": [
- "string"
]
}{- "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
}
]
}
]
}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.
| 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" "CERTIFICATE_OF_APPOINTMENT" "REPORT_DOC_TYPE" "INTEREST_ON_CAPITAL" |
| 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) |
{- "accountId": "string",
- "attachToReferenceIds": [
- "string"
], - "documentType": "OTHER",
- "legalWeight": "LEGAL_WEIGHT_STANDARD",
- "mediaIds": [
- "string"
], - "name": "string",
- "note": "string",
- "signers": [
- {
- "contactId": "string",
- "order": 0
}
]
}{- "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
}
]
}
}Enables or disables the Evorest integration for the given account, including API key and whether Swiss Caution is allowed.
| accountId required | string <int64> |
| allowSwissCaution | boolean |
| apiKey | string |
| enable | boolean |
{- "allowSwissCaution": true,
- "apiKey": "string",
- "enable": true
}{ }Returns Evorest settings for the given account: enabled flag, allowInvestment, API key, and whether Swiss Caution is allowed.
| accountId required | string <int64> |
{- "allowInvestment": "UNDEFINED_VALUE",
- "allowSwissCaution": true,
- "apiKey": "string",
- "enabled": true
}Opens an Evorest rental deposit for the given object and tenancy. Optionally allows investment and requires contactPersonId when the tenant is a company.
| allowInvestment required | boolean |
| contactPersonId required | string Only required if tenant is a company. |
| objectId required | string |
| tenancyId required | string |
{- "allowInvestment": true,
- "contactPersonId": "string",
- "objectId": "string",
- "tenancyId": "string"
}{ }Sets the owner configuration for the given account, including the allowInvestment applicability setting.
| accountId required | string <int64> |
| allowInvestment | string (applicableApplicable) Default: "UNDEFINED_VALUE" Enum: "UNDEFINED_VALUE" "APPLIES" "DOES_NOT_APPLY" |
{- "allowInvestment": "UNDEFINED_VALUE"
}{ }Enables or disables the Firstcaution integration for the given account.
| accountId required | string <int64> |
| enable | boolean |
{- "enable": true
}{ }Opens a Firstcaution rental deposit for the given object and tenancy. contactPersonId is required when the tenant is a company.
| contactPersonId required | string Only required if tenant is a company. |
| objectId required | string |
| tenancyId required | string |
{- "contactPersonId": "string",
- "objectId": "string",
- "tenancyId": "string"
}{ }Enables or disables the Gocaution integration for the given account, including client ID, client secret, and login URL.
| accountId required | string <int64> |
| clientId | string |
| clientSecret | string |
| enable | boolean |
| loginUrl | string |
{- "clientId": "string",
- "clientSecret": "string",
- "enable": true,
- "loginUrl": "string"
}{ }Returns Gocaution settings for the given account: enabled flag, login URL, and client credentials (credentials only for platform employees).
| accountId required | string <int64> |
{- "clientId": "string",
- "clientSecret": "string",
- "enabled": true,
- "loginUrl": "string"
}Opens a Gocaution rental deposit for the given object and tenancy. contactPersonId is required when the tenant is a company.
| contactPersonId required | string Only required if tenant is a company. |
| objectId required | string |
| tenancyId required | string |
{- "contactPersonId": "string",
- "objectId": "string",
- "tenancyId": "string"
}{ }Exchanges client credentials (client_id, client_secret, and audience) for an OAuth access token. Returns the access token, scope, expires_in, and token_type.
| audience required | string |
| clientId required | string |
| clientSecret required | string |
{- "audience": "string",
- "clientId": "string",
- "clientSecret": "string"
}{- "accessToken": "string",
- "expiresIn": "string",
- "scope": "string",
- "tokenType": "string"
}Creates a note for the given owner with reference IDs, text, optional media IDs, mentions, and account-internal flag. Returns the created note.
| 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 |
{- "accountInternal": true,
- "mediaIds": [
- "string"
], - "mentions": [
- {
- "accountId": "string",
- "userId": "string"
}
], - "note": "string",
- "ownerId": "string",
- "referenceIds": [
- "string"
]
}{- "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"
}
}Creates a note from the given mail ID for the owner, with reference IDs and optional account-internal flag. Returns the created note.
| accountInternal required | boolean |
| mailId required | string |
| ownerId required | string <int64> |
| referenceIds required | Array of strings |
{- "accountInternal": true,
- "mailId": "string",
- "ownerId": "string",
- "referenceIds": [
- "string"
]
}{- "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"
}
}Creates a note from an unregistered creator identified by name and email, with reference IDs, text, and optional media IDs. Returns the created note.
| email required | string |
| mediaIds required | Array of strings |
| name required | string |
| note required | string |
| referenceIds required | Array of strings |
{- "email": "string",
- "mediaIds": [
- "string"
], - "name": "string",
- "note": "string",
- "referenceIds": [
- "string"
]
}{- "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"
}
}Returns all notes linked to any of the given reference IDs.
| referenceIds required | Array of strings |
{- "referenceIds": [
- "string"
]
}{- "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"
}
]
}Updates the note text, media IDs, and mentions for the given note ID. Returns the updated note.
| id required | string |
| mediaIds | Array of strings |
Array of objects (noteMention) | |
| note | string |
{- "mediaIds": [
- "string"
], - "mentions": [
- {
- "accountId": "string",
- "userId": "string"
}
], - "note": "string"
}{- "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"
}
}Returns the authenticated caller's Nylas grant configuration (id, account, user, email, provider, and scopes). The request has no parameters.
{- "accountId": "string",
- "email": "string",
- "id": "string",
- "provider": "PROVIDER_UNDEFINED",
- "scopes": [
- "SCOPE_UNDEFINED"
], - "userId": "string"
}Starts the Nylas OAuth flow for the requested scopes and initial URL. Returns the authentication URL to redirect the user to.
| 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. |
{- "authUrl": "string"
}Opens one Server-Sent Events stream for the authenticated user's browser tab. Identity comes from the gateway identity headers. Each event name is the published envelope type and the event data is the envelope payload JSON, which is not parsed. A heartbeat comment is sent about every 20 seconds. The stream closes after about one hour, and on shutdown all streams close immediately.
Requests an OAuth client-credentials token from the account's 3CX token endpoint (Admin only). TLS is always verified. On success, returns any propbase extensions that 3CX does not let us monitor.
| accountId required | string <int64> |
{ }{- "error": "string",
- "ok": true,
- "unmonitoredExtensions": [
- "string"
]
}Deletes the 3CX configuration for the given account (Admin only). Used when the VoIP provider is set to "-". User extension numbers are not touched.
| accountId required | string <int64> |
{ }{ }Publishes call.dismissed to the authenticated user so other tabs close the popup. Only legs on the user's own extension may be dismissed. Nothing is stored. legId is sent in the JSON body (not the URL path) so slash-containing provider ids are not mangled by gateways.
| legId required | string Provider-specific leg id (e.g. dn/participantId). |
{- "legId": "string"
}{ }Enables or disables VoIP for the given account (support). The VoIP card is visible only to Admins of enabled accounts.
| accountId required | string <int64> |
| enable | boolean |
{- "enable": true
}{ }Returns live call legs (ringing or answered) on the authenticated user's own extension, answered live from 3CX and enriched with contacts. Identity comes from the gateway identity headers. Users without an extension get an empty list.
{- "calls": [
- {
- "answeredAt": "string",
- "contacts": [
- {
- "company": "string",
- "displayName": "string",
- "id": "string",
- "kind": "CALL_CONTACT_KIND_UNDEFINED"
}
], - "contactsTotal": 0,
- "direction": "DIRECTION_UNDEFINED",
- "endedAt": "string",
- "legId": "string",
- "remoteNumber": "string",
- "remoteUser": {
- "displayName": "string",
- "id": "string"
}, - "startedAt": "string"
}
]
}Returns the 3CX configuration for the given account (Admin only): URL, client ID, whether a client secret is set, connection status, and last error. The client secret itself is never returned. configured is true when a 3CX config exists (provider dropdown).
| accountId required | string <int64> |
{- "configured": true,
- "settings": {
- "accountId": "string",
- "clientId": "string",
- "connectionStatus": "CONNECTION_STATUS_UNDEFINED",
- "hasClientSecret": true,
- "lastError": "string",
- "lastErrorAt": "string",
- "url": "string"
}
}Publishes call.contactIdentified to the authenticated user so other tabs apply the chosen contact. Only legs on the user's own extension may be identified, and contactId must be among that leg's enriched contacts. Nothing is stored. legId and contactId are sent in the JSON body (not the URL path) so slash-containing provider ids are not mangled by gateways.
| contactId required | string Contact id to assign; must be among the leg's enriched contacts. |
| legId required | string Provider-specific leg id (e.g. dn/participantId). |
{- "contactId": "string",
- "legId": "string"
}{ }Creates or updates the 3CX configuration for the given account (Admin only): URL, client ID, and optional client secret. Omitting or leaving clientSecret empty keeps the existing secret. The client secret is stored encrypted and is never returned.
| accountId required | string <int64> |
| clientId | string |
| clientSecret | string Write-only. Empty keeps the existing secret. |
| url | string |
{- "clientId": "string",
- "clientSecret": "string",
- "url": "string"
}{- "settings": {
- "accountId": "string",
- "clientId": "string",
- "connectionStatus": "CONNECTION_STATUS_UNDEFINED",
- "hasClientSecret": true,
- "lastError": "string",
- "lastErrorAt": "string",
- "url": "string"
}
}