API docs by Redocly

Excellent Books REST API (1.0.34)

Download OpenAPI specification:

REST API for Excellent Books ERP system by Excellent Business Solutions.

Available Registers

Complete list of all available registers and their fields: Standard Booksi registrite loetelu

For more documentation, visit the ERA Confluence Space.

Authentication

HTTP Basic Authentication

Encode username:password in Base64 for the Authorization header.

Important: Using Basic Auth on every request creates significant server load. We strongly recommend using cookie-based sessions after the initial authentication.

How it works:

  1. Make one request with Basic Auth credentials
  2. Server returns HSESSION cookie in the response
  3. Use this cookie for all subsequent requests (no Basic Auth needed)
  4. Session remains valid for the configured timeout period (e.g., 24 hours)

Server Configuration Required:

  • Module General > Settings > Optional Features (2nd tab): Ensure Do not allow Web API sessions is NOT checked
  • Module Technical > Registers > Program Settings > Web tab:
    • Max Sessions: Set to a value greater than 0 (e.g., 25)
    • Timeout, minutes: Set session duration (e.g., 1440 for 24 hours)

Example - Initial authentication request:

curl -X GET "https://YOUR-SERVER:PORT/api/1/" \
  -H "Authorization: Basic BASE64_CREDENTIALS" \
  -H "Accept: application/json" -c cookies.txt

Response includes: Set-Cookie: HSESSION=CC1AC3C5-DAC9C590-DA4FD41F-1E820CB7-C1713CC8

Example - Subsequent requests using session cookie:

curl -X GET "https://YOUR-SERVER:PORT/api/1/TRVc" \
  -H "Accept: application/json" \
  -H "Cookie: HSESSION=CC1AC3C5-DAC9C590-DA4FD41F-1E820CB7-C1713CC8"

Benefits:

  • Significantly reduced server load
  • Improved Excellent Books stability
  • Better performance for high-frequency integrations

Response Formats

  • Default: XML
  • JSON: Add header Accept: application/json

Common Query Parameters

All register endpoints support:

  • fields - Comma-separated list of fields to return
  • sort - Field to sort by (required when using range)
  • range - Record range using sort field values (requires sort), e.g., range=104:110
  • limit - Maximum number of records to return
  • offset - Number of records to skip (for pagination with limit)
  • updates_after - Get records modified after sequence number (Base registers only)
  • deletes_after - Get deleted record IDs after sequence number (Base registers only)
  • filter.FieldName - Filter records by field value, e.g., filter.Code=12

Pagination

Use offset and limit together to paginate through large result sets:

# First page (records 0-4)
https://YOUR-SERVER:PORT/api/1/IVVc?offset=0&limit=5

# Second page (records 5-9)
https://YOUR-SERVER:PORT/api/1/IVVc?offset=5&limit=5

# Third page (records 10-14)
https://YOUR-SERVER:PORT/api/1/IVVc?offset=10&limit=5

curl Examples

GET - List records

Returns only fields that contain data (empty fields are omitted).

curl -X GET "https://YOUR-SERVER:PORT/api/1/ObjVc" \
  -H "Authorization: Basic BASE64_CREDENTIALS" \
  -H "Accept: application/json"

GET - With filters

Returns all fields for each record, including empty ones.

curl -X GET "https://YOUR-SERVER:PORT/api/1/INVc?sort=Code&range=104:110&fields=Code,Name,UPrice1" \
  -H "Authorization: Basic BASE64_CREDENTIALS" \
  -H "Accept: application/json"

GET - With pagination

curl -X GET "https://YOUR-SERVER:PORT/api/1/IVVc?offset=0&limit=5" \
  -H "Authorization: Basic BASE64_CREDENTIALS" \
  -H "Accept: application/json"

POST - Create record

curl -X POST "https://YOUR-SERVER:PORT/api/1/ObjVc" \
  -H "Authorization: Basic BASE64_CREDENTIALS" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -H "Accept: application/json" \
  -d "set_field.Code=NEWOBJ&set_field.Comment=New Object Name"

POST - Create with rows

