ZeyOS Standard REST API API Reference

The ZeyOS Standard REST API provides access to almost all of your ZeyOS data and gives you a powerful tool to connect third-party applications and other systems with ZeyOS, without having to write a custom ZeyOS app.

You may access the ZeyOS Standard REST API via https://cloud.zeyos.com/{INSTANCE}/api/v1/, provided that you supply a valid token generated through the ZeyOS Authentication API via https://cloud.zeyos.com/{INSTANCE}/auth/v1/.

Return Values and Error Handling

The ZeyOS Standard REST API currently only returns JSON data and an HTTP status code indicating the outcome of a request.

HTTP status code 200 or 201 are used to indicate a successful response, and the result will be a JSON object.

When an error occurs, the HTTP status code will be 400 or greater, and the response will be a text message.

We recommend that you treat any HTTP status code greater than or equal to 400 as an error.

Data Retrieval

The ZeyOS Standard REST API allows you to execute complex queries, including simple joins and composite filters.

Let's take a look at the following example:

Query (query.json):

{
  "fields": {
    "Id": "ID",
    "Name": "lastname",
    "Nickname": "extdata.nickname"
    "Address": "contact.address",
    "Postalcode": "contact.postalcode",
    "Town": "contact.city",
    "SalesAgent": "assigneduser.name"
  },
  "filters": {
    "visibility": 0,
    "contact.country": {"IN": ["DE", "AT", "GB"]},
    2: [
      "OR",
      {"lastmodified": {">": 1524472045}},
      {"contact.lastmodified": {">": 1524472045}}
    ]
  },
  "sort": [
    "+lastname",
    "-contact.country"
  ],
  "limit": 3,
  "offset": 0
}

Request:

$ curl -X POST \
  -H 'Authorization: Bearer YourApiToken' \
  -H "Content-Type: application/json" \
  --data @./query.json \
  https://cloud.zeyos.com/demo/api/v1/accounts/

Response:

[{
    "Id": 2,
    "Name": "BEQ Building Equipment",
    "Nickname": null,
    "Address": "Queensstreet",
    "Postalcode": "12923",
    "Town": "London",
    "Country": "GB",
    "SalesAgent": "Max Mueller"
}, {
    "Id": 15,
    "Name": "CleanTexx",
    "Nickname": null,
    "Address": "Tower Bridge",
    "Postalcode": "12923",
    "Town": "London",
    "Country": "GB",
    "SalesAgent": null
}, {
    "Id": 1,
    "Name": "Lightexx AG",
    "Nickname": null,
    "Address": "Schmittstr. 4",
    "Postalcode": "80172",
    "Town": "Munich",
    "Country": "DE",
    "SalesAgent": null
}]

Field Selection

The field selection references all fields you want to have included in your query results. You can either specify your field selection as and array or as an object. Using an object is useful if you want to specify alias names. In the example above, we select the field lastname with an alias called name.

If you are not certain what fields are available for which entity, you can either check the entity reference in this document or the ZeyOS Schema Documentation.

Besides selecting the entity's own fields, you can also perform simple join operations within the entity's first degree relationships. In order to discover relationships, it's best to check the ZeyOS Schema Documentation, it also contains a graphical map of all entity relationships.

Besides related tables you can also select extdata fields. extdata is a concept in ZeyOS which allows for storing additional values for all entities in ZeyOS. Whenever you create a new form field in ZeyOS, the field's value is stored in extdata.

Filters

You can specify composite filters as you would in a regular SQL statement:

filters <array/json> = {
 "field": "value",
 "field2": {"=": "value"},
 "field3": {"<": "value1", ">": "value2"},
 "field4": {"IN": ["value1", "value2"]},
 ["AND/OR/NOT", {...}, {...}]
}

The following filter operators are supported:

  • =: Equals
  • !=, <>: Not equals
  • <: Less than
  • <=: Less than or equal to
  • >: Greater than
  • >=: Greater than or equal to
  • IN: Contains (e.g. "field": {"IN": ["value1", "value2"]})
  • !IN: Does not contain

For strings you can also use the following operators:

  • ~: Matches regular expression
  • ~*: Matches regular expression, case-insensitive
  • !~: Not matches regular expression
  • !~*: Not matches regular expression, case-insensitive
  • ~~: Is like
  • ~~*: Is like, case-insensitive
  • !~~: Not like
  • !~~*: Not like, case-insensitive

Search Queries

The query parameter allows to specify a search string, that will be applied to all searchable strings, such as name.

Sorting

You can sort by multiple columns by defining an array of column names.

sort <array/json> = {
 "field1",
 "+field2",
 "-field3"
}

Adding modifiers will set the sorting mode:

  • + for ascending
  • - for descending

Pagination

Sometimes the result size might be too large to be selected through one query. In such cases it makes sense to use pagination to page through the results.

Obviously, the first thing you need to know is the number or records in order to calculate the number of pages. This can be achived throuch the count modifier.

For example:

{
  "count": 1,
  "filters": {
    "visibility": 0,
    "contact.country": {"IN": ["DE", "AT", "GB"]},
    2: [
      "OR",
      {"lastmodified": {">": 1524472045}},
      {"contact.lastmodified": {">": 1524472045}}
    ]
  }
}

Result:

{
  "count":5
}

Now that you have the number of records, you can easily page through the result by using the limit and offset parameters.

Expanding JSON and Binary Data

Some table columns include JSON data or reference binary files. The expand parameter allows you to specify to load the columns content automatically.

For example:

{
  "fields": [
    "ID",
    "subject",
    "binfile"
  ],
  "expand": [
    "binfile"
  ],
  "limit": 1
}

Request:

$ curl -X POST \
  -H 'Authorization: Bearer YourApiToken' \
  -H "Content-Type: application/json" \
  --data @./query.json \
  https://cloud.zeyos.com/demo/api/v1/messages/

Result:

[{"ID":188,"subject":"Test","binfile":{"content":"UmV0dXJuLVBhdGg6IDx..."}}]

This example will return the entire e-mail message as RFC 822.

API Endpoint
https://cloud.zeyos.com/{INSTANCE}/api/v1
Terms of Service: https://www.zeyos.com/termsofservice
Contact: info@zeyos.com
Schemes: https
Version: v1

Authentication

The ZeyOS REST API is only usable for authenticated users. Authentication is achieved in two ways:

  1. For interal apps - the ZeyOS session: If the user is already logged in to ZeyOS and you are using the REST API within a Weblet, the current ZeyOS session will be used.
  2. For external apps - obtaining a session token

Token authentication relies on ZeyOS's token authentication mechanism, documented in the Auth API documentation.

Once a token has been obtained, you can then use the REST API by including the Authorization header in your request with the method indicator Bearer, a space, the obtained token string, e.g. Authorization: Bearer 2a3e4ec88e66138253a69da3406841fccb1c998e.

Example with CURL:

$ curl -X POST \
  -H 'Authorization: Bearer a749717494cf42aa2fcb7533a950e2a7350d1086' \
  -d "fields[]=ID&fields[]=lastname&fields[]=firstname&limit=3" \
  https://cloud.zeyos.com/demo/api/v1/contacts/

Response:

[{
    "ID": 12198,
    "lastname": "Morris",
    "firstname": "Steve"
}, {
    "ID": 12199,
    "lastname": "Schulz",
    "firstname": "Dirk"
}, {
    "ID": 12200,
    "lastname": "Charlott",
    "firstname": "Sophie"
}]
Obtaining a login token with CURL
$ curl -X POST -i --data 'name=max.power&password=MySecretPwd&identifier=MyDevice&appsecret=ff55c5095a126d66faaa37cd71bc771672c56ec5' https://cloud.zeyos.com/demo/auth/v1/login

Response:

{
  "user": 2,
  "application": 345,
  "token": "a749717494cf42aa2fcb7533a950e2a7360d1086",
  "identifier": "MyDevice",
  "expdate": null
}

session

Session Cookie Authentication ( RFC 6265)

in
cookie
name
ZEYOSID
type
apiKey

token

HTTP Bearer Authentication ( RFC 6750); use the ZeyOS Authentication API 's POST /auth/v1/login to obtain a valid bearer token

scheme
bearer
type
http

general

general

Get system configuration

GET /config

Return the user-visible system configuration.

200 OK

OK

type
object
401 Unauthorized

Unauthorized

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: text/plain
Response Example (200 OK) 
{}
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
general

Get application settings

GET /settings

Return the settings of the application that was used for authentication.

200 OK

OK

type
object
401 Unauthorized

Unauthorized

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
"object"
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

accounts

accounts

List accounts

POST /accounts

List selected data from all accounts that match the specified filter and search criteria in a specific sort order. Requires accounts permission.

count
in formData
boolean

Return number of results only (fields, sort, limit, offset and expand have no effect)

export
in formData
boolean

Export result as CSV file (type text/csv, delimiter ;) with unbounded limit (admin)

distinct
in formData
boolean

Return distinct result set

fields
in formData
object

Select specified fields only; use optional alias as object key

filter
in formData
object

Eliminate results that do not match specified filter criteria

query
in formData
string

Eliminate results that do not match specified query search pattern

sort
in formData
string[]

Return sorted results by specified order of fields; use the minus sign (-) as a prefix to sort by a field in descending instead of ascending order (default)

limit
in formData
integer 1 ≤ x ≤ 10000 1000

Limit to total number of results (defaults to 1000, unless export is true)

offset
in formData
integer (int64) 0

Return results forward from specified offset only

expand
in formData
string[]

Expand content of composite fields (binfile, json or array)

200 OK
accounts

OK

type
accounts
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: text/plain
Response Example (200 OK) 
[
  {
    "ID": 1,
    "assigneduser": 6,
    "contact": 7,
    "creationdate": 872838840,
    "creator": 6,
    "currency": "EUR",
    "customernum": "C-123456",
    "description": "string",
    "excludetax": "integer",
    "firstname": "John",
    "lastmodified": 872838840,
    "lastname": "Doe",
    "locked": "integer",
    "ownergroup": "integer (int32)",
    "suppliernum": "S-123456",
    "taxid": "DE123456789",
    "type": "integer",
    "visibility": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
accounts

Create new account

PUT /accounts

Create a new account and return it's persistent data. Requires writable accounts permission.

body
in formData
object

(no description)

201 Created
accounts

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "assigneduser": 6,
  "contact": 7,
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "customernum": "C-123456",
  "description": "string",
  "excludetax": "integer",
  "firstname": "John",
  "lastmodified": 872838840,
  "lastname": "Doe",
  "locked": "integer",
  "ownergroup": "integer (int32)",
  "suppliernum": "S-123456",
  "taxid": "DE123456789",
  "type": "integer",
  "visibility": "integer"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
accounts

Delete account

DELETE /accounts/{ID}

Permanently delete an existing account by ID. Requires writable accounts permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
accounts

Get account

GET /accounts/{ID}

Return the data of an existing account by ID. Requires accounts permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
accounts

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "assigneduser": 6,
  "contact": 7,
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "customernum": "C-123456",
  "description": "string",
  "excludetax": "integer",
  "firstname": "John",
  "lastmodified": 872838840,
  "lastname": "Doe",
  "locked": "integer",
  "ownergroup": "integer (int32)",
  "suppliernum": "S-123456",
  "taxid": "DE123456789",
  "type": "integer",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
accounts

Check if account exists

HEAD /accounts/{ID}

Check if an account with ID exists, but do not return it's data. Requires accounts permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
accounts

Update existing account

PATCH /accounts/{ID}

Update an existing account by ID and return it's persistent data. Requires writable accounts permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
accounts

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "assigneduser": 6,
  "contact": 7,
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "customernum": "C-123456",
  "description": "string",
  "excludetax": "integer",
  "firstname": "John",
  "lastmodified": 872838840,
  "lastname": "Doe",
  "locked": "integer",
  "ownergroup": "integer (int32)",
  "suppliernum": "S-123456",
  "taxid": "DE123456789",
  "type": "integer",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

actionsteps

actionsteps

List actionsteps

POST /actionsteps

List selected data from all action steps that match the specified filter and search criteria in a specific sort order. Requires actionsteps permission.

200 OK
actionsteps

OK

type
actionsteps
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "account": "integer (int32)",
    "actionnum": "A-123456",
    "assigneduser": 6,
    "creationdate": 872838840,
    "creator": 6,
    "date": 872838840,
    "description": "string",
    "duedate": "integer (int64)",
    "effort": "number (int32)",
    "lastmodified": 872838840,
    "name": "My Action Step",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)",
    "status": "integer",
    "task": 7,
    "ticket": "integer (int32)",
    "transaction": "integer (int32)"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
actionsteps

Create new action step

PUT /actionsteps

Create a new action step and return it's persistent data. Requires writable actionsteps permission.

body
in formData
object

(no description)

201 Created
actionsteps

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "account": "integer (int32)",
  "actionnum": "A-123456",
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "description": "string",
  "duedate": "integer (int64)",
  "effort": "number (int32)",
  "lastmodified": 872838840,
  "name": "My Action Step",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "status": "integer",
  "task": 7,
  "ticket": "integer (int32)",
  "transaction": "integer (int32)"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
actionsteps

Delete action step

DELETE /actionsteps/{ID}

Permanently delete an existing action step by ID. Requires writable actionsteps permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
actionsteps

Get action step

GET /actionsteps/{ID}

Return the data of an existing action step by ID. Requires actionsteps permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
actionsteps

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": "integer (int32)",
  "actionnum": "A-123456",
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "description": "string",
  "duedate": "integer (int64)",
  "effort": "number (int32)",
  "lastmodified": 872838840,
  "name": "My Action Step",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "status": "integer",
  "task": 7,
  "ticket": "integer (int32)",
  "transaction": "integer (int32)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
actionsteps

Check if action step exists

HEAD /actionsteps/{ID}

Check if an action step with ID exists, but do not return it's data. Requires actionsteps permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
actionsteps

Update existing action step

PATCH /actionsteps/{ID}

Update an existing action step by ID and return it's persistent data. Requires writable actionsteps permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
actionsteps

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": "integer (int32)",
  "actionnum": "A-123456",
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "description": "string",
  "duedate": "integer (int64)",
  "effort": "number (int32)",
  "lastmodified": 872838840,
  "name": "My Action Step",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "status": "integer",
  "task": 7,
  "ticket": "integer (int32)",
  "transaction": "integer (int32)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

addresses

addresses

List addresses

POST /addresses

List selected data from all addresses that match the specified filter and search criteria in a specific sort order. Requires accounts permission. Has dependency on account.

200 OK
addresses

OK

type
addresses
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "account": 7,
    "contact": 13,
    "creationdate": 872838840,
    "creator": 6,
    "default": "integer",
    "lastmodified": 872838840,
    "type": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
addresses

Create new address

PUT /addresses

Create a new address and return it's persistent data. Requires writable accounts permission. Has dependency on account.

ID
in formData
integer (int64)

Address ID

creator
in formData
integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate
in formData
integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

lastmodified
in formData
integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

account
in formData
integer (int32)

Account ID ( dependency)

contact
in formData
integer (int32)

Contact ID

type
in formData
integer 0, 1, 2, 3, 4 0

Address type (0=BILLING_SHIPPING, 1=BILLING_BILLING, 2=PROCUREMENT_SHIPPING, 3=PROCUREMENT_BILLING, 4=COLLECTION)

default
in formData
integer 0, 1 0

Default for this address type

201 Created
addresses

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "account": 7,
  "contact": 13,
  "creationdate": 872838840,
  "creator": 6,
  "default": "integer",
  "lastmodified": 872838840,
  "type": "integer"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
addresses

Delete address

DELETE /addresses/{ID}

Permanently delete an existing address by ID. Requires writable accounts permission. Has dependency on account.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
addresses

Get address

GET /addresses/{ID}

Return the data of an existing address by ID. Requires accounts permission. Has dependency on account.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
addresses

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": 7,
  "contact": 13,
  "creationdate": 872838840,
  "creator": 6,
  "default": "integer",
  "lastmodified": 872838840,
  "type": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
addresses

Check if address exists

HEAD /addresses/{ID}

Check if an address with ID exists, but do not return it's data. Requires accounts permission. Has dependency on account.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
addresses

Update existing address

PATCH /addresses/{ID}

Update an existing address by ID and return it's persistent data. Requires writable accounts permission. Has dependency on account.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
addresses

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": 7,
  "contact": 13,
  "creationdate": 872838840,
  "creator": 6,
  "default": "integer",
  "lastmodified": 872838840,
  "type": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

applications

Please note: Applications are only read-only and can only be accessed by admin users

applications

List applications

POST /applications

List selected data from all applications that match the specified filter and search criteria in a specific sort order. Requires dev permission.

200 OK
applications

OK

type
applications
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "activity": "integer",
    "creationdate": 872838840,
    "creator": 6,
    "identifier": "my_application",
    "lastmodified": 872838840,
    "name": "My Application",
    "vendor": "ZeyOS",
    "version": 10000
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
applications

Get application

GET /applications/{ID}

Return the data of an existing application by ID. Requires dev permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
applications

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "activity": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "identifier": "my_application",
  "lastmodified": 872838840,
  "name": "My Application",
  "vendor": "ZeyOS",
  "version": 10000
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
applications

Check if application exists

HEAD /applications/{ID}

Check if an application with ID exists, but do not return it's data. Requires dev permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

appointments

appointments

List appointments

POST /appointments

List selected data from all appointments that match the specified filter and search criteria in a specific sort order. Requires calendar permission.

200 OK
appointments

OK

type
appointments
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "assigneduser": 6,
    "color": "string",
    "creationdate": 872838840,
    "creator": 6,
    "datefrom": 872838840,
    "daterecurrence": "integer (int64)",
    "dateto": 872842440,
    "davserver": 7,
    "description": "string",
    "interval": "integer",
    "lastmodified": 872838840,
    "location": "Office",
    "name": "My Appointment",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)",
    "recurrence": "integer",
    "visibility": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
appointments

Create new appointment

PUT /appointments

Create a new appointment and return it's persistent data. Requires writable calendar permission.

body
in formData
object

(no description)

201 Created
appointments

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "assigneduser": 6,
  "color": "string",
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": 872838840,
  "daterecurrence": "integer (int64)",
  "dateto": 872842440,
  "davserver": 7,
  "description": "string",
  "interval": "integer",
  "lastmodified": 872838840,
  "location": "Office",
  "name": "My Appointment",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recurrence": "integer",
  "visibility": "integer"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
appointments

Delete appointment

DELETE /appointments/{ID}

Permanently delete an existing appointment by ID. Requires writable calendar permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
appointments

Get appointment

GET /appointments/{ID}

Return the data of an existing appointment by ID. Requires calendar permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
appointments

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "assigneduser": 6,
  "color": "string",
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": 872838840,
  "daterecurrence": "integer (int64)",
  "dateto": 872842440,
  "davserver": 7,
  "description": "string",
  "interval": "integer",
  "lastmodified": 872838840,
  "location": "Office",
  "name": "My Appointment",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recurrence": "integer",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
appointments

Check if appointment exists

HEAD /appointments/{ID}

Check if an appointment with ID exists, but do not return it's data. Requires calendar permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
appointments

Update existing appointment

PATCH /appointments/{ID}

Update an existing appointment by ID and return it's persistent data. Requires writable calendar permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
appointments

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "assigneduser": 6,
  "color": "string",
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": 872838840,
  "daterecurrence": "integer (int64)",
  "dateto": 872842440,
  "davserver": 7,
  "description": "string",
  "interval": "integer",
  "lastmodified": 872838840,
  "location": "Office",
  "name": "My Appointment",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recurrence": "integer",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

associations

associations

List associations

POST /associations

List selected data from all associations that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

200 OK
associations

OK

type
associations
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "creationdate": 872838840,
    "creator": 6,
    "entity1": "notes",
    "entity2": "tasks",
    "index1": 7,
    "index2": 13
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
associations

Create new association

PUT /associations

Create a new association and return it's persistent data. Requires no specific permission.

ID
in formData
integer (int64)

Association ID

creator
in formData
integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate
in formData
integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

entity1
in formData
string accounts, actionsteps, applications, appointments, campaigns, contacts, contracts, coupons, davservers, devices, dunning, feedservers, groups, items, ledgers, links, mailinglists, mailservers, messages, notes, objects, opportunities, payments, pricelists, projects, resources, services, storages, tasks, tickets, transactions, users, weblets

First canonical entity

entity2
in formData
string accounts, actionsteps, applications, appointments, campaigns, contacts, contracts, coupons, davservers, devices, dunning, feedservers, groups, items, ledgers, links, mailinglists, mailservers, messages, notes, objects, opportunities, payments, pricelists, projects, resources, services, storages, tasks, tickets, transactions, users, weblets

Second canonical entity

index1
in formData
integer (int32)

First entity ID

index2
in formData
integer (int32)

Second entity ID

in

(no description)

201 Created
associations

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity1": "notes",
  "entity2": "tasks",
  "index1": 7,
  "index2": 13
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
associations

Delete association

DELETE /associations/{ID}

Permanently delete an existing association by ID. Requires no specific permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
associations

Get association

GET /associations/{ID}

Return the data of an existing association by ID. Requires no specific permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
associations

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity1": "notes",
  "entity2": "tasks",
  "index1": 7,
  "index2": 13
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
associations

Check if association exists

HEAD /associations/{ID}

Check if an association with ID exists, but do not return it's data. Requires no specific permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
associations

Update existing association

PATCH /associations/{ID}

Update an existing association by ID and return it's persistent data. Requires no specific permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
associations

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity1": "notes",
  "entity2": "tasks",
  "index1": 7,
  "index2": 13
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

binfiles

binfiles

List bin files

POST /binfiles

List selected data from all bin files that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

200 OK
users

OK

type
users
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "activity": "integer",
    "apionly": "integer",
    "contact": 7,
    "creationdate": 872838840,
    "creator": 6,
    "email": "john.doe@company.com",
    "expdate": "integer (int64)",
    "lastlogin": 872838840,
    "lastmodified": 872838840,
    "name": "john.doe",
    "nopublic": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
binfiles

Get bin file

GET /binfiles/{ID}

Return the data of an existing bin file by ID. Requires no specific permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
binfiles

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "hash": "\\xed076287532e86365e841e92bfc50d8c",
  "size": 12
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
binfiles

Check if bin file exists

HEAD /binfiles/{ID}

Check if a bin file with ID exists, but do not return it's data. Requires no specific permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

campaigns

campaigns

List campaigns

POST /campaigns

List selected data from all campaigns that match the specified filter and search criteria in a specific sort order. Requires campaigns permission.

200 OK
campaigns

OK

type
campaigns
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "assigneduser": 6,
    "creationdate": 872838840,
    "creator": 6,
    "datefrom": "integer (int64)",
    "dateto": "integer (int64)",
    "description": "string",
    "lastmodified": 872838840,
    "name": "My Campaign",
    "ownergroup": "integer (int32)",
    "status": "integer",
    "visibility": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
campaigns

Create new campaign

PUT /campaigns

Create a new campaign and return it's persistent data. Requires writable campaigns permission.

body
in formData
object

(no description)

201 Created
campaigns

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Campaign",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "visibility": "integer"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
campaigns

Delete campaign

DELETE /campaigns/{ID}

Permanently delete an existing campaign by ID. Requires writable campaigns permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
campaigns

Get campaign

GET /campaigns/{ID}

Return the data of an existing campaign by ID. Requires campaigns permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
campaigns

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Campaign",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
campaigns

Check if campaign exists

HEAD /campaigns/{ID}

Check if a campaign with ID exists, but do not return it's data. Requires campaigns permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
campaigns

Update existing campaign

PATCH /campaigns/{ID}

Update an existing campaign by ID and return it's persistent data. Requires writable campaigns permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
campaigns

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Campaign",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

categories

categories

List categories

POST /categories

List selected data from all categories that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

200 OK
categories

OK

type
categories
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "creationdate": 872838840,
    "creator": 6,
    "entity": "notes",
    "name": "My Category/My Subcategory",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
categories

Create new category

PUT /categories

Create a new category and return it's persistent data. Requires no specific permission.

ID
in formData
integer (int32)

Category ID

owneruser
in formData
integer (int32)

Owner user ID (PUBLIC if owneruser=null and ownergroup=null)

ownergroup
in formData
integer (int32)

Owner group ID (PUBLIC if owneruser=null and ownergroup=null)

creator
in formData
integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate
in formData
integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

entity
in formData
string (at least 1 chars)

Canonical entity

name
in formData
string (at least 1 chars)

Name

201 Created
categories

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity": "notes",
  "name": "My Category/My Subcategory",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
categories

Delete category

DELETE /categories/{ID}

Permanently delete an existing category by ID. Requires no specific permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
categories

Get category

GET /categories/{ID}

Return the data of an existing category by ID. Requires no specific permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
categories

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity": "notes",
  "name": "My Category/My Subcategory",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
categories

Check if category exists

HEAD /categories/{ID}

Check if a category with ID exists, but do not return it's data. Requires no specific permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
categories

Update existing category

PATCH /categories/{ID}

Update an existing category by ID and return it's persistent data. Requires no specific permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
categories

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity": "notes",
  "name": "My Category/My Subcategory",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

channels

channels

List channels

POST /channels

List selected data from all channels that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

200 OK
channels

OK

type
channels
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "creationdate": 872838840,
    "creator": 6,
    "name": "Channel"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
channels

Create new channel

PUT /channels

Create a new channel and return it's persistent data. Requires no specific permission.

