Daten-Spezifikation

 

MODELS
      • User (Benutzer)
      • Company (Gastronomie)
      • Address (Adresse)
      • Country (Land)
      • Recipe (Rezept)
      • Menusection (Karte)
      • Event (Eintrag)
      • File (Datei)
      • Gallery (Galerie)
      • Reservation (Reservierung)
      • Sale (Verkauf)
      • SaleItem (Verkaufsposition)
      • Customer (Kunde)
API CALL EXAMPLES
    • LOGIN
    • READ RECIPES
    • READ MENUSECTIONS
    • UPDATE RECIPE (single)
    • UPDATE RECIPE (multi)

 

MODELS

 

User (Benutzer)

Der Benutzername

FIELDS

Name Title Description Editable
id Id   Nein
guid     Ja
address_id Adresse   Ja
comment Kommentar   Ja
pin PIN Vierstellige Benutzer-PIN zum Schnellwechsel Ja
username Benutzername Ihr Benutzername Ja
group_id     Ja
password Kennwort Ihr Kennwort Ja
email E-Mail Ihre E-Mail Adresse Ja
firstname Vorname Ihr Vorname Ja
lastname Nachname Ihr Nachname Ja
auth Schlüssel Bestätigungsschlüssel für die Benutzerregistrierung Ja
active Aktiv Ist das Feld nicht gesetzt, ist der Benutzer deaktiviert bzw. gesperrt Ja
verified Verifiziert Ist die E-Mail-Adresse des Benutzers bereits bestätigt? Ja
file_id Foto Ihr persönliches Foto für die Darstellung des Benutzerprofils Ja
created_by Erstellt von Der Name des Eintrag-Erstellers Nein
updated_by Aktualisiert von Person, die den Eintrag zuletzt bearbeitet hat Nein
version Version   Nein
created_at Erstellt am Der Benutzer wurde zu diesem Zeitpunkt erstellt. Nein
updated_at Aktualisiert am Der Benutzer wurde zu diesem Zeitpunkt aktualisiert. Nein
slug Slug Eindeutiger Bezeichner (Slug) Nein
deleted_at Entfernt am   Nein

RELATIONS

Name Title Description Local Foreign Type
Role Rolle Mit Hilfe von Rollen können pro Benutzer individuelle Rechte definiert werden (z.B. Der Benutzer 'Mustermann' darf nur den Menüpunkt 'Reservierungsverwaltung' aufrufen). user_id role_id n-1
UserRole Benutzerzuordnung Hier können Benutzer aus dem 'gastronovi Office-System' einer Rolle in Ihrem Unternehmen zugeordnet werden (z.B. Max Mustermann mit dem Benutzernamen 'mustermann' wird mit der Rolle 'Oberkellner' verknüpft) id user_id n-1
Address Adresse   address_id id 1-n
UserSetting Benutzereinstellung   id additive_id n-1
Customer Kunde Der Eintrag beinhaltet alle relevanten Informationen zum Kunden id user_id n-1
Group Gruppe Dem Benutzer eine Richtlinie zuordnen group_id id 1-n
File Datei   file_id id 1-n
Editor     updated_by id 1-n
Owner     created_by id 1-n
Version     id id n-1

CONTROLLER

/**
 * IndexController - The default controller class
 *
 * @author
 * @version
 */
URL Description
users/changepassword  
users/current
/**
 * manage user bookings
 *
 * @param array $user
 * @param User $userModel
 */
users/delete
/**
 * default delete action for all Action Controllers
 * @return null
 */
users/edit  
users/index
/**
 * the default index action for all Action Controllers
 * @return null
 */
users/ingroupswitch  
users/ingroupswitchback  
users/ingroupswitchmode  
users/ingroupswitchroles  
users/insert
/**
 * default insert Action for all Action Controllers
 * @return null
 */
users/list  
users/login
/**
 * login Action
 */
users/logout  
users/password  
users/profile
/**
 * users profile function
 *
 */
users/read
/**
 * default read action for all Action Controllers
 * @return null
 */
users/register
/**
 * The default action - show the home page
 */
users/rest
/**
 * REST action for all Action Controllers
 * 
 * GET -> readAction
 * POST -> editAction
 * PUT -> insertAction
 * DELETE -> deleteAction
 * 
 * @return null
 */
users/roles  
users/session  
users/show  
users/sort
/**
 * sort a record
 * @return null
 */
users/start  
users/statistics  
users/switch
/**
 * selects the users profile
 * @return null
 */
users/terminate
/**
 * terminate a record
 */
users/verificate  
users/versions  

Company (Gastronomie)

Die Bezeichnung bzw. die Firmierung des Unternehmens

FIELDS

Name Title Description Editable
id Id   Nein
guid     Ja
title Titel Der Name des Unternehmens (z.B. Restaurant Mustermann) Ja
description Beschreibung Die Beschreibung bzw. Anmerkung Ja
organisation Firmenbezeichnung Name der Firma inkl. Rechtsform (z.B. Musterfirma GmbH) Ja
holder Inhaber bzw. vertreten durch Name des Inhaber bzw. der vertretungsberechtigten Person(en) Ja
representation Vertreten durch Die vertretungsberechtigte Person(en) (z.B. Max Mustermann) Ja
registry Registereintrag Öffentliches Register (z.B. Amtsgericht Bremen, HRB 1234) Ja
ustid Umsatzsteuer-ID. Die Umsatzsteuer-Identifikationsnummer (z.B. DE999999999) Ja
wstid Wirtschafts-IdNr. Die Wirtschafts-Identifikationsnummer (z.B. DE999999999) Ja
taxid Steuernummer Die Steuernummer beim zuständigen Finanzamt Ja
financeauthority Finanzamt Das zuständige Finanzamt (z.B. Bremen) Ja
controllingauthority Aufsichtsbehörde Die zuständige Aufsichtsbehörde (z.B. Ordnungsamt Bremen) Ja
bank Bank Name der Bank Ja
bank_code BLZ Bankleitzahl Ja
bank_account Kontonummer Die Kontonummer Ihrer Bank Ja
bank_iban IBAN Internationale Bankkontonummer Ja
bank_bic BIC Business Identifier Code - international standardisierter Code zur Identifikation von Banken Ja
hosting_username Benutzer Ihr Benutzername des gebuchten Hostingpaketes Ja
hosting_password Passwort Geben Sie hier das dazugehörige E-Mail-Passwort ein Ja
closing_time Tagesabschluss Um welche Uhrzeit soll der Tagesabschluss erstellt werden? Ja
gastronavi_public gastronavi Soll das Unternehmen als Eintrag auf gastronavi veröffentlicht werden? Ja
address_id Adresse   Ja
currency_id Währung Die Währungsart (z.B. Euro €, US Dollar $) Ja
language_id Hauptsprache Die Hauptsprache des Unternehmens. Alle Texte und öffentlichen Präsentationen werden in dieser Sprache erstellt und angezeigt. Ja
section_id Hauptkategorie Die Hauptkategorie des Unternehmens (z.B. Hotel, Restaurant) Ja
analytics_id     Ja
created_by Erstellt von Der Name des Eintrag-Erstellers Nein
updated_by Aktualisiert von Person, die den Eintrag zuletzt bearbeitet hat Nein
logo_id Logo Das Logo des Unternehmens Ja
created_at Erstellt am Der Zeitpunkt der Erstellung Nein
updated_at Aktualisiert am Der Zeitpunkt der letzten Aktualisierung Nein
root_id     Nein
lft     Nein
rgt     Nein
level     Nein
deleted_at Entfernt am   Nein
version Version   Nein

RELATIONS

