API docs by Redocly

ready2order Public API (R2-2025.22.2)

Download OpenAPI specification:

Intro

Authentication

  • ready2order API uses token-based authentication.
  • all requests require an Authorization HTTP header with the appropriate token.
  • ensure the header is spelled correctly as Authorization.

Getting Started

1. Obtain a Developer Token

  • Endpoint: Register at api.ready2order.com.
  • Details: No Authorization header is needed at this stage since you don’t yet have a token. Follow the signup instructions and provide the required request data.

2. Request a Grant Access Token

  • Endpoint: POST /v1/developerToken/grantAccessToken
  • Headers:
    • Authorization: Bearer <Developer-Token>
  • Request Body:
    • callbackUri (optional): The URI to redirect to after approval or denial (e.g., http://www.ready2order.com?your-extra-param=123).
  • Response:
    • grantAccessToken: The token for the next step.
    • grantAccessUri: The full URI to approve access.
  • Note: Use the grantAccessUri in the next step.

3. Obtain an Account Token

  • Steps:
    1. Navigate to the grantAccessUri from the previous step.
    2. Log in with existing ready2order account credentials.
    3. Approve or deny access via the confirmation dialog.
  • Redirect: If a callbackUri was specified, the API redirects to it with these parameters:
    • accountToken: The Account Token (if approved).
    • grantAccessToken: The Grant Access Token used.
    • status: approved or denied.
  • Example Redirect: http://www.ready2order.com?your-extra-param=123&accountToken=<ACCOUNT_TOKEN>&grantAccessToken=<GRANT_ACCESS_TOKEN>&status=approved
  • Expiration: The Grant Access Token expires after 10 minutes if not used.

Token Types

Developer Token

  • Purpose: Identifies the developer using the API. Used to request permissions for existing ready2order accounts.
  • How to Obtain:
    1. Visit api.ready2order.com.
    2. Sign up as a developer.
    3. Follow the instructions in the confirmation email, which includes your Developer Token.
  • Usage: Only required for requesting a Grant Access Token.

Grant Access Token

  • Purpose: Enables a developer to request permissions for ready2order accounts.
  • Expiration: Valid for 10 minutes. If not approved within this time, you must request a new one.

Account Token

  • Purpose: Grants access to account-specific data, such as products, product groups, customers, and more.
  • Requirement: Must be included in the Authorization header for all account data interactions.

Rate limit

  • Limit: 60 requests per minute per Account Token.
  • Exceeded Response Status: HTTP 429

Webhooks

Overview

ready2order supports webhooks to notify your application of events in real time, providing an optimal experience.

Available Events

Event Description
product.created Triggered when a new product is created.
product.updated Triggered when an existing product is updated.
product.deleted Triggered when an existing product is deleted.
productGroup.created Triggered when a new product group is created.
productGroup.updated Triggered when an existing product group is updated.
productGroup.deleted Triggered when an existing product group is deleted.
invoice.created Triggered when a new receipt (e.g., bill, invoice, payment receipt) is created.
orderItem.created Triggered when a gastro-order is booked on a table.

Payloads

  • For created and updated Events:
    • The full object is sent in the resource array of the webhook payload, eliminating the need for additional API calls.
  • For deleted Events:
    • Only the IDs of the deleted resources are provided.

Getting Started

  1. Set Up Webhook URL: Configure your webhook endpoint in the Webhook section of the API dashboard.
  2. Subscribe to Events: Select the events (listed above) you want to receive notifications for.

AccountingFinancialYear

List all Accounting Financial Years

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find Accounting Financial Year by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "accountingFinancialYear_id": 1,
  • "accountingFinancialYear_number": 477415141,
  • "accountingFinancialYear_active": false,
  • "accountingFinancialYear_trunkYear": false
}

Bill

List all Bills

Authorizations:
Bearer
query Parameters
offset
integer

Offset (Default: 0)

limit
integer

Items per page (Default: 25)

query
string

Search query (For example: RG2018/1)

tableId
integer

Table-Id which should be filtered (For example: 1234)

customerId
integer

Customer-Id which should be filtered (For example: 1234)

dateField
string

Date field you want to query (Possible values: dr_startDate or b_dateTime)

dateFrom
string

Date from (For example: 2019-01-01)

dateTo
string

Date to (For example: 2019-12-31

testMode
boolean

Trainingmode on/off

items
boolean

Include list of items (Default: false)

discounts
boolean

Include list of discounts (Default: false)

payments
boolean

Include list of payments (Default: false)

payment
boolean

[DEPRECATED] Include list of payments. Please use 'payments' instead (Default: false)

Responses

Response samples

Content type
application/json
{
  • "invoices": [
    ],
  • "count": 50,
  • "offset": 0,
  • "limit": 50,
  • "dateFrom": "2019-01-01",
  • "dateTo": "2019-12-31",
  • "query": "some-query"
}

Create Bill

Authorizations:
Bearer
Request Body schema: application/json
paymentMethod_id
integer

PaymentMethod ID

user_id
integer

User ID

table_id
integer

Table ID

billType_id
integer

BillType ID

printer_id
integer

Printer ID on which the bill should be printed

printingProfile_id
integer

PrintingProfile ID on which the bill should be printed.

invoice_inPrinterQueue
integer

Decide how many copies should be printed (1 is original receipt)

invoice_textBeforeItemsTable
string

Text shown before items table on bill PDF

invoice_text
string

Text shown after items table on bill PDF

invoice_externalReferenceNumber
string

External reference number for the bill

invoice_priceBase
string
Enum: "0" "1" "brutto" "netto" "gross" "net"

Pricebase

invoice_testMode
boolean

Trainingmode

createPDF
boolean

Whether to create and return PDF or not

pdfFormat
string

PDF format

invoice_showRecipient
boolean

Show additional lines on invoice receipt

invoice_paid
boolean

Wether invoice should be marked as paid or not

invoice_dueDate
string

Due date

invoice_paidDate
string

Paid date

Array of objects

List of items

orderItem_ids
Array of integers

List of orderItemIds to process the invoice for

Array of objects

Address object

Responses

Request samples

Content type
application/json
{
  • "paymentMethod_id": 123456,
  • "user_id": 123456,
  • "table_id": 4321,
  • "billType_id": 1,
  • "printer_id": 1,
  • "printingProfile_id": 1,
  • "invoice_inPrinterQueue": 1,
  • "invoice_textBeforeItemsTable": "Some text",
  • "invoice_text": "Some text",
  • "invoice_externalReferenceNumber": "REF-1234",
  • "invoice_priceBase": "brutto",
  • "invoice_testMode": false,
  • "createPDF": false,
  • "pdfFormat": "A4, 80mm or 58mm",
  • "invoice_showRecipient": false,
  • "invoice_paid": false,
  • "invoice_dueDate": "2019-01-15",
  • "invoice_paidDate": "2019-01-15",
  • "items": [
    ],
  • "orderItem_ids": [
    ],
  • "address": [
    ]
}

Response samples

Content type
application/json
{
  • "invoice_id": 1234,
  • "invoice_reference_id": 1233,
  • "invoice_timestamp": "2019-01-01 00:00:00",
  • "invoice_number": 1,
  • "invoice_numberFull": "RG2019/1",
  • "invoice_total": 12,
  • "invoice_totalNet": 10,
  • "invoice_totalVat": 2,
  • "invoice_totalTip": 0,
  • "invoice_address_company": "ready2order GmbH",
  • "invoice_address_vatId": "ATU12341234",
  • "invoice_address_salutation": "Mr/Ms",
  • "invoice_address_title": "Professor",
  • "invoice_address_firstName": "Chris",
  • "invoice_address_lastName": "Fox",
  • "invoice_address_street": "Hintere Zollamtsstraße 17",
  • "invoice_address_city": "Vienna",
  • "invoice_address_zip": 1030,
  • "invoice_address_country": "AT",
  • "invoice_address_email": "[email protected]",
  • "invoice_address_phone": "+43 664 1234 1234 1234",
  • "invoice_inPrinterQueue": true,
  • "invoice_priceBase": "brutto",
  • "invoice_deleted_at": "2019-01-01 00:00:00",
  • "invoice_deletedReason": "Some reason",
  • "invoice_pdf": "http://some.link",
  • "invoice_textBeforeItemsTable": "Some text",
  • "invoice_text": "Some text",
  • "invoice_locked": true,
  • "invoice_externalReferenceNumber": "REF-1234",
  • "invoice_internalInvoiceReferenceNumber": 1233,
  • "invoice_dueDate": "2019-01-05",
  • "invoice_deliveryDate": "2019-01-01",
  • "invoice_paid": true,
  • "invoice_paidDate": "2019-01-01",
  • "invoice_testMode": true,
  • "invoice_formatVersion": 2,
  • "customer_id": 1234,
  • "customerCategory_id": 1023,
  • "table_id": 1234,
  • "tableArea_id": 67,
  • "paymentMethod_id": 1234,
  • "user_id": 1234,
  • "printer_id": 23,
  • "billType_id": 1,
  • "currency_id": 1,
  • "items": [
    ],
  • "address": {
    },
  • "type": {
    },
  • "payment": [
    ],
  • "transaction": {
    },
  • "discounts": [
    ]
}

Count All Bills

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "count": 1500
}

Find Bill by Id

