JavaScript / .NET

API-Spezifikation

Technische Referenz auf Basis der vorhandenen TypeScript-Definitionen.

1. Data APIs

1.2 Einführung

Data APIs dienen zum Abrufen, Hinzufügen, Aktualisieren und Löschen von Rohdaten. Für jede Modellklasse gibt es eine eigene API-Klasse, zum Beispiel DishAPI für DishModel. Die Methoden sind bei diesen APIs gleich; sie unterscheiden sich durch den Modelltyp und die zugeordnete Datenliste. Bei allen Modellklassen ist Id die einzige technisch erforderliche Eigenschaft.

export class DishAPI extends DataAPI<DishModel> {
  constructor() {
    super(DishListId);
  }
}

Die folgenden Abfrage- und Schreibfunktionen werden deshalb einmal am Beispiel der DishAPI beschrieben.

1.3 Daten abrufen

Load() führt die Abfrage aus und liefert die passenden Datensätze. Abfrageoptionen werden vor Load() verkettet.

Option	Verwendung	Funktion
`Where(field, filter, value)`	`.Where("Name", FilterType.Equals, "Suppe")`	Filtert nach Feld, Filteroperator und Vergleichswert.
`OrderAsc(field)`	`.OrderAsc("Name")`	Sortiert aufsteigend nach dem angegebenen Feld.
`OrderDesc(field)`	`.OrderDesc("SentDate")`	Sortiert absteigend nach dem angegebenen Feld.
`Include(field)`	`.Include("Category")`	Bezieht verknüpfte Daten des Felds ein.
`Limit(count)`	`.Limit(20)`	Begrenzt die Anzahl der geladenen Datensätze.

const dishes = await new DishAPI()
  .Where("Name", FilterType.Equals, "Suppe")
  .Include("Category")
  .OrderAsc("Name")
  .Limit(20)
  .Load();

1.4 Daten ändern

Schreibfunktionen arbeiten mit dem jeweiligen Modelltyp. Update kann laut Verwendung sowohl ein einzelnes Modell als auch eine Liste von Modellen entgegennehmen. Delete kann eine ID oder eine Liste von IDs löschen.

Methode	Funktion	Beispiel
`Add(model)`	Fügt einen Datensatz hinzu.	`await api.Add(dish)`
`Update(modelOrModels)`	Aktualisiert einen oder mehrere Datensätze.	`await api.Update({ Id, Price })`
`Delete(idOrIds)`	Löscht einen oder mehrere Datensätze anhand ihrer IDs.	`await api.Delete(id)`

2. Models

2.1 DishModel

Modell eines Speisekarteneintrags. Id ist die einzige technisch erforderliche Eigenschaft. Nicht angegebene optionale Eigenschaften können beim Schreiben ausgelassen werden.

Feld	Typ	Beschreibung
`Id`	`string`	Eindeutige ID des Gerichts, zum Beispiel `"dish-123"`.
`Name`	`string`	Anzeigename des Gerichts.
`Price`	`number`	Preis des Gerichts.
`Image`	`string`	Bildreferenz, zum Beispiel `"suppe.jpg"`.
`Category`	`LinkedValue`	Verknüpfte Kategorie; kann eine `LinkedId` und einen `Value` enthalten.
`Description`	`string`	Beschreibung des Gerichts.
`Available`	`number`	Verfügbarkeitswert.
`Allergens`	`string`	Allergenangaben, zum Beispiel `"A, G"`.
`Vegetarian`	`boolean`	Kennzeichnet, ob das Gericht vegetarisch ist.
`Vegan`	`boolean`	Kennzeichnet, ob das Gericht vegan ist.
`Featured`	`number`	Numerischer Wert zur Hervorhebung des Gerichts.

2.2 AdminSettingsModel

Feld	Typ	Beschreibung
`Id`	`string`	Eindeutige ID des Eintrags.
`Key`	`string`	Schlüssel der Einstellung.
`Value`	`string`	Wert der Einstellung.