Name Title Description Local Foreign Type
Currency Währung   currency_id id 1-n
Address Adresse   address_id id 1-n
Logo     logo_id id 1-n
Language Sprache   language_id id 1-n
CompanyLanguage Weitere Sprache Durch weitere Sprachen können internationale Gäste auf öffentlichen Medien besser angesprochen werden. Alle öffentlichen Einträge im System können anschließend aus der Hauptsprache in die jeweilige Sprache übersetzt werden. id company_id n-1
CompanyBooking Buchung   id company_id n-1
Translation     id id n-1
Section     section_id id 1-n
CompanyProvider Kooperation Der Name des Kooperationspartners id company_id n-1
CompanySection Unterkategorie   id company_id n-1
CompanySpecial Besonderheiten Besonderheiten id company_id n-1
CompanyCuisine Angewandte Küche   id company_id n-1
Settingset Profil Ein Profil beinhaltet die benutzerdefinierten Einstellungen. id company_id n-1
Recipe Rezept Ein Rezept ist ein Produkt, z.B. eine Speise oder ein Getränk id company_id n-1
Api Schlüssel Der Zugriffsschlüssel für die gastronovi Office-Schnittstelle (API) id company_id n-1
Breakage Bruchliste Eine Bruchliste ist eine Zusammenstellung von Brüchen. id company_id n-1
Costunit Kostenstelle Der Ort der Kostenentstehung und der Leistungserbringung id company_id n-1
Customer Kunde Der Eintrag beinhaltet alle relevanten Informationen zum Kunden id company_id n-1
Cluster Kundengruppe Eine Kundengruppe dient zur Zusammenfassung von mehreren Kunden zu einer Gruppe id company_id n-1
Depot Lager Die Lagerbezeichnung (z.B. Keller, Tiefkühlhaus Nr. 1) id company_id n-1
Event Eintrag   id company_id n-1
Expense Ausgabe Die Verwaltung von betrieblichen Ausgaben (z.B. monatliche Pachtkosten) id company_id n-1
Folder Ordner   id company_id n-1
Gallery Galerie Eine Galerie stellt eine Auswahl von Bildern dar. Die Darstellung erfolgt je nach Galerieart auf der Internetpräsenz (z.B. Seite: Bildergalerie) id company_id n-1
Device     id company_id n-1
Ingredient Zutat Die Bezeichnung einer Zutat im eigenen Unternehmen (z.B. Tomaten, Zucker) id company_id n-1
IngredientItem Zuordnung Eine Zuordnung verknüpft eine Zutat mit den jeweiligen Lieferantenartikel. id company_id n-1
Inventory Inventur Inventuren ermöglichen das Zählen des momentanen Bestandes von Zutaten in einem Lager. id company_id n-1
Menusection Karte In Karten werden Rezepte mit gemeinsamen Merkmalen zu einer Gruppe zusammengefasst. id company_id n-1
MenusectionFile     id company_id n-1
Newsletter   Ein Newsletter ist ein elektronisches Rundschreiben, das herausgegeben wird, um z.B. Mitglieder, Kunden oder Mitarbeiter über Neuigkeiten zu informieren. id company_id n-1
NewsletterItem Inhalt Ein Newsletter besteht aus einem oder mehreren 'Inhaltselementen' id company_id n-1
NewsletterProtocoll Sendebericht   id company_id n-1
Opening Öffnungszeit Die Öffnungszeit informiert Ihre Gäste über die Geschäftszeiten Ihres Unternehmens. id company_id n-1
Openingtype Öffnungszeitentyp Die Art der Öffnunszeit (z.B. Standard- oder Sonderöffnungszeiten) id company_id n-1
Order Bestellung Die Bestellung ist eine Aufforderung an einen Hersteller, Händler oder Dienstleister zur Bereitstellung eines Produktes (z.B. Milch 1.5%). Eine Bestellung fasst mehrere Zutaten bzw. Lieferantenartikel zusammen. id company_id n-1
Provider Lieferant Die Bezeichnung des Lieferanten/Anbieters id company_id n-1
Reservation Reservierung Eine Reservierung dient zur Vormerkung eines bestimmten Tisches zur einem konktreten Termin id company_id n-1
Reservationsetting Zusatzangabe Zusätzliche Angaben bzw. Felder der Online-Reservierung beifügen. id company_id n-1
Role Rolle Mit Hilfe von Rollen können pro Benutzer individuelle Rechte definiert werden (z.B. Der Benutzer 'Mustermann' darf nur den Menüpunkt 'Reservierungsverwaltung' aufrufen). id company_id n-1
Sale Verkauf Ein Verkauf ist die Zusammenfassung mehrerer Verkaufsposten. Der Verkauf wird nach Bezahlung zu einer Rechnung. id company_id n-1
Site Seite Eine Seite stellt eine statische Inhaltsseite dar. Zur jeder Seite können anschließend Inhaltselemnte, wie z.B. Text, hinzugefügt werden. id company_id n-1
Social Soziales Netzwerk Soziale Netzwerke sind Webdienste, die Netzgemeinschaften bzw. Online-Kontaktnetzwerke im Internet anbieten (z.B. Facebook.com oder Twitter.com). id company_id n-1
Table Tisch Tische bieten unterschiedliche Sitzkapazitäten, enthalten eine Tischnummer und können Bereichen bzw. Räumen zugeordnet werden. id company_id n-1
Room Bereich Ein Bereich kann z.B. ein gesonderter Raum sein oder eine räumliche Aufteilung in Ihrem Unternehmen. Jedem Bereich können beliebig viele Tische zuordnen werden. id company_id n-1
Template Vorlage Eine Form- bzw. Stilvorlage id company_id n-1
CompanyPayment Zahlungsart Die Zahlungsart gibt an, wie Ihre Gäste bezahlen können. id company_id n-1
Bookings     company_id booking_id n-1
Coupons     id company_id n-1
Orderset Bestellvorlage Bestellvorlagen sind Zusammenstellungen von Zutaten, um eine schnelle Bestellung zu ermöglichen. id company_id n-1
GalleryCategory Kategorie Die Kategorien dienen zur Unterteilung der Gallerien. id company_id n-1
Printer Drucker Unternehmensdrucker id company_id n-1
RecipeGroup Extra/Zwang Mit einem Extra oder einem Zwang können Sie Menüs oder eine mögliche Auswahl für den Gast festlegen. Sie könnten beispielsweise zu einem Wienerschnitzel mehrere Extras wie "Bratkartoffeln" oder "Pommes Frites" anbieten. Die Extras können mit einem Zusatzbetrag versehen werden, die bei der Kalkulation beachtet werden. Auf Wunsch kann die Angabe gleich für den Gast auf der Internetseite und in der Karte sichtbar gemacht werden. id company_id n-1
RecipeFavorite Favorit Favoriten dienen als Schnellauswahl in der Kasse. Sie werden dort bevorzugt zum schnellen Zugriff dargestellt. id company_id n-1
EventCategory Kategorie Die Kategorien dienen zur Unterteilung der Termine und Neuigkeiten. id company_id n-1
Stint Schicht Eine Schicht bestimmt den Arbeitsabschnitt eines Mitarbeiters. id company_id n-1
Notice Anmerkung Anmerkungen dienen zur Ergänzung von Bestellungen. Häufig verwendete Anmerkungen werden gesammelt, damit sie bei der Bestellung schnell ausgewählt werden können. id company_id n-1
Report Bericht Berichte fassen Verkäufe zusammen. id company_id n-1
Channel Präsentationskanal Ein Präsentationskanal ermöglicht die Veröffentlichung von Inhalten auf externen Medien. id company_id n-1
ChannelItem Kanaleintrag Ein Kanaleintrag ist ein Element des jeweiligen Präsentationskanals. id company_id n-1
Editor     updated_by id 1-n
Owner     created_by id 1-n
Version     id id n-1

CONTROLLER

/**
 * CompaniesController
 *
 * @author
 * @version
 */
URL Description
companies/branchmove  
companies/build  
companies/children
/**
 * get children of company
 * @return unknown_type
 */
companies/copydata  
companies/datacopy  
companies/delete
/**
 * default delete action for all Action Controllers
 * @return null
 */
companies/edit
/**
 * default edit action for all Action Controllers
 * @return null
 */
companies/hosting  
companies/index
/**
 * the default index action for all Action Controllers
 * @return null
 */
companies/insert
/**
 * default insert Action for all Action Controllers
 * @return null
 */
companies/latest
/**
 * load the companies, order by latest
 * @return unknown_type
 */
companies/list  
companies/movebranch  
companies/openingtimes  
companies/overview  
companies/read
/**
 * default read action for all Action Controllers
 * @return null
 */
companies/rest
/**
 * REST action for all Action Controllers
 * 
 * GET -> readAction
 * POST -> editAction
 * PUT -> insertAction
 * DELETE -> deleteAction
 * 
 * @return null
 */
companies/self  
companies/sort
/**
 * sort a record
 * @return null
 */