ID
in formData
integer (int32)

Channel ID

creator
in formData
integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate
in formData
integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

name
in formData
string (at least 1 chars)

Name (unique)

201 Created
channels

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "name": "Channel"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
channels

Delete channel

DELETE /channels/{ID}

Permanently delete an existing channel by ID. Requires no specific permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
channels

Get channel

GET /channels/{ID}

Return the data of an existing channel by ID. Requires no specific permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
channels

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "name": "Channel"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
channels

Check if channel exists

HEAD /channels/{ID}

Check if a channel with ID exists, but do not return it's data. Requires no specific permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
channels

Update existing channel

PATCH /channels/{ID}

Update an existing channel by ID and return it's persistent data. Requires no specific permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
channels

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "name": "Channel"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

comments

comments

List comments

POST /comments

List selected data from all comments that match the specified filter and search criteria in a specific sort order. Requires no specific permission. Has dependency on record.

200 OK
comments

OK

type
comments
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "creationdate": 872838840,
    "creator": 6,
    "record": 7,
    "sender": "John Doe",
    "text": "This is my comment!"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
comments

Create new comment

PUT /comments

Create a new comment and return it's persistent data. Requires the authenticated user to be the creator. Has dependency on record.

ID
in formData
integer (int64)

Comment ID

creator
in formData
integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate
in formData
integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

record
in formData
integer (int64)

Record ID ( dependency)

sender
in formData
string

Sender

text
in formData
string

Comment text ( Markdown for rich text representation)

201 Created
comments

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "record": 7,
  "sender": "John Doe",
  "text": "This is my comment!"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
comments

Delete comment

DELETE /comments/{ID}

Permanently delete an existing comment by ID. Requires the authenticated user to be the creator. Has dependency on record.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
comments

Get comment

GET /comments/{ID}

Return the data of an existing comment by ID. Requires no specific permission. Has dependency on record.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
comments

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "record": 7,
  "sender": "John Doe",
  "text": "This is my comment!"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
comments

Check if comment exists

HEAD /comments/{ID}

Check if a comment with ID exists, but do not return it's data. Requires no specific permission. Has dependency on record.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
comments

Update existing comment

PATCH /comments/{ID}

Update an existing comment by ID and return it's persistent data. Requires the authenticated user to be the creator. Has dependency on record.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
comments

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "record": 7,
  "sender": "John Doe",
  "text": "This is my comment!"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

components

components

List components

POST /components

List selected data from all components that match the specified filter and search criteria in a specific sort order. Requires inventory permission. Has dependency on item.

200 OK
components

OK

type
components
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "amount": "number (double)",
    "component": 13,
    "creationdate": 872838840,
    "creator": 6,
    "fixed": "integer",
    "item": 7,
    "lastmodified": 872838840,
    "price": "number (double)"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
components

Create new component

PUT /components

Create a new component and return it's persistent data. Requires writable inventory permission. Has dependency on item.

ID
in formData
integer (int64)

Component ID

creator
in formData
integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate
in formData
integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

lastmodified
in formData
integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

item
in formData
integer (int32)

Item ID ( dependency)

component
in formData
integer (int32)

Component item ID; must be distinct from item

amount
in formData
number (double) 1

Amount (quantity)

price
in formData
number (double)

Imputed price per unit

fixed
in formData
integer 0, 1 0

Fixed quantity

201 Created
components

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "amount": "number (double)",
  "component": 13,
  "creationdate": 872838840,
  "creator": 6,
  "fixed": "integer",
  "item": 7,
  "lastmodified": 872838840,
  "price": "number (double)"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
components

Delete component

DELETE /components/{ID}

Permanently delete an existing component by ID. Requires writable inventory permission. Has dependency on item.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
components

Get component

GET /components/{ID}

Return the data of an existing component by ID. Requires inventory permission. Has dependency on item.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
components

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "amount": "number (double)",
  "component": 13,
  "creationdate": 872838840,
  "creator": 6,
  "fixed": "integer",
  "item": 7,
  "lastmodified": 872838840,
  "price": "number (double)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
components

Check if component exists

HEAD /components/{ID}

Check if a component with ID exists, but do not return it's data. Requires inventory permission. Has dependency on item.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
components

Update existing component

PATCH /components/{ID}

Update an existing component by ID and return it's persistent data. Requires writable inventory permission. Has dependency on item.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
components

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "amount": "number (double)",
  "component": 13,
  "creationdate": 872838840,
  "creator": 6,
  "fixed": "integer",
  "item": 7,
  "lastmodified": 872838840,
  "price": "number (double)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

contacts

contacts

List contacts

POST /contacts

List selected data from all contacts that match the specified filter and search criteria in a specific sort order. Requires contacts permission.

200 OK
contacts

OK

type
contacts
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "address": "123 Main St.",
    "assigneduser": 6,
    "birthdate": "integer (int64)",
    "cell": "+1 123-456-7892",
    "city": "Anytown",
    "company": "Any Company, Inc.",
    "country": "US",
    "creationdate": 872838840,
    "creator": 6,
    "davserver": 7,
    "department": "Research & Development",
    "description": "string",
    "email": "john.doe@company.com",
    "email2": "johnny_d@personal.com",
    "fax": "+1 123-456-7893",
    "firstname": "John",
    "lastmodified": 872838840,
    "lastname": "Doe",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)",
    "phone": "+1 123-456-7890",
    "phone2": "+1 123-456-7891",
    "position": "CTO",
    "postalcode": "95060",
    "region": "CA",
    "title": "Dr.",
    "type": "integer",
    "visibility": "integer",
    "website": "http://www.company.com/about/john_doe"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
contacts

Create new contact

PUT /contacts

Create a new contact and return it's persistent data. Requires writable contacts permission.

body
in formData
object

(no description)

201 Created
contacts

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "address": "123 Main St.",
  "assigneduser": 6,
  "birthdate": "integer (int64)",
  "cell": "+1 123-456-7892",
  "city": "Anytown",
  "company": "Any Company, Inc.",
  "country": "US",
  "creationdate": 872838840,
  "creator": 6,
  "davserver": 7,
  "department": "Research & Development",
  "description": "string",
  "email": "john.doe@company.com",
  "email2": "johnny_d@personal.com",
  "fax": "+1 123-456-7893",
  "firstname": "John",
  "lastmodified": 872838840,
  "lastname": "Doe",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "phone": "+1 123-456-7890",
  "phone2": "+1 123-456-7891",
  "position": "CTO",
  "postalcode": "95060",
  "region": "CA",
  "title": "Dr.",
  "type": "integer",
  "visibility": "integer",
  "website": "http://www.company.com/about/john_doe"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
contacts

Delete contact

DELETE /contacts/{ID}

Permanently delete an existing contact by ID. Requires writable contacts permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
contacts

Get contact

GET /contacts/{ID}

Return the data of an existing contact by ID. Requires contacts permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
contacts

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "address": "123 Main St.",
  "assigneduser": 6,
  "birthdate": "integer (int64)",
  "cell": "+1 123-456-7892",
  "city": "Anytown",
  "company": "Any Company, Inc.",
  "country": "US",
  "creationdate": 872838840,
  "creator": 6,
  "davserver": 7,
  "department": "Research & Development",
  "description": "string",
  "email": "john.doe@company.com",
  "email2": "johnny_d@personal.com",
  "fax": "+1 123-456-7893",
  "firstname": "John",
  "lastmodified": 872838840,
  "lastname": "Doe",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "phone": "+1 123-456-7890",
  "phone2": "+1 123-456-7891",
  "position": "CTO",
  "postalcode": "95060",
  "region": "CA",
  "title": "Dr.",
  "type": "integer",
  "visibility": "integer",
  "website": "http://www.company.com/about/john_doe"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
contacts

Check if contact exists

HEAD /contacts/{ID}

Check if a contact with ID exists, but do not return it's data. Requires contacts permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
contacts

Update existing contact

PATCH /contacts/{ID}

Update an existing contact by ID and return it's persistent data. Requires writable contacts permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
contacts

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "address": "123 Main St.",
  "assigneduser": 6,
  "birthdate": "integer (int64)",
  "cell": "+1 123-456-7892",
  "city": "Anytown",
  "company": "Any Company, Inc.",
  "country": "US",
  "creationdate": 872838840,
  "creator": 6,
  "davserver": 7,
  "department": "Research & Development",
  "description": "string",
  "email": "john.doe@company.com",
  "email2": "johnny_d@personal.com",
  "fax": "+1 123-456-7893",
  "firstname": "John",
  "lastmodified": 872838840,
  "lastname": "Doe",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "phone": "+1 123-456-7890",
  "phone2": "+1 123-456-7891",
  "position": "CTO",
  "postalcode": "95060",
  "region": "CA",
  "title": "Dr.",
  "type": "integer",
  "visibility": "integer",
  "website": "http://www.company.com/about/john_doe"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

contacts2contacts

contacts2contacts

List contacts-to-contacts

POST /contacts2contacts

List selected data from all contacts-to-contacts that match the specified filter and search criteria in a specific sort order. Requires contacts permission. Has dependencies on contact1 and contact2.

200 OK
contacts2contacts

OK

type
contacts2contacts
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "contact1": 7,
    "contact2": 13,
    "creationdate": 872838840,
    "creator": 6
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
contacts2contacts

Create new contact-to-contact

PUT /contacts2contacts

Create a new contact-to-contact and return it's persistent data. Requires writable contacts permission. Has dependencies on contact1 and contact2.

ID
in formData
integer (int64)

Contact-to-contact ID

creator
in formData
integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate
in formData
integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

contact1
in formData
integer (int32)

First contact ID ( dependency)

contact2
in formData
integer (int32)

Second contact ID ( dependency)

201 Created
contacts2contacts

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "contact1": 7,
  "contact2": 13,
  "creationdate": 872838840,
  "creator": 6
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
contacts2contacts

Delete contact-to-contact

DELETE /contacts2contacts/{ID}

Permanently delete an existing contact-to-contact by ID. Requires writable contacts permission. Has dependencies on contact1 and contact2.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
contacts2contacts

Get contact-to-contact

GET /contacts2contacts/{ID}

Return the data of an existing contact-to-contact by ID. Requires contacts permission. Has dependencies on contact1 and contact2.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
contacts2contacts

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "contact1": 7,
  "contact2": 13,
  "creationdate": 872838840,
  "creator": 6
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
contacts2contacts

Check if contact-to-contact exists

HEAD /contacts2contacts/{ID}

Check if a contact-to-contact with ID exists, but do not return it's data. Requires contacts permission. Has dependencies on contact1 and contact2.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
contacts2contacts

Update existing contact-to-contact

PATCH /contacts2contacts/{ID}

Update an existing contact-to-contact by ID and return it's persistent data. Requires writable contacts permission. Has dependencies on contact1 and contact2.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
contacts2contacts

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "contact1": 7,
  "contact2": 13,
  "creationdate": 872838840,
  "creator": 6
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

contracts

contracts

List contracts

POST /contracts

List selected data from all contracts that match the specified filter and search criteria in a specific sort order. Requires contracts permission.

200 OK
contracts

OK

type
contracts
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "account": 7,
    "assigneduser": 6,
    "billingcycle": "integer",
    "calculation": "integer",
    "contractnum": "N-123456",
    "creationdate": 872838840,
    "creator": 6,
    "currency": "EUR",
    "datecancel": "integer (int64)",
    "datefrom": 872838840,
    "dateto": "integer (int64)",
    "description": "string",
    "exchangerate": "number (double)",
    "lastbilling": "integer (int64)",
    "lastmodified": 872838840,
    "name": "My Contract",
    "ownergroup": "integer (int32)",
    "status": "integer",
    "visibility": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
contracts

Create new contract

PUT /contracts

Create a new contract and return it's persistent data. Requires writable contracts permission.

body
in formData
object

(no description)

201 Created
contracts

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "billingcycle": "integer",
  "calculation": "integer",
  "contractnum": "N-123456",
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "datecancel": "integer (int64)",
  "datefrom": 872838840,
  "dateto": "integer (int64)",
  "description": "string",
  "exchangerate": "number (double)",
  "lastbilling": "integer (int64)",
  "lastmodified": 872838840,
  "name": "My Contract",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "visibility": "integer"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
contracts

Delete contract

DELETE /contracts/{ID}

Permanently delete an existing contract by ID. Requires writable contracts permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
contracts

Get contract

GET /contracts/{ID}

Return the data of an existing contract by ID. Requires contracts permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
contracts

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "billingcycle": "integer",
  "calculation": "integer",
  "contractnum": "N-123456",
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "datecancel": "integer (int64)",
  "datefrom": 872838840,
  "dateto": "integer (int64)",
  "description": "string",
  "exchangerate": "number (double)",
  "lastbilling": "integer (int64)",
  "lastmodified": 872838840,
  "name": "My Contract",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
contracts

Check if contract exists

HEAD /contracts/{ID}

Check if a contract with ID exists, but do not return it's data. Requires contracts permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
contracts

Update existing contract

PATCH /contracts/{ID}

Update an existing contract by ID and return it's persistent data. Requires writable contracts permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
contracts

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "billingcycle": "integer",
  "calculation": "integer",
  "contractnum": "N-123456",
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "datecancel": "integer (int64)",
  "datefrom": 872838840,
  "dateto": "integer (int64)",
  "description": "string",
  "exchangerate": "number (double)",
  "lastbilling": "integer (int64)",
  "lastmodified": 872838840,
  "name": "My Contract",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

coupons

coupons

List coupons

POST /coupons

List selected data from all coupons that match the specified filter and search criteria in a specific sort order. Requires pricelists permission.

200 OK
coupons

OK

type
coupons
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "activity": "integer",
    "code": "XMAX17",
    "creationdate": 872838840,
    "creator": 6,
    "datefrom": "integer (int64)",
    "dateto": "integer (int64)",
    "description": "string",
    "foreigntaxrates": {
      "AT": 21,
      "DE": 19
    },
    "lastmodified": 872838840,
    "name": "My Coupon",
    "neutral": "integer",
    "ownergroup": "integer (int32)",
    "taxrate": "number (double)",
    "type": "integer",
    "value": "number (double)"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
coupons

Create new coupon

PUT /coupons

Create a new coupon and return it's persistent data. Requires writable pricelists permission.

body
in formData
object

(no description)

201 Created
coupons

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "activity": "integer",
  "code": "XMAX17",
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "description": "string",
  "foreigntaxrates": {
    "AT": 21,
    "DE": 19
  },
  "lastmodified": 872838840,
  "name": "My Coupon",
  "neutral": "integer",
  "ownergroup": "integer (int32)",
  "taxrate": "number (double)",
  "type": "integer",
  "value": "number (double)"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
coupons

Delete coupon

DELETE /coupons/{ID}

Permanently delete an existing coupon by ID. Requires writable pricelists permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
coupons

Get coupon

GET /coupons/{ID}

Return the data of an existing coupon by ID. Requires pricelists permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
coupons

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "activity": "integer",
  "code": "XMAX17",
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "description": "string",
  "foreigntaxrates": {
    "AT": 21,
    "DE": 19
  },
  "lastmodified": 872838840,
  "name": "My Coupon",
  "neutral": "integer",
  "ownergroup": "integer (int32)",
  "taxrate": "number (double)",
  "type": "integer",
  "value": "number (double)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
coupons

Check if coupon exists

HEAD /coupons/{ID}

Check if a coupon with ID exists, but do not return it's data. Requires pricelists permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
coupons

Update existing coupon

PATCH /coupons/{ID}

Update an existing coupon by ID and return it's persistent data. Requires writable pricelists permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
coupons

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "activity": "integer",
  "code": "XMAX17",
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "description": "string",
  "foreigntaxrates": {
    "AT": 21,
    "DE": 19
  },
  "lastmodified": 872838840,
  "name": "My Coupon",
  "neutral": "integer",
  "ownergroup": "integer (int32)",
  "taxrate": "number (double)",
  "type": "integer",
  "value": "number (double)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

couponcodes

couponcodes

List coupon codes

POST /couponcodes

List selected data from all coupon codes that match the specified filter and search criteria in a specific sort order. Requires pricelists permission. Has dependency on coupon.

200 OK
couponcodes

OK

type
couponcodes
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "code": "XMAX17",
    "coupon": 7,
    "creationdate": 872838840,
    "creator": 6,
    "date": 872838840,
    "datefrom": "integer (int64)",
    "dateto": "integer (int64)",
    "flag": "integer",
    "lastmodified": 872838840,
    "transaction": "integer (int32)",
    "value": "number (double)"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
couponcodes

Create new coupon code

PUT /couponcodes

Create a new coupon code and return it's persistent data. Requires writable pricelists permission. Has dependency on coupon.

body
in formData
object

(no description)

201 Created
couponcodes

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "code": "XMAX17",
  "coupon": 7,
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "flag": "integer",
  "lastmodified": 872838840,
  "transaction": "integer (int32)",
  "value": "number (double)"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
couponcodes

Delete coupon code

DELETE /couponcodes/{ID}

Permanently delete an existing coupon code by ID. Requires writable pricelists permission. Has dependency on coupon.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
couponcodes

Get coupon code

GET /couponcodes/{ID}

Return the data of an existing coupon code by ID. Requires pricelists permission. Has dependency on coupon.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
couponcodes

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "code": "XMAX17",
  "coupon": 7,
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "flag": "integer",
  "lastmodified": 872838840,
  "transaction": "integer (int32)",
  "value": "number (double)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
couponcodes

Check if coupon code exists

HEAD /couponcodes/{ID}

Check if a coupon code with ID exists, but do not return it's data. Requires pricelists permission. Has dependency on coupon.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
couponcodes

Update existing coupon code

PATCH /couponcodes/{ID}

Update an existing coupon code by ID and return it's persistent data. Requires writable pricelists permission. Has dependency on coupon.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
couponcodes

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "code": "XMAX17",
  "coupon": 7,
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "flag": "integer",
  "lastmodified": 872838840,
  "transaction": "integer (int32)",
  "value": "number (double)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

davservers

davservers

List DAV servers

POST /davservers

List selected data from all DAV servers that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

200 OK
davservers

OK

type
davservers
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "activity": "integer",
    "creationdate": 872838840,
    "creator": 6,
    "ctag": "\"73c5fdd17f180f2126995666b7edc0e3\"",
    "description": "string",
    "lastmodified": 872838840,
    "name": "My DAV Server",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)",
    "recipientgroup": "integer (int32)",
    "recipientuser": "integer (int32)",
    "synctoken": "http://dav.company.com/sync/1234",
    "type": "integer",
    "url": "https://dav.company.com/collection",
    "username": "john.doe"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
davservers

Create new DAV server

PUT /davservers

Create a new DAV server and return it's persistent data. Requires no specific permission.

body
in formData
object

(no description)

201 Created
davservers

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "activity": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "ctag": "\"73c5fdd17f180f2126995666b7edc0e3\"",
  "description": "string",
  "lastmodified": 872838840,
  "name": "My DAV Server",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recipientgroup": "integer (int32)",
  "recipientuser": "integer (int32)",
  "synctoken": "http://dav.company.com/sync/1234",
  "type": "integer",
  "url": "https://dav.company.com/collection",
  "username": "john.doe"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
davservers

Delete DAV server

DELETE /davservers/{ID}

Permanently delete an existing DAV server by ID. Requires no specific permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
davservers

Get DAV server

GET /davservers/{ID}

Return the data of an existing DAV server by ID. Requires no specific permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
davservers

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "activity": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "ctag": "\"73c5fdd17f180f2126995666b7edc0e3\"",
  "description": "string",
  "lastmodified": 872838840,
  "name": "My DAV Server",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recipientgroup": "integer (int32)",
  "recipientuser": "integer (int32)",
  "synctoken": "http://dav.company.com/sync/1234",
  "type": "integer",
  "url": "https://dav.company.com/collection",
  "username": "john.doe"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
davservers

Check if DAV server exists

HEAD /davservers/{ID}

Check if a DAV server with ID exists, but do not return it's data. Requires no specific permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
davservers

Update existing DAV server

PATCH /davservers/{ID}

Update an existing DAV server by ID and return it's persistent data. Requires no specific permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
davservers

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "activity": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "ctag": "\"73c5fdd17f180f2126995666b7edc0e3\"",
  "description": "string",
  "lastmodified": 872838840,
  "name": "My DAV Server",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recipientgroup": "integer (int32)",
  "recipientuser": "integer (int32)",
  "synctoken": "http://dav.company.com/sync/1234",
  "type": "integer",
  "url": "https://dav.company.com/collection",
  "username": "john.doe"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

devices

devices

List devices

POST /devices

List selected data from all devices that match the specified filter and search criteria in a specific sort order. Requires inventory permission.

200 OK
devices

OK

type
devices
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "chargenum": "LOT-123456",
    "contract": "integer (int32)",
    "creationdate": 872838840,
    "creator": 6,
    "description": "string",
    "expdate": "integer (int64)",
    "item": 7,
    "lastmodified": 872838840,
    "ownergroup": "integer (int32)",
    "serialnum": "S-123456",
    "visibility": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
devices

Create new device

PUT /devices

Create a new device and return it's persistent data. Requires inventory permission.

body
in formData
object

(no description)

201 Created
devices

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "chargenum": "LOT-123456",
  "contract": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "expdate": "integer (int64)",
  "item": 7,
  "lastmodified": 872838840,
  "ownergroup": "integer (int32)",
  "serialnum": "S-123456",
  "visibility": "integer"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
devices

Delete device

DELETE /devices/{ID}

Permanently delete an existing device by ID. Requires inventory permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
devices

Get device

GET /devices/{ID}

Return the data of an existing device by ID. Requires inventory permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
devices

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "chargenum": "LOT-123456",
  "contract": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "expdate": "integer (int64)",
  "item": 7,
  "lastmodified": 872838840,
  "ownergroup": "integer (int32)",
  "serialnum": "S-123456",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
devices

Check if device exists

HEAD /devices/{ID}

Check if a device with ID exists, but do not return it's data. Requires inventory permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
devices

Update existing device

PATCH /devices/{ID}

Update an existing device by ID and return it's persistent data. Requires inventory permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
devices

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "chargenum": "LOT-123456",
  "contract": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "expdate": "integer (int64)",
  "item": 7,
  "lastmodified": 872838840,
  "ownergroup": "integer (int32)",
  "serialnum": "S-123456",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

dunning

dunning

List dunning notices

POST /dunning

List selected data from all dunning notices that match the specified filter and search criteria in a specific sort order. Requires billing, procurement or collection permission.

200 OK
dunning

OK

type
dunning
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "account": 7,
    "address": "123 Main St.",
    "assigneduser": 6,
    "city": "Anytown",
    "country": "US",
    "creationdate": 872838840,
    "creator": 6,
    "date": 872838840,
    "duedate": "integer (int64)",
    "dunningnum": "D-0117.12345",
    "fee": "number (double)",
    "lastmodified": 872838840,
    "ownergroup": "integer (int32)",
    "postalcode": "95060",
    "recipient": "Bad Customer, Inc.",
    "region": "CA",
    "status": "integer",
    "type": 1
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
dunning

Create new dunning notice

PUT /dunning

Create a new dunning notice and return it's persistent data. Requires writable billing, procurement or collection permission.

body
in formData
object

(no description)

201 Created
dunning

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "account": 7,
  "address": "123 Main St.",
  "assigneduser": 6,
  "city": "Anytown",
  "country": "US",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "duedate": "integer (int64)",
  "dunningnum": "D-0117.12345",
  "fee": "number (double)",
  "lastmodified": 872838840,
  "ownergroup": "integer (int32)",
  "postalcode": "95060",
  "recipient": "Bad Customer, Inc.",
  "region": "CA",
  "status": "integer",
  "type": 1
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
dunning

Delete dunning notice

DELETE /dunning/{ID}

Permanently delete an existing dunning notice by ID. Requires writable billing, procurement or collection permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
dunning

Get dunning notice

GET /dunning/{ID}

Return the data of an existing dunning notice by ID. Requires billing, procurement or collection permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
dunning

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": 7,
  "address": "123 Main St.",
  "assigneduser": 6,
  "city": "Anytown",
  "country": "US",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "duedate": "integer (int64)",
  "dunningnum": "D-0117.12345",
  "fee": "number (double)",
  "lastmodified": 872838840,
  "ownergroup": "integer (int32)",
  "postalcode": "95060",
  "recipient": "Bad Customer, Inc.",
  "region": "CA",
  "status": "integer",
  "type": 1
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
dunning

Check if dunning notice exists

HEAD /dunning/{ID}

Check if a dunning notice with ID exists, but do not return it's data. Requires billing, procurement or collection permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
dunning

Update existing dunning notice

PATCH /dunning/{ID}

Update an existing dunning notice by ID and return it's persistent data. Requires writable billing, procurement or collection permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
dunning

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": 7,
  "address": "123 Main St.",
  "assigneduser": 6,
  "city": "Anytown",
  "country": "US",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "duedate": "integer (int64)",
  "dunningnum": "D-0117.12345",
  "fee": "number (double)",
  "lastmodified": 872838840,
  "ownergroup": "integer (int32)",
  "postalcode": "95060",
  "recipient": "Bad Customer, Inc.",
  "region": "CA",
  "status": "integer",
  "type": 1
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

dunning2transactions

dunning2transactions

List dunning-to-transactions

POST /dunning2transactions

List selected data from all dunning-to-transactions that match the specified filter and search criteria in a specific sort order. Requires billing, procurement or collection permission. Has dependencies on dunning and transaction.