2.3 CategoryModel

Feld	Typ	Beschreibung
`Id`	`string`	Eindeutige ID der Kategorie.
`Name`	`string`	Name der Kategorie.
`SortOrder`	`number`	Position bei der Sortierung.

2.4 CompanyAreaModel

Feld	Typ	Beschreibung
`Id`	`string`	Eindeutige ID des Unternehmensbereichs.
`Number`	`string`	Bereichsnummer.
`Name`	`string`	Name des Bereichs.
`Parent`	`string`	ID des übergeordneten Bereichs.
`FullName`	`string`	Vollständiger Name inklusive Hierarchie.

2.5 DishOptionModel

Feld	Typ	Beschreibung
`Id`	`string`	Eindeutige ID der Option.
`Name`	`string`	Anzeigename der Option.
`Surcharge`	`number`	Aufpreis für die Option.
`Dish`	`LinkedValue`	Verknüpftes Gericht.
`Activ`	`boolean`	Gibt an, ob die Option aktiv ist.
`GroupName`	`string`	Name der Optionsgruppe.
`Allergens`	`string`	Allergenangaben.
`Vegetarian`	`boolean`	Kennzeichnet eine vegetarische Option.
`Vegan`	`boolean`	Kennzeichnet eine vegane Option.

2.6 FinishedOrderModel

Feld	Typ	Beschreibung
`Id`	`string`	Eindeutige ID des abgeschlossenen Auftrags.
`OrderNumber`	`string`	Auftragsnummer.
`Table`	`LinkedValue`	Verknüpfter Tisch.

2.7 FiscalEntityModel

Feld	Typ	Beschreibung
`Id`	`string`	Eindeutige ID des Steuersubjekts.
`CompanyName`	`string`	Firmenname.
`CompanyAddressLine1`	`string`	Erste Adresszeile.
`CompanyAddressLine2`	`string`	Zweite Adresszeile.
`HeaderTextForReceipt`	`string`	Kopftext auf Belegen.
`FooterTextForReceipt`	`string`	Fußtext auf Belegen.
`RegistrierkassenId`	`string`	Registrierkassen-ID.

2.8 HolidayModel

Feld	Typ	Beschreibung
`Id`	`string`	Eindeutige ID des Eintrags.
`Start`	`Date`	Beginn des Zeitraums.
`End`	`Date`	Ende des Zeitraums.
`Resource`	`LinkedValue`	Zugeordnete Ressource.
`Typ`	`string`	Typ des Eintrags.

2.9 ImbissResourceModel

Feld	Typ	Beschreibung
`Id`	`string`	Eindeutige ID der Ressource.
`IsTable`	`boolean`	Gibt an, ob die Ressource ein Tisch ist.
`PaymentProviderConfig`	`string`	Zahlungsanbieter-Konfiguration.
`FiscalEntity`	`LinkedValue`	Zugeordnetes Steuersubjekt.
`Name`	`string`	Name der Ressource.
`StartDate`	`Date`	Beginn des Gültigkeitszeitraums.
`EndDate`	`Date`	Ende des Gültigkeitszeitraums.
`Standort`	`MultiLinkedValue`	Zugeordnete Standorte.

2.10 KitchenStationModel

Feld	Typ	Beschreibung
`Id`	`string`	Eindeutige ID der Küchenstation.
`Name`	`string`	Name der Küchenstation.
`Icon`	`string`	Icon-Kennung.
`Active`	`boolean`	Gibt an, ob die Station aktiv ist.

2.11 OrderModel

Feld	Typ	Beschreibung
`Id`	`string`	Eindeutige ID der Bestellung.
`OrderTable`	`LinkedValue`	Zugeordneter Tisch.
`CreateDate`	`Date`	Zeitpunkt der Erstellung.
`SentDate`	`Date`	Zeitpunkt der Übermittlung.
`StartedDate`	`Date`	Zeitpunkt des Bearbeitungsbeginns.
`ReadyDate`	`Date`	Zeitpunkt der Fertigstellung.
`OrderNumber`	`number`	Angezeigte Bestellnummer.
`PaymentStatus`	`number`	Zahlungsstatus als numerischer Wert.
`ReadyForPickup`	`boolean`	Gibt an, ob die Bestellung abholbereit ist.
`Station`	`MultiLinkedValue`	Zugeordnete Küchenstationen.

