ready2order Public API (R2-2024.42.1-patch1)

Download OpenAPI specification:Download

Introduction

The API of ready2order uses tokens for authentication. These tokens have to be set in the Authorization header of your request. (Please note the correct spelling of Authorization in your request header!)

Types of tokens

Developer-Token

This token identifies the developer who is using the API. With that token you can request permissions to existing ready2order accounts. To start, please go to api.ready2order.com, sign up as a developer and follow the instruction in the email. Your Developer-Token will be included in that email!

The Developer-Token is only needed for:

  • requesting Grant-Access-Token

Grant-Access-Token

This token identifies the request of developer who wants to use the API. With that token you can request permissions to existing ready2order accounts.

Account-Token

The Account-Token is the key to access account data like products, product groups, customers and more. To interact with data of ready2order accounts you must use this token!

Getting started

1. Get Developer-Token

Initially you have to request a unique Developer Token for your application at api.ready2order.com. Therefore, call the following URL with the following request data. You don’t need to set the Authorization header by now, as you don’t have your token yet.

2. Get a Grant-Access-Token

With your Developer token you can request Grant-Access-Token. Call POST /v1/developerToken/grantAccessToken endpoint to request that. You can specify the callbackUri in this step (see detailed description below). In the response you will get the grantAccessToken but also the full URI (field grantAccessUri) you can use for approving the access.

2. Get Account-Token

Call the grantAccessUri and login with the credentials of an existing ready2order account. After login, the user will see a confirmation box to grant your application access. If it is specified we will redirect to callbackUri specified in previous step after the Grant-Access-Token is approved or denied by the Account. Example of callbackUri: http://www.ready2order.com?your-extra-param=123 We will then redirect to: http://www.ready2order.com?your-extra-param=123&accountToken=__ACCOUNT_TOKEN__&grantAccessToken=__GRANT_ACCESS_TOKEN__&status=approved|denied Grant-Access-Token has expiration set! You have 10 minutes to get this token approved by the Account. Otherwise you would need to create new one!

Rate limit

You can make up to 60 requests per minute per Account-Token. If you exceed the rate limit you will see the following response.

    {
        'error':true,
        'http':429,
        'code':'rateLimitExceeded',
        'rateLimitRequestPerMinute':60,
        'rateLimitRequest':60,
        'rateLimitMinutes':1,
        'msg':'You have reached the rate limit of 60 requests per minute. You were blocked for at least 1 minutes! Try again later!'
    }

Webhooks

ready2order supports webhooks for the best experience.

Available events

  • product.created is triggered whenever a new product is created
  • product.updated is triggered whenever an existing product is updated
  • product.deleted is triggered whenever an existing product is deleted
  • productGroup.created is triggered whenever a new product group is created
  • productGroup.updated is triggered whenever an existing product group is updated
  • productGroup.deleted is triggered whenever an existing product group is deleted
  • invoice.created is triggered whenever a new receipt (bill, invoice, payment-receipt, ...) is created
  • orderItem.created is triggered whenever a gastro-order is booked on a table

Payloads

  • for created and updated events we send the full objects to your webhook URL in the resource array, so you don't need to ask our API again.__
  • for deleted events we provide you the IDs which has been deleted__

Get started

  • To start with webhooks, you have to set up your webhook URL (see Webhook-section). You have to subscribe for events for which you want to be notified. Please see the list of available events above.

Account

Get Account Info