200 OK
dunning2transactions

OK

type
dunning2transactions
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "creationdate": 872838840,
    "creator": 6,
    "dunning": 7,
    "transaction": 13
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
dunning2transactions

Create new dunning-to-transaction

PUT /dunning2transactions

Create a new dunning-to-transaction and return it's persistent data. Requires writable billing, procurement or collection permission. Has dependencies on dunning and transaction.

ID
in formData
integer (int64)

Dunning-to-transaction ID

creator
in formData
integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate
in formData
integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

dunning
in formData
integer (int32)

Dunning notice ID ( dependency)

transaction
in formData
integer (int32)

Transaction ID ( dependency)

201 Created
dunning2transactions

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "dunning": 7,
  "transaction": 13
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
dunning2transactions

Delete dunning-to-transaction

DELETE /dunning2transactions/{ID}

Permanently delete an existing dunning-to-transaction by ID. Requires writable billing, procurement or collection permission. Has dependencies on dunning and transaction.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
dunning2transactions

Get dunning-to-transaction

GET /dunning2transactions/{ID}

Return the data of an existing dunning-to-transaction by ID. Requires billing, procurement or collection permission. Has dependencies on dunning and transaction.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
dunning2transactions

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "dunning": 7,
  "transaction": 13
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
dunning2transactions

Check if dunning-to-transaction exists

HEAD /dunning2transactions/{ID}

Check if a dunning-to-transaction with ID exists, but do not return it's data. Requires billing, procurement or collection permission. Has dependencies on dunning and transaction.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
dunning2transactions

Update existing dunning-to-transaction

PATCH /dunning2transactions/{ID}

Update an existing dunning-to-transaction by ID and return it's persistent data. Requires writable billing, procurement or collection permission. Has dependencies on dunning and transaction.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
dunning2transactions

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "dunning": 7,
  "transaction": 13
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

entities2channels

entities2channels

List entities-to-channels

POST /entities2channels

List selected data from all entities-to-channels that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

200 OK
entities2channels

OK

type
entities2channels
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "channel": 1,
    "creationdate": 872838840,
    "creator": 6,
    "entity": "notes",
    "index": 7
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
entities2channels

Create new entity-to-channel

PUT /entities2channels

Create a new entity-to-channel and return it's persistent data. Requires no specific permission.

ID
in formData
integer (int64)

Entity-to-channel ID

creator
in formData
integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate
in formData
integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

entity
in formData
string accounts, actionsteps, applications, appointments, campaigns, contacts, contracts, coupons, davservers, devices, dunning, feedservers, groups, items, ledgers, links, mailinglists, mailservers, messages, notes, objects, opportunities, payments, pricelists, projects, resources, services, storages, tasks, tickets, transactions, users, weblets

Canonical entity

index
in formData
integer (int64)

Entity ID

channel
in formData
integer (int32)

Channel ID ( dependency)

201 Created
entities2channels

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "channel": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity": "notes",
  "index": 7
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
entities2channels

Delete entity-to-channel

DELETE /entities2channels/{ID}

Permanently delete an existing entity-to-channel by ID. Requires no specific permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
entities2channels

Get entity-to-channel

GET /entities2channels/{ID}

Return the data of an existing entity-to-channel by ID. Requires no specific permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
entities2channels

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "channel": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity": "notes",
  "index": 7
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
entities2channels

Check if entity-to-channel exists

HEAD /entities2channels/{ID}

Check if an entity-to-channel with ID exists, but do not return it's data. Requires no specific permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
entities2channels

Update existing entity-to-channel

PATCH /entities2channels/{ID}

Update an existing entity-to-channel by ID and return it's persistent data. Requires no specific permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
entities2channels

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "channel": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity": "notes",
  "index": 7
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

events

events

List events

POST /events

List selected data from all events that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

200 OK
events

OK

type
events
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "color": "string",
    "creationdate": 872838840,
    "creator": 6,
    "datefrom": 872838840,
    "dateto": 872842440,
    "entity": "notes",
    "index": 7,
    "lastmodified": 872838840,
    "name": "My Event",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
events

Create new event

PUT /events

Create a new event and return it's persistent data. Requires no specific permission.

ID
in formData
integer (int32)

Event ID

owneruser
in formData
integer (int32)

Owner user ID (PUBLIC if owneruser=null and ownergroup=null)

ownergroup
in formData
integer (int32)

Owner group ID (PUBLIC if owneruser=null and ownergroup=null)

creator
in formData
integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate
in formData
integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

lastmodified
in formData
integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

entity
in formData
string accounts, actionsteps, applications, appointments, campaigns, contacts, contracts, coupons, davservers, devices, dunning, feedservers, groups, items, ledgers, links, mailinglists, mailservers, messages, notes, objects, opportunities, payments, pricelists, projects, resources, services, storages, tasks, tickets, transactions, users, weblets

Canonical entity

index
in formData
integer (int32)

Entity ID; is required if entity is not null, otherwise must be null

name
in formData
string (at least 1 chars)

Name

color
in formData
string

Color code (CSS-style hexadecimal without #)

datefrom
in formData
integer (int64)

Start date and time as a Unix time stamp; must be less than or equal to dateto

dateto
in formData
integer (int64)

End date and time as a Unix time stamp; must be greater than or equal to datefrom

in

(no description)

201 Created
events

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "color": "string",
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": 872838840,
  "dateto": 872842440,
  "entity": "notes",
  "index": 7,
  "lastmodified": 872838840,
  "name": "My Event",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
events

Delete event

DELETE /events/{ID}

Permanently delete an existing event by ID. Requires no specific permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
events

Get event

GET /events/{ID}

Return the data of an existing event by ID. Requires no specific permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
events

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "color": "string",
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": 872838840,
  "dateto": 872842440,
  "entity": "notes",
  "index": 7,
  "lastmodified": 872838840,
  "name": "My Event",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
events

Check if event exists

HEAD /events/{ID}

Check if an event with ID exists, but do not return it's data. Requires no specific permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
events

Update existing event

PATCH /events/{ID}

Update an existing event by ID and return it's persistent data. Requires no specific permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
events

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "color": "string",
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": 872838840,
  "dateto": 872842440,
  "entity": "notes",
  "index": 7,
  "lastmodified": 872838840,
  "name": "My Event",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

feedservers

feedservers

List feed servers

POST /feedservers

List selected data from all feed servers that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

200 OK
feedservers

OK

type
feedservers
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "activity": "integer",
    "channel": "integer (int32)",
    "creationdate": 872838840,
    "creator": 6,
    "description": "string",
    "etag": "\"73c5fdd17f180f2126995666b7edc0e3\"",
    "lastmodified": 872838840,
    "name": "My Feed Server",
    "notify": "integer",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)",
    "recipientgroup": "integer (int32)",
    "recipientuser": "integer (int32)",
    "url": "http://www.website.com/feed.rss",
    "username": "john.doe"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
feedservers

Create new feed server

PUT /feedservers

Create a new feed server and return it's persistent data. Requires no specific permission.

body
in formData
object

(no description)

201 Created
feedservers

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "activity": "integer",
  "channel": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "etag": "\"73c5fdd17f180f2126995666b7edc0e3\"",
  "lastmodified": 872838840,
  "name": "My Feed Server",
  "notify": "integer",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recipientgroup": "integer (int32)",
  "recipientuser": "integer (int32)",
  "url": "http://www.website.com/feed.rss",
  "username": "john.doe"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
feedservers

Delete feed server

DELETE /feedservers/{ID}

Permanently delete an existing feed server by ID. Requires no specific permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
feedservers

Get feed server

GET /feedservers/{ID}

Return the data of an existing feed server by ID. Requires no specific permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
feedservers

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "activity": "integer",
  "channel": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "etag": "\"73c5fdd17f180f2126995666b7edc0e3\"",
  "lastmodified": 872838840,
  "name": "My Feed Server",
  "notify": "integer",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recipientgroup": "integer (int32)",
  "recipientuser": "integer (int32)",
  "url": "http://www.website.com/feed.rss",
  "username": "john.doe"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
feedservers

Check if feed server exists

HEAD /feedservers/{ID}

Check if a feed server with ID exists, but do not return it's data. Requires no specific permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
feedservers

Update existing feed server

PATCH /feedservers/{ID}

Update an existing feed server by ID and return it's persistent data. Requires no specific permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
feedservers

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "activity": "integer",
  "channel": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "etag": "\"73c5fdd17f180f2126995666b7edc0e3\"",
  "lastmodified": 872838840,
  "name": "My Feed Server",
  "notify": "integer",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recipientgroup": "integer (int32)",
  "recipientuser": "integer (int32)",
  "url": "http://www.website.com/feed.rss",
  "username": "john.doe"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

files

files

List files

POST /files

List selected data from all files that match the specified filter and search criteria in a specific sort order. Requires no specific permission. Has dependency on record or comment.

200 OK
files

OK

type
files
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "comment": "integer (int64)",
    "creationdate": 872838840,
    "creator": 6,
    "filename": "my_file.txt",
    "mimetype": "text/plain",
    "record": 7,
    "size": 12
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
files

Create new file

PUT /files

Create a new file and return it's persistent data. Requires no specific permission. Has dependency on record or comment.

ID
in formData
integer (int64)

File ID

creator
in formData
integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate
in formData
integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

record
in formData
integer (int64)

Record ID ( dependency); is mutually exclusive to comment (either one is required)

comment
in formData
integer (int64)

Comment ID ( dependency); is mutually exclusive to record (either one is required)

filename
in formData
string

Filename

mimetype
in formData
string application/octet-stream

MIME type ( RFC 2045)

size
in formData
integer (int32) x ≥ 0 0

Size in bytes

in

(no description)

201 Created
files

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "comment": "integer (int64)",
  "creationdate": 872838840,
  "creator": 6,
  "filename": "my_file.txt",
  "mimetype": "text/plain",
  "record": 7,
  "size": 12
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
files

Delete file

DELETE /files/{ID}

Permanently delete an existing file by ID. Requires no specific permission. Has dependency on record or comment.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
files

Get file

GET /files/{ID}

Return the data of an existing file by ID. Requires no specific permission. Has dependency on record or comment.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
files

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "comment": "integer (int64)",
  "creationdate": 872838840,
  "creator": 6,
  "filename": "my_file.txt",
  "mimetype": "text/plain",
  "record": 7,
  "size": 12
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
files

Check if file exists

HEAD /files/{ID}

Check if a file with ID exists, but do not return it's data. Requires no specific permission. Has dependency on record or comment.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
files

Update existing file

PATCH /files/{ID}

Update an existing file by ID and return it's persistent data. Requires no specific permission. Has dependency on record or comment.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
files

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "comment": "integer (int64)",
  "creationdate": 872838840,
  "creator": 6,
  "filename": "my_file.txt",
  "mimetype": "text/plain",
  "record": 7,
  "size": 12
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

follows

follows

List follows

POST /follows

List selected data from all follows that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

200 OK
follows

OK

type
follows
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "creationdate": 872838840,
    "creator": 6,
    "entity": "notes",
    "index": 7
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
follows

Create new follow

PUT /follows

Create a new follow and return it's persistent data. Requires the authenticated user to be the creator.

ID
in formData
integer (int64)

Follow ID

creator
in formData
integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate
in formData
integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

entity
in formData
string accounts, actionsteps, applications, appointments, campaigns, contacts, contracts, coupons, davservers, devices, dunning, feedservers, groups, items, ledgers, links, mailinglists, mailservers, messages, notes, objects, opportunities, payments, pricelists, projects, records, resources, services, storages, tasks, tickets, transactions, users, weblets

Canonical entity

index
in formData
integer (int64)

Entity ID

201 Created
follows

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity": "notes",
  "index": 7
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
follows

Delete follow

DELETE /follows/{ID}

Permanently delete an existing follow by ID. Requires the authenticated user to be the creator.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
follows

Get follow

GET /follows/{ID}

Return the data of an existing follow by ID. Requires no specific permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
follows

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity": "notes",
  "index": 7
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
follows

Check if follow exists

HEAD /follows/{ID}

Check if a follow with ID exists, but do not return it's data. Requires no specific permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
follows

Update existing follow

PATCH /follows/{ID}

Update an existing follow by ID and return it's persistent data. Requires the authenticated user to be the creator.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
follows

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity": "notes",
  "index": 7
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

groups

groups

List groups

POST /groups

List selected data from all groups that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

200 OK
groups

OK

type
groups
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "activity": "integer",
    "creationdate": 872838840,
    "creator": 6,
    "lastmodified": 872838840,
    "leader": "integer (int32)",
    "name": "Operations"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
groups

Get group

GET /groups/{ID}

Return the data of an existing group by ID. Requires no specific permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
groups

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "activity": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "lastmodified": 872838840,
  "leader": "integer (int32)",
  "name": "Operations"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
groups

Check if group exists

HEAD /groups/{ID}

Check if a group with ID exists, but do not return it's data. Requires no specific permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

groups2users

groups2users

List groups-to-users

POST /groups2users

List selected data from all groups-to-users that match the specified filter and search criteria in a specific sort order. Requires admin permission.

200 OK
groups2users

OK

type
groups2users
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "creationdate": 872838840,
    "creator": 6,
    "group": 7,
    "lastmodified": 872838840,
    "user": 13,
    "writable": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
groups2users

Get group-to-user

GET /groups2users/{ID}

Return the data of an existing group-to-user by ID. Requires admin permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
groups2users

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "group": 7,
  "lastmodified": 872838840,
  "user": 13,
  "writable": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
groups2users

Check if group-to-user exists

HEAD /groups2users/{ID}

Check if a group-to-user with ID exists, but do not return it's data. Requires admin permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

invitations

invitations

List invitations

POST /invitations

List selected data from all invitations that match the specified filter and search criteria in a specific sort order. Requires calendar permission. Has dependency on appointment.

200 OK
invitations

OK

type
invitations
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "appointment": 7,
    "contact": "integer (int32)",
    "creationdate": 872838840,
    "creator": 6,
    "email": "john.doe@company.com",
    "flag": "integer",
    "lastmodified": 872838840,
    "name": "John Doe"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
invitations

Create new invitation

PUT /invitations

Create a new invitation and return it's persistent data. Requires writable calendar permission. Has dependency on appointment.

ID
in formData
integer (int64)

Invitation ID

creator
in formData
integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate
in formData
integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

lastmodified
in formData
integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

appointment
in formData
integer (int32)

Appointment ID ( dependency)

contact
in formData
integer (int32)

Contact ID

name
in formData
string (at least 1 chars)

Name

email
in formData
string (email)

E-mail address

flag
in formData
integer 0, 1, 2 0

Flag (0=UNANSWERED, 1=CONFIRMED, 2=REJECTED)

201 Created
invitations

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "appointment": 7,
  "contact": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "email": "john.doe@company.com",
  "flag": "integer",
  "lastmodified": 872838840,
  "name": "John Doe"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
invitations

Delete invitation

DELETE /invitations/{ID}

Permanently delete an existing invitation by ID. Requires writable calendar permission. Has dependency on appointment.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
invitations

Get invitation

GET /invitations/{ID}

Return the data of an existing invitation by ID. Requires calendar permission. Has dependency on appointment.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
invitations

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "appointment": 7,
  "contact": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "email": "john.doe@company.com",
  "flag": "integer",
  "lastmodified": 872838840,
  "name": "John Doe"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
invitations

Check if invitation exists

HEAD /invitations/{ID}

Check if an invitation with ID exists, but do not return it's data. Requires calendar permission. Has dependency on appointment.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
invitations

Update existing invitation

PATCH /invitations/{ID}

Update an existing invitation by ID and return it's persistent data. Requires writable calendar permission. Has dependency on appointment.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
invitations

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "appointment": 7,
  "contact": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "email": "john.doe@company.com",
  "flag": "integer",
  "lastmodified": 872838840,
  "name": "John Doe"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

items

items

List items

POST /items

List selected data from all items that match the specified filter and search criteria in a specific sort order. Requires inventory permission.

200 OK
items

OK

type
items
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "applicability": "integer",
    "barcode": "501234567890",
    "creationdate": 872838840,
    "creator": 6,
    "description": "string",
    "forcestock": "integer",
    "foreigntaxrates": {
      "AT": 21,
      "DE": 19
    },
    "itemnum": "I-123456",
    "lastmodified": 872838840,
    "manufacturer": "My Company, Inc.",
    "model": "integer (int32)",
    "name": "My Product",
    "ownergroup": "integer (int32)",
    "purchaseprice": "number (double)",
    "sellingprice": "number (double)",
    "taxrate": "number (double)",
    "type": "integer",
    "unit": "string",
    "visibility": "integer",
    "weight": "number (double)"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
items

Create new item

PUT /items

Create a new item and return it's persistent data. Requires writable inventory permission.

body
in formData
object

(no description)

201 Created
items

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "applicability": "integer",
  "barcode": "501234567890",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "forcestock": "integer",
  "foreigntaxrates": {
    "AT": 21,
    "DE": 19
  },
  "itemnum": "I-123456",
  "lastmodified": 872838840,
  "manufacturer": "My Company, Inc.",
  "model": "integer (int32)",
  "name": "My Product",
  "ownergroup": "integer (int32)",
  "purchaseprice": "number (double)",
  "sellingprice": "number (double)",
  "taxrate": "number (double)",
  "type": "integer",
  "unit": "string",
  "visibility": "integer",
  "weight": "number (double)"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
items

Delete item

DELETE /items/{ID}

Permanently delete an existing item by ID. Requires writable inventory permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
items

Get item

GET /items/{ID}

Return the data of an existing item by ID. Requires inventory permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
items

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "applicability": "integer",
  "barcode": "501234567890",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "forcestock": "integer",
  "foreigntaxrates": {
    "AT": 21,
    "DE": 19
  },
  "itemnum": "I-123456",
  "lastmodified": 872838840,
  "manufacturer": "My Company, Inc.",
  "model": "integer (int32)",
  "name": "My Product",
  "ownergroup": "integer (int32)",
  "purchaseprice": "number (double)",
  "sellingprice": "number (double)",
  "taxrate": "number (double)",
  "type": "integer",
  "unit": "string",
  "visibility": "integer",
  "weight": "number (double)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
items

Check if item exists

HEAD /items/{ID}

Check if an item with ID exists, but do not return it's data. Requires inventory permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
items

Update existing item

PATCH /items/{ID}

Update an existing item by ID and return it's persistent data. Requires writable inventory permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
items

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "applicability": "integer",
  "barcode": "501234567890",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "forcestock": "integer",
  "foreigntaxrates": {
    "AT": 21,
    "DE": 19
  },
  "itemnum": "I-123456",
  "lastmodified": 872838840,
  "manufacturer": "My Company, Inc.",
  "model": "integer (int32)",
  "name": "My Product",
  "ownergroup": "integer (int32)",
  "purchaseprice": "number (double)",
  "sellingprice": "number (double)",
  "taxrate": "number (double)",
  "type": "integer",
  "unit": "string",
  "visibility": "integer",
  "weight": "number (double)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

ledgers

ledgers

List ledgers

POST /ledgers

List selected data from all ledgers that match the specified filter and search criteria in a specific sort order. Requires payments permission.

200 OK
ledgers

OK

type
ledgers
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "creationdate": 872838840,
    "creator": 6,
    "description": "string",
    "lastmodified": 872838840,
    "name": "Credit Suisse #12345",
    "ownergroup": "integer (int32)",
    "visibility": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
ledgers

Create new ledger

PUT /ledgers

Create a new ledger and return it's persistent data. Requires writable payments permission.

body
in formData
object

(no description)

201 Created
ledgers

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "Credit Suisse #12345",
  "ownergroup": "integer (int32)",
  "visibility": "integer"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
ledgers

Delete ledger

DELETE /ledgers/{ID}

Permanently delete an existing ledger by ID. Requires writable payments permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
ledgers

Get ledger

GET /ledgers/{ID}

Return the data of an existing ledger by ID. Requires payments permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
ledgers

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "Credit Suisse #12345",
  "ownergroup": "integer (int32)",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
ledgers

Check if ledger exists

HEAD /ledgers/{ID}

Check if a ledger with ID exists, but do not return it's data. Requires payments permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
ledgers

Update existing ledger

PATCH /ledgers/{ID}

Update an existing ledger by ID and return it's persistent data. Requires writable payments permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
ledgers

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "Credit Suisse #12345",
  "ownergroup": "integer (int32)",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

likes

likes

List likes

POST /likes

List selected data from all likes that match the specified filter and search criteria in a specific sort order. Requires no specific permission. Has dependency on record.

200 OK
likes

OK

type
likes
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "creationdate": 872838840,
    "creator": 6,
    "record": 7
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
likes

Create new like

PUT /likes

Create a new like and return it's persistent data. Requires the authenticated user to be the creator. Has dependency on record.

ID
in formData
integer (int64)

Like ID

creator
in formData
integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate
in formData
integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

record
in formData
integer (int64)

Record ID ( dependency)

201 Created
likes

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "record": 7
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
likes

Delete like

DELETE /likes/{ID}

Permanently delete an existing like by ID. Requires the authenticated user to be the creator. Has dependency on record.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
likes

Get like

GET /likes/{ID}

Return the data of an existing like by ID. Requires no specific permission. Has dependency on record.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
likes

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "record": 7
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
likes

Check if like exists

HEAD /likes/{ID}

Check if a like with ID exists, but do not return it's data. Requires no specific permission. Has dependency on record.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
likes

Update existing like

PATCH /likes/{ID}

Update an existing like by ID and return it's persistent data. Requires the authenticated user to be the creator. Has dependency on record.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
likes

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "record": 7
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

links

links

List links

POST /links

List selected data from all links that match the specified filter and search criteria in a specific sort order. Requires links permission.

200 OK
links

OK

type
links
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "assigneduser": 6,
    "creationdate": 872838840,
    "creator": 6,
    "description": "string",
    "lastmodified": 872838840,
    "name": "My Link",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)",
    "password": "**********",
    "url": "https://www.website.com/login",
    "username": "john.doe",
    "visibility": "integer",
    "visits": "integer (int32)"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
links

Create new link

PUT /links

Create a new link and return it's persistent data. Requires writable links permission.

body
in formData
object

(no description)

201 Created
links

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Link",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "password": "**********",
  "url": "https://www.website.com/login",
  "username": "john.doe",
  "visibility": "integer",
  "visits": "integer (int32)"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
links

Delete link

DELETE /links/{ID}

Permanently delete an existing link by ID. Requires writable links permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
links

Get link

GET /links/{ID}

Return the data of an existing link by ID. Requires links permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
links

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Link",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "password": "**********",
  "url": "https://www.website.com/login",
  "username": "john.doe",
  "visibility": "integer",
  "visits": "integer (int32)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
links

Check if link exists

HEAD /links/{ID}

Check if a link with ID exists, but do not return it's data. Requires links permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
links

Update existing link

PATCH /links/{ID}

Update an existing link by ID and return it's persistent data. Requires writable links permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
links

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Link",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "password": "**********",
  "url": "https://www.website.com/login",
  "username": "john.doe",
  "visibility": "integer",
  "visits": "integer (int32)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

mailinglists

mailinglists

List mailing lists

POST /mailinglists

List selected data from all mailing lists that match the specified filter and search criteria in a specific sort order. Requires mailinglists permission.

200 OK
mailinglists

OK

type
mailinglists
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "assigneduser": 6,
    "campaign": "integer (int32)",
    "creationdate": 872838840,
    "creator": 6,
    "description": "string",
    "lastmodified": 872838840,
    "name": "My Mailing List",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)",
    "sender": "John Doe <john.doe@company.com>",
    "visibility": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
mailinglists

Create new mailing list

PUT /mailinglists

Create a new mailing list and return it's persistent data. Requires writable mailinglists permission.

body
in formData
object

(no description)

201 Created
mailinglists

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "assigneduser": 6,
  "campaign": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Mailing List",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "sender": "John Doe <john.doe@company.com>",
  "visibility": "integer"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
mailinglists

Delete mailing list

DELETE /mailinglists/{ID}

Permanently delete an existing mailing list by ID. Requires writable mailinglists permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
mailinglists

Get mailing list

GET /mailinglists/{ID}

Return the data of an existing mailing list by ID. Requires mailinglists permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
mailinglists

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "assigneduser": 6,
  "campaign": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Mailing List",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "sender": "John Doe <john.doe@company.com>",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
mailinglists

Check if mailing list exists

HEAD /mailinglists/{ID}

Check if a mailing list with ID exists, but do not return it's data. Requires mailinglists permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
mailinglists

Update existing mailing list

PATCH /mailinglists/{ID}

Update an existing mailing list by ID and return it's persistent data. Requires writable mailinglists permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
mailinglists

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "assigneduser": 6,
  "campaign": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Mailing List",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "sender": "John Doe <john.doe@company.com>",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

mailservers

mailservers

List mail servers

POST /mailservers

List selected data from all mail servers that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

200 OK
mailservers

OK

type
mailservers
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "activity": "integer",
    "creationdate": 872838840,
    "creator": 6,
    "description": "string",
    "lastmodified": 872838840,
    "name": "My Mail Server",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)",
    "recipientgroup": "integer (int32)",
    "recipientuser": "integer (int32)",
    "sender": "John Doe <john.doe@company.com>",
    "serverin": "imap.company.com:143/tls",
    "serverout": "smtp.company.com:587/tls",
    "usernamein": "john.doe",
    "usernameout": "john.doe"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
