/restaurant

Attention : tous les prix sont en centimes

Restaurant

Attribut	Type	Nullable ?	Commentaires
id	Entier (Unique)	NON	Id du restaurant
name	String	NON	Nom du restaurant
slug	String	OUI	Nom raccourci du restaurant
address	String	OUI	Adresse de l'établissement
zipcode	String	OUI	Code postal du restaurant
city	String	NON	Ville du restaurant
country	String	OUI	Pays du restaurant en format abrégé
countryName	String	NON	Pays du restaurant
currency	String	NON	Devise du restaurant
siret	String	NON	Siret du restaurant
ticketFooter	String	OUI	Message à afficher sur le pied de page du ticket client
media	Array	OUI	Contient le logo de l'établissement
companyName	String	OUI	Nom juridique de l'établissement

RestaurantFeature

Module activé pour le restaurant

Attribut	Type	Nullable ?	Commentaire
id	Entier (unique)	NON	Id de l'activation du module pour le restaurant
feature	String	NON	Code du module
price	Entier	NON	Prix du module en centime dans la devise du restaurant

PaymentTypes

Liste les moyens de paiements acceptés par l'établissement

Attribut	Type	Nullable ?	Commentaire
id	Entier (Unique)	NON	id du moyen de paiement
type	String	NON	Type de paiement
openDrawer	Boolean	NON	Indique si le paiement déclenche l'ouverture du tiroir caisse.
cashback	Boolean	NON	Indique si le paiement déclenche un rendu monnaie.
extraData	Array	OUI	Dictionnaire des informations complémentaire liées au type de payement
identifier	String	NON	identifiant unique du moyen de paiement qui apparaît sur le ticket

Tax

Liste les taxes configurées pour l'établissement

Attribut	Type	Nullable ?	Commentaire
id	Entier (unique)	NON	Id de la taxe
name	String	NON	Nom de la taxe
value	Décimal (4,2)	NON	Valeur de la taxe en %
identifier	String	NON	identifiant unique de la taxe qui apparaît sur le ticket

Printer

Liste des imprimantes configurées pour l'établissement

Attribut	Type	Nullable ?	Commentaire
id	Entier (unique)	NON	Id de l'imprimante
name	String	NON	Nom de l'imprimante

Waiter

Liste des utilisateurs configurés pour l'établissement

Attribut	Type	Nullable ?	Commentaire
id	Entier (unique)	NON	Id du serveur
name	String	NON	Nom du serveur
password	String	NON	Mot de passe du serveur
hourlyCost	Decimal (4,2)	OUI	Coût horaire du serveur
rights	Entier	NON	Droits associés à l'utilisateur (bitmask) 0x01 => allowSettings (Accéder aux réglages) 0x02 => allowDiscounts (Faire une remise) 0x04 => allowCancelProduct (Annuler produit) 0x08 => allowCancelPayment (Annuler Paiement) 0x10 => allowOpenDrawer (Ouvrir tiroir caisse) 0x20 => allowAccessAllOrders (Accéder aux commandes des autres utilisateurs) 0x40 => allowAccessClosedOrders (Accéder aux commandes clôturées)

Room

Attribut	Type	Nullable ?	Commentaire
Id	Entier (unqiue)	NON	Id de la salle
name	String	NON	Nom de la salle
position	Entier	NON	Position de la table (démarre à 0)
tables	Array of Table	OUI	Liste de table de la salle

Table

Attribut	Type	Nullable ?	Commentaire
id	Entier (unique)	NON	Id de la table
name	String	NON	Nom de la table
position	Entier	NON	Position de la table (Démarre à 0, classé par ordre croissant)

Attribut	Type	Nullable ?	Commentaire
id	Entier (unique)	NON	id de la carte
name	String	NON	Nom de la carte
isPlanned	Boolean	NON	Est-ce que la carte est planifiée (changement automatique de plage horaire)
plannedDays	Integer	NON	Liste de jours activés : 0x01 => lundi 0x02 => mardi 0x04 => mercredi 0x08 => jeudi 0x10 => vendredi 0x20 => samedi 0x40 => dimanche
startTime	Time	OUI	Heure de début
endTime	Time	OUI	Heure de fin
position	Entier	NON	Position de la carte (classer par ordre croissant)
period	array	OUI	Periodes d'activation de la carte

Period

Attribut	Type	Nullable ?	Commentaire
id	Entier (unique)	NON	id de la période
plannedDays	Integer	NON	Liste de jours activés : 0x01 => lundi 0x02 => mardi 0x04 => mercredi 0x08 => jeudi 0x10 => vendredi 0x20 => samedi 0x40 => dimanche
startTime	Array	OUI	Heure de planification de début avec 'hour' en clé pour les heures et 'minute' en clé pour les minutes
endTime	Array	OUI	Heure de planification de fin avec 'hour' en clé pour les heures et 'minute' en clé pour les minutes

OrderTerminal

Configuration de la borne de commande pour l'établissement

Attribut	Type	Nullable ?	Commentaire
id	Entier (unique)	NON	Id de la configuration de la borne
name	String	NON	Nom de l'établissement à afficher sur la borne
description	String	NON	Description de l'établissement à afficher sur la borne
mode	String	NON	Mode de présentation de la borne: ORDER_TERMINAL_TABLE ORDER_TERMINAL_STAND
logo	array	OUI	Media du logo de l'établissement à afficher pour la borne
cover	array	OUI	Media de la cover à afficher pour la borne