Get Account Info

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "company_id": 1,
  • "company_branch": 1,
  • "company_username": "Franz123",
  • "company_accountNumber": "123456a",
  • "company_name": "ABC GmbH",
  • "company_business": "ABC GmbH",
  • "company_firstName": "Franz",
  • "company_lastName": "Klein",
  • "company_vatId": "1",
  • "company_street": "Hintere Zollamtsstraße 17/4",
  • "company_city": "Wien",
  • "company_zip": "1030",
  • "company_phone": "+43 6 123 456 789",
  • "company_businessPhoneNumber": "+43 6 123 456 789",
  • "company_website": "http://www.abc.at",
  • "company_referrer": "cde",
  • "company_failedLoginAttempts": 1,
  • "company_trainingsMode": false,
  • "company_liveMode": false,
  • "company_liveModeStartedAt": "2019-01-01",
  • "language_id": 1,
  • "currency_id": 1,
  • "country_id": "1",
  • "company_partnerData": "xxx"
}

Update Account

Update Account

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

business country id

company_legalForm
integer

legal form id

company_name
string

company name

company_email
string

company email

company_username
string

user name

company_street
string

street

company_businessStreet
string

business street

company_city
string

city

company_businessCity
string

business city

company_zip
string

zip

company_businessZip
string

business zip

company_phone
string
company_businessPhoneNumber
string
company_website
string

company website

company_businessRegistrationNumber
string

business registration number

company_globalLocationNumber
string

business GLN number

company_disableVatReason
integer

business disable VAT reason id

company_taxOffice
integer

business tax office number

company_taxIdentificationNumber
string

business tax identification mumber

language_id
integer

language id

currency_id
integer

currency id

company_requireBillingMethodBeforeLiveMode
boolean

is required to have billing method before live mode started?

company_partnerData
string

partner data

company_businessDateOfBirth
string

company date of birth

syncToSalesforce
boolean
company_accountNumber
string

account number

Responses

Request samples

Content type
application/json
{
  • "company_businessCountry": 1,
  • "company_legalForm": 1,
  • "company_name": "ABC GmbH",
  • "company_email": "[email protected]",
  • "company_username": "Franz123",
  • "company_street": "Hintere Zollamtsstraße 17/4",
  • "company_businessStreet": "Hintere Zollamtsstraße 17",
  • "company_city": "Wien",
  • "company_businessCity": "Wien",
  • "company_zip": "1030",
  • "company_businessZip": "1030",
  • "company_phone": "+43 6 123 456 789",
  • "company_businessPhoneNumber": "+43 6 123 456 789",
  • "company_website": "http://www.abc.at",
  • "company_businessRegistrationNumber": "1234567890123",
  • "company_globalLocationNumber": "1234567890123",
  • "company_disableVatReason": 1,
  • "company_taxOffice": 39,
  • "company_taxIdentificationNumber": "125705103",
  • "language_id": 1,
  • "currency_id": 1,
  • "company_requireBillingMethodBeforeLiveMode": false,
  • "company_partnerData": "xxx",
  • "company_businessDateOfBirth": "yyyy-mm-dd",
  • "syncToSalesforce": false,
  • "company_accountNumber": "123456a"
}

Response samples

Content type
application/json
{
  • "company_id": 1,
  • "company_branch": 1,
  • "company_username": "Franz123",
  • "company_accountNumber": "123456a",
  • "company_name": "ABC GmbH",
  • "company_business": "ABC GmbH",
  • "company_firstName": "Franz",
  • "company_lastName": "Klein",
  • "company_vatId": "1",
  • "company_street": "Hintere Zollamtsstraße 17/4",
  • "company_city": "Wien",
  • "company_zip": "1030",
  • "company_phone": "+43 6 123 456 789",
  • "company_businessPhoneNumber": "+43 6 123 456 789",
  • "company_website": "http://www.abc.at",
  • "company_referrer": "cde",
  • "company_failedLoginAttempts": 1,
  • "company_trainingsMode": false,
  • "company_liveMode": false,
  • "company_liveModeStartedAt": "2019-01-01",
  • "language_id": 1,
  • "currency_id": 1,
  • "country_id": "1",
  • "company_partnerData": "xxx"
}

AccountingFinancialYear

Get all Accounting Financial Years

Get all Accounting Financial Years

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Accounting Financial Year by Id

Get 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

Get all Bills