companies/terminate
/**
 * terminate a record
 */
companies/versions  

Address (Adresse)

FIELDS

Name Title Description Editable
id Id   Nein
guid     Ja
country_id Land Das Land (z.B. Deutschland) Ja
title Titel Der Titel bzw. Bezeichner Ja
description Beschreibung Die Beschreibung bzw. Anmerkung Ja
salutation     Ja
gender Anrede Die Anrede (Frau, Herr) Ja
person Ansprechpartner Der Namen des Ansprechpartners (z.B. Max Mustermann) Ja
street Straße und Hausnr. Die Straße und Hausnummer (z.B. Musterstraße 12) Ja
city Ort Der Ort (z.B. Hamburg) Ja
district Stadtteil / Bezirk Die genauere Ortsbeschreibung (z.B. St. Pauli) Ja
zip Postleitzahl Die Postleitzahl (PLZ) (z.B. 12123) Ja
postbox Postfach   Ja
telephone Telefon Die Telefonnummer (z.B. +49 123 456789) Ja
fax Fax Die Faxnummer (z.B. +49 123 456789) Ja
mobile Mobiltelefon Die Mobiltelefonummer (z.B. +49 172 123567) Ja
email E-Mail Die E-Mail-Adresse (z.B. name@firma.de) Ja
newsletter     Ja
url Internetadresse Die Internetadresse (z.B. www.meineseite.de) Ja
additional_url Zusatzdomains Weitere Domains (mehrere mit Komma separiert z.B. gastro.de, navi.de) Ja
created_by Erstellt von Der Name des Eintrag-Erstellers Nein
updated_by Aktualisiert von Person, die den Eintrag zuletzt bearbeitet hat Nein
picture_id Bild Das Representationsbild Ja
created_at Erstellt am Der Zeitpunkt der Erstellung Nein
updated_at Aktualisiert am Der Zeitpunkt der letzten Aktualisierung Nein
deleted_at Entfernt am   Nein
latitude Breitengrad   Ja
longitude Längengrad   Ja
version Version   Nein

RELATIONS

Name Title Description Local Foreign Type
Country Land Das Land (z.B. Deutschland) country_id id 1-n
Provider Lieferant Die Bezeichnung des Lieferanten/Anbieters id address_id n-1
Customer Kunde Der Eintrag beinhaltet alle relevanten Informationen zum Kunden id address_id n-1
Company Gastronomie Die Bezeichnung bzw. die Firmierung des Unternehmens id address_id n-1
User Benutzer Der Benutzername id address_id n-1
Editor     updated_by id 1-n
Owner     created_by id 1-n
Picture     picture_id id 1-n
Version     id id n-1

Country (Land)

Das Land (z.B. Deutschland)

FIELDS

Name Title Description Editable
id Id   Nein
guid     Ja
title Titel Der Titel bzw. Bezeichner Ja
international     Ja
short     Ja
currency_id Währung Die Währungsart (z.B. Euro €, US Dollar $) Ja
created_by Erstellt von Der Name des Eintrag-Erstellers Nein
updated_by Aktualisiert von Person, die den Eintrag zuletzt bearbeitet hat Nein
created_at Erstellt am Der Zeitpunkt der Erstellung Nein
updated_at Aktualisiert am Der Zeitpunkt der letzten Aktualisierung Nein
deleted_at Entfernt am   Nein
version Version   Nein

RELATIONS

Name Title Description Local Foreign Type
Tax Steuer   id country_id n-1
Translation     id id n-1
Currency Währung   currency_id id 1-n
Address Adresse   id country_id n-1
Weather Wetter   id country_id n-1
Editor     updated_by id 1-n
Owner     created_by id 1-n
Version     id id n-1

CONTROLLER

/**
 * CountriesController
 *
 * @author Andreas Jonderko
 * @version 1.0
 */
URL Description
countries/delete
/**
 * default delete action for all Action Controllers
 * @return null
 */
countries/edit
/**
 * default edit action for all Action Controllers
 * @return null
 */
countries/index
/**
 * the default index action for all Action Controllers
 * @return null
 */
countries/insert
/**
 * default insert Action for all Action Controllers
 * @return null
 */
countries/read
/**
 * default read action for all Action Controllers
 * @return null
 */
countries/rest
/**
 * REST action for all Action Controllers
 * 
 * GET -> readAction
 * POST -> editAction
 * PUT -> insertAction
 * DELETE -> deleteAction
 * 
 * @return null
 */
countries/sort
/**
 * sort a record
 * @return null
 */
countries/terminate
/**
 * terminate a record
 */
countries/versions  

Recipe (Rezept)

Ein Rezept ist ein Produkt, z.B. eine Speise oder ein Getränk

FIELDS