mailservers

Create new mail server

PUT /mailservers

Create a new mail server and return it's persistent data. Requires no specific permission.

body
in formData
object

(no description)

201 Created
mailservers

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "activity": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Mail Server",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recipientgroup": "integer (int32)",
  "recipientuser": "integer (int32)",
  "sender": "John Doe <john.doe@company.com>",
  "serverin": "imap.company.com:143/tls",
  "serverout": "smtp.company.com:587/tls",
  "usernamein": "john.doe",
  "usernameout": "john.doe"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
mailservers

Delete mail server

DELETE /mailservers/{ID}

Permanently delete an existing mail server by ID. Requires no specific permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
mailservers

Get mail server

GET /mailservers/{ID}

Return the data of an existing mail server by ID. Requires no specific permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
mailservers

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "activity": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Mail Server",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recipientgroup": "integer (int32)",
  "recipientuser": "integer (int32)",
  "sender": "John Doe <john.doe@company.com>",
  "serverin": "imap.company.com:143/tls",
  "serverout": "smtp.company.com:587/tls",
  "usernamein": "john.doe",
  "usernameout": "john.doe"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
mailservers

Check if mail server exists

HEAD /mailservers/{ID}

Check if a mail server with ID exists, but do not return it's data. Requires no specific permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
mailservers

Update existing mail server

PATCH /mailservers/{ID}

Update an existing mail server by ID and return it's persistent data. Requires no specific permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
mailservers

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "activity": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Mail Server",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recipientgroup": "integer (int32)",
  "recipientuser": "integer (int32)",
  "sender": "John Doe <john.doe@company.com>",
  "serverin": "imap.company.com:143/tls",
  "serverout": "smtp.company.com:587/tls",
  "usernamein": "john.doe",
  "usernameout": "john.doe"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

messages

messages

List messages

POST /messages

List selected data from all messages that match the specified filter and search criteria in a specific sort order. Requires messages permission.

200 OK
messages

OK

type
messages
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "attachments": [
      "string"
    ],
    "bcc": "John Doe <john.doe@company.com>, Johnny <johnny_d@personal.com>",
    "cc": "John Doe <john.doe@company.com>, Johnny <johnny_d@personal.com>",
    "contenttype": "text/plain",
    "creationdate": 872838840,
    "creator": 6,
    "date": 872838840,
    "lastmodified": 872838840,
    "mailbox": "integer",
    "mailinglist": "integer (int32)",
    "mailserver": 7,
    "opportunity": "integer (int32)",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)",
    "reference": "integer (int32)",
    "senddate": "integer (int64)",
    "sender": "John Doe <john.doe@company.com>",
    "sender_email": "john.doe@company.com",
    "sender_name": "John Doe",
    "senderror": "I am afraid I can't do that Dave!",
    "size": 12,
    "subject": "Re: Hello World!",
    "text": "Hello World!",
    "ticket": "integer (int32)",
    "to": "John Doe <john.doe@company.com>, Johnny <johnny_d@personal.com>",
    "to_count": 2,
    "to_email": "john.doe@company.com",
    "to_name": "John Doe",
    "verified": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
messages

Create new message

PUT /messages

Create a new message and return it's persistent data. Requires writable messages permission.

body
in formData
object

(no description)

201 Created
messages

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "attachments": [
    "string"
  ],
  "bcc": "John Doe <john.doe@company.com>, Johnny <johnny_d@personal.com>",
  "cc": "John Doe <john.doe@company.com>, Johnny <johnny_d@personal.com>",
  "contenttype": "text/plain",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "lastmodified": 872838840,
  "mailbox": "integer",
  "mailinglist": "integer (int32)",
  "mailserver": 7,
  "opportunity": "integer (int32)",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "reference": "integer (int32)",
  "senddate": "integer (int64)",
  "sender": "John Doe <john.doe@company.com>",
  "sender_email": "john.doe@company.com",
  "sender_name": "John Doe",
  "senderror": "I am afraid I can't do that Dave!",
  "size": 12,
  "subject": "Re: Hello World!",
  "text": "Hello World!",
  "ticket": "integer (int32)",
  "to": "John Doe <john.doe@company.com>, Johnny <johnny_d@personal.com>",
  "to_count": 2,
  "to_email": "john.doe@company.com",
  "to_name": "John Doe",
  "verified": "integer"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
messages

Delete message

DELETE /messages/{ID}

Permanently delete an existing message by ID. Requires writable messages permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
messages

Get message

GET /messages/{ID}

Return the data of an existing message by ID. Requires messages permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
messages

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "attachments": [
    "string"
  ],
  "bcc": "John Doe <john.doe@company.com>, Johnny <johnny_d@personal.com>",
  "cc": "John Doe <john.doe@company.com>, Johnny <johnny_d@personal.com>",
  "contenttype": "text/plain",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "lastmodified": 872838840,
  "mailbox": "integer",
  "mailinglist": "integer (int32)",
  "mailserver": 7,
  "opportunity": "integer (int32)",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "reference": "integer (int32)",
  "senddate": "integer (int64)",
  "sender": "John Doe <john.doe@company.com>",
  "sender_email": "john.doe@company.com",
  "sender_name": "John Doe",
  "senderror": "I am afraid I can't do that Dave!",
  "size": 12,
  "subject": "Re: Hello World!",
  "text": "Hello World!",
  "ticket": "integer (int32)",
  "to": "John Doe <john.doe@company.com>, Johnny <johnny_d@personal.com>",
  "to_count": 2,
  "to_email": "john.doe@company.com",
  "to_name": "John Doe",
  "verified": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
messages

Check if message exists

HEAD /messages/{ID}

Check if a message with ID exists, but do not return it's data. Requires messages permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
messages

Update existing message

PATCH /messages/{ID}

Update an existing message by ID and return it's persistent data. Requires writable messages permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
messages

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "attachments": [
    "string"
  ],
  "bcc": "John Doe <john.doe@company.com>, Johnny <johnny_d@personal.com>",
  "cc": "John Doe <john.doe@company.com>, Johnny <johnny_d@personal.com>",
  "contenttype": "text/plain",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "lastmodified": 872838840,
  "mailbox": "integer",
  "mailinglist": "integer (int32)",
  "mailserver": 7,
  "opportunity": "integer (int32)",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "reference": "integer (int32)",
  "senddate": "integer (int64)",
  "sender": "John Doe <john.doe@company.com>",
  "sender_email": "john.doe@company.com",
  "sender_name": "John Doe",
  "senderror": "I am afraid I can't do that Dave!",
  "size": 12,
  "subject": "Re: Hello World!",
  "text": "Hello World!",
  "ticket": "integer (int32)",
  "to": "John Doe <john.doe@company.com>, Johnny <johnny_d@personal.com>",
  "to_count": 2,
  "to_email": "john.doe@company.com",
  "to_name": "John Doe",
  "verified": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

messagereads

messagereads

List message-reads

POST /messagereads

List selected data from all message-reads that match the specified filter and search criteria in a specific sort order. Requires messages permission. Has dependency on message.

200 OK
messagereads

OK

type
messagereads
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "creationdate": 872838840,
    "creator": 6,
    "message": 7
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
messagereads

Create new message-read

PUT /messagereads

Create a new message-read and return it's persistent data. Requires writable messages and the authenticated user to be the creator permission. Has dependency on message.

ID
in formData
integer (int64)

Message-read ID

creator
in formData
integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate
in formData
integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

message
in formData
integer (int32)

Message ID ( dependency)

201 Created
messagereads

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "message": 7
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
messagereads

Delete message-read

DELETE /messagereads/{ID}

Permanently delete an existing message-read by ID. Requires writable messages and the authenticated user to be the creator permission. Has dependency on message.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
messagereads

Get message-read

GET /messagereads/{ID}

Return the data of an existing message-read by ID. Requires messages permission. Has dependency on message.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
messagereads

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "message": 7
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
messagereads

Check if message-read exists

HEAD /messagereads/{ID}

Check if a message-read with ID exists, but do not return it's data. Requires messages permission. Has dependency on message.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
messagereads

Update existing message-read

PATCH /messagereads/{ID}

Update an existing message-read by ID and return it's persistent data. Requires writable messages and the authenticated user to be the creator permission. Has dependency on message.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
messagereads

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "message": 7
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

notes

notes

List notes

POST /notes

List selected data from all notes that match the specified filter and search criteria in a specific sort order. Requires notes permission.

200 OK
notes

OK

type
notes
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "assigneduser": 6,
    "attachments": [
      "string"
    ],
    "contenttype": "text/plain",
    "creationdate": 872838840,
    "creator": 6,
    "description": "string",
    "lastmodified": 872838840,
    "name": "My Note",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)",
    "size": 12,
    "text": "Hello World!",
    "visibility": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
notes

Create new note

PUT /notes

Create a new note and return it's persistent data. Requires writable notes permission.

body
in formData
object

(no description)

201 Created
notes

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "assigneduser": 6,
  "attachments": [
    "string"
  ],
  "contenttype": "text/plain",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Note",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "size": 12,
  "text": "Hello World!",
  "visibility": "integer"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
notes

Delete note

DELETE /notes/{ID}

Permanently delete an existing note by ID. Requires writable notes permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
notes

Get note

GET /notes/{ID}

Return the data of an existing note by ID. Requires notes permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
notes

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "assigneduser": 6,
  "attachments": [
    "string"
  ],
  "contenttype": "text/plain",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Note",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "size": 12,
  "text": "Hello World!",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
notes

Check if note exists

HEAD /notes/{ID}

Check if a note with ID exists, but do not return it's data. Requires notes permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
notes

Update existing note

PATCH /notes/{ID}

Update an existing note by ID and return it's persistent data. Requires writable notes permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
notes

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "assigneduser": 6,
  "attachments": [
    "string"
  ],
  "contenttype": "text/plain",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Note",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "size": 12,
  "text": "Hello World!",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

objects

objects

List custom objects

POST /objects

List selected data from all custom objects that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

200 OK
objects

OK

type
objects
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "assigneduser": 6,
    "creationdate": 872838840,
    "creator": 6,
    "description": "string",
    "entity": "my_custom_entity",
    "lastmodified": 872838840,
    "name": "My Object",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)",
    "visibility": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
objects

Create new custom object

PUT /objects

Create a new custom object and return it's persistent data. Requires no specific permission.

body
in formData
object

(no description)

201 Created
objects

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "entity": "my_custom_entity",
  "lastmodified": 872838840,
  "name": "My Object",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "visibility": "integer"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
objects

Delete custom object

DELETE /objects/{ID}

Permanently delete an existing custom object by ID. Requires no specific permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
objects

Get custom object

GET /objects/{ID}

Return the data of an existing custom object by ID. Requires no specific permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
objects

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "entity": "my_custom_entity",
  "lastmodified": 872838840,
  "name": "My Object",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
objects

Check if custom object exists

HEAD /objects/{ID}

Check if a custom object with ID exists, but do not return it's data. Requires no specific permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
objects

Update existing custom object

PATCH /objects/{ID}

Update an existing custom object by ID and return it's persistent data. Requires no specific permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
objects

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "entity": "my_custom_entity",
  "lastmodified": 872838840,
  "name": "My Object",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

opportunities

opportunities

List opportunities

POST /opportunities

List selected data from all opportunities that match the specified filter and search criteria in a specific sort order. Requires opportunities permission.

200 OK
opportunities

OK

type
opportunities
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "account": 7,
    "assigneduser": 6,
    "campaign": "integer (int32)",
    "contact": "integer (int32)",
    "creationdate": 872838840,
    "creator": 6,
    "description": "string",
    "duedate": "integer (int64)",
    "lastmodified": 872838840,
    "mostlikely": "number (double)",
    "name": "My Opportunity",
    "opportunitynum": "O-123456",
    "ownergroup": "integer (int32)",
    "priority": "integer",
    "probability": "integer",
    "status": "integer",
    "upside": "number (double)",
    "visibility": "integer",
    "worstcase": "number (double)"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
opportunities

Create new opportunity

PUT /opportunities

Create a new opportunity and return it's persistent data. Requires writable opportunities permission.

body
in formData
object

(no description)

201 Created
opportunities

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "campaign": "integer (int32)",
  "contact": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "duedate": "integer (int64)",
  "lastmodified": 872838840,
  "mostlikely": "number (double)",
  "name": "My Opportunity",
  "opportunitynum": "O-123456",
  "ownergroup": "integer (int32)",
  "priority": "integer",
  "probability": "integer",
  "status": "integer",
  "upside": "number (double)",
  "visibility": "integer",
  "worstcase": "number (double)"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
opportunities

Delete opportunity

DELETE /opportunities/{ID}

Permanently delete an existing opportunity by ID. Requires writable opportunities permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
opportunities

Get opportunity

GET /opportunities/{ID}

Return the data of an existing opportunity by ID. Requires opportunities permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
opportunities

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "campaign": "integer (int32)",
  "contact": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "duedate": "integer (int64)",
  "lastmodified": 872838840,
  "mostlikely": "number (double)",
  "name": "My Opportunity",
  "opportunitynum": "O-123456",
  "ownergroup": "integer (int32)",
  "priority": "integer",
  "probability": "integer",
  "status": "integer",
  "upside": "number (double)",
  "visibility": "integer",
  "worstcase": "number (double)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
opportunities

Check if opportunity exists

HEAD /opportunities/{ID}

Check if an opportunity with ID exists, but do not return it's data. Requires opportunities permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
opportunities

Update existing opportunity

PATCH /opportunities/{ID}

Update an existing opportunity by ID and return it's persistent data. Requires writable opportunities permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
opportunities

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "campaign": "integer (int32)",
  "contact": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "duedate": "integer (int64)",
  "lastmodified": 872838840,
  "mostlikely": "number (double)",
  "name": "My Opportunity",
  "opportunitynum": "O-123456",
  "ownergroup": "integer (int32)",
  "priority": "integer",
  "probability": "integer",
  "status": "integer",
  "upside": "number (double)",
  "visibility": "integer",
  "worstcase": "number (double)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

participants

participants

List participants

POST /participants

List selected data from all participants that match the specified filter and search criteria in a specific sort order. Requires mailinglists or campaigns permission. Has dependency on mailinglist or campaign.

200 OK
participants

OK

type
participants
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "campaign": "integer (int32)",
    "contact": "integer (int32)",
    "creationdate": 872838840,
    "creator": 6,
    "email": "john.doe@company.com",
    "lastmodified": 872838840,
    "mailinglist": 7,
    "name": "John Doe",
    "phone": "+1 123-456-7890"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
participants

Create new participant

PUT /participants

Create a new participant and return it's persistent data. Requires writable mailinglists or campaigns permission. Has dependency on mailinglist or campaign.

body
in formData
object

(no description)

201 Created
participants

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "campaign": "integer (int32)",
  "contact": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "email": "john.doe@company.com",
  "lastmodified": 872838840,
  "mailinglist": 7,
  "name": "John Doe",
  "phone": "+1 123-456-7890"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
participants

Delete participant

DELETE /participants/{ID}

Permanently delete an existing participant by ID. Requires writable mailinglists or campaigns permission. Has dependency on mailinglist or campaign.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
participants

Get participant

GET /participants/{ID}

Return the data of an existing participant by ID. Requires mailinglists or campaigns permission. Has dependency on mailinglist or campaign.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
participants

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "campaign": "integer (int32)",
  "contact": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "email": "john.doe@company.com",
  "lastmodified": 872838840,
  "mailinglist": 7,
  "name": "John Doe",
  "phone": "+1 123-456-7890"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
participants

Check if participant exists

HEAD /participants/{ID}

Check if a participant with ID exists, but do not return it's data. Requires mailinglists or campaigns permission. Has dependency on mailinglist or campaign.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
participants

Update existing participant

PATCH /participants/{ID}

Update an existing participant by ID and return it's persistent data. Requires writable mailinglists or campaigns permission. Has dependency on mailinglist or campaign.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
participants

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "campaign": "integer (int32)",
  "contact": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "email": "john.doe@company.com",
  "lastmodified": 872838840,
  "mailinglist": 7,
  "name": "John Doe",
  "phone": "+1 123-456-7890"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

payments

payments

List payments

POST /payments

List selected data from all payments that match the specified filter and search criteria in a specific sort order. Requires billing, procurement or payments permission.

200 OK
payments

OK

type
payments
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "account": "integer (int32)",
    "amount": 199.99,
    "assigneduser": 6,
    "autoadvance": "integer",
    "creationdate": 872838840,
    "creator": 6,
    "date": 872838840,
    "description": "string",
    "lastmodified": 872838840,
    "ledger": "integer (int32)",
    "ownergroup": "integer (int32)",
    "status": "integer",
    "subject": "Ref. P12345X67890",
    "transaction": 7
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
payments

Create new payment

PUT /payments

Create a new payment and return it's persistent data. Requires writable billing, procurement or payments permission.

body
in formData
object

(no description)

201 Created
payments

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "account": "integer (int32)",
  "amount": 199.99,
  "assigneduser": 6,
  "autoadvance": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "description": "string",
  "lastmodified": 872838840,
  "ledger": "integer (int32)",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "subject": "Ref. P12345X67890",
  "transaction": 7
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
payments

Delete payment

DELETE /payments/{ID}

Permanently delete an existing payment by ID. Requires writable billing, procurement or payments permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
payments

Get payment

GET /payments/{ID}

Return the data of an existing payment by ID. Requires billing, procurement or payments permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
payments

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": "integer (int32)",
  "amount": 199.99,
  "assigneduser": 6,
  "autoadvance": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "description": "string",
  "lastmodified": 872838840,
  "ledger": "integer (int32)",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "subject": "Ref. P12345X67890",
  "transaction": 7
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
payments

Check if payment exists

HEAD /payments/{ID}

Check if a payment with ID exists, but do not return it's data. Requires billing, procurement or payments permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
payments

Update existing payment

PATCH /payments/{ID}

Update an existing payment by ID and return it's persistent data. Requires writable billing, procurement or payments permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
payments

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": "integer (int32)",
  "amount": 199.99,
  "assigneduser": 6,
  "autoadvance": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "description": "string",
  "lastmodified": 872838840,
  "ledger": "integer (int32)",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "subject": "Ref. P12345X67890",
  "transaction": 7
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

permissions

permissions

List permissions

POST /permissions

List selected data from all permissions that match the specified filter and search criteria in a specific sort order. Requires admin permission.

200 OK
permissions

OK

type
permissions
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "creationdate": 872838840,
    "creator": 6,
    "group": 7,
    "identifier": "my_permission",
    "lastmodified": 872838840,
    "writable": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
permissions

Get permission

GET /permissions/{ID}

Return the data of an existing permission by ID. Requires admin permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
permissions

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "group": 7,
  "identifier": "my_permission",
  "lastmodified": 872838840,
  "writable": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
permissions

Check if permission exists

HEAD /permissions/{ID}

Check if a permission with ID exists, but do not return it's data. Requires admin permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

pricelists

pricelists

List price lists

POST /pricelists

List selected data from all price lists that match the specified filter and search criteria in a specific sort order. Requires pricelists permission.

200 OK
pricelists

OK

type
pricelists
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "activity": "integer",
    "applytoall": "integer",
    "creationdate": 872838840,
    "creator": 6,
    "currency": "EUR",
    "datefrom": "integer (int64)",
    "dateto": "integer (int64)",
    "description": "string",
    "discount": "number (double)",
    "lastmodified": 872838840,
    "name": "My Price List",
    "ownergroup": "integer (int32)",
    "type": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
pricelists

Create new price list

PUT /pricelists

Create a new price list and return it's persistent data. Requires writable pricelists permission.

body
in formData
object

(no description)

201 Created
pricelists

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "activity": "integer",
  "applytoall": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "description": "string",
  "discount": "number (double)",
  "lastmodified": 872838840,
  "name": "My Price List",
  "ownergroup": "integer (int32)",
  "type": "integer"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
pricelists

Delete price list

DELETE /pricelists/{ID}

Permanently delete an existing price list by ID. Requires writable pricelists permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
pricelists

Get price list

GET /pricelists/{ID}

Return the data of an existing price list by ID. Requires pricelists permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
pricelists

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "activity": "integer",
  "applytoall": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "description": "string",
  "discount": "number (double)",
  "lastmodified": 872838840,
  "name": "My Price List",
  "ownergroup": "integer (int32)",
  "type": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
pricelists

Check if price list exists

HEAD /pricelists/{ID}

Check if a price list with ID exists, but do not return it's data. Requires pricelists permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
pricelists

Update existing price list

PATCH /pricelists/{ID}

Update an existing price list by ID and return it's persistent data. Requires writable pricelists permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
pricelists

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "activity": "integer",
  "applytoall": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "description": "string",
  "discount": "number (double)",
  "lastmodified": 872838840,
  "name": "My Price List",
  "ownergroup": "integer (int32)",
  "type": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

pricelists2accounts

pricelists2accounts

List pricelists-to-accounts

POST /pricelists2accounts

List selected data from all pricelists-to-accounts that match the specified filter and search criteria in a specific sort order. Requires pricelists or accounts permission. Has dependencies on pricelist and account.

200 OK
pricelists2accounts

OK

type
pricelists2accounts
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "account": 13,
    "creationdate": 872838840,
    "creator": 6,
    "pricelist": 7
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
pricelists2accounts

Create new price

PUT /pricelists2accounts

Create a new price and return it's persistent data. Requires writable pricelists or accounts permission. Has dependencies on pricelist and account.

ID
in formData
integer (int64)

Pricelist-to-account ID

creator
in formData
integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate
in formData
integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

pricelist
in formData
integer (int32)

Price list ID ( dependency)

account
in formData
integer (int32)

Account ID ( dependency)

201 Created
pricelists2accounts

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "account": 13,
  "creationdate": 872838840,
  "creator": 6,
  "pricelist": 7
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
pricelists2accounts

Delete price

DELETE /pricelists2accounts/{ID}

Permanently delete an existing price by ID. Requires writable pricelists or accounts permission. Has dependencies on pricelist and account.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
pricelists2accounts

Get price

GET /pricelists2accounts/{ID}

Return the data of an existing price by ID. Requires pricelists or accounts permission. Has dependencies on pricelist and account.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
pricelists2accounts

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": 13,
  "creationdate": 872838840,
  "creator": 6,
  "pricelist": 7
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
pricelists2accounts

Check if price exists

HEAD /pricelists2accounts/{ID}

Check if a price with ID exists, but do not return it's data. Requires pricelists or accounts permission. Has dependencies on pricelist and account.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
pricelists2accounts

Update existing price

PATCH /pricelists2accounts/{ID}

Update an existing price by ID and return it's persistent data. Requires writable pricelists or accounts permission. Has dependencies on pricelist and account.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
pricelists2accounts

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": 13,
  "creationdate": 872838840,
  "creator": 6,
  "pricelist": 7
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

prices

prices

List prices

POST /prices

List selected data from all prices that match the specified filter and search criteria in a specific sort order. Requires inventory or pricelists permission. Has dependencies on items and pricelist.

200 OK
prices

OK

type
prices
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "creationdate": 872838840,
    "creator": 6,
    "discount": "number (double)",
    "item": 7,
    "lastmodified": 872838840,
    "minamount": "number (double)",
    "price": "number (double)",
    "pricelist": 13,
    "rebate": "number (double)"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
prices

Create new price

PUT /prices

Create a new price and return it's persistent data. Requires writable inventory or pricelists permission. Has dependencies on items and pricelist.

ID
in formData
integer (int64)

Price ID

creator
in formData
integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate
in formData
integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

lastmodified
in formData
integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

item
in formData
integer (int32)

Item ID ( dependency)

pricelist
in formData
integer (int32)

Price list ID ( dependency)

price
in formData
number (double) x ≥ 0

Price per unit (null=item.sellingprice for billing or null=item.purchaseprice for procurement)

rebate
in formData
number (double) x ≥ 0

Absolute rebate per unit (applied before discount)

discount
in formData
number (double) -100 ≤ x ≤ 100

Relative discount in percent (applied after rebate; null=pricelist.discount)

minamount
in formData
number (double) x ≥ 0 0

Minimum amount (quantity)

201 Created
prices

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "discount": "number (double)",
  "item": 7,
  "lastmodified": 872838840,
  "minamount": "number (double)",
  "price": "number (double)",
  "pricelist": 13,
  "rebate": "number (double)"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
prices

Delete price

DELETE /prices/{ID}

Permanently delete an existing price by ID. Requires writable inventory or pricelists permission. Has dependencies on items and pricelist.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
prices

Get price

GET /prices/{ID}

Return the data of an existing price by ID. Requires inventory or pricelists permission. Has dependencies on items and pricelist.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
prices

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "discount": "number (double)",
  "item": 7,
  "lastmodified": 872838840,
  "minamount": "number (double)",
  "price": "number (double)",
  "pricelist": 13,
  "rebate": "number (double)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
prices

Check if price exists

HEAD /prices/{ID}

Check if a price with ID exists, but do not return it's data. Requires inventory or pricelists permission. Has dependencies on items and pricelist.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
prices

Update existing price

PATCH /prices/{ID}

Update an existing price by ID and return it's persistent data. Requires writable inventory or pricelists permission. Has dependencies on items and pricelist.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
prices

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "discount": "number (double)",
  "item": 7,
  "lastmodified": 872838840,
  "minamount": "number (double)",
  "price": "number (double)",
  "pricelist": 13,
  "rebate": "number (double)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