Get 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 Invoice

Create Invoice

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

PaymentMethod ID

user_id
integer

User 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_roundToSmallestCurrencyUnit
string

Rounding to 0.05 or 0.10 cents

invoice_priceBase
string

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

Array of objects

Address object

Responses

Request samples

Content type
application/json
{
  • "paymentMethod_id": 123456,
  • "user_id": 123456,
  • "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_roundToSmallestCurrencyUnit": "0.05, 0.1",
  • "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": [
    ],
  • "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": "string",
  • "invoice_totalNet": "string",
  • "invoice_totalVat": "string",
  • "invoice_totalTip": "string",
  • "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,
  • "id": "TFRG4C6NG2",
  • "r2o_id": "U1JGILYS",
  • "items": [
    ],
  • "address": {
    },
  • "type": {
    },
  • "payment": [
    ],
  • "transaction": {
    },
  • "discounts": [
    ]
}

Count All Bills

Count All Bills

Authorizations:
Bearer

Responses

Response samples

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

Get Bill by Id

Get 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": "string",
  • "invoice_totalNet": "string",
  • "invoice_totalVat": "string",
  • "invoice_totalTip": "string",
  • "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,
  • "id": "TFRG4C6NG2",
  • "r2o_id": "U1JGILYS",
  • "items": [
    ],
  • "address": {
    },
  • "type": {
    },
  • "payment": [
    ],
  • "transaction": {
    },
  • "discounts": [
    ]
}

Delete Bill by Id

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": "string",
  • "invoice_totalNet": "string",
  • "invoice_totalVat": "string",
  • "invoice_totalTip": "string",
  • "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,
  • "id": "TFRG4C6NG2",
  • "r2o_id": "U1JGILYS",
  • "items": [
    ],
  • "address": {
    },
  • "type": {
    },
  • "payment": [
    ],
  • "transaction": {
    },
  • "discounts": [
    ]
}

Print

Print

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"
}

Pdf

Pdf

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

Get all Bill Types

Get all Bill Types

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Bill Type by Id

Get 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

Get all Countries

Get all Countries

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Country by Id

Get 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

Get all Coupons

Get all Coupons

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

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
coupon_purpose
string
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|multiple",
  • "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-Discount",
  • "coupon_containsVat": "string",
  • "coupon_purpose": "single|multiple",
  • "couponCategory_id": 4,
  • "customer_id": 7455,
  • "coupon_identifier": "MyCoupon",
  • "coupon_testMode": true,
  • "coupon_validUntil": "2020-01-31 00:49:39",
  • "coupon_issuedAt": "2018-01-31 00:49:39",
  • "coupon_created_at": "2018-01-31 00:49:39",
  • "coupon_updated_at": "2018-01-31 04:49:39"
}

Get Coupon by Id

Get 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-Discount",
  • "coupon_containsVat": "string",
  • "coupon_purpose": "single|multiple",
  • "couponCategory_id": 4,
  • "customer_id": 7455,
  • "coupon_identifier": "MyCoupon",
  • "coupon_testMode": true,
  • "coupon_validUntil": "2020-01-31 00:49:39",
  • "coupon_issuedAt": "2018-01-31 00:49:39",
  • "coupon_created_at": "2018-01-31 00:49:39",
  • "coupon_updated_at": "2018-01-31 04:49:39"
}

Update Coupon by Id

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
coupon_purpose
string
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|multiple",
  • "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-Discount",
  • "coupon_containsVat": "string",
  • "coupon_purpose": "single|multiple",
  • "couponCategory_id": 4,
  • "customer_id": 7455,
  • "coupon_identifier": "MyCoupon",
  • "coupon_testMode": true,
  • "coupon_validUntil": "2020-01-31 00:49:39",
  • "coupon_issuedAt": "2018-01-31 00:49:39",
  • "coupon_created_at": "2018-01-31 00:49:39",
  • "coupon_updated_at": "2018-01-31 04:49:39"
}