Name Title Description Editable
id Id   Ja
uid Uid   Nein
guid     Ja
title Titel Der Rezepttitel bzw. die Rezeptbezeichnung (z.B. Wiener Schnitzel) Ja
company_id Gastronomie   Ja
amount_description Mengenbeschreibung Die genaue Mengen- bzw. Zusatzbeschreibung (z.B. "0,7l Flasche", "0,33l Glas", "mit Eis") Ja
description Beschreibung Die Rezeptbeschreibung laut Karte (z.B. mit Kartoffel-Gurkensalat) Ja
internal_description Interne Anmerkung Anmerkung zum Rezept, die nicht öffentlich dargestellt, sondern nur intern genutzt wird (z.B. in der Kasse für den Kellner). Ja
prepare_description Vorbereitung Die Schritt-für-Schritt Beschreibung des Vorberetungsvorgangs Ja
manual Zubereitung Die Schrit-für-Schritt Beschreibung des Zubereitungsvorgangs Ja
temperature_description Koch-, Back-, Brat- und Garangaben Die Information über den abschließenden Vorgang (z.B. 4min auf der Pfanne in Olivenöl braten) Ja
serving_description Anrichteweise Die Schritt-für-Schritt Beschreibung der Anrichteweise (z.B. auf dem Teller) Ja
time Zubereitungszeit Die gesamte Zubereitungszeit in Minuten (z.B. 1,5) Ja
pretime Vorbereitungszeit Die gesamte Vorbereitungszeit in Minuten (z.B. 1,5) Ja
temptime Koch-, Back-, Brat- und Garzeit Die gesamte Koch-, Back-, Brat- und Garzeit in Minuten (z.B. 1,5) Ja
servetime Anrichtezeit Die gesamte Anrichtezeit in Minuten (z.B. 1,5) Ja
price Preis br. Der Brutto-Verkaufspreis pro Portion bzw. Preis laut Karte (inkl. MwSt.) Ja
cost_price WES Der kalkulierter netto Warenverbrauch (ohne MwSt.) pro Portion Ja
amount Menge Die Gesamtmenge des Rezepts Ja
packagingunit_id Einheit Die Einheit (z.B. Gramm, Stück) Ja
currency_id Währung Die Währungsart (z.B. Euro €, US Dollar $) Ja
tax_id MwSt.Satz Der gesetzl. Mehrwertsteuersatz in Prozentpunkten (z.B. 19%) Ja
tax_ext_id Erm. MwSt.Satz Der ermäßigte gesetzl. Mehrwertsteuersatz in Prozentpunkten (z.B. 7%) Ja
event_id     Ja
cost_time     Ja
worst_sales pr.VM min Die prognostizierte minimale Verkaufsmenge (in Portionen) Ja
best_sales pr.VM max Die prognostizierte maximale Verkaufsmenge (in Portionen) Ja
portions Port. Die Anzahl der Portionen, auf die sich die Kalkulation bezieht Ja
hardware_id Rezeptnr. Die eindeutige Rezeptnummer (z.B. 34567) Ja
calculation_valid Status Der aktuelle Status/Zustand der Kalkulation. Hinweis: Uhrsymbol: Die Rezeptkalkulation wird zur Zeit aktualisert. Grüner Kreis: Die Rezeptkalkulation wurde erfolgreich aktualisiert Ja
verified Vollständig Das Rezept hat alle Zutaten sowie Basisrezepte und ist damit vollständig. Nur vollständige Rezepte können aus dem Lager verbucht werden. Ja
calculated_at Kalkuliert am Der Zeitpunkt der letzen Kalkulation Ja
ingredients     Ja
termination_modified     Ja
basal Grundrezept Ist dies ein Grundrezept, welches nur zur Kalkulation verwendet und nicht direkt verkauft wird? Ja
disbursement     Ja
created_by Erstellt von Der Name des Eintrag-Erstellers Nein
updated_by Aktualisiert von Person, die den Eintrag zuletzt bearbeitet hat Nein
picture_id Internes Rezeptbild Ein Rezeptbild zur internen Darstellung (z.B. vom angerichteten Teller) Ja
photo_id Rezeptbild Bild zur öffentlichen Darstellung des Rezepts Ja
created_at Erstellt am Der Zeitpunkt der Erstellung Nein
updated_at Aktualisiert am Der Zeitpunkt der letzten Aktualisierung Nein
deleted_at Entfernt am   Nein
termination Gültigkeit Gibt den aktuellen Gültigkeitszeitraum an. Falls eine Gültigkeit vorgenommen wurde, wird das Datum und die Uhrzeit ausgewiesen Ja
termination_hook_id     Ja
version Version   Nein
section Warengruppe In Warengruppen werden Rezepte mit gemeinsamen Merkmalen zu einer Gruppe zusammengefasst (z.B. Suppen, Fischgerichte etc.) Nein
mainsection Hauptwarengruppe Die Hauptwarengruppen (Food, Beverage, Non-Food & Unsortiert) Nein
threshold_costofgoods Wareneinsatz-Vorgabe Der Schwellenwert dient als Richtlinie für den Wareneinsatz in Prozenten und kann pro Warengruppe anders gewählt werden. Stellt den höchsten Wareneinsatz dar. Nein
threshold_rawaddition Deckungsbeitrag-Vorgabe Der Schwellenwert dient als Richtlinie für den Deckungsbeitrag als Währung und kann pro Warengruppe anders gewählt werden. Stellt den mindest Deckungsbeitrag dar. Nein
recommended_price_costofgoods     Nein
recommended_price_rawaddition     Nein
netprice_in Preis Der netto Verkaufspreis (ohne MwSt.) pro Portion Nein
costofgoods_in WES-Q Der Wareneinsatz/Warenverbrauch in Prozentpunkten (Im-Haus-Verkauf) pro Portion Nein
rawaddition_in RA-B Der Rohaufschlag-Betrag gibt an, um wie viel Ihr Verkaufspreis pro Portion über Ihrem Einkaufspreis liegt (Im-Haus-Verkauf) Nein
rawaddition_prct_in RA Der Rohaufschlag in Prozentpunkten gibt an, um wie viel Ihr Verkaufspreis pro Portion über Ihrem Einkaufspreis liegt (Im-Haus-Verkauf) Nein
netprice_out Preis (erm.) Der netto Verkaufspreis (erm., ohne MwSt.) pro Portion Nein
costofgoods_out WES-Q (erm.) Der Wareneinsatz/Warenverbrauch in Prozentpunkten (Außer-Haus-Verkauf) pro Portion Nein
rawaddition_out RA-B (erm.) Der Rohaufschlag-Betrag gibt an, um wie viel Ihr Verkaufspreis pro Portion über Ihrem Einkaufspreis liegt (Außer-Haus-Verkauf) Nein
rawaddition_prct_out RA (erm.) Der Rohaufschlag in Prozentpunkten gibt an, um wie viel Ihr Verkaufspreis pro Portion über Ihrem Einkaufspreis liegt (Außer-Haus-Verkauf) Nein
worst_win pr.RG min Der prognostizierter netto Rohgewinn (ohne MwSt.) bei einer minimalen Verkaufsmenge Nein
best_win pr.RG max Der prognostizierter netto Rohgewinn (ohne MwSt.) bei einer maximalen Verkaufsmenge Nein
average_win pr.RG durchs Der prognostizierter durschnittlicher netto Rohgewinn (ohne MwSt.) Nein

RELATIONS

Name Title Description Local Foreign Type
Company Gastronomie Die Bezeichnung bzw. die Firmierung des Unternehmens company_id id 1-n
Currency Währung   currency_id id 1-n
Packagingunit Einheit Die jeweilige Einheit (z.B. g = Gramm, kg = Kilogramm, ml = Milliliter, l = Liter, st = Stück) packagingunit_id id 1-n
Event Eintrag   event_id id 1-n
Tax Steuer   tax_id id 1-n
TaxExt     tax_ext_id id 1-n
Additive Zusatzstoff Die ausweispflichtigen Lebensmittelzusatzstoffe recipe_id additive_id n-1
RecipeAdditive Rezeptzusatzstoff Die ausweispflichtigen Zusatzstoffe uid recipe_id n-1
RecipeIngredient Rezeptzutat Eine Zutat (Rezeptzutat) ist ein Bestandteil von Produkten, z.B. von Speisen oder Getränken uid recipe_id n-1
RecipeGroup Extra/Zwang Mit einem Extra oder einem Zwang können Sie Menüs oder eine mögliche Auswahl für den Gast festlegen. Sie könnten beispielsweise zu einem Wienerschnitzel mehrere Extras wie "Bratkartoffeln" oder "Pommes Frites" anbieten. Die Extras können mit einem Zusatzbetrag versehen werden, die bei der Kalkulation beachtet werden. Auf Wunsch kann die Angabe gleich für den Gast auf der Internetseite und in der Karte sichtbar gemacht werden. uid recipe_id n-1
MenusectionContent Menüinhalt   id recipe_id n-1
RecipeBaserecipe Basisrezept Das Basisrezept, dient zur Wiederverwendung von bereits angelegten Rezepten uid recipe_id n-1
Coupons     uid recipe_id n-1
RecipeParentrecipes     id baserecipe_id n-1
RecipeFavorite Favorit Favoriten dienen als Schnellauswahl in der Kasse. Sie werden dort bevorzugt zum schnellen Zugriff dargestellt. id recipe_id n-1
SaleItem Verkaufsposition Eine Verkaufsposition ist ein zu buchender Eintrag. uid recipe_id n-1
Editor     updated_by id 1-n
Owner     created_by id 1-n
Picture     picture_id id 1-n
Photo     photo_id id 1-n
Translation     uid uid n-1
TerminationHook     termination_hook_id id 1-n
Version     uid uid n-1

CONTROLLER

/**
 * RecipesController
 *
 * @author
 * @version
 */
URL Description
recipes/calculate  
recipes/calculation  
recipes/delete
/**
 * default delete action for all Action Controllers
 * @return null
 */
recipes/edit
/**
 * default edit action for all Action Controllers
 * @return null
 */
recipes/export  
recipes/flop  
recipes/index
/**
 * the default index action for all Action Controllers
 * @return null
 */
recipes/insert
/**
 * default insert Action for all Action Controllers
 * @return null
 */
recipes/list  
recipes/read
/**
 * default read action for all Action Controllers
 * @return null
 */
recipes/rest
/**
 * REST action for all Action Controllers
 * 
 * GET -> readAction
 * POST -> editAction
 * PUT -> insertAction
 * DELETE -> deleteAction
 * 
 * @return null
 */
recipes/sort
/**
 * sort a record
 * @return null
 */
recipes/statistics  
recipes/terminate
/**
 * terminate a record
 */
recipes/top  
recipes/versions  

Menusection (Karte)

In Karten werden Rezepte mit gemeinsamen Merkmalen zu einer Gruppe zusammengefasst.

FIELDS