2.12 OrderLineModel

Feld	Typ	Beschreibung
`Id`	`string`	Eindeutige ID der Bestellposition.
`Order`	`LinkedValue`	Zugehörige Bestellung.
`Dish`	`LinkedValue`	Bestelltes Gericht.
`Price`	`number`	Preis der Position.
`Comment`	`string`	Kommentar oder Sonderwunsch.
`Option`	`MultiLinkedValue`	Ausgewählte Optionen.
`PaymentStatus`	`number`	Zahlungsstatus als numerischer Wert.
`OrderStatus`	`number`	Bestellstatus als numerischer Wert.
`TaxRate`	`number`	Angewendeter Steuersatz.
`OrderTable`	`LinkedValue`	Zugeordneter Tisch.

2.13 PaymentModel

Feld	Typ	Beschreibung
`Id`	`string`	Eindeutige ID der Zahlung.
`PaymentStatus`	`number`	Zahlungsstatus als numerischer Wert.
`PaymentReference`	`string`	Referenz des Zahlungsvorgangs.
`AmountPaid`	`number`	Bezahlter Betrag.
`PaymentType`	`number`	Zahlungsart als numerischer Wert.
`InvoiceAmount`	`number`	Rechnungsbetrag.
`OrderLines`	`MultiLinkedValue`	Zugehörige Bestellpositionen.
`Table`	`LinkedValue`	Zugeordneter Tisch.
`Started`	`Date`	Beginn des Zahlungsvorgangs.
`Finished`	`Date`	Abschluss des Zahlungsvorgangs.
`CashBookId`	`string`	ID des zugeordneten Kassenbuchs.
`FiscalTransactionId`	`number`	ID des Fiskalvorgangs.
`Tips`	`number`	Trinkgeldbetrag.
`CashBookEntryId`	`number`	ID des Kassenbucheintrags.
`PaymentMessage`	`string`	Nachricht zum Zahlungsvorgang.
`AmountPaidByVoucher`	`number`	Mit Gutscheinen bezahlter Betrag.

2.14 ServiceCallModel

Feld	Typ	Beschreibung
`Id`	`string`	Eindeutige ID des Service-Rufs.
`Table`	`LinkedValue`	Tisch, von dem der Ruf ausgelöst wurde.
`CallDate`	`Date`	Zeitpunkt des Service-Rufs.

2.15 VoucherModel

Feld	Typ	Beschreibung
`Id`	`string`	Eindeutige ID des Gutscheins.
`VoucherCode`	`string`	Gutscheincode.
`VoucherValue`	`number`	Ursprünglicher Gutscheinwert.
`VoucherBalance`	`number`	Verbleibendes Guthaben.
`ValidUntil`	`Date`	Gültig bis zu diesem Zeitpunkt.
`IssuedOn`	`Date`	Ausstellungszeitpunkt.
`Invalid`	`boolean`	Gibt an, ob der Gutschein ungültig ist.

3. Services

3.1 Einführung

Services führen fachliche oder mehrstufige Aktionen aus, die über das einfache Hinzufügen, Aktualisieren oder Löschen einzelner Rohdatensätze hinausgehen.

3.2 OrderService

OrderService stellt Aktionen für Bestellungen bereit.