curl -X POST "https://YOUR-SERVER:PORT/api/1/IVVc" \
  -H "Authorization: Basic BASE64_CREDENTIALS" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -H "Accept: application/json" \
  -d "set_field.CustCode=C001&set_field.InvDate=2024-01-15&set_row_field.0.ArtCode=ITEM1&set_row_field.0.Quant=2&set_row_field.0.Price=100"

PATCH - Update record

curl -X PATCH "https://YOUR-SERVER:PORT/api/1/ObjVc/MYCODE" \
  -H "Authorization: Basic BASE64_CREDENTIALS" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -H "Accept: application/json" \
  -d "set_field.Comment=Updated Name"

Data Format

  • Header fields: set_field.FieldName=value
  • Row fields: set_row_field.N.FieldName=value (N = row index starting at 0)

Objects

List Objects

Retrieve objects/tags used for categorizing transactions

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

updates_after
integer

Get records modified after this sequence number

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Object

Create a new object/tag

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.Code
string
set_field.Comment
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Object by Code

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Responses

Update Object

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string
Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Items

List Items/Articles

Retrieve items from the product catalog

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

updates_after
integer

Get records modified after this sequence number

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Item

Create a new item/article.

Example request body:

set_field.Code=NEWITEM&set_field.Name=New Product&set_field.UPrice1=100.00&set_field.VATCode=22
Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get Item by Code

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Responses

Update Item

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string
Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Contacts

List Contacts

Retrieve contacts (customers and suppliers)

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

updates_after
integer

Get records modified after this sequence number

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Contact

Create a new contact (customer/supplier).

Example:

set_field.Name=New Company OÜ&set_field.CUType=1&set_field.CountryCode=EE&set_field.ExportFlag=0
Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get Contact by Code

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Responses

Update Contact

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string
Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Sales Invoices

List Sales Invoices

Retrieve sales invoices

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Sales Invoice

Create a new sales invoice with line items.

Example:

set_field.CustCode=C001&set_field.InvDate=2024-01-15&set_row_field.0.ArtCode=ITEM1&set_row_field.0.Quant=2
Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get Sales Invoice by Number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Invoice serial number

Responses

Update Sales Invoice

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer
Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Purchase Invoices

List Purchase Invoices

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Purchase Invoice

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get Purchase Invoices by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update Purchase Invoices

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Accounts

List Financial Accounts

Retrieve chart of accounts

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

updates_after
integer

Get records modified after this sequence number

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Financial Account

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Sales Orders

List Sales Orders

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Sales Order

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get Sales Orders by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update Sales Orders

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Purchase Orders

List Purchase Orders

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Purchase Order

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get Purchase Orders by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update Purchase Orders

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Goods Receipts

List Goods Receipts

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Goods Receipt

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get Goods Receipts by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update Goods Receipts

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Quotations

List Quotations

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Quotation

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get Quotations by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update Quotations

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Expenses

List Expense Reports

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Expense Report

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get Expenses by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update Expenses

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Stock Balance

Get Stock Balance

Read-only register for stock levels

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Prices

List Prices

Price list

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

updates_after
integer

Get records modified after this sequence number

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Prices

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get Prices by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update Prices

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

PaymentTerms

List PaymentTerms

Payment terms

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

updates_after
integer

Get records modified after this sequence number

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create PaymentTerms

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get PaymentTerms by Code

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Responses

Update PaymentTerms

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

CustomerClasses

List CustomerClasses

Customer classes/categories

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

updates_after
integer

Get records modified after this sequence number

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create CustomerClasses

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get CustomerClasses by Code

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Responses

Update CustomerClasses

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

ItemClasses

List ItemClasses

Item classes

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

updates_after
integer

Get records modified after this sequence number

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create ItemClasses

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get ItemClasses by Code

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Responses

Update ItemClasses

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

DeliveryAddresses

List DeliveryAddresses

Delivery addresses

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

updates_after
integer

Get records modified after this sequence number

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create DeliveryAddresses

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get DeliveryAddresses by Code

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Responses

Update DeliveryAddresses

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Employees

List Employees

Employees

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

updates_after
integer