Name Title Description Editable
id Id   Nein
guid     Ja
hardware_id Konto Nummer des Warengruppen-Kontos für den Export an Buchhaltungsprogramme Ja
hardware_ext_id Konto erm. Alternative Nummer des Warengruppen-Kontos für den Export an Buchhaltungsprogramme (wenn explizit nicht gesetzt, wird das normale Konto übernommen) Ja
public Aktiv Soll dieser Eintrag aktiviert werden? Ja
main     Ja
threshold_costofgoods Wareneinsatz-Vorgabe Der Schwellenwert dient als Richtlinie für den Wareneinsatz in Prozenten und kann pro Warengruppe anders gewählt werden. Stellt den höchsten Wareneinsatz dar. Ja
threshold_rawaddition Deckungsbeitrag-Vorgabe Der Schwellenwert dient als Richtlinie für den Deckungsbeitrag als Währung und kann pro Warengruppe anders gewählt werden. Stellt den mindest Deckungsbeitrag dar. Ja
tax_id MwSt.Satz Der gesetzl. Mehrwertsteuersatz in Prozentpunkten (z.B. 19%) Ja
tax_ext_id Erm. MwSt.Satz Der ermäßigte gesetzl. Mehrwertsteuersatz in Prozentpunkten (z.B. 7%) Ja
type Typ   Ja
title Titel Der Titel bzw. Bezeichner Ja
main_title     Ja
company_id Gastronomie   Ja
settingset_id Druckvorlage Die Kartendruckvorlage Ja
costunit_id Kostenstelle Ist diese Karte exklusiv der ausgewählten Kostenstelle zugeordnet? Ja
description Beschreibung Die Beschreibung der Karte Ja
description_long Fußzeile Diese Informationen werden in der Fußzeile der Karte angezeigt Ja
valid_from Gültig von Begin der Gültigkeit Ja
valid_until Gültig bis Ende der Gültigkeit Ja
option_noprices Keine Preise Preise nicht anzeigen Ja
option_noadditives Keine Zusatzstoffe Zusatzstoffe nicht anzeigen Ja
option_noallergenes Keine Allergene Allergene nicht anzeigen Ja
option_extendedadditives Zusatzstoffe neben Zutaten Zusatzstoffe/Allergene neben den Zutaten auszeichnen. Hinweis: Das Rezept muss Zutaten enthalten. Ja
option_nogrouping Keine Gruppierung Gleiche Rezepte (z.B. Wasser 0,2l & Wasser 0,5l) nicht zu einem Rezept/Eintrag zusammenfassen Ja
option_nodate Keine Gültigkeit Gültigkeit der Karte nicht anzeigen Ja
option_internal_noprices     Ja
option_internal_noadditives     Ja
option_internal_noallergenes     Ja
option_internal_extendedadditives     Ja
option_internal_nogrouping     Ja
option_internal_nodate     Ja
inheritable Vererbbar Soll dieser Eintrag an die Filialen vererbt werden? Ja
inheritchilds Vererbt an An welche Filialen soll dieser Eintrag vererbt werden (falls der Eintrag generell vererbbar ist)? Ja
social     Ja
created_by Erstellt von Der Name des Eintrag-Erstellers Nein
updated_by Aktualisiert von Person, die den Eintrag zuletzt bearbeitet hat Nein
file_id Datei Eine alternative Datei (z.B. PDF, DOC) auf der Internetpräsenz bereitstellen Ja
created_at Erstellt am Der Zeitpunkt der Erstellung Nein
updated_at Aktualisiert am Der Zeitpunkt der letzten Aktualisierung Nein
root_id     Nein
lft     Nein
rgt     Nein
level     Nein
tree_root     Ja
tree_parent     Ja
tree_sorting     Ja
tree_level     Ja
tree_path     Ja
deleted_at Entfernt am   Nein
version Version   Nein
mainsection     Nein

RELATIONS

Name Title Description Local Foreign Type
Settingset Profil Ein Profil beinhaltet die benutzerdefinierten Einstellungen. settingset_id id 1-n
Company Gastronomie Die Bezeichnung bzw. die Firmierung des Unternehmens company_id id 1-n
Costunit Kostenstelle Der Ort der Kostenentstehung und der Leistungserbringung costunit_id id 1-n
Tax Steuer   tax_id id 1-n
TaxExt     tax_ext_id id 1-n
MenusectionContent Menüinhalt   id menusection_id n-1
MenusectionFile     id menusection_id n-1
MenusectionOpening Gültigkeit Eine Gültigkeit bestimmt, wann eine Karte gültig ist. Wird eine Gültigkeit zu einer Karte hinzugefügt, ist die Karte nur noch zu den angegebenen Tagen bzw. Zeiten gültig. id menusection_id n-1
RecipeFavorite Favorit Favoriten dienen als Schnellauswahl in der Kasse. Sie werden dort bevorzugt zum schnellen Zugriff dargestellt. id menusection_id n-1
SaleItem Verkaufsposition Eine Verkaufsposition ist ein zu buchender Eintrag. id menusection_id n-1
Notice Anmerkung Anmerkungen dienen zur Ergänzung von Bestellungen. Häufig verwendete Anmerkungen werden gesammelt, damit sie bei der Bestellung schnell ausgewählt werden können. id menusection_id n-1
CostunitPrinter Bondrucker Ein Bondrucker gibt an, auf welchem Drucker eine bestimmte Warengruppe gedruckt werden soll. Dabei werden alle entsprechenden Unterwarengruppen mit eingeschlossen, außer eine Unterwarengruppe hat explizit einen eigenen Bondrucker zugewiesen. id menusection_id n-1
Editor     updated_by id 1-n
Owner     created_by id 1-n
File Datei   file_id id 1-n
Translation     id id n-1
Version     id id n-1

CONTROLLER

/**
 * MenusController
 *
 * @author
 * @version
 */
URL Description
menus/applydraft  
menus/delete
/**
 * default delete action for all Action Controllers
 * @return null
 */
menus/edit
/**
 * default edit action for all Action Controllers
 * @return null
 */
menus/export  
menus/hook  
menus/index  
menus/insert
/**
 * default insert Action for all Action Controllers
 * @return null
 */
menus/list  
menus/read
/**
 * default read action for all Action Controllers
 * @return null
 */
menus/rest
/**
 * REST action for all Action Controllers
 * 
 * GET -> readAction
 * POST -> editAction
 * PUT -> insertAction
 * DELETE -> deleteAction
 * 
 * @return null
 */
menus/sort
/**
 * sort a record
 * @return null
 */
menus/terminate
/**
 * terminate a record
 */
menus/tree  
menus/versions  

Event (Eintrag)

FIELDS

Name Title Description Editable
id Id   Nein
guid     Ja
title Titel Der Titel bzw. Bezeichner Ja
text Text Der Textinhalt (z.B. eine Beschreibung) Ja
company_id Gastronomie   Ja
provider_id Lieferant Der Namen des Lieferanten (z.B. Musterlieferant GmbH) Ja
eventtype_id     Ja
event_category_id Kategorie Die zugeordnete Kategorie Ja
public Aktiv Soll dieser Eintrag aktiviert werden? Ja
fulldate Ganztägig Der Termin ist ganztägig? Ja
inheritable Vererbbar Soll dieser Eintrag an die Filialen vererbt werden? Ja
inheritchilds Vererbt an An welche Filialen soll dieser Eintrag vererbt werden (falls der Eintrag generell vererbbar ist)? Ja
time_start Von Die Beginnzeit des Termins Ja
time_end Bis Die Endzeit des Termins Ja
highlight Hervorgehoben Soll dieser Eintrag auf öffentlichen Präsentationen besonders hervorgehoben werden? Ja
social     Ja
created_by Erstellt von Der Name des Eintrag-Erstellers Nein
updated_by Aktualisiert von Person, die den Eintrag zuletzt bearbeitet hat Nein
file_id Bild Das Bild zum Eintrag (z.B. Veranstaltungsbild) Ja
created_at Erstellt am Der Zeitpunkt der Erstellung Nein
updated_at Aktualisiert am Der Zeitpunkt der letzten Aktualisierung Nein
deleted_at Entfernt am   Nein
version Version   Nein

RELATIONS

Name Title Description Local Foreign Type
Company Gastronomie Die Bezeichnung bzw. die Firmierung des Unternehmens company_id id 1-n
Provider Lieferant Die Bezeichnung des Lieferanten/Anbieters provider_id id 1-n
Eventtype Art von Aktuelles Die Art (z.B. Ankündigung, Veranstaltung, News) eventtype_id id 1-n
EventCategory Kategorie Die Kategorien dienen zur Unterteilung der Termine und Neuigkeiten. event_category_id id 1-n
Link   Eine Verlinkung auf bestimmte Seite, Datei oder E-Mail id event_id n-1
Recipe Rezept Ein Rezept ist ein Produkt, z.B. eine Speise oder ein Getränk id event_id n-1
Editor     updated_by id 1-n
Owner     created_by id 1-n
File Datei   file_id id 1-n
Translation     id id n-1
Version     id id n-1

CONTROLLER

/**
 * EventsController
 *
 * @author
 * @version
 */
