Creates an address
streetAddress required | string Street and house number |
postalCode required | string Postal code / zip code |
locality required | string City / town |
country required | string 2-letter country code (ISO 3166-1 alpha-2) |
additionalInfo | string |
{- "streetAddress": "string",
- "postalCode": "string",
- "locality": "string",
- "country": "string",
- "additionalInfo": "string"
}
0
Creates a customer. Can also connect to casavi Tenant
casaviAccountId | integer If provided, the customer will be connected to given casavi tenant. If not, the customer will only exist in relay |
required | object Information about the customer that will be created |
{- "casaviAccountId": 0,
- "customer": {
- "internalId": "string",
- "id": "string",
- "name": "string",
- "telephone": "string",
- "emailAddress": "string",
- "address": {
- "id": 0,
- "streetAddress": "string",
- "postalCode": "string",
- "locality": "string",
- "country": "string",
- "additionalInfo": "string",
- "accountId": 0
}
}
}
{- "casaviAccountId": 0,
- "customer": {
- "internalId": "string",
- "id": "string",
- "name": "string",
- "telephone": "string",
- "emailAddress": "string",
- "address": {
- "id": 0,
- "streetAddress": "string",
- "postalCode": "string",
- "locality": "string",
- "country": "string",
- "additionalInfo": "string",
- "accountId": 0
}
}
}
{- "customers": [
- {
- "id": 0,
- "accountId": 0,
- "casaviTenantId": 0,
- "casaviContactId": 0,
- "internalId": "string",
- "externalId": "string",
- "name": "string",
- "status": "string",
- "statusUpdatedAt": "string",
- "telephone": "string",
- "addressId": 0,
- "origin": "string",
- "techemId": "string",
- "oasisId": "string",
- "emailAddress": "string",
- "assfinetId": "string",
- "autoAssignUserId": 0,
- "address": {
- "id": 0,
- "streetAddress": "string",
- "postalCode": "string",
- "locality": "string",
- "country": "string",
- "additionalInfo": "string",
- "accountId": 0
}
}
]
}
Creates or Updates one or multiple Properties.
casaviAccountId | number |
required | Array of objects (PropertyApiDefinition) [ items ] |
{- "casaviAccountId": 0,
- "properties": [
- {
- "id": "string",
- "name": "string",
- "address": {
- "id": 0,
- "streetAddress": "string",
- "postalCode": "string",
- "locality": "string",
- "country": "string",
- "additionalInfo": "string",
- "accountId": 0
}, - "mscNumber": "string",
- "internalId": "string",
- "externalId": "string",
- "customerId": 0
}
]
}
{- "properties": [
- {
- "id": "string",
- "name": "string",
- "address": {
- "id": 0,
- "streetAddress": "string",
- "postalCode": "string",
- "locality": "string",
- "country": "string",
- "additionalInfo": "string",
- "accountId": 0
}, - "mscNumber": "string",
- "internalId": "string",
- "externalId": "string",
- "customerId": 0
}
]
}
{- "properties": [
- {
- "id": 0,
- "name": "string",
- "externalId": 0,
- "customerId": 0,
- "origin": "string",
- "address": {
- "id": 0,
- "streetAddress": "string",
- "postalCode": "string",
- "locality": "string",
- "country": "string",
- "additionalInfo": "string",
- "accountId": 0
}, - "mscNumber": "string",
- "createdAt": "string",
- "updatedAt": "string"
}
]
}
Get Property by Id
propertyId required | number |
{- "id": 0,
- "name": "string",
- "externalId": 0,
- "customerId": 0,
- "origin": "string",
- "address": {
- "id": 0,
- "streetAddress": "string",
- "postalCode": "string",
- "locality": "string",
- "country": "string",
- "additionalInfo": "string",
- "accountId": 0
}, - "mscNumber": "string",
- "createdAt": "string",
- "updatedAt": "string"
}
Gets one specific order by ID
orderId required | number |
{- "id": 0,
- "title": "string",
- "status": "OPEN",
- "address": {
- "id": 0,
- "streetAddress": "string",
- "postalCode": "string",
- "locality": "string",
- "country": "string",
- "additionalInfo": "string",
- "accountId": 0
}, - "dueDate": "string",
- "followUpDate": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "internalId": "string",
- "isInternal": true,
- "type": "string",
- "taskId": "string",
- "fields": [
- {
- "id": 0,
- "position": 0,
- "name": "string",
- "content": "string"
}
], - "attachments": [
- {
- "name": "string",
- "itemType": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "comments": [
- {
- "id": 0,
- "text": "string",
- "orderId": 0,
- "author": "string",
- "attachments": [
- {
- "name": "string",
- "itemType": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2019-08-24T14:15:22Z"
}
], - "contactPersons": [
- {
- "type": "string",
- "name": "string",
- "id": 0,
- "telephone": "string",
- "mobile": "string",
- "emailAddress": "string"
}
], - "customerId": 0
}
Patches an order
orderId required | number |
status | string Enum: "OPEN" "IN_PROGRESS" "FINISHED" "DECLINED" "NULL" "PREPARE" |
dueDate | string <date-time> |
internalId | string |
object (ApiAddress) |
{- "status": "OPEN",
- "dueDate": "2019-08-24T14:15:22Z",
- "internalId": "string",
- "address": {
- "id": 0,
- "streetAddress": "string",
- "postalCode": "string",
- "locality": "string",
- "country": "string",
- "additionalInfo": "string",
- "accountId": 0
}
}
0
[- {
- "id": 0,
- "title": "string",
- "status": "OPEN",
- "address": {
- "id": 0,
- "streetAddress": "string",
- "postalCode": "string",
- "locality": "string",
- "country": "string",
- "additionalInfo": "string",
- "accountId": 0
}, - "dueDate": "string",
- "followUpDate": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "internalId": "string",
- "isInternal": true,
- "type": "string",
- "taskId": "string",
- "fields": [
- {
- "id": 0,
- "position": 0,
- "name": "string",
- "content": "string"
}
], - "attachments": [
- {
- "name": "string",
- "itemType": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "comments": [
- {
- "id": 0,
- "text": "string",
- "orderId": 0,
- "author": "string",
- "attachments": [
- {
- "name": "string",
- "itemType": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2019-08-24T14:15:22Z"
}
], - "contactPersons": [
- {
- "type": "string",
- "name": "string",
- "id": 0,
- "telephone": "string",
- "mobile": "string",
- "emailAddress": "string"
}
], - "customerId": 0
}
]
Gets all comments related to one order
orderId required | number |
[- {
- "id": 0,
- "text": "string",
- "orderId": 0,
- "author": "string",
- "attachments": [
- {
- "name": "string",
- "itemType": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2019-08-24T14:15:22Z"
}
]
Creates an order comment
orderId required | number |
text required | string |
authorName required | string |
files | Array of arrays[ items ] A maximum of 10 files and 100 MB |
{- "id": 0
}
Creates an order-field
name required | string |
content required | string |
position required | number |
orderId required | number |
{- "name": "string",
- "content": "string",
- "position": 0,
- "orderId": 0
}
0