Get records modified after this sequence number

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Employees

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get Employees by Code

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Responses

Update Employees

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

ItemClassifiers

List ItemClassifiers

Item classifiers

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

updates_after
integer

Get records modified after this sequence number

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create ItemClassifiers

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get ItemClassifiers by Code

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Responses

Update ItemClassifiers

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

SerialBalance

List SerialBalance

Serial number balance (read-only)

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

updates_after
integer

Get records modified after this sequence number

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create SerialBalance

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

ContactRelations

List ContactRelations

Contact relations

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

updates_after
integer

Get records modified after this sequence number

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create ContactRelations

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get ContactRelations by Code

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Responses

Update ContactRelations

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Users

List Users

Users/Persons

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

updates_after
integer

Get records modified after this sequence number

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Users

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get Users by Code

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Responses

Update Users

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

QuantityDiscounts

List QuantityDiscounts

Quantity discount scales

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

updates_after
integer

Get records modified after this sequence number

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create QuantityDiscounts

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get QuantityDiscounts by Code

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Responses

Update QuantityDiscounts

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

DiscountMatrices

List DiscountMatrices

Discount matrices

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

updates_after
integer

Get records modified after this sequence number

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create DiscountMatrices

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get DiscountMatrices by Code

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Responses

Update DiscountMatrices

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

StockMovements

List StockMovements

Stock movements

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create StockMovements

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get StockMovements by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update StockMovements

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

StockWriteoffs

List StockWriteoffs

Stock write-offs

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create StockWriteoffs

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get StockWriteoffs by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update StockWriteoffs

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Contracts

List Contracts

Contracts

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Contracts

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get Contracts by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update Contracts

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Budgets

List Budgets

Budgets

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Budgets

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get Budgets by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update Budgets

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

OpeningBalances

List OpeningBalances

Opening/brought forward balances

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create OpeningBalances

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get OpeningBalances by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update OpeningBalances

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

EmploymentContracts

List EmploymentContracts

Employment contracts

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create EmploymentContracts

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get EmploymentContracts by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update EmploymentContracts

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Timesheets

List Timesheets

Worked hours / Timesheets

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Timesheets

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get Timesheets by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update Timesheets

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Absences

List Absences

Absences (vacation, sick leave)

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Absences

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get Absences by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update Absences

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

OpenTransactions

List OpenTransactions

Open transactions (payroll)

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create OpenTransactions

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get OpenTransactions by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update OpenTransactions

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

GiftCards

List GiftCards

Gift cards

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create GiftCards

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get GiftCards by Code

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Responses

Update GiftCards

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

code
required
string

Code

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Receipts

List Receipts

Receipts / Payments received

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create Receipts

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get Receipts by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update Receipts

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

JournalEntries

List JournalEntries

Journal entries / Transactions

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create JournalEntries

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get JournalEntries by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update JournalEntries

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

OutgoingPayments

List OutgoingPayments

Outgoing payments

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create OutgoingPayments

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

Get OutgoingPayments by Serial number

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Responses

Update OutgoingPayments

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

sernr
required
integer

Serial number

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

ARPrepayments

List ARPrepayments

AR open prepayments (read-only)

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

sort
string
Example: sort=Code

Field to sort results by (required when using range)

range
string
Example: range=104:110

Record range using sort field values (requires sort). Format: startValue:endValue

Responses

Response samples

Content type
{
  • "data": {
    }
}

Create ARPrepayments

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

Request Body schema: application/x-www-form-urlencoded
required
set_field.FieldName
string

Header field value (replace FieldName with actual field)

set_row_field.0.FieldName
string

Row field value (0=row index, replace FieldName with actual field)

Responses

VATCodes

Get VATCodes

VAT codes

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

Responses

NumberSeries

Get NumberSeries

Number series defaults

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

Responses

Companies

Get Companies

Company register

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

Responses

CompanyData

Get CompanyData

Company data

Authorizations:
basicAuthsessionCookie
path Parameters
compcode
required
integer
Example: 1

Company code (database number)

query Parameters
fields
string
Example: fields=Code,Name,Objects

Comma-separated list of fields to return

Responses