projects

projects

List projects

POST /projects

List selected data from all projects that match the specified filter and search criteria in a specific sort order. Requires projects permission.

200 OK
projects

OK

type
projects
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "account": 7,
    "assigneduser": 6,
    "creationdate": 872838840,
    "creator": 6,
    "description": "string",
    "lastmodified": 872838840,
    "name": "My Project",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)",
    "projectnum": "P-123456",
    "status": "integer",
    "visibility": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
projects

Create new project

PUT /projects

Create a new project and return it's persistent data. Requires writable projects permission.

body
in formData
object

(no description)

201 Created
projects

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Project",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "projectnum": "P-123456",
  "status": "integer",
  "visibility": "integer"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
projects

Delete project

DELETE /projects/{ID}

Permanently delete an existing project by ID. Requires writable projects permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
projects

Get project

GET /projects/{ID}

Return the data of an existing project by ID. Requires projects permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
projects

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Project",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "projectnum": "P-123456",
  "status": "integer",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
projects

Check if project exists

HEAD /projects/{ID}

Check if a project with ID exists, but do not return it's data. Requires projects permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
projects

Update existing project

PATCH /projects/{ID}

Update an existing project by ID and return it's persistent data. Requires writable projects permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
projects

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Project",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "projectnum": "P-123456",
  "status": "integer",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

records

records

List records

POST /records

List selected data from all records that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

200 OK
records

OK

type
records
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "assigneduser": "integer (int32)",
    "creationdate": 872838840,
    "creator": 6,
    "date": 872838840,
    "entity": "string",
    "flag": "integer",
    "index": "integer (int32)",
    "lastmodified": 872838840,
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)",
    "sender": "John Doe",
    "text": "This is my record!"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
records

Create new record

PUT /records

Create a new record and return it's persistent data. Requires the authenticated user to be the creator.

body
in formData
object

(no description)

201 Created
records

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "assigneduser": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "entity": "string",
  "flag": "integer",
  "index": "integer (int32)",
  "lastmodified": 872838840,
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "sender": "John Doe",
  "text": "This is my record!"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
records

Delete record

DELETE /records/{ID}

Permanently delete an existing record by ID. Requires the authenticated user to be the creator.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
records

Get record

GET /records/{ID}

Return the data of an existing record by ID. Requires no specific permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
records

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "assigneduser": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "entity": "string",
  "flag": "integer",
  "index": "integer (int32)",
  "lastmodified": 872838840,
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "sender": "John Doe",
  "text": "This is my record!"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
records

Check if record exists

HEAD /records/{ID}

Check if a record with ID exists, but do not return it's data. Requires no specific permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
records

Update existing record

PATCH /records/{ID}

Update an existing record by ID and return it's persistent data. Requires the authenticated user to be the creator.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
records

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "assigneduser": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "entity": "string",
  "flag": "integer",
  "index": "integer (int32)",
  "lastmodified": 872838840,
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "sender": "John Doe",
  "text": "This is my record!"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

resources

resources

List resources

POST /resources

List selected data from all resources that match the specified filter and search criteria in a specific sort order. Requires dev permission.

200 OK
resources

OK

type
resources
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "activity": "integer",
    "application": 7,
    "creationdate": 872838840,
    "creator": 6,
    "identifier": "my_resource",
    "lastmodified": 872838840,
    "mimetype": "string",
    "name": "My Resource",
    "public": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
resources

Get resource

GET /resources/{ID}

Return the data of an existing resource by ID. Requires dev permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
resources

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "activity": "integer",
  "application": 7,
  "creationdate": 872838840,
  "creator": 6,
  "identifier": "my_resource",
  "lastmodified": 872838840,
  "mimetype": "string",
  "name": "My Resource",
  "public": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
resources

Check if resource exists

HEAD /resources/{ID}

Check if an resource with ID exists, but do not return it's data. Requires dev permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

services

services

List services

POST /services

List selected data from all services that match the specified filter and search criteria in a specific sort order. Requires dev permission.

200 OK
services

OK

type
services
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "activity": "integer",
    "application": 7,
    "creationdate": 872838840,
    "creator": 6,
    "entity": "notes",
    "identifier": "my_service",
    "interval": "integer",
    "lastmodified": 872838840,
    "mimetype": "string",
    "name": "My Service",
    "schedule": "integer (int32)",
    "type": 5
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
services

Get service

GET /services/{ID}

Return the data of an existing service by ID. Requires dev permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
services

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "activity": "integer",
  "application": 7,
  "creationdate": 872838840,
  "creator": 6,
  "entity": "notes",
  "identifier": "my_service",
  "interval": "integer",
  "lastmodified": 872838840,
  "mimetype": "string",
  "name": "My Service",
  "schedule": "integer (int32)",
  "type": 5
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
services

Check if service exists

HEAD /services/{ID}

Check if an service with ID exists, but do not return it's data. Requires dev permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

stocktransactions

stocktransactions

List stock transactions

POST /stocktransactions

List selected data from all stock transactions that match the specified filter and search criteria in a specific sort order. Requires inventory permission. Has dependency on item.

200 OK
stocktransactions

OK

type
stocktransactions
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "amount": "number (double)",
    "chargenum": "LOT-123456",
    "creationdate": 872838840,
    "creator": 6,
    "date": 872838840,
    "flag": "integer",
    "item": 7,
    "lastmodified": 872838840,
    "location": "B1-R2-S3",
    "purchaseprice": "number (double)",
    "reference": "SHIP-17/01-123456",
    "sellingprice": "number (double)",
    "serials": [
      "string"
    ],
    "storage": "integer (int32)",
    "subtransactions": [
      "integer (int64)"
    ],
    "transaction": "integer (int32)",
    "transfer": "integer (int64)"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
stocktransactions

Create new stock transaction

PUT /stocktransactions

Create a new stock transaction and return it's persistent data. Requires writable inventory permission. Has dependency on item.

body
in formData
object

(no description)

201 Created
stocktransactions

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "amount": "number (double)",
  "chargenum": "LOT-123456",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "flag": "integer",
  "item": 7,
  "lastmodified": 872838840,
  "location": "B1-R2-S3",
  "purchaseprice": "number (double)",
  "reference": "SHIP-17/01-123456",
  "sellingprice": "number (double)",
  "serials": [
    "string"
  ],
  "storage": "integer (int32)",
  "subtransactions": [
    "integer (int64)"
  ],
  "transaction": "integer (int32)",
  "transfer": "integer (int64)"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
stocktransactions

Delete stock transaction

DELETE /stocktransactions/{ID}

Permanently delete an existing stock transaction by ID. Requires writable inventory permission. Has dependency on item.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
stocktransactions

Get stock transaction

GET /stocktransactions/{ID}

Return the data of an existing stock transaction by ID. Requires inventory permission. Has dependency on item.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
stocktransactions

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "amount": "number (double)",
  "chargenum": "LOT-123456",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "flag": "integer",
  "item": 7,
  "lastmodified": 872838840,
  "location": "B1-R2-S3",
  "purchaseprice": "number (double)",
  "reference": "SHIP-17/01-123456",
  "sellingprice": "number (double)",
  "serials": [
    "string"
  ],
  "storage": "integer (int32)",
  "subtransactions": [
    "integer (int64)"
  ],
  "transaction": "integer (int32)",
  "transfer": "integer (int64)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
stocktransactions

Check if stock transaction exists

HEAD /stocktransactions/{ID}

Check if a stock transaction with ID exists, but do not return it's data. Requires inventory permission. Has dependency on item.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
stocktransactions

Update existing stock transaction

PATCH /stocktransactions/{ID}

Update an existing stock transaction by ID and return it's persistent data. Requires writable inventory permission. Has dependency on item.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
stocktransactions

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "amount": "number (double)",
  "chargenum": "LOT-123456",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "flag": "integer",
  "item": 7,
  "lastmodified": 872838840,
  "location": "B1-R2-S3",
  "purchaseprice": "number (double)",
  "reference": "SHIP-17/01-123456",
  "sellingprice": "number (double)",
  "serials": [
    "string"
  ],
  "storage": "integer (int32)",
  "subtransactions": [
    "integer (int64)"
  ],
  "transaction": "integer (int32)",
  "transfer": "integer (int64)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

storages

storages

List storages

POST /storages

List selected data from all storages that match the specified filter and search criteria in a specific sort order. Requires inventory permission.

200 OK
storages

OK

type
storages
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "creationdate": 872838840,
    "creator": 6,
    "description": "string",
    "lastmodified": 872838840,
    "name": "My Storage",
    "ownergroup": "integer (int32)",
    "visibility": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
storages

Create new storage

PUT /storages

Create a new storage and return it's persistent data. Requires writable inventory permission.

body
in formData
object

(no description)

201 Created
storages

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Storage",
  "ownergroup": "integer (int32)",
  "visibility": "integer"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
storages

Delete storage

DELETE /storages/{ID}

Permanently delete an existing storage by ID. Requires writable inventory permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
storages

Get storage

GET /storages/{ID}

Return the data of an existing storage by ID. Requires inventory permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
storages

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Storage",
  "ownergroup": "integer (int32)",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
storages

Check if storage exists

HEAD /storages/{ID}

Check if a storage with ID exists, but do not return it's data. Requires inventory permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
storages

Update existing storage

PATCH /storages/{ID}

Update an existing storage by ID and return it's persistent data. Requires writable inventory permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
storages

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Storage",
  "ownergroup": "integer (int32)",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

suppliers

suppliers

List suppliers

POST /suppliers

List selected data from all suppliers that match the specified filter and search criteria in a specific sort order. Requires inventory or accounts permission. Has dependencies on items and account.

200 OK
suppliers

OK

type
suppliers
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "account": 13,
    "creationdate": 872838840,
    "creator": 6,
    "deliverytime": "integer",
    "item": 7,
    "itemnum": "EXTERNAL-123456",
    "lastmodified": 872838840,
    "minamount": "number (double)",
    "price": "number (double)",
    "stock": 100
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
suppliers

Create new supplier

PUT /suppliers

Create a new supplier and return it's persistent data. Requires writable inventory or accounts permission. Has dependencies on items and account.

ID
in formData
integer (int64)

Supplier ID

creator
in formData
integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate
in formData
integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

lastmodified
in formData
integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

item
in formData
integer (int32)

Item ID ( dependency)

account
in formData
integer (int32)

Account ID ( dependency)

itemnum
in formData
string

Supplier item number (SKU)

price
in formData
number (double) x ≥ 0

Supplier price per unit

minamount
in formData
number (double) x ≥ 0 0

Minimum order amount (quantity)

deliverytime
in formData
integer 0 ≤ x ≤ 32767

Expected delivery time in days

stock
in formData
number (double)

Expected stock/inventory amount (quantity)

201 Created
suppliers

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "account": 13,
  "creationdate": 872838840,
  "creator": 6,
  "deliverytime": "integer",
  "item": 7,
  "itemnum": "EXTERNAL-123456",
  "lastmodified": 872838840,
  "minamount": "number (double)",
  "price": "number (double)",
  "stock": 100
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
suppliers

Delete supplier

DELETE /suppliers/{ID}

Permanently delete an existing supplier by ID. Requires writable inventory or accounts permission. Has dependencies on items and account.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
suppliers

Get supplier

GET /suppliers/{ID}

Return the data of an existing supplier by ID. Requires inventory or accounts permission. Has dependencies on items and account.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
suppliers

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": 13,
  "creationdate": 872838840,
  "creator": 6,
  "deliverytime": "integer",
  "item": 7,
  "itemnum": "EXTERNAL-123456",
  "lastmodified": 872838840,
  "minamount": "number (double)",
  "price": "number (double)",
  "stock": 100
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
suppliers

Check if supplier exists

HEAD /suppliers/{ID}

Check if a supplier with ID exists, but do not return it's data. Requires inventory or accounts permission. Has dependencies on items and account.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
suppliers

Update existing supplier

PATCH /suppliers/{ID}

Update an existing supplier by ID and return it's persistent data. Requires writable inventory or accounts permission. Has dependencies on items and account.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
suppliers

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": 13,
  "creationdate": 872838840,
  "creator": 6,
  "deliverytime": "integer",
  "item": 7,
  "itemnum": "EXTERNAL-123456",
  "lastmodified": 872838840,
  "minamount": "number (double)",
  "price": "number (double)",
  "stock": 100
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

tasks

tasks

List tasks

POST /tasks

List selected data from all tasks that match the specified filter and search criteria in a specific sort order. Requires tasks permission.

200 OK
tasks

OK

type
tasks
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "assigneduser": 6,
    "creationdate": 872838840,
    "creator": 6,
    "datefrom": "integer (int64)",
    "davserver": 7,
    "description": "string",
    "duedate": "integer (int64)",
    "lastmodified": 872838840,
    "name": "My Task",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)",
    "priority": "integer",
    "project": "integer (int32)",
    "projectedeffort": "number (int32)",
    "status": "integer",
    "tasknum": "K-123456",
    "ticket": "integer (int32)",
    "visibility": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
tasks

Create new task

PUT /tasks

Create a new task and return it's persistent data. Requires writable tasks permission.

body
in formData
object

(no description)

201 Created
tasks

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": "integer (int64)",
  "davserver": 7,
  "description": "string",
  "duedate": "integer (int64)",
  "lastmodified": 872838840,
  "name": "My Task",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "priority": "integer",
  "project": "integer (int32)",
  "projectedeffort": "number (int32)",
  "status": "integer",
  "tasknum": "K-123456",
  "ticket": "integer (int32)",
  "visibility": "integer"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
tasks

Delete task

DELETE /tasks/{ID}

Permanently delete an existing task by ID. Requires writable tasks permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
tasks

Get task

GET /tasks/{ID}

Return the data of an existing task by ID. Requires tasks permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
tasks

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": "integer (int64)",
  "davserver": 7,
  "description": "string",
  "duedate": "integer (int64)",
  "lastmodified": 872838840,
  "name": "My Task",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "priority": "integer",
  "project": "integer (int32)",
  "projectedeffort": "number (int32)",
  "status": "integer",
  "tasknum": "K-123456",
  "ticket": "integer (int32)",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
tasks

Check if task exists

HEAD /tasks/{ID}

Check if a task with ID exists, but do not return it's data. Requires tasks permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
tasks

Update existing task

PATCH /tasks/{ID}

Update an existing task by ID and return it's persistent data. Requires writable tasks permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
tasks

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": "integer (int64)",
  "davserver": 7,
  "description": "string",
  "duedate": "integer (int64)",
  "lastmodified": 872838840,
  "name": "My Task",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "priority": "integer",
  "project": "integer (int32)",
  "projectedeffort": "number (int32)",
  "status": "integer",
  "tasknum": "K-123456",
  "ticket": "integer (int32)",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

tickets

tickets

List tickets

POST /tickets

List selected data from all tickets that match the specified filter and search criteria in a specific sort order. Requires tickets permission.

200 OK
tickets

OK

type
tickets
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "account": 7,
    "assigneduser": 6,
    "calculation": "integer",
    "creationdate": 872838840,
    "creator": 6,
    "date": 872838840,
    "description": "string",
    "duedate": "integer (int64)",
    "lastmodified": 872838840,
    "name": "My Ticket",
    "ownergroup": "integer (int32)",
    "priority": "integer",
    "project": "integer (int32)",
    "status": "integer",
    "ticketnum": "T-123456",
    "visibility": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
tickets

Create new ticket

PUT /tickets

Create a new ticket and return it's persistent data. Requires writable tickets permission.

body
in formData
object

(no description)

201 Created
tickets

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "calculation": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "description": "string",
  "duedate": "integer (int64)",
  "lastmodified": 872838840,
  "name": "My Ticket",
  "ownergroup": "integer (int32)",
  "priority": "integer",
  "project": "integer (int32)",
  "status": "integer",
  "ticketnum": "T-123456",
  "visibility": "integer"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
tickets

Delete ticket

DELETE /tickets/{ID}

Permanently delete an existing ticket by ID. Requires writable tickets permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
tickets

Get ticket

GET /tickets/{ID}

Return the data of an existing ticket by ID. Requires tickets permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
tickets

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "calculation": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "description": "string",
  "duedate": "integer (int64)",
  "lastmodified": 872838840,
  "name": "My Ticket",
  "ownergroup": "integer (int32)",
  "priority": "integer",
  "project": "integer (int32)",
  "status": "integer",
  "ticketnum": "T-123456",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
tickets

Check if ticket exists

HEAD /tickets/{ID}

Check if a ticket with ID exists, but do not return it's data. Requires tickets permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
tickets

Update existing ticket

PATCH /tickets/{ID}

Update an existing ticket by ID and return it's persistent data. Requires writable tickets permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
tickets

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "calculation": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "description": "string",
  "duedate": "integer (int64)",
  "lastmodified": 872838840,
  "name": "My Ticket",
  "ownergroup": "integer (int32)",
  "priority": "integer",
  "project": "integer (int32)",
  "status": "integer",
  "ticketnum": "T-123456",
  "visibility": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

transactions

transactions

List transactions

POST /transactions

List selected data from all transactions that match the specified filter and search criteria in a specific sort order. Requires billing, procurement or production permission.

200 OK
transactions

OK

type
transactions
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "account": 7,
    "assigneduser": 6,
    "billingaddress": "123 Main St.",
    "billingcity": "Anytown",
    "billingcountry": "US",
    "billingpostalcode": "95060",
    "billingrecipient": "Customer, Inc.",
    "billingregion": "CA",
    "calculation": "integer",
    "contract": "integer (int32)",
    "creationdate": 872838840,
    "creator": 6,
    "currency": "EUR",
    "date": 872838840,
    "discount": 20,
    "duedate": "integer (int64)",
    "exchangerate": "number (double)",
    "item": "integer (int32)",
    "lastmodified": 872838840,
    "margin": 40,
    "netamount": 100,
    "ownergroup": "integer (int32)",
    "productionfactor": "integer (int32)",
    "shippingaddress": "123 Main St.",
    "shippingcity": "Anytown",
    "shippingcountry": "US",
    "shippingpostalcode": "95060",
    "shippingrecipient": "Customer, Inc.",
    "shippingregion": "CA",
    "status": "integer",
    "tax": 19,
    "taxid": "DE123456789",
    "transactionnum": "BI-0117.12345",
    "type": 3,
    "weight": "number (double)"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
transactions

Create new transaction

PUT /transactions

Create a new transaction and return it's persistent data. Requires writable billing, procurement or production permission.

body
in formData
object

(no description)

201 Created
transactions

Successful Creation (Created)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (201 Created) 
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "billingaddress": "123 Main St.",
  "billingcity": "Anytown",
  "billingcountry": "US",
  "billingpostalcode": "95060",
  "billingrecipient": "Customer, Inc.",
  "billingregion": "CA",
  "calculation": "integer",
  "contract": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "date": 872838840,
  "discount": 20,
  "duedate": "integer (int64)",
  "exchangerate": "number (double)",
  "item": "integer (int32)",
  "lastmodified": 872838840,
  "margin": 40,
  "netamount": 100,
  "ownergroup": "integer (int32)",
  "productionfactor": "integer (int32)",
  "shippingaddress": "123 Main St.",
  "shippingcity": "Anytown",
  "shippingcountry": "US",
  "shippingpostalcode": "95060",
  "shippingrecipient": "Customer, Inc.",
  "shippingregion": "CA",
  "status": "integer",
  "tax": 19,
  "taxid": "DE123456789",
  "transactionnum": "BI-0117.12345",
  "type": 3,
  "weight": "number (double)"
}
Response Headers (201 Created)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
transactions

Delete transaction

DELETE /transactions/{ID}

Permanently delete an existing transaction by ID. Requires writable billing, procurement or production permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
transactions

Get transaction

GET /transactions/{ID}

Return the data of an existing transaction by ID. Requires billing, procurement or production permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
transactions

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "billingaddress": "123 Main St.",
  "billingcity": "Anytown",
  "billingcountry": "US",
  "billingpostalcode": "95060",
  "billingrecipient": "Customer, Inc.",
  "billingregion": "CA",
  "calculation": "integer",
  "contract": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "date": 872838840,
  "discount": 20,
  "duedate": "integer (int64)",
  "exchangerate": "number (double)",
  "item": "integer (int32)",
  "lastmodified": 872838840,
  "margin": 40,
  "netamount": 100,
  "ownergroup": "integer (int32)",
  "productionfactor": "integer (int32)",
  "shippingaddress": "123 Main St.",
  "shippingcity": "Anytown",
  "shippingcountry": "US",
  "shippingpostalcode": "95060",
  "shippingrecipient": "Customer, Inc.",
  "shippingregion": "CA",
  "status": "integer",
  "tax": 19,
  "taxid": "DE123456789",
  "transactionnum": "BI-0117.12345",
  "type": 3,
  "weight": "number (double)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
transactions

Check if transaction exists

HEAD /transactions/{ID}

Check if a transaction with ID exists, but do not return it's data. Requires billing, procurement or production permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
transactions

Update existing transaction

PATCH /transactions/{ID}

Update an existing transaction by ID and return it's persistent data. Requires writable billing, procurement or production permission.

ID
in path
integer

Unique ID

If-Match
in header
string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK
transactions

Successful Update (OK)

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "billingaddress": "123 Main St.",
  "billingcity": "Anytown",
  "billingcountry": "US",
  "billingpostalcode": "95060",
  "billingrecipient": "Customer, Inc.",
  "billingregion": "CA",
  "calculation": "integer",
  "contract": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "date": 872838840,
  "discount": 20,
  "duedate": "integer (int64)",
  "exchangerate": "number (double)",
  "item": "integer (int32)",
  "lastmodified": 872838840,
  "margin": 40,
  "netamount": 100,
  "ownergroup": "integer (int32)",
  "productionfactor": "integer (int32)",
  "shippingaddress": "123 Main St.",
  "shippingcity": "Anytown",
  "shippingcountry": "US",
  "shippingpostalcode": "95060",
  "shippingrecipient": "Customer, Inc.",
  "shippingregion": "CA",
  "status": "integer",
  "tax": 19,
  "taxid": "DE123456789",
  "transactionnum": "BI-0117.12345",
  "type": 3,
  "weight": "number (double)"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

users

users

List users

POST /users

List selected data from all users that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

200 OK
users

OK

type
users
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "activity": "integer",
    "apionly": "integer",
    "contact": 7,
    "creationdate": 872838840,
    "creator": 6,
    "email": "john.doe@company.com",
    "expdate": "integer (int64)",
    "lastlogin": 872838840,
    "lastmodified": 872838840,
    "name": "john.doe",
    "nopublic": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
users

Get user

GET /users/{ID}

Return the data of an existing user by ID. Requires no specific permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
users

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "activity": "integer",
  "apionly": "integer",
  "contact": 7,
  "creationdate": 872838840,
  "creator": 6,
  "email": "john.doe@company.com",
  "expdate": "integer (int64)",
  "lastlogin": 872838840,
  "lastmodified": 872838840,
  "name": "john.doe",
  "nopublic": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
users

Check if user exists

HEAD /users/{ID}

Check if a user with ID exists, but do not return it's data. Requires no specific permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

weblets

weblets

List weblets

POST /weblets

List selected data from all weblets that match the specified filter and search criteria in a specific sort order. Requires dev permission.

200 OK
weblets

OK

type
weblets
401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "ID": 1,
    "activity": "integer",
    "application": 7,
    "color": "string",
    "creationdate": 872838840,
    "creator": 6,
    "height": "integer",
    "identifier": "my_weblet",
    "langaliases": {
      "de_DE": "Mein neues Weblet",
      "en_US": "My new Weblet"
    },
    "lastmodified": 872838840,
    "mimetype": "string",
    "name": "My Weblet",
    "svgpath": "string",
    "type": "integer",
    "view": "notes.index",
    "width": "integer"
  }
]
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
weblets

Get weblet

GET /weblets/{ID}

Return the data of an existing weblet by ID. Requires dev permission.

ID
in path
integer

Unique ID

expand
in query
string[]

Expand content of composite fields (binfile, json or array)

extdata
in query
integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags
in query
integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK
weblets

OK

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
403 Forbidden

Forbidden

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "ID": 1,
  "activity": "integer",
  "application": 7,
  "color": "string",
  "creationdate": 872838840,
  "creator": 6,
  "height": "integer",
  "identifier": "my_weblet",
  "langaliases": {
    "de_DE": "Mein neues Weblet",
    "en_US": "My new Weblet"
  },
  "lastmodified": 872838840,
  "mimetype": "string",
  "name": "My Weblet",
  "svgpath": "string",
  "type": "integer",
  "view": "notes.index",
  "width": "integer"
}
Response Headers (200 OK)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (403 Forbidden) 
"Forbidden: Lacking access permission"
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"
weblets

Check if weblet exists

HEAD /weblets/{ID}

Check if an weblet with ID exists, but do not return it's data. Requires dev permission.

ID
in path
integer

Unique ID

If-None-Match
in header
string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type
string
404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type
string
Response Headers (204 No Content)
ETag

Entity tag ( RFC 7232)

 object
Response Example (401 Unauthorized) 
"Unauthorized: Invalid token for bearer authentication"
Response Headers (401 Unauthorized)
WWW-Authenticate

Preferred authentication scheme ( RFC 7235)

 object
Response Example (500 Internal Server Error) 
"I am afraid I can't do that Dave!"

Schema Definitions

accounts: object

ID: integer (int32)

Account ID

assigneduser: integer (int32)