Methode	Parameter	Ergebnis	Beschreibung
`AddOrderLine`	`DishId: string` `OptionIds: string[]` `TableId: string`	`Promise<void>`	Fügt ein Gericht mit den gewählten Optionen zur Bestellung am angegebenen Tisch hinzu.
`RemoveOrderLine`	`lineId: string`	`Promise<void>`	Entfernt die Bestellposition mit der angegebenen ID.
`SendOrder`	`orderId: string`	`Promise<void>`	Sendet die angegebene Bestellung ab.
`GetFeatures`	—	`Promise<FeatureList>`	Liefert die konfigurierten Funktionen und Grenzwerte.
`DummyForEnums`	`OrderStatusEnum`, `PaymentStatusEnum`, `PaymentTypeEnum`	`Promise<void>`	Hilfsmethode, die Status- und Zahlungswerte an den Order-Endpunkt weitergibt.

await OrderService.AddOrderLine(
  dishId,
  optionIds,
  tableId
);

3.3 CashBookService

Methode	Parameter	Ergebnis	Beschreibung
`CreateCashBook`	`CashBookCreateOptions`	`Promise<string>`	Erstellt ein Kassenbuch.
`UpdateCashBook`	`CashBookUpdateOptions`	`Promise<void>`	Aktualisiert ein Kassenbuch.
`ListCashBooks`	`CashBookListOptions`	`Promise<CashBookModel[]>`	Liefert Kassenbücher passend zu den Suchoptionen.
`CreateEntry`	`CashTransactionCreateOptions`	`Promise<number>`	Erstellt eine Kassenbuchtransaktion und liefert deren ID.
`GetEntry`	`cashTransactionId: number`	`Promise<CashTransactionModel>`	Liefert eine Transaktion anhand ihrer ID.
`SearchEntries`	`CashTransactionSearchOptions`	`Promise<CashTransactionSearchResult>`	Sucht Kassenbuchtransaktionen.
`GetCashBookBalance`	`cashBookId: string`	`Promise<number>`	Liefert den aktuellen Saldo des Kassenbuchs.
`GetCashBookBalanceAt`	`cashBookId: string` `recordedAt: Date` `activeOnly: boolean`	`Promise<number>`	Liefert den Saldo zum angegebenen Zeitpunkt, optional nur aus aktiven Einträgen.
`GetDefaultCashBookId`	—	`Promise<string>`	Liefert die ID des Standard-Kassenbuchs.
`CreateReconciliation`	`CashReconciliationCreateOptions`	`Promise<string>`	Erstellt einen Kassenabgleich.
`UpdateReconciliationReason`	`CashReconciliationReasonUpdateOptions`	`Promise<void>`	Aktualisiert Begründung und Notizen eines Kassenabgleichs.
`ListReconciliations`	`CashReconciliationSearchOptions`	`Promise<CashReconciliationModel[]>`	Liefert Kassenabgleiche passend zu den Suchoptionen.

3.4 PaymentService

Methode	Parameter	Ergebnis	Beschreibung
`PayOpenOrders`	`orderLineGuids: string[]` `tipAmount: number` `voucherCodes: any[]`	`Promise<string>`	Startet die Zahlung offener Bestellpositionen inklusive Trinkgeld und Gutscheincodes.
`ValidateVoucher`	`voucherCode: string`	`Promise<VoucherValidationResult>`	Prüft einen Gutscheincode und liefert das Validierungsergebnis.
`SetPaymentAsPaid`	`paymentId: string`	`Promise<void>`	Setzt die angegebene Zahlung auf bezahlt.
`ResetPayment`	`paymentId: string`	`Promise<void>`	Setzt den Status der angegebenen Zahlung zurück.

3.5 PrintService