Authorizations:
Bearer
path Parameters
id
required
integer

Bill ID to find

Responses

Response samples

Content type
application/json
{
  • "invoice_id": 1234,
  • "invoice_reference_id": 1233,
  • "invoice_timestamp": "2019-01-01 00:00:00",
  • "invoice_number": 1,
  • "invoice_numberFull": "RG2019/1",
  • "invoice_total": 12,
  • "invoice_totalNet": 10,
  • "invoice_totalVat": 2,
  • "invoice_totalTip": 0,
  • "invoice_address_company": "ready2order GmbH",
  • "invoice_address_vatId": "ATU12341234",
  • "invoice_address_salutation": "Mr/Ms",
  • "invoice_address_title": "Professor",
  • "invoice_address_firstName": "Chris",
  • "invoice_address_lastName": "Fox",
  • "invoice_address_street": "Hintere Zollamtsstraße 17",
  • "invoice_address_city": "Vienna",
  • "invoice_address_zip": 1030,
  • "invoice_address_country": "AT",
  • "invoice_address_email": "[email protected]",
  • "invoice_address_phone": "+43 664 1234 1234 1234",
  • "invoice_inPrinterQueue": true,
  • "invoice_priceBase": "brutto",
  • "invoice_deleted_at": "2019-01-01 00:00:00",
  • "invoice_deletedReason": "Some reason",
  • "invoice_pdf": "http://some.link",
  • "invoice_textBeforeItemsTable": "Some text",
  • "invoice_text": "Some text",
  • "invoice_locked": true,
  • "invoice_externalReferenceNumber": "REF-1234",
  • "invoice_internalInvoiceReferenceNumber": 1233,
  • "invoice_dueDate": "2019-01-05",
  • "invoice_deliveryDate": "2019-01-01",
  • "invoice_paid": true,
  • "invoice_paidDate": "2019-01-01",
  • "invoice_testMode": true,
  • "invoice_formatVersion": 2,
  • "customer_id": 1234,
  • "customerCategory_id": 1023,
  • "table_id": 1234,
  • "tableArea_id": 67,
  • "paymentMethod_id": 1234,
  • "user_id": 1234,
  • "printer_id": 23,
  • "billType_id": 1,
  • "currency_id": 1,
  • "items": [
    ],
  • "address": {
    },
  • "type": {
    },
  • "payment": [
    ],
  • "transaction": {
    },
  • "discounts": [
    ]
}

Delete Bill by Id

Authorizations:
Bearer
path Parameters
id
required
integer

Bill ID to find

Request Body schema: application/json
storno_id
integer

Storno ID

storno_reason
string

Some reason why bill was deleted

invoice_externalReferenceNumber
string

Some external reference number for that bill

Responses

Request samples

Content type
application/json
{
  • "storno_id": 9823,
  • "storno_reason": "Correction",
  • "invoice_externalReferenceNumber": "REF-1234"
}

Response samples

Content type
application/json
{
  • "invoice_id": 1234,
  • "invoice_reference_id": 1233,
  • "invoice_timestamp": "2019-01-01 00:00:00",
  • "invoice_number": 1,
  • "invoice_numberFull": "RG2019/1",
  • "invoice_total": 12,
  • "invoice_totalNet": 10,
  • "invoice_totalVat": 2,
  • "invoice_totalTip": 0,
  • "invoice_address_company": "ready2order GmbH",
  • "invoice_address_vatId": "ATU12341234",
  • "invoice_address_salutation": "Mr/Ms",
  • "invoice_address_title": "Professor",
  • "invoice_address_firstName": "Chris",
  • "invoice_address_lastName": "Fox",
  • "invoice_address_street": "Hintere Zollamtsstraße 17",
  • "invoice_address_city": "Vienna",
  • "invoice_address_zip": 1030,
  • "invoice_address_country": "AT",
  • "invoice_address_email": "[email protected]",
  • "invoice_address_phone": "+43 664 1234 1234 1234",
  • "invoice_inPrinterQueue": true,
  • "invoice_priceBase": "brutto",
  • "invoice_deleted_at": "2019-01-01 00:00:00",
  • "invoice_deletedReason": "Some reason",
  • "invoice_pdf": "http://some.link",
  • "invoice_textBeforeItemsTable": "Some text",
  • "invoice_text": "Some text",
  • "invoice_locked": true,
  • "invoice_externalReferenceNumber": "REF-1234",
  • "invoice_internalInvoiceReferenceNumber": 1233,
  • "invoice_dueDate": "2019-01-05",
  • "invoice_deliveryDate": "2019-01-01",
  • "invoice_paid": true,
  • "invoice_paidDate": "2019-01-01",
  • "invoice_testMode": true,
  • "invoice_formatVersion": 2,
  • "customer_id": 1234,
  • "customerCategory_id": 1023,
  • "table_id": 1234,
  • "tableArea_id": 67,
  • "paymentMethod_id": 1234,
  • "user_id": 1234,
  • "printer_id": 23,
  • "billType_id": 1,
  • "currency_id": 1,
  • "items": [
    ],
  • "address": {
    },
  • "type": {
    },
  • "payment": [
    ],
  • "transaction": {
    },
  • "discounts": [
    ]
}

Print a bill

Add bill to printer queue for specific printer

Authorizations:
Bearer
path Parameters
id
required
integer

Bill ID to find

Request Body schema: application/json
printer_id
integer

Printer ID where to print the bill

Responses

Request samples

Content type
application/json
{
  • "printer_id": 2394
}

Response samples

Content type
application/json
{
  • "error": false,
  • "msg": "Bill was added to printer queue"
}

Create PDF for bill

Returns signed S3 URL. Optionally regenerates pdf if regeneratePDF is set to true

Authorizations:
Bearer
path Parameters
id
required
integer

User ID to delete

Request Body schema: application/json
regeneratePDF
boolean

Optionally regenerate an existing PDF

format
string

PDF Format

Responses

Request samples

Content type
application/json
{
  • "regeneratePDF": true,
  • "format": "A4, 80mm or 58mm"
}

Response samples

Content type
application/json
{}

BillType

List all Bill Types

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find Bill Type by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "billType_id": 1,
  • "billType_name": "Rechnung",
  • "billType_symbol": "RG"
}

Country

List all Countries

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find Country by Id

Authorizations:
Bearer
path Parameters
id
required
integer

Country id to find

Responses

Response samples

Content type
application/json
{
  • "country_id": 123,
  • "country_code": "AT",
  • "country_name": "Austria"
}

Coupon

List all Coupons

Authorizations:
Bearer
query Parameters
page
integer

Page you want to display

limit
integer

Items per page

identifier
string

Identifier/Code of coupon

trainingMode
boolean

Trainingmode

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Coupon

Authorizations:
Bearer
Request Body schema: application/json
coupon_name
string
coupon_value
string
couponCategory_id
string
coupon_containsVat
string
customer_id
integer
coupon_type
string
Value: "coupon"
coupon_purpose
string
Enum: "single" "multi"
coupon_validUntil
string
coupon_issuedAt
string
coupon_testMode
boolean
coupon_identifier
string

Responses

Request samples

Content type
application/json
{
  • "coupon_name": "MyCoupon",
  • "coupon_value": 5,
  • "couponCategory_id": 123,
  • "coupon_containsVat": 3,
  • "customer_id": 450,
  • "coupon_type": "coupon",
  • "coupon_purpose": "single|multi",
  • "coupon_validUntil": "2030-01-02",
  • "coupon_issuedAt": "2025-01-02",
  • "coupon_testMode": false,
  • "coupon_identifier": "AABBCC"
}

Response samples

Content type
application/json
{
  • "coupon_id": 1234,
  • "coupon_name": "Christmas Coupon",
  • "coupon_containsVat": 20,
  • "coupon_purpose": "single|multi",
  • "coupon_identifier": 9995071228303,
  • "coupon_testMode": true,
  • "coupon_validUntil": "2020-01-31 00:49:39",
  • "coupon_issuedAt": "2018-01-31 00:49:39",
  • "couponCategory_id": 4,
  • "vat_id": 1234,
  • "product_id": 1234,
  • "customer_id": 7455,
  • "coupon_created_at": "2018-01-31 00:49:39",
  • "coupon_updated_at": "2018-01-31 04:49:39"
}

Find Coupon by Id

Authorizations:
Bearer
path Parameters
id
required
integer

Coupon ID to find

Responses

Response samples

Content type
application/json
{
  • "coupon_id": 1234,
  • "coupon_name": "Christmas Coupon",
  • "coupon_containsVat": 20,
  • "coupon_purpose": "single|multi",
  • "coupon_identifier": 9995071228303,
  • "coupon_testMode": true,
  • "coupon_validUntil": "2020-01-31 00:49:39",
  • "coupon_issuedAt": "2018-01-31 00:49:39",
  • "couponCategory_id": 4,
  • "vat_id": 1234,
  • "product_id": 1234,
  • "customer_id": 7455,
  • "coupon_created_at": "2018-01-31 00:49:39",
  • "coupon_updated_at": "2018-01-31 04:49:39"
}

Update Coupon by Id

Authorizations:
Bearer
path Parameters
id
required
integer

Coupon ID to update