Assigned user ID

contact: integer (int32)

Contact ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

currency: string

Currency code ( ISO 4217)

customernum: string

Customer number (only for PROSPECT, CUSTOMERANDSUPPLIER, CUSTOMER or EMPLOYEE)

description: string

Detailed general description

excludetax: integer 0, 1 0

Exclude from taxation

firstname: string

First name (given name); is required if lastname is empty

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

lastname: string

Last name (surname or company name); is required if firstname is empty

locked: integer 0, 1 0

Deny booking of billing or procurement transactions

ownergroup: integer (int32)

Owner group ID (null=PUBLIC)

suppliernum: string

Supplier number (only for SUPPLIER or CUSTOMERANDSUPPLIER)

taxid: string

Tax ID (e.g. VATIN or SSN)

type: integer 0, 1, 2, 3, 4, 5 0

Account type (0=PROSPECT, 1=CUSTOMER, 2=SUPPLIER, 3=CUSTOMERANDSUPPLIER, 4=COMPETITOR, 5=EMPLOYEE)

visibility: integer 0, 1, 2 0

Visibility (0=REGULAR, 1=ARCHIVED, 2=DELETED)

Example
{
  "ID": 1,
  "assigneduser": 6,
  "contact": 7,
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "customernum": "C-123456",
  "description": "string",
  "excludetax": "integer",
  "firstname": "John",
  "lastmodified": 872838840,
  "lastname": "Doe",
  "locked": "integer",
  "ownergroup": "integer (int32)",
  "suppliernum": "S-123456",
  "taxid": "DE123456789",
  "type": "integer",
  "visibility": "integer"
}

actionsteps: object

ID: integer (int32)

Action step ID

account: integer (int32)

Account ID; is mutually exclusive to task and ticket

actionnum: string

Action number

assigneduser: integer (int32)

Assigned user ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

date: integer (int64)

Designated date and time as a Unix time stamp (defaults to current date and time on creation)

description: string

Detailed general description

duedate: integer (int64)

Due date and time as a Unix time stamp

effort: number (int32) x ≥ 0 0

Effort in minutes

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Name

ownergroup: integer (int32)

Owner group ID (PUBLIC if owneruser=null and ownergroup=null)

owneruser: integer (int32)

Owner user ID (PUBLIC if owneruser=null and ownergroup=null)

status: integer 0, 1, 2, 3 0

Status (0=DRAFT, 1=COMPLETED, 2=CANCELLED, 3=BOOKED)

task: integer (int32)

Task ID; is mutually exclusive to ticket and account

ticket: integer (int32)

Ticket ID; is mutually exclusive to task and account

transaction: integer (int32)

Transaction ID

Example
{
  "ID": 1,
  "account": "integer (int32)",
  "actionnum": "A-123456",
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "description": "string",
  "duedate": "integer (int64)",
  "effort": "number (int32)",
  "lastmodified": 872838840,
  "name": "My Action Step",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "status": "integer",
  "task": 7,
  "ticket": "integer (int32)",
  "transaction": "integer (int32)"
}

addresses: object

ID: integer (int64)

Address ID

account: integer (int32)

Account ID ( dependency)

contact: integer (int32)

Contact ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

default: integer 0, 1 0

Default for this address type

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

type: integer 0, 1, 2, 3, 4 0

Address type (0=BILLING_SHIPPING, 1=BILLING_BILLING, 2=PROCUREMENT_SHIPPING, 3=PROCUREMENT_BILLING, 4=COLLECTION)

Example
{
  "ID": 1,
  "account": 7,
  "contact": 13,
  "creationdate": 872838840,
  "creator": 6,
  "default": "integer",
  "lastmodified": 872838840,
  "type": "integer"
}

applications: object

ID: integer (int32)

Application ID

activity: integer 0, 1, 2 0

Activity (0=ACTIVE, 1=DEACTIVATED, 2=DELETED)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

identifier: string (up to 200 chars)

Unique application identifier

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Name

vendor: string

Vendor (developer or company name)

version: integer (int32) x ≥ 10000 10000

Version number (formatted as 1.00-00)

Example
{
  "ID": 1,
  "activity": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "identifier": "my_application",
  "lastmodified": 872838840,
  "name": "My Application",
  "vendor": "ZeyOS",
  "version": 10000
}

appointments: object

ID: integer (int32)

Appointment ID

assigneduser: integer (int32)

Assigned user ID

color: string

Color code (CSS-style hexadecimal without #)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

datefrom: integer (int64)

Start date and time as a Unix time stamp; must be less than or equal to dateto

daterecurrence: integer (int64)

Recurrence end date as a Unix time stamp

dateto: integer (int64)

End date and time as a Unix time stamp; must be greater than or equal to datefrom

davserver: integer (int32)

DAV server ID

description: string

Detailed general description

interval: integer 1 ≤ x ≤ 32767 1

Recurrence interval in minutes

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

location: string

Location

name: string (at least 1 chars)

Name

ownergroup: integer (int32)

Owner group ID (PUBLIC if owneruser=null and ownergroup=null)

owneruser: integer (int32)

Owner user ID (PUBLIC if owneruser=null and ownergroup=null)

recurrence: integer 0, 1, 2, 3, 4

Recurrence (0=DAY, 1=WORKDAY, 2=WEEK, 3=MONTH, 4=YEAR)

visibility: integer 0, 1, 2 0

Visibility (0=REGULAR, 1=ARCHIVED, 2=DELETED)

Example
{
  "ID": 1,
  "assigneduser": 6,
  "color": "string",
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": 872838840,
  "daterecurrence": "integer (int64)",
  "dateto": 872842440,
  "davserver": 7,
  "description": "string",
  "interval": "integer",
  "lastmodified": 872838840,
  "location": "Office",
  "name": "My Appointment",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recurrence": "integer",
  "visibility": "integer"
}

associations: object

ID: integer (int64)

Association ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

entity1: string accounts, actionsteps, applications, appointments, campaigns, contacts, contracts, coupons, davservers, devices, dunning, feedservers, groups, items, ledgers, links, mailinglists, mailservers, messages, notes, objects, opportunities, payments, pricelists, projects, resources, services, storages, tasks, tickets, transactions, users, weblets

First canonical entity

entity2: string accounts, actionsteps, applications, appointments, campaigns, contacts, contracts, coupons, davservers, devices, dunning, feedservers, groups, items, ledgers, links, mailinglists, mailservers, messages, notes, objects, opportunities, payments, pricelists, projects, resources, services, storages, tasks, tickets, transactions, users, weblets

Second canonical entity

index1: integer (int32)

First entity ID

index2: integer (int32)

Second entity ID

meta: meta-field
Example
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity1": "notes",
  "entity2": "tasks",
  "index1": 7,
  "index2": 13
}

binfile-content: object

content: string

Base64-encoded content; is mutually exclusive to uri (either one is required)

uri: string (url)

Data URI ( RFC 2397); is mutually exclusive to content (either one is required)

Example
{
  "content": "SGVsbG8gV29ybGQh",
  "uri": "data:text/plain;base64,SGVsbG8gV29ybGQh"
}

binfile-field:

Example

binfiles: object

ID: integer (int32)

Bin file ID

hash: string

MD5 hash of the content in hexadecimal notation prefixed with '\x'

size: integer (int32) x ≥ 1

Size in bytes

Example
{
  "ID": 1,
  "hash": "\\xed076287532e86365e841e92bfc50d8c",
  "size": 12
}

campaigns: object

ID: integer (int32)

Campaign ID

assigneduser: integer (int32)

Assigned user ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

datefrom: integer (int64)

Start date as a Unix time stamp; must be less than or equal to dateto

dateto: integer (int64)

End date as a Unix time stamp; must be greater than or equal to datefrom

description: string

Detailed general description

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Name

ownergroup: integer (int32)

Owner group ID (null=PUBLIC)

status: integer 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 0

Status (0=DRAFT, 1=NOTSTARTED, 2=AWAITINGAPPROVAL, 3=APPROVED, 4=DISMISSED, 5=ACTIVE, 6=INACTIVE, 7=INEVALUATION, 8=CANCELLED, 9=CLOSED)

visibility: integer 0, 1, 2 0

Visibility (0=REGULAR, 1=ARCHIVED, 2=DELETED)

Example
{
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Campaign",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "visibility": "integer"
}

categories: object

ID: integer (int32)

Category ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

entity: string (at least 1 chars)

Canonical entity

name: string (at least 1 chars)

Name

ownergroup: integer (int32)

Owner group ID (PUBLIC if owneruser=null and ownergroup=null)

owneruser: integer (int32)

Owner user ID (PUBLIC if owneruser=null and ownergroup=null)

Example
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity": "notes",
  "name": "My Category/My Subcategory",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)"
}

channels: object

ID: integer (int32)

Channel ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

name: string (at least 1 chars)

Name (unique)

Example
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "name": "Channel"
}

comments: object

ID: integer (int64)

Comment ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

record: integer (int64)

Record ID ( dependency)

sender: string

Sender

text: string

Comment text ( Markdown for rich text representation)

Example
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "record": 7,
  "sender": "John Doe",
  "text": "This is my comment!"
}

components: object

ID: integer (int64)

Component ID

amount: number (double) 1

Amount (quantity)

component: integer (int32)

Component item ID; must be distinct from item

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

fixed: integer 0, 1 0

Fixed quantity

item: integer (int32)

Item ID ( dependency)

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

price: number (double)

Imputed price per unit

Example
{
  "ID": 1,
  "amount": "number (double)",
  "component": 13,
  "creationdate": 872838840,
  "creator": 6,
  "fixed": "integer",
  "item": 7,
  "lastmodified": 872838840,
  "price": "number (double)"
}

contacts: object

ID: integer (int32)

Contact ID

address: string

Address (street and building/suite number)

assigneduser: integer (int32)

Assigned user ID

birthdate: integer (int64)

Birth date as a Unix time stamp (only for PERSON)

cell: string

Cell phone number

city: string

City or municipality

company: string

Company name (only for PERSON)

country: string

Country code ( ISO 3166-1 alpha-2)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

davserver: integer (int32)

DAV server ID

department: string

Department (only for PERSON)

description: string

Detailed general description

email: string (email)

Primary e-mail address

email2: string (email)

Secondary e-mail address

fax: string

Fax number

firstname: string

First name (given name); is required if lastname is empty

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

lastname: string

Last name (surname or company name); is required if firstname is empty

ownergroup: integer (int32)

Owner group ID (PUBLIC if owneruser=null and ownergroup=null)

owneruser: integer (int32)

Owner user ID (PUBLIC if owneruser=null and ownergroup=null)

phone: string

Primary phone number

phone2: string

Secondary phone number

position: string

Position or job title (only for PERSON)

postalcode: string

Postal or ZIP code

region: string

Region or state

title: string

Title or salutation (only for PERSON)

type: integer 0, 1 0

Contact type (0=COMPANY, 1=PERSON)

visibility: integer 0, 1, 2 0

Visibility (0=REGULAR, 1=ARCHIVED, 2=DELETED)

website: string (url)

Website URL

Example
{
  "ID": 1,
  "address": "123 Main St.",
  "assigneduser": 6,
  "birthdate": "integer (int64)",
  "cell": "+1 123-456-7892",
  "city": "Anytown",
  "company": "Any Company, Inc.",
  "country": "US",
  "creationdate": 872838840,
  "creator": 6,
  "davserver": 7,
  "department": "Research & Development",
  "description": "string",
  "email": "john.doe@company.com",
  "email2": "johnny_d@personal.com",
  "fax": "+1 123-456-7893",
  "firstname": "John",
  "lastmodified": 872838840,
  "lastname": "Doe",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "phone": "+1 123-456-7890",
  "phone2": "+1 123-456-7891",
  "position": "CTO",
  "postalcode": "95060",
  "region": "CA",
  "title": "Dr.",
  "type": "integer",
  "visibility": "integer",
  "website": "http://www.company.com/about/john_doe"
}

contacts2contacts: object

ID: integer (int64)

Contact-to-contact ID

contact1: integer (int32)

First contact ID ( dependency)

contact2: integer (int32)

Second contact ID ( dependency)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

Example
{
  "ID": 1,
  "contact1": 7,
  "contact2": 13,
  "creationdate": 872838840,
  "creator": 6
}

contracts: object

ID: integer (int32)

Contract ID

account: integer (int32)

Account ID

assigneduser: integer (int32)

Assigned user ID

autobilling:
billingcycle: integer 1 ≤ x ≤ 32767

Billing cycle in months

billingitems: items-field
calculation: integer 0, 1, 2 0

Calculation method (0=NET, 1=GROSS, 2=LEGACY)

contractnum: string

Contract number

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

currency: string

Currency code ( ISO 4217)

datecancel: integer (int64)

Cancellation date as a Unix time stamp

datefrom: integer (int64)

Start date as a Unix time stamp; must be less than or equal to dateto

dateto: integer (int64)

End date as a Unix time stamp; must be greater than or equal to datefrom

description: string

Detailed general description

exchangerate: number (double) x ≥ 0 1

Exchange rate as a multiple of one monetary unit of the fixed system currency

lastbilling: integer (int64)

Last billing date and time as a Unix time stamp

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Name

ownergroup: integer (int32)

Owner group ID (null=PUBLIC)

procurementitems: items-field
status: integer 0, 1, 2, 3, 4, 5, 6, 7, 8 0

Status (0=DRAFT, 1=AWAITINGAPPROVAL, 2=APPROVED, 3=DISMISSED, 4=ACTIVE, 5=INACTIVE, 6=EXPIRED, 7=CANCELLED, 8=CLOSED)

visibility: integer 0, 1, 2 0

Visibility (0=REGULAR, 1=ARCHIVED, 2=DELETED)

Example
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "billingcycle": "integer",
  "calculation": "integer",
  "contractnum": "N-123456",
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "datecancel": "integer (int64)",
  "datefrom": 872838840,
  "dateto": "integer (int64)",
  "description": "string",
  "exchangerate": "number (double)",
  "lastbilling": "integer (int64)",
  "lastmodified": 872838840,
  "name": "My Contract",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "visibility": "integer"
}

couponcodes: object

ID: integer (int64)

Coupon code ID

code: string (at least 1 chars)

Coupon code

coupon: integer (int32)

Coupon ID ( dependency)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

date: integer (int64)

Designated date and time as a Unix time stamp (defaults to current date and time on creation)

datefrom: integer (int64)

Start date and time as a Unix time stamp; must be less than or equal to dateto

dateto: integer (int64)

End date and time as a Unix time stamp; must be greater than or equal to datefrom

flag: integer 0, 1, 2 0

Flag (0=BOOKED, 1=RESERVED, 2=CANCELLED)

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

transaction: integer (int32)

Transaction ID

value: number (double) x ≥ 0 0

Value

Example
{
  "ID": 1,
  "code": "XMAX17",
  "coupon": 7,
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "flag": "integer",
  "lastmodified": 872838840,
  "transaction": "integer (int32)",
  "value": "number (double)"
}

coupons: object

ID: integer (int32)

Coupon ID

activity: integer 0, 1, 2 0

Activity (0=ACTIVE, 1=DEACTIVATED, 2=DELETED)

code: string

Promotion code (only for PROMOTION)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

datefrom: integer (int64)

Start date and time as a Unix time stamp; must be less than or equal to dateto

dateto: integer (int64)

End date and time as a Unix time stamp; must be greater than or equal to datefrom

description: string

Detailed general description

foreigntaxrates: object

Country-specific tax rates in percent; use country code as object key

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Name

neutral: integer 0, 1 0

Neutral in transaction

ownergroup: integer (int32)

Owner group ID (null=PUBLIC)

taxrate: number (double) 0 ≤ x ≤ 100 0

Tax rate in percent

type: integer 0, 1 0

Coupon type (0=PROMOTION, 1=INDIVIDUAL)

value: number (double) x ≥ 0 0

Default value

Example
{
  "ID": 1,
  "activity": "integer",
  "code": "XMAX17",
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "description": "string",
  "foreigntaxrates": {
    "AT": 21,
    "DE": 19
  },
  "lastmodified": 872838840,
  "name": "My Coupon",
  "neutral": "integer",
  "ownergroup": "integer (int32)",
  "taxrate": "number (double)",
  "type": "integer",
  "value": "number (double)"
}

davservers: object

ID: integer (int32)

DAV server ID

activity: integer 0, 1, 2 0

Activity (0=ACTIVE, 1=DEACTIVATED, 2=DELETED)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

ctag: string

Collection entity tag (CTag) ( caldav-ctag-03)

description: string

Detailed general description

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Name

ownergroup: integer (int32)

Owner group ID (PUBLIC if owneruser=null and ownergroup=null)

owneruser: integer (int32)

Owner user ID (PUBLIC if owneruser=null and ownergroup=null)

recipientgroup: integer (int32)

Recipient group ID (PUBLIC if recipientuser=null and recipientgroup=null)

recipientuser: integer (int32)

Recipient user ID (PUBLIC if recipientuser=null and recipientgroup=null)

synctoken: string

Synchronization token ( RFC 6578)

type: integer 0, 1, 2 0

Collection type (0=CONTACTS, 2=APPOINTMENTS, 1=TASKS)

url: string (url) (at least 1 chars)

Endpoint URL

username: string

Username

Example
{
  "ID": 1,
  "activity": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "ctag": "\"73c5fdd17f180f2126995666b7edc0e3\"",
  "description": "string",
  "lastmodified": 872838840,
  "name": "My DAV Server",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recipientgroup": "integer (int32)",
  "recipientuser": "integer (int32)",
  "synctoken": "http://dav.company.com/sync/1234",
  "type": "integer",
  "url": "https://dav.company.com/collection",
  "username": "john.doe"
}

devices: object

ID: integer (int32)

Device ID

chargenum: string

Charge (lot) number; is required if serialnum is empty, otherwise must be empty

contract: integer (int32)

Contract ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

description: string

Detailed general description

expdate: integer (int64)

Expiry date as a Unix time stamp

item: integer (int32)

Item ID

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

ownergroup: integer (int32)

Owner group ID (null=PUBLIC)

serialnum: string

Serial number; is required if chargenum is empty, otherwise must be empty

visibility: integer 0, 1, 2 0

Visibility (0=REGULAR, 1=ARCHIVED, 2=DELETED)

Example
{
  "ID": 1,
  "chargenum": "LOT-123456",
  "contract": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "expdate": "integer (int64)",
  "item": 7,
  "lastmodified": 872838840,
  "ownergroup": "integer (int32)",
  "serialnum": "S-123456",
  "visibility": "integer"
}

dunning: object

ID: integer (int32)

Dunning notice ID

account: integer (int32)

Account ID

address: string

Address (street and building/suite number)

assigneduser: integer (int32)

Assigned user ID

city: string

City or municipality

country: string

Country code ( ISO 3166-1 alpha-2)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

date: integer (int64)

Designated date and time as a Unix time stamp (defaults to current date and time on creation)

duedate: integer (int64)

Due date as a Unix time stamp

dunningnum: string (at least 1 chars)

Dunning number

fee: number (double) x ≥ 0 0

Dunning fee

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

ownergroup: integer (int32)

Owner group ID (null=PUBLIC)

postalcode: string

Postal or ZIP code

recipient: string

Recipient

region: string

Region or state

status: integer 0, 1, 2, 3 0

Status (0=DRAFT, 1=BOOKED, 2=CANCELLED, 3=CLOSED)

type: integer 0, 1, 2 0

Dunning type (0=LISTING, 1=REMINDER, 2=NOTICE)

Example
{
  "ID": 1,
  "account": 7,
  "address": "123 Main St.",
  "assigneduser": 6,
  "city": "Anytown",
  "country": "US",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "duedate": "integer (int64)",
  "dunningnum": "D-0117.12345",
  "fee": "number (double)",
  "lastmodified": 872838840,
  "ownergroup": "integer (int32)",
  "postalcode": "95060",
  "recipient": "Bad Customer, Inc.",
  "region": "CA",
  "status": "integer",
  "type": 1
}

dunning2transactions: object

ID: integer (int64)

Dunning-to-transaction ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

dunning: integer (int32)

Dunning notice ID ( dependency)

transaction: integer (int32)

Transaction ID ( dependency)

Example
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "dunning": 7,
  "transaction": 13
}

entities2channels: object

ID: integer (int64)

Entity-to-channel ID

channel: integer (int32)

Channel ID ( dependency)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

entity: string accounts, actionsteps, applications, appointments, campaigns, contacts, contracts, coupons, davservers, devices, dunning, feedservers, groups, items, ledgers, links, mailinglists, mailservers, messages, notes, objects, opportunities, payments, pricelists, projects, resources, services, storages, tasks, tickets, transactions, users, weblets

Canonical entity

index: integer (int64)

Entity ID

Example
{
  "ID": 1,
  "channel": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity": "notes",
  "index": 7
}

events: object

ID: integer (int32)

Event ID

color: string

Color code (CSS-style hexadecimal without #)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

datefrom: integer (int64)

Start date and time as a Unix time stamp; must be less than or equal to dateto

dateto: integer (int64)

End date and time as a Unix time stamp; must be greater than or equal to datefrom

entity: string accounts, actionsteps, applications, appointments, campaigns, contacts, contracts, coupons, davservers, devices, dunning, feedservers, groups, items, ledgers, links, mailinglists, mailservers, messages, notes, objects, opportunities, payments, pricelists, projects, resources, services, storages, tasks, tickets, transactions, users, weblets

Canonical entity

index: integer (int32)

Entity ID; is required if entity is not null, otherwise must be null

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

meta: meta-field
name: string (at least 1 chars)

Name

ownergroup: integer (int32)

Owner group ID (PUBLIC if owneruser=null and ownergroup=null)

owneruser: integer (int32)

Owner user ID (PUBLIC if owneruser=null and ownergroup=null)

Example
{
  "ID": 1,
  "color": "string",
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": 872838840,
  "dateto": 872842440,
  "entity": "notes",
  "index": 7,
  "lastmodified": 872838840,
  "name": "My Event",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)"
}

extdata-field: object

extdata: object

Extension data field and value pairs; remove if null (only for PUT or PATCH)

Example
{
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  }
}

feedservers: object

ID: integer (int32)

Feed server ID

activity: integer 0, 1, 2 0

Activity (0=ACTIVE, 1=DEACTIVATED, 2=DELETED)

channel: integer (int32)

Channel ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

description: string

Detailed general description

etag: string

Entity tag (ETag) ( RFC 7232)

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Name

notify: integer 0, 1 0

Notify about new records

ownergroup: integer (int32)

Owner group ID (PUBLIC if owneruser=null and ownergroup=null)

owneruser: integer (int32)

Owner user ID (PUBLIC if owneruser=null and ownergroup=null)

recipientgroup: integer (int32)

Recipient group ID (PUBLIC if recipientuser=null and recipientgroup=null)

recipientuser: integer (int32)

Recipient user ID (PUBLIC if recipientuser=null and recipientgroup=null)

url: string (url) (at least 1 chars)

Feed URL

username: string

Username

Example
{
  "ID": 1,
  "activity": "integer",
  "channel": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "etag": "\"73c5fdd17f180f2126995666b7edc0e3\"",
  "lastmodified": 872838840,
  "name": "My Feed Server",
  "notify": "integer",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recipientgroup": "integer (int32)",
  "recipientuser": "integer (int32)",
  "url": "http://www.website.com/feed.rss",
  "username": "john.doe"
}

files: object

ID: integer (int64)

File ID

binfile: binfile-field
comment: integer (int64)

Comment ID ( dependency); is mutually exclusive to record (either one is required)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

filename: string

Filename

mimetype: string application/octet-stream

MIME type ( RFC 2045)

record: integer (int64)

Record ID ( dependency); is mutually exclusive to comment (either one is required)

size: integer (int32) x ≥ 0 0

Size in bytes

Example
{
  "ID": 1,
  "comment": "integer (int64)",
  "creationdate": 872838840,
  "creator": 6,
  "filename": "my_file.txt",
  "mimetype": "text/plain",
  "record": 7,
  "size": 12
}

follows: object

ID: integer (int64)

Follow ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

entity: string accounts, actionsteps, applications, appointments, campaigns, contacts, contracts, coupons, davservers, devices, dunning, feedservers, groups, items, ledgers, links, mailinglists, mailservers, messages, notes, objects, opportunities, payments, pricelists, projects, records, resources, services, storages, tasks, tickets, transactions, users, weblets

Canonical entity

index: integer (int64)

Entity ID

Example
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity": "notes",
  "index": 7
}

groups: object

ID: integer (int32)

Group ID

activity: integer 0, 1, 2 0

Activity (0=ACTIVE, 1=DEACTIVATED, 2=DELETED)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

leader: integer (int32)

Leader user ID

name: string (at least 1 chars)

Name (case-insensitively unique)

Example
{
  "ID": 1,
  "activity": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "lastmodified": 872838840,
  "leader": "integer (int32)",
  "name": "Operations"
}

groups2users: object

ID: integer (int64)

Group-to-user ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

group: integer (int32)

Group ID

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

user: integer (int32)

User ID

writable: integer 0, 1 0

Allow writing of group-owned data by user

Example
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "group": 7,
  "lastmodified": 872838840,
  "user": 13,
  "writable": "integer"
}

invitations: object

ID: integer (int64)

Invitation ID

appointment: integer (int32)

Appointment ID ( dependency)

contact: integer (int32)

Contact ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

email: string (email)

E-mail address

flag: integer 0, 1, 2 0

Flag (0=UNANSWERED, 1=CONFIRMED, 2=REJECTED)

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Name