Methode	Parameter	Ergebnis	Beschreibung
`GenerateESC`	`ESCPrintingOptions`	`Promise<string>`	Erzeugt Druckdaten im ESC-Format.
`GeneratePDF`	`PDFPrintingOptions`	`Promise<string>`	Erzeugt ein PDF-Dokument.
`GenerateDigitalReceiptForPayment`	`paymentId: string`	`Promise<string>`	Erzeugt einen digitalen Beleg für eine Zahlung.
`PrintEscViaConfiguration`	`printConfigurationId: string` `ESCPrintingOptions`	`Promise<string>`	Erzeugt ESC-Druckdaten anhand einer Druckkonfiguration.
`ListGatewayClients`	—	`Promise<GatewayClientModel[]>`	Liefert die eingerichteten Gateway-Clients.
`SaveGatewayClient`	`GatewayClientModel`	`Promise<GatewayClientModel>`	Speichert einen Gateway-Client und liefert den gespeicherten Datensatz.
`DeleteGatewayClient`	`gatewayId: string`	`Promise<void>`	Löscht den Gateway-Client mit der angegebenen ID.
`ListPrintConfigurations`	—	`Promise<PrintConfigurationModel[]>`	Liefert die eingerichteten Druckkonfigurationen.
`SavePrintConfiguration`	`PrintConfigurationModel`	`Promise<PrintConfigurationModel>`	Speichert eine Druckkonfiguration und liefert den gespeicherten Datensatz.
`DeletePrintConfiguration`	`printConfigurationId: string`	`Promise<void>`	Löscht die Druckkonfiguration mit der angegebenen ID.
`CreateGatewayConfigJson`	`gatewayId: string` `serverWebSocketUrl: string`	`Promise<string>`	Erzeugt die JSON-Konfiguration für einen Gateway-Client.

3.6 RksvService

Methode	Parameter	Ergebnis	Beschreibung
`CreateSignatureCertificate`	—	`Promise<number>`	Erstellt ein Signaturzertifikat und liefert dessen ID.
`CreateCashRegister`	`identifikationsNummer: string` `certificateId: number`	`Promise<string>`	Registriert eine Kasse mit Identifikationsnummer und Zertifikat.
`CreateStartDEP`	`cashRegisterId: string` `fiscalEntityId: string`	`Promise<number>`	Erstellt das Start-DEP für Kasse und Steuersubjekt.
`ListMandatoryReceiptStatus`	—	`Promise<RksvMandatoryReceiptStatus[]>`	Liefert den Status der vorgeschriebenen Belege.
`CreateMonthlyReceipt`	`cashRegisterId: string` `fiscalEntityId: string` `year: number` `month: number`	`Promise<number>`	Erstellt den Monatsbeleg für Kasse, Steuersubjekt und Zeitraum.
`CreateYearlyReceipt`	`cashRegisterId: string` `fiscalEntityId: string` `year: number`	`Promise<number>`	Erstellt den Jahresbeleg für Kasse, Steuersubjekt und Jahr.
`CreateFinalReceipt`	`cashRegisterId: string` `fiscalEntityId: string`	`Promise<number>`	Erstellt den Schlussbeleg.
`GetCashRegisters`	—	`Promise<CashRegister[]>`	Liefert die registrierten Kassen.
`Export`	`cashRegisterId: string`	`Promise<string>`	Erzeugt einen Export für die angegebene Kasse.
`ExportCsv`	`cashRegisterId: string`	`Promise<string>`	Erzeugt einen CSV-Export für die angegebene Kasse.

3.7 TableService

Methode	Parameter	Ergebnis	Beschreibung
`GetLoginQrCode`	`tableId: string`	`Promise<string>`	Liefert den Login-QR-Code für den angegebenen Tisch.

3.8 TranslationService

Methode	Parameter	Ergebnis	Beschreibung
`Translate`	`text: string`	`Promise<string>`	Übersetzt den angegebenen Text.
`GetAll`	—	`Promise<{ [key: string]: string }>`	Liefert alle verfügbaren Übersetzungen als Schlüssel-Wert-Zuordnung.

4. Types

4.1 FeatureList

Objekt mit optionalen Funktionsflags und Grenzwerten.

