Download OpenAPI specification:
Authorization
HTTP header with the appropriate token.Authorization
.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.POST /v1/developerToken/grantAccessToken
Authorization: Bearer <Developer-Token>
callbackUri
(optional): The URI to redirect to after approval or denial (e.g., http://www.ready2order.com?your-extra-param=123
).grantAccessToken
: The token for the next step.grantAccessUri
: The full URI to approve access.grantAccessUri
in the next step.grantAccessUri
from the previous step.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
.http://www.ready2order.com?your-extra-param=123&accountToken=<ACCOUNT_TOKEN>&grantAccessToken=<GRANT_ACCESS_TOKEN>&status=approved
Authorization
header for all account data interactions.ready2order supports webhooks to notify your application of events in real time, providing an optimal experience.
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. |
created
and updated
Events:resource
array of the webhook payload, eliminating the need for additional API calls.deleted
Events:Webhook
section of the API dashboard.id required | integer ID to find |
{- "accountingFinancialYear_id": 1,
- "accountingFinancialYear_number": 477415141,
- "accountingFinancialYear_active": false,
- "accountingFinancialYear_trunkYear": false
}
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) |
{- "invoices": [
- {
- "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_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_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": [
- {
- "item_id": 76234,
- "item_timestamp": "2019-01-01 00:00:00",
- "item_quantity": 1,
- "item_retour": false,
- "item_number": 1,
- "item_serialNumber": "some-serial-number",
- "item_expirationDate": "2019-01-01 00:00:00",
- "item_name": "MyProductName",
- "item_comment": "my-optional-comment",
- "item_price": 12,
- "item_priceNet": 10,
- "item_priceBase": false,
- "item_total": 12,
- "item_totalNet": 10,
- "item_vat": 2,
- "item_vatRate": 20,
- "item_vatCompensation": 0,
- "item_undiscountedSumBeforeLineDiscount": 0,
- "item_undiscountedSumBeforeInvoiceDiscount": 0,
- "item_lineDiscountId": 1234,
- "item_lineDiscountGroupId": 1234,
- "item_lineDiscountName": "SomeDiscountName",
- "item_lineDiscountPercent": 0,
- "item_lineDiscountNet": 0,
- "item_lineDiscountGross": 0,
- "item_invoiceDiscountNet": 0,
- "item_invoiceDiscountGross": 0,
- "item_discountable": true,
- "paymentMethod_id": 1234,
- "item_updatedStock": true,
- "product_id": 1234,
- "productgroup_name": "My product group",
- "productGroup_id": 1234,
- "customer_id": 1234,
- "user_id": 1234,
- "user_name": "SomeUser",
- "invoice_id": 1234,
- "deliveryBill_id": 1234,
- "dailyReport_id": 1234,
- "productUnit_id": 1,
- "table_id": 1234,
- "table_name": "SomeTableName",
- "payment_id": 431,
- "retourInvoice_id": 1233,
- "item_accountingCode": 4000,
- "item_testMode": false,
- "item_product_price": 12,
- "item_product_priceNet": 10,
- "item_product_vat": 2,
- "item_qty": 1,
- "item_product_vatRate": 20,
- "item_product_vatCompensation": 0,
- "item_product_priceNetPerUnit": 10,
- "item_product_pricePerUnit": 12,
- "item_product_discountable": true
}
], - "address": {
- "company": "ready2order GmbH",
- "vatId": "ATU12341234",
- "salutation": "Mr/Ms",
- "title": "Professor",
- "firstName": "Chris",
- "lastName": "Muster",
- "street": "SomeStreet 1234",
- "city": "Vienna",
- "zip": 1030,
- "country": "AT",
- "phone": "+43 1234 12312341234"
}, - "type": {
- "billType_id": 1,
- "billType_name": "Rechnung",
- "billType_symbol": "RG"
}, - "payment": [
- {
- "billPayment_id": 9999,
- "billPayment_name": "Cash",
- "billPayment_value": 12,
- "payment_id": 431,
- "referenced_bill_id": 1234
}
], - "transaction": {
- "id": "TFRG4C6NG2",
- "r2o_id": "U1JGILYS"
}, - "discounts": [
- {
- "billDiscount_id": 9999,
- "billDiscount_name": "SomeDiscountName",
- "billDiscount_value": 0,
- "billDiscount_percent": 0,
- "billDiscount_discount_id": 9999,
- "billDiscount_discountGroup_id": 9999,
- "billDiscount_created_at": "2019-01-01 00:00:00",
- "billDiscount_updated_at": "2019-01-01 00:00:00"
}
]
}
], - "count": 50,
- "offset": 0,
- "limit": 50,
- "dateFrom": "2019-01-01",
- "dateTo": "2019-12-31",
- "query": "some-query"
}
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 |
{- "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": [
- {
- "item_quantity": 1,
- "item_name": "MyProductName",
- "item_comment": "MyProductDescription",
- "item_price": 12,
- "item_vatRate": 20,
- "item_vatId": 12345,
- "item_priceBase": "brutto or netto",
- "product_id": 1234,
- "discount_id": 1234,
- "discount_value": 0,
- "discount_unit": "percent or currency",
- "item_variations": [
- {
- "product_id": 1,
- "variation_name": "Schnitzel with chips and mayo",
- "variation_price": 15.2
}
]
}
], - "orderItem_ids": [
- 1,
- 2,
- 3
], - "address": [
- {
- "company": "ready2order GmbH",
- "vatId": "ATU12341234",
- "salutation": "Mr/Mrs",
- "title": "Professor",
- "firstName": "Chris",
- "lastName": "Muster",
- "street": "SomeStreet 1234",
- "city": "Vienna",
- "zip": 1030,
- "country": "AT",
- "phone": "+43 1234 12312341234"
}
]
}
{- "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_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_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": [
- {
- "item_id": 76234,
- "item_timestamp": "2019-01-01 00:00:00",
- "item_quantity": 1,
- "item_retour": false,
- "item_number": 1,
- "item_serialNumber": "some-serial-number",
- "item_expirationDate": "2019-01-01 00:00:00",
- "item_name": "MyProductName",
- "item_comment": "my-optional-comment",
- "item_price": 12,
- "item_priceNet": 10,
- "item_priceBase": false,
- "item_total": 12,
- "item_totalNet": 10,
- "item_vat": 2,
- "item_vatRate": 20,
- "item_vatCompensation": 0,
- "item_undiscountedSumBeforeLineDiscount": 0,
- "item_undiscountedSumBeforeInvoiceDiscount": 0,
- "item_lineDiscountId": 1234,
- "item_lineDiscountGroupId": 1234,
- "item_lineDiscountName": "SomeDiscountName",
- "item_lineDiscountPercent": 0,
- "item_lineDiscountNet": 0,
- "item_lineDiscountGross": 0,
- "item_invoiceDiscountNet": 0,
- "item_invoiceDiscountGross": 0,
- "item_discountable": true,
- "paymentMethod_id": 1234,
- "item_updatedStock": true,
- "product_id": 1234,
- "productgroup_name": "My product group",
- "productGroup_id": 1234,
- "customer_id": 1234,
- "user_id": 1234,
- "user_name": "SomeUser",
- "invoice_id": 1234,
- "deliveryBill_id": 1234,
- "dailyReport_id": 1234,
- "productUnit_id": 1,
- "table_id": 1234,
- "table_name": "SomeTableName",
- "payment_id": 431,
- "retourInvoice_id": 1233,
- "item_accountingCode": 4000,
- "item_testMode": false,
- "item_product_price": 12,
- "item_product_priceNet": 10,
- "item_product_vat": 2,
- "item_qty": 1,
- "item_product_vatRate": 20,
- "item_product_vatCompensation": 0,
- "item_product_priceNetPerUnit": 10,
- "item_product_pricePerUnit": 12,
- "item_product_discountable": true
}
], - "address": {
- "company": "ready2order GmbH",
- "vatId": "ATU12341234",
- "salutation": "Mr/Ms",
- "title": "Professor",
- "firstName": "Chris",
- "lastName": "Muster",
- "street": "SomeStreet 1234",
- "city": "Vienna",
- "zip": 1030,
- "country": "AT",
- "phone": "+43 1234 12312341234"
}, - "type": {
- "billType_id": 1,
- "billType_name": "Rechnung",
- "billType_symbol": "RG"
}, - "payment": [
- {
- "billPayment_id": 9999,
- "billPayment_name": "Cash",
- "billPayment_value": 12,
- "payment_id": 431,
- "referenced_bill_id": 1234
}
], - "transaction": {
- "id": "TFRG4C6NG2",
- "r2o_id": "U1JGILYS"
}, - "discounts": [
- {
- "billDiscount_id": 9999,
- "billDiscount_name": "SomeDiscountName",
- "billDiscount_value": 0,
- "billDiscount_percent": 0,
- "billDiscount_discount_id": 9999,
- "billDiscount_discountGroup_id": 9999,
- "billDiscount_created_at": "2019-01-01 00:00:00",
- "billDiscount_updated_at": "2019-01-01 00:00:00"
}
]
}
{- "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_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_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": [
- {
- "item_id": 76234,
- "item_timestamp": "2019-01-01 00:00:00",
- "item_quantity": 1,
- "item_retour": false,
- "item_number": 1,
- "item_serialNumber": "some-serial-number",
- "item_expirationDate": "2019-01-01 00:00:00",
- "item_name": "MyProductName",
- "item_comment": "my-optional-comment",
- "item_price": 12,
- "item_priceNet": 10,
- "item_priceBase": false,
- "item_total": 12,
- "item_totalNet": 10,
- "item_vat": 2,
- "item_vatRate": 20,
- "item_vatCompensation": 0,
- "item_undiscountedSumBeforeLineDiscount": 0,
- "item_undiscountedSumBeforeInvoiceDiscount": 0,
- "item_lineDiscountId": 1234,
- "item_lineDiscountGroupId": 1234,
- "item_lineDiscountName": "SomeDiscountName",
- "item_lineDiscountPercent": 0,
- "item_lineDiscountNet": 0,
- "item_lineDiscountGross": 0,
- "item_invoiceDiscountNet": 0,
- "item_invoiceDiscountGross": 0,
- "item_discountable": true,
- "paymentMethod_id": 1234,
- "item_updatedStock": true,
- "product_id": 1234,
- "productgroup_name": "My product group",
- "productGroup_id": 1234,
- "customer_id": 1234,
- "user_id": 1234,
- "user_name": "SomeUser",
- "invoice_id": 1234,
- "deliveryBill_id": 1234,
- "dailyReport_id": 1234,
- "productUnit_id": 1,
- "table_id": 1234,
- "table_name": "SomeTableName",
- "payment_id": 431,
- "retourInvoice_id": 1233,
- "item_accountingCode": 4000,
- "item_testMode": false,
- "item_product_price": 12,
- "item_product_priceNet": 10,
- "item_product_vat": 2,
- "item_qty": 1,
- "item_product_vatRate": 20,
- "item_product_vatCompensation": 0,
- "item_product_priceNetPerUnit": 10,
- "item_product_pricePerUnit": 12,
- "item_product_discountable": true
}
], - "address": {
- "company": "ready2order GmbH",
- "vatId": "ATU12341234",
- "salutation": "Mr/Ms",
- "title": "Professor",
- "firstName": "Chris",
- "lastName": "Muster",
- "street": "SomeStreet 1234",
- "city": "Vienna",
- "zip": 1030,
- "country": "AT",
- "phone": "+43 1234 12312341234"
}, - "type": {
- "billType_id": 1,
- "billType_name": "Rechnung",
- "billType_symbol": "RG"
}, - "payment": [
- {
- "billPayment_id": 9999,
- "billPayment_name": "Cash",
- "billPayment_value": 12,
- "payment_id": 431,
- "referenced_bill_id": 1234
}
], - "transaction": {
- "id": "TFRG4C6NG2",
- "r2o_id": "U1JGILYS"
}, - "discounts": [
- {
- "billDiscount_id": 9999,
- "billDiscount_name": "SomeDiscountName",
- "billDiscount_value": 0,
- "billDiscount_percent": 0,
- "billDiscount_discount_id": 9999,
- "billDiscount_discountGroup_id": 9999,
- "billDiscount_created_at": "2019-01-01 00:00:00",
- "billDiscount_updated_at": "2019-01-01 00:00:00"
}
]
}
id required | integer Bill ID to find |
storno_id | integer Storno ID |
storno_reason | string Some reason why bill was deleted |
invoice_externalReferenceNumber | string Some external reference number for that bill |
{- "storno_id": 9823,
- "storno_reason": "Correction",
- "invoice_externalReferenceNumber": "REF-1234"
}
{- "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_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_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": [
- {
- "item_id": 76234,
- "item_timestamp": "2019-01-01 00:00:00",
- "item_quantity": 1,
- "item_retour": false,
- "item_number": 1,
- "item_serialNumber": "some-serial-number",
- "item_expirationDate": "2019-01-01 00:00:00",
- "item_name": "MyProductName",
- "item_comment": "my-optional-comment",
- "item_price": 12,
- "item_priceNet": 10,
- "item_priceBase": false,
- "item_total": 12,
- "item_totalNet": 10,
- "item_vat": 2,
- "item_vatRate": 20,
- "item_vatCompensation": 0,
- "item_undiscountedSumBeforeLineDiscount": 0,
- "item_undiscountedSumBeforeInvoiceDiscount": 0,
- "item_lineDiscountId": 1234,
- "item_lineDiscountGroupId": 1234,
- "item_lineDiscountName": "SomeDiscountName",
- "item_lineDiscountPercent": 0,
- "item_lineDiscountNet": 0,
- "item_lineDiscountGross": 0,
- "item_invoiceDiscountNet": 0,
- "item_invoiceDiscountGross": 0,
- "item_discountable": true,
- "paymentMethod_id": 1234,
- "item_updatedStock": true,
- "product_id": 1234,
- "productgroup_name": "My product group",
- "productGroup_id": 1234,
- "customer_id": 1234,
- "user_id": 1234,
- "user_name": "SomeUser",
- "invoice_id": 1234,
- "deliveryBill_id": 1234,
- "dailyReport_id": 1234,
- "productUnit_id": 1,
- "table_id": 1234,
- "table_name": "SomeTableName",
- "payment_id": 431,
- "retourInvoice_id": 1233,
- "item_accountingCode": 4000,
- "item_testMode": false,
- "item_product_price": 12,
- "item_product_priceNet": 10,
- "item_product_vat": 2,
- "item_qty": 1,
- "item_product_vatRate": 20,
- "item_product_vatCompensation": 0,
- "item_product_priceNetPerUnit": 10,
- "item_product_pricePerUnit": 12,
- "item_product_discountable": true
}
], - "address": {
- "company": "ready2order GmbH",
- "vatId": "ATU12341234",
- "salutation": "Mr/Ms",
- "title": "Professor",
- "firstName": "Chris",
- "lastName": "Muster",
- "street": "SomeStreet 1234",
- "city": "Vienna",
- "zip": 1030,
- "country": "AT",
- "phone": "+43 1234 12312341234"
}, - "type": {
- "billType_id": 1,
- "billType_name": "Rechnung",
- "billType_symbol": "RG"
}, - "payment": [
- {
- "billPayment_id": 9999,
- "billPayment_name": "Cash",
- "billPayment_value": 12,
- "payment_id": 431,
- "referenced_bill_id": 1234
}
], - "transaction": {
- "id": "TFRG4C6NG2",
- "r2o_id": "U1JGILYS"
}, - "discounts": [
- {
- "billDiscount_id": 9999,
- "billDiscount_name": "SomeDiscountName",
- "billDiscount_value": 0,
- "billDiscount_percent": 0,
- "billDiscount_discount_id": 9999,
- "billDiscount_discountGroup_id": 9999,
- "billDiscount_created_at": "2019-01-01 00:00:00",
- "billDiscount_updated_at": "2019-01-01 00:00:00"
}
]
}
Add bill to printer queue for specific printer
id required | integer Bill ID to find |
printer_id | integer Printer ID where to print the bill |
{- "printer_id": 2394
}
{- "error": false,
- "msg": "Bill was added to printer queue"
}
Returns signed S3 URL. Optionally regenerates pdf if regeneratePDF
is set to true
id required | integer User ID to delete |
regeneratePDF | boolean Optionally regenerate an existing PDF |
format | string PDF Format |
{- "regeneratePDF": true,
- "format": "A4, 80mm or 58mm"
}
{- "error": false,
- "format": "A4"
}
page | integer Page you want to display |
limit | integer Items per page |
identifier | string Identifier/Code of coupon |
trainingMode | boolean Trainingmode |
[- {
- "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"
}
]
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 |
{- "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"
}
{- "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"
}
{- "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"
}
id required | integer Coupon ID to update |
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 |
{- "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"
}
{- "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"
}
id required | integer Coupon ID to charge |
value | string Charge value |
{- "value": 12
}
{- "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"
}
id required | integer Coupon ID to redeem |
value | string Redemption value |
{- "value": 12
}
{- "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"
}
page | integer Page you want to display |
limit | integer Items per page |
[- {
- "couponCategory_id": 123,
- "couponCategory_name": "my coupon category",
- "couponCategory_description": "my great coupon category"
}
]
couponCategory_name | string |
couponCategory_description | string |
{- "couponCategory_name": "string",
- "couponCategory_description": "string"
}
{- "couponCategory_id": 123,
- "couponCategory_name": "my coupon category",
- "couponCategory_description": "my great coupon category"
}
id required | integer Coupon Category ID to update |
couponCategory_name | string |
couponCategory_description | string |
{- "couponCategory_name": "string",
- "couponCategory_description": "string"
}
{- "couponCategory_id": 123,
- "couponCategory_name": "my coupon category",
- "couponCategory_description": "my great coupon category"
}
page | integer Page you want to display |
limit | integer Items per page |
[- {
- "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",
- "phone": "+43 664 12345678",
- "customer_notes": "Some custom notes",
- "customerCategory_id": 9999,
- "customer_birthday": "1991-09-20"
}
]
customerCategory_id | integer |
birthday | string |
city | string |
company | string |
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 |
{- "customerCategory_id": 1126,
- "birthday": "1991-09-20",
- "city": "Wien",
- "company": "Maxi Gmbh",
- "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
}
{- "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",
- "phone": "+43 664 12345678",
- "customer_notes": "Some custom notes",
- "customerCategory_id": 9999,
- "customer_birthday": "1991-09-20"
}
id required | integer Customer ID to find |
{- "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",
- "phone": "+43 664 12345678",
- "customer_notes": "Some custom notes",
- "customerCategory_id": 9999,
- "customer_birthday": "1991-09-20"
}
id required | integer Customer ID to update |
customerCategory_id | integer |
birthday | string |
city | string |
company | string |
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 |
{- "customerCategory_id": 1126,
- "birthday": "1991-09-20",
- "city": "Wien",
- "company": "Maxi Gmbh",
- "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
}
{- "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",
- "phone": "+43 664 12345678",
- "customer_notes": "Some custom notes",
- "customerCategory_id": 9999,
- "customer_birthday": "1991-09-20"
}
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. |
{- "masterCustomer": 5924,
- "customerIds": [
- 1,
- 2,
- 3,
- 4
]
}
{- "error": false,
- "success": true,
- "msg": "Merged successfully!"
}
customerCategory_name | string |
customerCategory_description | string |
{- "customerCategory_name": "string",
- "customerCategory_description": "string"
}
{- "customerCategory_id": 123,
- "customerCategory_name": "a customer group",
- "customerCategory_description": "a customer group description"
}
id required | integer Customer Group ID to update |
customerCategory_name | string |
customerCategory_description | string |
{- "customerCategory_name": "string",
- "customerCategory_description": "string"
}
{- "customerCategory_id": 123,
- "customerCategory_name": "a customer group",
- "customerCategory_description": "a customer group description"
}
[- {
- "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"
}
]
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 |
{- "discount_name": "Discount",
- "discountGroup_id": 116,
- "discount_unit": "custom",
- "discount_order": 0,
- "discount_description": "A discount description",
- "discount_active": true,
- "discount_value": 30
}
{- "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"
}
{- "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"
}
id required | integer ID to find |
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 |
{- "discount_name": "Discount",
- "discountGroup_id": 116,
- "discount_unit": "custom",
- "discount_order": 0,
- "discount_description": "A discount description",
- "discount_active": true,
- "discount_value": 30
}
{- "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"
}
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 |
{- "discountGroup_description": "description example",
- "discountGroup_active": true,
- "discountGroup_name": "Sales"
}
{- "discountGroup_id": 74890,
- "discountGroup_name": "Barzahlung",
- "discountGroup_description": "just a description",
- "discountGroup_active": true
}
id required | integer ID to find |
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 |
{- "discountGroup_description": "description example",
- "discountGroup_active": true,
- "discountGroup_name": "Sales"
}
{- "discountGroup_id": 74890,
- "discountGroup_name": "Barzahlung",
- "discountGroup_description": "just a description",
- "discountGroup_active": true
}
dateFrom | string |
dateTo | string |
fileFormat | string Enum: "excel" "pdf" |
{- "dateFrom": "2021-08-01",
- "dateTo": "2021-08-31",
- "fileFormat": "pdf|excel"
}
{- "jobStatus_id": 123,
- "jobStatus_status": "finished",
- "jobStatus_startedAt": "2019-08-02 08:08:13",
- "jobStatus_finishedAt": "2019-08-02 08:08:14"
}
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 |
{- "format": "datev",
- "year": 2019,
- "month": 1,
- "day": 31,
- "exportCashbook": true,
- "dataSource": "invoice",
- "financialYear": 2019,
- "from": "2019-01-01",
- "to": "2019-12-31"
}
{- "filename": 1234,
- "error": false
}
year | integer |
month | integer |
day | integer |
dateFrom | string |
dateTo | string |
{- "year": 2019,
- "month": 1,
- "day": 31,
- "dateFrom": "2021-08-01",
- "dateTo": "2021-08-31"
}
{- "filename": 1234,
- "error": false
}
month | integer |
year | integer |
filter | Array of integers Filter your data |
{- "month": 1,
- "year": 2019,
- "filter": [
- 0
]
}
{- "error": false,
- "success": true,
- "msg": "success",
- "jobStatus_id": 123
}
authorizationCallbackUri | string The callback to which the merchant will be redirected if access will be granted. |
{
}
{- "error": false,
- "success": true,
- "expiresAt": 1641546585,
- "grantAccessToken": "abcdef_token (JWT token)",
- "status": "pending"
}
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 |
{- "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"
}
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 |
{- "table_id": 1234,
- "price_base": "gross",
- "training_mode": false,
- "items": [ ]
}
{- "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"
}
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 |
{- "payment_description": "Paying in cash",
- "payment_markAsPaid": true,
- "paymentType_id": 1,
- "payment_name": "Barzahlung"
}
{- "payment_id": 74890,
- "payment_name": "Barzahlung",
- "payment_description": "just a description",
- "payment_accountingCode": 2700,
- "payment_markAsPaid": true,
- "paymentType_id": 1
}
id required | integer ID to find |
{- "payment_id": 74890,
- "payment_name": "Barzahlung",
- "payment_description": "just a description",
- "payment_accountingCode": 2700,
- "payment_markAsPaid": true,
- "paymentType_id": 1
}
id required | integer ID to find |
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 |
{- "payment_description": "Paying in cash",
- "payment_markAsPaid": true,
- "paymentType_id": 1,
- "payment_name": "Barzahlung"
}
{- "payment_id": 74890,
- "payment_name": "Barzahlung",
- "payment_description": "just a description",
- "payment_accountingCode": 2700,
- "payment_markAsPaid": true,
- "paymentType_id": 1
}
printJob_content | string |
printJob_imageURL | string |
printJob_printLogo | boolean |
printer_id | integer |
{- "printJob_content": "no-example",
- "printJob_imageURL": "no-example",
- "printJob_printLogo": false,
- "printer_id": 0
}
{- "printJob_id": 9999,
- "printer_id": 9999,
- "printJob_imageURL": "string",
- "printJob_printLogo": false,
- "printJob_createdAt": "string",
- "printJob_printedAt": "string",
- "printJob_content": "string"
}
[- {
- "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"
}
]
id required | integer Printer ID to find |
{- "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"
}
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 |
[- {
- "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": {
- "productgroup_id": 1,
- "productgroup_name": "string",
- "productgroup_description": "string",
- "productgroup_shortcut": "string",
- "productgroup_active": false,
- "productgroup_sortIndex": 9999,
- "productgroup_created_at": "string",
- "productgroup_updated_at": "string",
- "productgroup_type_id": 9999
}, - "productvariation": [
- {
- "variation_id": 1,
- "variation_name": "schnitzel with chips and mayo",
- "variation_price": 15.2,
- "variation_stock": 10
}
], - "productingredient": [
- {
- "ingredient_id": 1,
- "ingredient_name": "pork meat",
- "ingredient_unit": "Kg",
- "ingredient_quantity": 0
}
]
}
]
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 |
{- "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": {
- "productgroup_id": 0
}, - "product_base": {
- "product_id": 1002
}
}
{- "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": {
- "productgroup_id": 1,
- "productgroup_name": "string",
- "productgroup_description": "string",
- "productgroup_shortcut": "string",
- "productgroup_active": false,
- "productgroup_sortIndex": 9999,
- "productgroup_created_at": "string",
- "productgroup_updated_at": "string",
- "productgroup_type_id": 9999
}, - "productvariation": [
- {
- "variation_id": 1,
- "variation_name": "schnitzel with chips and mayo",
- "variation_price": 15.2,
- "variation_stock": 10
}
], - "productingredient": [
- {
- "ingredient_id": 1,
- "ingredient_name": "pork meat",
- "ingredient_unit": "Kg",
- "ingredient_quantity": 0
}
]
}
id required | integer Product ID to find |
includeProductGroup | boolean include product group information |
includeProductVariations | boolean include product variations information |
includeProductIngredients | boolean include product variations information |
{- "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": {
- "productgroup_id": 1,
- "productgroup_name": "string",
- "productgroup_description": "string",
- "productgroup_shortcut": "string",
- "productgroup_active": false,
- "productgroup_sortIndex": 9999,
- "productgroup_created_at": "string",
- "productgroup_updated_at": "string",
- "productgroup_type_id": 9999
}, - "productvariation": [
- {
- "variation_id": 1,
- "variation_name": "schnitzel with chips and mayo",
- "variation_price": 15.2,
- "variation_stock": 10
}
], - "productingredient": [
- {
- "ingredient_id": 1,
- "ingredient_name": "pork meat",
- "ingredient_unit": "Kg",
- "ingredient_quantity": 0
}
]
}
id required | integer product id |
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 |
{- "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": {
- "product_id": 1002
}, - "productgroup": {
- "productgroup_id": 0
}
}
{- "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": {
- "productgroup_id": 1,
- "productgroup_name": "string",
- "productgroup_description": "string",
- "productgroup_shortcut": "string",
- "productgroup_active": false,
- "productgroup_sortIndex": 9999,
- "productgroup_created_at": "string",
- "productgroup_updated_at": "string",
- "productgroup_type_id": 9999
}, - "productvariation": [
- {
- "variation_id": 1,
- "variation_name": "schnitzel with chips and mayo",
- "variation_price": 15.2,
- "variation_stock": 10
}
], - "productingredient": [
- {
- "ingredient_id": 1,
- "ingredient_name": "pork meat",
- "ingredient_unit": "Kg",
- "ingredient_quantity": 0
}
]
}
Array of objects List of products |
{- "products": "List of products"
}
{- "updatedIds": {
- "id": 1
}, - "updatedItemNumbers": {
- "number": 1
}
}
id required | integer Product ID |
product_stock | string |
product_reorderLevel | string |
product_safetyStock | string |
product_stockDelta | string |
{- "product_stock": "string",
- "product_reorderLevel": "string",
- "product_safetyStock": "string",
- "product_stockDelta": "string"
}
{- "product_id": 1234,
- "product_stock": 10,
- "product_reorderLevel": 5.2,
- "product_safetyStock": 2.1,
- "product_unit": "piece"
}
id required | integer ID to find |
[- {
- "price_id": 1234,
- "price_value": 12.45,
- "price_valueGross": 13.56,
- "price_valueNet": 12.45,
- "price_timestamp": 1234,
- "product_id": 1234,
- "customerCategory_id": 1
}
]
id required | integer ID to find |
price_value | string |
customerCategory_id | integer |
{- "price_value": "string",
- "customerCategory_id": 9999
}
{- "price_id": 1234,
- "price_value": 12.45,
- "price_valueGross": 13.56,
- "price_valueNet": 12.45,
- "price_timestamp": 1234,
- "product_id": 1234,
- "customerCategory_id": 1
}
id required | integer ID to find |
customerCategoryId required | integer Customer category ID to find |
{- "price_id": 1234,
- "price_value": 12.45,
- "price_valueGross": 13.56,
- "price_valueNet": 12.45,
- "price_timestamp": 1234,
- "product_id": 1234,
- "customerCategory_id": 1
}
id required | integer ID to find |
customerCategoryId required | integer customer category id |
price_value | string |
{- "price_value": "string"
}
{- "price_id": 1234,
- "price_value": 12.45,
- "price_valueGross": 13.56,
- "price_valueNet": 12.45,
- "price_timestamp": 1234,
- "product_id": 1234,
- "customerCategory_id": 1
}
id required | integer ID to find |
customerCategoryId required | integer Customer category ID to find |
{- "error": false,
- "success": true,
- "msg": "Product price was deleted successfully."
}
id required | integer ID to find |
[- {
- "price_id": 1234,
- "price_value": 12.45,
- "price_valueGross": 13.56,
- "price_valueNet": 12.45,
- "price_timestamp": 1234,
- "product_id": 1234,
- "customer_id": 1
}
]
id required | integer ID to find |
price_value | string |
customer_id | integer |
{- "price_value": "string",
- "customer_id": 9999
}
{- "price_id": 1234,
- "price_value": 12.45,
- "price_valueGross": 13.56,
- "price_valueNet": 12.45,
- "price_timestamp": 1234,
- "product_id": 1234,
- "customer_id": 1
}
id required | integer ID to find |
customerId required | integer Customer category ID to find |
{- "price_id": 1234,
- "price_value": 12.45,
- "price_valueGross": 13.56,
- "price_valueNet": 12.45,
- "price_timestamp": 1234,
- "product_id": 1234,
- "customer_id": 1
}
id required | integer ID to find |
customerId required | integer customer id |
price_value | string |
{- "price_value": "string"
}
{- "price_id": 1234,
- "price_value": 12.45,
- "price_valueGross": 13.56,
- "price_valueNet": 12.45,
- "price_timestamp": 1234,
- "product_id": 1234,
- "customer_id": 1
}
page | integer Page you want to display |
limit | integer Items per page |
[- {
- "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
}
]
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 |
{- "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
}
{- "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
}
{- "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
}
id required | integer ID to find |
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 |
{- "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
}
{- "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
}
{- "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
}
page | integer Page you want to display |
limit | integer Items per page |
[- {
- "storno_id": 1234,
- "storno_name": "cancellation",
- "storno_description": "storno reason 1234",
- "storno_created_at": "2019-01-01 12:00:00"
}
]
storno_name | string Storno name |
storno_description | string Storno description |
{- "storno_name": "cancellation",
- "storno_description": "storno reason 1234"
}
{- "storno_id": 1234,
- "storno_name": "cancellation",
- "storno_description": "storno reason 1234",
- "storno_created_at": "2019-01-01 12:00:00"
}
page | integer Page you want to display |
limit | integer Items per page |
[- {
- "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"
}
]
table_name | string |
table_isTemporay | boolean |
table_checkoutMode | boolean |
table_order | integer |
table_description | string |
tableArea_id | integer |
{- "table_name": 1234,
- "table_isTemporay": true,
- "table_checkoutMode": false,
- "table_order": 1,
- "table_description": 1234,
- "tableArea_id": 1
}
{- "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"
}
{- "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"
}
{- "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"
}
page | integer Page you want to display |
limit | integer Items per page |
[- {
- "tableArea_id": 1234,
- "tableArea_name": "innen 1",
- "tableArea_shortName": "IN-1",
- "tableArea_order": 1,
- "tableArea_allowTemporaryTables": true,
- "tableArea_active": true,
- "tableArea_intelligentFavourites": 1
}
]
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 |
{- "tableArea_name": "innen 1",
- "tableArea_shortName": "IN-1",
- "tableArea_order": 1,
- "tableArea_allowTemporaryTables": true,
- "tableArea_active": true
}
{- "tableArea_id": 1234,
- "tableArea_name": "innen 1",
- "tableArea_shortName": "IN-1",
- "tableArea_order": 1,
- "tableArea_allowTemporaryTables": true,
- "tableArea_active": true,
- "tableArea_intelligentFavourites": 1
}
{- "tableArea_id": 1234,
- "tableArea_name": "innen 1",
- "tableArea_shortName": "IN-1",
- "tableArea_order": 1,
- "tableArea_allowTemporaryTables": true,
- "tableArea_active": true,
- "tableArea_intelligentFavourites": 1
}
id required | integer ID to find |
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 |
{- "tableArea_name": "innen 1",
- "tableArea_shortName": "IN-1",
- "tableArea_order": 1,
- "tableArea_allowTemporaryTables": true,
- "tableArea_active": true
}
{- "tableArea_id": 1234,
- "tableArea_name": "innen 1",
- "tableArea_shortName": "IN-1",
- "tableArea_order": 1,
- "tableArea_allowTemporaryTables": true,
- "tableArea_active": true,
- "tableArea_intelligentFavourites": 1
}
page | integer Page you want to display |
limit | integer Items per page |
[- {
- "user_id": 1234,
- "user_firstName": "Christoph",
- "user_lastName": "Müller",
- "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,
- "loginLog": {
- "loginLog_lastActionAt": "2018-11-05 01:23:45",
- "loginLog_userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6)"
}
}
]
user_username | string |
user_password | string |
user_firstName | string |
user_lastName | string |
user_trainingsMode | boolean |
user_printer | integer |
user_printAccess | integer |
right_id | integer |
{- "user_password": "StrongPassword123!",
- "user_firstName": "Christoph",
- "user_lastName": "Müller",
- "user_trainingsMode": true,
- "user_printer": 123,
- "user_printAccess": 2457,
- "right_id": 1234
}
{- "user_id": 1234,
- "user_firstName": "Christoph",
- "user_lastName": "Müller",
- "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
}
{- "user_id": 1234,
- "user_firstName": "Christoph",
- "user_lastName": "Müller",
- "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
}
id required | integer User ID to update |
user_username | string |
user_password | string |
user_firstName | string |
user_lastName | string |
user_trainingsMode | boolean |
user_printer | integer |
user_printAccess | integer |
right_id | integer |
{- "user_password": "StrongPassword123!",
- "user_firstName": "Christoph",
- "user_lastName": "Müller",
- "user_trainingsMode": true,
- "user_printer": 123,
- "user_printAccess": 2457,
- "right_id": 1234
}
{- "user_id": 1234,
- "user_firstName": "Christoph",
- "user_lastName": "Müller",
- "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
}
id required | integer User ID to update password |
user_password | string |
{- "user_password": "StrongPassword123!"
}
{- "user_id": 1234,
- "user_firstName": "Christoph",
- "user_lastName": "Müller",
- "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
}
id required | integer User ID to generate token |
expiresIn | integer Life-time of token (seconds) |
crmUserId | string |
{- "crmUserId": "string"
}
{- "error": false,
- "token": "AAA.BBBBBBBBBBBB.CCC",
- "issuedAt": "2018-11-05 01:23:45",
- "expiresAt": "2018-11-05 01:24:45",
}
page | integer Page you want to display |
limit | integer Items per page |
{- "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
}
{
}
addEvent | string |
removeEvent | string |
{- "addEvent": "string",
- "removeEvent": "string"
}
{- "error": true,
- "success": false,
- "msg": "Your now receiving webhooks for the event <name>"
}