Request Body schema: application/json
coupon_name
string
coupon_value
string
couponCategory_id
string
coupon_containsVat
string
customer_id
integer
coupon_type
string
Value: "coupon"
coupon_purpose
string
Enum: "single" "multi"
coupon_validUntil
string
coupon_issuedAt
string
coupon_testMode
boolean
coupon_identifier
string

Responses

Request samples

Content type
application/json
{
  • "coupon_name": "MyCoupon",
  • "coupon_value": 5,
  • "couponCategory_id": 123,
  • "coupon_containsVat": 3,
  • "customer_id": 450,
  • "coupon_type": "coupon",
  • "coupon_purpose": "single|multi",
  • "coupon_validUntil": "2030-01-02",
  • "coupon_issuedAt": "2025-01-02",
  • "coupon_testMode": false,
  • "coupon_identifier": "AABBCC"
}

Response samples

Content type
application/json
{
  • "coupon_id": 1234,
  • "coupon_name": "Christmas Coupon",
  • "coupon_containsVat": 20,
  • "coupon_purpose": "single|multi",
  • "coupon_identifier": 9995071228303,
  • "coupon_testMode": true,
  • "coupon_validUntil": "2020-01-31 00:49:39",
  • "coupon_issuedAt": "2018-01-31 00:49:39",
  • "couponCategory_id": 4,
  • "vat_id": 1234,
  • "product_id": 1234,
  • "customer_id": 7455,
  • "coupon_created_at": "2018-01-31 00:49:39",
  • "coupon_updated_at": "2018-01-31 04:49:39"
}

Delete Coupon by Id

Authorizations:
Bearer
path Parameters
id
required
integer

Coupon ID to delete

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "Coupon was successfully deleted!"
}

Charge By Id

Authorizations:
Bearer
path Parameters
id
required
integer

Coupon ID to charge

Request Body schema: application/json
value
string

Charge value

Responses

Request samples

Content type
application/json
{
  • "value": 12
}

Response samples

Content type
application/json
{
  • "coupon_id": 1234,
  • "coupon_name": "Christmas Coupon",
  • "coupon_containsVat": 20,
  • "coupon_purpose": "single|multi",
  • "coupon_identifier": 9995071228303,
  • "coupon_testMode": true,
  • "coupon_validUntil": "2020-01-31 00:49:39",
  • "coupon_issuedAt": "2018-01-31 00:49:39",
  • "couponCategory_id": 4,
  • "vat_id": 1234,
  • "product_id": 1234,
  • "customer_id": 7455,
  • "coupon_created_at": "2018-01-31 00:49:39",
  • "coupon_updated_at": "2018-01-31 04:49:39"
}

Redeem By Id

Authorizations:
Bearer
path Parameters
id
required
integer

Coupon ID to redeem

Request Body schema: application/json
value
string

Redemption value

Responses

Request samples

Content type
application/json
{
  • "value": 12
}

Response samples

Content type
application/json
{
  • "coupon_id": 1234,
  • "coupon_name": "Christmas Coupon",
  • "coupon_containsVat": 20,
  • "coupon_purpose": "single|multi",
  • "coupon_identifier": 9995071228303,
  • "coupon_testMode": true,
  • "coupon_validUntil": "2020-01-31 00:49:39",
  • "coupon_issuedAt": "2018-01-31 00:49:39",
  • "couponCategory_id": 4,
  • "vat_id": 1234,
  • "product_id": 1234,
  • "customer_id": 7455,
  • "coupon_created_at": "2018-01-31 00:49:39",
  • "coupon_updated_at": "2018-01-31 04:49:39"
}

CouponCategory

List all Coupon Categories

Authorizations:
Bearer
query Parameters
page
integer

Page you want to display

limit
integer

Items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Coupon Category

Authorizations:
Bearer
Request Body schema: application/json
couponCategory_name
string
couponCategory_description
string

Responses

Request samples

Content type
application/json
{
  • "couponCategory_name": "string",
  • "couponCategory_description": "string"
}

Response samples

Content type
application/json
{
  • "couponCategory_id": 123,
  • "couponCategory_name": "my coupon category",
  • "couponCategory_description": "my great coupon category"
}

Find Coupon Category by Id

Authorizations:
Bearer
path Parameters
id
required
integer

Coupon Category ID to find

Responses

Response samples

Content type
application/json
{
  • "couponCategory_id": 123,
  • "couponCategory_name": "my coupon category",
  • "couponCategory_description": "my great coupon category"
}

Update Coupon Category by Id

Authorizations:
Bearer
path Parameters
id
required
integer

Coupon Category ID to update

Request Body schema: application/json
couponCategory_name
string
couponCategory_description
string

Responses

Request samples

Content type
application/json
{
  • "couponCategory_name": "string",
  • "couponCategory_description": "string"
}

Response samples

Content type
application/json
{
  • "couponCategory_id": 123,
  • "couponCategory_name": "my coupon category",
  • "couponCategory_description": "my great coupon category"
}

Delete Coupon Category by Id

Authorizations:
Bearer
path Parameters
id
required
integer

Coupon Category ID to find

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "Coupon Category was successfully deleted!"
}

Currency

Get Currencies

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Currency

Authorizations:
Bearer
path Parameters
id
required
integer

Currency ID to find

Responses

Response samples

Content type
application/json
{
  • "currency_id": 1,
  • "currency_name": "Euro",
  • "currency_short": "EUR"
}

Customer

List all Customers

Authorizations:
Bearer
query Parameters
page
integer

Page you want to display

limit
integer

Items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Customer

Authorizations:
Bearer
Request Body schema: application/json
customerCategory_id
integer
birthday
string
city
string
company
string
email
string
firstName
string
lastName
string
customer_name
string
notes
string
customer_number
integer
phone
string
salutation
string
street
string
title
string
uid
string
zip
string
fk_cou_id
integer

Responses

Request samples

Content type
application/json
{
  • "customerCategory_id": 1126,
  • "birthday": "1991-09-20",
  • "city": "Wien",
  • "company": "Maxi Gmbh",
  • "email": "[email protected]",
  • "firstName": "Max",
  • "lastName": "Muster",
  • "customer_name": "no-example",
  • "notes": "Some custom notes",
  • "customer_number": 0,
  • "phone": "+43 12345678",
  • "salutation": "Herr",
  • "street": "Straße 1",
  • "title": "Herr",
  • "uid": "ATU1234567",
  • "zip": 1030,
  • "fk_cou_id": 1
}

Response samples

Content type
application/json
{
  • "customer_id": 9999,
  • "customer_number": 9999,
  • "customer_name": "Maxi's custom name",
  • "vatId": "ATU1234567",
  • "customer_company": "Maxi Gmbh",
  • "salutation": "Herr",
  • "title": "Professor",
  • "lastName": "Muster",
  • "firstName": "Max",
  • "zip": 1030,
  • "city": "WIen",
  • "street": "Straße 1",
  • "email": "[email protected]",
  • "phone": "+43 664 12345678",
  • "customer_notes": "Some custom notes",
  • "customerCategory_id": 9999,
  • "customer_birthday": "1991-09-20"
}

Find Customer by Id

Authorizations:
Bearer
path Parameters
id
required
integer

Customer ID to find

Responses

Response samples

Content type
application/json
{
  • "customer_id": 9999,
  • "customer_number": 9999,
  • "customer_name": "Maxi's custom name",
  • "vatId": "ATU1234567",
  • "customer_company": "Maxi Gmbh",
  • "salutation": "Herr",
  • "title": "Professor",
  • "lastName": "Muster",
  • "firstName": "Max",
  • "zip": 1030,
  • "city": "WIen",
  • "street": "Straße 1",
  • "email": "[email protected]",
  • "phone": "+43 664 12345678",
  • "customer_notes": "Some custom notes",
  • "customerCategory_id": 9999,
  • "customer_birthday": "1991-09-20"
}

Update Customer by Id

Authorizations:
Bearer
path Parameters
id
required
integer

Customer ID to update

Request Body schema: application/json
customerCategory_id
integer
birthday
string
city
string
company
string
email
string
firstName
string
lastName
string
customer_name
string
notes
string
customer_number
integer
phone
string
salutation
string
street
string
title
string
uid
string
zip
string
fk_cou_id
integer

Responses

Request samples

Content type
application/json
{
  • "customerCategory_id": 1126,
  • "birthday": "1991-09-20",
  • "city": "Wien",
  • "company": "Maxi Gmbh",
  • "email": "[email protected]",
  • "firstName": "Max",
  • "lastName": "Muster",
  • "customer_name": "no-example",
  • "notes": "Some custom notes",
  • "customer_number": 0,
  • "phone": "+43 12345678",
  • "salutation": "Herr",
  • "street": "Straße 1",
  • "title": "Herr",
  • "uid": "ATU1234567",
  • "zip": 1030,
  • "fk_cou_id": 1
}

Response samples

Content type
application/json
{
  • "customer_id": 9999,
  • "customer_number": 9999,
  • "customer_name": "Maxi's custom name",
  • "vatId": "ATU1234567",
  • "customer_company": "Maxi Gmbh",
  • "salutation": "Herr",
  • "title": "Professor",
  • "lastName": "Muster",
  • "firstName": "Max",
  • "zip": 1030,
  • "city": "WIen",
  • "street": "Straße 1",
  • "email": "[email protected]",
  • "phone": "+43 664 12345678",
  • "customer_notes": "Some custom notes",
  • "customerCategory_id": 9999,
  • "customer_birthday": "1991-09-20"
}