Eigenschaft	Typ	Beschreibung
`CardPaymentByCustomer`	`boolean`	Ermöglicht Gästen die Kartenzahlung.
`CallForService`	`boolean`	Aktiviert den Service-Ruf durch Gäste.
`Vouchers`	`boolean`	Aktiviert die Gutschein-Funktion.
`DigitalReceipt`	`boolean`	Aktiviert digitale Belege.
`SelfOrdering`	`boolean`	Aktiviert Self-Order.
`AskForTips`	`boolean`	Aktiviert die Trinkgeldabfrage.
`MaxSelfPaymentAmount`	`number`	Maximalbetrag für Self-Payment.
`MaxOrderAmount`	`number`	Maximaler Bestellbetrag.
`MinimumOrderAmount`	`number`	Mindestbestellbetrag.
`DigitalReceiptAvailabilityMinutes`	`number`	Verfügbarkeitsdauer digitaler Belege in Minuten.

4.2 OrderStatusEnum

None = 0
Pending = 1
Ordered = 2
InProgress = 3
Ready = 4
Closed = 5

4.3 PaymentStatusEnum

None = 0
Preparing = 1
Started = 2
Failed = 3
Canceled = 4
PayLater = 6
Paid = 10

4.4 PaymentTypeEnum

None = 0
Cash = 1
Card = 2
VoucherOnly = 3

LinkedValue

LinkedId?: string: ID des verknüpften Eintrags.
Value?: any: Wert des verknüpften Eintrags.

MultiLinkedValue

LinkedIds?: string[]: IDs der verknüpften Einträge.
Values?: any[]: Werte der verknüpften Einträge.

CashBookCreateOptions

Name?: string: Name des neuen Kassenbuchs.
OpeningBalance?: number: Eröffnungsbestand.
IsActive?: boolean: Aktivstatus des Kassenbuchs.

CashBookUpdateOptions

CashBookId?: string: ID des zu aktualisierenden Kassenbuchs.
Name?: string: Name des Kassenbuchs.
OpeningBalance?: number: Eröffnungsbestand.
IsActive?: boolean: Aktivstatus des Kassenbuchs.

CashBookListOptions

IncludeInactive?: boolean: Bezieht inaktive Kassenbücher in die Liste ein.
SearchText?: string: Suchtext zur Filterung der Liste.

CashBookModel

CashBookId?: string: ID des Kassenbuchs.
Name?: string: Name des Kassenbuchs.
OpeningBalance?: number: Eröffnungsbestand.
CurrentBalance?: number: Aktueller Bestand.
IsActive?: boolean: Aktivstatus.
CreatedAt?: Date: Erstellungszeitpunkt.
TransactionCount?: number: Anzahl der Transaktionen.
LastRecordedAt?: Date: Zeitpunkt der letzten Erfassung.

CashTransactionCreateOptions

CashBookId?: string: ID des zugehörigen Kassenbuchs.
Amount?: number: Betrag der Transaktion.
TransactionType?: CashTransactionTypeEnum: Art der Transaktion.
BusinessDate?: Date: Buchungsdatum im Geschäftsbetrieb.
Description?: string: Beschreibung der Transaktion.
Reference?: string: Externe oder interne Referenz.
AccountNumber?: string: Kontonummer.
AccountName?: string: Kontobezeichnung.
CorrectsTransactionId?: number: ID der korrigierten Transaktion.
CurrentUser?: string: Benutzer, der die Transaktion erfasst.

CashTransactionModel

CashTransactionId?: number: ID der Transaktion.
CashBookId?: string: ID des zugehörigen Kassenbuchs.
Amount?: number: Betrag der Transaktion.
TransactionType?: CashTransactionTypeEnum: Art der Transaktion.
BusinessDate?: Date: Buchungsdatum im Geschäftsbetrieb.
RecordedAt?: Date: Zeitpunkt der Erfassung.
Description?: string: Beschreibung der Transaktion.
Reference?: string: Externe oder interne Referenz.
AccountNumber?: string: Kontonummer.
AccountName?: string: Kontobezeichnung.
CorrectsTransactionId?: number: ID der korrigierten Transaktion.
CreatedBy?: string: Benutzer, der den Eintrag erstellt hat.

CashTransactionSearchOptions

