MODELS
      • User (Benutzer)
      • Provider (Lieferant)
      • Address (Adresse)
      • Country (Land)
      • Article (Lieferantenartikel)
      • Price (Angebot)
      • CompanyProvider (Kooperation)
      • Order (Bestellung)
      • OrderItem (Bestellposten)
API CALL EXAMPLES
    • LOGIN AS PROVIDER
    • READ PACKAGINGUNITS
    • CREATE ARTICLES
    • READ ARTICLES
    • CREATE PRICES
    • READ COMPANY PROVIDERS
    • CREATE COMPANY PRICE
    • READ COMPANY PRICES
    • UPDATE COMPANY PRICE (single)
    • UPDATE COMPANY PRICE (multi)
    • LOGOUT
    • LOGIN AS COMPANY
    • CREATE NEW ORDER
    • CREATE NEW ORDER ITEMS
    • ORDER ORDER (single, set as "ordered")
    • LOGOUT
    • LOGIN AS PROVIDER
    • READ ORDERS (multi, get only ordered ones)
    • READ ORDER (single)
    • PEND ORDER (single, set as "pending")
    • READ ORDER ITEMS (of specific order)
    • UPDATE ORDER ITEM (single, set new price and amount)
    • PROCESS ORDER (single, set as "processed")
    • UPDATE ORDER (single, set expected delivery time)

 

 

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  

Provider (Lieferant)

Die Bezeichnung des Lieferanten/Anbieters

FIELDS

Name Title Description Editable
id Id   Nein
guid     Ja
title Bezeichnung Der Name des Lieferanten (z.B. Musterlieferant GmbH) Ja
description Beschreibung Beschreibung des Lieferanten Ja
public Aktiv Soll dieser Eintrag aktiviert werden? Ja
closing_time Tagesabschluss Um welche Uhrzeit soll der Tagesabschluss erstellt werden? Ja
address_id Adresse   Ja
currency_id Währung Die Währungsart (z.B. Euro €, US Dollar $) Ja
language_id Sprache Welche Sprache spricht der Lieferant? In dieser Sprache werden nach Verfügbarkeit auch alle Informationen zugesandt. Ja
company_id Gastronomie   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   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
pricecount Angebote gesamt Die Gesamtanzahl der Angebote, die vom Lieferanten zur Verfügung gestellt wurden. Nein

RELATIONS

Name Title Description Local Foreign Type
Address Adresse   address_id id 1-n
Logo     logo_id id 1-n
Language Sprache   language_id id 1-n
ProviderBooking     id provider_id n-1
Company Gastronomie Die Bezeichnung bzw. die Firmierung des Unternehmens company_id id 1-n
Currency Währung   currency_id id 1-n
CompanyProvider Kooperation Der Name des Kooperationspartners id provider_id n-1
Api Schlüssel Der Zugriffsschlüssel für die gastronovi Office-Schnittstelle (API) id provider_id n-1
Event Eintrag   id provider_id n-1
Folder Ordner   id provider_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 provider_id n-1
Settingset Profil Ein Profil beinhaltet die benutzerdefinierten Einstellungen. id provider_id n-1
Bookings     provider_id booking_id n-1
Printer Drucker Unternehmensdrucker id provider_id n-1
EventCategory Kategorie Die Kategorien dienen zur Unterteilung der Termine und Neuigkeiten. id provider_id n-1
Article Lieferantenartikel Der Lieferantenartikel definiert einen Artikel aus der Sicht des Lieferanten. id provider_id n-1
Editor     updated_by id 1-n
Owner     created_by id 1-n
Version     id id n-1

CONTROLLER

/**
 * ProvidersController
 *
 * @author
 * @version
 */
URL Description
providers/build  
providers/children
/**
 * get children of provider
 * @return unknown_type
 */
providers/delete
/**
 * default delete action for all Action Controllers
 * @return null
 */
providers/edit
/**
 * default edit action for all Action Controllers
 * @return null
 */
providers/index
/**
 * the default index action for all Action Controllers
 * @return null
 */
providers/insert
/**
 * default insert Action for all Action Controllers
 * @return null
 */
providers/latest  
providers/list  
providers/overview  
providers/read
/**
 * default read action for all Action Controllers
 * @return null
 */