Delete Customer by Id

Authorizations:
Bearer
path Parameters
id
required
integer

Customer ID to delete

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "Customer was successfully deleted!"
}

Merge Customers

Authorizations:
Bearer
Request Body schema: application/json
masterCustomer
integer

Customer into which the list of customerIds should be merged into.

customerIds
Array of integers

List of customers which shall be merged into masterCustomer.

Responses

Request samples

Content type
application/json
{
  • "masterCustomer": 5924,
  • "customerIds": [
    ]
}

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "Merged successfully!"
}

CustomerGroup

Get All Customer Groups

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Customer Group

Authorizations:
Bearer
Request Body schema: application/json
customerCategory_name
string
customerCategory_description
string

Responses

Request samples

Content type
application/json
{
  • "customerCategory_name": "string",
  • "customerCategory_description": "string"
}

Response samples

Content type
application/json
{
  • "customerCategory_id": 123,
  • "customerCategory_name": "a customer group",
  • "customerCategory_description": "a customer group description"
}

Get Customer Group By Id

Authorizations:
Bearer
path Parameters
id
required
integer

Customer Group ID to find

Responses

Response samples

Content type
application/json
{
  • "customerCategory_id": 123,
  • "customerCategory_name": "a customer group",
  • "customerCategory_description": "a customer group description"
}

Update Customer Group

Authorizations:
Bearer
path Parameters
id
required
integer

Customer Group ID to update

Request Body schema: application/json
customerCategory_name
string
customerCategory_description
string

Responses

Request samples

Content type
application/json
{
  • "customerCategory_name": "string",
  • "customerCategory_description": "string"
}

Response samples

Content type
application/json
{
  • "customerCategory_id": 123,
  • "customerCategory_name": "a customer group",
  • "customerCategory_description": "a customer group description"
}

Delete Customer Group

Authorizations:
Bearer
path Parameters
id
required
integer

Customer Group ID to delete

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "CustomerCategory was successfully deleted."
}

Discount

List all Discounts

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Discount

Authorizations:
Bearer
Request Body schema: application/json
discount_name
string

The name of the discount

discountGroup_id
integer

The id of the discount group

discount_unit
string
Enum: "percent" "currency" "custom"

The unit of the discount

discount_order
integer

The order of the discount

discount_description
string

The description of the discount

discount_active
boolean

Whether the discount is active or not

discount_value
string

The value of the discount

Responses

Request samples

Content type
application/json
{
  • "discount_name": "Discount",
  • "discountGroup_id": 116,
  • "discount_unit": "custom",
  • "discount_order": 0,
  • "discount_description": "A discount description",
  • "discount_active": true,
  • "discount_value": 30
}

Response samples

Content type
application/json
{
  • "discount_id": 123,
  • "discount_name": "Discount",
  • "discount_description": "A discount description",
  • "discount_value": 30,
  • "discount_unit": "custom",
  • "discount_active": true,
  • "discount_order": 0,
  • "discountGroup_id": 116,
  • "discount_created_at": "2018-12-20 11:00:00",
  • "discount_updated_at": "2018-12-20 11:15:00"
}

Find Discount by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "discount_id": 123,
  • "discount_name": "Discount",
  • "discount_description": "A discount description",
  • "discount_value": 30,
  • "discount_unit": "custom",
  • "discount_active": true,
  • "discount_order": 0,
  • "discountGroup_id": 116,
  • "discount_created_at": "2018-12-20 11:00:00",
  • "discount_updated_at": "2018-12-20 11:15:00"
}

Update Discount by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Request Body schema: application/json
discount_name
string

The name of the discount

discountGroup_id
integer

The id of the discount group

discount_unit
string
Enum: "percent" "currency" "custom"

The unit of the discount

discount_order
integer

The order of the discount

discount_description
string

The description of the discount

discount_active
boolean

Whether the discount is active or not

discount_value
string

The value of the discount

Responses

Request samples

Content type
application/json
{
  • "discount_name": "Discount",
  • "discountGroup_id": 116,
  • "discount_unit": "custom",
  • "discount_order": 0,
  • "discount_description": "A discount description",
  • "discount_active": true,
  • "discount_value": 30
}

Response samples

Content type
application/json
{
  • "discount_id": 123,
  • "discount_name": "Discount",
  • "discount_description": "A discount description",
  • "discount_value": 30,
  • "discount_unit": "custom",
  • "discount_active": true,
  • "discount_order": 0,
  • "discountGroup_id": 116,
  • "discount_created_at": "2018-12-20 11:00:00",
  • "discount_updated_at": "2018-12-20 11:15:00"
}

Delete Discount by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "Discount was successfully deleted!"
}

DiscountGroup

Get All Discount Groups

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Discount Group

Authorizations:
Bearer
Request Body schema: application/json
discountGroup_description
string

The description of the discount group

discountGroup_active
boolean

Whether the discount group is active or not

discountGroup_name
string

The name of the discount group

Responses

Request samples

Content type
application/json
{
  • "discountGroup_description": "description example",
  • "discountGroup_active": true,
  • "discountGroup_name": "Sales"
}

Response samples

Content type
application/json
{
  • "discountGroup_id": 74890,
  • "discountGroup_name": "Barzahlung",
  • "discountGroup_description": "just a description",
  • "discountGroup_active": true
}

Get Discount Group

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "discountGroup_id": 74890,
  • "discountGroup_name": "Barzahlung",
  • "discountGroup_description": "just a description",
  • "discountGroup_active": true
}

Update Discount Group

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Request Body schema: application/json
discountGroup_description
string

The description of the discount group

discountGroup_active
boolean

Whether the discount group is active or not

discountGroup_name
string

The name of the discount group

Responses

Request samples

Content type
application/json
{
  • "discountGroup_description": "description example",
  • "discountGroup_active": true,
  • "discountGroup_name": "Sales"
}

Response samples

Content type
application/json
{
  • "discountGroup_id": 74890,
  • "discountGroup_name": "Barzahlung",
  • "discountGroup_description": "just a description",
  • "discountGroup_active": true
}

Delete Discount Group

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "DiscountGroup was successfully deleted!"
}

Export

Export Cashbook

Authorizations:
Bearer
Request Body schema: application/json
dateFrom
string
dateTo
string
fileFormat
string
Enum: "excel" "pdf"

Responses

Request samples

Content type
application/json
{
  • "dateFrom": "2021-08-01",
  • "dateTo": "2021-08-31",
  • "fileFormat": "pdf|excel"
}

Response samples

Content type
application/json
{
  • "jobStatus_id": 123,
  • "jobStatus_status": "finished",
  • "jobStatus_startedAt": "2019-08-02 08:08:13",
  • "jobStatus_finishedAt": "2019-08-02 08:08:14"
}

Export Accountancy

Authorizations:
Bearer
Request Body schema: application/json
format
string

Use one of the possible export formats: bmd, bmd-ntcs, datev, sap, rzl

year
integer

Year for which the export should be generated (optional)

month
integer

Month for which the export should be generated (optional)

day
integer

Day for which the export should be generated (optional)

exportCashbook
boolean

Whether to include cashbook transactions in the export

dataSource
string

Type of data-aggregation to use. Possible value are: invoice, eachItem, dailyReport_productGroups, dailyReport_accountingCode

financialYear
integer

If format is datev the number of the financialYear has to be provided. See GET /accounting/financialYears

from
string

If format is datev the start date of the financialYear has to be provided. See GET /accounting/financialYears

to
string

If format is datev the end date of the financialYear has to be provided. See GET /accounting/financialYears

Responses

Request samples

Content type
application/json
{
  • "format": "datev",
  • "year": 2019,
  • "month": 1,
  • "day": 31,
  • "exportCashbook": true,
  • "dataSource": "invoice",
  • "financialYear": 2019,
  • "from": "2019-01-01",
  • "to": "2019-12-31"
}

Response samples

Content type
application/json
{}

Export Cashbook

Authorizations:
Bearer
Request Body schema: application/json
year
integer
month
integer
day
integer
dateFrom
string
dateTo
string

Responses

Request samples

Content type
application/json
{
  • "year": 2019,
  • "month": 1,
  • "day": 31,
  • "dateFrom": "2021-08-01",
  • "dateTo": "2021-08-31"
}

Response samples

Content type
application/json
{}

Export Sales

Authorizations:
Bearer
Request Body schema: application/json
month
integer
year
integer
filter
Array of integers

Filter your data

Responses

Request samples

Content type
application/json
{
  • "month": 1,
  • "year": 2019,
  • "filter": [
    ]
}

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "success",
  • "jobStatus_id": 123
}

Grant Access Token

Create Grant Access Token

Authorizations:
Bearer
Request Body schema: application/json
authorizationCallbackUri
string

The callback to which the merchant will be redirected if access will be granted.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Get Grant Access Token Status

Authorizations:
Bearer
path Parameters
token
required
string

Grant-access token

Responses

Response samples

Content type
application/json
{
  • "status": "pending, expired, granted, denied"
}

JobStatus

Get Status By Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "jobStatus_id": 123,
  • "jobStatus_status": "finished",
  • "jobStatus_startedAt": "2019-08-02 08:08:13",
  • "jobStatus_finishedAt": "2019-08-02 08:08:14"
}

