Models

ButtonGroupEntity

Object containing the following properties:

Property	Type
`id`	`string` (uuid)
`name` (*)	`string` (max length: 255)
`isRoot` (*)	`boolean`
`layout` (*)	`'5-Cols' \| '4-Cols' \| '3-Cols' \| '2-Cols' \| 'Folder' \| 'SelectionFolder' \| 'MealsFolder'`
`rows` (*)	`number` (int)
`cols` (*)	`number` (int)
`buttons` (*)	Array of objects: `id` (): `string` (uuid) `type`* (): `'buttonGroup' \| 'product' \| 'meal'` `objectId`* (): `string` (uuid) `index`* (): `number` (int, ≥0) `color`* (): `never` `brightness`: `'light' \| 'normal' \| 'dark'` `fontSize`: `number` (int, ≥0*) `icon`: `string`

(*) Required.

CashMovementReasonEntity

Object containing the following properties:

Property	Type
`id`	`string` (uuid)
`name` (*)	`string`

(*) Required.

DiscountEntity

Object containing the following properties:

Property	Type
`id`	`string` (uuid)
`name` (*)	`string`
`index`	`number` (int, ≥0)
`type` (*)	`'percentage' \| 'amount'`
`value` (*)	`number`
`targetPrice` (*)	`'unit' \| 'total'`

(*) Required.

EmployeeEntity

Object containing the following properties:

Property	Type
`id`	`string` (uuid)
`colorBlind` (*)	`boolean`
`isOwner` (*)	`boolean`
`keyDallasCode` (*)	`string` (nullable)
`name` (*)	`string`
`password` (*)	`string` (length: 4) (nullable)
`qrCode` (*)	`string` (nullable)
`drawerOpenOnPaid` (*)	`boolean`
`canOpenCashDrawer` (*)	`boolean`
`canSwitchHappyHour` (*)	`boolean`
`canPayCustomerAccount` (*)	`boolean`
`canPayOrders` (*)	`boolean`
`canCancelOrders` (*)	`boolean`
`canChangeOwnership` (*)	`boolean`
`canChangePricing` (*)	`boolean`
`canUseCustomPrice` (*)	`boolean`
`canChangePayment` (*)	`boolean`
`canUseDiscount` (*)	`boolean`
`canUseCustomDiscount` (*)	`boolean`
`canManageCatalog` (*)	`boolean`
`canManageCustomers` (*)	`boolean`
`canManageEmployees` (*)	`boolean`
`canManagePrinters` (*)	`boolean`
`canAccessAllOrders` (*)	`boolean`
`canAccessReport` (*)	`boolean`
`canAccessAllStats` (*)	`boolean`
`canCloseTill` (*)	`boolean`
`canStartAndStopTill` (*)	`boolean`
`canTransferProductsBetweenOrders` (*)	`boolean`
`canPrintProofOfPayment` (*)	`boolean`
`canCancelAfterBillPrint` (*)	`boolean`
`canModifyAfterBillPrint` (*)	`boolean`

(*) Required.

LocationSettingsEntityV4

Object containing the following properties:

Property	Type	Default
`id`	`string` (uuid)
`locationName` (*)	`string`
`currencyLocale`	`string`	`'fr_FR'`
`timezone`	`'Africa/Abidjan' \| 'Africa/Accra' \| 'Africa/Addis_Ababa' \| 'Africa/Algiers' \| 'Africa/Asmara' \| 'Africa/Asmera' \| 'Africa/Bamako' \| 'Africa/Bangui' \| 'Africa/Banjul' \| 'Africa/Bissau' \| 'Africa/Blantyre' \| 'Africa/Brazzaville' \| 'Africa/Bujumbura' \| 'Africa/Cairo' \| 'Africa/Casablanca' \| 'Africa/Ceuta' \| 'Africa/Conakry' \| 'Africa/Dakar' \| 'Africa/Dar_es_Salaam' \| 'Africa/Djibouti' \| ...`
`establishmentName`	`string`	`''`
`address1`	`string`	`''`
`address2` (*)	`string` (nullable)	`''`
`customHeader`	`string`	`''`
`siretCode`	`string`	`''`
`phoneNumber`	`string`	`''`
`zipCode`	`string`	`''`
`city`	`string`	`''`
`country`	`string`	`'France'`
`website`	`string`	`''`
`nafCode`	`string`	`''`
`tvaCode`	`string`	`''`
`customFooter`	`string`	`''`
`companyName`	`string`	`''`
`cutBetweenSteps`	`boolean`	`true`
`printOnlyFirstPrepaReceipt`	`boolean`	`false`
`enablePreparationCall`	`boolean`	`true`
`detailedReport`	`boolean`	`true`
`doNotPrintClaim`	`boolean`	`false`
`closeAfterOrderCall`	`boolean`	`true`
`qrCodeLogin`	`boolean`	`false`
`printOnPay`	`boolean`	`false`
`prepaStepsCount`	`number` (≤10, ≥0)	`3`
`askForInitialCashFloat`	`boolean`	`false`
`groupProductsOnPrepaReceipt`	`boolean`	`true`
`printClaimWithoutDetail`	`boolean`	`false`
`allowGapInTillStats`	`boolean`	`false`
`allowCatalogEditOnPos`	`boolean`	`true`
`printMenuWithDetail`	`boolean`	`false`
`groupProductsOnOrder`	`boolean`	`false`
`printMenuNameOnPrepaReceipt`	`boolean`	`false`
`printModifierGroupOnPrepaReceipt`	`boolean`	`false`
`menuButtonsCount`	`number` (≥4, ≤16)	`8`
`closeFiscalYearDate`	`Date` (nullable)
`logoUrl`	`string` (nullable)	`''`

(*) Required.

MealButtonEntity

Object containing the following properties:

Property	Type
`id`	`string` (uuid)
`amount` (*)	`number`
`index`	`number` (int, ≥0)
`fontSize` (*)	`number`
`courseId` (*)	`string` (uuid)
`productId` (*)	`string` (uuid)

(*) Required.

MealCourseEntity

Object containing the following properties:

Property	Type
`id`	`string` (uuid)
`name` (*)	`string`
`index`	`number` (int, ≥0)
`stepIndex` (*)	`number` (≥-1, ≤9)
`amountToSubtract`	`number`
`mealId` (*)	`string` (uuid)

(*) Required.

MealEntity

Object containing the following properties:

Property	Type
`id`	`string` (uuid)
`index`	`number` (int, ≥0)
`name` (*)	`string`

(*) Required.

MealPriceEntity

Object containing the following properties:

Property	Type
`id`	`string` (uuid)
`amount` (*)	`number`
`mealId` (*)	`string` (uuid)
`pricingId` (*)	`string` (uuid)

(*) Required.

ModifierEntity

Object containing the following properties:

Property	Type
`id`	`string` (uuid)
`index`	`number` (int, ≥0)
`name` (*)	`string`
`price` (*)	`number`
`groupId` (*)	`string` (uuid)

(*) Required.

ModifierGroupEntity

Object containing the following properties:

Property	Type
`id`	`string` (uuid)
`required` (*)	`boolean`
`maxSelect` (*)	`number` (≥0)
`name` (*)	`string`
`type` (*)	`'special' \| 'shared'`
`index`	`number` (int, ≥0)

(*) Required.

ModifierGroupProductLink

Object containing the following properties:

Property	Type
`id`	`string` (uuid)
`modifierGroupId` (*)	`string` (uuid)
`productId` (*)	`string` (uuid)

(*) Required.

PaymentEntity

Object containing the following properties:

Property	Type
`id`	`string` (uuid)
`index`	`number` (int, ≥0)
`enabled` (*)	`boolean`
`mode` (*)	`'cash' \| 'card' \| 'restaurantCheck' \| 'check' \| 'amex' \| 'credit' \| 'custom' \| 'iZettle' \| 'debt' \| 'foxOrder' \| 'restoFlash' \| 'mews' \| 'barnaby' \| 'uberEats' \| 'deposit' \| 'deliveroo' \| 'bananaSplit' \| 'qoodosCashback' \| 'hubrise' \| 'keytchens' \| ...`
`name` (*)	`string`
`tips` (*)	`boolean`
`voucher` (*)	`boolean`
`openCashDrawer` (*)	`boolean`

(*) Required.

PrepaStationProductLink

Object containing the following properties:

Property	Type
`id`	`string` (uuid)
`stationId` (*)	`string` (uuid)
`productId` (*)	`string` (uuid)

(*) Required.

PreparationStationEntity

Object containing the following properties:

Property	Type	Default
`id`	`string` (uuid)
`name` (*)	`string`
`printerId`	`string` (uuid) (nullable)
`recapPrepa` (*)	`boolean`
`printUnknownItems` (*)	`boolean`
`mainStationId`	`string` (uuid) (nullable)
`relatedStations`	`Array<string (_uuid_)>`	`[]`

(*) Required.

PriceEntity

Object containing the following properties:

Property	Type
`id`	`string` (uuid)
`amount` (*)	`number`
`productId` (*)	`string` (uuid)
`taxId` (*)	`string` (uuid)
`pricingId` (*)	`string` (uuid)

(*) Required.

PricingEntity

Object containing the following properties:

Property	Type
`id`	`string` (uuid)
`enabled` (*)	`boolean`
`name` (*)	`string`
`type` (*)	`'custom' \| 'normal' \| 'happyHour' \| 'bar' \| 'takeOut' \| 'terrace' \| 'special' \| 'weightPrice' \| 'event0' \| 'event1' \| 'event2' \| 'event3' \| 'event4' \| 'event5' \| 'event6' \| 'delivery'`

(*) Required.

PricingEventEntity

Object containing the following properties:

Property	Type
`id`	`string` (uuid)
`dateBegin` (*)	`Date`
`dateEnd` (*)	`Date`
`enabled` (*)	`boolean`
`pricingId` (*)	`string` (uuid)

(*) Required.

PrinterEntity

Object containing the following properties:

Property	Type	Default
`id`	`string` (uuid)
`workerDeviceId`	`string` (nullable)
`uniqueIdentifier`	`string` (nullable)
`localAddress`	`string` (nullable)
`customerDisplay` (*)	`boolean`
`reversePrint` (*)	`boolean`
`modelName`	`string` (nullable)
`manufacturer`	`string` (nullable)
`name` (*)	`string`
`port`	`number` (nullable)
`interface`	`'bluetooth' \| 'internal' \| 'network' \| 'virtual'`	`'network'`

(*) Required.

ProductEntity

Object containing the following properties:

Property	Type
`id`	`string` (uuid)
`barCode`	`string` (nullable)
`isCustomPrice` (*)	`boolean`
`isPricedByWeight` (*)	`boolean`
`name` (*)	`string`
`prepStationName`	`string` (nullable)
`layoutButtonName`	`string` (nullable)
`stepIndex` (*)	`number` (≥-1, ≤9)
`sku`	`string` (nullable)
`plu`	`number` (int, ≥0) (nullable)
`image`	`string` (nullable)
`tare`	`number` (≥0) (nullable)

(*) Required.

RoomEntity

Object containing the following properties:

Property	Type	Default
`id`	`string` (uuid)
`index`	`number` (int, ≥0)
`name` (*)	`string`
`enabled` (*)	`boolean`
`type` (*)	`'room' \| 'bar' \| 'takeOut' \| 'extOrder'`
`pricingId` (*)	`string` (uuid)
`enableBeepers`	`boolean`	`false`
`additionalReceiptCount`	`number` (≥0, ≤4)	`0`
`askGuests`	`boolean`	`false`
`showOwner`	`boolean`	`false`
`logoutAfterPayment`	`boolean`	`false`
`logoutAfterOrderCall`	`boolean`	`false`
`openNewOrderAfterPayment`	`boolean`	`false`
`orderCallAfterClosing`	`boolean`	`false`
`orderCallAfterPayment`	`boolean`	`false`

(*) Required.

TableEntity

Object containing the following properties:

Property	Type	Default
`id`	`string` (uuid)
`name` (*)	`string`
`seatCount`	`number` (≥0)	`0`
`roomId` (*)	`string` (uuid)
`positionX` (*)	`number` (≥0)
`positionY` (*)	`number` (≥0)
`shape` (*)	`'square' \| 'circle'`

(*) Required.

TaxEntity

Object containing the following properties:

Property	Type
`id`	`string` (uuid)
`name` (*)	`string`
`rate` (*)	`number` (int, ≥0)

(*) Required.

Models

On this page