providers/rest
/**
 * REST action for all Action Controllers
 * 
 * GET -> readAction
 * POST -> editAction
 * PUT -> insertAction
 * DELETE -> deleteAction
 * 
 * @return null
 */
providers/self  
providers/sort
/**
 * sort a record
 * @return null
 */
providers/terminate
/**
 * terminate a record
 */
providers/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  

 

 

Article (Lieferantenartikel)

Der Lieferantenartikel definiert einen Artikel aus der Sicht des Lieferanten.

FIELDS

Name Title Description Editable
id Id   Nein
guid     Ja
category_id Kategorie   Ja
gtin GTIN/EAN Die weltweit eindeutige Identifikationsnummer (Strichcode) für Produkte und Packstücke (Global Trade Item Number) Ja
number PLU (Art.-Nr.) Die eindeutige Identifikationsnummer des Artikels (Artikelnummer) Ja
title Titel Die Bezeichnung des Artikels (z.B. Tomaten, Zucker etc.) Ja
description Beschreibung (Artk.) Die Beschreibung des Artikels Ja
provider_id Lieferant Der Namen des Lieferanten (z.B. Musterlieferant GmbH) Ja
packagingamount Menge Die Menge (z.B. 50) pro Einheit (z.B. Kilogramm, Liter oder Stück) Ja
packagingunit_id Einheit Die Einheit (z.B. Gramm, Stück) Ja
wrappingamount Gebindem. Die Gebindemenge bzw. Verpackungsmenge (z.B. 12 Dosen) Ja
wrappingunit_id Gebindeeinheit Die Gebindeeinheit (z.B. in Kiste, im Fass) Ja
public Aktiv Ist der Artikel aktiv? Ja
dirty Status Der aktuelle Status des Artikels Ja
bundled Gebündelt Ist dieser Artikel zusammenhängend und kann nur in Voll- und nicht in Teilmengen bestellt werden? Ja
disbursement     Ja
availability Verfügbarkeit Die (Liefer-) Verfügbarkeit des Artikels 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
version Version   Nein
deleted_at Entfernt am   Nein
total_amount Gesamtmenge Gesamtmenge des Artikels Nein
order_count_total Best. (ges.) Betriebsübergreifende Gesamtanzahl, wie oft dieser Artikel bereits in Bestellungen verwendet wurde. Nein
order_count Best. Anzahl, wie oft dieser Artikel bereits in Bestellungen verwendet wurde. Nein
price_count Angebote Anzahl der Angebote zu diesem Artikel Nein
company_price_count Indiv. Angebote Anzahl der indiv. Angebote zu diesem Artikel Nein
usedcount Verw. Die Anzahl der Zutaten, die diesen Lieferantenartikel verwenden Nein

RELATIONS

Name Title Description Local Foreign Type
Category Kategorie   category_id id 1-n
Provider Lieferant Die Bezeichnung des Lieferanten/Anbieters provider_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
Wrappingunit     wrappingunit_id id 1-n
Price Angebot Ein Angebot stellt die Definition eines Preises zu einem Artikel dar. id article_id n-1
IngredientItem Zuordnung Eine Zuordnung verknüpft eine Zutat mit den jeweiligen Lieferantenartikel. id article_id n-1
OrderItem Bestellposten Ein Bestellposten ist ein Bestandteil der Bestellung. id article_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

 

 

CONTROLLER

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

 

 

Price (Angebot)

Ein Angebot stellt die Definition eines Preises zu einem Artikel dar.

FIELDS

Name Title Description Editable
id Id   Ja
uid Uid   Nein
guid     Ja
article_id Artikel Der Artikel, auf den sich das Angebot bezieht. Ja
number PLU (Angb.) Die eindeutige Identifikationsnummer des Angebots Ja
description Beschreibung (Angb.) Die Beschreibung des Angebots Ja
value Preis Der Netto-Einkaufspreis (ohne MwSt.) (z.B. 3,55) Ja
comparevalue Einheitspreis Der netto Einheitspreis (ohne MwSt.) (z.B. Preis pro Kilogramm) 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
type Typ   Ja
minpurchase Mind. Bestellm. Die Mindestabnahmemenge (z.B. 12) Ja
valid_from Gültig von Begin der Gültigkeit (Datum: TT.MM.JJJJ) Ja
valid_until Gültig bis Ende der Gültigkeit (Datum: TT.MM.JJJJ) Ja
public Aktiv Ist das Angebot aktiv? Ja
dirty Status Der aktuelle Status des Preises Ja
company_provider_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
termination Gültigkeit Gibt den aktuellen Gültigkeitszeitraum an. Falls eine Gültigkeit vorgenommen wurde, wird das Datum und die Uhrzeit ausgewiesen Ja
version Version   Nein
total_amount Gesamtmenge Gesamtmenge des Artikels Nein