Language

List all Languages

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find Language by Id

Authorizations:
Bearer
path Parameters
id
required
integer

Language ID to find

Responses

Response samples

Content type
application/json
{
  • "language_id": 1,
  • "language_name": "label_en",
  • "language_code": "en",
  • "language_locale": "en_US"
}

LegalForm

List all Legal Forms

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find Legal Form by Id

Authorizations:
Bearer
path Parameters
id
required
integer

Legal Form ID to find

Responses

Response samples

Content type
application/json
{
  • "legalForm_id": 1,
  • "legalForm_name": "GmbH",
  • "legalForm_identifier": "gmbh",
  • "legalForm_country_id": 1
}

Order

List all Orders

Authorizations:
Bearer
query Parameters
page
integer

Page you want to display

limit
integer

Items per page

groupBy
string

allowed values: table_id or product_id or both

trainingsMode
string

retrieve results for trainingsMode or liveMde

table_id
integer

table id

product_id
integer

product id

Responses

Response samples

Content type
application/json
{
  • "order_id": 123,
  • "order_quantity": 123,
  • "order_priceGross": 123.12,
  • "order_priceNet": 123.12,
  • "order_vat": 10,
  • "order_discount_valueGross": 10,
  • "order_discount_valueNet": 10,
  • "order_vatRate": 10,
  • "order_product_priceGrossPerUnit": 123,
  • "order_product_priceNetPerUnit": 123,
  • "order_discount_name": "discountA",
  • "order_discountable": true,
  • "order_mergeable": true,
  • "order_retour": false,
  • "order_number": 123,
  • "order_group": 123,
  • "order_product_name": "productA",
  • "order_product_itemnumber": 123,
  • "order_product_serialnumber": 1231234,
  • "order_course": 1,
  • "order_status": 1,
  • "order_comment": "very long text",
  • "table_id": 123456,
  • "product_id": 123456,
  • "user_id": 123456,
  • "productgroup_type_id": 123456,
  • "order_created_at": "2019-01-01"
}

Create a new Order

Authorizations:
Bearer
Request Body schema: application/json
table_id
integer

Table on which the orders are booked

price_base
string
Enum: "0" "1" "brutto" "netto" "gross" "net"

'gross' or 'net'

training_mode
boolean

Whether to place the order in training- or normal-mode

Array of objects

List of items

Responses

Request samples

Content type
application/json
{
  • "table_id": 1234,
  • "price_base": "gross",
  • "training_mode": false,
  • "items": [ ]
}

Response samples

Content type
application/json
{
  • "order_id": 123,
  • "order_quantity": 123,
  • "order_priceGross": 123.12,
  • "order_priceNet": 123.12,
  • "order_vat": 10,
  • "order_discount_valueGross": 10,
  • "order_discount_valueNet": 10,
  • "order_vatRate": 10,
  • "order_product_priceGrossPerUnit": 123,
  • "order_product_priceNetPerUnit": 123,
  • "order_discount_name": "discountA",
  • "order_discountable": true,
  • "order_mergeable": true,
  • "order_retour": false,
  • "order_number": 123,
  • "order_group": 123,
  • "order_product_name": "productA",
  • "order_product_itemnumber": 123,
  • "order_product_serialnumber": 1231234,
  • "order_course": 1,
  • "order_status": 1,
  • "order_comment": "very long text",
  • "table_id": 123456,
  • "product_id": 123456,
  • "user_id": 123456,
  • "productgroup_type_id": 123456,
  • "order_created_at": "2019-01-01"
}

PaymentMethod

List all Payment Methods

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Payment Method

Authorizations:
Bearer
Request Body schema: application/json
payment_description
string

The description of the payment method

payment_markAsPaid
boolean

Mark payment method as paid

paymentType_id
integer

The payment type id of the payment method

payment_name
string

The name of the payment method

Responses

Request samples

Content type
application/json
{
  • "payment_description": "Paying in cash",
  • "payment_markAsPaid": true,
  • "paymentType_id": 1,
  • "payment_name": "Barzahlung"
}

Response samples

Content type
application/json
{
  • "payment_id": 74890,
  • "payment_name": "Barzahlung",
  • "payment_description": "just a description",
  • "payment_accountingCode": 2700,
  • "payment_markAsPaid": true,
  • "paymentType_id": 1
}

Find Payment Method by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "payment_id": 74890,
  • "payment_name": "Barzahlung",
  • "payment_description": "just a description",
  • "payment_accountingCode": 2700,
  • "payment_markAsPaid": true,
  • "paymentType_id": 1
}

Update Payment Method

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Request Body schema: application/json
payment_description
string

The description of the payment method

payment_markAsPaid
boolean

Mark payment method as paid

paymentType_id
integer

The payment type id of the payment method

payment_name
string

The name of the payment method

Responses

Request samples

Content type
application/json
{
  • "payment_description": "Paying in cash",
  • "payment_markAsPaid": true,
  • "paymentType_id": 1,
  • "payment_name": "Barzahlung"
}

Response samples

Content type
application/json
{
  • "payment_id": 74890,
  • "payment_name": "Barzahlung",
  • "payment_description": "just a description",
  • "payment_accountingCode": 2700,
  • "payment_markAsPaid": true,
  • "paymentType_id": 1
}

Delete Payment Method

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "PaymentMethod was successfully deleted."
}

PaymentMethodType

List all Payment Method Types

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find Payment Method Type by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "paymentType_id": 1,
  • "paymentType_identifier": "cash",
  • "paymentType_name": "Bargeld"
}

PrintJob

Get Not Printed

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Print Job

Authorizations:
Bearer
Request Body schema: application/json
printJob_content
string
printJob_imageURL
string
printJob_printLogo
boolean
printer_id
integer

Responses

Request samples

Content type
application/json
{
  • "printJob_content": "no-example",
  • "printJob_imageURL": "no-example",
  • "printJob_printLogo": false,
  • "printer_id": 0
}

Response samples

Content type
application/json
{
  • "printJob_id": 9999,
  • "printer_id": 9999,
  • "printJob_imageURL": "string",
  • "printJob_printLogo": false,
  • "printJob_createdAt": "string",
  • "printJob_printedAt": "string",
  • "printJob_content": "string"
}

Delete Print Job by Id

Authorizations:
Bearer
path Parameters
id
required
integer

Customer ID to find

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "Customer was successfully deleted!"
}

Printer

List all Printers

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find Printer by Id

Authorizations:
Bearer
path Parameters
id
required
integer

Printer ID to find

Responses

Response samples

Content type
application/json
{
  • "printer_id": 123,
  • "printer_name": "kitchen printer",
  • "printer_description": "kitchen printer",
  • "printer_deviceName": "EPSON-TM-T88V",
  • "printer_model": "TM-T20II",
  • "printer_manufacturer": "EPSON",
  • "printer_ipAddress": "192.168.0.1",
  • "printer_characters": 42,
  • "printer_doubleHeight": true,
  • "printer_createdAt": "2019-01-01 11:11:11"
}

Test Print

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "error": true,
  • "success": false,
  • "msg": "Printer not found"
}

Product

List all Products

Authorizations:
Bearer
query Parameters
page
integer

Page you want to display

limit
integer

Items per page

productgroup_id
integer

get all products for this productgroup_id

itemNumber
string

search for a product with the given product_itemNumber

name
string

search for a product with the given product_name

barcode
string

search for a product with the given product_barcode

q
string

search for a product by keywords

includeProductGroup
boolean

include product group information

includeProductVariations
boolean

include product variations information

includeProductIngredients
boolean

include product variations information

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Product

Authorizations:
Bearer
Request Body schema: application/json
productgroup_id
integer

Product group id

product_name
string

Product name

product_price
string

Product price

product_vat
string

VAT-Rate in decimals. Provide either product_vat or product_vat_id

product_vat_id
integer

ID of VAT-rate (see /vat-rates). Provide either product_vat or product_vat_id

product_itemnumber
string

Item number

product_externalReference
string

External reference

product_barcode
string

Barcode

product_description
string

Optional description

product_priceIncludesVat
boolean

Whether price is provided included or excluding VAT

product_active
boolean

Is product active

product_discountable
boolean

Is product discountable

product_stock_enabled
boolean

Is stock for product enabled

product_stock_value
string

Product stock value

product_stock_reorderLevel
string

Product stock reorder level

product_stock_safetyStock
string

Product stock safety level

product_stock_unit
string

Product stock unit

product_sortIndex
integer

Product sort index

product_type
string

In case of adding new sidedishes or extras you need to provide the product_type. For example, if you're adding 'Fries' as a side you need to provide 'food'.

object
object

Responses

Request samples

Content type
application/json
{
  • "productgroup_id": 1,
  • "product_name": "Coca cola",
  • "product_price": 124.25,
  • "product_vat": 10.5,
  • "product_vat_id": 1234,
  • "product_itemnumber": "x-123",
  • "product_externalReference": "xxx-123",
  • "product_barcode": 12345678,
  • "product_description": "lorem ipsum dolor sit amet",
  • "product_priceIncludesVat": false,
  • "product_active": true,
  • "product_discountable": true,
  • "product_stock_enabled": true,
  • "product_stock_value": 10.5,
  • "product_stock_reorderLevel": 2.5,
  • "product_stock_safetyStock": 5.1,
  • "product_stock_unit": "Kg",
  • "product_sortIndex": 5,
  • "product_type": "food, drink or default",
  • "productgroup": {
    },
  • "product_base": {
    }
}