Example
{
  "ID": 1,
  "appointment": 7,
  "contact": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "email": "john.doe@company.com",
  "flag": "integer",
  "lastmodified": 872838840,
  "name": "John Doe"
}

items: object

ID: integer (int32)

Item ID

applicability: integer 0, 1, 2, 3 0

Applicability (0=ALWAYS, 1=NEVER, 2=BILLINGONLY, 3=PROCUREMENTONLY)

barcode: string

Barcode (e.g. UPC or EAN/GTIN)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

description: string

Detailed general description

forcestock: integer 0, 1

Force stock check on depletion (0=STORAGE, 1=LOCATION)

foreigntaxrates: object

Country-specific tax rates in percent; use country code as object key

itemnum: string

Item number (SKU)

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

manufacturer: string

Manufacturer (brand or company name)

model: integer (int32)

Model item ID (only for non-MODEL)

name: string (at least 1 chars)

Product name

ownergroup: integer (int32)

Owner group ID (null=PUBLIC)

picbinfile: binfile-field
purchaseprice: number (double) x ≥ 0 0

Default purchase price per unit

sellingprice: number (double) x ≥ 0 0

Default selling price per unit

subitems: items-field
taxrate: number (double) 0 ≤ x ≤ 100 0

Tax rate in percent

type: integer 0, 1, 2, 3, 4, 5, 6, 7 0

Item type (0=SIMPLE, 1=SERIALS, 2=CHARGES, 3=SERIALSANDCHARGES, 4=SET, 5=CONTAINER, 6=NOSTOCK, 7=MODEL)

unit: string (up to 3 chars)

Unit code ( UN/CEFACT Recommendation 20)

visibility: integer 0, 1, 2 0

Visibility (0=REGULAR, 1=ARCHIVED, 2=DELETED)

weight: number (double) x ≥ 0 0

Shipping weight per unit in kilogram

Example
{
  "ID": 1,
  "applicability": "integer",
  "barcode": "501234567890",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "forcestock": "integer",
  "foreigntaxrates": {
    "AT": 21,
    "DE": 19
  },
  "itemnum": "I-123456",
  "lastmodified": 872838840,
  "manufacturer": "My Company, Inc.",
  "model": "integer (int32)",
  "name": "My Product",
  "ownergroup": "integer (int32)",
  "purchaseprice": "number (double)",
  "sellingprice": "number (double)",
  "taxrate": "number (double)",
  "type": "integer",
  "unit": "string",
  "visibility": "integer",
  "weight": "number (double)"
}

items-common: object

original: integer (int32)

Original entity ID

references: object[]
object
subindex: integer (int32) 0

Position in referenced transaction

transaction: integer (int32)

Referenced transaction ID

subindex: integer (int32) 0

Position in original entity

type: integer 0, 1, 2 0

Type (0=PRODUCT, 1=TEXT, 2=COUPON)

Example
{
  "original": "integer (int32)",
  "references": [
    {
      "subindex": 0,
      "transaction": 1
    }
  ],
  "subindex": 0,
  "type": "integer"
}

items-coupon: object

code: string

Coupon code

couponcode: integer (int64)

Final coupon code ID (only set on delivery or invoice)

name: string

Coupon name

reservation: integer (int64)

Reservation coupon code ID (only set on order)

taken: boolean

Taken by subsequent transaction step

taxrate: number (double) 0 ≤ x ≤ 100 0

Tax rate in percent

value: number (double) 0

Value

Example
{
  "code": "XMAS",
  "couponcode": "integer (int64)",
  "name": "Holiday Promotion",
  "reservation": "integer (int64)",
  "taken": "boolean",
  "taxrate": "number (double)",
  "value": "number (double)"
}

items-field:

Example

items-list: array

Example
[
  {
    "original": "integer (int32)",
    "references": [
      {
        "subindex": 0,
        "transaction": 1
      }
    ],
    "subindex": 0,
    "type": "integer"
  }
]

items-product: object

amount: number (double) 0

Amount (quantity)

amounttaken: number (double) 0

Amount (quantity) taken by subsequent transaction step

barcode: string

Barcode (e.g. UPC or EAN/GTIN)

discount: number (double) -100 ≤ x ≤ 100 0

Primary relative discount in percent (applied after rebate and before discount2)

discount2: number (double) -100 ≤ x ≤ 100 0

Secondary relative discount in percent on top of primary discount (applied after rebate and discount)

item: integer (int32)

Item ID

itemnum: string

Item number (SKU)

itemtype: integer 0, 1, 2, 3, 4, 5, 6, 7 0

Item type (0=SIMPLE, 1=SERIALS, 2=CHARGES, 3=SERIALSANDCHARGES, 4=SET, 5=CONTAINER, 6=NOSTOCK, 7=MODEL)

manufacturer: string

Manufacturer (brand or company name)

name: string

Product name

purchaseprice: number (double) 0

Purchase price per unit

rebate: number (double) 0

Absolute rebate per unit (applied before discount and discount2)

reservation: integer (int64)

Reservation stock transaction ID (only set on order)

sellingprice: number (double) 0

Selling price per unit

taxrate: number (double) 0 ≤ x ≤ 100 0

Tax rate in percent

transactions: object[]
object
amount: number (double) 0

Amount (quantity)

chargenum: string

Charge (lot) number

location: string

Physical location (e.g. shelf identification)

serials: string[]

Serial numbers

string
storage: integer (int32)

Storage ID

transaction: integer (int64)

Final stock transaction ID (only set on delivery, invoice or production)

unit: string (up to 3 chars)

Unit code ( UN/CEFACT Recommendation 20)

weight: number (double) x ≥ 0 0

Shipping weight per unit in kilogram

Example
{
  "amount": "number (double)",
  "amounttaken": "number (double)",
  "barcode": "501234567890",
  "discount": "number (double)",
  "discount2": "number (double)",
  "item": "integer (int32)",
  "itemnum": "I-123456",
  "itemtype": "integer",
  "manufacturer": "My Company, Inc.",
  "name": "My Product",
  "purchaseprice": "number (double)",
  "rebate": "number (double)",
  "reservation": "integer (int64)",
  "sellingprice": "number (double)",
  "taxrate": "number (double)",
  "transactions": [
    {
      "amount": "number (double)",
      "chargenum": "LOT-123456",
      "location": "B1-R2-S3",
      "serials": [
        "string"
      ],
      "storage": "integer (int32)",
      "transaction": "integer (int64)"
    }
  ],
  "unit": "string",
  "weight": "number (double)"
}

items-text: object

taken: boolean

Taken by subsequent transaction step

text: string

Text

variant: integer 0, 1, 2, 3, 4 0

Variant (0=DESCRIPTION, 1=ANNOTATION, 2=SUBTITLE, 3=TITLE, 4=HEADLINE)

Example
{
  "taken": "boolean",
  "text": "My Description, Title or Headline",
  "variant": "integer"
}

ledgers: object

ID: integer (int32)

Ledger ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

description: string

Detailed general description

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Name

ownergroup: integer (int32)

Owner group ID (null=PUBLIC)

visibility: integer 0, 1, 2 0

Visibility (0=REGULAR, 1=ARCHIVED, 2=DELETED)

Example
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "Credit Suisse #12345",
  "ownergroup": "integer (int32)",
  "visibility": "integer"
}

likes: object

ID: integer (int64)

Like ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

record: integer (int64)

Record ID ( dependency)

Example
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "record": 7
}

mailinglists: object

ID: integer (int32)

Mailing list ID

assigneduser: integer (int32)

Assigned user ID

campaign: integer (int32)

Campaign ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

description: string

Detailed general description

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Name

ownergroup: integer (int32)

Owner group ID (PUBLIC if owneruser=null and ownergroup=null)

owneruser: integer (int32)

Owner user ID (PUBLIC if owneruser=null and ownergroup=null)

sender: string

Sender name and e-mail address

visibility: integer 0, 1, 2 0

Visibility (0=REGULAR, 1=ARCHIVED, 2=DELETED)

Example
{
  "ID": 1,
  "assigneduser": 6,
  "campaign": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Mailing List",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "sender": "John Doe <john.doe@company.com>",
  "visibility": "integer"
}

mailservers: object

ID: integer (int32)

Mail server ID

activity: integer 0, 1, 2 0

Activity (0=ACTIVE, 1=DEACTIVATED, 2=DELETED)

autoreplybinfile: binfile-field
creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

description: string

Detailed general description

folders:
lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Name

ownergroup: integer (int32)

Owner group ID (PUBLIC if owneruser=null and ownergroup=null)

owneruser: integer (int32)

Owner user ID (PUBLIC if owneruser=null and ownergroup=null)

recipientgroup: integer (int32)

Recipient group ID (PUBLIC if recipientuser=null and recipientgroup=null)

recipientuser: integer (int32)

Recipient user ID (PUBLIC if recipientuser=null and recipientgroup=null)

sender: string

Sender name and e-mail address

serverin: string

Server (Inbound)

serverout: string

Server (Outbound)

signaturebinfile: binfile-field
ticketing:
usernamein: string

Username (Inbound)

usernameout: string

Username (Outbound)

Example
{
  "ID": 1,
  "activity": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Mail Server",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recipientgroup": "integer (int32)",
  "recipientuser": "integer (int32)",
  "sender": "John Doe <john.doe@company.com>",
  "serverin": "imap.company.com:143/tls",
  "serverout": "smtp.company.com:587/tls",
  "usernamein": "john.doe",
  "usernameout": "john.doe"
}

messagereads: object

ID: integer (int64)

Message-read ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

message: integer (int32)

Message ID ( dependency)

Example
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "message": 7
}

messages: object

ID: integer (int32)

Message ID

attachments: string[]

Attachments (filenames)

string
bcc: string

All blind carbon copy recipient names and e-mail addresses

binfile: binfile-field
cc: string

All carbon copy recipient names and e-mail addresses

contenttype: string

Content MIME type ( RFC 2045)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

date: integer (int64)

Designated date and time as a Unix time stamp (defaults to current date and time on creation)

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

mailbox: integer 0, 1, 2, 3, 4, 5, 6, 7 0

Type (0=INBOX, 1=DRAFTS, 2=SENT, 3=TEMPLATES, 4=MAILINGS, 5=ARCHIVE, 6=TRASH, 7=JUNK)

mailinglist: integer (int32)

Mailing list ID

mailserver: integer (int32)

Mail server ID

opportunity: integer (int32)

Opportunity ID; is mutually exclusive to ticket

ownergroup: integer (int32)

Owner group ID (PUBLIC if owneruser=null and ownergroup=null)

owneruser: integer (int32)

Owner user ID (PUBLIC if owneruser=null and ownergroup=null)

reference: integer (int32)

Reference message (reply-to) ID; must be distinct from ID

senddate: integer (int64)

Scheduled send date and time as a Unix time stamp

sender: string

Sender name and e-mail address

sender_email: string (email)

Sender e-mail address

sender_name: string

Sender name

senderror: string

Last error message from failure to send

size: integer (int32) x ≥ 0 0

Size in bytes

subject: string

Subject

text: string

Plain text version of content

ticket: integer (int32)

Ticket ID; is mutually exclusive to opportunity

to: string

All regular recipient names and e-mail addresses

to_count: integer (int32) x ≥ 0 0

Number of regular recipients

to_email: string (email)

First regular recipient e-mail address

to_name: string

First regular recipient name

verified: integer 0, 1 0

Verified sender e-mail address

Example
{
  "ID": 1,
  "attachments": [
    "string"
  ],
  "bcc": "John Doe <john.doe@company.com>, Johnny <johnny_d@personal.com>",
  "cc": "John Doe <john.doe@company.com>, Johnny <johnny_d@personal.com>",
  "contenttype": "text/plain",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "lastmodified": 872838840,
  "mailbox": "integer",
  "mailinglist": "integer (int32)",
  "mailserver": 7,
  "opportunity": "integer (int32)",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "reference": "integer (int32)",
  "senddate": "integer (int64)",
  "sender": "John Doe <john.doe@company.com>",
  "sender_email": "john.doe@company.com",
  "sender_name": "John Doe",
  "senderror": "I am afraid I can't do that Dave!",
  "size": 12,
  "subject": "Re: Hello World!",
  "text": "Hello World!",
  "ticket": "integer (int32)",
  "to": "John Doe <john.doe@company.com>, Johnny <johnny_d@personal.com>",
  "to_count": 2,
  "to_email": "john.doe@company.com",
  "to_name": "John Doe",
  "verified": "integer"
}

meta-field:

Example

meta-object: object

Meta data field and value pairs

Example
{
  "meta_field1": "value",
  "meta_field2": "value"
}

notes: object

ID: integer (int32)

Note ID

assigneduser: integer (int32)

Assigned user ID

attachments: string[]

Attachments (filenames)

string
binfile: binfile-field
contenttype: string

Content MIME type ( RFC 2045)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

description: string

Detailed general description

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Name

ownergroup: integer (int32)

Owner group ID (PUBLIC if owneruser=null and ownergroup=null)

owneruser: integer (int32)

Owner user ID (PUBLIC if owneruser=null and ownergroup=null)

size: integer (int32) x ≥ 0 0

Size in bytes

text: string

Plain text version of content

visibility: integer 0, 1, 2 0

Visibility (0=REGULAR, 1=ARCHIVED, 2=DELETED)

Example
{
  "ID": 1,
  "assigneduser": 6,
  "attachments": [
    "string"
  ],
  "contenttype": "text/plain",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Note",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "size": 12,
  "text": "Hello World!",
  "visibility": "integer"
}

objects: object

ID: integer (int32)

Object ID

assigneduser: integer (int32)

Assigned user ID

binfile: binfile-field
creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

data:
description: string

Detailed general description

entity: string (at least 1 chars)

Custom entity

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Name

ownergroup: integer (int32)

Owner group ID (PUBLIC if owneruser=null and ownergroup=null)

owneruser: integer (int32)

Owner user ID (PUBLIC if owneruser=null and ownergroup=null)

visibility: integer 0, 1, 2 0

Visibility (0=REGULAR, 1=ARCHIVED, 2=DELETED)

Example
{
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "entity": "my_custom_entity",
  "lastmodified": 872838840,
  "name": "My Object",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "visibility": "integer"
}

opportunities: object

ID: integer (int32)

Opportunity ID

account: integer (int32)

Account ID

assigneduser: integer (int32)

Assigned user ID

campaign: integer (int32)

Campaign ID

contact: integer (int32)

Contact ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

description: string

Detailed general description

duedate: integer (int64)

Due date as a Unix time stamp

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

mostlikely: number (double) x ≥ 0 0

Most likely monetary outcome

name: string (at least 1 chars)

Name

opportunitynum: string

Opportunity number

ownergroup: integer (int32)

Owner group ID (null=PUBLIC)

priority: integer 0, 1, 2, 3, 4 2

Priority (0=LOWEST, 1=LOW, 2=MEDIUM, 3=HIGH, 4=HIGHEST)

probability: integer 0 ≤ x ≤ 100 0

Probability of success in percent; must be 100 for ACCEPTED

status: integer 0, 1, 2, 3, 4, 5, 6 0

Status (0=UNEVALUATED, 1=ELIGIBLE, 2=FEEDBACKREQUIRED, 3=INNEGOTIATION, 4=OFFERED, 5=ACCEPTED, 6=REJECTED)

upside: number (double) x ≥ 0 0

Upside monetary outcome

visibility: integer 0, 1, 2 0

Visibility (0=REGULAR, 1=ARCHIVED, 2=DELETED)

worstcase: number (double) x ≥ 0 0

Worst-case monetary outcome

Example
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "campaign": "integer (int32)",
  "contact": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "duedate": "integer (int64)",
  "lastmodified": 872838840,
  "mostlikely": "number (double)",
  "name": "My Opportunity",
  "opportunitynum": "O-123456",
  "ownergroup": "integer (int32)",
  "priority": "integer",
  "probability": "integer",
  "status": "integer",
  "upside": "number (double)",
  "visibility": "integer",
  "worstcase": "number (double)"
}

participants: object

ID: integer (int64)

Particpants ID

campaign: integer (int32)

Campaign ID ( dependency); is mutually exclusive to mailinglist (either one is required)

contact: integer (int32)

Contact ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

email: string (email)

E-mail address

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

mailinglist: integer (int32)

Mailing list ID ( dependency); is mutually exclusive to campaign (either one is required)

name: string (at least 1 chars)

Name

phone: string

Phone number

Example
{
  "ID": 1,
  "campaign": "integer (int32)",
  "contact": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "email": "john.doe@company.com",
  "lastmodified": 872838840,
  "mailinglist": 7,
  "name": "John Doe",
  "phone": "+1 123-456-7890"
}

payments: object

ID: integer (int64)

Payment ID

account: integer (int32)

Account ID; is mutually exclusive to transaction

amount: number (double)

Amount (monetary); must not be zero

assigneduser: integer (int32)

Assigned user ID

autoadvance: integer 0, 1 0

Auto-advance to next transaction

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

date: integer (int64)

Designated date and time as a Unix time stamp (defaults to current date and time on creation)

description: string

Detailed general description

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

ledger: integer (int32)

Ledger ID

ownergroup: integer (int32)

Owner group ID (null=PUBLIC)

status: integer 0, 1, 2, 3 0

Status (0=DRAFT, 1=COMPLETED, 2=CANCELLED, 3=BOOKED)

subject: string

Subject (e.g. bank statement or reference number)

transaction: integer (int32)

Transaction ID; is mutually exclusive to account

Example
{
  "ID": 1,
  "account": "integer (int32)",
  "amount": 199.99,
  "assigneduser": 6,
  "autoadvance": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "description": "string",
  "lastmodified": 872838840,
  "ledger": "integer (int32)",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "subject": "Ref. P12345X67890",
  "transaction": 7
}

permissions: object

ID: integer (int64)

Permission ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

group: integer (int32)

Group ID

identifier: string

Permission identifier

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

writable: integer 0, 1 0

Allow writing of permission-specific data by group members

Example
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "group": 7,
  "identifier": "my_permission",
  "lastmodified": 872838840,
  "writable": "integer"
}

pricelists: object

ID: integer (int32)

Price list ID

activity: integer 0, 1, 2 0

Activity (0=ACTIVE, 1=DEACTIVATED, 2=DELETED)

applytoall: integer 0, 1 0

Apply to all accounts regardless of association via pricelists2accounts

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

currency: string

Currency code ( ISO 4217)

datefrom: integer (int64)

Start date as a Unix time stamp; must be less than or equal to dateto

dateto: integer (int64)

End date as a Unix time stamp; must be greater than or equal to datefrom

description: string

Detailed general description

discount: number (double) -100 ≤ x ≤ 100 0

Default relative discount in percent

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Name

ownergroup: integer (int32)

Owner group ID (null=PUBLIC)

type: integer 0, 1, 2, 3 0

Price list type (0=BILLING_MIN, 1=BILLING_MAX, 2=PROCUREMENT_MIN, 3=PROCUREMENT_MAX)

Example
{
  "ID": 1,
  "activity": "integer",
  "applytoall": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "description": "string",
  "discount": "number (double)",
  "lastmodified": 872838840,
  "name": "My Price List",
  "ownergroup": "integer (int32)",
  "type": "integer"
}

pricelists2accounts: object

ID: integer (int64)

Pricelist-to-account ID

account: integer (int32)

Account ID ( dependency)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

pricelist: integer (int32)

Price list ID ( dependency)

Example
{
  "ID": 1,
  "account": 13,
  "creationdate": 872838840,
  "creator": 6,
  "pricelist": 7
}

prices: object

ID: integer (int64)

Price ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

discount: number (double) -100 ≤ x ≤ 100

Relative discount in percent (applied after rebate; null=pricelist.discount)

item: integer (int32)

Item ID ( dependency)

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

minamount: number (double) x ≥ 0 0

Minimum amount (quantity)

price: number (double) x ≥ 0

Price per unit (null=item.sellingprice for billing or null=item.purchaseprice for procurement)

pricelist: integer (int32)

Price list ID ( dependency)

rebate: number (double) x ≥ 0

Absolute rebate per unit (applied before discount)

Example
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "discount": "number (double)",
  "item": 7,
  "lastmodified": 872838840,
  "minamount": "number (double)",
  "price": "number (double)",
  "pricelist": 13,
  "rebate": "number (double)"
}

projects: object

ID: integer (int32)

Project ID

account: integer (int32)

Account ID

assigneduser: integer (int32)

Assigned user ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

description: string

Detailed general description

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Name

ownergroup: integer (int32)

Owner group ID (PUBLIC if owneruser=null and ownergroup=null)

owneruser: integer (int32)

Owner user ID (PUBLIC if owneruser=null and ownergroup=null)

projectnum: string

Project number

status: integer 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 0

Status (0=DRAFT, 1=NOTSTARTED, 2=AWAITINGAPPROVAL, 3=APPROVED, 4=DISMISSED, 5=ACTIVE, 6=INACTIVE, 7=TESTING, 8=CANCELLED, 9=COMPLETED, 10=FAILED, 11=BOOKED)

visibility: integer 0, 1, 2 0

Visibility (0=REGULAR, 1=ARCHIVED, 2=DELETED)

Example
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Project",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "projectnum": "P-123456",
  "status": "integer",
  "visibility": "integer"
}

records: object

ID: integer (int64)

Record ID

assigneduser: integer (int32)

Assigned user (recipient) ID; must be distinct from creator

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

date: integer (int64)

Designated date and time as a Unix time stamp (defaults to current date and time on creation)

entity: string accounts, actionsteps, applications, appointments, campaigns, contacts, contracts, coupons, davservers, devices, dunning, feedservers, groups, items, ledgers, links, mailinglists, mailservers, messages, notes, objects, opportunities, payments, pricelists, projects, resources, services, storages, tasks, tickets, transactions, users, weblets

Canonical entity

flag: integer 0, 1, 2, 4 0

Flag (0=REGULAR, 1=ASSOCONLY, 2=MINDLOGONLY, 3=MONITOR); must be REGULAR if entity is null

index: integer (int32)

Entity ID; is required if entity is not null, otherwise must be null

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

meta: meta-field
ownergroup: integer (int32)

Owner group ID (PUBLIC if owneruser=null and ownergroup=null)

owneruser: integer (int32)

Owner user ID (PUBLIC if owneruser=null and ownergroup=null)

sender: string

Sender

text: string

Record text ( Markdown for rich text representation)

Example
{
  "ID": 1,
  "assigneduser": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "entity": "string",
  "flag": "integer",
  "index": "integer (int32)",
  "lastmodified": 872838840,
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "sender": "John Doe",
  "text": "This is my record!"
}

request-accounts:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "assigneduser": 6,
  "contact": 7,
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "customernum": "C-123456",
  "description": "string",
  "excludetax": "integer",
  "firstname": "John",
  "lastmodified": 872838840,
  "lastname": "Doe",
  "locked": "integer",
  "ownergroup": "integer (int32)",
  "suppliernum": "S-123456",
  "taxid": "DE123456789",
  "type": "integer",
  "visibility": "integer"
}

request-actionsteps:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "account": "integer (int32)",
  "actionnum": "A-123456",
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "description": "string",
  "duedate": "integer (int64)",
  "effort": "number (int32)",
  "lastmodified": 872838840,
  "name": "My Action Step",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "status": "integer",
  "task": 7,
  "ticket": "integer (int32)",
  "transaction": "integer (int32)"
}

request-appointments:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "assigneduser": 6,
  "color": "string",
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": 872838840,
  "daterecurrence": "integer (int64)",
  "dateto": 872842440,
  "davserver": 7,
  "description": "string",
  "interval": "integer",
  "lastmodified": 872838840,
  "location": "Office",
  "name": "My Appointment",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recurrence": "integer",
  "visibility": "integer"
}

request-campaigns:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Campaign",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "visibility": "integer"
}

request-contacts:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "address": "123 Main St.",
  "assigneduser": 6,
  "birthdate": "integer (int64)",
  "cell": "+1 123-456-7892",
  "city": "Anytown",
  "company": "Any Company, Inc.",
  "country": "US",
  "creationdate": 872838840,
  "creator": 6,
  "davserver": 7,
  "department": "Research & Development",
  "description": "string",
  "email": "john.doe@company.com",
  "email2": "johnny_d@personal.com",
  "fax": "+1 123-456-7893",
  "firstname": "John",
  "lastmodified": 872838840,
  "lastname": "Doe",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "phone": "+1 123-456-7890",
  "phone2": "+1 123-456-7891",
  "position": "CTO",
  "postalcode": "95060",
  "region": "CA",
  "title": "Dr.",
  "type": "integer",
  "visibility": "integer",
  "website": "http://www.company.com/about/john_doe"
}

request-contracts:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "billingcycle": "integer",
  "calculation": "integer",
  "contractnum": "N-123456",
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "datecancel": "integer (int64)",
  "datefrom": 872838840,
  "dateto": "integer (int64)",
  "description": "string",
  "exchangerate": "number (double)",
  "lastbilling": "integer (int64)",
  "lastmodified": 872838840,
  "name": "My Contract",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "visibility": "integer"
}

request-couponcodes:

Example
{
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "code": "XMAX17",
  "coupon": 7,
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "flag": "integer",
  "lastmodified": 872838840,
  "transaction": "integer (int32)",
  "value": "number (double)"
}

request-coupons:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "activity": "integer",
  "code": "XMAX17",
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "description": "string",
  "foreigntaxrates": {
    "AT": 21,
    "DE": 19
  },
  "lastmodified": 872838840,
  "name": "My Coupon",
  "neutral": "integer",
  "ownergroup": "integer (int32)",
  "taxrate": "number (double)",
  "type": "integer",
  "value": "number (double)"
}