CashBookId?: string: Filtert nach Kassenbuch.
RecordedFrom?: Date: Frühester Erfassungszeitpunkt.
RecordedTo?: Date: Spätester Erfassungszeitpunkt.
BusinessDateFrom?: Date: Frühestes Buchungsdatum.
BusinessDateTo?: Date: Spätestes Buchungsdatum.
TransactionType?: CashTransactionTypeEnum: Filtert nach Transaktionsart.
SearchText?: string: Suchtext.
AmountFrom?: number: Untergrenze des Betrags.
AmountTo?: number: Obergrenze des Betrags.
AccountNumber?: string: Filtert nach Kontonummer.
Offset?: number: Anzahl der Einträge, die am Anfang übersprungen werden.
Limit?: number: Maximale Anzahl der Ergebnisse.
SortBy?: CashTransactionSortField: Sortierfeld.
SortDescending?: boolean: Legt eine absteigende Sortierung fest.

CashTransactionSearchResult

Entries?: CashTransactionModel[]: Gefundene Transaktionen.
TotalCount?: number: Gesamtzahl der Treffer.
OpeningBalanceBeforeFilter?: number: Bestand vor Anwendung der Filter.
IncomeTotal?: number: Summe der Einnahmen.
ExpenseTotal?: number: Summe der Ausgaben.
NetTotal?: number: Netto-Gesamtsumme.
ClosingBalance?: number: Abschlussbestand.

CashReconciliationCreateOptions

CashBookId?: string: ID des Kassenbuchs.
ReconciliationType?: CashReconciliationTypeEnum: Art des Kassenabgleichs.
ReconciledAt?: Date: Zeitpunkt des Abgleichs.
CountedBalance?: number: Gezählter Bestand.
ReasonType?: CashReconciliationReasonTypeEnum: Grund für eine Abweichung.
Notes?: string: Zusätzliche Notizen.
CreateAdjustmentTransaction?: boolean: Legt fest, ob eine Ausgleichstransaktion erstellt wird.
AdjustmentDescription?: string: Beschreibung der Ausgleichstransaktion.
CurrentUser?: string: Benutzer, der den Abgleich erstellt.

CashReconciliationReasonUpdateOptions

CashReconciliationId?: string: ID des Kassenabgleichs.
ReasonType?: CashReconciliationReasonTypeEnum: Grund für die Abweichung.
Notes?: string: Zusätzliche Notizen.
CurrentUser?: string: Benutzer, der die Änderung vornimmt.

CashReconciliationSearchOptions

CashBookId?: string: Filtert nach Kassenbuch.
ReconciledFrom?: Date: Frühester Zeitpunkt des Abgleichs.
ReconciledTo?: Date: Spätester Zeitpunkt des Abgleichs.
ReconciliationType?: CashReconciliationTypeEnum: Filtert nach Art des Abgleichs.

CashReconciliationModel

CashReconciliationId?: string: ID des Kassenabgleichs.
CashBookId?: string: ID des Kassenbuchs.
ReconciliationType?: CashReconciliationTypeEnum: Art des Abgleichs.
ReconciledAt?: Date: Zeitpunkt des Abgleichs.
CreatedAt?: Date: Erstellungszeitpunkt.
BookBalance?: number: Saldo laut Kassenbuch.
CountedBalance?: number: Gezählter Bestand.
Difference?: number: Abweichung zwischen Buch- und Ist-Bestand.
DifferenceType?: CashReconciliationDifferenceTypeEnum: Art der Abweichung.
ReasonType?: CashReconciliationReasonTypeEnum: Grund für die Abweichung.
AdjustmentTransactionId?: number: ID der Ausgleichstransaktion.
Notes?: string: Notizen zum Abgleich.
CreatedBy?: string: Benutzer, der den Abgleich erstellt hat.

VoucherValidationResult

IsValid?: boolean: Gibt an, ob der Gutschein gültig ist.
VoucherCode?: string: Geprüfter Gutscheincode.
VoucherBalance?: number: Verbleibendes Guthaben.
Message?: string: Ergebnis- oder Fehlermeldung.

ESCPrintingOptions