Response samples

Content type
application/json
{
  • "product_id": 1234,
  • "product_externalReference": "ref-1234",
  • "product_itemnumber": 1,
  • "product_barcode": "x400467508233",
  • "product_name": "coca cola",
  • "product_description": "coca cola - non-alcoholic drink",
  • "product_price": 10.5,
  • "product_priceIncludesVat": false,
  • "product_vat": 2,
  • "product_vat_id": 2,
  • "product_customPrice": true,
  • "product_customQuantity": true,
  • "product_fav": true,
  • "product_highlight": true,
  • "product_expressMode": true,
  • "product_stock_enabled": true,
  • "product_ingredients_enabled": true,
  • "product_variations_enabled": true,
  • "product_stock_value": 100,
  • "product_stock_unit": "kg",
  • "product_stock_reorderLevel": 10,
  • "product_stock_safetyStock": 20,
  • "product_sortIndex": 5,
  • "product_soldOut": true,
  • "product_sideDishOrder": true,
  • "product_discountable": true,
  • "product_accountingCode": 1000123,
  • "product_colorClass": "bgGreenYellow",
  • "productgroup_id": 1,
  • "product_type_id": 1,
  • "product_type": "standard",
  • "product_created_at": "2019-01-01 11:11:11",
  • "product_updated_at": "2019-01-01 11:11:11",
  • "product_alternativeNameOnReceipts": "xxx cola",
  • "product_alternativeNameInPos": "yyy cola",
  • "productgroup": {
    },
  • "productvariation": [
    ],
  • "productingredient": [
    ]
}

Find Product by Id

Authorizations:
Bearer
path Parameters
id
required
integer

Product ID to find

query Parameters
includeProductGroup
boolean

include product group information

includeProductVariations
boolean

include product variations information

includeProductIngredients
boolean

include product variations information

Responses

Response samples

Content type
application/json
{
  • "product_id": 1234,
  • "product_externalReference": "ref-1234",
  • "product_itemnumber": 1,
  • "product_barcode": "x400467508233",
  • "product_name": "coca cola",
  • "product_description": "coca cola - non-alcoholic drink",
  • "product_price": 10.5,
  • "product_priceIncludesVat": false,
  • "product_vat": 2,
  • "product_vat_id": 2,
  • "product_customPrice": true,
  • "product_customQuantity": true,
  • "product_fav": true,
  • "product_highlight": true,
  • "product_expressMode": true,
  • "product_stock_enabled": true,
  • "product_ingredients_enabled": true,
  • "product_variations_enabled": true,
  • "product_stock_value": 100,
  • "product_stock_unit": "kg",
  • "product_stock_reorderLevel": 10,
  • "product_stock_safetyStock": 20,
  • "product_sortIndex": 5,
  • "product_soldOut": true,
  • "product_sideDishOrder": true,
  • "product_discountable": true,
  • "product_accountingCode": 1000123,
  • "product_colorClass": "bgGreenYellow",
  • "productgroup_id": 1,
  • "product_type_id": 1,
  • "product_type": "standard",
  • "product_created_at": "2019-01-01 11:11:11",
  • "product_updated_at": "2019-01-01 11:11:11",
  • "product_alternativeNameOnReceipts": "xxx cola",
  • "product_alternativeNameInPos": "yyy cola",
  • "productgroup": {
    },
  • "productvariation": [
    ],
  • "productingredient": [
    ]
}

Update Product by Id

Authorizations:
Bearer
path Parameters
id
required
integer

product id

Request Body schema: application/json
product_vat
string

VAT-Rate in decimals. Provide either product_vat or product_vat_id

product_vat_id
integer

ID of VAT-rate (see /vat-rates). Provide either product_vat or product_vat_id

product_name
string

Product name

product_itemnumber
string

Item number

product_externalReference
string

External reference

product_barcode
string

Barcode

product_description
string

Optional description

product_price
string

Product price

product_priceIncludesVat
boolean

Whether price is provided included or excluding VAT

product_active
boolean

Is product active

product_discountable
boolean

Is product discountable

product_stock_enabled
boolean

Is stock for product enabled

product_stock_value
string

Product stock value

product_stock_reorderLevel
string

Product stock reorder level

product_stock_safetyStock
string

Product stock safety level

product_stock_unit
string

Product stock unit

product_sortIndex
integer

Product sort index

productgroup_id
integer

Product group id

product_type
string

In case of adding new sidedishes or extras you need to provide the product_type. For example, if you're adding 'Fries' as a side you need to provide 'food'.

object
object

Responses

Request samples

Content type
application/json
{
  • "product_vat": 10.5,
  • "product_vat_id": 1234,
  • "product_name": "Coca cola",
  • "product_itemnumber": "x-123",
  • "product_externalReference": "xxx-123",
  • "product_barcode": 12345678,
  • "product_description": "lorem ipsum dolor sit amet",
  • "product_price": 124.25,
  • "product_priceIncludesVat": false,
  • "product_active": true,
  • "product_discountable": true,
  • "product_stock_enabled": true,
  • "product_stock_value": 10.5,
  • "product_stock_reorderLevel": 2.5,
  • "product_stock_safetyStock": 5.1,
  • "product_stock_unit": "Kg",
  • "product_sortIndex": 5,
  • "productgroup_id": 1,
  • "product_type": "food, drink or default",
  • "product_base": {
    },
  • "productgroup": {
    }
}

Response samples

Content type
application/json
{
  • "product_id": 1234,
  • "product_externalReference": "ref-1234",
  • "product_itemnumber": 1,
  • "product_barcode": "x400467508233",
  • "product_name": "coca cola",
  • "product_description": "coca cola - non-alcoholic drink",
  • "product_price": 10.5,
  • "product_priceIncludesVat": false,
  • "product_vat": 2,
  • "product_vat_id": 2,
  • "product_customPrice": true,
  • "product_customQuantity": true,
  • "product_fav": true,
  • "product_highlight": true,
  • "product_expressMode": true,
  • "product_stock_enabled": true,
  • "product_ingredients_enabled": true,
  • "product_variations_enabled": true,
  • "product_stock_value": 100,
  • "product_stock_unit": "kg",
  • "product_stock_reorderLevel": 10,
  • "product_stock_safetyStock": 20,
  • "product_sortIndex": 5,
  • "product_soldOut": true,
  • "product_sideDishOrder": true,
  • "product_discountable": true,
  • "product_accountingCode": 1000123,
  • "product_colorClass": "bgGreenYellow",
  • "productgroup_id": 1,
  • "product_type_id": 1,
  • "product_type": "standard",
  • "product_created_at": "2019-01-01 11:11:11",
  • "product_updated_at": "2019-01-01 11:11:11",
  • "product_alternativeNameOnReceipts": "xxx cola",
  • "product_alternativeNameInPos": "yyy cola",
  • "productgroup": {
    },
  • "productvariation": [
    ],
  • "productingredient": [
    ]
}

Delete Product by Id

Authorizations:
Bearer
path Parameters
id
required
integer

Product ID to delete

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "Product was deleted successfully."
}

Update Stock In Batch

Authorizations:
Bearer
Request Body schema: application/json
Array of objects

List of products

Responses

Request samples

Content type
application/json
{
  • "products": "List of products"
}

Response samples

Content type
application/json
{
  • "updatedIds": {
    },
  • "updatedItemNumbers": {
    }
}

Get Stock

Authorizations:
Bearer
path Parameters
id
required
integer

Product ID

Responses

Response samples

Content type
application/json
{
  • "product_id": 1234,
  • "product_stock": 10,
  • "product_reorderLevel": 5.2,
  • "product_safetyStock": 2.1,
  • "product_unit": "piece"
}

Update Stock

Authorizations:
Bearer
path Parameters
id
required
integer

Product ID

Request Body schema: application/json
product_stock
string
product_reorderLevel
string
product_safetyStock
string
product_stockDelta
string

Responses

Request samples

Content type
application/json
{
  • "product_stock": "string",
  • "product_reorderLevel": "string",
  • "product_safetyStock": "string",
  • "product_stockDelta": "string"
}

Response samples

Content type
application/json
{
  • "product_id": 1234,
  • "product_stock": 10,
  • "product_reorderLevel": 5.2,
  • "product_safetyStock": 2.1,
  • "product_unit": "piece"
}

Get Stock By Item Number

Authorizations:
Bearer
path Parameters
itemNumber
required
string

Product item number

Responses

Response samples

Content type
application/json
{
  • "product_id": 1234,
  • "product_stock": 10,
  • "product_reorderLevel": 5.2,
  • "product_safetyStock": 2.1,
  • "product_unit": "piece"
}

Get All Customer Category Product Prices

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Customer Category Product Price

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Request Body schema: application/json
price_value
string
customerCategory_id
integer

Responses

Request samples

Content type
application/json
{
  • "price_value": "string",
  • "customerCategory_id": 9999
}

Response samples

Content type
application/json
{
  • "price_id": 1234,
  • "price_value": 12.45,
  • "price_valueGross": 13.56,
  • "price_valueNet": 12.45,
  • "price_timestamp": 1234,
  • "product_id": 1234,
  • "customerCategory_id": 1
}