request-davservers:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "activity": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "ctag": "\"73c5fdd17f180f2126995666b7edc0e3\"",
  "description": "string",
  "lastmodified": 872838840,
  "name": "My DAV Server",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recipientgroup": "integer (int32)",
  "recipientuser": "integer (int32)",
  "synctoken": "http://dav.company.com/sync/1234",
  "type": "integer",
  "url": "https://dav.company.com/collection",
  "username": "john.doe"
}

request-devices:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "chargenum": "LOT-123456",
  "contract": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "expdate": "integer (int64)",
  "item": 7,
  "lastmodified": 872838840,
  "ownergroup": "integer (int32)",
  "serialnum": "S-123456",
  "visibility": "integer"
}

request-dunning:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "account": 7,
  "address": "123 Main St.",
  "assigneduser": 6,
  "city": "Anytown",
  "country": "US",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "duedate": "integer (int64)",
  "dunningnum": "D-0117.12345",
  "fee": "number (double)",
  "lastmodified": 872838840,
  "ownergroup": "integer (int32)",
  "postalcode": "95060",
  "recipient": "Bad Customer, Inc.",
  "region": "CA",
  "status": "integer",
  "type": 1
}

request-feedservers:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "activity": "integer",
  "channel": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "etag": "\"73c5fdd17f180f2126995666b7edc0e3\"",
  "lastmodified": 872838840,
  "name": "My Feed Server",
  "notify": "integer",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recipientgroup": "integer (int32)",
  "recipientuser": "integer (int32)",
  "url": "http://www.website.com/feed.rss",
  "username": "john.doe"
}

request-items:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "applicability": "integer",
  "barcode": "501234567890",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "forcestock": "integer",
  "foreigntaxrates": {
    "AT": 21,
    "DE": 19
  },
  "itemnum": "I-123456",
  "lastmodified": 872838840,
  "manufacturer": "My Company, Inc.",
  "model": "integer (int32)",
  "name": "My Product",
  "ownergroup": "integer (int32)",
  "purchaseprice": "number (double)",
  "sellingprice": "number (double)",
  "taxrate": "number (double)",
  "type": "integer",
  "unit": "string",
  "visibility": "integer",
  "weight": "number (double)"
}

request-ledgers:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "Credit Suisse #12345",
  "ownergroup": "integer (int32)",
  "visibility": "integer"
}

request-list: object

count: boolean

Return number of results only (fields, sort, limit, offset and expand have no effect)

distinct: boolean

Return distinct result set

expand: string[]

Expand content of composite fields (binfile, json or array)

string
export: boolean

Export result as CSV file (type text/csv, delimiter ;) with unbounded limit (admin)

fields: object

Select specified fields only; use optional alias as object key

filter: object

Eliminate results that do not match specified filter criteria

limit: integer 1 ≤ x ≤ 10000 1000

Limit to total number of results (defaults to 1000, unless export is true)

offset: integer (int64) 0

Return results forward from specified offset only

query: string

Eliminate results that do not match specified query search pattern

sort: string[]

Return sorted results by specified order of fields; use the minus sign (-) as a prefix to sort by a field in descending instead of ascending order (default)

string
Example
{
  "count": "boolean",
  "distinct": "boolean",
  "expand": [
    "field_binfile",
    "field_json",
    "field_array"
  ],
  "export": "boolean",
  "fields": {
    "0": "field1",
    "1": "field2",
    "alias": "field3"
  },
  "filter": "object",
  "limit": 100,
  "offset": "integer (int64)",
  "query": "list of search terms",
  "sort": [
    "field1_asc",
    "field2_asc",
    "-field3_desc"
  ]
}

request-mailinglists:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "assigneduser": 6,
  "campaign": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Mailing List",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "sender": "John Doe <john.doe@company.com>",
  "visibility": "integer"
}

request-mailservers:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "activity": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Mail Server",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recipientgroup": "integer (int32)",
  "recipientuser": "integer (int32)",
  "sender": "John Doe <john.doe@company.com>",
  "serverin": "imap.company.com:143/tls",
  "serverout": "smtp.company.com:587/tls",
  "usernamein": "john.doe",
  "usernameout": "john.doe"
}

request-messages:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "attachments": [
    "string"
  ],
  "bcc": "John Doe <john.doe@company.com>, Johnny <johnny_d@personal.com>",
  "cc": "John Doe <john.doe@company.com>, Johnny <johnny_d@personal.com>",
  "contenttype": "text/plain",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "lastmodified": 872838840,
  "mailbox": "integer",
  "mailinglist": "integer (int32)",
  "mailserver": 7,
  "opportunity": "integer (int32)",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "reference": "integer (int32)",
  "senddate": "integer (int64)",
  "sender": "John Doe <john.doe@company.com>",
  "sender_email": "john.doe@company.com",
  "sender_name": "John Doe",
  "senderror": "I am afraid I can't do that Dave!",
  "size": 12,
  "subject": "Re: Hello World!",
  "text": "Hello World!",
  "ticket": "integer (int32)",
  "to": "John Doe <john.doe@company.com>, Johnny <johnny_d@personal.com>",
  "to_count": 2,
  "to_email": "john.doe@company.com",
  "to_name": "John Doe",
  "verified": "integer"
}

request-notes:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "assigneduser": 6,
  "attachments": [
    "string"
  ],
  "contenttype": "text/plain",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Note",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "size": 12,
  "text": "Hello World!",
  "visibility": "integer"
}

request-objects:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "entity": "my_custom_entity",
  "lastmodified": 872838840,
  "name": "My Object",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "visibility": "integer"
}

request-opportunities:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "campaign": "integer (int32)",
  "contact": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "duedate": "integer (int64)",
  "lastmodified": 872838840,
  "mostlikely": "number (double)",
  "name": "My Opportunity",
  "opportunitynum": "O-123456",
  "ownergroup": "integer (int32)",
  "priority": "integer",
  "probability": "integer",
  "status": "integer",
  "upside": "number (double)",
  "visibility": "integer",
  "worstcase": "number (double)"
}

request-participants:

Example
{
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "campaign": "integer (int32)",
  "contact": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "email": "john.doe@company.com",
  "lastmodified": 872838840,
  "mailinglist": 7,
  "name": "John Doe",
  "phone": "+1 123-456-7890"
}

request-payments:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "account": "integer (int32)",
  "amount": 199.99,
  "assigneduser": 6,
  "autoadvance": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "description": "string",
  "lastmodified": 872838840,
  "ledger": "integer (int32)",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "subject": "Ref. P12345X67890",
  "transaction": 7
}

request-pricelists:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "activity": "integer",
  "applytoall": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "description": "string",
  "discount": "number (double)",
  "lastmodified": 872838840,
  "name": "My Price List",
  "ownergroup": "integer (int32)",
  "type": "integer"
}

request-projects:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Project",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "projectnum": "P-123456",
  "status": "integer",
  "visibility": "integer"
}

request-records:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "ID": 1,
  "assigneduser": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "entity": "string",
  "flag": "integer",
  "index": "integer (int32)",
  "lastmodified": 872838840,
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "sender": "John Doe",
  "text": "This is my record!"
}

request-stocktransactions:

Example
{
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "amount": "number (double)",
  "chargenum": "LOT-123456",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "flag": "integer",
  "item": 7,
  "lastmodified": 872838840,
  "location": "B1-R2-S3",
  "purchaseprice": "number (double)",
  "reference": "SHIP-17/01-123456",
  "sellingprice": "number (double)",
  "serials": [
    "string"
  ],
  "storage": "integer (int32)",
  "subtransactions": [
    "integer (int64)"
  ],
  "transaction": "integer (int32)",
  "transfer": "integer (int64)"
}

request-storages:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Storage",
  "ownergroup": "integer (int32)",
  "visibility": "integer"
}

request-tasks:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": "integer (int64)",
  "davserver": 7,
  "description": "string",
  "duedate": "integer (int64)",
  "lastmodified": 872838840,
  "name": "My Task",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "priority": "integer",
  "project": "integer (int32)",
  "projectedeffort": "number (int32)",
  "status": "integer",
  "tasknum": "K-123456",
  "ticket": "integer (int32)",
  "visibility": "integer"
}

request-tickets:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "calculation": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "description": "string",
  "duedate": "integer (int64)",
  "lastmodified": 872838840,
  "name": "My Ticket",
  "ownergroup": "integer (int32)",
  "priority": "integer",
  "project": "integer (int32)",
  "status": "integer",
  "ticketnum": "T-123456",
  "visibility": "integer"
}

request-transactions:

Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ],
  "extdata": {
    "existing_field": "value",
    "new_field": "value"
  },
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "billingaddress": "123 Main St.",
  "billingcity": "Anytown",
  "billingcountry": "US",
  "billingpostalcode": "95060",
  "billingrecipient": "Customer, Inc.",
  "billingregion": "CA",
  "calculation": "integer",
  "contract": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "date": 872838840,
  "discount": 20,
  "duedate": "integer (int64)",
  "exchangerate": "number (double)",
  "item": "integer (int32)",
  "lastmodified": 872838840,
  "margin": 40,
  "netamount": 100,
  "ownergroup": "integer (int32)",
  "productionfactor": "integer (int32)",
  "shippingaddress": "123 Main St.",
  "shippingcity": "Anytown",
  "shippingcountry": "US",
  "shippingpostalcode": "95060",
  "shippingrecipient": "Customer, Inc.",
  "shippingregion": "CA",
  "status": "integer",
  "tax": 19,
  "taxid": "DE123456789",
  "transactionnum": "BI-0117.12345",
  "type": 3,
  "weight": "number (double)"
}

resources: object

ID: integer (int32)

Resource ID

activity: integer 0, 1, 2 0

Activity (0=ACTIVE, 1=DEACTIVATED, 2=DELETED)

application: integer (int32)

Application ID (null=STANDALONE)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

identifier: string (up to 200 chars)

Unique resource identifier

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

mimetype: string text/x-zymba

MIME type ( RFC 2045)

name: string (at least 1 chars)

Name

public: integer 0, 1 0

Publicly accessible

Example
{
  "ID": 1,
  "activity": "integer",
  "application": 7,
  "creationdate": 872838840,
  "creator": 6,
  "identifier": "my_resource",
  "lastmodified": 872838840,
  "mimetype": "string",
  "name": "My Resource",
  "public": "integer"
}

services: object

ID: integer (int32)

Service ID

activity: integer 0, 1, 2 0

Activity (0=ACTIVE, 1=DEACTIVATED, 2=DELETED)

application: integer (int32)

Application ID (null=STANDALONE)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

entity: string

Canonical entity (only for AFTERCREATION, BEFOREMODIFICATION, AFTERMODIFICATION, AFTERCREATIONORMODIFICATION, BEFOREDELETION or AFTERDELETION)

identifier: string (up to 200 chars)

Unique service identifier

interval: integer 1 ≤ x ≤ 1440 1

Interval in minutes (only for TIMING)

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

mimetype: string application/ixml+xml, text/x-zymba text/x-zymba

MIME type ( RFC 2045)

name: string (at least 1 chars)

Name

schedule: integer (int32) x ≥ 0 0

Schedule as a minute of each day (only for TIMING)

type: integer 0, 1, 2, 3, 4, 5, 6, 7

Service type (0=TIMING, 1=REMOTECALL, 2=AFTERCREATION, 3=BEFOREMODIFICATION, 4=AFTERMODIFICATION, 5=AFTERCREATIONORMODIFICATION, 6=BEFOREDELETION, 7=AFTERDELETION)

Example
{
  "ID": 1,
  "activity": "integer",
  "application": 7,
  "creationdate": 872838840,
  "creator": 6,
  "entity": "notes",
  "identifier": "my_service",
  "interval": "integer",
  "lastmodified": 872838840,
  "mimetype": "string",
  "name": "My Service",
  "schedule": "integer (int32)",
  "type": 5
}

stocktransactions: object

ID: integer (int64)

Stock transaction ID

amount: number (double) 0

Amount (quantity); must not be zero (greater than zero if transfer is not null)

chargenum: string

Charge (lot) number

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

date: integer (int64)

Designated date and time as a Unix time stamp (defaults to current date and time on creation)

flag: integer 0, 1, 2 0

Flag (0=BOOKED, 1=RESERVED, 2=CANCELLED)

item: integer (int32)

Item ID ( dependency)

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

location: string

Physical location (e.g. shelf identification)

purchaseprice: number (double) 0

Purchase price per unit

reference: string

Reference identification

sellingprice: number (double) 0

Selling price per unit

serials: string[]

Serial numbers

string
storage: integer (int32)

Storage ID

subtransactions: integer[]

Sub-transaction IDs

integer (int64)
transaction: integer (int32)

Transaction ID

transfer: integer (int64)

Transfer stock transaction ID; must be distinct from ID and null for RESERVED

Example
{
  "ID": 1,
  "amount": "number (double)",
  "chargenum": "LOT-123456",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "flag": "integer",
  "item": 7,
  "lastmodified": 872838840,
  "location": "B1-R2-S3",
  "purchaseprice": "number (double)",
  "reference": "SHIP-17/01-123456",
  "sellingprice": "number (double)",
  "serials": [
    "string"
  ],
  "storage": "integer (int32)",
  "subtransactions": [
    "integer (int64)"
  ],
  "transaction": "integer (int32)",
  "transfer": "integer (int64)"
}

storages: object

ID: integer (int32)

Storage ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

description: string

Detailed general description

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Name

ownergroup: integer (int32)

Owner group ID (null=PUBLIC)

visibility: integer 0, 1, 2 0

Visibility (0=REGULAR, 1=ARCHIVED, 2=DELETED)

Example
{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Storage",
  "ownergroup": "integer (int32)",
  "visibility": "integer"
}

suppliers: object

ID: integer (int64)

Supplier ID

account: integer (int32)

Account ID ( dependency)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

deliverytime: integer 0 ≤ x ≤ 32767

Expected delivery time in days

item: integer (int32)

Item ID ( dependency)

itemnum: string

Supplier item number (SKU)

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

minamount: number (double) x ≥ 0 0

Minimum order amount (quantity)

price: number (double) x ≥ 0

Supplier price per unit

stock: number (double)

Expected stock/inventory amount (quantity)

Example
{
  "ID": 1,
  "account": 13,
  "creationdate": 872838840,
  "creator": 6,
  "deliverytime": "integer",
  "item": 7,
  "itemnum": "EXTERNAL-123456",
  "lastmodified": 872838840,
  "minamount": "number (double)",
  "price": "number (double)",
  "stock": 100
}

tags-field: object

tags: string[]

Tags to reset; remove all existing and add new tags (only for PUT or PATCH)

string
+tags: string[]

Tags to add; ignore existing (only for PUT or PATCH)

string
-tags: string[]

Tags to remove; ignore non-existing (only for PUT or PATCH)

string
Example
{
  "tags": [
    "New Tag"
  ],
  "+tags": [
    "New Tag"
  ],
  "-tags": [
    "Obsolete Tag"
  ]
}

tasks: object

ID: integer (int32)

Task ID

assigneduser: integer (int32)

Assigned user ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

datefrom: integer (int64)

Start date and time as a Unix time stamp

davserver: integer (int32)

DAV server ID

description: string

Detailed general description

duedate: integer (int64)

Due date and time as a Unix time stamp

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Name

ownergroup: integer (int32)

Owner group ID (PUBLIC if owneruser=null and ownergroup=null)

owneruser: integer (int32)

Owner user ID (PUBLIC if owneruser=null and ownergroup=null)

priority: integer 0, 1, 2, 3, 4 2

Priority (0=LOWEST, 1=LOW, 2=MEDIUM, 3=HIGH, 4=HIGHEST)

project: integer (int32)

Project ID; is mutually exclusive to ticket

projectedeffort: number (int32) x ≥ 0 0

Projected effort in minutes

status: integer 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 0

Status (0=NOTSTARTED, 1=AWAITINGACCEPTANCE, 2=ACCEPTED, 3=REJECTED, 4=ACTIVE, 5=INACTIVE, 6=FEEDBACKREQUIRED, 7=TESTING, 8=CANCELLED, 9=COMPLETED, 10=FAILED, 11=BOOKED)

tasknum: string

Task number

ticket: integer (int32)

Ticket ID; is mutually exclusive to project

visibility: integer 0, 1, 2 0

Visibility (0=REGULAR, 1=ARCHIVED, 2=DELETED)

Example
{
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": "integer (int64)",
  "davserver": 7,
  "description": "string",
  "duedate": "integer (int64)",
  "lastmodified": 872838840,
  "name": "My Task",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "priority": "integer",
  "project": "integer (int32)",
  "projectedeffort": "number (int32)",
  "status": "integer",
  "tasknum": "K-123456",
  "ticket": "integer (int32)",
  "visibility": "integer"
}

tickets: object

ID: integer (int32)

Ticket ID

account: integer (int32)

Account ID; is mutually exclusive to project

assigneduser: integer (int32)

Assigned user ID

billingitems: items-field
calculation: integer 0, 1, 2 0

Calculation method (0=NET, 1=GROSS, 2=LEGACY)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

date: integer (int64)

Designated date and time as a Unix time stamp (defaults to current date and time on creation)

description: string

Detailed general description

duedate: integer (int64)

Due date and time as a Unix time stamp

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Name

ownergroup: integer (int32)

Owner group ID (null=PUBLIC)

priority: integer 0, 1, 2, 3, 4 2

Priority (0=LOWEST, 1=LOW, 2=MEDIUM, 3=HIGH, 4=HIGHEST)

procurementitems: items-field
project: integer (int32)

Project ID; is mutually exclusive to account

status: integer 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 0

Status (0=NOTSTARTED, 1=AWAITINGACCEPTANCE, 2=ACCEPTED, 3=REJECTED, 4=ACTIVE, 5=INACTIVE, 6=FEEDBACKREQUIRED, 7=TESTING, 8=CANCELLED, 9=COMPLETED, 10=FAILED, 11=BOOKED)

ticketnum: string

Ticket number

visibility: integer 0, 1, 2 0

Visibility (0=REGULAR, 1=ARCHIVED, 2=DELETED)

Example
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "calculation": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "description": "string",
  "duedate": "integer (int64)",
  "lastmodified": 872838840,
  "name": "My Ticket",
  "ownergroup": "integer (int32)",
  "priority": "integer",
  "project": "integer (int32)",
  "status": "integer",
  "ticketnum": "T-123456",
  "visibility": "integer"
}

transactions: object

ID: integer (int32)

Transaction ID

account: integer (int32)

Account ID; must be null for PRODUCTION

assigneduser: integer (int32)

Assigned user ID

billingaddress: string

Billing address (street and building/suite number)

billingcity: string

Billing city or municipality

billingcountry: string

Billing country code ( ISO 3166-1 alpha-2)

billingpostalcode: string

Billing postal or ZIP code

billingrecipient: string

Billing recipient

billingregion: string

Billing region or state

calculation: integer 0, 1, 2 0

Calculation method (0=NET, 1=GROSS, 2=LEGACY)

contract: integer (int32)

Contract ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

currency: string

Currency code ( ISO 4217)

date: integer (int64)

Designated date and time as a Unix time stamp (defaults to current date and time on creation)

discount: number (double)

Total absolute discount

duedate: integer (int64)

Due date as a Unix time stamp

exchangerate: number (double) x ≥ 0 1

Exchange rate as a multiple of one monetary unit of the fixed system currency

item: integer (int32)

Item ID; is required for PRODUCTION, otherwise must be null

items: items-field
lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

margin: number (double)

Total absolute margin

netamount: number (double)

Total net amount

ownergroup: integer (int32)

Owner group ID (null=PUBLIC)

productionfactor: integer (int32) x ≥ 0

Production factor; is required for PRODUCTION, otherwise must be null

shippingaddress: string

Shipping address (street and building/suite number)

shippingcity: string

Shipping city or municipality

shippingcountry: string

Shipping country code ( ISO 3166-1 alpha-2)

shippingpostalcode: string

Shipping postal or ZIP code

shippingrecipient: string

Shipping recipient

shippingregion: string

Shipping region or state

status: integer 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23 0

Status (0=DRAFT, 1=BOOKED, 2=HOLD, 3=CANCELLED, 4=CLOSED, 5=PARTLYORDERED, 6=PARTLYORDERED_CANCELLED, 7=PARTLYORDERED_CLOSED, 8=ORDERED, 9=PARTLYDELIVERED, 10=PARTLYDELIVERED_CANCELLED, 11=PARTLYDELIVERED_CLOSED, 12=DELIVERED, 13=PARTLYINVOICED, 14=PARTLYINVOICED_CANCELLED, 15=PARTLYINVOICED_CLOSED, 16=INVOICED, 17=PARTLYPAID, 18=PARTLYPAID_CANCELLED, 19=PARTLYPAID_CLOSED, 20=PAID, 21=OVERPAID, 22=PROCESSED, 23=PROCESSED_CANCELLED)

tax: number (double)

Total tax amount

taxid: string

Tax ID (e.g. VATIN or SSN)

transactionnum: string (at least 1 chars)

Transaction number

type: integer 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 0

Transaction type (0=BILLING_QUOTE, 1=BILLING_ORDER, 2=BILLING_DELIVERY, 3=BILLING_INVOICE, 4=BILLING_CREDIT, 5=PROCUREMENT_REQUEST, 6=PROCUREMENT_ORDER, 7=PROCUREMENT_DELIVERY, 8=PROCUREMENT_INVOICE, 9=PROCUREMENT_CREDIT, 10=PRODUCTION_FABRICATION, 11=PRODUCTION_DISASSEMBLY)

weight: number (double) x ≥ 0 0

Total shipping weight in kilogram

Example
{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "billingaddress": "123 Main St.",
  "billingcity": "Anytown",
  "billingcountry": "US",
  "billingpostalcode": "95060",
  "billingrecipient": "Customer, Inc.",
  "billingregion": "CA",
  "calculation": "integer",
  "contract": "integer (int32)",
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "date": 872838840,
  "discount": 20,
  "duedate": "integer (int64)",
  "exchangerate": "number (double)",
  "item": "integer (int32)",
  "lastmodified": 872838840,
  "margin": 40,
  "netamount": 100,
  "ownergroup": "integer (int32)",
  "productionfactor": "integer (int32)",
  "shippingaddress": "123 Main St.",
  "shippingcity": "Anytown",
  "shippingcountry": "US",
  "shippingpostalcode": "95060",
  "shippingrecipient": "Customer, Inc.",
  "shippingregion": "CA",
  "status": "integer",
  "tax": 19,
  "taxid": "DE123456789",
  "transactionnum": "BI-0117.12345",
  "type": 3,
  "weight": "number (double)"
}

users: object

ID: integer (int32)

User ID

activity: integer 0, 1, 2 0

Activity (0=ACTIVE, 1=DEACTIVATED, 2=DELETED)

apionly: integer 0, 1 0

Restricted to API access, no regular login

contact: integer (int32)

Contact ID

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

email: string (email)

System e-mail address (case-insensitively unique)

expdate: integer (int64)

Expiry date and time as a Unix time stamp

lastlogin: integer (int64)

Last login date and time as a Unix time stamp

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

name: string (at least 1 chars)

Username (case-insensitively unique)

nopublic: integer 0, 1 0

Deny access to public data

Example
{
  "ID": 1,
  "activity": "integer",
  "apionly": "integer",
  "contact": 7,
  "creationdate": 872838840,
  "creator": 6,
  "email": "john.doe@company.com",
  "expdate": "integer (int64)",
  "lastlogin": 872838840,
  "lastmodified": 872838840,
  "name": "john.doe",
  "nopublic": "integer"
}

weblets: object

ID: integer (int32)

Weblet ID

activity: integer 0, 1, 2 0

Activity (0=ACTIVE, 1=DEACTIVATED, 2=DELETED)

application: integer (int32)

Application ID (null=STANDALONE)

color: string

Color code (CSS-style hexadecimal without #)

creationdate: integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

creator: integer (int32)

Creator user ID (defaults to authenticated user on creation)

height: integer 0 ≤ x ≤ 32767 0

Height in pixels (0=100%)

identifier: string (up to 200 chars)

Unique weblet identifier

langaliases: object

Language-specific aliases; use language code as object key

lastmodified: integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

mimetype: string application/ixml+xml, text/x-zymba text/x-zymba

MIME type ( RFC 2045)

name: string (at least 1 chars)

Name

svgpath: string

SVG path for icon (square)

type: integer 0, 1, 2, 3, 4, 5, 6, 7 0

Weblet type (0=INTEGRATED, 1=STANDALONE, 2=DETACHED, 3=POPUP_FRAMED, 4=POPUP_PLAIN, 5=EMBEDDED_FRAMED, 6=EMBEDDED_COLLAPSED, 7=EMBEDDED_PLAIN)

view: string

Canonical view

width: integer 0 ≤ x ≤ 32767 0

Width in pixels (0=100%)

Example
{
  "ID": 1,
  "activity": "integer",
  "application": 7,
  "color": "string",
  "creationdate": 872838840,
  "creator": 6,
  "height": "integer",
  "identifier": "my_weblet",
  "langaliases": {
    "de_DE": "Mein neues Weblet",
    "en_US": "My new Weblet"
  },
  "lastmodified": 872838840,
  "mimetype": "string",
  "name": "My Weblet",
  "svgpath": "string",
  "type": "integer",
  "view": "notes.index",
  "width": "integer"
}
Documentation by Spectacle