Delete Coupon by Id

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

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.0"
}

Response samples

Content type
application/json
{
  • "coupon_id": 1234,
  • "coupon_name": "Christmas-Discount",
  • "coupon_containsVat": "string",
  • "coupon_purpose": "single|multiple",
  • "couponCategory_id": 4,
  • "customer_id": 7455,
  • "coupon_identifier": "MyCoupon",
  • "coupon_testMode": true,
  • "coupon_validUntil": "2020-01-31 00:49:39",
  • "coupon_issuedAt": "2018-01-31 00:49:39",
  • "coupon_created_at": "2018-01-31 00:49:39",
  • "coupon_updated_at": "2018-01-31 04:49:39"
}

Redeem By Id

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-Discount",
  • "coupon_containsVat": "string",
  • "coupon_purpose": "single|multiple",
  • "couponCategory_id": 4,
  • "customer_id": 7455,
  • "coupon_identifier": "MyCoupon",
  • "coupon_testMode": true,
  • "coupon_validUntil": "2020-01-31 00:49:39",
  • "coupon_issuedAt": "2018-01-31 00:49:39",
  • "coupon_created_at": "2018-01-31 00:49:39",
  • "coupon_updated_at": "2018-01-31 04:49:39"
}

CouponCategory

Get all Coupon Categories

Get 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

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"
}

Get Coupon Category by Id

Get 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

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

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

Get Currencies

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Currency

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

Get all Customers

Get 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

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"
}

Get Customer by Id

Get 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

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

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

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 any

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

Get All Customer Groups

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Customer Group

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

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

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

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."
}

DeveloperToken

Create 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

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"
}

Discount

Get all Discounts

Get all Discounts

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Discount

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

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": "string",
  • "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"
}

Get Discount by Id

Get 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": "string",
  • "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

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

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": "string",
  • "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

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

Get All Discount Groups

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Discount Group

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

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

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

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

Export Cashbook

Authorizations:
Bearer
Request Body schema: application/json
dateFrom
string
dateTo
string
fileFormat
string

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

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

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

Export Sales

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

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
}

JobStatus

Get Status By Id

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

Get all Languages

Get all Languages

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Language by Id

Get 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

Get all Legal Forms

Get all Legal Forms

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Legal Form by Id

Get 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
}

License

Order

Get all Orders

Get 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": "string",
  • "order_priceGross": "string",
  • "order_priceNet": "string",
  • "order_vat": "string",
  • "order_discount_valueGross": "string",
  • "order_discount_valueNet": "string",
  • "order_vatRate": "string",
  • "order_product_priceGrossPerUnit": "string",
  • "order_product_priceNetPerUnit": "string",
  • "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

Create a new Order

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

Table on which the orders are booked

price_base
string

'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": "string",
  • "order_priceGross": "string",
  • "order_priceNet": "string",
  • "order_vat": "string",
  • "order_discount_valueGross": "string",
  • "order_discount_valueNet": "string",
  • "order_vatRate": "string",
  • "order_product_priceGrossPerUnit": "string",
  • "order_product_priceNetPerUnit": "string",
  • "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

Get all Payment Methods

Get all Payment Methods

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Payment Method

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
}

Get Payment Method by Id

Get 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

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

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

Get all Payment Method Types

Get all Payment Method Types

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Payment Method Type by Id

Get 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

Get Not Printed

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Print Job

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

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!"
}

PrintLog

Get all Print Logs

Get all Print Logs

Authorizations:
Bearer
query Parameters
page
integer

Page you want to display

limit
integer

Items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Printer

Get all Printers

Get all Printers

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Printer by Id

Get 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

Test Print

Authorizations:
Bearer

Responses

Response samples

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

Product

Update Stock In Batch

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": [
    ]
}

Response samples

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

Get all Products

Get 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

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_itemnumber
string

item number

product_externalReference
string