Get Customer Category Product Price

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

customerCategoryId
required
integer

Customer category ID to find

Responses

Response samples

Content type
application/json
{
  • "price_id": 1234,
  • "price_value": 12.45,
  • "price_valueGross": 13.56,
  • "price_valueNet": 12.45,
  • "price_timestamp": 1234,
  • "product_id": 1234,
  • "customerCategory_id": 1
}

Update Customer Category Product Price

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

customerCategoryId
required
integer

customer category id

Request Body schema: application/json
price_value
string

Responses

Request samples

Content type
application/json
{
  • "price_value": "string"
}

Response samples

Content type
application/json
{
  • "price_id": 1234,
  • "price_value": 12.45,
  • "price_valueGross": 13.56,
  • "price_valueNet": 12.45,
  • "price_timestamp": 1234,
  • "product_id": 1234,
  • "customerCategory_id": 1
}

Delete Customer Category Product Price

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

customerCategoryId
required
integer

Customer category ID to find

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "Product price was deleted successfully."
}

Get All Customer Product Prices

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Customer Product Price

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Request Body schema: application/json
price_value
string
customer_id
integer

Responses

Request samples

Content type
application/json
{
  • "price_value": "string",
  • "customer_id": 9999
}

Response samples

Content type
application/json
{
  • "price_id": 1234,
  • "price_value": 12.45,
  • "price_valueGross": 13.56,
  • "price_valueNet": 12.45,
  • "price_timestamp": 1234,
  • "product_id": 1234,
  • "customer_id": 1
}

Get Customer Product Price

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

customerId
required
integer

Customer category ID to find

Responses

Response samples

Content type
application/json
{
  • "price_id": 1234,
  • "price_value": 12.45,
  • "price_valueGross": 13.56,
  • "price_valueNet": 12.45,
  • "price_timestamp": 1234,
  • "product_id": 1234,
  • "customer_id": 1
}

Update Customer Product Price

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

customerId
required
integer

customer id

Request Body schema: application/json
price_value
string

Responses

Request samples

Content type
application/json
{
  • "price_value": "string"
}

Response samples

Content type
application/json
{
  • "price_id": 1234,
  • "price_value": 12.45,
  • "price_valueGross": 13.56,
  • "price_valueNet": 12.45,
  • "price_timestamp": 1234,
  • "product_id": 1234,
  • "customer_id": 1
}

Delete Customer Product Price

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

customerId
required
integer

Customer category ID to find

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "Product price was deleted successfully."
}

ProductGroup

List all Product Groups

Authorizations:
Bearer
query Parameters
page
integer

Page you want to display

limit
integer

Items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Product Group

Authorizations:
Bearer
Request Body schema: application/json
productgroup_name
string
productgroup_description
string
productgroup_shortcut
string
productgroup_active
boolean
productgroup_parent
integer
productgroup_sortIndex
integer
productgroup_accountingCode
string
productgroup_accountingCodeName
string
productgroup_accountingCodeVatRate
string
productgroup_type_id
integer

Responses

Request samples

Content type
application/json
{
  • "productgroup_name": "string",
  • "productgroup_description": "string",
  • "productgroup_shortcut": "string",
  • "productgroup_active": false,
  • "productgroup_parent": 9999,
  • "productgroup_sortIndex": 9999,
  • "productgroup_accountingCode": "string",
  • "productgroup_accountingCodeName": "string",
  • "productgroup_accountingCodeVatRate": "string",
  • "productgroup_type_id": 9999
}

Response samples

Content type
application/json
{
  • "productgroup_id": 83012,
  • "productgroup_name": "Favorites",
  • "productgroup_description": "Just a description",
  • "productgroup_shortcut": "fav",
  • "productgroup_active": true,
  • "productgroup_sortIndex": -1,
  • "productgroup_created_at": "2019-07-29 08:26:18",
  • "productgroup_updated_at": "2019-07-29 08:26:18",
  • "productgroup_type_id": 2
}

Find Product Group by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "productgroup_id": 83012,
  • "productgroup_name": "Favorites",
  • "productgroup_description": "Just a description",
  • "productgroup_shortcut": "fav",
  • "productgroup_active": true,
  • "productgroup_sortIndex": -1,
  • "productgroup_created_at": "2019-07-29 08:26:18",
  • "productgroup_updated_at": "2019-07-29 08:26:18",
  • "productgroup_type_id": 2
}

Update Product Group by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Request Body schema: application/json
productgroup_name
string
productgroup_description
string
productgroup_shortcut
string
productgroup_active
boolean
productgroup_parent
integer
productgroup_sortIndex
integer
productgroup_accountingCode
string
productgroup_accountingCodeName
string
productgroup_accountingCodeVatRate
string
productgroup_type_id
integer

Responses

Request samples

Content type
application/json
{
  • "productgroup_name": "string",
  • "productgroup_description": "string",
  • "productgroup_shortcut": "string",
  • "productgroup_active": false,
  • "productgroup_parent": 9999,
  • "productgroup_sortIndex": 9999,
  • "productgroup_accountingCode": "string",
  • "productgroup_accountingCodeName": "string",
  • "productgroup_accountingCodeVatRate": "string",
  • "productgroup_type_id": 9999
}

Response samples

Content type
application/json
{
  • "productgroup_id": 83012,
  • "productgroup_name": "Favorites",
  • "productgroup_description": "Just a description",
  • "productgroup_shortcut": "fav",
  • "productgroup_active": true,
  • "productgroup_sortIndex": -1,
  • "productgroup_created_at": "2019-07-29 08:26:18",
  • "productgroup_updated_at": "2019-07-29 08:26:18",
  • "productgroup_type_id": 2
}

Delete Product Group by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "Productgroup was deleted successfully"
}

Find With Products By Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "productgroup_id": 83012,
  • "productgroup_name": "Favorites",
  • "productgroup_description": "Just a description",
  • "productgroup_shortcut": "fav",
  • "productgroup_active": true,
  • "productgroup_sortIndex": -1,
  • "productgroup_created_at": "2019-07-29 08:26:18",
  • "productgroup_updated_at": "2019-07-29 08:26:18",
  • "productgroup_type_id": 2
}

Storno

List all Stornos

Authorizations:
Bearer
query Parameters
page
integer

Page you want to display

limit
integer

Items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Storno

Authorizations:
Bearer
Request Body schema: application/json
storno_name
string

Storno name

storno_description
string

Storno description

Responses

Request samples

Content type
application/json
{
  • "storno_name": "cancellation",
  • "storno_description": "storno reason 1234"
}

Response samples

Content type
application/json
{
  • "storno_id": 1234,
  • "storno_name": "cancellation",
  • "storno_description": "storno reason 1234",
  • "storno_created_at": "2019-01-01 12:00:00"
}

Find Storno by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "storno_id": 1234,
  • "storno_name": "cancellation",
  • "storno_description": "storno reason 1234",
  • "storno_created_at": "2019-01-01 12:00:00"
}

Update Storno by Id

Authorizations:
Bearer
path Parameters
id
required
integer

storno id

Responses

Response samples

Content type
application/json
{
  • "storno_id": 1234,
  • "storno_name": "cancellation",
  • "storno_description": "storno reason 1234",
  • "storno_created_at": "2019-01-01 12:00:00"
}

Delete Storno by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "Storno was successfully deleted!"
}

Table

List all Tables

Authorizations:
Bearer
query Parameters
page
integer

Page you want to display

limit
integer

Items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Table

Authorizations:
Bearer
Request Body schema: application/json
table_name
string
table_isTemporay
boolean
table_checkoutMode
boolean
table_order
integer
table_description
string
tableArea_id
integer

Responses

Request samples

Content type
application/json
{
  • "table_name": 1234,
  • "table_isTemporay": true,
  • "table_checkoutMode": false,
  • "table_order": 1,
  • "table_description": 1234,
  • "tableArea_id": 1
}

Response samples

Content type
application/json
{
  • "table_id": 1234,
  • "table_name": 1234,
  • "table_description": 1234,
  • "table_isTemporay": true,
  • "table_order": 1,
  • "table_checkoutMode": false,
  • "tableArea_id": 1,
  • "table_created_at": "2019-01-01 12:12:12",
  • "table_updated_at": "2019-01-01 12:12:12"
}

Find Table by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "table_id": 1234,
  • "table_name": 1234,
  • "table_description": 1234,
  • "table_isTemporay": true,
  • "table_order": 1,
  • "table_checkoutMode": false,
  • "tableArea_id": 1,
  • "table_created_at": "2019-01-01 12:12:12",
  • "table_updated_at": "2019-01-01 12:12:12"
}

Update Table by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "table_id": 1234,
  • "table_name": 1234,
  • "table_description": 1234,
  • "table_isTemporay": true,
  • "table_order": 1,
  • "table_checkoutMode": false,
  • "tableArea_id": 1,
  • "table_created_at": "2019-01-01 12:12:12",
  • "table_updated_at": "2019-01-01 12:12:12"
}

Delete Table by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "Table was deleted successfully."
}

TableArea

List all Table Areas

Authorizations:
Bearer
query Parameters
page
integer

Page you want to display

limit
integer

Items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Table Area