RELATIONS

Name Title Description Local Foreign Type
Currency Währung   currency_id id 1-n
Tax Steuer   tax_id id 1-n
Article Lieferantenartikel Der Lieferantenartikel definiert einen Artikel aus der Sicht des Lieferanten. article_id id 1-n
CompanyProvider Kooperation Der Name des Kooperationspartners company_provider_id id 1-n
IngredientItem Zuordnung Eine Zuordnung verknüpft eine Zutat mit den jeweiligen Lieferantenartikel. id price_id n-1
OrderItem Bestellposten Ein Bestellposten ist ein Bestandteil der Bestellung. id price_id n-1
Editor     updated_by id 1-n
Owner     created_by id 1-n
Version     uid uid n-1

 

 

CONTROLLER

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

 

 

CompanyProvider (Kooperation)

Der Name des Kooperationspartners

FIELDS

Name Title Description Editable
id Id   Nein
guid     Ja
customer_number Kundennr. Kundennummer beim jeweiligen Lieferanten Ja
company_id Gastronomie   Ja
provider_id Lieferant Der Namen des Lieferanten (z.B. Musterlieferant GmbH) Ja
active Aktiv Die Information darüber, ob der Lieferant Ihre Kooperationsanfrage bestätigt hat Ja
status Status Der Freigabestatus für die Angebotspalette des Anbieters an. Der Anbieter muss zuerst eine Freigabe erteilen, bevor Sie auf das jeweilige Angebot Zugriff erhalten. Bedeutungen: Warten auf Bestätigung = Die Freigabe-Anfrage wurde an den Anbieter gesendet bzw. befindet sich in der Bearbeitung. Bestätigt = Die Freigabe wurde erteilt. Die Angebotpalette des Anbieters ist für Sie verfügbar. Kooperation beendet = Die vorhandene Freigabe wurde entzogen bzw. beendet. Die Angebotspalette des Anbieters ist für Sie nicht mehr verfügbar. Ja
minpurchase Mindestbestellwert Welcher Umsatz muss pro Bestellung mindestens generiert werden? Ja
delivery_monday Mo Ist montags eine Lieferung möglich? Ja
delivery_tuesday Di Ist dienstags eine Lieferung möglich? Ja
delivery_wednesday Mi Ist mittwochs eine Lieferung möglich? Ja
delivery_thursday Do Ist donnerstags eine Lieferung möglich? Ja
delivery_friday Fr Ist freitags eine Lieferung möglich? Ja
delivery_saturday Sa Ist samstags eine Lieferung möglich? Ja
delivery_sunday So Ist sonntags eine Lieferung möglich? Ja
delivery_maxtime Spät. Best.Zeit Bis zu welcher Zeit ist eine Lieferung noch am gleichen Tag möglich? 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
inheritconfig     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
articlecount Artikel gesamt Die Gesamtanzahl der Artikel, die vom Lieferanten zur Verfügung gestellt wurden. Nein
pricecount Angebote gesamt Die Gesamtanzahl der Angebote, die der Lieferant zur Verfügung gestellt hat. 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
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_provider_id n-1
Price Angebot Ein Angebot stellt die Definition eines Preises zu einem Artikel dar. id company_provider_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
companyproviders/basicproviders  
companyproviders/companies  
companyproviders/delete
/**
 * default delete action for all Action Controllers
 * @return null
 */
companyproviders/edit
/**
 * default edit action for all Action Controllers
 * @return null
 */
companyproviders/index
/**
 * the default index action for all Action Controllers
 * @return null
 */
companyproviders/insert
/**
 * default insert Action for all Action Controllers
 * @return null
 */