Category et ExtraCategory

Attribut	Type	Nullable ?	Commentaire
id	Entier (unique)	NON	Id de la categorie
name	String	NON	Nom de la categorie
isExtra	Boolean	NON	Est-ce que c'est une catégorie d'extra
position	Entier	NON	Position de la catégorie (classer par ordre croissant)
terminalName	String	NON	Nom de la catégorie à afficher pour la borne
terminalDescription	String	OUI	Description de la catégorie à afficher sur la borne
media	Array	OUI	Media à afficher sur la borne
color	String (hex code)	OUI	Couleur de la catégorie
products	Array of product	OUI	Liste des produits de la catégorie

Product

Attribut	Type	Nullable ?	Commentaire
id	Entier (unique)	NON	Id du produit
name	String	NON	Nom du produit
description	String	NON	Description du produit
price	Entier	NON	Prix par défaut du produit en centimes dans la devise du restaurant (ne pas utiliser si le module "plage horaire" est activé)
costPrice	Entier	NON	Cout de production du produit en centimes dans la devise du restaurant
tax	Entier	NON	Id de la tax du produit
printer	Entier	NON	Id de l'imprimante du produit
position	Entier	OUI	Position du produit (classer par ordre croissant)
color	String (hex code)	OUI	Couleur du plat
productExtras	Array of ProductExtra	NON	Liste des options et suppléments du produit
productInMenus	Array of ProductInMenu	NON	Liste des prix du produit selon les cartes/plages horaires
hasTimer	Boolean	NON	Est-ce que le produit à un timer ?
barcode	String	OUI	Code barre du produit
terminalName	String	OUI	Nom du produit dans la borne
isInTerminal	Boolean	NON	Défini si le produit est présent dans la borne ou non

ProductExtra

Défini l'existence d'une option ou d'un supplément pour un produit

Attribut	Type	Nullable	Commentaire
id	Entier (unique)	NON	Id de l'extra du produit
product	Entier	NON	Id du produit de l'extra du produit
extraCategoryId	Entier	NON	Id de la categorie d'extra de l'extra du produit
popupAuto	Boolean	NON	Affichage de la popup automatique
isUnique	Boolean	NON	La sélection peut être multiple ou doit être unique
position	Entier	NON	Position de l'option dans la popup

CourseMeals

Liste des formules d'un restaurant

Attribut	Type	Nullable ?	Commentaire
id	Entier	NON	id de la formule. Une formule est un product
name	String	NON	Nom donné à la formule
description	String	OUI	Description de la formule
price	Entier	NON	Prix de la formule. Le prix est en centime dans la devise du restaurant
color	String (hex code)	OUI	Couleur de la formule
courseMealChoices	Array of CourseMealChoices	NON	Liste des choix dans la formule

CourseMealChoices

Liste des choix d'une formule

Attribut	Type	Nullable ?	Commentaire
id	Entier	NON	id du choix dans une formule
name	String	NON	Nom du choix
position	Entier	NON	Position du choix dans la formule
sendingOrder	Entier	NON	Ordre de l'envoi du choix (Direct, Suite, Suite1, etc)
products	Array of ProductChoices	NON	Liste des produits sélectionnés dans la formule

ProductChoices

Liste des produits dans un choix

Attribut	Type	Nullable ?	Commentaire
id	Entier	NON	id du produit dans le choix
productId	Entier	NON	id du produit inclus dans la formule
position	Entier	NON	Position du produit dans la choix
extraPrice	Entier	NON	Supplément de prix en centime dans la devise dans la formule. Le supplément s'applique au prix de base du produit

ProductInMenu

Appartenance d'un produit à son menu (avec le prix de celui ci par rapport a ce menu)

Attribut	Type	Nullable ?	Commentaire
id	Entier (unique)	NON	Id du produit dans le menu
menu	Entier	NON	Id du menu du produit dans le menu
product	Entier	NON	Id du produit du produit dans le menu
price	Entier	NON	Prix du produit en centimes dans la devise du restaurant

customDiscounts

Liste des remises personnalisée de l'établissement

Attribut	Type	Nullable ?	Commentaire
name	String	NON	Nom de la remise personnalisée
type	String	NON	Type de la remise (% ou monétaire) PERCENTAGE_DISCOUNT AMOUNT_DISCOUNT
amount	Entier	NON	Prix en centime pour les remises monétaires sinon montant en pourcentage
position	Entier	NON	Position de la remise

currentTill

Caisse courrante

Attribut	Type	Nullable ?	Commentaire
id	Entier (unique)	NON	id de la till
startDate	String	NON	date d'ouverture de la caisse format YYYY-MM-DDTHH:MM:SS+Z
endDate	String	OUI	date de fermeture de la caisse format YYYY-MM-DDTHH:MM:SS+Z
cashFund	Entier	NON	Fond de caisse en centime dans la devise du restaurant
lastUpdate	String	OUI	dernière date de modification de la caisse format YYYY-MM-DDTHH:MM:SS+Z
updateByWaiter	Entier	OUI	id du dernier utilisateur qui a avoir modifié la caisse

restaurantDevices

Liste des appareils de l'établissement

Attribut	Type	Nullable	Commentaire
id	Entier (unique)	NON	id du device
name	String	NON	Nom de l'appareil
prefix	String	NON	Valeurs : A, B, ... ZZZ identifiant de l'appareil généré pour l'établissement.

current device

Appareil lié à la session en cours