Authorizations:
Bearer
Request Body schema: application/json
tableArea_name
string

Table name

tableArea_shortName
string

Table area short name

tableArea_order
string

Table area order number (sorting)

tableArea_allowTemporaryTables
boolean

Allow temporary tables

tableArea_active
boolean

Table is active

Responses

Request samples

Content type
application/json
{
  • "tableArea_name": "innen 1",
  • "tableArea_shortName": "IN-1",
  • "tableArea_order": 1,
  • "tableArea_allowTemporaryTables": true,
  • "tableArea_active": true
}

Response samples

Content type
application/json
{
  • "tableArea_id": 1234,
  • "tableArea_name": "innen 1",
  • "tableArea_shortName": "IN-1",
  • "tableArea_order": 1,
  • "tableArea_allowTemporaryTables": true,
  • "tableArea_active": true,
  • "tableArea_intelligentFavourites": 1
}

Find Table Area by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "tableArea_id": 1234,
  • "tableArea_name": "innen 1",
  • "tableArea_shortName": "IN-1",
  • "tableArea_order": 1,
  • "tableArea_allowTemporaryTables": true,
  • "tableArea_active": true,
  • "tableArea_intelligentFavourites": 1
}

Update Table Area by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Request Body schema: application/json
tableArea_name
string

Table name

tableArea_shortName
string

Table area short name

tableArea_order
string

Table area order number (sorting)

tableArea_allowTemporaryTables
boolean

Allow temporary tables

tableArea_active
boolean

Table is active

Responses

Request samples

Content type
application/json
{
  • "tableArea_name": "innen 1",
  • "tableArea_shortName": "IN-1",
  • "tableArea_order": 1,
  • "tableArea_allowTemporaryTables": true,
  • "tableArea_active": true
}

Response samples

Content type
application/json
{
  • "tableArea_id": 1234,
  • "tableArea_name": "innen 1",
  • "tableArea_shortName": "IN-1",
  • "tableArea_order": 1,
  • "tableArea_allowTemporaryTables": true,
  • "tableArea_active": true,
  • "tableArea_intelligentFavourites": 1
}

Delete Table Area by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "TableArea was successfully deleted!"
}

User

List all Users

Authorizations:
Bearer
query Parameters
page
integer

Page you want to display

limit
integer

Items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new User

Authorizations:
Bearer
Request Body schema: application/json
user_username
string
user_password
string
user_firstName
string
user_lastName
string
user_trainingsMode
boolean
user_printer
integer
user_printAccess
integer
right_id
integer

Responses

Request samples

Content type
application/json
{
  • "user_username": "[email protected]",
  • "user_password": "StrongPassword123!",
  • "user_firstName": "Christoph",
  • "user_lastName": "Müller",
  • "user_trainingsMode": true,
  • "user_printer": 123,
  • "user_printAccess": 2457,
  • "right_id": 1234
}

Response samples

Content type
application/json
{
  • "user_id": 1234,
  • "user_firstName": "Christoph",
  • "user_lastName": "Müller",
  • "user_username": "[email protected]",
  • "user_printAccess": 1234,
  • "user_printer": 15,
  • "user_lastActionAt": "2018-11-05 01:23:45",
  • "user_lastLoginAt": "2018-11-05 01:23:45",
  • "user_trainingsMode": true,
  • "right_id": 1234
}

Find User by Id

Authorizations:
Bearer
path Parameters
id
required
integer

User ID to find

Responses

Response samples

Content type
application/json
{
  • "user_id": 1234,
  • "user_firstName": "Christoph",
  • "user_lastName": "Müller",
  • "user_username": "[email protected]",
  • "user_printAccess": 1234,
  • "user_printer": 15,
  • "user_lastActionAt": "2018-11-05 01:23:45",
  • "user_lastLoginAt": "2018-11-05 01:23:45",
  • "user_trainingsMode": true,
  • "right_id": 1234
}

Update User by Id

Authorizations:
Bearer
path Parameters
id
required
integer

User ID to update

Request Body schema: application/json
user_username
string
user_password
string
user_firstName
string
user_lastName
string
user_trainingsMode
boolean
user_printer
integer
user_printAccess
integer
right_id
integer

Responses

Request samples

Content type
application/json
{
  • "user_username": "[email protected]",
  • "user_password": "StrongPassword123!",
  • "user_firstName": "Christoph",
  • "user_lastName": "Müller",
  • "user_trainingsMode": true,
  • "user_printer": 123,
  • "user_printAccess": 2457,
  • "right_id": 1234
}

Response samples

Content type
application/json
{
  • "user_id": 1234,
  • "user_firstName": "Christoph",
  • "user_lastName": "Müller",
  • "user_username": "[email protected]",
  • "user_printAccess": 1234,
  • "user_printer": 15,
  • "user_lastActionAt": "2018-11-05 01:23:45",
  • "user_lastLoginAt": "2018-11-05 01:23:45",
  • "user_trainingsMode": true,
  • "right_id": 1234
}

Delete User by Id

Authorizations:
Bearer
path Parameters
id
required
integer

User ID to delete

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "User was successfully deleted!"
}

Update Password By Id

Authorizations:
Bearer
path Parameters
id
required
integer

User ID to update password

Request Body schema: application/json
user_password
string

Responses

Request samples

Content type
application/json
{
  • "user_password": "StrongPassword123!"
}

Response samples

Content type
application/json
{
  • "user_id": 1234,
  • "user_firstName": "Christoph",
  • "user_lastName": "Müller",
  • "user_username": "[email protected]",
  • "user_printAccess": 1234,
  • "user_printer": 15,
  • "user_lastActionAt": "2018-11-05 01:23:45",
  • "user_lastLoginAt": "2018-11-05 01:23:45",
  • "user_trainingsMode": true,
  • "right_id": 1234
}

Get Sign In Token

Authorizations:
Bearer
path Parameters
id
required
integer

User ID to generate token

query Parameters
expiresIn
integer

Life-time of token (seconds)

Request Body schema: application/json
crmUserId
string

Responses

Request samples

Content type
application/json
{
  • "crmUserId": "string"
}

Response samples

Content type
application/json
{}

UserRoles

List all User Roles

Authorizations:
Bearer
query Parameters
page
integer

Page you want to display

limit
integer

Items per page

Responses

Response samples

Content type
application/json
{
  • "userRight_name": "string",
  • "userRight_description": "string",
  • "userRight_allowGastroTransferOrders": false,
  • "userRight_allowGastroCancellation": false,
  • "userRight_allowGastroCancellationWithoutReceiptPrinting": false,
  • "userRight_allowCancellationInvoice": 9999,
  • "userRight_allowOrderRetourMode": false,
  • "userRight_allowGastroOrder": "string",
  • "userRight_allowGastroPayment": "string",
  • "userRight_showOwnOrdersOnly": false,
  • "userRight_allowOpenDay": false,
  • "userRight_allowCloseDay": false,
  • "userRight_allowSalesReport": false,
  • "userRight_allowSalesReportOwnOnly": false,
  • "userRight_allowSalesDailyReports": false,
  • "userRight_allowProductPage": false,
  • "userRight_allowOrderStop": false,
  • "userRight_allowProductSoldOut": false,
  • "userRight_allowProductFavorite": false,
  • "userRight_allowProductAddSideDish": false,
  • "userRight_showProductStock": false,
  • "userRight_allowPrintProductStock": false,
  • "userRight_allowInvoicePage": false,
  • "userRight_invoicePageShowOwnInvoicesOnly": false,
  • "userRight_allowCashBook": false,
  • "userRight_allowCashBookInsert": false,
  • "userRight_allowCashBookPdfExport": false,
  • "userRight_showCashBookBalance": false,
  • "userRight_allowBackendLogin": false,
  • "userRight_allowPrinterPage": false,
  • "userRight_allowPrinterDiscovery": false,
  • "userRight_allowLogoutAllUsers": false,
  • "userRight_allowOpenShiftAgain": false,
  • "userRight_allowProductDiscount": false,
  • "userRight_allowSelectedProductPriceChange": false
}

Webhook

Find

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{}

Update Webhook Url

Authorizations:
Bearer
Request Body schema: application/json
webhookUrl
string

Responses

Request samples

Content type
application/json
{
  • "webhookUrl": "string"
}

Response samples

Content type
application/json
{}

Find Webhook Events

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "activeEvents": [
    ],
  • "availableEvents": [
    ]
}

Update Webhook Event

Authorizations:
Bearer
Request Body schema: application/json
addEvent
string
removeEvent
string

Responses

Request samples

Content type
application/json
{
  • "addEvent": "string",
  • "removeEvent": "string"
}

Response samples

Content type
application/json
{
  • "error": true,
  • "success": false,
  • "msg": "Your now receiving webhooks for the event <name>"
}

Account Token

Revoke Account Token

This endpoint can be used to revoke the currently used API Account Token.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "Access was revoked successfully"
}

DailyReport

Open

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "Day was opened successfully."
}

Close

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "Day was closed successfully."
}

Status

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "success": true,
  • "msg": "success",
  • "status": "open"
}

Printer Profile

List all Printer Profiles

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Units

List all Units

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "identifier": "kg|piece|hours|liter|..."
}

VatRate

List all Vat Rates

This endpoint returns a list of all available VatRates for this account

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]