URL Description
events/atom  
events/csv  
events/delete
/**
 * default delete action for all Action Controllers
 * @return null
 */
events/edit
/**
 * default edit action for all Action Controllers
 * @return null
 */
events/feed  
events/ical  
events/index
/**
 * the default index action for all Action Controllers
 * @return null
 */
events/insert
/**
 * default insert Action for all Action Controllers
 * @return null
 */
events/list  
events/read
/**
 * default read action for all Action Controllers
 * @return null
 */
events/rest
/**
 * REST action for all Action Controllers
 * 
 * GET -> readAction
 * POST -> editAction
 * PUT -> insertAction
 * DELETE -> deleteAction
 * 
 * @return null
 */
events/rss  
events/sort
/**
 * sort a record
 * @return null
 */
events/terminate
/**
 * terminate a record
 */
events/versions  

File (Datei)

FIELDS

Name Title Description Editable
id Id   Nein
guid     Ja
role_id Rolle   Ja
folder_id Ordner Die Bezeichnung des Ordners, in dem die Datei abgelegt ist Ja
class_id     Ja
size Dateigröße Die Größe der Datei (z.B. 50KB) Ja
ctime     Ja
status Status Der aktuelle Status Ja
title Dateiname Der Bezeichnung der Datei (z.B. logo.jpg) Ja
description Beschreibung Die Beschreibung bzw. Anmerkung Ja
keywords Schlüsselwörter Die Hauptschlagwörter (z.B. Logo oder Preisliste) Ja
name     Ja
original     Ja
type Typ   Ja
public Aktiv Soll dieser Eintrag aktiviert werden? Ja
created_by Erstellt von Der Name des Eintrag-Erstellers Nein
updated_by Aktualisiert von Person, die den Eintrag zuletzt bearbeitet hat Nein
slug Slug Eindeutiger Bezeichner (Slug) Nein
created_at Erstellt am Der Zeitpunkt der Erstellung Nein
updated_at Aktualisiert am Der Zeitpunkt der letzten Aktualisierung Nein
deleted_at Entfernt am   Nein
version Version   Nein

RELATIONS

Name Title Description Local Foreign Type
Translation     id id n-1
Role Rolle Mit Hilfe von Rollen können pro Benutzer individuelle Rechte definiert werden (z.B. Der Benutzer 'Mustermann' darf nur den Menüpunkt 'Reservierungsverwaltung' aufrufen). role_id id 1-n
Editor     updated_by id 1-n
Owner     created_by id 1-n
Folder Ordner   folder_id id 1-n
Version     id id n-1

CONTROLLER

/**
 * FilesController
 *
 * @author Andreas Jonderko
 * @version 1.0
 */
URL Description
files/delete
/**
 * default delete action for all Action Controllers
 * @return null
 */
files/download  
files/edit
/**
 * default edit action for all Action Controllers
 * @return null
 */
files/index
/**
 * the default index action for all Action Controllers
 * @return null
 */
files/insert
/**
 * default insert Action for all Action Controllers
 * @return null
 */
files/read
/**
 * default read action for all Action Controllers
 * @return null
 */
files/refresh  
files/rest
/**
 * REST action for all Action Controllers
 * 
 * GET -> readAction
 * POST -> editAction
 * PUT -> insertAction
 * DELETE -> deleteAction
 * 
 * @return null
 */
files/show  
files/sort
/**
 * sort a record
 * @return null
 */
files/terminate
/**
 * terminate a record
 */
files/upload  
files/versions  

Gallery (Galerie)

Eine Galerie stellt eine Auswahl von Bildern dar. Die Darstellung erfolgt je nach Galerieart auf der Internetpräsenz (z.B. Seite: Bildergalerie)

FIELDS

Name Title Description Editable
id Id   Nein
guid     Ja
company_id Gallerieart Die Art der Foto-Gallerie (z.B. Veranstaltung) Ja
public Aktiv Soll dieser Eintrag aktiviert werden? Ja
title Titel Der Titel bzw. Bezeichner Ja
description Beschreibung Die Beschreibung bzw. Anmerkung Ja
date Datum Wann hat das Ereignis stattgefunden? Ja
gallerytype_id Galerieart Die Art der Galerie bzw. Darstellung (z.B. Veranstaltung) Ja
gallery_category_id Kategorie Die zugeordnete Kategorie Ja
inheritable Vererbbar Soll dieser Eintrag an die Filialen vererbt werden? Ja
inheritchilds Vererbt an An welche Filialen soll dieser Eintrag vererbt werden (falls der Eintrag generell vererbbar ist)? Ja
social     Ja
created_by Erstellt von Der Name des Eintrag-Erstellers Nein
updated_by Aktualisiert von Person, die den Eintrag zuletzt bearbeitet hat Nein
watermark_id Wasserzeichen Alle Bilder der Galerie werden mit diesem Wasserzeichen gekennzeichnet. Ja
created_at Erstellt am Der Zeitpunkt der Erstellung Nein
updated_at Aktualisiert am Der Zeitpunkt der letzten Aktualisierung Nein
deleted_at Entfernt am   Nein
version Version   Nein
item_count Datei(en) Die Anzahl der Dateien (z.B: 26) Nein

RELATIONS

Name Title Description Local Foreign Type
Company Gastronomie Die Bezeichnung bzw. die Firmierung des Unternehmens company_id id 1-n
Gallerytype Galerieart Die Art der Galerie bzw. Darstellung gallerytype_id id 1-n
GalleryCategory Kategorie Die Kategorien dienen zur Unterteilung der Gallerien. gallery_category_id id 1-n
GalleryItem Bild Bilder einer Galerie id gallery_id n-1
Editor     updated_by id 1-n
Owner     created_by id 1-n
Watermark     watermark_id id 1-n
Translation     id id n-1
Version     id id n-1

CONTROLLER

/**
 * GalleriesController
 *
 * @author
 * @version
 */
URL Description
galleries/delete
/**
 * default delete action for all Action Controllers
 * @return null
 */
galleries/edit
/**
 * default edit action for all Action Controllers
 * @return null
 */
galleries/index
/**
 * the default index action for all Action Controllers
 * @return null
 */
galleries/insert
/**
 * default insert Action for all Action Controllers
 * @return null
 */
galleries/list  
galleries/read
/**
 * default read action for all Action Controllers
 * @return null
 */
galleries/rest
/**
 * REST action for all Action Controllers
 * 
 * GET -> readAction
 * POST -> editAction
 * PUT -> insertAction
 * DELETE -> deleteAction
 * 
 * @return null
 */
galleries/sort
/**
 * sort a record
 * @return null
 */
galleries/terminate
/**
 * terminate a record
 */
galleries/versions  

Reservation (Reservierung)

Eine Reservierung dient zur Vormerkung eines bestimmten Tisches zur einem konktreten Termin

FIELDS

Name Title Description Editable
id Id   Nein
guid     Ja
description Notiz Eine Anmerkung zu der Reservierung (z.B. Sonderwünsche vom Gast) Ja
arranger Bearbeiter Kürzel des bearbeitenden Mitarbeiters Ja
source     Ja
company_id Gastronomie   Ja
customer_id Kundennr. Die Kundennummer Ja
status_id Status Der Status der Reservierung Ja
room_id Bereich Der zugeordnete Wunschbereich Ja
item_group_id     Ja
time Zeit Die gewünschte Reservierungszeit (Datum: TT.MM.JJJJ, Uhrzeit: HH:MM) Ja
persons Personen Die Anzahl der Gäste (z.B. 2) Ja
settings     Ja
code Code Der Referenzcode für die Reservierung Ja
visittime Abw. Verweilzeit Abweichende Verweilzeit des Gastes in Minuten (bei Nichtsetzen wird die durchschnittliche Verweilzeit angenommen) Ja
external Online-Reservierung Ist diese Reservierung durch den Gast selbst online getätigt worden? Ja
tablestoset Autom. Zuordn. Soll noch eine automatische Tischvergabe erfolgen? Ja
walkout     Ja
created_by Erstellt von Der Name des Eintrag-Erstellers Nein
updated_by Aktualisiert von Person, die den Eintrag zuletzt bearbeitet hat Nein
file_id Datei Die Bezeichnung der Datei (z.B. Preisliste.csv) Ja
created_at Erstellt am Der Zeitpunkt der Erstellung Nein
updated_at Aktualisiert am Der Zeitpunkt der letzten Aktualisierung Nein
deleted_at Entfernt am   Nein
version Version   Nein