companyproviders/latest
/**
 * list the latest companies / providers, related to the called group
 * if a provider is calling this action, all his latest companies are listed and so on
 * @return null
 */
companyproviders/providers  
companyproviders/read
/**
 * default read action for all Action Controllers
 * @return null
 */
companyproviders/rest
/**
 * REST action for all Action Controllers
 * 
 * GET -> readAction
 * POST -> editAction
 * PUT -> insertAction
 * DELETE -> deleteAction
 * 
 * @return null
 */
companyproviders/sort
/**
 * sort a record
 * @return null
 */
companyproviders/terminate
/**
 * terminate a record
 */
companyproviders/versions  

 

 

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.

FIELDS

Name Title Description Editable
id Id   Nein
guid     Ja
title Lager Die Lagerbezeichnung (z.B. Keller, Tiefkühlhaus Nr. 1) Ja
number PLU Die interne Bestellnummer des bestellenden Unternehmens Ja
order_number Bestellnr. Die interne Bestellnummer des Lieferanten Ja
description Beschreibung Die Beschreibung bzw. Anmerkung Ja
transmit_history     Ja
company_id Gastronomie   Ja
company_provider_id Lieferant Der ausgwählte Lieferant, an den die Bestellung gehen soll. Ja
status_id Status Der aktuelle Vorgangsstatus Ja
orderset_id Bestellvorlage Auf Basis welcher Bestellvorlage soll die Bestellung erstellt werden? Ja
costunit_id Kostenstelle Welche Kostenstelle soll die Bestellung ausführen? Ja
time_delivery_wished Gewünscht. Lieferdatum Das gewünschte Lieferdatum des Auftraggebers (Datum: TT.MM.JJJJ, Uhrzeit: HH:MM) Ja
time_delivery_expected Voraussicht. Lieferdatum Das voraussichtliche Auslieferungsdatum (Datum: TT.MM.JJJJ, Uhrzeit: HH:MM) Ja
time_ordered Bestellzeit Der Zeitpunkt der Bestellung (Datum: TT.MM.JJJJ, Uhrzeit: HH:MM) Ja
time_processed Ausgeliefert am Der Zeitpunkt der Auslieferung (Datum: TT.MM.JJJJ, Uhrzeit: HH:MM) Ja
time_received Warenannahme am Der Zeitpunkt der Warenannahme (Datum: TT.MM.JJJJ, Uhrzeit: HH:MM) 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     Nein
total_price_ordered Preis (bestellt) Preis bei Bestellung Nein
total_price_processed Preis (bearbeitet) Preis nach Bearbeitung durch den Lieferanten Nein
total_price_received Preis (erhalten) Preis bei Warenannahme Nein
currency_title     Nein
currency_short     Nein
currency_sign     Nein
currency_value     Nein
currency_prec     Nein

RELATIONS

Name Title Description Local Foreign Type
Company Gastronomie Die Bezeichnung bzw. die Firmierung des Unternehmens company_id id 1-n
CompanyProvider Kooperation Der Name des Kooperationspartners company_provider_id id 1-n
Orderset Bestellvorlage Bestellvorlagen sind Zusammenstellungen von Zutaten, um eine schnelle Bestellung zu ermöglichen. orderset_id id 1-n
Costunit Kostenstelle Der Ort der Kostenentstehung und der Leistungserbringung costunit_id id 1-n
Orderstatus Status Der aktuelle Vorgangsstatus status_id id 1-n
OrderItem Bestellposten Ein Bestellposten ist ein Bestandteil der Bestellung. id order_id n-1
OrderFile     id order_id n-1
Editor     updated_by id 1-n
Owner     created_by id 1-n
Version     id id n-1

 

 

CONTROLLER

/**
 * OrdersController
 *
 * @author
 * @version
 */
URL Description
orders/cancel  
orders/complain  
orders/convey  
orders/customer  
orders/defer  
orders/delete
/**
 * default delete action for all Action Controllers
 * @return null
 */
orders/edit
/**
 * default edit action for all Action Controllers
 * @return null
 */
orders/index
/**
 * the default index action for all Action Controllers
 * @return null
 */
orders/insert
/**
 * default insert Action for all Action Controllers
 * @return null
 */