externa reference

product_barcode
string

barcode

product_description
string

barcode

product_priceIncludesVat
boolean

does price include 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'.

product_vat_id
integer

ID which belongs to vat codes. Provide either product_vat or product_vat_id

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_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",
  • "product_vat_id": 1234,
  • "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": "string",
  • "product_priceIncludesVat": false,
  • "product_vat": "string",
  • "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": "string",
  • "product_stock_unit": "kg",
  • "product_stock_reorderLevel": "string",
  • "product_stock_safetyStock": "string",
  • "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": [
    ]
}

Get Product by Id

Get 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": "string",
  • "product_priceIncludesVat": false,
  • "product_vat": "string",
  • "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": "string",
  • "product_stock_unit": "kg",
  • "product_stock_reorderLevel": "string",
  • "product_stock_safetyStock": "string",
  • "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

Update Product by Id

Authorizations:
Bearer
path Parameters
id
required
integer

product id

Request Body schema: application/json
product_name
string

product name

product_itemnumber
string

item number

product_externalReference
string

externa reference

product_barcode
string

barcode

product_description
string

barcode

product_price
string

product price

product_priceIncludesVat
boolean

does price include VAT

product_active
boolean

is product active

product_discountable
boolean

is product discountable

product_vat
string

VAT-Rate in decimals. Provide either product_vat or product_vat_id

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'.

product_vat_id
integer

ID which belongs to vat codes. Provide either product_vat or product_vat_id

object
object

Responses

Request samples

Content type
application/json
{
  • "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_vat": "10.5",
  • "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_vat_id": 1234,
  • "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": "string",
  • "product_priceIncludesVat": false,
  • "product_vat": "string",
  • "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": "string",
  • "product_stock_unit": "kg",
  • "product_stock_reorderLevel": "string",
  • "product_stock_safetyStock": "string",
  • "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

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."
}

Get Stock

Get Stock

Authorizations:
Bearer
path Parameters
id
required
integer

Product ID

Responses

Response samples

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

Update Stock

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": "string",
  • "product_reorderLevel": "string",
  • "product_safetyStock": "string",
  • "product_unit": "piece"
}

Get Stock By Item Number

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": "string",
  • "product_reorderLevel": "string",
  • "product_safetyStock": "string",
  • "product_unit": "piece"
}

Get All Customer Category Product Prices

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

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": "string",
  • "price_valueGross": "string",
  • "price_valueNet": "string",
  • "price_timestamp": "1234",
  • "product_id": 1234,
  • "customerCategory_id": 1
}

Get Customer Category Product Price

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": "string",
  • "price_valueGross": "string",
  • "price_valueNet": "string",
  • "price_timestamp": "1234",
  • "product_id": 1234,
  • "customerCategory_id": 1
}

Update Customer Category Product Price

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": "string",
  • "price_valueGross": "string",
  • "price_valueNet": "string",
  • "price_timestamp": "1234",
  • "product_id": 1234,
  • "customerCategory_id": 1
}

Delete Customer Category Product Price

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

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

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": "string",
  • "price_valueGross": "string",
  • "price_valueNet": "string",
  • "price_timestamp": "1234",
  • "product_id": 1234,
  • "customer_id": 1
}

Get Customer Product Price

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": "string",
  • "price_valueGross": "string",
  • "price_valueNet": "string",
  • "price_timestamp": "1234",
  • "product_id": 1234,
  • "customer_id": 1
}

Update Customer Product Price

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": "string",
  • "price_valueGross": "string",
  • "price_valueNet": "string",
  • "price_timestamp": "1234",
  • "product_id": 1234,
  • "customer_id": 1
}

Delete Customer Product Price

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

Get all Product Groups

Get 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

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
}

Get Product Group by Id

Get 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

Update Product Group by Id

Authorizations:
Bearer
path Parameters
id
required
integer

ID to find

Request Body schema: application/json