RELATIONS

Name Title Description Local Foreign Type
Company Gastronomie Die Bezeichnung bzw. die Firmierung des Unternehmens company_id id 1-n
Customer Kunde Der Eintrag beinhaltet alle relevanten Informationen zum Kunden customer_id id 1-n
Room Bereich Ein Bereich kann z.B. ein gesonderter Raum sein oder eine räumliche Aufteilung in Ihrem Unternehmen. Jedem Bereich können beliebig viele Tische zuordnen werden. room_id id 1-n
ItemGroup     item_group_id id 1-n
Reservationstatus     status_id id 1-n
ReservationTable Tischzuordnung Eine Tischzuordnung verknüpft eine Reservierungen mit einem bestimmten Tisch/Sitzplatz. id reservation_id n-1
Reservation Reservierung Eine Reservierung dient zur Vormerkung eines bestimmten Tisches zur einem konktreten Termin id item_group_id n-1
Sale Verkauf Ein Verkauf ist die Zusammenfassung mehrerer Verkaufsposten. Der Verkauf wird nach Bezahlung zu einer Rechnung. id reservation_id n-1
Editor     updated_by id 1-n
Owner     created_by id 1-n
File Datei   file_id id 1-n
Version     id id n-1

CONTROLLER

/**
 * ReservationsController
 *
 * @author
 * @version
 */
URL Description
reservations/available
/**
 * called for url ..../reservations/available
 *
 */
reservations/delete
/**
 * default delete action for all Action Controllers
 * @return null
 */
reservations/edit
/**
 * default edit action for all Action Controllers
 * @return null
 */
reservations/index
/**
 * the default index action for all Action Controllers
 * @return null
 */
reservations/insert
/**
 * default insert Action for all Action Controllers
 * @return null
 */
reservations/list
/**
 * call the action e.g. reservations/list url
 *
 */
reservations/read
/**
 * default read action for all Action Controllers
 * @return null
 */
reservations/rest
/**
 * REST action for all Action Controllers
 * 
 * GET -> readAction
 * POST -> editAction
 * PUT -> insertAction
 * DELETE -> deleteAction
 * 
 * @return null
 */
reservations/sort
/**
 * sort a record
 * @return null
 */
reservations/terminate
/**
 * terminate a record
 */
reservations/versions  

Sale (Verkauf)

Ein Verkauf ist die Zusammenfassung mehrerer Verkaufsposten. Der Verkauf wird nach Bezahlung zu einer Rechnung.

FIELDS

Name Title Description Editable
id Id   Nein
guid     Ja
hardware_id Rechn.-Nr. Rechnungsnummer Ja
title Titel Der Titel bzw. Bezeichner Ja
description Beschreibung Die Beschreibung bzw. Anmerkung Ja
company_id Gastronomie   Ja
customer_id Kunde Zugeordneter Kunde Ja
type_id Art Art des Verkaufs (z.B. In-Haus, Außer-Haus, online) Ja
table_id Tisch Zugeordneter Tisch Ja
currency_id Währung Die Währungsart (z.B. Euro €, US Dollar $) Ja
closed_at Abgeschlossen am Zu welchem Zeitpunkt wurde die Rechnung erstellt? Ja
printed_at     Ja
persons Personen Die Anzahl der Gäste (z.B. 2) Ja
time Verkaufszeitpunkt Die Zeit Ja
payment_id Bezahlart Wie wurde die Verkaufsposition bezahlt? Ja
costunit_id Kostenstelle Zugeordnete Kostenstelle Ja
reservation_id Reservierung Die zugeordnete Reservierung Ja
given_value     Ja
payment_config     Ja
paid Bezahlt Wurde die Rechnung bereits bezahlt? Ja
external Außer-Haus Ist dies ein Außer-Haus-Verkauf mit ermäßigtem Steuersatz? Ja
stint_id Schicht Die zugeordnete Schicht Ja
party Partei Die Partei am jeweiligen Tisch Ja
calledcourse     Ja
testing Test-Modus Der Test-Modus ermöglicht das Testen der Kasse. Ist der Test-Modus aktiviert, wird der Verkauf in keinen Statistiken aufgeführt. Ja
recovered_at Wiederhergestellt am Zu welchem Zeitpunkt wurde die Rechnung wiederhergestellt? Ja
report_id Bericht Der zugeordnete Bericht Ja
created_by Erstellt von Der Name des Eintrag-Erstellers Nein
updated_by Aktualisiert von Person, die den Eintrag zuletzt bearbeitet hat Nein
created_at Erstellt am Der Zeitpunkt der Erstellung Nein
updated_at Aktualisiert am Der Zeitpunkt der letzten Aktualisierung Nein
deleted_at Entfernt am   Nein
version Version   Nein
item_count # Posten Anzahl der gesamten Posten Nein
item_count_booked     Nein
item_count_all # alle Anzahl der gesamten Posten (inkl. stornierter) Nein
total_price Betrag Der Gesamtbetrag brutto (inkl. MwSt.) Nein

RELATIONS

Name Title Description Local Foreign Type
Currency Währung   currency_id id 1-n
Customer Kunde Der Eintrag beinhaltet alle relevanten Informationen zum Kunden customer_id id 1-n
Company Gastronomie Die Bezeichnung bzw. die Firmierung des Unternehmens company_id id 1-n
Saletype Verkaufsart   type_id id 1-n
Table Tisch Tische bieten unterschiedliche Sitzkapazitäten, enthalten eine Tischnummer und können Bereichen bzw. Räumen zugeordnet werden. table_id id 1-n
Payment Bezahlart   payment_id id 1-n
Stint Schicht Eine Schicht bestimmt den Arbeitsabschnitt eines Mitarbeiters. stint_id id 1-n
Costunit Kostenstelle Der Ort der Kostenentstehung und der Leistungserbringung costunit_id id 1-n
Reservation Reservierung Eine Reservierung dient zur Vormerkung eines bestimmten Tisches zur einem konktreten Termin reservation_id id 1-n
SaleItem Verkaufsposition Eine Verkaufsposition ist ein zu buchender Eintrag. id sale_id n-1
SaleTable Zusatztisch Zusatztische dienen als Information, an welchen Tischen außer dem jeweils ausgewählten Haupttisch der Vorgang noch gebucht wird. Zusatztische werden ebenfalls durch Walk-ins blockiert. id sale_id n-1
Report Bericht Berichte fassen Verkäufe zusammen. report_id id 1-n
SalePayment Teilzahlung Teilzahlungen ermöglichen, eine Rechnung durch mehrere Bezahlarten begleichen zu können. id sale_id n-1
Journal Journaleintrag Ein Journal enthält alle Buchungsvorgänge. id sale_id n-1
Editor     updated_by id 1-n
Owner     created_by id 1-n
Version     id id n-1

CONTROLLER

/**
 * SalesController
 *
 * @author
 * @version
 */
URL Description
sales/config  
sales/delete
/**
 * default delete action for all Action Controllers
 * @return null
 */
sales/edit
/**
 * default edit action for all Action Controllers
 * @return null
 */
sales/export  
sales/index
/**
 * the default index action for all Action Controllers
 * @return null
 */
sales/insert
/**
 * default insert Action for all Action Controllers
 * @return null
 */
sales/list  
sales/pos  
sales/read
/**
 * default read action for all Action Controllers
 * @return null
 */
sales/rest
/**
 * REST action for all Action Controllers
 * 
 * GET -> readAction
 * POST -> editAction
 * PUT -> insertAction
 * DELETE -> deleteAction
 * 
 * @return null
 */
sales/sort
/**
 * sort a record
 * @return null
 */
sales/terminate
/**
 * terminate a record
 */
sales/versions  

SaleItem (Verkaufsposition)

Eine Verkaufsposition ist ein zu buchender Eintrag.

FIELDS