orders/list  
orders/order  
orders/pend  
orders/preorder  
orders/process  
orders/propose  
orders/read
/**
 * default read action for all Action Controllers
 * @return null
 */
orders/receive
/**
 * Description
 * 
 * @param id
 * @model [Order] Description ...
 * @model [Order.Orderstatus.id]  Description ...
 * 
 * @blocked Order.status_id
 * @blocked Order.Orderstatus.title
 * @blocked Order.Orderstatus.description
 * 
 * @return updated.[Order]
 * 
 */
orders/rest
/**
 * REST action for all Action Controllers
 * 
 * GET -> readAction
 * POST -> editAction
 * PUT -> insertAction
 * DELETE -> deleteAction
 * 
 * @return null
 */
orders/sort
/**
 * sort a record
 * @return null
 */
orders/terminate
/**
 * terminate a record
 */
orders/versions  

 

 

OrderItem (Bestellposten)

Ein Bestellposten ist ein Bestandteil der Bestellung.

FIELDS

Name Title Description Editable
id Id   Nein
guid     Ja
description Beschreibung Die Beschreibung bzw. Anmerkung Ja
order_id     Ja
article_id Artikel Der ausgewählte Lieferantenartikel Ja
price_id     Ja
ingredient_id Zutat Die Bezeichnung der Zutat (z.B. Tomate) Ja
status Status Der aktuelle Status Ja
price_ordered Einzelpreis (bestellt) Einzelpreis bei Bestellung Ja
price_processed Einzelpreis (bearbeitet) Einzelpreis nach Bearbeitung durch den Lieferanten Ja
price_received Einzelpreis (erhalten) Einzelpreis bei Warenannahme Ja
amount_raw Menge Menge an Grundeinheiten der Zutat Ja
amount_ordered Bestellmenge Menge bei der Bestellung Ja
amount_processed Menge (bearbeitet) Menge nach Bearbeitung durch den Lieferanten Ja
amount_received Menge (erhalten) Menge bei Warenannahme Ja
amount_tostock Menge (einzulagern) Menge, die noch eingelagert werden muss Ja
vat MwSt.Satz Der gesetzl. Mehrwertsteuersatz in Prozentpunkten (z.B. 19%) Ja
apply Übernehmen Soll der angenommene Preis des Bestellpostens bei Annahme der Bestellung als aktueller Preis des Lieferantenartikels übernommen werden? Ja
checked Überprüft Wurde dieser Posten vor der Bestellannahme überprüft? 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_ordered Preis (bestellt) Preis bei Bestellung Nein
total_price_processed Preis (bearbeitet) Preis nach Bearbeitung durch den Lieferanten Nein
total_price_received Preis (erhalten) Preis bei Warenannahme Nein
total_amount Gesamtmenge Gesamtmenge des Artikels Nein
total_amount_ordered Gesamtmenge (bestellt) Gesamtmenge bei Bestellung Nein
total_amount_processed Gesamtmenge (bearbeitet) Gesamtmenge nach Bearbeitung durch den Lieferanten Nein
total_amount_received Gesamtmenge (erhalten) Gesamtmenge bei Warenannahme Nein
amount_remaining     Nein

RELATIONS

Name Title Description Local Foreign Type
Ingredient Zutat Die Bezeichnung einer Zutat im eigenen Unternehmen (z.B. Tomaten, Zucker) ingredient_id id 1-n
Article Lieferantenartikel Der Lieferantenartikel definiert einen Artikel aus der Sicht des Lieferanten. article_id id 1-n
Price Angebot Ein Angebot stellt die Definition eines Preises zu einem Artikel dar. price_id id 1-n
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. order_id id 1-n
Editor     updated_by id 1-n
Owner     created_by id 1-n
Version     id id n-1

 

 

CONTROLLER

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

 

 

API CALL EXAMPLES

LOGIN AS PROVIDER

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(121)
}

RESPONSE

...

READ PACKAGINGUNITS

URL

packagingunits/index/

POST PARAMS

array(1) {
  ["search"] => string(33) "{"Packagingunit.comparable":true}"
}

RESPONSE

...

CREATE ARTICLES

URL

articles/index/

POST PARAMS

