Download OpenAPI specification:
Automatisch generierte API-Dokumentation
Ändert die Tischnummer einer Bestellung. Falls auf dem Zieltisch bereits eine Bestellung existiert, werden sie zusammengeführt.
| orderId required | string ID der zu verschiebenden Bestellung |
| table required | string Ziel-Tischnummer |
{- "orderId": "order123",
- "table": "7"
}| orderId | string ID einer bestehenden Bestellung (optional) |
| table | string Tischnummer |
required | Array of objects |
| employee required | string Name des Mitarbeiters |
| dontPrint | boolean Nicht drucken? |
{- "table": "5",
- "employee": "Max",
- "articles": [
- {
- "_id": "prod1",
- "name": "Cappuccino",
- "price": "3.50",
- "quantity": 2
}
]
}| orderId required | string ID der Bestellung |
| payedArticels required | Array of objects Liste der bezahlten Artikel |
| total required | string Gesamtbetrag |
| tipValue | string Trinkgeld |
| payment required | string Zahlungsmethode (BAR, EC, etc.) |
| isStorno | boolean Ist es ein Storno? |
| freeText | string Freitext für Bon |
{- "orderId": "string",
- "payedArticels": [
- { }
], - "total": "string",
- "tipValue": "string",
- "payment": "string",
- "isStorno": true,
- "freeText": "string"
}Nur für Splitting und Verschieben von Artikeln. Druckt keinen Storno-Bon.
| payed required | boolean Muss true sein (false ist für Stornos, siehe /stornoItem) |
| orderId required | string Bestellungs-ID |
| productUniqueId required | string Eindeutige Artikel-ID |
| removeComplete required | boolean Komplette Bestellung löschen falls keine Artikel übrig |
{- "payed": true,
- "orderId": "order123",
- "productUniqueId": "art-uuid-123",
- "removeComplete": true
}| paymentId required | string Payment-ID der bezahlten Bestellung |
| hospitality required | boolean Als Bewirtungsbeleg drucken? |
| employee | string Mitarbeiter (optional) |
{- "paymentId": "pay-uuid-123",
- "hospitality": false,
- "employee": "Max"
}Setzt den Preis eines Artikels auf 0 und druckt einen Storno-Bon
| orderId required | string Bestellungs-ID |
| productUniqueId | string Eindeutige Artikel-ID (optional, wenn leer werden alle nicht bezahlten Artikel storniert) |
| employee required | string Mitarbeiter der das Storno durchführt |
| reason required | string Storno-Grund |
{- "orderId": "order123",
- "productUniqueId": "art-uuid-123",
- "employee": "Max",
- "reason": "Kunde hat sich umentschieden"
}| orderId required | string Bestellungs-ID |
| productUniqueId required | string Eindeutige Artikel-ID |
| orderStatus | number Neuer Status des Artikels |
{- "orderId": "order123",
- "productUniqueId": "art-uuid-123",
- "orderStatus": 1
}Ruft die aktuelle Ansichtskonfiguration ab, inklusive Kiosk-Modus, Ordner-Ansicht und verschiedener UI-Optionen
{- "kioskState": false,
- "folderView": true,
- "showExtras": true,
- "showCourse": true,
- "showTable": true,
- "showDivers": true,
- "showVoucher": true,
- "groupArticles": false,
- "usePreorders": false,
- "scanOnly": false
}Aktualisiert die Ansichtskonfiguration. Felder können einzeln oder zusammen aktualisiert werden.
| kioskState | boolean Kiosk-Modus aktiviert (false=Restaurant, true=Kiosk) |
| folderView | boolean Ordner-Ansicht aktiviert (true=Ordner, false=Ausklappbar) |
| showExtras | boolean Extras-Button in Bestellartikelliste anzeigen |
| showCourse | boolean Gang-Auswahl in Bestellung anzeigen |
| showTable | boolean Tisch-Auswahl im Kiosk-Modus anzeigen |
| showDivers | boolean "Diverses"-Artikel-Button anzeigen |
| showVoucher | boolean "Gutschein"-Button anzeigen |
| groupArticles | boolean Artikel gruppieren (true=3x Bier, false=Bier Bier Bier) |
| scanOnly | boolean Nur-Scan-Modus im SCO-Modus |
{- "kioskState": false,
- "folderView": true,
- "showExtras": true,
- "groupArticles": true
}{- "kioskState": true,
- "folderView": true,
- "showExtras": true,
- "showCourse": true,
- "showTable": true,
- "showDivers": true,
- "showVoucher": true,
- "groupArticles": true,
- "scanOnly": true
}| objectIds required | Array of strings Array von Gutschein-IDs |
{- "objectIds": [
- "string"
]
}{- "success": true,
- "vouchers": [
- { }
]
}| apiKey | string Adyen API-Key |
| merchant | string Händler-ID |
Array of objects Liste der Terminals | |
| testMode | boolean Testmodus aktivieren/deaktivieren |
{- "apiKey": "AQE...xyz",
- "merchant": "MyCompanyPOSGmbH",
- "testMode": true,
- "terminals": [
- {
- "_id": "term_001",
- "provider": "adyen",
- "name": "Kasse 1",
- "tid": "P400Plus-12345678"
}
]
}{- "apiKey": "AQE...xyz",
- "merchant": "MyCompanyPOSGmbH",
- "testMode": true,
- "terminals": [
- {
- "_id": "term_001",
- "provider": "adyen",
- "name": "Kasse 1",
- "tid": "P400Plus-12345678"
}
]
}Ruft die aktuellen Terminals von der Adyen-API ab und aktualisiert die lokale Konfiguration
{- "apiKey": "AQE...xyz",
- "merchant": "MyCompanyPOSGmbH",
- "testMode": false,
- "terminals": [
- {
- "_id": "term_001",
- "provider": "adyen",
- "name": "Kasse 1",
- "tid": "P400Plus-12345678"
}
]
}Ruft die Liste der verfügbaren Händlerkonten für den angegebenen API-Key ab
| apiKey | string Adyen API-Key (optional, verwendet gespeicherten Key falls nicht angegeben) |
{- "apiKey": "AQE...xyz"
}[- [
- "MyCompanyPOSGmbH",
- "My Company POS GmbH"
], - [
- "MyCompanyOnlineGmbH",
- "My Company Online GmbH"
]
]| tid required | string Terminal-ID des Adyen-Terminals |
| amount required | number Zahlungsbetrag |
{- "amount": 42.5
}{- "success": true,
- "id": "pay_abc123xyz"
}| tid required | string Terminal-ID des Mollie-Terminals |
| payid required | string Zahlungs-ID der zu stornierenden Zahlung |
{- "id": "tr_abc123xyz",
- "status": "canceled",
- "mode": "live",
- "amount": {
- "value": "42.50",
- "currency": "EUR"
}
}| apiKey | string Mollie API-Key |
Array of objects |
{- "apiKey": "live_abc123xyz",
- "terminals": [
- {
- "name": "Kasse 1",
- "tid": "term_abc123"
}, - {
- "name": "Kasse 2",
- "tid": "term_xyz789"
}
]
}{- "apiKey": "live_abc123xyz",
- "terminals": [
- {
- "name": "Kasse 1",
- "tid": "term_abc123"
}
]
}| tid required | string Terminal-ID des Mollie-Terminals |
| amount required | string Zahlungsbetrag als String |
| reference | string <= 255 characters Optional Referenz (max. 255 Zeichen) |
{- "amount": "42.50",
- "reference": "Bestellung #12345"
}{- "id": "tr_abc123xyz",
- "mode": "live",
- "description": "Zahlung",
- "amount": {
- "value": "42.50",
- "currency": "EUR"
}, - "status": "open"
}| tid required | string Terminal-ID des Mollie-Terminals |
| payid required | string Zahlungs-ID |
{- "id": "tr_abc123xyz",
- "mode": "live",
- "description": "Zahlung",
- "amount": {
- "value": "42.50",
- "currency": "EUR"
}, - "status": "paid"
}| tid required | number Terminal-ID des myPOS-Terminals |
| ruid required | string Eindeutige Anfrage-ID der zu stornierenden Zahlung |
{- "ruid": "req_cancel_xyz789",
- "status": 0,
- "status_msg": "OK",
- "ruid_original": "req_abc123xyz",
- "ruid_original_status": 0
}Ruft die myPOS-Konfiguration vom Cloud-Service ab und speichert sie optional lokal
| storeConfig | boolean Konfiguration lokal speichern |
{- "storeConfig": true
}{- "enabled": true,
- "mail": "shop@example.com",
- "terminals": [
- {
- "name": "Kasse 1",
- "tid": 12345
}, - {
- "name": "Kasse 2",
- "tid": 67890
}
]
}| tid required | number Terminal-ID des myPOS-Terminals |
| amount required | string Zahlungsbetrag als String |
| reference | string <= 50 characters Optional Referenz (max. 50 Zeichen) |
{- "amount": "42.50",
- "reference": "Bestellung #12345"
}{- "ruid": "req_abc123xyz",
- "status": 0,
- "status_msg": "OK"
}| tid required | number Terminal-ID des myPOS-Terminals |
| ruid required | string Eindeutige Anfrage-ID |
{- "ruid": "req_abc123xyz",
- "status": 0,
- "status_msg": "OK",
- "amount": "42.50",
- "response_code": "00",
- "auth_code": "123456",
- "masked_pan": "************1234"
}Ruft die aktuelle OPI-Konfiguration mit allen konfigurierten Terminals ab
{- "configName": "opi",
- "enableRefunds": true,
- "terminals": [
- {
- "name": "Kasse 1",
- "ip": "192.168.1.100",
- "port": 20007
}, - {
- "name": "Kasse 2",
- "ip": "192.168.1.101",
- "port": 20007
}
]
}Aktualisiert die OPI-Konfiguration mit neuen Terminals und Einstellungen
Array of objects Liste der zu konfigurierenden Terminals | |
| enableRefunds | boolean Rückerstattungen aktivieren/deaktivieren |
{- "terminals": [
- {
- "name": "Kasse 1",
- "ip": "192.168.1.100",
- "port": 20007
}, - {
- "name": "Kasse 2",
- "ip": "192.168.1.101",
- "port": 20007
}
], - "enableRefunds": true
}{- "success": true
}Ruft den aktuellen Status einer Zahlung anhand der Zahlungs-ID ab
| paymentId required | string Eindeutige Zahlungs-ID |
{- "paymentId": "payment_12345"
}{- "status": "success"
}Sendet eine Zahlungsanfrage an ein OPI-Terminal. Unterstützt auch Rückerstattungen bei negativem Betrag.
| amount required | string Zahlungsbetrag (negativ für Rückerstattungen) |
required | object Terminal-Objekt |
| paymentId | string Optional eindeutige Zahlungs-ID zur Nachverfolgung |
{- "amount": "42.50",
- "terminal": {
- "name": "Kasse 1",
- "ip": "192.168.1.100",
- "port": 20007
}, - "paymentId": "payment_12345"
}{- "success": true
}Bricht eine laufende Rückerstattungsanfrage bei Softpay ab
| requestId required | string Eindeutige Request-ID der abzubrechenden Rückerstattung |
{- "requestId": "req_xyz789abc"
}{- "success": true,
- "message": "Refund cancelled"
}Aktualisiert die Softpay-Konfiguration mit Client-Zugangsdaten und Einstellungen
| client | string Client-ID für Softpay |
| secret | string Client-Secret für Softpay |
| sandbox | boolean Sandbox-Modus aktivieren/deaktivieren |
| appId | string App-ID für Softpay |
{- "client": "client_abc123",
- "secret": "secret_xyz789",
- "sandbox": true,
- "appId": "app_abc123xyz"
}{- "success": true
}Sendet eine Rückerstattungsanfrage an Softpay für einen bestimmten Betrag
| amountInCents required | string Rückerstattungsbetrag in Cent |
| employee required | string Name des Mitarbeiters, der die Rückerstattung durchführt |
| currency | string Währungscode (Standard=EUR) |
| appId required | string App-ID für die Transaktion |
{- "amountInCents": "4250",
- "employee": "Max Mustermann",
- "currency": "EUR",
- "appId": "app_abc123xyz"
}{- "success": true,
- "message": "Refund initiated",
- "intent": "softpay://transaction/refund_xyz789"
}Speichert die SumUp-Konfiguration (API-Key, Merchant, Terminals)
| apiKey | string SumUp API-Schlüssel |
| merchant | string SumUp Merchant-Code |
Array of objects Liste der konfigurierten Terminals | |
| tipRates | Array of numbers Optionale Trinkgeld-Sätze in Prozent |
{- "apiKey": "sup_sk_xxxxxxxxxxxxxxxxxxxxxxxxxx",
- "merchant": "MRCDE12345",
- "terminals": [
- {
- "tid": "rdr_3MSAFM23CK82VSTT4BN6RWSQ65",
- "name": "Frontdesk"
}
], - "tipRates": [
- 0,
- 5,
- 10,
- 15
]
}{- "apiKey": "sup_sk_xxxxxxxxxxxxxxxxxxxxxxxxxx",
- "merchant": "MRCDE12345",
- "terminals": [
- {
- "tid": "rdr_3MSAFM23CK82VSTT4BN6RWSQ65",
- "name": "Frontdesk"
}
], - "tipRates": [
- 0,
- 5,
- 10,
- 15
]
}Ruft die aktuelle Konfiguration von SumUp ab und aktualisiert die lokale Konfiguration (Terminal-Liste)
{- "apiKey": "sup_sk_xxxxxxxxxxxxxxxxxxxxxxxxxx",
- "merchant": "MRCDE12345",
- "terminals": [
- {
- "tid": "rdr_3MSAFM23CK82VSTT4BN6RWSQ65",
- "name": "Frontdesk"
}
], - "tipRates": [
- 0,
- 5,
- 10,
- 15
]
}Sendet eine Zahlungsanforderung an ein SumUp-Terminal
| tid required | string Example: rdr_3MSAFM23CK82VSTT4BN6RWSQ65 Terminal-ID des SumUp-Terminals |
| amount | number Zahlungsbetrag in Euro |
{- "amount": 49.99
}{- "success": true,
- "id": "TXNID123456789"
}Ruft den Status einer laufenden oder abgeschlossenen Zahlung ab
| payid | string Zahlungs-ID |
{- "payid": "TXNID123456789"
}{- "success": true,
- "id": "TXNID123456789",
- "status": "SUCCESSFUL",
- "amount": 49.99,
- "currency": "EUR",
- "timestamp": "2026-02-18T10:30:00Z",
- "transaction_code": "ABC123",
- "client_transaction_id": "CLIENT-TXN-001"
}Aktualisiert den Sumup API-Key und benachrichtigt alle verbundenen Clients über die Änderung
| sumupKey required | string Neuer Sumup API-Key |
{- "sumupKey": "00000000-0000-0000-0000-000000000000"
}Ruft die aktuelle ZVT-Konfiguration mit allen konfigurierten Terminals ab
{- "configName": "zvtData",
- "zvtDevices": [
- {
- "name": "Kasse 1",
- "ip": "192.168.1.100",
- "port": 20007
}, - {
- "name": "Kasse 2",
- "ip": "192.168.1.101",
- "port": 20007
}
]
}Aktualisiert die ZVT-Konfiguration mit neuen Terminals
| configName | string Name der Konfiguration (optional, immer "zvtData") |
required | Array of objects Liste der zu konfigurierenden ZVT-Terminals |
{- "configName": "zvtData",
- "zvtDevices": [
- {
- "name": "Kasse 1",
- "ip": "192.168.1.100",
- "port": 20007
}, - {
- "name": "Kasse 2",
- "ip": "192.168.1.101",
- "port": 20007
}
]
}{- "success": true
}Sendet eine Zahlungsanfrage an ein ZVT-Terminal (ZVT-Protokoll)
| amount required | string Zahlungsbetrag |
required | object Terminal-Objekt mit Verbindungsinformationen |
| paymentId | string Optional eindeutige Zahlungs-ID zur Nachverfolgung |
{- "amount": "42.50",
- "terminal": {
- "name": "Kasse 1",
- "ip": "192.168.1.100",
- "port": 20007
}, - "paymentId": "payment_12345"
}{- "success": true
}Sendet ein NFC-Scan-Ereignis über WebSocket an verbundene Clients basierend auf appId und tagId
| appId required | string Anwendungskennung, um Scanner <-> Frontend zuzuordnen (zur Zeit nicht verwendet) |
| tagId required | string NFC-Tag-ID bzw. Gutscheincode, der gescannt wurde |
{- "appId": "kasse_01",
- "tagId": "12345abcde"
}{- "success": true
}Aktualisiert die Selfordering-Konfiguration und benachrichtigt alle verbundenen Clients über die Änderung.
| enabled | boolean Selfordering aktivieren/deaktivieren |
| autoConfirm | boolean Automatische Bestätigung aktivieren/deaktivieren |
{- "enabled": true,
- "autoConfirm": false
}Ruft alle aktuell offenen Online-Bestellungen vom Selfordering-Service ab.
[- {
- "orderId": "order_456def",
- "orderStatus": "RECEIVED",
- "customerName": "Max Mustermann",
- "totalAmount": 24.5,
- "createdAt": "2026-02-13T14:30:00Z",
- "items": [
- {
- "name": "Margherita Pizza",
- "quantity": 1,
- "price": 9.5
}, - {
- "name": "Cola 0,33l",
- "quantity": 2,
- "price": 3
}
]
}
]Ruft die aktuelle Selfordering-Konfiguration ab. Falls keine Konfiguration existiert, wird eine neue mit Standardwerten erstellt.
{- "_id": "config_123abc",
- "configName": "selfordering",
- "enabled": true,
- "autoConfirm": false
}Aktualisiert den Status einer Online-Bestellung und erstellt optional die Bestellung lokal im System.
| orderId required | string ID der zu aktualisierenden Bestellung |
| confirm | boolean Bestellung bestätigen (true) oder ablehnen (false) |
| createOrder | boolean Bestellung lokal im System erstellen (nur wirksam wenn confirm=true) |
{- "orderId": "order_456def",
- "confirm": true,
- "createOrder": true
}Druckt eine oder mehrere Vorbestellungen über den konfigurierten Drucker
| employee required | string Name des Mitarbeiters, der den Druck auslöst |
required | Array of objects Liste der zu druckenden Vorbestellungen |
| area | string Optional - spezifischer Bereich für den Druck |
{- "employee": "Max Mustermann",
- "area": "Restaurant",
- "orders": [
- {
- "objectId": "preorder_abc123",
- "apiKey": "key_xyz789",
- "object": {
- "area": "Terrasse",
- "table": "Tisch 5",
- "guestName": "Anna Schmidt",
- "usedCapacity": 4,
- "orderArticles": [
- {
- "name": "Schnitzel mit Pommes",
- "extras": [
- "Extra Soße",
- "Ohne Salat"
], - "infoText": "Bitte gut durchbraten"
}, - {
- "name": "Cola 0,5l",
- "extras": [ ],
- "infoText": ""
}
]
}
}
]
}Positive Beträge = Einzahlung, negative Beträge = Auszahlung
| amount required | number Geldbetrag (positiv = Einzahlung, negativ = Auszahlung) |
| text | string Beschreibung der Buchung |
{- "amount": 100,
- "text": "Startkapital"
}| transactions | Array of objects Liste der Transaktionen |
{- "transactions": [ ]
}{- "success": true,
- "data": "string",
- "sendSuccess": true
}| _id required | string ID der Kategorie |
| name required | string Neuer Name der Kategorie |
| oldName required | string Alter Name der Kategorie |
| visible | boolean Default: true Sichtbarkeit der Kategorie |
{- "_id": "cat123",
- "name": "Heiße Getränke",
- "oldName": "Getränke",
- "visible": true
}| name required | string |
| price required | string |
| availableProducts required | Array of objects |
| required required | boolean |
| changetax required | boolean |
| category | string |
| color | string |
{- "name": "string",
- "price": "string",
- "availableProducts": [
- { }
], - "required": true,
- "changetax": true,
- "category": "string",
- "color": "string"
}| name required | string Name des Produkts |
| price required | string Preis des Produkts |
| category required | string Kategorie-Name |
| tax required | string Steuersatz |
| infoText | string Zusätzliche Info |
| stockChecking required | boolean Lagerbestand prüfen? |
| stockAmount required | number Lagerbestand |
| customPrinterAddress required | string Drucker-Adresse |
| showOnGimig required | boolean Auf Gimig anzeigen? |
| ean | string EAN |
| plu | string PLU |
{- "name": "Cappuccino",
- "price": "3.50",
- "category": "Getränke",
- "tax": "7",
- "stockChecking": false,
- "stockAmount": 0,
- "customPrinterAddress": "",
- "showOnGimig": true
}| _id required | string |
| name | string |
| category | string |
| price | string |
| tax | string |
| active | boolean |
| infoText | string |
| stockChecking | boolean |
| stockAmount | number |
| customPrinterAddress | string |
| color | string |
| showOnGimig | boolean |
| variablePrice | boolean |
| favorite | boolean |
| ean | string |
| plu | string |
{- "_id": "prod123",
- "name": "Latte Macchiato",
- "price": "4.20",
- "active": true
}| _id required | string |
| name required | string |
| price required | string |
| active required | boolean |
| availableProducts required | Array of objects |
| required required | boolean |
| changetax required | boolean |
| category | string |
| color | string |
{- "_id": "string",
- "name": "string",
- "price": "string",
- "active": true,
- "availableProducts": [
- { }
], - "required": true,
- "changetax": true,
- "category": "string",
- "color": "string"
}| password required | string Neues Passwort |
| closing | boolean Passwort für Kassenabschluss |
| article | boolean Passwort für Artikel |
| settings | boolean Passwort für Einstellungen |
{- "password": "1234",
- "closing": true,
- "article": false,
- "settings": true
}required | object |
{- "restaurantData": {
- "restaurantName": "string",
- "restaurantStreet": "string",
- "restaurantHouseNumber": "string",
- "restaurantZip": "string",
- "restaurantCity": "string",
- "restaurantUstid": "string",
- "restaurantStnr": "string"
}
}Fügt einen neuen Drucker zur Konfiguration hinzu
| name required | string Name des Druckers |
required | Array of objects |
required | object |
{- "name": "Küche",
- "devices": [
- {
- "ip": "192.168.1.100",
- "type": 0
}
], - "config": {
- "partialPrinting": false,
- "summaryOnPartialPrint": false,
- "textHuge": true,
- "orderedOrder": true,
- "kickDrawer": false,
- "tableOnBottom": false
}
}Aktualisiert die Konfiguration eines vorhandenen Druckers
| oldName required | string Aktueller Name des Druckers |
| name required | string Neuer Name des Druckers |
required | Array of objects |
required | object |
{- "oldName": "Küche",
- "name": "Küche 1",
- "devices": [
- {
- "ip": "192.168.1.100",
- "type": 0
}
], - "config": {
- "partialPrinting": false,
- "summaryOnPartialPrint": false,
- "textHuge": true,
- "orderedOrder": true,
- "kickDrawer": false,
- "tableOnBottom": false
}
}Ruft einen einzelnen Drucker mit seinem aktuellen Status ab
| name required | string Name des Druckers |
{- "name": "Küche",
- "devices": [
- {
- "ip": "192.168.1.100",
- "type": 0,
- "reachable": true
}
], - "config": {
- "partialPrinting": false,
- "textHuge": true,
- "kickDrawer": false
}
}[- {
- "name": "Küche",
- "devices": [
- {
- "ip": "192.168.1.100",
- "type": 0,
- "reachable": true
}
], - "config": {
- "partialPrinting": false,
- "summaryOnPartialPrint": false,
- "textHuge": true,
- "orderedOrder": true,
- "kickDrawer": false,
- "tableOnBottom": false
}
}
]{- "printingOnOwnDevice": false,
- "automaticDigitalReceive": true,
}Aktualisiert die globale Druckkonfiguration. Felder können einzeln oder zusammen aktualisiert werden.
| printingOnOwnDevice | boolean Drucken auf eigenem Gerät aktiviert |
| automaticDigitalReceive | boolean Automatischer digitaler Empfang |
| logoUrl | string URL des Logos für Belege |
{- "printingOnOwnDevice": false,
- "automaticDigitalReceive": true,
}Sendet einen Testdruck an einen Drucker, um die Verbindung zu prüfen
| ip required | string IP-Adresse des Druckers |
| type required | number Druckertyp (0 = ESCPOS, 1 = VIRTUAL) |
| name | string Optionaler Name des Druckers |
{- "ip": "192.168.1.100",
- "type": 0,
- "name": "Küche"
}Versucht, einen Drucker an der angegebenen IP-Adresse erneut zu finden und die Verbindung wiederherzustellen
| name required | string Name des Druckers |
| ip required | string IP-Adresse des Druckers |
{- "name": "Küche",
- "ip": "192.168.1.100"
}Aktualisiert die Einstellungen eines Druckers. Felder können einzeln oder zusammen aktualisiert werden.
| name required | string Name des Druckers |
| kickDrawer | boolean Kassenschublade öffnen nach Druck |
| orderedOrder | boolean Bestellungen sortiert drucken |
| partialPrinting | boolean Teilweises Drucken aktiviert |
| summaryOnPartialPrint | boolean Zusammenfassung bei Teildruck anzeigen |
| textHuge | boolean Große Textgröße verwenden |
| tableOnBottom | boolean Tischnummer am Ende drucken |
| width | number Druckbreite in Zeichen (1-1000) |
| footerText | string Fußzeilentext |
| hideExtraPrice | boolean Extra-Preis ausblenden |
{- "name": "Küche",
- "kickDrawer": false,
- "textHuge": true,
- "orderedOrder": true,
- "footerText": "Vielen Dank!"
}Exportiert alle Einträge aus der angegebenen Datenbank
| db required | string Enum: "cashbookDb" "categoryDb" "configDb" "orderDb" "payedOrdersDb" "productDb" "tempDb" "voucherDb" Name der zu exportierenden Datenbank |
[- {
- "_id": "cat_001",
- "name": "Getränke",
- "order": 1
}, - {
- "_id": "cat_002",
- "name": "Speisen",
- "order": 2
}
]Ersetzt alle Einträge in der angegebenen Datenbank mit den importierten Daten. ACHTUNG - Alle vorhandenen Daten werden gelöscht!
| db required | string Enum: "cashbookDb" "categoryDb" "configDb" "orderDb" "payedOrdersDb" "productDb" "tempDb" "voucherDb" Name der zu importierenden Datenbank |
[- {
- "_id": "cat_001",
- "name": "Getränke",
- "order": 1
}, - {
- "_id": "cat_002",
- "name": "Speisen",
- "order": 2
}
]{- "success": true
}Setzt den aktiven Kartenzahlungsanbieter
| provider required | string Enum: "none" "mypos" "sumup" "zvt" "softpos" "mypos-glass" "opi" "mollie" "adyen" Der zu aktivierende Kartenzahlungsanbieter |
{- "provider": "sumup"
}Setzt die Liste der aktivierten Kartenzahlungsanbieter. Mit "all" können alle Anbieter aktiviert werden.
[- "sumup",
- "mypos",
- "zvt"
]{- "success": true,
- "object": [
- "sumup",
- "mypos",
- "zvt"
]
}Setzt die Kassenbuch-Konfiguration. Felder können einzeln oder zusammen aktualisiert werden.
| autoCloseCheckout | boolean Automatischer Kassenabschluss aktiviert |
| closeCheckoutHour | number [ 0 .. 23 ] Stunde für automatischen Kassenabschluss (0-23) |
| cashbookEnabled | boolean Kassenbuch aktiviert |
{- "autoCloseCheckout": true,
- "closeCheckoutHour": 22,
- "cashbookEnabled": true
}{- "autoCloseCheckout": true,
- "closeCheckoutHour": 22,
- "cashbookEnabled": true
}Ruft den aktuellen Status des Netzwerkscans ab, inklusive gefundener Geräte und Fortschritt
{- "scanning": true,
- "foundDevices": [
- {
- "ip": "192.168.1.100",
- "type": 0,
- "reachable": true
}, - {
- "ip": "192.168.1.101",
- "type": 0,
- "reachable": true
}
], - "progress": 0.453
}Setzt die aktiven Steuersätze aus der Liste der verfügbaren Standardwerte. Die Werte werden automatisch absteigend sortiert.
[- "19",
- "7",
- "0"
]Ruft alle Artikel ab, die einen Steuersatz haben, der nicht in den aktuell konfigurierten Steuersätzen enthalten ist
[- {
- "_id": "prod_001",
- "name": "Pizza Margherita",
- "tax": "16",
- "price": "8.50"
}, - {
- "_id": "prod_002",
- "name": "Cola",
- "tax": "16",
- "price": "2.50"
}
]Migriert alle Artikel mit ungültigen Steuersätzen zu einem neuen, gültigen Steuersatz
[- "19"
]42Ruft die aktuelle Zahlungskonfiguration ab, inklusive Trinkgeld-, Gutschein- und Zahlungsmethoden-Einstellungen
{- "tipEnable": false,
- "tipShowServer": true,
- "tipFlip": false,
- "tipPercentMode": true,
- "tipPercentValues": [
- "5",
- "10",
- "15",
- "20"
], - "tipThanks": true,
- "enabledPaymentMethods": [
- "CASH",
- "CARD",
- "INVOICE"
], - "nfcVouchersEnabled": false,
- "nfcVoucherTopupEnabled": false,
- "nfcVoucherPayoutEnabled": false,
- "cloudVouchersEnabled": false,
- "showTipCalculator": true,
- "showVoucherButton": true,
- "showDiscountButton": true
}Aktualisiert die Zahlungskonfiguration. Felder können einzeln oder zusammen aktualisiert werden.
| tipEnable | boolean Trinkgeld aktiviert |
| tipShowServer | boolean Zeige Server-Auswahl bei Trinkgeld |
| tipFlip | boolean Trinkgeld-Ansicht umdrehen |
| tipPercentMode | boolean Trinkgeld als Prozentwerte anzeigen |
| tipPercentValues | Array of strings Vordefinierte Trinkgeld-Prozentwerte |
| tipThanks | boolean Dankesbild nach Trinkgeld anzeigen |
| enabledPaymentMethods | Array of strings Items Enum: "CASH" "CARD" "INVOICE" Aktivierte Zahlungsmethoden |
| nfcVouchersEnabled | boolean NFC-Gutscheine aktiviert |
| nfcVoucherTopupEnabled | boolean NFC-Gutschein-Aufladung aktiviert |
| nfcVoucherPayoutEnabled | boolean NFC-Gutschein-Auszahlung aktiviert |
| cloudVouchersEnabled | boolean Cloud-Gutscheine aktiviert |
| showTipCalculator | boolean Trinkgeldrechner anzeigen |
| showVoucherButton | boolean Gutschein-Button anzeigen |
| showDiscountButton | boolean Rabatt-Button anzeigen |
{- "tipEnable": true,
- "tipPercentMode": true,
- "tipPercentValues": [
- "10",
- "15",
- "20"
], - "enabledPaymentMethods": [
- "CASH",
- "CARD"
], - "showTipCalculator": true
}{- "tipEnable": true,
- "tipShowServer": true,
- "tipFlip": true,
- "tipPercentMode": true,
- "tipPercentValues": [
- "string"
], - "tipThanks": true,
- "enabledPaymentMethods": [
- "string"
], - "nfcVouchersEnabled": true,
- "nfcVoucherTopupEnabled": true,
- "nfcVoucherPayoutEnabled": true,
- "cloudVouchersEnabled": true,
- "showTipCalculator": true,
- "showVoucherButton": true,
- "showDiscountButton": true
}