Name Title Description Editable
id Id   Nein
guid     Ja
item_group_id Gruppe Zu welcher Gruppe gehört der Eintrag? Ja
sale_id     Ja
recipe_id Rezept Der Rezepttitel bzw. die Rezeptbezeichnung (z.B. Wiener Schnitzel) Ja
menusection_id Warengruppe   Ja
mainsection     Ja
status_id Status Aktueller Status der Verkaufsposition Ja
amount Anzahl Die Anzahl (z.B. 5) Ja
course     Ja
disbursement     Ja
title Titel Der Titel bzw. Bezeichner Ja
description Beschreibung Die Beschreibung bzw. Anmerkung Ja
notice Notiz Zusätzliche Notiz (z.B. "extra scharf") Ja
price_value Einzelpreis Der Einzelpreis brutto (inkl. MwSt.) Ja
original_price_value     Ja
discount_description     Ja
tax_value MwSt.Satz Der gesetzl. Mehrwertsteuersatz in Prozentpunkten (z.B. 19%) Ja
time Bestelleingang Der Zeitpunkt des Bestelleingangs Ja
deduct Wurde produziert Kann diese Verkaufsposition aus dem Lager entnommen werden? Ja
booked Verbucht Wurde die Verkaufsposition bereits aus dem Lager verbucht? Ja
printed_at     Ja
breakagetype_id     Ja
created_by Erstellt von Der Name des Eintrag-Erstellers Nein
updated_by Aktualisiert von Person, die den Eintrag zuletzt bearbeitet hat Nein
created_at Erstellt am Der Zeitpunkt der Erstellung Nein
updated_at Aktualisiert am Der Zeitpunkt der letzten Aktualisierung Nein
deleted_at Entfernt am   Nein
version Version   Nein
total_price Betrag Der Gesamtbetrag brutto (inkl. MwSt.) Nein

RELATIONS

Name Title Description Local Foreign Type
Recipe Rezept Ein Rezept ist ein Produkt, z.B. eine Speise oder ein Getränk recipe_id uid 1-n
Menusection Karte In Karten werden Rezepte mit gemeinsamen Merkmalen zu einer Gruppe zusammengefasst. menusection_id id 1-n
Sale Verkauf Ein Verkauf ist die Zusammenfassung mehrerer Verkaufsposten. Der Verkauf wird nach Bezahlung zu einer Rechnung. sale_id id 1-n
ItemGroup     item_group_id id 1-n
Saleitemstatus Status der Verkaufposition   status_id id 1-n
Breakagetype Art des Bruchs   breakagetype_id id 1-n
Coupons     id sale_item_id n-1
SaleItem Verkaufsposition Eine Verkaufsposition ist ein zu buchender Eintrag. id item_group_id n-1
Journal Journaleintrag Ein Journal enthält alle Buchungsvorgänge. id sale_item_id n-1
Editor     updated_by id 1-n
Owner     created_by id 1-n
Version     id id n-1

CONTROLLER

/**
 * SaleitemsController
 *
 * @author
 * @version
 */
URL Description
saleitems/delete
/**
 * default delete action for all Action Controllers
 * @return null
 */
saleitems/edit
/**
 * default edit action for all Action Controllers
 * @return null
 */
saleitems/index
/**
 * the default index action for all Action Controllers
 * @return null
 */
saleitems/insert
/**
 * default insert Action for all Action Controllers
 * @return null
 */
saleitems/read
/**
 * default read action for all Action Controllers
 * @return null
 */
saleitems/rest
/**
 * REST action for all Action Controllers
 * 
 * GET -> readAction
 * POST -> editAction
 * PUT -> insertAction
 * DELETE -> deleteAction
 * 
 * @return null
 */
saleitems/sort
/**
 * sort a record
 * @return null
 */
saleitems/terminate
/**
 * terminate a record
 */
saleitems/versions  

Customer (Kunde)

Der Eintrag beinhaltet alle relevanten Informationen zum Kunden

FIELDS

Name Title Description Editable
id Kundennr. Die Kundennummer Nein
guid     Ja
number Kundennummer Die eindeutige Nummer für Ihren Kunden Ja
title Titel Der Titel bzw. Bezeichner Ja
firstname Vorname Der Vorname Ja
lastname Nachname Der Familienname Ja
company Firma Firma bzw. Unternehmen des Kunden Ja
birthday Geburtstag Geburtstag des Kunden Ja
description Beschreibung Die Beschreibung bzw. Anmerkung Ja
address_id Adresse   Ja
user_id Benutzer   Ja
company_id Gastronomie   Ja
language_id Sprache Welche Sprache spricht der Kunde? In dieser Sprache werden nach Verfügbarkeit auch alle Informationen zugesandt. Ja
verified Überprüft Sind die Angaben bzw. Daten von einem Mitarbeiter geprüft worden? Bei 'JA': Angaben können vom Kunden nicht mehr geändert werden (z.B. bei einer erneuten Reservierung) Ja
optin Newsletter Ist der Kunde für den Empfang von Newslettern bestätigt? Ja
oiauth     Ja
created_by Erstellt von Der Name des Eintrag-Erstellers Nein
updated_by Aktualisiert von Person, die den Eintrag zuletzt bearbeitet hat Nein
photo_id Foto Ein Foto des Kunden Ja
created_at Erstellt am Der Zeitpunkt der Erstellung Nein
updated_at Aktualisiert am Der Zeitpunkt der letzten Aktualisierung Nein
deleted_at Entfernt am   Nein
version Version   Nein
sale_count # Ums. Wie viele Umsätze hat der Kunde gemacht? Nein
reservation_count # Res. Wie viele Reservierungen hat der Kunde getätigt? Nein

RELATIONS

Name Title Description Local Foreign Type
User Benutzer Der Benutzername user_id id 1-n
Address Adresse   address_id id 1-n
Company Gastronomie Die Bezeichnung bzw. die Firmierung des Unternehmens company_id id 1-n
Language Sprache   language_id id 1-n
CustomerCluster     id customer_id n-1
Reservation Reservierung Eine Reservierung dient zur Vormerkung eines bestimmten Tisches zur einem konktreten Termin id customer_id n-1
Sale Verkauf Ein Verkauf ist die Zusammenfassung mehrerer Verkaufsposten. Der Verkauf wird nach Bezahlung zu einer Rechnung. id customer_id n-1
Editor     updated_by id 1-n
Owner     created_by id 1-n
Photo     photo_id id 1-n
Version     id id n-1

CONTROLLER

/**
 * CustomersController
 *
 * @author
 * @version
 */
URL Description
customers/auth  
customers/delete
/**
 * default delete action for all Action Controllers
 * @return null
 */
customers/edit
/**
 * default edit action for all Action Controllers
 * @return null
 */
customers/index
/**
 * the default index action for all Action Controllers
 * @return null
 */
customers/insert
/**
 * default insert Action for all Action Controllers
 * @return null
 */
customers/list  
customers/read
/**
 * default read action for all Action Controllers
 * @return null
 */
customers/rest
/**
 * REST action for all Action Controllers
 * 
 * GET -> readAction
 * POST -> editAction
 * PUT -> insertAction
 * DELETE -> deleteAction
 * 
 * @return null
 */
customers/sort
/**
 * sort a record
 * @return null
 */
customers/terminate
/**
 * terminate a record
 */
customers/versions  

API CALL EXAMPLES

LOGIN

URL

users/login

POST PARAMS

array(2) {
  ["username"] => string(7) "gnadmin"
  ["password"] => string(32) "e2237bb9e7eb9faa1c60d834a0205609"
}

RESPONSE

...

URL

users/switch

POST PARAMS

array(1) {
  ["selector"] => int(48)
}

RESPONSE

...

READ RECIPES

URL

recipes/index/

POST PARAMS

array(3) {
  ["search"] => string(46) "{"Recipe.title":{"or":["schnitzel","pommes"]}}"
  ["sort"] => string(22) "{"Recipe.title":"ASC"}"
  ["image"] => string(69) "{"Recipe.picture_id":"15x:r","Recipe.picture_id.url_big":"200x400:r"}"
}

RESPONSE

...

READ MENUSECTIONS

URL

menus/tree/

RESPONSE

...

UPDATE RECIPE (single)

URL

recipes/edit/2571

POST PARAMS

array(1) {
  ["price"] => string(2) "12"
}

RESPONSE

...

UPDATE RECIPE (multi)

URL

recipes/index/

POST PARAMS

array(1) {
  ["Recipe"] => string(88) "[{"uid":2571,"price":11,"_action":"update"},{"uid":23397,"price":11,"_action":"update"}]"
}

RESPONSE

...