array(1) {
  ["Article"] => string(180) "[{"title":"Tomaten","packagingunit_id":0,"number":"A1353934015","_action":"add"},{"title":"Becks","packagingunit_id":0,"packagingamount":50,"number":"A1353934016","_action":"add"}]"
}

RESPONSE

...

READ ARTICLES

URL

articles/index/

POST PARAMS

array(3) {
  ["search"] => string(40) "{"Article.title":{"or":["mehl","zuck"]}}"
  ["sort"] => string(23) "{"Article.title":"ASC"}"
  ["image"] => string(71) "{"Article.picture_id":"15x:r","Article.picture_id.url_big":"200x400:r"}"
}

RESPONSE

...

CREATE PRICES

URL

prices/index/

POST PARAMS

array(1) {
  ["Price"] => string(194) "[{"value":"2.90","number":"P1353934019","Article__number":"A1353934015","_action":"add"},{"value":"2.73","minpurchase":10,"number":"P1353934020","Article__number":"A1353934015","_action":"add"}]"
}

RESPONSE

...

READ COMPANY PROVIDERS

URL

companyproviders/index/

POST PARAMS

array(1) {
  ["search"] => string(47) "{"CompanyProvider.customer_number":"=KUND0023"}"
}

RESPONSE

...

CREATE COMPANY PRICE

URL

companyprices/insert/

POST PARAMS

array(3) {
  ["company_provider_id"] => string(1) "0"
  ["discount"] => string(2) "10"
  ["Price__number"] => string(13) ""P1353934019""
}

RESPONSE

...

READ COMPANY PRICES

URL

companyprices/index/

POST PARAMS

array(1) {
  ["search"] => string(47) "{"CompanyProvider.customer_number":"=KUND0023"}"
}

RESPONSE

...

UPDATE COMPANY PRICE (single)

URL

companyprices/edit/0

POST PARAMS

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

RESPONSE

...

UPDATE COMPANY PRICE (multi)

URL

companyprices/index/

POST PARAMS

array(1) {
  ["CompanyPrice"] => string(96) "[{"uid":9999999999,"discount":11,"_action":"update"},{"uid":0,"discount":11,"_action":"update"}]"
}

RESPONSE

...

LOGOUT

URL

users/logout

RESPONSE

...

LOGIN AS COMPANY

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

...

CREATE NEW ORDER

URL

orders/insert/

POST PARAMS

array(1) {
  ["company_provider_id"] => string(1) "0"
}

RESPONSE

...

CREATE NEW ORDER ITEMS

URL

orderitems/index/

POST PARAMS

array(2) {
  ["OrderItem"] => string(111) "[{"amount_ordered":"7.5","article_id":0,"_action":"add"},{"amount_ordered":"5","article_id":0,"_action":"add"}]"
  ["order_id"] => string(1) "0"
}

RESPONSE

...

ORDER ORDER (single, set as "ordered")

URL

orders/order/0

RESPONSE

...

LOGOUT

URL

users/logout

RESPONSE

...

LOGIN AS PROVIDER

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(121)
}

RESPONSE

...

READ ORDERS (multi, get only ordered ones)

URL

orders/index/

POST PARAMS

array(1) {
  ["search"] => string(31) "{"Orderstatus.type":"=ordered"}"
}

RESPONSE

...

READ ORDER (single)

URL

orders/index/0

RESPONSE

...

PEND ORDER (single, set as "pending")

URL

orders/pend/0

RESPONSE

...

READ ORDER ITEMS (of specific order)

URL

orderitems/index/

GET PARAMS

array(1) {
  ["order_id"] => string(1) "0"
}

RESPONSE

...

UPDATE ORDER ITEM (single, set new price and amount)

URL

orderitems/edit/0

POST PARAMS

array(3) {
  ["order_id"] => string(1) "0"
  ["amount_processed"] => string(3) "6.5"
  ["description"] => string(80) ""Leider k\u00f6nnen wir nicht alles liefern. Daf\u00fcr ist es teurer geworden.""
}

RESPONSE

...

PROCESS ORDER (single, set as "processed")

URL

orders/process/0

RESPONSE

...

UPDATE ORDER (single, set expected delivery time)

URL

orders/edit/0

POST PARAMS

array(1) {
  ["time_delivery_expected"] => string(10) "1353977273"
}

RESPONSE

...