FiscalTransactionId?: number: ID des Fiskalvorgangs, der gedruckt werden soll.

PDFPrintingOptions

FiscalTransactionId?: number: ID des Fiskalvorgangs, für den ein PDF erzeugt wird.

GatewayClientModel

GatewayId?: string: ID des Gateway-Clients.
DisplayName?: string: Anzeigename.
Secret?: string: Geheimer Zugangswert.
LastSeenAt?: Date: Zeitpunkt des letzten Kontakts.
LastStatus?: string: Zuletzt gemeldeter Status.
CreatedAt?: Date: Erstellungszeitpunkt.
UpdatedAt?: Date: Zeitpunkt der letzten Aktualisierung.

PrintConfigurationModel

PrintConfigurationId?: string: ID der Druckkonfiguration.
Name?: string: Name der Konfiguration.
DeliveryChannel?: number: Numerische Kennung des Ausgabekanals.
PrinterType?: number: Numerische Kennung des Druckertyps.
GatewayId?: string: ID des zugeordneten Gateways.
PrinterHost?: string: Host des Druckers.
PrinterPort?: number: Netzwerkport des Druckers.
PrinterTimeoutMs?: number: Timeout in Millisekunden.
MaxRetryAttempts?: number: Maximale Anzahl der Wiederholungsversuche.
MaxRetryDurationSeconds?: number: Maximale Dauer der Wiederholungen in Sekunden.
RetryBackoffSeconds?: number: Wartezeit zwischen Wiederholungen in Sekunden.
CreatedAt?: Date: Erstellungszeitpunkt.
UpdatedAt?: Date: Zeitpunkt der letzten Aktualisierung.
GatewayDisplayName?: string: Anzeigename des Gateways.

RksvMandatoryReceiptStatus

CashRegisterId?: string: ID der Registrierkasse.
FiscalEntityId?: string: ID des Steuersubjekts.
Name?: string: Name der Registrierkasse.
FiscalEntityName?: string: Name des Steuersubjekts.
CurrentJournalSequence?: number: Aktuelle Journal-Sequenz.
LastReceiptAt?: Date: Zeitpunkt des letzten Belegs.
LastMonthlyReceiptAt?: Date: Zeitpunkt des letzten Monatsbelegs.
LastYearlyReceiptAt?: Date: Zeitpunkt des letzten Jahresbelegs.
FinalReceiptAt?: Date: Zeitpunkt des Schlussbelegs.
IsStarted?: boolean: Gibt an, ob die Kasse gestartet wurde.
IsClosed?: boolean: Gibt an, ob die Kasse geschlossen wurde.
MonthlyReceiptDue?: boolean: Gibt an, ob ein Monatsbeleg fällig ist.
YearlyReceiptDue?: boolean: Gibt an, ob ein Jahresbeleg fällig ist.
DueMonthlyYear?: number: Jahr des fälligen Monatsbelegs.
DueMonthlyMonth?: number: Monat des fälligen Monatsbelegs.
DueYearlyYear?: number: Jahr des fälligen Jahresbelegs.

CashRegister

CashRegisterId?: string: ID der Registrierkasse.
Name?: string: Name der Registrierkasse.

CashTransactionTypeEnum

Unknown = 0
Income = 1
Expense = 2
Deposit = 3
Withdrawal = 4
Correction = 5
CashShortage = 6
CashOverage = 7

CashTransactionSortField

CashTransactionId = 1
RecordedAt = 2
BusinessDate = 3
Amount = 4
TransactionType = 5

CashReconciliationTypeEnum

Unknown = 0
DailyClosing = 1
CashCount = 2
Audit = 3

CashReconciliationReasonTypeEnum

Unknown = 0
PendingInvestigation = 1
ChangeGivenIncorrectly = 3
MissingCashTransaction = 4
UnrecordedWithdrawalOrDeposit = 5
SuspectedTheft = 6
Other = 99

CashReconciliationDifferenceTypeEnum

Balanced = 0
Shortage = 1
Overage = 2