Data Models

This reference documents the data models used by the Mando API. Models are auto-generated from the model definitions.

Generated: 2026-02-09T12:43:30+02:00 Total Models: 431 Total Enums: 83

Quick Navigation

A (30)B (14)C (42)D (29)E (8)F (4)G (3)H (3)I (18)L (19)M (7)N (6)O (1)P (57)R (34)S (82)T (27)U (7)V (2)W (38)

---

Enums

company_type

flowposmandomando_minirootreseller

stock_value_type

manualaveragelastfifo

invdiff_report

noneif_availablemandatory

additional_field_type

textnumberamounttextareadatedatetimeselectionmultiselectcheckboxmeasurementimage

companytree_type

companylocationpos

token_type

Customer identification token type

BARCODE - BarcodeQR - QR CodeNFC - NFC TagOTHER - OtherNYX - NYX Card

customer_type

Customer account type

private - Private Customercompany - Business Customer

customer_invoice_type

Customer invoicing preference

single - Single Invoice per Receiptsingle_automatic - Automatic Single Invoiceconsolidated_manual - Manual Consolidated Invoiceconsolidated_weekly - Weekly Consolidated Invoiceconsolidated_monthly - Monthly Consolidated Invoicenone - No Invoicing

send_type

manualfinvoice_xmlnetvisorprocountorfennoaapix

receipts_and_products

allreceipts_onlyproducts_grouped

payment_terms

immediate57101421283035456090

eft_mode

EFT payment terminal integration mode

Dummy - Ei maksupäätettäBaxi - Nets VikingBaxiBT - Nets Viking (Bluetooth)BaxiCloud - Nets Connect@CloudVerifone - Verifone TerminalVerifoneTcp - Verifone TCP/IPVerifoneSelfService - Verifone Self ServiceEPay2Evented - Seitatech EPay2Softpay - Softpay TerminalPoynt - Poynt/Nets MobilePoplaIP - Popla IP TerminalPoplaBT - Popla BluetoothPoplaCloud - Popla Cloud ServiceNpay1 - Npay (Mando tuotantopäätteet)Npay2 - Npay (Mando testipäätteet)Npay3 - Npay (Kassapolar)Npay4 - Npay (Tammerdata)Npay5 - Npay (Suomen ATK-Maahantuonti)Npay6 - Npay (Kassa- ja Toimistohuolto Häme)Npay - Npay Terminal (älä käytä)

customerdisplay_type

Customer display integration type

NONE - No DisplayTEXT - Text DisplayWEB - GraafinenWEB2 - Graafinen aina näkyvissä (ACT)GFX - Graphics Display (ei käytössä)

printer_control

Printer control protocol/driver type

A8 - Posbank A8ESCPOS - ESC/POS StandardSTAR - Star TSPCITIZEN - CitizenEPSON - Epson TM-T88CBM1000BAXI - Payment Terminal PrinterVF - Verifone PrinterA8_GFX - Posbank A8 GraphicsNETS_GFX - Payment Terminal GraphicsBROTHER_GFX - Brother QL GraphicsBROTHER_GFX_BW - Brother QL Graphics B/WSUNMI - SunMiSUNMI_GFX - SunMi GraphicsWIN - Windows PrinterCASTLES - Castles Terminal Printer

scale_type

Connected scale/weighing device type

NONE - No ScaleDIBAL - Dibal Scale

betting_type

Type of betting terminal integration

NONE - NoneOIVA - OivaEKI - Eki

pos2_login_type

POS 2026 login type

none - Ei kirjautumistalist - Valikkopin - PINnumber - Valikkonumber_and_pin - Numero ja PIN

postype_type

POS terminal platform type

flowpos - FlowPOS Windowscastles-pat - Castles Pay-at-Tablecastles - Castles Terminalcastles-pp - Castles Payment Pointcastles-upt - Castles UPT Terminalandroid - Android POSpos2 - POS 2026printer - Kuittikirjoitinkds - Keittiönäyttöorderdisplay - Tilausnäyttö

pos_network_type

standalonehostmobileselfservice

discount_order

Hinnan järjestys alennuksessa

PRICE_ASC - Alaspäin hinnan mukaanPRICE_DESC - Ylöspäin hinnan mukaan

discount_line_type

Alennusrivin tyyppi

PRICE - Uusi hintaAMOUNT - €-AlennusPERCENT - %-AlennusRECEIPT - Kuitti

invoicing_subscription_type

Laskutuksen tilaustyyppi

DISCOUNT_AMOUNT - AlennusmääräAMOUNT - SummaPERCENT - Prosentti

discount_pricetype

Alennuksen hintatyyppi

DISCOUNT_AMOUNT - AlennusmääräAMOUNT - SummaPERCENT - Prosentti

discount_type

Alennustyyppi

PLU_PCT_DISC - % Alennus tuotteestaTOTAL_PCT_DISC - % Alennus loppusummastaPLU_EUR_DISC - € Alennus tuotteestaTOTAL_EUR_DISC - € Alennus loppusummastaSET_PRICE - Uusi hinta tuotteelleMIXNMATCH - Mix'n'MatchBUNDLE - Niputus

subscription_type

Alennuksen tilaustapa

ALWAYS - AinaSUBSCRIBE - Valinnainen: PysyväCAMPAIGN - Valinnainen: Kampanja

discount_target

Alennuksen kohde

PLU - TuoteRECEIPT - KuittiTENDER - MaksutapaCUSTOMER - AsiakasCUSTOMERGROUP - Asiakasryhmä

external_status

Type of betting terminal integration

COMPLETE - Request completed successfullySENT_AND_REMOVED - Request sent but replaced with new oneSENT - Request sent successfullyHOLD - Request is on holdERROR - Error occurred during request

customerdisplay_element_type

EMPTYIMAGETEXTIMAGE_TEXT

customerdisplay_effect_type

NONEZOOMEXPLODE

customerdisplay_transition_type

NONEDISSOLVEFADESCROLL_LEFTRANDOM

customerdisplay_layout_type

FULLSCREENSPLIT_VERTICALSPLIT_HORIZONTAL

layout_page_layout_type

MASTERPAGEDPT_SELECTDPTSUBTOTALDISCOUNTPLUNORMAL

layout_background_type

NONEDEFAULTIMAGEIMAGE_REPEATIMAGE_COVER

layout_page_button_type

NORMALLEFT_RIGHTTOP_BOTTOMFREEFORM

pricegroup_type

basepricepricediscountpercentpurchaseprice

salestarget_type

TOTAL_SALES_AMOUNTAVG_SALES_AMOUNTTOTAL_CUSTOMERS_QTYPRODUCT_SALES_QTYDISCOUNT_SALES_QTY

plu_selection_type

OPEN_MENUCHANGE_PLUCHANGE_PRICECHANGE_PRICE_LEVELAPPLY_DISCOUNTCHANGE_QTYADD_MODIFIERREMOVE_MODIFIER

plu_selection_ui

TOGGLE_SELECTEDTOGGLE_UNSELECTEDTOGGLEBUTTON

pricing_type

BASE_PRICEPRICEAMOUNTPERCENT

unit_type

weightliquidpcslengthtime

refprice_type

weightliquid

time_units

SECMIN15MIN30MINHOURDAY

trend_direction

Sales trend direction

up - Sales increasingdown - Sales decreasingneutral - No significant change

menu_data_item_type

HIDDENPOPUPLISTFOLDABLELAYOUTPICKER

menu_data_choice_type

SINGLEWIZARDUPSELLCROSSSELL

stockevent_type

INVENTORYDELIVERYWASTAGETRANSFERUSAGEDAILY_TOTALS

stockevent_status

COMPLETECALCULATEDACTIVEWAITINGSTARTEDIN_TRANSFER

infocode_type

SELL_PRODUCTSELL_DPTSELL_GRPRECEIPT_STARTRECEIPT_ENDSUBTOTALRECEIPT_TRASHRECEIPT_REFUNDREFUNDOPEN_PRICESCHEDULEDRECEIPT_COMMENTTENDEREXTERNAL_PRODUCTEXTERNAL_PAYMENTEXTERNAL_DISCOUNT

infocode_input_type

textfunctionlisttextdatenumericproductcustomerstafffunctionbuttonsagelimitbuttonsandother

infocode_validation_type

minlenmaxlenminvalmaxvalrequired

infocode_printing_type

printpromptprintinputprinttype

tender_type

Maksutavan tyyppi

cash - Käteinencard - Korttimaksucard_selfservice - Korttimaksu itsepalvelulunchvoucher - Lounassetelivoucher - Lounasseteliepassi - ePassieazybreak - Eazybreakmobilepay - MobilePaymobilepay_selfservice - MobilePay itsepalveluprepaid - Etukäteen maksettuinvoice - Laskutusonly_invoice - Siirto laskulle, ei myyntiäother - Muu velkagiftcard - Lahjakortti

printout_type

Tulostustyyppi

receipt - Kuittino_receipt - Ei kuittiabill - Tositeinvoice - Lasku

tender_use

Maksutavan rajoitus

multiple - Monta maksua kuitillasingle - Vain yksi maksu per kuittionly_this - Ainoa maksutapa

cashdrawer_open

Kassalaatikon avaus

ignore - Ei vaikutustaforce_open - Avaa ainaforce_close - Älä avaa

change_type

Vaihtorahatyyppi

none - Eitender - Anna vaihtorahaaoverpay - Ylijäämäkäsittely

lunchvoucher_type

Lounassetelin tyyppi

none - Eiedenred - Edenred Setelismartum - Smartum Seteligeneric - Yleineneazybreak - Eazybreakedenred_mobile - Edenred Mobiilismartum_mobile - Smartum Mobiili

delivery_type

TAKE_OUTEAT_IN

card_payment_type

eftmobilepaymobilepay_refund

tender_line_type

TENDERCHANGEVOID

pos_action_name

OPEN_DRAWERPRINT_RECEIPTEMAIL_RECEIPTSMS_RECEIPTKITCHEN_PRINT

receipt_origin_type

split

receipt_type

SALESCASH_DROPCLOSE_DAYOPEN_DAYPAID_OUTRECEIVED_ON_ACCOUNTCASHIER_LOGINCASHIER_LOGOUTNO_SALESETTLEMENTPURCHASE_ORDERDELIVERYWASTAGE

receipt_status

voidedvoiding

tendersales_type

TENDER - Tender paymentCHANGE - Change givenVOID - Voided tender

invoice_language

fisven

invoice_receipts_type

allreceipts_onlyproducts_grouped

invoice_type

SALES_INVOICEPURCHASE_ORDERPURCHASE_INVOICE

invoice_status

COLLECTOPENREADYSENTPARTIALCOMPLETEREFUNDEDVOID

dashboard_widget_type

sales-summarytop-productsrecent-transactionsavg-transactioncustomers

dashboard_product_trend

updownstable

dashboard_sort_by

revenuequantity

businessday_event_type

CASHIER_LOGINCASHIER_LOGOUT

stock_transaction_type

INVENTORYDELIVERYUSAGEWASTAGETRANSFERADJUSTMENT

stock_transaction_status

DRAFTPENDINGPROCESSINGCOMPLETEDFAILEDCANCELLED

stock_count_type

FULLPARTIALCYCLESPOT

stock_count_status

DRAFTACTIVECOMPLETEDCANCELLED

stock_transfer_status

DRAFTPENDING_APPROVALAPPROVEDIN_PREPARATIONSHIPPEDIN_TRANSITRECEIVEDCOMPLETEDCANCELLED

stock_transfer_priority

LOWNORMALHIGHURGENT

stock_notification_type

low_stocknegative_stockinventory_variancetransfer_completedcount_session_completeddelivery_receivedcalculation_failedstock_adjustmentlarge_movementexpiry_warning

stock_notification_status

pendingdeliveredfailedcancelled

notification_delivery_method

emailsmswebhookslackpush_notification

attachment_type

Type of attachment

POS_BACKGROUND - Kassan taustakuvaPOS_LOGO - Kassan logoSELFSERVICE_LOGO1 - Kuitin taustakuvaCUSTOMER_DISPLAY - AsiakasnäyttöRECEIPT_LOGO0 - Kuitti [LOGO0]RECEIPT_LOGO1 - Kuitti [LOGO1]RECEIPT_LOGO2 - Kuitti [LOGO2]RECEIPT_LOGO3 - Kuitti [LOGO3]RECEIPT_LOGO4 - Kuitti [LOGO4]RECEIPT_LOGO5 - Kuitti [LOGO5]CASTLES_LOGO0 - Castles KuittiCASTLES_SPLASH - CASTLES SPLASHSELFSERVICE_LOGO2 - Itsepalvelukassan logo 2SELFSERVICE_LOGO3 - Itsepalvelukassan logo 3REPORT_TEMPLATE - RaporttipohjaPLU_IMAGE - TuotekuvaPLU_IMAGE_DEFAULT - Oletus tuotekuvaAREA_MAP - Pöytäkartan taustaINVOICE_LOGO - Laskun logoLAYOUT_IMAGE - Kassanäyttökuva

---

Models

A

30 model(s)

address

Field	Type	Required	Description
line1	string	Required	Address line 1
line2	string	Optional	Address line 2
postnumber	string	Required	Postal code (5 digits)
city	string	Required	City name
country	string?	Optional	Country code

apix_parameters

Field	Type	Required	Description
active	boolean	Optional	Use APIX e-invoice integration
transfer_id	string	Optional	APIX transfer ID
transfer_key	string	Optional	APIX transfer key
api_address	url	Optional	APIX API address (empty = default)

api_token

Field	Type	Required	Description
id	guid	Required	—
company	guid	Required	—
host	string	Required	—
validity_end	date	Required	—
token	string	Optional	—

additional_field

Field	Type	Required	Description
id	guid	Required	Field unique id
name	string	Required	Field name
group	string?	Optional	Group name
type	enum:additional_field_type	Required	Field type
ref	string	Optional	Reference to external system
description	string	Optional	Field description
required	boolean	Optional	Is field required

additional_fields

Field	Type	Required	Description
company	additional_field[]	Optional	Additional fields for company
customer	additional_field[]	Optional	Additional fields for customer
plu	additional_field[]	Optional	Additional fields for plu
dpt	additional_field[]	Optional	Additional fields for dpt
grp	additional_field[]	Optional	Additional fields for grp
location	additional_field[]	Optional	Additional fields for location
pos	additional_field[]	Optional	Additional fields for pos
salesorder	additional_field[]	Optional	Additional fields for sales orders

assortment

Field	Type	Required	Description
not_for_sale	string[]	Required	—
out_of_stock	string[]	Required	—

accounting_data

Field	Type	Required	Description
dummy	string	Optional	—

accounting

has idtable

Field	Type	Required	Description
target_date	date	Required	—
serialnum	number	Required	—
name	string	Required	—
invoice_id	guid	Optional	—
bankaccount_transaction_id	guid	Optional	—
data	accounting_data	Required	—

accounting_item

has idtable

Field	Type	Required	Description
accounting_id	guid	Required	—
accounting_map_id	guid	Required	—
type	string	Required	—
name	string	Required	—
value	amount	Required	—

accounting_map_data

Field	Type	Required	Description
dummy	string	Optional	—

accounting_map

has idtable

Field	Type	Required	Description
parent_map_id	guid	Optional	—
accountnum	int	Required	—
name	string	Required	—
vat_type	string	Required	—
tax_id	int	Required	—
data	accounting_map_data	Required	—

account

Field	Type	Required	Description
account_num	int	Required	—
sign	int	Required	—
vatpct	number	Required	—
description	string	Optional	—

additional_barcode

Field	Type	Required	Description
barcode	string	Required	additional barcode
qty	number	Optional	custom sales quantity for this barcode
price	number	Optional	custom price for this barcode

allergens

Field	Type	Required	Description
cereals_gluten	boolean	Optional	Cereals containing gluten (wheat, rye, barley, oats, spelt, kamut)
crustaceans	boolean	Optional	Crustaceans and products thereof
eggs	boolean	Optional	Eggs and products thereof
fish	boolean	Optional	Fish and products thereof
peanuts	boolean	Optional	Peanuts and products thereof
soybeans	boolean	Optional	Soybeans and products thereof
milk	boolean	Optional	Milk and products thereof (including lactose)
nuts	boolean	Optional	Tree nuts (almonds, hazelnuts, walnuts, cashews, etc.)
celery	boolean	Optional	Celery and products thereof
mustard	boolean	Optional	Mustard and products thereof
sesame	boolean	Optional	Sesame seeds and products thereof
sulphites	boolean	Optional	Sulphur dioxide and sulphites at concentrations >10mg/kg or >10mg/L
lupin	boolean	Optional	Lupin and products thereof
molluscs	boolean	Optional	Molluscs and products thereof

api_token_create_response

API token creation response

Field	Type	Required	Description
id	guid	Required	Token identifier (UUID)
validity_end	date	Required	Token expiration date (YYYY-MM-DD)
host	string	Required	Allowed host for this token
company	guid	Required	Company GUID this token belongs to
token	string	Required	JWT token for API authentication

ai_query_request

AI query request payload

Field	Type	Required	Description
query	string	Required	Natural language query text

ai_query_response

AI query response with result data

Field	Type	Required	Description
response	string	Required	AI text response
outputType	string	Required	Output type: TABLE or CHART
data	any	Required	Result data: HTML table string or ECharts options object

ai_company_info_response

AI service company information

Field	Type	Required	Description
companyId	guid	Required	Company GUID
name	string	Required	Company name
displayName	string	Optional	Display name
ident	string	Optional	Company identifier
locationCount	int	Required	Number of locations
productCount	int	Required	Number of products
salesCount	int	Required	Number of sales records

ai_error_response

AI service error response

Field	Type	Required	Description
error	string	Required	Error code
message	string	Required	Error message
details	string	Optional	Additional error details

arnolds_ingredients_request

Field	Type	Required	Description
file	any	Required	Excel file upload

arnolds_ingredients_response

Field	Type	Required	Description
success	boolean	Required	—
messages	string[]	Required	—
details	any	Required	—

attachment_upload_request

Field	Type	Required	Description
image	any	Required	File upload
ref_type	string	Optional	—

attachment_response

Field	Type	Required	Description
id	string	Required	Attachment GUID

attachment_update_request

Field	Type	Required	Description
data	any	Required	—

alert_request

Field	Type	Required	Description
what	string	Required	—
title	string	Required	—
data	string	Required	—

ack_alert_request

Field	Type	Required	Description
id	string	Required	—

accounting_day_request

Field	Type	Required	Description
id	string	Required	Business day GUID
loc	string	Required	Location GUID

attachment_upload

Upload metadata stored during file upload

Field	Type	Required	Description
head	string	Optional	HTTP header from upload
name	string	Optional	Form field name
type	string	Optional	MIME type
filename	string	Optional	Original filename
tempfile	string	Optional	Tempfile reference (string representation)

attachment_data

Attachment metadata

Field	Type	Required	Description
checksum	string	Required	File checksum (SHA1)
type	string	Required	Attachment type category
upload	attachment_upload	Optional	Upload metadata

attachment

has idhas activetablecompany-scopeddeletable

File attachment for images and documents

Field	Type	Required	Description
filename	string	Required	Original filename
filetype	string	Required	MIME type of the file
ref_guid	guid	Optional	Reference to related entity GUID
ref_type	string	Optional	Type of referenced entity
storage	string	Required	Storage location identifier
data	attachment_data	Required	Attachment metadata

B

14 model(s)

bank_account

Field	Type	Required	Description
bank	string	Required	Bank name
bic	string	Required	Bank Identifier Code (BIC/SWIFT)
iban	string	Required	International Bank Account Number

big_receipt_settings

Settings for large receipt display view

Field	Type	Required	Description
showTable	boolean	Optional	Show table number on receipt
showDelivery	boolean	Optional	Show delivery information
showReceiptName	boolean	Optional	Show receipt name/title
showLineDelivery	boolean	Optional	Show delivery info per line item
showLineVat	boolean	Optional	Show VAT per line item
showLineChair	boolean	Optional	Show chair/seat number per line
showSinglePrice	boolean	Optional	Show unit price for single items
selfService	boolean	Optional	Self-service mode enabled
collapseButton	boolean	Optional	Show collapse/expand button
fontSize	string	Optional	Font size (small, normal, large)

bankaccount_data

Field	Type	Required	Description
dummy	string	Optional	—

bankaccount

has idhas activetable

Field	Type	Required	Description
valid_from	date	Required	—
valid_to	date	Required	—
bic	string	Required	—
iban	string	Required	—
name	string	Required	—
data	bankaccount_data	Required	—

bankaccount_transaction_data

Field	Type	Required	Description
dummy	string	Optional	—

bankaccount_transaction

has idtable

Field	Type	Required	Description
bankaccount_id	string	Required	—
target_date	date	Required	—
payment_date	date	Required	—
bookkeeping_date	date	Required	—
payer	string	Required	—
reference	string	Required	—
amount	amount	Required	—
balance	amount	Required	—
data	bankaccount_transaction_data	Required	—

businessday_data

Custom data for a business day

Field	Type	Required	Description
autogenerate	boolean	Required	—
timesheet_calculated	boolean	Optional	—
external	id	Optional	—

businessday

has idtablecompany-scoped

A business day is a day when the store is open. Usually there is a single businessday per calendar day

Field	Type	Required	Description
pos_id	id	Required	—
name	date	Required	—
open_time	datetime	Required	—
close_time	datetime?	Optional	—
data	businessday_data	Required	—
date_year	int	Required	—
date_quarter	int	Required	—
date_month	int	Required	—
date_week	int	Required	—
date_dow	int	Required	—
date_day	int	Required	—

businessday_op_request

Field	Type	Required	Description
id	string	Required	Business day GUID
loc	string	Required	Location GUID
op	string	Required	Operation: merge_sales, remove_day

businessday_cash

Field	Type	Required	Description
beginCash	number	Required	cash in drawer at the beginning of day
endCash	number	Required	cash in drawer at the end of day
cashDrops	number	Required	cash reconciled from drawer
paidOuts	number	Required	cash paid out

businessday_grp_sales

Field	Type	Required	Description
grp_num	number	Required	group number
id	string	Required	group id
name	string	Required	group name
qty	string	Required	quantity sold
total	string	Required	total sales

businessday_tax_sales

Field	Type	Required	Description
tax_num	number	Required	tax number
name	string	Required	tax name
netsales	string	Required	net sales
total	string	Required	total sales

businessday_event

Field	Type	Required	Description
type	enum:businessday_event_type	Required	type of event
cashier_id	guid	Required	cashier id
timestamp	string	Required	timestamp of event
cashier_name	string	Required	cashier name

businessday_report

Field	Type	Required	Description
id	guid	Required	Unique identifier for this businessday
name	string	Required	Date of the businessday, YYYY-MM-DD
data	businessday_data	Required	—
businessdays	guid	Required	Day name -> guid mapping for the week
cash	businessday_cash	Required	cash reports
grp_sales	businessday_grp_sales[]	Required	group sales
tax_sales	businessday_tax_sales[]	Required	tax sales
cashdrop_receipts	guid[]	Required	??
paidout_receipts	guid[]	Required	??
open_receipt	guid	Required	open receipt
close_receipt	guid	Required	close receipt
customers	number	Required	number of customers
next	guid	Optional	Id of the next businessday
prev	guid	Optional	Id of the previous businessday
openTime	string	Required	Time when the businessday was opened
closeTime	string	Required	Time when the businessday was closed
plu_count	number	Required	number of plu sold
sales	number	Required	total sales without taxes
totalsales	number	Required	total sales with taxes
events	businessday_event[]	Required	special transactions
externals	external[]	Required	external transfers

C

42 model(s)

contract_invoice_data

Field	Type	Required	Description
dummy	string	Optional	—

contract_invoice

has idtable

Field	Type	Required	Description
company_id	guid	Required	—
contract_id	guid	Required	—
type	string	Required	—
target_date	string	Required	—
reference	string	Required	—
data	contract_invoice_data	Required	—

contract_data

Field	Type	Required	Description
contract_type	string	Required	—
our_ref	string	Required	—
qty	number	Required	—

contract

has idhas activetablecompany-scoped

Field	Type	Required	Description
valid_from	string	Required	—
valid_to	string	Required	—
name	string	Required	—
data	contract_data	Required	—

contract_type

Field	Type	Required	Description
id	guid	Required	—
code	string	Required	—
name	string	Required	—
period	string	Required	—
billingperiod	string	Required	—
price	number	Required	—

company_weeklyreport_parameters

Field	Type	Required	Description
refnum	string	Optional	Reference number for weekly reports

company_externals

Field	Type	Required	Description
id	string	Required	Unique id
location	guid	Optional	—
prequisites	string	Optional	—
schedule	string	Optional	—
title	string	Optional	—
type	string	Optional	—
voucherclass	string	Optional	—
voucherlines	voucher_line[]	Optional	—
calculationmode	string	Required	—
description	string	Optional	—
dimensions	external_dimension[]	Required	—
generator_class	string	Required	—
remove_empty_lines	boolean	Optional	Remove empty lines from voucher

customer_group_data

Field	Type	Required	Description
set_taxtype	boolean	Optional	—
taxtype	number_or_string	Optional	—

customer_group

Field	Type	Required	Description
id	guid	Required	—
active	boolean	Required	—
name	string	Required	—
data	customer_group_data	Optional	—

company_data

Field	Type	Required	Description
type	enum:company_type	Optional	—
root	boolean	Optional	is root company
reseller	boolean	Optional	is reseller company
address	address	Optional	—
weekly	company_weeklyreport_parameters	Optional	—
netvisor	netvisor_parameters	Optional	—
procountor	procountor_parameters	Optional	—
fennoa	fennoa_parameters	Optional	—
apix	apix_parameters	Optional	—
ecommerce	ecommerce_parameters	Optional	—
nyx	nyx_parameters	Optional	—
shopify	shopify_parameters	Optional	—
woocommerce	woocommerce_parameters	Optional	—
externals	company_externals[]	Optional	—
invoice	invoice_parameters	Optional	—
timesheets	timesheet_parameters	Optional	Timesheet tracking configuration
display_name	string	Required	Company display name
group	string	Optional	Company grouping
customergroups	customer_group[]	Optional	—
kitchenprinter	string[]	Optional	—
receipt_layouts	pos_receipt_layout_data[]	Optional	—
email_reports	email_report_settings	Optional	—
card_contractsdeprecated	any	Optional	—
franchising	franchising_parameters	Optional	—
only_inherited_products	boolean	Optional	Use only inherited products from parent company
contracts	contract_type[]	Optional	—
default_tags	string[]	Required	Default tags for products
dimensions	dimension_data[]	Optional	—
contact	string	Optional	Primary contact person
phone	string	Optional	Company phone number
admin_name	string	Optional	Administrator name
admin_email	string	Optional	Administrator email address
giftcard	giftcard_data	Optional	Gift card configuration
product_numbering	string	Optional	Product numbering template
reuse_product_numbers	boolean	Optional	Allow reuse of inactive product numbers
version	number	Optional	Company data version
pos_name	string	Optional	Default POS name for company creation
location_name	string	Optional	Default location name for company creation
stock_value_typedeprecated	enum:stock_value_type	Optional	Stock valuation method (purchase_price, running_average, fifo)
invdiff_reportdeprecated	enum:invdiff_report	Optional	Inventory difference report mode (none, if_available, mandatory)
api_tokens	api_token[]	Optional	—
receipthero_active	boolean	Optional	Use Receipt Hero integration
additional_fields	additional_fields	Optional	Additional fields used by this company
sales_channels	sales_channel[]	Optional	Sales channels used by this company
languages	string[]	Optional	Available languages for translations (e.g., ["en", "sv"]). Finnish is always the default source language.
internal	any	Optional	—
hide_invoice_number_in_attachments	boolean	Optional	Hide invoice number in PDF attachments sent via email

company_big_data

Field	Type	Required	Description
dimensions	dimension_data[]	Optional	—
receipt_layouts	pos_receipt_layout_data[]	Optional	—

company

has idhas activetable

Field	Type	Required	Description
name	string	Required	—
ident	string	Required	—
parent_id	id	Optional	—
data	company_data	Required	—
sales_history	sales_history	Optional	—
state	string	Required	—
bigdata	company_big_data?	Optional	—

companyextended

has idhas activetable

Field	Type	Required	Description
name	string	Required	—
ident	string	Required	—
parent_id	id	Optional	—
data	company_data	Required	—
sales_history	sales_history	Optional	—
state	string	Required	—
bigdata	company_big_data?	Optional	—
type	enum:companytree_type	Optional	—
children	any[]	Optional	—
locations	any[]	Optional	—

customer_token

Field	Type	Required	Description
type	enum:token_type	Required	token type
data	any	Required	token value

customer_billing

Field	Type	Required	Description
address1	string	Required	Customer address
address2	string	Optional	Customer address
postcode	string	Required	Postal code
city	string	Required	City name
country	string	Optional	Country code
phone	string	Optional	Customer phone number
email	email	Optional	Customer email address
email_invoicingdeprecated	string	Optional	Customer email address

customer_finvoice

Field	Type	Required	Description
address	string?	Optional	Finvoice address
operator	string?	Optional	Finvoice operator

customer_data

Field	Type	Required	Description
blocked	boolean	Optional	—
can_invoice	boolean	Optional	—
is_companydeprecated	boolean	Optional	—
groups	guid[]	Optional	—
customergroup	guid	Optional	—
language	string	Optional	—
name	string	Required	Customer name
additional_name	string	Optional	Customer additional name
type	enum:customer_type	Required	Company or individual person
ident	string	Optional	Customer company identifier
contact_name	string	Optional	Customer contact person
our_ref	string	Optional	Our reference
your_ref	string	Optional	Customer reference
billing	customer_billing	Required	Customer billing information
finvoice	customer_finvoice	Optional	Customer finvoice information
payment_term	enum:payment_terms	Required	Payment terms
notes	string?	Optional	Internal notes about customer
invoice_type	enum:customer_invoice_type	Required	Type of invoice
invoice_sending	enum:send_type	Required	Invoice sending route
receipts_and_products	enum:receipts_and_products	Required	Invoice row types
tokens	customer_token[]	Optional	Customer identification tokens
discounts	guid[]	Optional	Customer discounts
pricing	guid	Optional	Customer special pricing
forbid_sales	boolean	Optional	—
ask_reference	boolean	Optional	Ask reference text at sales
is_default	boolean	Optional	—
ext_id	external_id[]	Optional	—
additional_fields	string	Optional	Additional fields

customer

has idhas activetablecompany-scoped

Field	Type	Required	Description
customer_num	number	Required	Customer unique number
data	customer_data	Required	—

coordinates

Field	Type	Required	Description
lat	number	Optional	—
lon	number	Optional	—

campaign_period

Reference period for campaign performance comparison

Field	Type	Required	Description
start_date	date	Required	Period start date for comparison analysis
end_date	date	Required	Period end date for comparison analysis
weight	number_or_string	Required	Weight factor for this reference period in calculations

campaign_discount

Discount configuration for campaign promotions

Field	Type	Required	Description
discount_id	string?	Required	ID of the discount to apply during campaign
is_coupon	boolean	Optional	Whether this discount is automatic or manual (coupon)
start_date	string	Required	Discount validity start date, must be within campaign period
end_date	string	Required	Discount validity end date, must be within campaign period

campaign_report_dpt

Department filter for campaign reporting

Field	Type	Required	Description
dpt_id	guid?	Required	Department ID to include in campaign reports

campaign_report_plu

Product filter for campaign reporting

Field	Type	Required	Description
plu_id	guid?	Required	Product ID to include in campaign reports

campaign_data

Campaign configuration data and settings

Field	Type	Required	Description
discounts	campaign_discount[]	Required	List of discounts associated with this campaign
reference_periods	campaign_period[]	Required	Historical periods for performance comparison
report_dpts	campaign_report_dpt[]	Required	Departments to include in campaign reports
report_plus	campaign_report_plu[]	Required	Products to include in campaign reports
notes	string	Optional	Additional notes and comments about the campaign

campaign

has idhas activetablecompany-scoped

Marketing campaigns with promotions, targeting, and performance tracking

Field	Type	Required	Description
location_id	id	Optional	Location where campaign is active (null for all locations)
name	string	Required	Campaign name and title
start_date	date	Required	Campaign start date
end_date	date	Optional	Campaign end date (null for ongoing campaigns)
data	campaign_data	Required	Campaign configuration, targeting, and reporting settings

cashier_data

Field	Type	Required	Description
training	boolean	Optional	Training user
manager	boolean	Optional	Manager privileges
password	string	Optional	User password (hashed)
company_ident	string	Optional	Company identifier, if user is company
layout_page	number	Optional	Layout page to select on login
pos_language	string	Optional	User language
pos_layout	guid	Optional	—
selfservice	boolean	Optional	use self-service features in pos
cardnumber	string	Optional	cashier login card number
netvisor_worker_id	string	Optional	timesheet worker id
additional_fields	string	Optional	Additional fields

cashier

has idhas activetablecompany-scoped

Field	Type	Required	Description
cashier_num	int	Required	cashier number
location_id	id	Optional	—
name	string	Required	cashier name
password	string?	Optional	User password (hashed)
data	cashier_data	Required	—
sales_history	sales_history?	Optional	—

customerdisplay_config

Field	Type	Required	Description
show_welcome	boolean	Required	—

customerdisplay_element

Field	Type	Required	Description
id	guid	Required	—
type	string	Required	—
image_id	guid	Optional	—
text	string	Optional	—
effect	enum:customerdisplay_effect_type	Required	—
effect_duration	int	Optional	—

customerdisplay_view_item

Field	Type	Required	Description
element	guid	Required	—
duration	int	Required	—
transition	enum:customerdisplay_transition_type	Required	—

customerdisplay_view

Field	Type	Required	Description
layout	enum:customerdisplay_layout_type	Required	—
items	customerdisplay_view_item[]	Required	—
randomize	boolean	Required	—

customerdisplay_schedule_item

Field	Type	Required	Description
dummy	string	Optional	—

customerdisplay_schedule

Field	Type	Required	Description
dummy	string	Optional	—

customerdisplay_data

Field	Type	Required	Description
views	customerdisplay_view[]	Required	—
elements	customerdisplay_element[]	Required	—
schedule	customerdisplay_schedule[]	Required	—
config	customerdisplay_config	Required	—
default_posclosed	guid[]	Required	—
default_posopen	guid[]	Required	—
default_receiptopen	guid[]	Required	—
default_sales	guid[]	Required	—
default_subtotal	guid[]	Required	—
default_payment	guid[]	Required	—
default_receiptclose	guid[]	Required	—

customerdisplay

has idhas activetablecompany-scoped

Field	Type	Required	Description
name	string	Required	—
data	customerdisplay_data	Required	—

card_payment

Field	Type	Required	Description
type	enum:card_payment_type	Optional	—
batchId	string	Optional	—
terminalTransId	string	Optional	—
authNumber	string	Optional	—
cardNumber	string	Optional	—
cardName	string	Optional	—
archiveId	string	Optional	—
entryMethod	string	Optional	—
verification	string	Optional	—
customerReceipt	string	Required	—
controlReceipt	string	Optional	—
aid	string	Optional	—
tvr	string	Optional	—
tsi	string	Optional	—
terminalName	string	Optional	—
terminalBatch	string	Optional	—
attributes	any	Optional	—

cardbatch_data

Field	Type	Required	Description
count	number	Optional	—

cardbatch

has idtablecompany-scoped

Field	Type	Required	Description
pos_id	id	Optional	—
name	string	Required	—
open_time	datetime	Optional	—
close_time	datetime	Optional	—
type	string	Required	—
reference	string	Required	—
total	number	Required	—
accounted	number	Required	—
data	cardbatch_data	Required	—

cardpayment_data

Field	Type	Required	Description
aid	string?	Optional	—
tsi	string?	Optional	—
tvr	string?	Optional	—
card_name	string	Required	—
attributes	any?	Optional	—
batch_type	string?	Optional	—
auth_number	string?	Optional	—
card_number	string?	Optional	—
entry_method	string?	Optional	—
verification	string?	Optional	—
terminal_name	string?	Optional	—
pos_entry_mode	string?	Optional	—
terminal_batch	string	Required	—
control_receipt	string	Required	—
customer_receipt	string?	Optional	—

cardpayment

has idtablecompany-scoped

Field	Type	Required	Description
pos_id	id	Optional	—
batch_id	id	Optional	—
tendersales_id	id	Optional	—
receipt_num	int	Required	—
timestamp	datetime	Required	—
transactionid	string	Required	—
archiveid	string	Required	—
cancelled	boolean	Optional	—
original_transactionid	string	Required	—
reference	string	Required	—
amount_in	number	Required	—
amount_out	number	Required	—
data	cardpayment_data	Required	—

chainstatus_response

Field	Type	Required	Description
reports	any[]	Required	—

cashier_password_request

Field	Type	Required	Description
pwd	string	Required	New password

D

29 model(s)

dimension_details

Field	Type	Required	Description
fennoakey	string	Optional	—
name	string	Optional	—
level	string	Optional	—
is_hidden	boolean	Optional	—
sort	string	Optional	—
end_sort	string	Optional	—
father_id	string	Optional	—
code	string	Optional	—

dimension_data

Field	Type	Required	Description
fennoakey	string	Optional	—
netvisorkey	string	Optional	—
code	string	Required	—
name	string	Required	—
is_hidden	boolean	Optional	—
details	dimension_details[]	Required	—
end_sort	string	Optional	—
father_id	string	Optional	—
level	string	Optional	—
parent_name	string	Optional	—
sort	string	Optional	—

daily_time_slot

Field	Type	Required	Description
id	guid	Required	—
template_id	guid	Optional	—
start_time	string	Required	—
end_time	string	Required	—
description	string	Required	—

daily_hours

Field	Type	Required	Description
open_time	string	Optional	—
close_time	string	Optional	—
is_closed	boolean	Optional	—
time_slots	daily_time_slot[]	Optional	—

dashboard_widget

Field	Type	Required	Description
id	string	Required	—
x	int	Required	—
y	int	Required	—
width	int	Required	—
height	int	Required	—
componentName	string	Required	—
settings	any	Optional	—

dashboard_settings

Field	Type	Required	Description
width	int	Required	—
height	int	Required	—
name	string	Optional	—
description	string	Optional	—
updateFrequency	int	Optional	—
widgets	any[]	Required	—

discountline_discount

Field	Type	Required	Description
type	enum:discount_line_type	Required	—
amount	number?	Required	—

discount_salesline

Field	Type	Required	Description
dpt	number_or_string[]	Optional	—
plu	number_or_string[]	Optional	—
grp	string[]	Optional	—
delivery	enum:delivery_type	Optional	—
discount	discountline_discount	Optional	—
bundling	boolean	Optional	—
order	enum:discount_order	Optional	—
optional	boolean	Optional	—

discount_sellline

Field	Type	Required	Description
productId	string	Optional	—
productGuid	guid	Optional	—
qty	number	Required	—

discount_match

Field	Type	Required	Description
order	enum:discount_order	Optional	—
apply	string	Optional	—
salesLines	discount_salesline	Required	—
sell	discount_sellline[]	Optional	—

discount_invoicing

Field	Type	Required	Description
active	boolean	Required	—
customer_id	guid	Required	—
discount_price_type	enum:discount_line_type	Required	—
invoice_amount	amount	Required	—

discount_data

Field	Type	Required	Description
description	string	Optional	—
notes	string	Optional	—
weekreport	boolean	Optional	—
valid_from	date	Optional	—
valid_to	date	Optional	—
discount_type	enum:discount_type	Optional	—
manual	boolean	Optional	—
target	enum:discount_target	Optional	—
percent	discount_ask?	Optional	—
priority	number?	Optional	—
amount	discount_ask?	Optional	—
match	discount_match?	Optional	—
tender_id	string	Optional	—
subscription_type	enum:subscription_type	Optional	—
invoicing	discount_invoicing	Optional	—
time_restriction	string	Optional	—
hide_on_receipt	boolean	Optional	Piilota kuitilta
additional_fields	string	Optional	Additional fields

discount

has idhas activetablecompany-scoped

Field	Type	Required	Description
name	string	Required	—
discount_code	string	Required	—
data	discount_data	Required	—
sales_history	sales_history?	Optional	—

dpt_data

Field	Type	Required	Description
sales_dpt	boolean	Optional	—
stock_dpt	boolean	Optional	—
ex_sale	boolean	Optional	—
fin_rep	boolean	Optional	—
default_tax	number_or_string	Optional	—
color	string	Optional	—
foreground_color	string	Optional	—
margin	number_or_string	Optional	—
kitchenprinter	boolean	Optional	—
description	string	Optional	Department description for menu exports
image_url	string	Optional	Image URL for department/category
sort_order	number	Optional	Display order in menu exports
accounting	account	Optional	—
ext_id	external_id[]	Optional	—
additional_fields	string	Optional	Additional fields

dpt

has idhas activetablecompany-scoped

Field	Type	Required	Description
dpt_num	number	Required	Unique number for this department
grp_id	id?	Required	Main group that is department belongs to
name	string	Required	—
data	dpt_data	Required	—
sales_history	sales_history?	Optional	—

discount_line

Field	Type	Required	Description
manual	boolean	Optional	—
id	string	Optional	—
name	string	Optional	—
type	string	Optional	—
amount	amount	Optional	—
originalAmount	amount	Optional	—
bundlable	boolean	Optional	—
qty	number	Optional	—
productsPerDiscount	int	Optional	—
infocodes	receipt_infocode[]	Optional	—

delivery_order_item

Field	Type	Required	Description
plu_id	guid	Required	—
qty	number	Required	—
unit	string	Required	—
cost	number	Optional	—
count	number	Optional	—
value	number	Optional	—

delivery_order

Field	Type	Required	Description
id	guid	Required	—
supplier_id	guid	Required	—
items	delivery_order_item[]	Required	—

delivery_data

Field	Type	Required	Description
order	delivery_order	Required	—

discountsales

table

Field	Type	Required	Description
company_id	id	Required	—
pos_id	id	Required	—
discount_id	id	Required	—
businessday_id	id	Required	—
plusales_id	id	Optional	—
receipt_num	int	Required	—
timestamp	datetime	Required	—
amount	amount	Required	—
original_amount	amount	Required	—
qty	number	Required	—
sales_type	string	Required	E.g. null or INVOICE
sales_id	id	Required	—

dashboard_widget_request_item

Field	Type	Required	Description
id	string	Required	Widget instance ID
componentName	string	Required	Widget type
settings	dashboard_widget_settings	Optional	Widget settings

dashboard_widgets_request

Dashboard widgets data request - batch request for multiple widgets

Field	Type	Required	Description
widgets	dashboard_widget_request_item[]	Required	Array of widget configurations to fetch data for

dashboard_widget_response_item

Single widget data response

Field	Type	Required	Description
success	boolean	Required	Whether the widget data fetch succeeded
data	any	Optional	Widget-specific data payload
error	string	Optional	Error message if failed
error_type	string	Optional	Error type/class name

dashboard_widget_settings

Common widget settings

Field	Type	Required	Description
startDate	date	Optional	Start date for period
endDate	date	Optional	End date for period
startTime	string	Optional	Start time (HH:MM:SS)
endTime	string	Optional	End time (HH:MM:SS)
showComparison	boolean	Optional	Show previous period comparison
limit	int	Optional	Number of items to return
sortBy	string	Optional	Sort by: revenue or quantity
showRevenue	boolean	Optional	—
count	int	Optional	Number of transactions
locationFilter	guid	Optional	Filter by location GUID
period	string	Optional	Period label for display

dashboard_sales_summary_data

Sales summary widget data

Field	Type	Required	Description
totalSales	number	Required	Total sales amount
previousSales	number	Required	Previous period sales
transactionCount	int	Required	Number of transactions
previousTransactionCount	int	Required	—
customerCount	int	Required	—
previousCustomerCount	int	Required	—
averageTransaction	number	Required	—
previousAverageTransaction	number	Required	—

dashboard_top_product_item

Field	Type	Required	Description
rank	int	Required	—
name	string	Required	—
category	string	Required	—
quantity	int	Required	—
revenue	number	Required	—
trend	enum:dashboard_product_trend	Required	—

dashboard_recent_transaction_item

Field	Type	Required	Description
id	guid	Required	—
receiptNumber	string	Required	—
timestamp	datetime	Required	—
location	string	Required	—
total	number	Required	—
paymentMethod	string	Required	—
itemCount	int	Required	—
cashier	string	Required	—
isVoided	boolean	Required	—

dashboard_metric_data

Simple metric widget data (avg-transaction, customers)

Field	Type	Required	Description
value	number	Required	Current period value
change	number	Required	Percentage change from previous period
period	string	Required	Period label

dashboard_widget_result

Field	Type	Required	Description
success	boolean	Required	—
data	any	Optional	Widget-specific data on success
error	string	Optional	Error message on failure
error_type	string	Optional	—

E

8 model(s)

external_id

Field	Type	Required	Description
id	string	Required	External system ID
data	any	Required	External system data
system	string	Required	External system name

ecommerce_parameters

Field	Type	Required	Description
enable	boolean	Optional	Enable e-commerce integration
api_url	string	Optional	E-commerce API URL
api_key	string	Optional	E-commerce API key
api_secret	string	Optional	E-commerce API secret
customergroup	guid	Optional	Customer group for e-commerce customers
prepaid_tender	guid	Optional	Tender for prepaid orders

external_dimension

Field	Type	Required	Description
name	string	Required	—
item	string	Required	—

email_report_settings

Field	Type	Required	Description
active	boolean	Optional	Enable email reporting
daily_emails	string	Optional	Email addresses for daily reports

event

tablecompany-scoped

Field	Type	Required	Description
type	string	Required	—
object_guid	guid	Required	—
timestamp	datetime	Required	—
pos_id	id	Optional	—
user_id	id	Optional	—
value	string	Required	—

external_data

Additional data for external API request/response

Field	Type	Required	Description
dummy	string	Optional	—

external

has idtablecompany-scoped

External API request/response

Field	Type	Required	Description
location_id	guid	Optional	Location of the request
pos_id	guid	Optional	POS that made the request
target	string	Optional	Target of the request, date or guid
timestamp	string	Required	Time when the request was made
type	string	Required	Type of the request
status	enum:external_status	Required	Status of the request
request	string	Required	Request data
response	string	Required	Response data
data	external_data	Required	Additional data

external_image_request

Field	Type	Required	Description
url	string	Required	—
plu_id	string	Required	—

F

4 model(s)

fennoa_parameters

Field	Type	Required	Description
active	boolean	Optional	Use Fennoa integration
customer_iddeprecated	string	Optional	—
customer_keydeprecated	string	Optional	—
user	string	Optional	Fennoa API username
pass	string	Optional	Fennoa API password
max_rounding	number_or_string	Optional	Max acceptable rounding in cents
sales_transfer	string	Optional	Sales transfer mode (manual, daily, weeklyreport)
inventory_transfer	string	Optional	Inventory transfer mode (manual, inventory)
statement_series_code	string	Optional	Statement series code for vouchers
sync	sync_settings	Optional	—

franchising_fee

Field	Type	Required	Description
name	string	Required	Fee name
type	string	Required	Fee calculation basis (turnover, part_turnover, profit)
account	number_or_string	Required	Account number for fee posting
percent	number_or_string	Required	Fee percentage
valid_from	string	Optional	Fee validity start date
valid_to	string	Optional	Fee validity end date

franchising_parameters

Field	Type	Required	Description
active	boolean	Required	Enable franchising
payment_account	string	Optional	IBAN account for franchise payments
root_company	string	Optional	Root company name for franchise payments
root_company_id	string	Optional	Root company business ID (Y-tunnus)
fees	franchising_fee[]	Optional	Franchising fee structure

flags

Field	Type	Required	Description
askprice	boolean	Optional	ask price on sale
kitchenprinter	boolean	Optional	print to kitchen printer
kitchenprinter2	boolean	Optional	print to kitchen printer 2
kitchenprinter3	boolean	Optional	print to kitchen printer 3
nosell	boolean	Optional	not sellable
nobuy	boolean	Optional	not purchasable
kitcheninfo	boolean	Optional	ask kitchen info
no_discount	boolean	Optional	no discounts allowed
no_price_on_receipt	boolean	Optional	do not print price on receipt
not_on_receipt	boolean	Optional	do not print this item on receipt
no_group	boolean	Optional	do not group this item on receipt
no_customer_display	boolean	Optional	do not show item on customer display
linked_item	boolean	Optional	this is a linked item
alcohol	boolean	Optional	age restricted alcohol item
no_creditcard	boolean	Optional	do not allow credit card payments for this item
modifier	boolean	Optional	this item is a modifier
pack_price	boolean	Optional	this item has pack pricing
giftcard	boolean	Optional	this item is a gift card
start_meal_definition	boolean	Optional	this item starts a meal definition
no_dpt_button	boolean	Optional	do not show this item on dpt button layout
scale	boolean	Optional	scale product
time_based_price	boolean	Optional	time based pricing
betting	boolean	Optional	Interface to Veikkaus "Elite-S" machine
used_in_app	boolean	Optional	this item is used in mobile app ordering (proprietary

G

3 model(s)

giftcard_data

Field	Type	Required	Description
active	boolean	Optional	Enable gift card functionality
numbering	string	Optional	Gift card numbering template

grp_data

Field	Type	Required	Description
sales_grp	boolean	Optional	true if contains sales departments
stock_grp	boolean	Optional	true if contains stock departments
description	string	Optional	Group description for menu exports
image_url	string	Optional	Image URL for group/category
sort_order	number	Optional	Display order in menu exports
ext_id	external_id[]	Optional	—
additional_fields	string	Optional	Additional fields

grp

has idhas activetablecompany-scoped

Field	Type	Required	Description
grp_num	int	Required	unique number of this group
name	string	Required	name of this group
data	grp_data	Required	—
sales_history	sales_history?	Optional	—

H

3 model(s)

help_text

has idtable

Field	Type	Required	Description
name	string	Required	—
lang	string	Required	—
helptext	string	Required	—

hourlysalesrequest

Field	Type	Required	Description
poslist	string[]	Required	—
date_from	date	Required	—
date_to	date	Required	—

hourlysalesresponse

Field	Type	Required	Description
date_from	date	Required	—
date_to	date	Required	—

I

18 model(s)

interval

Field	Type	Required	Description
valid_from	string	Optional	Validity start date
valid_to	string	Optional	Validity end date

invoice_parameters

Field	Type	Required	Description
banks	bank_account[]	Required	Bank accounts for invoice payments
home_city	string	Optional	Company home city for invoice
contact_email	email	Optional	Invoice contact email address
contact_person	string	Optional	Invoice contact person name
contact_phone	string	Optional	Invoice contact phone number
interest	number	Optional	Late payment interest rate (percentage)
overdue_fee	number	Optional	Overdue fee amount
title1	string	Optional	Invoice title line 1
title2	string	Optional	Invoice title line 2
title_type	string	Optional	Invoice title type (logo, logo_and_text, text_only, none)
pdf_type	string	Optional	Invoice PDF template type

infocode_data

Field	Type	Required	Description
subscription_type	string	Required	—
prompt	string	Required	—
description	string	Required	—
input_type	enum:infocode_input_type	Required	—
data	string	Optional	—
validation	enum:infocode_validation_type	Optional	—
frequency	string	Optional	—
once_per_receipt	boolean	Optional	—
priority	number	Optional	—
printing	enum:infocode_printing_type	Optional	—
link	string	Optional	—
default	string	Optional	—
plu_id	guid	Optional	—
dpt_id	guid	Optional	—
grp_id	guid	Optional	—
tender_id	guid	Optional	—
additional_fields	string	Optional	Additional fields

infocode

has idhas activetablecompany-scoped

Field	Type	Required	Description
name	string	Required	—
type	enum:infocode_type	Required	—
data	infocode_data	Required	—

infocodeuses

table

Field	Type	Required	Description
company_id	id	Required	—
pos_id	id	Required	—
infocode_id	id	Required	—
businessday_id	id	Required	—
receipt_num	number	Required	—
timestamp	datetime	Required	—
target	string	Required	—
value	string	Required	—
plusaless_id	id	Optional	—
tendersales_id	id	Optional	—
discountsales_id	id	Optional	—

invoice_purchase_list

Field	Type	Required	Description
sku	string	Required	—
ean	string	Required	—
qty	number	Required	—
batch_name	string	Required	—
batch_size	number	Required	—
batch_value	number	Required	—

invoice_item_data

Field	Type	Required	Description
supply	invoice_purchase_list[]	Optional	—
receipt_id	guid	Optional	—

invoice_item

table

Field	Type	Required	Description
linenum	int	Required	—
dpt_id	id	Optional	—
plu_id	id	Optional	—
tax_id	id	Optional	—
qty	number_or_string	Required	—
price	number_or_string	Required	—
total	number_or_string	Required	—
profit	number_or_string	Required	—
description	string	Optional	—
price_with_tax	number_or_string	Required	—
total_with_tax	number_or_string	Required	—
data	invoice_item_data	Required	—

invoice_sales_receipt

Field	Type	Required	Description
id	guid	Required	—
pos_id	guid	Required	—
timestamp	datetime	Required	—
cashier	guid	Optional	—
receipt_num	int	Required	—

invoice_payment

Field	Type	Required	Description
payment_date	date	Optional	—
account_date	date	Required	—
amount	amount	Required	—
payment_id	string	Optional	—
account	string	Optional	—
archive_id	string	Optional	—
reference	string	Required	—
name	string	Optional	—

invoice_external

Field	Type	Required	Description
netvisor_key	int	Optional	—

invoice_data

Field	Type	Required	Description
version	int	Optional	—
language	enum:invoice_language?	Optional	—
sales_receipts	invoice_sales_receipt[]	Optional	—
receipts_and_products	enum:invoice_receipts_type	Optional	—
payments	invoice_payment[]	Optional	—
ext_id	external_id[]	Optional	—
your_ref	string	Optional	—
our_ref	string	Optional	—
notes	string	Optional	—
additional_fields	string	Optional	Additional fields
external	invoice_external	Optional	—

invoice

has idhas activetablecompany-scoped

Field	Type	Required	Description
location_id	id	Required	—
customer_id	id	Optional	—
supplier_id	id?	Optional	—
type	enum:invoice_type	Required	—
invoice_num	int	Required	unique number of this invoice
status	enum:invoice_status	Required	—
invoice_date	date?	Optional	—
due_date	date?	Optional	—
entry_date	date?	Optional	—
payment_date	date?	Optional	—
reference	string?	Optional	—
data	invoice_data	Required	—
items	invoice_item[]	Required	—
salesorders	salesorder[]	Optional	—

invoice_status_customer_invoice

Field	Type	Required	Description
name	string	Required	Customer name
invoice_num	int	Required	Invoice number
invoice_date	date	Required	Invoice date
total	amount	Required	Total amount without tax
total_with_tax	amount	Required	Total amount with tax

invoice_status_customer_total

Field	Type	Required	Description
name	string	Required	Customer name
count	int	Required	Number of invoices
total	amount	Required	Total amount without tax
total_with_tax	amount	Required	Total amount with tax

invoice_status_monthly_sale

Field	Type	Required	Description
d	int	Required	Month offset from current date (0 = current month)
dd	date	Required	Date representing the month
count	int	Required	Number of invoices
total	amount	Required	Total amount without tax
total_with_tax	amount	Required	Total amount with tax

invoice_status_response

Invoice status summary and statistics

Field	Type	Required	Description
invoices_collecting	invoice_status_customer_invoice[]	Required	List of invoices in COLLECT status
invoices_ready	invoice_status_customer_invoice[]	Required	List of invoices in READY status
invoices_sent	invoice_status_customer_invoice[]	Required	List of invoices in SENT status
invoices_overdue	invoice_status_customer_invoice[]	Required	List of overdue invoices
total_collecting	invoice_status_customer_total[]	Required	Totals by customer for COLLECT status invoices
total_ready	invoice_status_customer_total[]	Required	Totals by customer for READY status invoices
total_sent	invoice_status_customer_total[]	Required	Totals by customer for SENT status invoices
total_overdue	invoice_status_customer_total[]	Required	Totals by customer for overdue invoices
monthly_sales	invoice_status_monthly_sale[]	Required	Monthly sales data for the past 12 months

inventory_excel_request

Field	Type	Required	Description
file	any	Required	Excel file upload
location	string	Required	Location GUID
date	date	Optional	—
month	string	Optional	—

L

19 model(s)

location_data_table_wall

Field	Type	Required	Description
id	string	Required	—
x	number	Required	—
y	number	Required	—
w	number	Required	—
h	number	Required	—
rotation	number	Required	—
color	string	Optional	—
type	string	Optional	—

location_data_table

Field	Type	Required	Description
id	guid	Required	—
name	string	Required	—
seats	number	Required	—
shape	string	Required	—
x	number	Required	—
y	number	Required	—
w	number	Required	—
h	number	Required	—
rotation	number	Required	—
color	string	Optional	—
seats_top	number	Required	—
seats_left	number	Required	—
seats_right	number	Required	—
seats_bottom	number	Required	—
opacity	number	Optional	—

location_data_table_area

Field	Type	Required	Description
name	string	Required	—
walls	location_data_table_wall[]	Required	—
tables	location_data_table[]	Required	—
image	string	Optional	—

location_data_tables

Field	Type	Required	Description
areas	location_data_table_area[]	Required	—
use_map	boolean	Optional	—

location_data_pos

Field	Type	Required	Description
default_delivery	string	Required	—
background_image_url	string	Optional	—
logo_image_url	string	Optional	—

location_email_report

Field	Type	Required	Description
active	boolean	Optional	—
daily_emails	string	Optional	—
weekly_emails	string	Optional	—
weekly_report_day	string	Optional	—
include_comparisons	boolean	Optional	—
include_recommendations	boolean	Optional	—
pdf_attachment	boolean	Optional	—

location_data_table_map_area

Field	Type	Required	Description
name	string	Required	—
items	location_data_table[]	Required	—

location_data_table_maps

Field	Type	Required	Description
maximumAmountOfTables	number	Required	—
areas	location_data_table_map_area[]	Required	—

location_stock_settings

Stock v2 settings for a location

Field	Type	Required	Description
auto_update_stock	boolean	Optional	Automatically update stock levels on transactions (deliveries, wastage, transfers)
low_stock_threshold	number	Optional	Threshold for low stock alerts
negative_stock_allowed	boolean	Optional	Allow stock to go negative
inventory_reminder_days	number	Optional	Days between inventory reminder notifications
wastage_approval_required	boolean	Optional	Require approval for wastage transactions
transfer_auto_complete	boolean	Optional	Auto-complete transfers after shipping
delivery_auto_receive	boolean	Optional	Auto-receive deliveries after saving
cost_calculation_method	string	Optional	Cost calculation method: fifo, average, last, manual
notification_email	string	Optional	Email for stock notifications

location_data

Field	Type	Required	Description
address	address	Optional	—
position	position	Optional	—
email	email	Optional	—
phone	string	Optional	—
ext_id	external_id[]	Optional	—
opening_hours	opening_hours	Optional	—
time_slot_templates	time_slot_template[]	Optional	—
sales_location	boolean	Optional	Location processes sales transactions
stock_location	boolean	Optional	Location manages inventory/stock
weeklyreport_location	boolean	Optional	Location generates weekly reports
calculate_stock	boolean	Optional	Calculate stock levels and movements
calculate_wastage	boolean	Optional	Track and calculate food wastage
calculate_profit	boolean	Optional	Calculate profit margins and costs
calculate_stock_values	boolean	Optional	Calculate stock values using FIFO
calculate_labor_metrics	boolean	Optional	Track labor costs and productivity
track_table_turnover	boolean	Optional	Monitor table utilization and turnover
track_customer_metrics	boolean	Optional	Track customer behavior and satisfaction
tables	location_data_tables	Optional	—
tableMaps	location_data_table_maps	Optional	—
stock_locations	string[]	Optional	—
not_in_stock	guid[]	Optional	—
assortment	assortment	Optional	—
weekly	weeklyreport_parameters	Optional	—
description	string	Optional	—
pos	location_data_pos	Optional	—
day_start_time	string	Optional	—
home_delivery	boolean	Optional	—
coordinates	coordinates	Optional	—
default_delivery	string	Optional	—
transfer_source	string	Optional	—
pricetags_printed	string	Optional	—
email_reports	location_email_report	Optional	—
purchaseinvoicematching	purchase_invoice_matching	Optional	—
service_periods	service_period[]	Optional	—
wolt	wolt_data	Optional	—
stock_settings	location_stock_settings	Optional	—
arnolds_app	any	Optional	proprietary Arnold's app integration data
temp	any	Optional	FIXME

location

has idhas activetablecompany-scoped

Field	Type	Required	Description
name	string	Required	—
parent_id	id?	Optional	—
data	location_data	Required	—
sales_history	sales_history?	Optional	—
receipt_image_iddeprecated	string?	Optional	—

layout_button

Field	Type	Required	Description
page	number	Required	—
x	number	Required	—
y	number	Required	—
plu	string	Optional	—
plu_id	guid	Optional	—
tender_id	guid	Optional	—
discount_id	guid	Optional	—
dpt_id	guid	Optional	—
span_x	number	Optional	—
span_y	number	Optional	—
text1	string	Optional	—
text2	string	Optional	—
text3	string	Optional	—
image	string	Optional	—
foreground	string	Required	—
background	string	Required	—
menu	number	Optional	—
font_size1	number?	Optional	—
font_size2	number?	Optional	—
font_size3	number?	Optional	—
pad1	number	Optional	—
action	string	Optional	—
data	any	Optional	—
price	number	Optional	—
page_change	string	Optional	—
multiplier	number	Optional	—

layout_page

Field	Type	Required	Description
id	number	Required	—
label	string	Optional	—
hidden	boolean	Required	—
background	string	Optional	—
foreground	string	Optional	—
columns	number	Optional	—
rows	number	Optional	—

layout_data

Field	Type	Required	Description
buttons	layout_button[]	Required	—
pages	layout_page[]	Optional	—

layout2_textline

Field	Type	Required	Description
text	string	Required	—
font	string	Optional	—
font_size	number?	Optional	—
overflow	string	Optional	—
font_style	string	Optional	—
align	string	Optional	—

layout2_button

Field	Type	Required	Description
x	int	Required	—
y	int	Required	—
span_x	int	Required	—
span_y	int	Required	—
action	string	Required	—
object_id	any	Optional	—
tender_iddeprecated	any	Optional	—
data	string	Required	—
price	number	Optional	—
page_change	string	Optional	—
multiplier	number	Optional	—
text1	layout2_textline	Required	—
text2	layout2_textline	Required	—
text3	layout2_textline	Required	—
image	string	Optional	—
icon	string	Optional	—
icon_size	string	Optional	—
icon_pos	string	Optional	—
style	string	Required	—
foreground	string	Required	—
background	string	Required	—
text_padding	int	Required	—
password	boolean	Optional	—
price_text	string	Optional	—

layout2_page

Field	Type	Required	Description
id	int	Required	—
label	string	Required	—
layout_type	enum:layout_page_layout_type	Required	—
layout_object	string	Optional	—
columns	int	Required	—
rows	int	Required	—
type	enum:layout_page_button_type	Optional	—
foreground	any	Optional	—
background	any	Optional	—
background_type	string	Optional	—
hidden	boolean	Required	—
scroll_x	boolean	Optional	—
scroll_y	boolean	Optional	—
show_prices	boolean	Optional	—
prices_in_buttonsdeprecated	boolean	Optional	—
buttons	layout2_button[]	Required	—
user_editable	boolean	Optional	—
sort_alpha	boolean	Optional	—
image	guid	Optional	—

layout2_data

Field	Type	Required	Description
aspect_ratio	number	Optional	—
pages	layout2_page[]	Required	—

layout

has idhas activetablecompany-scoped

Field	Type	Required	Description
name	string	Required	—
data	layout2_data	Required	—

M

7 model(s)

menu_data_item

Field	Type	Required	Description
id	guid	Required	id of menu item
type	enum:menu_data_item_type	Required	type of menu item
plulist	guid[]	Required	list of plu to select
dptlist	guid[]	Required	list of dpt to select
taglist	string[]	Required	list of tags to select plu
only_modifiers	boolean	Required	only modifier products are allowed
default_plu	guid	Optional	default plu to select
default_qty	number	Optional	default quantity
min_qty	number	Optional	minimum quantity
max_qty	number	Optional	maximum quantity
charge_threshold	number	Optional	after this value ordered products can have additional price, between min_qty and max_qty
optional	boolean	Required	no selection needed
pricing	plu_pricing	Optional	alternate pricing for this item
price_level	guid	Optional	alternate price level for this item
group_price	boolean	Required	group menu price to first product
allow_same	boolean	Required	allow same product multiple times
item_text	string	Optional	item comment to add
no_discount	boolean	Required	no discounts apply to this item
course	string	Optional	course for this item
modify_course	boolean	Optional	modify parent course
layout_text	string	Optional	title for selection screen
layout_id	number	Optional	popup or screen in layout for selection

menu_data_upsell

Field	Type	Required	Description
type	enum:menu_data_item_type	Required	type of upsell item
layout_text	string	Optional	title for selection screen
layout_id	number	Optional	popup or screen in layout for selection
remove_item	guid	Optional	remove this item from order
add_item	guid	Optional	remove this item from order

menu_data

Field	Type	Required	Description
items	menu_data_item[]	Required	—
upsells	menu_data_upsell[]	Optional	—
type	enum:menu_data_choice_type	Required	type of ui
layout_page	number	Optional	page in layout for selection
sales_channels	string[]	Optional	sales channels for this plu

menu

has idhas activetablecompany-scoped

Field	Type	Required	Description
name	string	Required	—
data	menu_data	Required	—

mobilepay_data_response

Field	Type	Required	Description
store_info	any	Required	—

mobilepay_register_request

Field	Type	Required	Description
name	string	Required	—
store	string	Required	—
qr	string	Optional	—

metasearch_request

Field	Type	Required	Description
term	string	Required	Search term

N

6 model(s)

netvisor_parameters

Field	Type	Required	Description
active	boolean	Optional	Use Netvisor integration
customer_id	string	Optional	Netvisor customer ID
customer_key	string	Optional	Netvisor customer key
max_rounding	number_or_string	Optional	Max acceptable rounding in cents
sales_transfer	string	Optional	Sales transfer mode (manual, daily, weeklyreport)
inventory_transfer	string	Optional	Inventory transfer mode (manual, inventory)
test_env	boolean	Optional	Use Netvisor test environment
sync	sync_settings	Optional	—

nyx_parameters

Field	Type	Required	Description
active	boolean	Optional	Use NYX customer loyalty integration
apikey	string	Optional	NYX API key

nutrition_value

Field	Type	Required	Description
unit	string	Optional	Unit of measurement (g, mg, etc.)
value	number	Required	Numeric value

nutrition_information

Field	Type	Required	Description
serving_size	string	Optional	Serving size basis (default: per_100_grams)
energy_kcal	nutrition_value	Optional	Energy in kilocalories
energy_kj	nutrition_value	Optional	Energy in kilojoules
fats	nutrition_value	Optional	Total fat content
saturated_fats	nutrition_value	Optional	Saturated fat content
mono_unsaturated_fats	nutrition_value	Optional	Monounsaturated fat content
poly_unsaturated_fats	nutrition_value	Optional	Polyunsaturated fat content
carbohydrate	nutrition_value	Optional	Total carbohydrate content
sugar	nutrition_value	Optional	Sugar content
starch	nutrition_value	Optional	Starch content
polyols	nutrition_value	Optional	Polyols content
protein	nutrition_value	Optional	Protein content
fibres	nutrition_value	Optional	Dietary fiber content
salt	nutrition_value	Optional	Salt content
sodium	nutrition_value	Optional	Sodium content
potassium	nutrition_value	Optional	Potassium content
calcium	nutrition_value	Optional	Calcium content
magnesium	nutrition_value	Optional	Magnesium content
chloride	nutrition_value	Optional	Chloride content
fluoride	nutrition_value	Optional	Fluoride content
cholesterol	nutrition_value	Optional	Cholesterol content (for Google Business Profile)
vitamin_c	nutrition_value	Optional	Vitamin C content
alcohol_percentage	number	Optional	Alcohol percentage (e.g., 5.0 for 5%)
caffeine_mg_per_100g	number	Optional	Caffeine content in mg per 100g

number_response

Field	Type	Required	Description
result	number	Required	—

notification_delivery_result

Field	Type	Required	Description
method	string	Required	Delivery method used
success	boolean	Required	Whether delivery was successful
timestamp	datetime	Required	When delivery was attempted
response_code	string	Optional	Response code from delivery service
error_message	string	Optional	Error message if delivery failed
external_id	string	Optional	External service message ID

O

1 model(s)

opening_hours

Field	Type	Required	Description
monday	daily_hours	Optional	—
tuesday	daily_hours	Optional	—
wednesday	daily_hours	Optional	—
thursday	daily_hours	Optional	—
friday	daily_hours	Optional	—
saturday	daily_hours	Optional	—
sunday	daily_hours	Optional	—

P

57 model(s)

position

Field	Type	Required	Description
lat	number	Required	Latitude coordinate
lng	number	Required	Longitude coordinate

procountor_parameters

Field	Type	Required	Description
active	boolean	Optional	Use Procountor integration
test_env	boolean	Optional	Use Procountor test environment
max_rounding	number_or_string	Optional	Max acceptable rounding in cents
sales_transfer	string	Optional	Sales transfer mode (manual, daily, weeklyreport)
inventory_transfer	string	Optional	Inventory transfer mode (manual, inventory)
purchase_invoice_counter	number	Optional	Last fetched purchase invoice number
access_token	string	Optional	OAuth access token
apikey	string	Optional	API key
code	string	Optional	OAuth authorization code
expires_in	number	Optional	Token expiration time
refresh_token	string	Optional	OAuth refresh token
sync	sync_settings	Optional	—

pos_receipt_partial

Field	Type	Required	Description
name	string	Required	—
template	string	Required	—
precompiled	string	Optional	—

pos_receipt_layout_data

Field	Type	Required	Description
name	string	Required	—
type	string	Required	—
active	boolean	Required	—
partials	pos_receipt_partial[]	Required	—
template	string	Required	—
precompiled	string	Optional	—

purchase_invoice_matching

Field	Type	Required	Description
active	boolean	Optional	—
name_regex	string	Optional	—

pos_image

POS image/asset reference

Field	Type	Required	Description
id	guid	Required	Unique identifier for the image
type	string?	Required	Image type (logo, background, etc.)
filename	string	Optional	Filename or path of the image
mimetype	string	Required	MIME type of the image
checksum	string	Optional	File checksum for cache validation

pos_settings

General POS display and behavior settings

Field	Type	Required	Description
language	string	Optional	UI language code
autoLogout	boolean	Optional	Auto-logout after transaction
bigReceipt	big_receipt_settings	Optional	Big receipt view settings
beepType	string	Optional	Sound feedback type (0-5)
fontSize	string	Optional	Global font size setting
cashierSidebar	boolean	Optional	Show cashier sidebar
cashierSidebarExtended	boolean	Optional	Extended cashier sidebar mode

postype_posagent

POS agent configuration for hardware and integrations

Field	Type	Required	Description
EFTMode	enum:eft_mode	Optional	Payment terminal mode
EFTData	string	Optional	EFT configuration data (COM port, terminal ID, etc.)
EFTIdle	string	Optional	Idle screen configuration for payment terminal
EFTDebug	boolean	Optional	Enable EFT debug logging
EFTTypedeprecated	string	Optional	Legacy EFT type field
HostUrl	string	Optional	Backend host URL for POS agent
DebugMode	boolean	Optional	Enable general debug mode
Environment	string	Optional	Environment identifier (prod, test)
PrinterName	string	Required	Main receipt printer URI
PrinterType	enum:printer_control	Required	Main printer control type
UpdateChannel	string	Optional	Software update channel
CustomerDisplayType	enum:customerdisplay_type	Optional	Customer display type
CustomerDisplayName	string	Optional	Customer display connection name
ScaleType	enum:scale_type	Optional	Connected scale type
ScalePort	string	Optional	Scale serial port
BettingType	enum:betting_type	Optional	Betting terminal integration
BettingPort	string	Optional	Betting terminal serial port
ReceiptDelivery	string	Optional	Receipt delivery method configuration
BackupUrl	string	Optional	Backup server URL
UpdateUrl	string	Optional	Software update server URL
UseRollbar	boolean	Optional	Enable Rollbar error reporting
CustomerDisplay	string	Optional	Legacy customer display field
KitchenPrinterName	string	Optional	Kitchen printer 1 URI
KitchenPrinterType	enum:printer_control	Optional	Kitchen printer 1 control type
KitchenPrinterName2	string	Optional	Kitchen printer 2 URI
KitchenPrinterType2	enum:printer_control	Optional	Kitchen printer 2 control type
KitchenPrinterName3	string	Optional	Kitchen printer 3 URI
KitchenPrinterType3	enum:printer_control	Optional	Kitchen printer 3 control type
stemmi_tag	string?	Optional	Default Stemmi tag for products
CloudUser	string	Optional	Cloud service username
CloudPassword	string	Optional	Cloud service password
CloudID	string	Optional	Cloud service terminal ID
ApiKey	string	Optional	API key for external services
Rollbardeprecated	string?	Optional	Legacy Rollbar token field

postype_hourlyreport_settings

Hourly report configuration

Field	Type	Required	Description
hours	string	Optional	Hours to include in report (comma-separated)
dptlist	string[]	Optional	Department IDs to include

postype_flowpos

FlowPOS-specific feature flags and settings

Field	Type	Required	Description
plugins	string[]	Optional	Enabled plugin identifiers
no_default_receipt	boolean	Optional	Disable automatic receipt printing
background_img	string	Optional	Background image URL/path
display_layout	string	Optional	UI layout variant (left, middle)
logo_img	string	Optional	Logo image URL/path
hourlyreport	postype_hourlyreport_settings	Optional	Hourly report settings
beep_on_touch	boolean	Optional	Enable touch feedback sounds
businessday_dialog	boolean	Optional	Show business day dialog on login
customer_system	boolean	Optional	Enable customer management
delivery_system	boolean	Optional	Enable delivery management
tax_system	boolean	Optional	Enable tax-free sales
sales_orders	boolean	Optional	Enable sales order functionality
keyboard	boolean	Optional	Show on-screen keyboard
wastage	boolean	Optional	Enable wastage tracking
delivery	boolean	Optional	Enable delivery mode
show_history	boolean	Optional	Show transaction history
product_info	boolean	Optional	Show product info button
eft_eod	boolean	Optional	Enable EFT end-of-day processing
order_numbers	boolean	Optional	Enable order number system
table_sales	boolean	Optional	Enable table service mode
kitchen_print_auto	boolean	Optional	Automatic kitchen slip printing
kitchen_print_all	boolean	Optional	Print all items to kitchen
kitchen_print_orders	boolean	Optional	Kitchen print for order numbers only
show_pricing	boolean	Optional	Show pricing information
show_stock	boolean	Optional	Show stock levels
login_timesheets	boolean	Optional	Show timesheet on login
login_cash_declaration	boolean	Optional	Require cash declaration on login
assortments	boolean	Optional	Enable assortment filtering
email_receipt	boolean	Optional	Enable email receipt option
barcode_customer	boolean	Optional	Enable customer barcode scanning
barcode_nyx	boolean	Optional	Enable NYX barcode format
barcode_stockmann	boolean	Optional	Enable Stockmann barcode format
barcode_cashier	boolean	Optional	Use barcode/NFC for cashier login
table_maps	boolean	Optional	Enable table map view
cash_declaration	boolean	Optional	Enable cash declaration
permanent_pricegroup	boolean	Optional	Keep price group across transactions
table_seats	boolean	Optional	Enable seat-level ordering
immediate_login	boolean	Optional	Skip login screen

postype_castles

Castles payment terminal specific settings

Field	Type	Required	Description
direct_pay	boolean	Optional	Enable direct payment mode
local_url	string	Optional	Local terminal URL
direct_sell	boolean	Optional	Enable direct sell mode

postype_pat

Pay-at-table terminal settings

Field	Type	Required	Description
direct_pay	boolean	Optional	Enable direct payment mode
local_url	string	Optional	Local terminal URL
direct_sell	boolean	Optional	Enable direct sell mode

pos_peripheral

Generic peripheral device configuration

Field	Type	Required	Description
type	string	Required	Peripheral type (printer, scale, display)
model	string	Required	Device model identifier
driver	string	Required	Driver/protocol to use
configuration	any	Required	Device-specific configuration

pos2_menu_settings

POS 2026 menus active

Field	Type	Required	Description
sales	boolean	Optional	Enable sales menu
tables	boolean	Optional	Enable tables menu
orders	boolean	Optional	Enable orders menu
reports	boolean	Optional	Enable reports menu
goals	boolean	Optional	Enable goals menu
archive	boolean	Optional	Enable archive menu
delivery	boolean	Optional	Enable delivery menu
wastage	boolean	Optional	Enable wastage menu
stock	boolean	Optional	Enable stock menu
inventory	boolean	Optional	Enable inventory menu
settings	boolean	Optional	Enable settings menu

pos2_settings

POS 2026 terminal settings

Field	Type	Required	Description
menus	pos2_menu_settings	Required	—
login_type	enum:pos2_login_type	Required	—

postype_receipt_templates

Receipt template assignments for different receipt types

Field	Type	Required	Description
control_receipt	string?	Optional	Control/merchant receipt template
customer_receipt	string?	Optional	Customer receipt template
kitchen_print	string?	Optional	Kitchen order slip template
special_tx	string?	Optional	Special transaction receipt template
subtotal_bill	string?	Optional	Subtotal/interim bill template
report	string?	Optional	Report printout template
invoice	string?	Optional	Invoice receipt template
sales_order	string?	Optional	Sales order receipt template
warranty	string?	Optional	Warranty receipt template

postype_data

POS type configuration data container

Field	Type	Required	Description
type	enum:postype_type	Optional	Terminal platform type
admin_password	string	Optional	Administrator password
preferred_version	string	Optional	Preferred software version
agent_version	string	Optional	Required agent version
peripherals	pos_peripheral[]	Optional	Connected peripheral devices
posagent	postype_posagent	Optional	POS agent configuration
flowpos	postype_flowpos	Optional	FlowPOS feature settings
castles	postype_castles	Optional	Castles terminal settings
pos2	pos2_settings	Optional	POS2 settings
payattable	postype_pat	Optional	Pay-at-table settings
settings	pos_settings	Optional	General POS settings
receipt_templates	postype_receipt_templates	Optional	Receipt template assignments

postype

has idhas activetablecompany-scoped

POS type definition - configuration template for POS terminals

Field	Type	Required	Description
layout_id	id	Optional	Default layout for this POS type
name	string	Required	POS type name
data	postype_data	Required	Configuration data

pos_subscriptions

Field	Type	Required	Description
tenders	guid[]	Optional	—
pricings	guid[]	Optional	—
discounts	guid[]	Optional	—
infocodes	guid[]	Optional	—

pos_mobilepay_config

Field	Type	Required	Description
pos_id	guid	Required	—
store_id	guid	Required	—
beacon_id	string	Required	—
environment	string	Optional	—
merchant_vat	string	Required	—

pos_vipps_config

Field	Type	Required	Description
mss	string	Optional	—
name	string	Optional	—
test	boolean	Optional	—
use_reader	boolean	Optional	—

pos_data

Field	Type	Required	Description
receipt	receipt_data	Optional	—
texts	any	Optional	—
subscriptions	pos_subscriptions	Required	—
eft	string	Optional	—
test_device	boolean	Optional	—
pos_network	boolean	Optional	—
live_parameters	boolean	Optional	—
hostname	string	Optional	—
language	string?	Optional	—
lock_code	string	Optional	—
monitor_type	string	Optional	—
update_groups	string	Optional	—
monitor_updates	boolean	Optional	—
monitor_location	string	Optional	—
activation_code	string	Optional	—
mobilepay	pos_mobilepay_config	Optional	—
vipps	pos_vipps_config	Optional	—
ext_id	external_id[]	Optional	—
preferred_sw	string	Optional	—
update_channel	string	Optional	—
automatic_close	string	Optional	—
description	string	Optional	—
network_host	guid	Optional	—
network_type	enum:pos_network_type	Optional	—
automatic_open	string	Optional	—
automatic_open_cashier	int	Optional	—
no_automatic_close_receipt	boolean	Optional	—
sales_channels	string[]	Optional	sales channels for this pos
opening_hoursdeprecated	any	Optional	—

pos

has idhas activetablecompany-scoped

Field	Type	Required	Description
name	string	Required	—
location_id	id	Required	—
postype_id	id	Required	—
data	pos_data	Required	—
sales_history	sales_history?	Optional	—

pos_discount_usage_response

Field	Type	Required	Description
pos_guid	guid	Required	POS system GUID identifier
discounts	guid[]	Optional	Array of discount GUIDs this POS is subscribed to

posdata_pos

Field	Type	Required	Description
id	guid	Required	—
active	boolean	Optional	—
location_id	id	Optional	—
name	string	Required	—
email	string	Optional	—
type	string	Optional	—
company_id	guid	Required	—
company_name	string	Optional	—
data	pos_data	Required	—
postype	postype	Required	—
peers	string[]	Optional	—
location_data	location_data	Optional	—
receipt_layouts	pos_receipt_layout_data	Required	—
images	pos_image[]	Optional	—
sales_history	sales_history	Optional	—
settlements	string[]	Optional	settlement methods for this pos
max_receipt_number	int	Optional	maximum receipt number before rolling over to 1
network_type	string	Optional	network type of this pos

pricing_data

Field	Type	Required	Description
type	enum:pricegroup_type	Required	—
taxtype	guid	Optional	—
set_taxtype	boolean	Optional	—
shortname	string	Optional	—

pricing

has idhas activetablecompany-scoped

Field	Type	Required	Description
name	string	Required	—
data	pricing_data	Required	—

plu_recipe

Field	Type	Required	Description
plu	string	Optional	—
plu_id	guid	Optional	link to plu
multiplier	number_or_string	Required	multiplier of base unit for this recipe item
price	number	Required	fractional price of this recipe item
vat_price	number	Optional	fractional vat price of this recipe item
tax_id	guid	Optional	tax id for this recipe item

plu_selection

Field	Type	Required	Description
type	enum:plu_selection_type	Required	selection type
name	string	Optional	name of selection
description	string	Optional	additional description of selection
target_plu	guid	Optional	target plu
target_menu	guid	Optional	target plu
target_price	amount	Optional	target price
target_price_level	guid	Optional	target price level
target_discount	guid	Optional	target discount
target_qty	number	Optional	target quantity
optional	boolean	Optional	optional selection
selection_ui	enum:plu_selection_ui	Optional	ui element for selection
recipe_changes	plu_recipe[]	Optional	recipe changes

plu_pricing

Field	Type	Required	Description
type	enum:pricing_type	Required	pricing type
amount	number_or_string	Optional	amount for AMOUNT type

plu_supply

information about suppliers where is plu can be ordered

Field	Type	Required	Description
active	boolean	Required	This supplier is active
batch_name	string	Required	Name of ordering unit
batch_size	number_or_string	Required	multiplier of base unit
batch_value	number_or_string	Required	taxless price of whole supply unit
sku	string	Required	suppliers product code
ean	string	Optional	ordering EAN code
supplier	guid	Optional	link to supplier

pricetag_data

Field	Type	Required	Description
tags	string	Optional	—
line1	string	Optional	—
line2	string	Optional	—

plu_data

Field	Type	Required	Description
stk_typedeprecated	string	Optional	—
stock_typedeprecated	string	Optional	—
unit_type	enum:unit_type	Optional	—
sales_unit	number	Optional	sales amount in base units, for stock products (6)
flags	flags	Optional	misc boolean flags for plu
menudeprecated	any	Optional	—
menu_countdeprecated	number_or_string	Optional	—
stock_units	stock_unit[]	Optional	list of stock units for this plu
warning_limit	number	Optional	warning limit for sales quantity
barcode	string	Optional	main barcode for this plu
barcodes	additional_barcode[]	Optional	additional barcodes for this plu
supply	plu_supply[]	Optional	list of suppliers for this plu
allergiesdeprecated	string[]	Optional	list of allergens (EU codes) - DEPRECATED
allergens	allergens	Optional	EU 14 allergen information (boolean flags for each allergen)
nutrition	nutrition_information	Optional	complete nutritional information including alcohol and caffeine
weight_grams	number	Optional	product weight in grams
age_limit	number	Optional	age limit for this plu
course	string	Optional	default course for this plu
linked_plu	guid	Optional	sell also this PLU when this PLU is sold
prices	plu_pricing	Optional	pricegroups for this plu
recipe	plu_recipe[]	Optional	recipe items for this plu
tags	string[]	Optional	custom tags for this plu
ext_id	external_id[]	Optional	external system ids for this plu
button_number	string	Optional	button number for pos
pricetag	pricetag_data	Optional	pricetag data for this plu
modified_at	string	Optional	Modification timestamp, used in pricetag printing
cost_price	number_or_string	Optional	cost price for this plu
stock_qty_warning	number	Optional	warning limit for stock quantity
foreground	string	Optional	foreground color for button
background	string	Optional	background color for button
use_own_color	boolean	Optional	use foreground/background colors for button, otherwise use dpt colors
refprice_size	number	Optional	reference price size for weight/liquid products
refprice_type	enum:refprice_type	Optional	reference price type for weight/liquid products
tare	number	Optional	tare weight for weight products
time_unit	enum:time_units	Optional	time unit for time products
additional_images	string[]	Optional	product image gallery (attachment IDs), independent of image_id field, supports multiple images with drag-and-drop reordering
additional_fields	string	Optional	Additional fields
menu_items	guid[]	Optional	list of menu items to add as components
selections	plu_selection[]	Optional	selections for this plu
sales_channels	string[]	Optional	sales channels for this plu

plu

has idhas activetablecompany-scoped

Field	Type	Required	Description
productid	string	Required	product id
name	string	Required	product internal name
taxtypedeprecated	any	Optional	deprecated, use tax_id instead
tax_id	id?	Optional	link to tax
type	int	Required	product type
receipt_name	string	Optional	product name on receipt
base_price	number	Optional	base price
dpt_id	id	Required	link to dpt
image	string	Optional	link to image in attachments
image_id	string?	Optional	primary product image (attachment ID), independent of data.additional_images
image_url	string	Optional	—
image_thumb	string	Optional	—
memo	string	Optional	free text description for this product
data	plu_data	Required	—
sales_history	sales_history	Optional	—

product_statistics_summary

Aggregate KPIs for the product

Field	Type	Required	Description
total_revenue	amount	Required	Total gross sales revenue (EUR)
total_quantity	number	Required	Total units sold
total_profit	amount	Required	Total profit (EUR)
average_margin	number	Required	Average margin percentage (0-100)
average_price	amount	Required	Average selling price per unit (EUR)
average_qty_per_day	number	Required	Average units sold per day
transaction_count	number	Required	Number of transactions
customer_count	number	Required	Number of unique customers
discount_total	amount	Required	Total discounts given (EUR)
discount_count	number	Required	Number of discounted sales
department_percentage	number	Required	Percentage of department sales

product_statistics_target

Sales target comparison

Field	Type	Required	Description
target_qty	number	Optional	Target quantity for period
target_revenue	amount	Optional	Target revenue for period
achievement_qty	number	Optional	Achievement percentage (qty)
achievement_revenue	number	Optional	Achievement percentage (revenue)

product_statistics_trend

Sales trend compared to previous period

Field	Type	Required	Description
direction	enum:trend_direction	Required	Trend direction
percentage	number	Required	Percentage change from previous period
previous_revenue	amount	Optional	Previous period revenue
previous_quantity	number	Optional	Previous period quantity

product_statistics_daily_sales

Daily sales breakdown

Field	Type	Required	Description
date	date	Required	Date (YYYY-MM-DD)
location_id	guid	Optional	Location GUID (null for total)
location_name	string	Optional	Location name
quantity	number	Required	Units sold
revenue	amount	Required	Revenue (EUR)
profit	amount	Required	Profit (EUR)
margin	number	Required	Margin percentage
customer_count	number	Required	Number of customers

product_statistics_daily_stock

Daily stock levels

Field	Type	Required	Description
date	date	Required	Date (YYYY-MM-DD)
location_id	guid	Optional	Location GUID
location_name	string	Optional	Location name
quantity	number	Required	Stock quantity
value	amount	Required	Stock value (EUR)

product_statistics_inventory

Inventory metrics

Field	Type	Required	Description
current_stock	number	Required	Current stock quantity
current_value	amount	Required	Current stock value (EUR)
turnover_rate	number	Required	Inventory turnover rate (annual)
days_of_stock	number	Optional	Estimated days of stock remaining

product_statistics_wastage

Wastage/shrinkage data per location

Field	Type	Required	Description
location_id	guid	Optional	Location GUID
location_name	string	Optional	Location name
quantity	number	Required	Wasted quantity
value	amount	Required	Wastage value (EUR)

product_statistics_related

Product frequently purchased together

Field	Type	Required	Description
id	guid	Required	Product GUID
name	string	Required	Product name
quantity	number	Required	Number of co-occurrences

product_statistics_price

Price point frequency

Field	Type	Required	Description
price	amount	Required	Selling price
count	number	Required	Number of sales at this price

product_statistics

Product statistics response for ProductEditor StatisticsTab

Field	Type	Required	Description
period_start	date	Required	Statistics period start
period_end	date	Required	Statistics period end
summary	product_statistics_summary	Required	Aggregate KPIs
target	product_statistics_target	Optional	Sales target comparison
trend	product_statistics_trend	Required	Trend vs previous period
rank	number	Optional	Product rank by sales qty (1 = top)
total_products	number	Optional	Total products for rank context
last_sale_date	date	Optional	Date of most recent sale
inventory	product_statistics_inventory	Optional	Inventory metrics
daily_sales	product_statistics_daily_sales[]	Optional	Daily sales data
daily_stock	product_statistics_daily_stock[]	Optional	Daily stock data
wastage	product_statistics_wastage[]	Optional	Wastage per location
related_products	product_statistics_related[]	Required	Top products bought together
price_distribution	product_statistics_price[]	Optional	Price frequency

pos_action

Field	Type	Required	Description
id	string	Required	—
name	enum:pos_action_name	Required	—
data	any	Required	—
extra	any	Optional	—

plusales

table

Field	Type	Required	Description
company_id	id	Required	—
pos_id	id	Required	—
dpt_id	id	Required	—
tax_iddeprecated	id	Required	—
plu_id	id	Required	—
businessday_id	id	Required	—
receipt_num	int	Required	—
timestamp	datetime	Required	—
qty	number	Required	—
price	amount	Required	—
total	amount	Required	—
profit	amount	Required	—
delivery	string	Optional	—
sales_type	string	Required	—
sales_id	id	Required	—

pos_pricing_data

Field	Type	Required	Description
id	guid	Required	—
validity_start	string	Optional	—
validity_end	string	Optional	—
valid_from	string	Optional	—
valid_to	string	Optional	—
tokens	tokens	Optional	—
description	string	Optional	—
grp	grp[]	Required	—
dpt	dpt[]	Required	—
pricing	pricing[]	Required	—
plu	plu[]	Required	—
tax	tax[]	Required	—
tenders	tender[]	Required	—
pos	posdata_pos	Required	—
cashiers	cashier[]	Required	—
suppliers	supplier[]	Required	—
layout	layout[]	Required	—
discounts	discount[]	Required	—
customers	customer[]	Optional	—
infocodes	infocode[]	Required	—
sales_targets	salestarget[]	Required	—
menus	menu[]	Required	—

paid_out_list_response

Field	Type	Required	Description
transactions	any[]	Required	—

pricelists_response

Field	Type	Required	Description
pricelists	any[]	Required	—

password_change_request

Field	Type	Required	Description
oldpwd	string	Required	—
newpwd1	string	Required	—
newpwd2	string	Required	—

password_result

Field	Type	Required	Description
result	string	Required	—

procountor_op_request

Field	Type	Required	Description
id	string	Required	Invoice GUID
state	string	Required	Operation type (dimension, etc.)

purchase_fetch_list_response

Field	Type	Required	Description
invoices	any[]	Required	—

purchase_fetch_response

Field	Type	Required	Description
invoice	any	Required	—

pricetag_request

Field	Type	Required	Description
list	string	Required	Product list
template	string	Required	Template type

pricelist_request

Field	Type	Required	Description
valid_from	date	Required	Validity start date
description	string	Required	Price list description

pricelist

Field	Type	Required	Description
dummy	string	Optional	—

R

34 model(s)

receipt_data

Field	Type	Required	Description
header	string	Optional	—
footer	string	Optional	—
image	string	Optional	—

receipt_infocode

Field	Type	Required	Description
id	guid	Required	—
type	string	Required	—
target	string	Optional	—
value	string	Optional	—

receipt_customer

Field	Type	Required	Description
id	guid	Required	—
name	string	Required	—
number	string	Optional	—
ident	string	Optional	—
token	customer_token	Optional	—
identified_by	string	Optional	—
ask_reference	boolean	Optional	—

receipt_origin

Field	Type	Required	Description
id	string	Required	—
receiptNumber	number	Optional	—
table	guid	Optional	—
type	enum:receipt_origin_type	Optional	—

receipt_debuginfo_data

Field	Type	Required	Description
items	any[]	Required	—

receipt_debuginfo

Field	Type	Required	Description
data	receipt_debuginfo_data	Required	—

receipt_cashier

has active

Field	Type	Required	Description
id	guid	Required	Unique identifier of the cashier
cashier_num	int	Required	cashier number
location_id	id	Optional	—
name	string	Required	cashier name
password	string?	Optional	User password (hashed)
data	cashier_data	Required	—
sales_history	sales_history?	Optional	—

receipt_serialized

Field	Type	Required	Description
id	guid	Required	Unique identifier of the receipt
type	enum:receipt_type	Required	Type of the receipt
status	enum:receipt_status	Optional	Status of the receipt
timestamp	datetime	Required	Timestamp of the receipt, usually the time of the monetary transaction
company	guid	Required	Company id that the receipt belongs to
pos	guid	Required	POS id that the receipt belongs to
pricingData	guid	Optional	Pricing data id that is used in pricing of the receipt
businessDay	guid	Optional	Business day id that the receipt belongs to
receiptNumber	int	Optional	Receipt number, unique within the POS
orderNumber	int	Optional	Order number, unique within the POS and businessday
origin	receipt_origin	Optional	Original table/receipt that this receipt is based on
originalReceiptNumber	int	Optional	Original receipt number, if the receipt is a return
void	boolean	Required	true if the receipt is voided (not valid at all)
comment	string	Optional	Comment for the receipt, entered at the POS
topComment	string	Optional	Top comment for the receipt, entered at the POS
delivery	string	Optional	Delivery method
salesOrder	guid	Optional	Sales order id that the receipt belongs to
age_verified	boolean	Optional	true if the customer age has been verified
table	guid	Optional	Table id that the receipt belongs to
seats	number	Optional	Number of seats reserved at the table
tableSession	guid	Optional	Unique table session id that the receipt belongs to
tableOps	table_statechange[]	Optional	Table state changes
seat	number	Optional	Seat number of this receipt from the table
tableState	string	Optional	State of the table at the time of the receipt
totalSales	amount	Optional	Total monetary sales amount of the receipt
cashier	receipt_cashier	Optional	Cashier that processed the receipt
customer	receipt_customer	Optional	Customer that the receipt belongs to
salesLines	sales_line[]	Optional	List of sales lines in the receipt
taxes	tax_line[]	Optional	List of tax lines in the receipt
discounts	discount_line[]	Optional	List of total discount lines in the receipt
tenderLines	tender_line[]	Optional	List of tender lines in the receipt
infocodes	receipt_infocode[]	Optional	List of infocodes in the receipt
tenderData	any	Optional	Misc. tender data for the receipt
printableList	string	Optional	List of receipts that can be printed
posActions	pos_action[]	Optional	List of actions that the POS should perform after the receipt has been processed
debugInfo	any	Optional	—

report_generator_product_sale

Individual product sale entry with tax breakdown

Field	Type	Required	Description
product_guid	guid	Required	Product GUID
product_id	string	Required	Product ID/code
product_name	string	Required	Product name
barcode	string	Optional	Product barcode
product_tags	any	Optional	Product tags as JSON array
grp_name	string	Required	Product group name
dpt_name	string	Required	Department name
qty_sum	number	Required	Total quantity sold
gross_sum	amount	Required	Total gross sales amount
cost_sum	amount	Required	Total cost amount
net_sum	amount	Required	Total net sales amount (after tax deductions)
profit_sum	amount	Required	Total profit amount
profit_pct	number	Required	Profit percentage (0-1)
tax_breakdown	any[]	Optional	Tax breakdown by rate

report_generator_product_sales_totals

Totals for product sales report

Field	Type	Required	Description
qty_sum	number	Required	Total quantity sold
net_sum	amount	Required	Total net sales amount
gross_sum	amount	Required	Total gross sales amount
cost_sum	amount	Required	Total cost amount
profit_sum	amount	Required	Total profit amount
profit_pct	number	Required	Overall profit percentage (0-1)

report_generator_product_sales_response

Product sales report with tax breakdown

Field	Type	Required	Description
rows	report_generator_product_sale[]	Required	Product sales data rows
totals	report_generator_product_sales_totals	Required	Summary totals
cursor	any?	Optional	Pagination cursor (not used)
has_more	boolean	Required	Whether more data is available
meta	any	Optional	Metadata including generation timestamp and execution time

report_generator_tender_sale

Individual tender sale entry

Field	Type	Required	Description
tender_id	guid	Required	Tender GUID
tender_name	string	Required	Tender name
tender_type	string	Optional	Tender type
qty	int	Required	Number of transactions
total	amount	Required	Total amount in EUR
overpay	amount	Required	Total overpayment amount in EUR

report_generator_tender_sales_totals

Totals for tender sales report

Field	Type	Required	Description
qty	int	Required	Total number of transactions
total	amount	Required	Total amount in EUR
overpay	amount	Required	Total overpayment amount in EUR

report_generator_tender_sales_response

Tender sales report

Field	Type	Required	Description
rows	report_generator_tender_sale[]	Required	Tender sales data rows
totals	report_generator_tender_sales_totals	Required	Summary totals
cursor	any?	Optional	Pagination cursor (not used)
has_more	boolean	Required	Whether more data is available
meta	any	Optional	Metadata including generation timestamp and execution time

report_generator_tender_fix

Individual tender fix entry

Field	Type	Required	Description
tender_id	guid	Optional	Tender GUID (if available)
tender_name	string	Required	Tender name
qty	int	Required	Number of corrections
total	amount	Required	Total correction amount in EUR

report_generator_tender_fixes_totals

Totals for tender fixes report

Field	Type	Required	Description
qty_sum	int	Required	Total number of corrections
total_sum	amount	Required	Total correction amount in EUR

report_generator_tender_fixes_response

Tender fixes report (manual tender corrections)

Field	Type	Required	Description
rows	report_generator_tender_fix[]	Required	Tender fix data rows
totals	report_generator_tender_fixes_totals	Required	Summary totals
cursor	any?	Optional	Pagination cursor (not used)
has_more	boolean	Required	Whether more data is available
meta	any	Optional	Metadata including generation timestamp and execution time

report_generator_action

Individual operational action entry

Field	Type	Required	Description
id	guid	Required	Sales record ID
timestamp	datetime	Required	Action timestamp
type	string	Required	Action type (PAID_OUT, RECEIVED_ON_ACCOUNT, SALES, NO_SALE, etc.)
void	boolean	Required	Whether the sale was voided
receipt	any	Required	Raw receipt JSON data
amount_eur	amount	Required	Action amount in EUR

report_generator_actions_totals

Totals for actions report

Field	Type	Required	Description
paid_out_sum	amount	Required	Total PAID_OUT amount
received_on_account_sum	amount	Required	Total RECEIVED_ON_ACCOUNT amount
voided_sales_sum	amount	Required	Total voided sales amount
no_sale_count	int	Required	Total NO_SALE count

report_generator_actions_response

Operational actions report (PAID_OUT, RECEIVED_ON_ACCOUNT, voided sales, NO_SALE, etc.)

Field	Type	Required	Description
rows	report_generator_action[]	Required	Action data rows
totals	report_generator_actions_totals	Required	Summary totals by action type
cursor	any?	Optional	Pagination cursor (not used)
has_more	boolean	Required	Whether more data is available
meta	any	Optional	Metadata including generation timestamp and execution time

report_generator_group_sale

Individual group sale entry with tax breakdown

Field	Type	Required	Description
dpt_id	guid	Required	Department GUID
dpt_name	string	Required	Department name
tax_name	string	Required	Tax name
tax_rate	number	Required	Tax rate (0-1)
line_qty	number	Required	Total quantity sold
line_total	amount	Required	Total amount including tax

report_generator_group_sales_totals

Totals for group sales report

Field	Type	Required	Description
line_qty	number	Required	Total quantity sold
line_total	amount	Required	Total amount including tax

report_generator_group_sales_response

Group sales report aggregated by department and tax rate

Field	Type	Required	Description
rows	report_generator_group_sale[]	Required	Group sales data rows with tax breakdown
totals	report_generator_group_sales_totals	Required	Summary totals
cursor	any?	Optional	Pagination cursor (not used)
has_more	boolean	Required	Whether more data is available
meta	any	Optional	Metadata including generation timestamp and execution time

report_generator_tax_summary

Individual tax summary entry

Field	Type	Required	Description
tax_name	string	Required	Tax name
tax_rate	number	Required	Tax rate (0-1)
taxless_amount	amount	Required	Total amount without tax
tax_amount	amount	Required	Total tax amount
total_amount	amount	Required	Total amount including tax

report_generator_tax_summary_totals

Totals for tax summary report

Field	Type	Required	Description
taxless_amount	amount	Required	Total amount without tax
tax_amount	amount	Required	Total tax amount
total_amount	amount	Required	Total amount including tax

report_generator_tax_summary_response

Tax summary report aggregated by tax rate

Field	Type	Required	Description
rows	report_generator_tax_summary[]	Required	Tax summary data rows
totals	report_generator_tax_summary_totals	Required	Summary totals
cursor	any?	Optional	Pagination cursor (not used)
has_more	boolean	Required	Whether more data is available
meta	any	Optional	Metadata including generation timestamp and execution time

report_generator_daily_sale

Individual daily sales entry

Field	Type	Required	Description
daystamp	date	Required	Date of sales (YYYY-MM-DD)
qty_sum	number	Required	Total quantity sold
gross_sum	amount	Required	Total gross sales amount
cost_sum	amount	Required	Total cost amount
net_sum	amount	Required	Total net sales amount (after tax)
profit_sum	amount	Required	Total profit amount
profit_pct	number	Required	Profit percentage (0-1)
receipt_count	int	Required	Number of receipts

report_generator_daily_sales_totals

Totals for daily sales report

Field	Type	Required	Description
qty_sum	number	Required	Total quantity sold
net_sum	amount	Required	Total net sales amount
gross_sum	amount	Required	Total gross sales amount
cost_sum	amount	Required	Total cost amount
profit_sum	amount	Required	Total profit amount
profit_pct	number	Required	Overall profit percentage (0-1)

report_generator_daily_sales_response

Daily sales report aggregated by day

Field	Type	Required	Description
rows	report_generator_daily_sale[]	Required	Daily sales data rows
totals	report_generator_daily_sales_totals	Required	Summary totals
cursor	any?	Optional	Pagination cursor (not used)
has_more	boolean	Required	Whether more data is available
meta	any	Optional	Metadata including generation timestamp

report_generator_hourly_sale

Individual hourly sales entry

Field	Type	Required	Description
hourstamp	string	Required	Hour timestamp (YYYY-MM-DD-HH)
qty_sum	number	Required	Total quantity sold
gross_sum	amount	Required	Total gross sales amount
receipt_count	int	Required	Number of receipts

report_generator_hourly_sales_totals

Totals for hourly sales report

Field	Type	Required	Description
qty_sum	number	Required	Total quantity sold
gross_sum	amount	Required	Total gross sales amount
receipt_count	int	Required	Total receipts

report_generator_hourly_sales_response

Hourly sales report aggregated by hour

Field	Type	Required	Description
rows	report_generator_hourly_sale[]	Required	Hourly sales data rows
totals	report_generator_hourly_sales_totals	Required	Summary totals
cursor	any?	Optional	Pagination cursor (not used)
has_more	boolean	Required	Whether more data is available
meta	any	Optional	Metadata including generation timestamp

receipt_search_request

Field	Type	Required	Description
query	string	Optional	Search terms
startDate	date	Optional	—
endDate	date	Optional	—
pos	string	Optional	Comma-separated POS IDs
cashier	string	Optional	Comma-separated cashier IDs
receiptStatus	string	Optional	VOID or VALID
order	string	Optional	ASC or DESC
limit	number	Optional	Max results

report_generator_request

Field	Type	Required	Description
queryType	string	Required	product, group, tendersales, actions, customer, tenderfixes
startDate	date	Optional	—
startTime	string	Optional	—
endDate	date	Optional	—
endTime	string	Optional	—
location	string	Optional	Comma-separated location IDs
pos	string	Optional	Comma-separated POS IDs
cashier	string	Optional	Comma-separated cashier IDs
grp	string	Optional	Comma-separated group IDs
dpt	string	Optional	Comma-separated department IDs
plu	string	Optional	Comma-separated product IDs
customer	string	Optional	Comma-separated customer numbers
tags	string	Optional	Comma-separated tags

S

82 model(s)

sales_history_customers

Field	Type	Required	Description
date	string	Required	Date of customer count
c	number	Required	Number of customers

sales_history_month

Field	Type	Required	Description
date	string	Required	Month date
qty	string?	Required	Total quantity sold
total	string?	Required	Total sales amount

sales_history

Field	Type	Required	Description
customers	sales_history_customers[]	Optional	Customer count history
month_sales	sales_history_month[]	Optional	Monthly sales history

sync_options

Field	Type	Required	Description
sync_active	boolean	Required	Enable synchronization
sync_create	boolean	Required	Sync create operations
sync_update	boolean	Required	Sync update operations
sync_delete	boolean	Required	Sync delete operations

sync_settings

Field	Type	Required	Description
dpt_from_sync	sync_options	Required	Department sync from external system
dpt_to_sync	sync_options	Required	Department sync to external system
plu_from_sync	sync_options	Required	Product sync from external system
plu_to_sync	sync_options	Required	Product sync to external system
customer_from_sync	sync_options	Required	Customer sync from external system
customer_to_sync	sync_options	Required	Customer sync to external system

shopify_parameters

Field	Type	Required	Description
active	boolean	Optional	Enable Shopify integration
shop_name	string	Optional	Shopify shop name
client_id	string	Optional	Shopify API key
client_secret	string	Optional	Shopify API password
access_token	string	Optional	Shopify access token
sync	sync_settings	Optional	—
customergroup_id	guid	Optional	Customer group for e-commerce customers
customer_id	guid	Optional	Common Customer for e-commerce customers
prepaid_tender	guid	Optional	Tender for prepaid orders

sales_channel

Field	Type	Required	Description
id	guid	Required	Unique id
active	boolean	Required	Sales Channel active
name	string	Required	Sales Channel name
type	string	Required	Sales Channel type
additional_fields	additional_fields	Optional	Additional fields used by this sales channel

service_period

Field	Type	Required	Description
id	guid	Required	—
name	string	Required	Name of the service period, for example "Breakfast", "Lunch"
start_time	string	Required	Start time of the service period in "HH:MM" format
end_time	string	Required	End time of the service period in "HH:MM" format
description	string	Optional	Optional description of the service period
weekdays	string[]	Optional	List of weekdays when the service period is active, e.g. ["MON", "TUE"]
color	color	Optional	Color associated with the service period, for UI representation

supplier_data

Field	Type	Required	Description
code	string	Optional	—
ident	string	Optional	Supplier company identification
description	string	Optional	Supplier description
ext_id	external_id[]	Optional	—
city	string	Optional	—
email	email	Optional	—
address	string	Optional	—
api_addr	string	Optional	—
postcode	string	Optional	—
order_type	string	Optional	—
order_header	string	Optional	—
customer_number	string	Optional	—

supplier

has idhas activetablecompany-scoped

Field	Type	Required	Description
supplier_num	number	Required	Supplier number for internal use
name	string	Required	Supplier name
data	supplier_data	Required	—
sales_history	sales_history[]?	Optional	—

sw_data

Field	Type	Required	Description
changelog	string	Optional	—

sw

has idhas activetable

Field	Type	Required	Description
name	string	Required	—
is_prod	boolean	Required	—
is_beta	boolean	Required	—
is_dev	boolean	Required	—
data	sw_data	Required	—

salesorder_item_option_deposit

Field	Type	Required	Description
gross_price	number_or_string	Required	Total deposit amount
net_price	number_or_string	Required	Net deposit amount
vat_percentage	number	Required	VAT percentage

salesorder_item_option

Field	Type	Required	Description
name	string	Required	Option category (e.g., Toppings, Size)
value	string	Required	Selected option value
price	number_or_string	Required	Additional cost for this option
pos_id	string	Optional	POS identifier for option
value_pos_id	string	Optional	POS identifier for option value
deposit	salesorder_item_option_deposit	Optional	Option deposit information

salesorder_item_deposit

Field	Type	Required	Description
gross_price	number_or_string	Required	Total deposit amount
net_price	number_or_string	Required	Net deposit amount
vat_percentage	number	Required	VAT percentage

salesorder_item

Field	Type	Required	Description
qty	number	Required	Quantity
name	string	Required	Item name
price	number_or_string	Required	Unit price
total	number_or_string	Required	Line total before tax
plu_id	guid	Optional	Reference to PLU
comment	string?	Optional	Item comment/special instructions
productid	string	Required	Product ID
linenum	number	Optional	Line number
price_override	boolean	Optional	Whether price was overridden
total_with_tax	number_or_string	Required	Line total including tax
woocommerce_variant	number	Optional	WooCommerce variant ID
sku	string	Optional	Stock keeping unit
gtin	string	Optional	Global Trade Item Number
base_price	number_or_string	Optional	Base price before modifications
is_bundle_offer	boolean	Optional	Whether item is a bundle offer
category_id	string	Optional	Category identifier
category_name	string	Optional	Category name
options	salesorder_item_option[]	Optional	Item modifiers/options
deposit	salesorder_item_deposit	Optional	Deposit information

salesorder_contact

Field	Type	Required	Description
email	email	Optional	Contact email
phone	string	Optional	Contact phone
name	string	Optional	Contact name

salesorder_external

Field	Type	Required	Description
woocommerce_key	string	Optional	WooCommerce order key
shopify_key	number	Optional	Shopify order ID
wolt_id	string	Optional	Wolt order ID
wolt_order_number	string	Optional	Wolt order number
attribution_id	string	Optional	Wolt attribution/campaign ID
venue_id	string	Optional	Wolt venue identifier
external_venue_id	string	Optional	Partner venue ID

salesorder_payment

Field	Type	Required	Description
total	number_or_string	Required	Payment amount
linenum	number	Required	Line number
overpay	number	Required	Overpayment amount
tender_id	guid	Required	Reference to tender type
tender_type	string	Required	Tender type

salesorder_shipping

Field	Type	Required	Description
name	string	Optional	Recipient name
company	string	Optional	Company name
address_1	string	Optional	Address line 1
address_2	string	Optional	Address line 2
city	string	Optional	City
postcode	string	Optional	Postal code
country	string	Optional	Country code
email	email?	Optional	Shipping email
phone	string?	Optional	Shipping phone

salesorder_delivery

Field	Type	Required	Description
status	string	Optional	Delivery status (estimated, delivered, etc.)
type	string	Optional	Delivery type (homedelivery, takeaway)
time	string	Optional	Expected delivery timestamp
fee	number_or_string	Optional	Delivery cost
small_order_surcharge	number_or_string	Optional	Small order surcharge
self_delivery	boolean	Optional	Whether venue handles delivery
pickup_eta	string	Optional	Courier pickup ETA
street_address	string	Optional	Street address
apartment	string	Optional	Apartment/unit number
city	string	Optional	City
country	string	Optional	Country code
latitude	number	Optional	GPS latitude
longitude	number	Optional	GPS longitude
formatted_address	string	Optional	Full formatted address

salesorder_payment_details

Field	Type	Required	Description
cash_amount	number_or_string	Optional	Cash payment amount
cash_to_expect	number_or_string	Optional	Expected cash amount
paid_by_other_methods	number_or_string	Optional	Amount paid by non-cash methods
company_tax_id	string	Optional	Company tax ID for business billing
loyalty_card_number	string	Optional	Customer loyalty card number
is_wolt_plus	boolean	Optional	Wolt Plus subscription status
balance_to_pay_in_venue	number_or_string	Optional	Amount to be paid at venue

salesorder_pricing

Field	Type	Required	Description
total_before_discounts	number_or_string	Optional	Total before discounts
subtotal_basket_discounts	number_or_string	Optional	Basket-level discounts
subtotal_item_discounts	number_or_string	Optional	Item-level discounts
total	number_or_string	Optional	Total order amount
currency	string	Optional	Currency code (EUR, USD, etc.)

salesorder_order_type_info

Field	Type	Required	Description
type	string	Optional	Order type (instant, preorder)
preorder_time	string	Optional	Preorder preparation time
preorder_status	string	Optional	Preorder status
preparation_time_seconds	number	Optional	Preparation time in seconds
preparation_time_source	string	Optional	Source of preparation time (venue_default, forecasted_by_wolt, etc.)
acceptance_status	string	Optional	Acceptance status (to_be_accepted_by_venue, auto_accepted_by_wolt, etc.)
courier_arrival	string	Optional	Courier arrival notification status

salesorder_venue

Field	Type	Required	Description
id	string	Optional	Wolt venue ID
name	string	Optional	Venue name
external_venue_id	string	Optional	Partner external venue ID

salesorder_group_participant

Field	Type	Required	Description
name	string	Optional	Participant name
comment	string	Optional	Participant comment
payment_method	string	Optional	Payment method
payment_status	string	Optional	Payment status
item_ids	string[]	Optional	Order item IDs for this participant

salesorder_data

Field	Type	Required	Description
items	salesorder_item[]	Optional	Order items
notes	string	Optional	Order notes
contact	salesorder_contact	Optional	Contact information
external	salesorder_external	Optional	External system references
payments	salesorder_payment[]	Optional	Payment information
shipping	salesorder_shipping	Optional	Shipping address
woocommerce	any	Optional	Full WooCommerce order data
delivery_method	string	Optional	Delivery method
delivery	salesorder_delivery	Optional	Wolt delivery information
payment_details	salesorder_payment_details	Optional	Wolt payment details
pricing	salesorder_pricing	Optional	Wolt pricing breakdown
order_type_info	salesorder_order_type_info	Optional	Wolt order type and handling info
venue	salesorder_venue	Optional	Wolt venue information
group_participants	salesorder_group_participant[]	Optional	Wolt group order participants
wolt	any	Optional	Full Wolt order data
ext_id	external_id[]	Optional	External system IDs
additional_fields	string	Optional	Additional fields

salesorder

has idhas activetablecompany-scoped

Field	Type	Required	Description
order_date	string	Required	—
delivery_date	string	Required	—
payment_date	string	Required	—
reference	string	Required	—
status	string	Required	—
customer_id	id	Required	—
order_num	number	Required	—
data	salesorder_data	Required	—

salestarget_data_types

Configuration for sales target scope by product hierarchy

Field	Type	Required	Description
plu	guid[]	Optional	Specific product IDs to include in target
dpt	guid[]	Optional	Department IDs to include in target
grp	guid[]	Optional	Group IDs to include in target

salestarget_data

Sales target configuration data structure

Field	Type	Required	Description
target	salestarget_data_types	Optional	Target scope configuration
campaign	string	Optional	Marketing campaign associated with this target
multiplier	number	Optional	Multiplier for target calculation (e.g., for discounts)
discount_id	id	Optional	Specific discount ID to apply for this target

salestarget

has idhas activetablecompany-scoped

Sales targets for tracking performance against goals by location and time period

Field	Type	Required	Description
name	string	Required	Descriptive name for this sales target
location_id	id	Required	Location this target applies to
start_date	date	Required	Target period start date
end_date	date	Optional	Target period end date (null for ongoing)
type	enum:salestarget_type	Required	Target type (daily, weekly, monthly, etc.)
data	salestarget_data	Required	Target configuration and scope settings

sales_target_data

tablecompany-scoped

Sales targets for each day

Field	Type	Required	Description
salestarget_id	id	Required	Sales target this data belongs to
businssday_id	id	Required	Business day this target data applies to
target_date	date	Required	Date for this sales target data
grp_id	id	Optional	Group ID for this target data
dpt_id	id	Optional	Department ID for this target data
plu_id	id	Optional	Product ID for this target data
target_amount	number	Required	Target amount for this day
total_amount	number	Required	Total sales amount achieved for this day
data	any	Optional	Additional data for this target (not used yet)

stock_unit

stock unit description, plu can have multiple stock units

Field	Type	Required	Description
name	string	Required	Stock unit name
ean	string	Optional	Stock unit EAN code
multiplier	number_or_string	Required	Stock unit multiplier from base unit
stock	number_or_string	Optional	Number of units in stock
value	number_or_string	Optional	Value of single unit in stock
batch_value	number_or_string	Optional	Value of single unit in stock
balance_unit	boolean	Optional	is this unit the main balance unit
inventory_unit	boolean	Optional	is this unit used in inventory management
wastage_unit	boolean	Optional	is this unit used to report wastage
order_unit	boolean	Optional	is this unit used for ordering
supplier_name	string	Optional	Name of supplier (only for internal use)

stockeventitem_data_item

Field	Type	Required	Description
cost	amount	Required	—
unit	string	Required	—
stock	number	Required	—
value	amount	Required	—
multiplier	number	Required	—

stockeventitem_dpt

Field	Type	Required	Description
id	guid	Required	—
name	string	Required	—
dpt_num	number	Required	—

stockeventitem_plu

Field	Type	Required	Description
id	guid	Required	—
name	string	Required	—
productid	string	Required	—

stockeventitem_data

Field	Type	Required	Description
items	stockeventitem_data_item[]	Optional	—
value	number	Optional	—
dpt	stockeventitem_dpt	Optional	—
plu	stockeventitem_plu	Optional	—

stockeventitem

has idtable

Field	Type	Required	Description
stockevent_id	id	Required	—
plu_id	id	Required	—
timestamp	datetime	Required	—
original_qty	number	Optional	—
inventory_qty	number	Optional	—
delivered_qty	number	Optional	—
adjusted_qty	number	Optional	—
data	stockeventitem_data	Required	—

stocklist_item

Field	Type	Required	Description
id	guid	Required	—
name	string	Required	—
type	string	Required	—
location	string	Required	—
stock_units	stock_unit[]	Required	—
entered	boolean	Required	—
current_stock	string	Optional	—
ean	string	Optional	—

stockevent_source

Field	Type	Required	Description
id	string	Required	—
type	string	Required	—

stockevent_currentstock

Field	Type	Required	Description
current_stock	number	Required	—
default_unit	string	Required	—
default_multiplier	number	Required	—

stockevent_data

Field	Type	Required	Description
month	number	Optional	—
list	stocklist_item[]	Optional	—
locations	string[]	Optional	—
source	stockevent_source	Optional	—
version	number	Optional	—
current_stock	stockevent_currentstock	Optional	—
generated	datetime	Optional	—
destination	string	Optional	—
description	string	Optional	user supplied description of this event
value	amount	Optional	monetary value of this stock event

stockevent

has idhas activetablecompany-scoped

Field	Type	Required	Description
location_id	id	Optional	—
supplier_id	id	Optional	—
timestamp	datetime	Required	—
type	enum:stockevent_type	Required	—
status	enum:stockevent_status	Required	—
data	stockevent_data	Required	—

sub_code

Field	Type	Required	Description
name	string	Required	—
description	string	Required	—
function	string	Required	—
target	string	Required	—
amount	number	Required	—

sales_line

Field	Type	Required	Description
id	string	Required	—
productId	string	Required	—
qty	number	Required	—
price	number	Required	—
tax	guid	Required	—
amountTax	amount	Optional	—
amountWithoutTax	amount	Optional	—
productName	string	Required	—
productGuid	guid	Required	—
priceOverride	boolean	Optional	—
comment	string	Optional	—
seat	int	Optional	—
course	string	Optional	—
sentToKitchen	boolean	Optional	—
isLinkedItem	boolean	Optional	—
priceKeyedIn	boolean	Optional	—
quantityKeyedIn	boolean	Optional	—
voided	boolean	Optional	—
description	string	Optional	—
delivery	enum:delivery_type	Optional	—
no_group	boolean	Optional	—
discounts	discount_line[]	Optional	—
no_discount	boolean	Optional	—
infocodes	receipt_infocode[]	Optional	—
modifiers	string[]	Optional	—
pricing	guid	Optional	—
forceModifier	boolean	Optional	—
topLevelPrice	boolean	Optional	—
startTime	datetime	Optional	—
endTime	datetime	Optional	—
menuItem	guid	Optional	—
taxSales	tax_sales_line[]	Optional	—

sales_data_plu

Field	Type	Required	Description
dpt_id	guid	Required	—
tax_id	guid	Required	—
plu_id	guid	Required	—
qty	number	Required	—
price	number	Required	—
total	number	Required	—
profit	number	Required	—
delivery	string	Optional	—

sales_data_tender

Field	Type	Required	Description
tender_id	guid	Required	—
type	string	Required	—
total	number	Required	—
overpay	number	Required	—

sales_data_discount

Field	Type	Required	Description
discount_id	guid	Required	—
amount	number	Required	—
original_amount	number	Required	—
qty	number	Required	—

sales_data_infocode

Field	Type	Required	Description
infocode_id	guid	Required	—
target	string	Required	—
value	string	Required	—

sales_data

Field	Type	Required	Description
plu	sales_data_plu[]	Required	—
tender	sales_data_tender[]	Required	—
discount	sales_data_discount[]	Required	—
infocode	sales_data_infocode[]	Required	—

sales

has idtablecompany-scoped

Field	Type	Required	Description
pos_id	id	Required	—
cashier_id	id	Required	—
customer_id	id	Optional	—
businessday_id	id	Required	—
receipt_num	int	Required	—
timestamp	datetime	Required	—
type	string	Required	—
void	boolean	Required	—
edited	boolean	Required	—
receipt	receipt_serialized	Optional	—

sales_target_data_request

Request model for updating sales target data

Field	Type	Required	Description
sales_target_id	string	Required	GUID of the sales target to update
target_date	date	Required	Date for which to update the target data
target_amount	number	Required	Target amount for the specified date
data	any	Optional	Additional data for this target entry

stockevent_update_request

Field	Type	Required	Description
data	any	Required	Stock event data

sync_result

Field	Type	Required	Description
result	string	Required	—
details	any	Optional	—

stock_transaction_item

has idtable

Individual line item within a stock transaction

Field	Type	Required	Description
stock_transaction_id	guid?	Optional	Parent transaction (set by backend)
product_id	guid	Required	Product being transacted
stock_unit	string	Required	Unit of measure
quantity_before	number?	Optional	Quantity before transaction (calculated by backend)
quantity_change	number?	Optional	Quantity change (positive or negative)
quantity_after	number?	Optional	Quantity after transaction (calculated by backend)
quantity	number?	Optional	Quantity entered by user (converted to quantity_change by backend)
unit_cost	number?	Optional	Unit cost for this transaction (in euros)
total_cost	amount?	Optional	Total cost for this line
data	any	Optional	Additional item data (original entry unit, wastage reason, etc.)

stock_transaction

has idtablecompany-scoped

Stock transaction for inventory changes

Field	Type	Required	Description
location_id	guid	Required	Location where transaction occurs
supplier_id	guid?	Optional	Supplier for delivery transactions
transaction_type	enum:stock_transaction_type	Required	Type of stock transaction
status	enum:stock_transaction_status	Required	Current transaction status
timestamp	date	Required	When transaction occurred
business_date	date	Required	Business date for reporting
reference_number	string?	Optional	External reference number
description	string?	Optional	Transaction description
reason	string?	Optional	Reason for transaction (e.g., wastage reason)
data	any	Required	Additional transaction data
wastage_reason	string?	Optional	Wastage reason extracted from data
notes	string?	Optional	Notes extracted from data
items	stock_transaction_item[]	Optional	Transaction line items

stock_state_v2

has idtablecompany-scoped

Real-time stock state tracking per product per location per unit

Field	Type	Required	Description
location_id	guid	Required	Location for this stock state
product_id	guid	Required	Product being tracked
stock_unit	string	Required	Unit of measure
current_quantity	number	Required	Current available quantity
reserved_quantity	number	Required	Quantity reserved for transfers/orders
unit_cost	amount	Optional	Current unit cost
total_value	amount	Optional	Total inventory value
last_movement_date	datetime	Optional	Last stock movement date
last_transaction_id	guid	Optional	Last transaction that affected this state
version	int	Required	Version for optimistic locking

stock_cost_layer

has idtablecompany-scoped

Cost layers for FIFO/LIFO stock valuation methods

Field	Type	Required	Description
location_id	guid	Required	Location for this cost layer
product_id	guid	Required	Product in this layer
stock_unit	string	Required	Unit of measure
layer_date	date	Required	Date this layer was created
remaining_quantity	number	Required	Remaining quantity in this layer
unit_cost	amount	Required	Unit cost for this layer
source_transaction_id	guid	Optional	Transaction that created this layer

stock_reservation

has idtablecompany-scoped

Tracks stock reservations for pending transfers and orders

Field	Type	Required	Description
location_id	guid	Required	Location where stock is reserved
product_id	guid	Required	Product being reserved
stock_unit	string	Required	Unit of measure
reserved_quantity	number	Required	Quantity reserved
reference_id	guid	Required	Reference to the entity requiring reservation
reference_type	string	Required	Type of entity (transfer_request, sales_order, etc.)
reservation_date	datetime	Required	When reservation was made
expiry_date	datetime	Optional	When reservation expires
notes	string	Optional	Reservation notes
status	string	Required	Reservation status (active, fulfilled, expired, cancelled)

stock_count_scope

Field	Type	Required	Description
dpt_ids	guid[]	Optional	Department IDs to include
grp_ids	guid[]	Optional	Group IDs to include
product_ids	guid[]	Optional	Specific product IDs
abc_classes	string[]	Optional	ABC classification classes
min_value	amount	Optional	Minimum inventory value
max_value	amount	Optional	Maximum inventory value
movement_period_days	int	Optional	Include products with movement in last N days
storage_locations	string[]	Optional	Storage locations to include
exclude_zero_stock	boolean	Optional	Exclude products with zero stock
exclude_negative_stock	boolean	Optional	Exclude products with negative stock

stock_count_progress

Field	Type	Required	Description
total_items	int	Required	Total items to count
counted_items	int	Required	Items already counted
variance_items	int	Required	Items with variance
completion_percentage	number	Required	Completion percentage
estimated_time_remaining	int	Optional	Estimated minutes remaining

stock_count_session

has idtablecompany-scoped

Physical inventory counting session

Field	Type	Required	Description
location_id	guid	Required	Location being counted
session_name	string	Optional	Name/description of count session
count_type	enum:stock_count_type	Required	Type of inventory count
status	enum:stock_count_status	Optional	Current status
scheduled_date	date	Optional	Scheduled count date
started_at	datetime	Optional	When counting started
completed_at	datetime?	Optional	When counting completed
scope_criteria	any?	Optional	Criteria for what to count

stock_count_item

has idtable

Individual product count within a count session

Field	Type	Required	Description
count_session_id	guid	Required	Parent count session
product_id	guid	Required	Product being counted
stock_unit	string	Required	Unit being counted
expected_quantity	number	Required	Expected quantity from system
counted_quantity	number	Optional	Actual counted quantity
variance	number	Optional	Difference between expected and counted
variance_percentage	number	Optional	Variance as percentage
unit_cost	amount	Optional	Unit cost at time of count (snapshotted)
variance_value	amount	Optional	Monetary value of variance
count_date	datetime	Optional	When this item was counted
counter_user_id	guid	Optional	User who counted this item
notes	string	Optional	Notes about this count
requires_recount	boolean	Optional	Whether item needs recount due to large variance

stock_count_variance_summary

Field	Type	Required	Description
total_items_counted	int	Required	Total items counted
items_with_variance	int	Required	Items with variance
positive_variance_items	int	Required	Items with positive variance
negative_variance_items	int	Required	Items with negative variance
total_variance_value	amount	Required	Total monetary variance
largest_variance_item	guid	Optional	Product with largest variance
largest_variance_amount	amount	Optional	Largest variance amount
accuracy_percentage	number	Required	Overall count accuracy percentage

stock_transfer_approval

Field	Type	Required	Description
approved_by	guid	Required	User who approved
approved_at	datetime	Required	When approval was given
approval_notes	string	Optional	Approval notes
conditions	string	Optional	Any conditions on approval

stock_transfer_shipping

Field	Type	Required	Description
shipped_by	guid	Optional	User who shipped
shipped_at	datetime	Optional	When shipment occurred
carrier	string	Optional	Shipping carrier
tracking_number	string	Optional	Shipment tracking number
estimated_arrival	datetime	Optional	Estimated arrival time
shipping_notes	string	Optional	Shipping notes

stock_transfer_receiving

Field	Type	Required	Description
received_by	guid	Optional	User who received
received_at	datetime	Optional	When receipt occurred
condition_on_arrival	string	Optional	Condition of goods on arrival
damage_notes	string	Optional	Any damage noted
receiving_notes	string	Optional	Receiving notes

stock_transfer_request

has idtablecompany-scoped

Request to transfer stock between locations

Field	Type	Required	Description
from_location_id	guid	Required	Source location
to_location_id	guid	Required	Destination location
request_number	string	Required	Unique request number
status	enum:stock_transfer_status	Required	Current status
priority	enum:stock_transfer_priority	Optional	Transfer priority
requested_date	date	Required	Date transfer was requested
required_date	date	Optional	Date transfer is required by
notes	string	Optional	Transfer request notes

stock_transfer_request_item

has idtable

Individual product item in a transfer request

Field	Type	Required	Description
transfer_request_id	guid	Required	Parent transfer request
product_id	guid	Required	Product being transferred
stock_unit	string	Required	Unit of transfer
requested_quantity	number	Required	Originally requested quantity
approved_quantity	number	Optional	Approved quantity for transfer
shipped_quantity	number	Optional	Actually shipped quantity
received_quantity	number	Optional	Actually received quantity
unit_cost	amount	Optional	Unit cost for valuation

stock_transfer_batch

has idtable

Batch tracking for transfer items

Field	Type	Required	Description
transfer_item_id	guid	Required	Parent transfer item
batch_number	string	Required	Batch/lot number
quantity	number	Required	Quantity from this batch
expiry_date	date	Optional	Batch expiry date
received_condition	string	Optional	Condition when received

stock_transfer_summary

Field	Type	Required	Description
total_requests	int	Required	Total transfer requests
completed_transfers	int	Required	Completed transfers
pending_approval	int	Required	Transfers pending approval
in_transit	int	Required	Transfers in transit
total_value_transferred	amount	Required	Total value of transfers
average_completion_time	number	Optional	Average completion time in hours
variance_items	int	Required	Items with shipping/receiving variance

stock_notification_data

Field	Type	Required	Description
company_id	guid	Optional	Related company
location_id	guid	Optional	Related location
product_id	guid	Optional	Related product
current_stock	number	Optional	Current stock level
warning_limit	number	Optional	Warning threshold
previous_stock	number	Optional	Previous stock level
transaction_id	guid	Optional	Related transaction
movement_amount	number	Optional	Stock movement amount
movement_value	amount	Optional	Monetary value of movement
count_session_id	guid	Optional	Related count session
variance_count	int	Optional	Number of items with variance
total_variance_value	amount	Optional	Total variance value
error_type	string	Optional	Type of error
error_details	string	Optional	Detailed error information
affected_records	int	Optional	Number of affected records
severity	string	Optional	Notification severity (low, medium, high, critical)
custom_fields	any	Optional	Additional custom data

stock_notification

has idtable

Stock system event notifications

Field	Type	Required	Description
type	string	Required	Type of notification
recipient	string	Required	Notification recipient (email, phone, webhook URL, etc.)
subject	string	Required	Notification subject/title
body	string	Required	Notification message body
data	any	Required	Notification data payload
delivery_methods	any[]	Required	Delivery methods to use
status	string	Required	Current notification status
delivery_results	any	Optional	Delivery attempt results
delivered_at	datetime	Optional	When notification was delivered
retry_count	int	Optional	Number of delivery retry attempts
max_retries	int	Optional	Maximum retry attempts allowed
next_retry_at	datetime	Optional	When to attempt next retry

stock_notification_rule

has idtablecompany-scoped

Rules for automatic stock notification generation

Field	Type	Required	Description
rule_name	string	Required	Human readable rule name
description	string	Optional	Rule description
notification_type	string	Required	Type of notification this rule generates
location_ids	any[]	Optional	Locations this rule applies to
product_ids	any[]	Optional	Products this rule applies to
dpt_ids	any[]	Optional	Departments this rule applies to
conditions	any	Required	JSON conditions that trigger this rule
threshold_values	any	Optional	Threshold values for conditions
recipients	any[]	Required	Default recipients for notifications
delivery_methods	any[]	Required	Delivery methods to use
message_template	string	Optional	Custom message template
subject_template	string	Optional	Custom subject template
immediate_notification	boolean	Optional	Send notification immediately
digest_frequency	string	Optional	Digest frequency (hourly, daily, weekly)
quiet_hours_start	string	Optional	Start of quiet hours (HH:MM)
quiet_hours_end	string	Optional	End of quiet hours (HH:MM)
active	boolean	Required	Whether rule is active
created_by	guid	Optional	User who created rule

stock_notification_subscription

has idtable

User subscriptions to stock notifications

Field	Type	Required	Description
user_id	guid	Required	Subscribing user
company_id	guid	Required	Company context
location_ids	any[]	Optional	Locations user is interested in
notification_types	any[]	Required	Types of notifications to receive
delivery_methods	any[]	Required	Preferred delivery methods
email_address	string	Optional	Email address for notifications
phone_number	string	Optional	Phone number for SMS
slack_channel	string	Optional	Slack channel for notifications
immediate_notifications	boolean	Optional	Receive immediate notifications
digest_frequency	string	Optional	Digest frequency preference
quiet_hours_start	string	Optional	Personal quiet hours start
quiet_hours_end	string	Optional	Personal quiet hours end
active	boolean	Required	Whether subscription is active

stock_daily_snapshot

has idtablecompany-scoped

Daily snapshot of stock movements and quantities for reporting

Field	Type	Required	Description
location_id	guid	Required	Location for this snapshot
product_id	guid	Required	Product being tracked
business_date	date	Required	Business date for this snapshot
stock_unit	string	Required	Unit of measure
opening_quantity	number	Required	Opening stock quantity at start of day
closing_quantity	number	Required	Closing stock quantity at end of day
deliveries_qty	number	Required	Total deliveries quantity
sales_qty	number	Required	Total sales quantity
wastage_qty	number	Required	Total wastage quantity
transfers_in_qty	number	Required	Total transfers in quantity
transfers_out_qty	number	Required	Total transfers out quantity
adjustments_qty	number	Required	Total adjustments quantity
inventory_adjustments_qty	number	Required	Total inventory adjustments quantity
opening_value	amount	Optional	Opening stock value
closing_value	amount	Optional	Closing stock value
deliveries_value	amount	Required	Total deliveries value
sales_value	amount	Required	Total sales value
wastage_value	amount	Required	Total wastage value
transfers_in_value	amount	Required	Total transfers in value
transfers_out_value	amount	Required	Total transfers out value
adjustments_value	amount	Required	Total adjustments value
inventory_adjustments_value	amount	Required	Total inventory adjustments value
weighted_avg_cost	amount	Optional	Weighted average cost
cost_layers_snapshot	any	Optional	Snapshot of cost layers
transaction_count	int	Required	Number of transactions processed
last_calculated_at	datetime	Optional	When snapshot was last calculated
created_at	datetime	Optional	When snapshot was created

stock_movement_summary

Summary of stock movements for reporting

Field	Type	Required	Description
company_id	guid	Required	Company
location_id	guid	Required	Location
product_id	guid	Required	Product
summary_date	date	Required	Date of summary
summary_period	string	Required	Summary period (daily, weekly, monthly)
opening_balance	number	Required	Opening stock balance
deliveries	number	Required	Total deliveries
usage	number	Required	Total usage/consumption
wastage	number	Required	Total wastage
transfers_in	number	Required	Transfers into location
transfers_out	number	Required	Transfers out of location
adjustments	number	Required	Inventory adjustments
closing_balance	number	Required	Closing stock balance
opening_value	amount	Optional	Opening stock value
closing_value	amount	Optional	Closing stock value
average_cost	amount	Optional	Average cost during period
total_movements	int	Required	Total number of movements
delivery_count	int	Required	Number of delivery transactions
usage_count	int	Required	Number of usage transactions
adjustment_count	int	Required	Number of adjustment transactions

stock_aging_band

Field	Type	Required	Description
band_name	string	Required	Age band name (e.g., "0-30 days")
min_days	int	Required	Minimum age in days
max_days	int	Optional	Maximum age in days (null for last band)
quantity	number	Required	Quantity in this age band
value	amount	Required	Value in this age band
percentage_of_total	number	Required	Percentage of total stock

stock_aging_analysis

Stock aging analysis for inventory management

Field	Type	Required	Description
company_id	guid	Required	Company
location_id	guid	Required	Location
product_id	guid	Required	Product
analysis_date	date	Required	Date of analysis
current_quantity	number	Required	Current stock quantity
current_value	amount	Required	Current stock value
average_age_days	number	Required	Average age of stock in days
oldest_stock_days	int	Required	Age of oldest stock in days
age_bands	stock_aging_band[]	Required	Stock broken down by age bands
slow_moving	boolean	Required	Flagged as slow moving stock
obsolete_risk	boolean	Required	At risk of becoming obsolete
recommended_action	string	Optional	Recommended action

stock_forecast_data

Field	Type	Required	Description
forecast_date	date	Required	Date of forecast
forecasted_demand	number	Required	Forecasted demand quantity
confidence_level	number	Required	Confidence level (0-1)
lower_bound	number	Optional	Lower confidence bound
upper_bound	number	Optional	Upper confidence bound
seasonal_factor	number	Optional	Seasonal adjustment factor

stock_forecast

Stock demand forecasting

Field	Type	Required	Description
company_id	guid	Required	Company
location_id	guid	Required	Location
product_id	guid	Required	Product
forecast_period	string	Required	Forecast period (weekly, monthly)
generated_at	datetime	Required	When forecast was generated
historical_periods	int	Required	Number of historical periods used
data_quality_score	number	Required	Quality of historical data (0-1)
forecast_data	stock_forecast_data[]	Required	Forecast data points
average_demand	number	Required	Average forecasted demand
peak_demand	number	Required	Peak forecasted demand
demand_volatility	number	Required	Demand volatility measure
recommended_reorder_point	number	Optional	Recommended reorder point
recommended_order_quantity	number	Optional	Recommended order quantity
recommended_safety_stock	number	Optional	Recommended safety stock

stock_kpi

Key Performance Indicators for stock management

Field	Type	Required	Description
company_id	guid	Required	Company
location_id	guid	Optional	Location (null for company-wide)
kpi_date	date	Required	Date of KPI calculation
kpi_period	string	Required	KPI period (daily, weekly, monthly)
inventory_turnover_ratio	number	Optional	Inventory turnover ratio
days_of_inventory	number	Optional	Days of inventory on hand
stockout_incidents	int	Required	Number of stockout incidents
stockout_duration_hours	number	Optional	Total hours of stockouts
inventory_accuracy_percentage	number	Optional	Inventory accuracy percentage
cycle_count_accuracy	number	Optional	Cycle count accuracy percentage
shrinkage_percentage	number	Optional	Inventory shrinkage percentage
carrying_cost_percentage	number	Optional	Inventory carrying cost percentage
obsolete_inventory_value	amount	Optional	Value of obsolete inventory
slow_moving_inventory_value	amount	Optional	Value of slow-moving inventory
fill_rate_percentage	number	Optional	Order fill rate percentage
perfect_order_percentage	number	Optional	Perfect order percentage
receiving_efficiency	number	Optional	Receiving process efficiency
counting_efficiency	number	Optional	Inventory counting efficiency
transfer_completion_rate	number	Optional	Transfer completion rate

T

27 model(s)

timesheet_wage

Field	Type	Required	Description
id	string	Optional	Wage type ID
name	string	Required	Wage type name
other	string	Required	Additional wage information
time_from	string	Required	Start time for wage calculation
time_to	string	Required	End time for wage calculation
days	boolean[]	Required	Days of week when wage applies

timesheet_parameters

Field	Type	Required	Description
active	boolean	Optional	Enable timesheet tracking
add_minutes_after_shift	number	Optional	Minutes to add after shift ends
sub_minutes_before_shift	number	Optional	Minutes to subtract before shift starts
wages	timesheet_wage[]	Optional	Wage calculation rules

time_slot_template

Field	Type	Required	Description
id	guid	Required	—
start_time	string	Required	—
end_time	string	Required	—
description	string	Required	—

tax

has idhas activetable

Tax rates

Field	Type	Required	Description
name	string	Required	Name of the tax rate
tax	number	Required	Tax rate as a decimal number (e.g. 0.14 for 14%)
tax_num	int	Required	Tax number, used for tax reporting
validitystart	date	Required	Start date of the tax rate validity
validityend	date?	Optional	End date of the tax rate validity, if applicable

tender_data

Field	Type	Required	Description
tender_type	enum:tender_type	Optional	—
printout_type	enum:printout_type	Optional	—
tender_use	enum:tender_use	Optional	—
cashdrawer	enum:cashdrawer_open	Optional	—
change_type	enum:change_type	Optional	—
change_tender	guid	Optional	—
lunch_voucher	enum:lunchvoucher_type	Optional	—
commission_tender	string	Optional	—
commission_percentage	string	Optional	—
eft	boolean	Optional	—
rounding	number?	Optional	—
over_tender	boolean	Optional	—
under_tender	boolean	Optional	—
require_comment	boolean	Optional	—
report	string	Optional	—
invoice_customer	guid	Optional	—
invoice_customergroup	guid	Optional	—
additional_fields	string	Optional	Additional fields

tender_sales_history_month

Field	Type	Required	Description
date	date	Required	—
count	number?	Required	—
total	string?	Required	—

tender_sales_history

Field	Type	Required	Description
month_sales	tender_sales_history_month[]	Required	—

tender

has idhas activetablecompany-scoped

Field	Type	Required	Description
tender_num	number	Required	tender number
name	string	Required	tender name
data	tender_data	Required	—
sales_history	tender_sales_history?	Optional	—

timesheet_wages

Field	Type	Required	Description
end	string	Required	—
cost	number	Required	—
name	string	Required	—
wage	string	Required	—
hours	number	Required	—
start	string	Required	—

timesheet_data

Field	Type	Required	Description
location	guid	Optional	—
login_trx	string	Optional	—
login_time	string	Required	—
logoff_trx	string	Optional	—
logoff_time	string	Optional	—
wages	timesheet_wages[]	Optional	—
close_day_trx	string	Optional	—

timesheet

has idtablecompany-scoped

Field	Type	Required	Description
cashier_id	id	Required	—
businessday_id	id	Required	—
state	string	Required	—
hours	number	Required	—
log_on	string	Required	—
log_off	string	Required	—
edited	boolean	Required	—
data	timesheet_data	Required	—

tax_sales_line

Field	Type	Required	Description
tax	guid	Required	—
taxAmount	amount	Required	—
taxlessAmount	amount	Required	—
totalAmount	amount	Required	—

tax_line

Field	Type	Required	Description
taxGuid	guid	Required	—
taxName	string	Required	—
taxPercent	number	Required	—
taxAmount	amount	Required	—
taxlessAmount	amount	Required	—
totalAmount	amount	Required	—

tender_line

Field	Type	Required	Description
id	string	Required	—
voided	boolean	Optional	—
tenderId	string	Required	—
tenderType	enum:tender_line_type	Required	—
tenderGuid	guid	Required	—
tenderName	string	Required	—
qty	number	Required	—
amount	amount	Required	—
total	amount	Required	—
overTender	amount	Required	—
cardPayment	card_payment	Optional	—
infocodes	receipt_infocode[]	Optional	—

table_statechange

Field	Type	Required	Description
newState	string	Required	—
timestamp	datetime	Required	—
operation	string	Optional	—
total	number	Optional	—

tendersales

table

Field	Type	Required	Description
company_id	id	Required	—
pos_id	id	Required	—
tender_id	id	Required	—
businessday_id	id	Required	—
receipt_num	int	Required	—
timestamp	datetime	Required	—
type	enum:tendersales_type	Required	—
total	amount	Required	—
overpay	amount	Required	—
sales_id	id	Required	—

taxsales

table

Field	Type	Required	Description
company_id	id	Required	—
pos_id	id	Required	—
businessday_id	id	Required	—
tax_id	id	Required	—
plu_id	id	Required	—
plusales_id	id	Required	—
tax_amount	amount	Required	—
taxless_amount	amount	Required	—
total_amount	amount	Required	—

tokens

Field	Type	Required	Description
auth	string	Optional	—

totp_enable_response

TOTP enable response with QR code

Field	Type	Required	Description
secret	string	Required	Base32-encoded TOTP secret
qrCodeUrl	string	Required	Data URL for QR code image
otpauthUrl	string	Required	otpauth:// URI for manual entry

totp_verify_request

TOTP verification request

Field	Type	Required	Description
token	string	Required	6-digit TOTP code

totp_verify_response

TOTP verification response

Field	Type	Required	Description
result	string	Required	Operation result (OK/FAIL)
error	string	Optional	Error message if failed

totp_status_response

TOTP status response

Field	Type	Required	Description
enabled	boolean	Required	Whether TOTP is enabled
backup_codes_count	int	Required	Number of remaining backup codes

totp_backup_codes_response

Generated backup codes

Field	Type	Required	Description
result	string	Required	Operation result (OK/FAIL)
codes	string[]	Optional	Array of backup codes
error	string	Optional	Error message if failed

totp_disable_response

TOTP disable response

Field	Type	Required	Description
result	string	Required	Operation result (OK/FAIL)

tender_change_list_response

Field	Type	Required	Description
changes	any[]	Required	—

token_response

Field	Type	Required	Description
id	string	Required	—
validity_end	string	Required	—
host	string	Required	—
company	string	Required	—
token	string	Required	—

task_list_response

Field	Type	Required	Description
tasks	any[]	Required	—

U

7 model(s)

user_webauthn

Field	Type	Required	Description
dummy	string	Optional	—

user_settings

Field	Type	Required	Description
theme	string	Optional	—
language	string	Optional	—
adminMode	boolean?	Optional	—
resellerMode	boolean?	Optional	—
component_size	string	Optional	—
entry_variant	string	Optional	—
date_format	string	Optional	—
date_range_picker	string	Optional	—
dashboards	dashboard_settings	Optional	—

user_data

Field	Type	Required	Description
skype	string	Optional	—
phone	string	Optional	—
picture	string	Optional	—
features	string	Required	—
webauthn	user_webauthn[]	Optional	—
site	string	Optional	—
settings	user_settings	Optional	—
totp_enabled	boolean?	Optional	Is TOTP 2FA enabled for this user?
totp_secret	string	Optional	TOTP secret for 2FA, if TOTP is enabled. base32 encoded.
totp_backup_codes	string[]	Optional	List of TOTP backup codes for this user.

user_company

has id

Field	Type	Required	Description
name	string	Required	—
display_name	string?	Required	—
group	string?	Required	—
state	string?	Required	—

user

has idhas activetable

Field	Type	Required	Description
email	email	Required	—
pass	string	Required	—
name	string	Required	—
locked	boolean	Required	—
data	user_data	Required	—
admindata	any	Required	—
admin	boolean?	Optional	Is this user admin?
reseller	boolean?	Optional	Is this user a reseller?
companies	user_company[]	Optional	—

user_companies_request

Field	Type	Required	Description
user_id	string	Required	User GUID
companies	any[]	Required	List of company objects with id and checked fields

user_create_request

Field	Type	Required	Description
name	string	Required	—
email	email	Required	—

V

2 model(s)

voucher_line

Field	Type	Required	Description
id	string	Optional	—
sign	string	Optional	—
value	string	Optional	—
vatcode	string	Optional	—
vatpercent	number	Optional	—
description	string	Optional	—
accountnumber	number_or_string	Optional	—
dimensions	external_dimension[]	Optional	—

vipps_list_response

Field	Type	Required	Description
payments	any[]	Required	—

W

38 model(s)

woocommerce_parameters

Field	Type	Required	Description
active	boolean	Optional	Enable WooCommerce integration
store_url	url	Optional	WooCommerce store URL
consumer_key	string	Optional	WooCommerce consumer key
consumer_secret	string	Optional	WooCommerce consumer secret
sync	sync_settings	Optional	—

weeklyreport_data_availability

Feature flags indicating what data is available for weekly reports

Field	Type	Required	Description
has_margins_data	boolean	Optional	Product margin/cost data is available
has_stock_data	boolean	Optional	Inventory/stock tracking data is available
has_profit_data	boolean	Optional	Profit calculation data is available
has_campaigns_data	boolean	Optional	Marketing campaign data is available
has_sales_targets_data	boolean	Optional	Sales target tracking data is available
has_discount_data	boolean	Optional	Discount/promotion tracking data is available
has_labor_data	boolean	Optional	Labor cost and scheduling data is available
has_staff_data	boolean	Optional	Staff/cashier performance data is available
has_table_turnover_data	boolean	Optional	Table turnover and seating data is available
has_kitchen_performance_data	boolean	Optional	Kitchen efficiency and timing data is available
has_customer_data	boolean	Optional	Customer information and profiles are available
has_loyalty_data	boolean	Optional	Customer loyalty program data is available
has_feedback_data	boolean	Optional	Customer feedback and rating data is available
has_sustainability_data	boolean	Optional	Waste tracking and sustainability metrics are available
has_energy_data	boolean	Optional	Energy consumption data is available
has_waste_tracking	boolean	Optional	Food waste tracking data is available

weeklyreport_parameters

Weekly report configuration parameters

Field	Type	Required	Description
refnum	number	Optional	Reference number for the report
email_recipients	string	Optional	Email addresses for automated report delivery
auto_delivery	boolean	Optional	Enable automatic report delivery
report_format	string	Optional	Report output format: pdf, excel, dashboard, email
report_schedule	string	Optional	Automated delivery schedule: monday_morning, sunday_evening, etc.
dashboard_refresh_interval	number	Optional	Dashboard auto-refresh interval in minutes
data_availability	weeklyreport_data_availability	Optional	Flags indicating what data is available for reporting
include_recommendations	boolean	Optional	Include AI-generated recommendations in report
include_forecast	boolean	Optional	Include predictive analytics and forecasting
compare_to_previous_periods	boolean	Optional	Include period-over-period comparisons
include_staff_performance	boolean	Optional	Include detailed staff performance metrics
include_customer_analytics	boolean	Optional	Include customer behavior and loyalty analytics
include_sustainability_metrics	boolean	Optional	Include sustainability and waste tracking
include_marketing_roi	boolean	Optional	Include marketing campaign ROI analysis
include_campaign_performance	boolean	Optional	Include active campaign performance tracking
include_sales_target_analysis	boolean	Optional	Include sales target achievement analysis
custom_kpis	any[]	Optional	Custom KPIs and metrics to include
alert_thresholds	any	Optional	Custom alert thresholds for key metrics

wolt_data

Field	Type	Required	Description
active	boolean	Optional	Wolt data is active
is_test_mode	boolean	Optional	Indicates if the Wolt integration uses test environment
venue_id	string	Optional	Wolt venue identifier
access_token	string	Optional	Wolt API access token
expires_at	datetime	Optional	Expiration time of the Wolt access token
refresh_token	string	Optional	Wolt API refresh token
is_online	boolean	Optional	Indicates if the location is currently online on Wolt
prep_time_duration	int	Optional	Preparation time duration in minutes for Wolt orders
pre_order_pre_time_duration	int	Optional	Pre-order preparation time duration in minutes for Wolt orders
max_acceptance_prep_time_duration	int	Optional	Maximum acceptance preparation time duration in minutes for Wolt orders
sales_channel	guid	Optional	Reference to the sales channel used for Wolt orders
tender_id	guid	Optional	Reference to the tender used for Wolt payments
supported_languages	string[]	Optional	List of supported languages for Wolt orders
last_sync	datetime	Optional	Timestamp of the last synchronization with Wolt

weeklyreport_cash

V1: Cash handling and reconciliation metrics

Field	Type	Required	Description
endCash	number	Required	Cash amount at end of business period
paidOuts	number	Required	Total paid out amounts during period
beginCash	number	Required	Cash amount at start of business period
cashDrops	number	Required	Cash drops/safe deposits during period

weeklyreport_daysales

V1: Daily sales performance and transaction metrics

Field	Type	Required	Description
count	number	Required	Total number of transactions
total	number	Required	Total sales amount
eat_in	number	Required	Dine-in sales amount
take_out	number	Required	Takeout/delivery sales amount
avg_ticket	number	Optional	Average transaction value (ATV)
peak_hour	string	Optional	Hour with highest sales volume
peak_hour_sales	number	Optional	Sales amount during peak hour
comparison_previous_week	number	Optional	Percentage change vs previous week
comparison_previous_year	number	Optional	Percentage change vs same period last year
gross_sales	number	Optional	Gross sales before discounts/taxes
net_sales	number	Optional	Net sales after discounts/taxes
target_amount	number	Optional	Sales target for the day
target_variance	number	Optional	Variance from sales target (%)
target_achievement_percentage	number	Optional	Target achievement percentage
active_campaigns	any[]	Optional	Active campaigns affecting this day sales
campaign_attributed_sales	number	Optional	Sales attributed to active campaigns

weeklyreport_taxsales

V1: Tax collection and compliance reporting

Field	Type	Required	Description
name	string	Required	Tax category name
total	number	Required	Total tax amount collected
tax_num	number	Required	Tax category number/identifier
netsales	number	Required	Net sales amount for this tax category
tax_rate	number	Optional	Tax rate percentage
taxable_amount	number	Optional	Taxable amount before tax application

weeklyreport_tendersales

V1: Payment method analysis and transaction breakdown

Field	Type	Required	Description
guid	guid	Required	Unique identifier for tender type
name	string	Required	Payment method name (cash, card, etc.)
total	number	Required	Total amount processed via this payment method
overpay	number	Required	Overpay amount (change given)
transaction_count	number	Optional	Number of transactions using this payment method
avg_transaction	number	Optional	Average transaction amount for this payment method

weeklyreport_category_sales

Product category performance and trend analysis

Field	Type	Required	Description
dpt_id	id	Required	Department ID for the category
category	string	Required	Product category name (appetizers, mains, beverages, etc.)
total	number	Required	Total sales amount for this category
percentage	number	Required	Percentage of total sales this category represents
profit_margin	number	Optional	Profit margin percentage for this category
quantity_sold	number	Optional	Total quantity of items sold in this category
avg_item_price	number	Optional	Average price per item in this category
trend_direction	string	Optional	Trend direction: up, down, stable
target_amount	number	Optional	Sales target for this category
target_achievement	number	Optional	Target achievement percentage
campaign_impact	any	Optional	Impact of active campaigns on this category

weeklyreport_category_sales_per_day

Daily breakdown of sales by category to identify weekday patterns

Field	Type	Required	Description
dpt_id	id	Required	Department ID for the category
category	string	Required	Product category name
weekday	string	Required	Day of week (monday, tuesday, wednesday, etc.)
date	string	Required	Actual date (YYYY-MM-DD format)
total	number	Required	Total sales amount for this category on this day
quantity_sold	number	Optional	Quantity of items sold in this category on this day
transaction_count	number	Optional	Number of transactions containing items from this category
percentage_of_week_total	number	Optional	Percentage of the weeks total for this category
avg_item_price	number	Optional	Average item price for this category on this day

weeklyreport_top_item

Menu item performance analysis and ranking

Field	Type	Required	Description
plu_id	id	Required	Product lookup code/ID
name	string	Required	Item name
quantity	number	Required	Quantity sold
total	number	Required	Total revenue from this item
profit	number	Optional	Profit amount from this item
trend	number	Optional	Percentage change vs previous week
profit_margin_percent	number	Optional	Profit margin as percentage
dpt_id	id	Required	Department ID for the category
category	string	Optional	Item category
daypart_performance	any	Optional	Performance by meal period (breakfast, lunch, dinner)
recommendation	string	Optional	Menu engineering recommendation (star, puzzle, plow, dog)

weeklyreport_hourly_sales

Hourly sales patterns and peak period analysis

Field	Type	Required	Description
hour	string	Required	Hour of the day (24-hour format)
total	number	Required	Total sales amount for this hour
count	number	Required	Number of transactions in this hour
avg_receipt_value	number	Optional	Average transaction value for this hour
kitchen_volume	number	Optional	Kitchen order volume correlation
staff_count	number	Optional	Number of staff working during this hour
sales_per_staff	number	Optional	Sales per staff member ratio

weeklyreport_labor

Labor cost analysis and efficiency metrics

Field	Type	Required	Description
total_hours	number	Required	Total labor hours worked during period
total_cost	number	Required	Total labor cost for the period
percentage_of_sales	number	Required	Labor cost as percentage of sales
sales_per_labor_hour	number	Required	Sales generated per labor hour
daily_breakdown	any[]	Optional	Day-by-day labor analysis
overtime_hours	number	Optional	Total overtime hours
overtime_cost	number	Optional	Total overtime cost
peak_vs_slow_efficiency	any	Optional	Labor efficiency during peak vs slow periods
forecast_next_week	any	Optional	Projected labor needs for upcoming week

weeklyreport_recommendation

Data-driven business recommendations and action items

Field	Type	Required	Description
category	string	Required	Recommendation category: staffing, menu, promotion, operations, etc.
description	string	Required	Detailed recommendation description
impact	string	Required	Expected impact level: high, medium, low
action_item	string	Optional	Specific action to take
priority	number	Optional	Priority ranking (1=highest)
responsible_role	string	Optional	Role responsible for implementation
timeline	string	Optional	Suggested implementation timeline
data_source	string	Optional	Data that led to this recommendation
expected_roi	number	Optional	Expected return on investment

weeklyreport_table_turnover

Table utilization and turnover optimization metrics

Field	Type	Required	Description
table_type	string	Required	Table type or size category
avg_dining_duration	number	Required	Average dining duration in minutes
turnover_rate	number	Required	Number of turns per day/period
revenue_per_seat_hour	number	Required	RevPASH - Revenue per available seat hour
utilization_percentage	number	Required	Table utilization as percentage
bottleneck_type	string	Optional	Primary bottleneck: kitchen, service, seating
peak_period_performance	any	Optional	Performance during peak hours
recommendations	string[]	Optional	Turnover optimization recommendations

weeklyreport_kitchen_performance

Kitchen efficiency and order preparation metrics

Field	Type	Required	Description
avg_prep_time_by_category	any	Required	Average preparation time by menu category
kds_metrics	any	Optional	Kitchen Display System performance metrics
order_accuracy_rate	number	Required	Percentage of orders prepared correctly
ticket_time_trends	any	Required	Ticket time analysis during different periods
peak_period_avg_time	number	Required	Average preparation time during peak periods
slow_period_avg_time	number	Required	Average preparation time during slow periods
workflow_bottlenecks	string[]	Optional	Identified kitchen workflow issues
improvement_opportunities	string[]	Optional	Kitchen workflow improvement suggestions

weeklyreport_inventory_analysis

Inventory management and waste analysis

Field	Type	Required	Description
key_ingredient_usage	any	Required	Usage rates for key ingredients
theoretical_vs_actual	any	Required	Variance between theoretical and actual usage
stockouts	any[]	Optional	Stock-out incidents and sales impact
wastage_report	any	Required	Food waste tracking with cost impact
ingredient_price_trends	any	Optional	Price trend alerts for key ingredients
ordering_suggestions	any[]	Optional	Auto-generated ordering recommendations
inventory_turnover	number	Optional	Inventory turnover rate
carrying_cost	number	Optional	Inventory carrying cost

weeklyreport_customer_loyalty

Customer loyalty and retention analysis

Field	Type	Required	Description
repeat_customer_percentage	number	Required	Percentage of customers who are repeat visitors
new_customer_percentage	number	Required	Percentage of customers who are new
avg_visit_frequency	number	Required	Average visits per customer per period
customer_lifetime_value	number	Optional	Estimated customer lifetime value
loyalty_tier_performance	any[]	Optional	Performance by loyalty program tiers
churn_risk_customers	number	Optional	Number of customers at risk of churning
retention_rate	number	Optional	Customer retention rate percentage

weeklyreport_customer_feedback

Customer satisfaction and feedback metrics

Field	Type	Required	Description
avg_food_rating	number	Required	Average food quality rating
avg_service_rating	number	Required	Average service quality rating
avg_ambiance_rating	number	Required	Average ambiance rating
overall_satisfaction	number	Required	Overall customer satisfaction score
sentiment_analysis	any	Optional	Sentiment analysis of written feedback
trending_topics	string[]	Optional	Trending topics or concerns from feedback
issue_resolution_rate	number	Optional	Rate of customer issue resolution
nps_score	number	Optional	Net Promoter Score

weeklyreport_forecast_daily_prediction

Individual daily prediction with confidence intervals

Field	Type	Required	Description
date	string	Required	Forecast date (YYYY-MM-DD)
day_of_week	string	Required	Day of the week (Monday, Tuesday, etc.)
prediction	number	Required	Primary forecast value
lower_bound	number	Required	Lower confidence interval bound
upper_bound	number	Required	Upper confidence interval bound
confidence_level	string	Optional	Confidence level: high, medium, low

weeklyreport_forecast_sales

14-day sales forecasting with daily breakdowns and confidence intervals

Field	Type	Required	Description
daily_forecasts	weeklyreport_forecast_daily_prediction[]	Required	14 days of daily sales forecasts
week1_total_prediction	number	Required	Total predicted sales for first forecast week
week1_lower_bound	number	Required	Lower bound for first week sales
week1_upper_bound	number	Required	Upper bound for first week sales
week2_total_prediction	number	Required	Total predicted sales for second forecast week
week2_lower_bound	number	Required	Lower bound for second week sales
week2_upper_bound	number	Required	Upper bound for second week sales
total_14_day_prediction	number	Required	Total predicted sales for entire 14-day period
total_14_day_lower_bound	number	Required	Lower bound for 14-day total
total_14_day_upper_bound	number	Required	Upper bound for 14-day total
average_daily_sales	number	Required	Average daily sales across forecast period
trend_direction	string	Optional	Overall trend: increasing, decreasing, stable
forecast_method	string	Optional	Forecasting method used: prophet, trend_based, simple
confidence_score	number	Optional	Overall forecast confidence (0-100)

weeklyreport_forecast_customers

14-day customer count forecasting for staffing optimization

Field	Type	Required	Description
daily_forecasts	weeklyreport_forecast_daily_prediction[]	Required	14 days of daily customer count forecasts
week1_total_customers	number	Required	Total predicted customers for first forecast week
week1_avg_daily_customers	number	Required	Average daily customers for first week
week2_total_customers	number	Required	Total predicted customers for second forecast week
week2_avg_daily_customers	number	Required	Average daily customers for second week
peak_day_prediction	string	Optional	Predicted busiest day of the forecast period
peak_day_customers	number	Optional	Predicted customer count for busiest day
staffing_recommendations	string[]	Optional	Staffing recommendations based on forecast

weeklyreport_forecast_category

Category-specific sales forecasting for inventory planning

Field	Type	Required	Description
dpt_id	id	Required	Department ID for the category
category_name	string	Required	Product category name
daily_predictions	weeklyreport_forecast_daily_prediction[]	Required	Daily EUR sales forecasts for this category
week1_total_eur	number	Required	Predicted EUR sales for first week
week1_lower_bound	number	Required	Lower bound EUR sales for first week
week1_upper_bound	number	Required	Upper bound EUR sales for first week
week2_total_eur	number	Required	Predicted EUR sales for second week
week2_lower_bound	number	Required	Lower bound EUR sales for second week
week2_upper_bound	number	Required	Upper bound EUR sales for second week
total_14_day_eur	number	Required	Total predicted EUR sales for 14-day period
category_trend	string	Optional	Category-specific trend direction
inventory_recommendations	string[]	Optional	Inventory planning recommendations

weeklyreport_forecast_summary

Overall forecast summary and metadata

Field	Type	Required	Description
forecast_generated_at	string	Required	Timestamp when forecast was generated (ISO 8601)
forecast_horizon_days	number	Required	Number of days forecasted (should be 14)
historical_data_points	number	Required	Number of historical data points used for forecasting
historical_data_start	string	Optional	Start date of historical data used
historical_data_end	string	Optional	End date of historical data used
api_service_used	string	Optional	External forecasting service used (prophet-api, fallback, etc.)
overall_confidence_level	string	Required	Overall forecast confidence: high, medium, low
seasonal_factors_detected	boolean	Optional	Whether seasonal patterns were detected and used
holiday_adjustments_applied	boolean	Optional	Whether holiday adjustments were applied
forecast_accuracy_notes	string	Optional	Notes about forecast accuracy and limitations

weeklyreport_forecast_comprehensive

Comprehensive 14-day forecasting system for sales, customers, and categories

Field	Type	Required	Description
sales_forecast	weeklyreport_forecast_sales	Required	Total sales forecasting for 14-day period
customer_forecast	weeklyreport_forecast_customers	Required	Customer count forecasting for staffing
category_forecasts	weeklyreport_forecast_category[]	Optional	Individual category forecasts for inventory planning
summary	weeklyreport_forecast_summary	Required	Forecast metadata and confidence information
current_week_remaining_days	number	Optional	Number of days remaining in current week (if mid-week)
current_week_completion_forecast	any	Optional	Forecast for completing the current week

weeklyreport_staff_performance

Individual staff performance and productivity metrics

Field	Type	Required	Description
staff_id	string	Optional	Staff member identifier
staff_name	string	Optional	Staff member name
sales_per_hour	number	Required	Sales generated per hour worked
avg_check_size	number	Required	Average transaction amount for this staff member
upselling_effectiveness	number	Optional	Upselling success rate percentage
order_accuracy_rate	number	Required	Order accuracy percentage
customer_satisfaction_score	number	Optional	Customer satisfaction rating for this staff member
hours_worked	number	Required	Total hours worked during period
total_sales	number	Required	Total sales attributed to this staff member
training_recommendations	string[]	Optional	Suggested training areas

weeklyreport_marketing_roi

Marketing campaign effectiveness and ROI analysis

Field	Type	Required	Description
campaign_id	id	Optional	Reference to campaign entity
campaign_name	string	Required	Marketing campaign or promotion name
campaign_cost	number	Required	Total cost of the campaign
incremental_revenue	number	Required	Additional revenue generated
roi_percentage	number	Required	Return on investment percentage
customer_acquisition_cost	number	Optional	Cost to acquire each new customer
campaign_effectiveness	string	Optional	Overall campaign effectiveness rating
daypart_performance	any	Optional	Campaign performance by time of day
channel_performance	any	Optional	Performance across different marketing channels
discount_performance	any[]	Optional	Performance metrics for each discount in the campaign
target_vs_actual	any	Optional	Campaign targets vs actual performance

weeklyreport_campaign_performance

Active campaign performance during the reporting period

Field	Type	Required	Description
campaign_id	id	Required	Reference to campaign entity
campaign_name	string	Required	Campaign name for reporting
start_date	date	Required	Campaign start date
end_date	date	Optional	Campaign end date
total_revenue	number	Required	Total revenue generated during campaign period
revenue_attribution	number	Optional	Revenue directly attributable to campaign
discount_redemptions	number	Optional	Number of discount redemptions
discount_value	number	Optional	Total value of discounts applied
target_products_performance	any[]	Optional	Performance of targeted products/departments
comparison_to_reference_period	any	Optional	Performance vs reference periods
customer_engagement_metrics	any	Optional	Customer engagement with campaign

weeklyreport_sales_target_performance

Sales target tracking and achievement analysis

Field	Type	Required	Description
target_id	id	Optional	Reference to sales target entity
target_name	string	Required	Sales target name/description
target_type	string	Required	Type of target (TOTAL_SALES_AMOUNT, PRODUCT_SALES_QTY, etc.)
target_amount	number	Required	Target amount/quantity to achieve
actual_amount	number	Required	Actual amount/quantity achieved
achievement_percentage	number	Required	Achievement percentage (actual/target * 100)
variance	number	Required	Variance from target (positive = over target)
variance_percentage	number	Required	Variance as percentage of target
daily_progress	any[]	Optional	Day-by-day progress toward target
contributing_factors	string[]	Optional	Factors contributing to performance
corrective_actions	string[]	Optional	Recommended corrective actions if under-performing

weeklyreport_sustainability

Sustainability metrics and environmental impact tracking

Field	Type	Required	Description
food_waste_amount	number	Required	Total food waste in kg/lbs
food_waste_value	number	Required	Monetary value of food waste
energy_consumption	number	Optional	Energy consumption metrics
packaging_usage	any	Optional	Packaging usage analysis
sustainable_product_sales	number	Optional	Sales of sustainable/eco-friendly products
carbon_footprint_estimate	number	Optional	Estimated carbon footprint
waste_reduction_initiatives	string[]	Optional	Active waste reduction initiatives
sustainability_score	number	Optional	Overall sustainability performance score

weeklyreport_v2

Enhanced sales and category reporting

Field	Type	Required	Description
category_sales	weeklyreport_category_sales[]	Optional	Sales breakdown by product categories
category_sales_per_day	weeklyreport_category_sales_per_day[]	Optional	Daily sales breakdown by product categories
top_items	weeklyreport_top_item[]	Optional	Top performing menu items
low_performing_items	weeklyreport_top_item[]	Optional	Underperforming menu items
hourly_sales	weeklyreport_hourly_sales	Optional	Sales by hour (day x hour matrix)
labor	weeklyreport_labor	Optional	Labor cost and efficiency analysis
table_turnover	weeklyreport_table_turnover[]	Optional	Table turnover and utilization metrics
kitchen_performance	weeklyreport_kitchen_performance	Optional	Kitchen efficiency and performance metrics
inventory_analysis	weeklyreport_inventory_analysis	Optional	Inventory usage and waste analysis
discounts	any[]	Optional	Discount and promotion effectiveness analysis
refunds	any[]	Optional	Refunds and voids analysis with categorization
customer_loyalty	weeklyreport_customer_loyalty	Optional	Customer loyalty and retention analysis
customer_feedback	weeklyreport_customer_feedback	Optional	Customer satisfaction and feedback metrics
weather_data	any[]	Optional	Weather correlation data for sales analysis
staff_performance	weeklyreport_staff_performance[]	Optional	Individual staff performance metrics
marketing_roi	weeklyreport_marketing_roi[]	Optional	Marketing campaign ROI analysis
sustainability	weeklyreport_sustainability	Optional	Sustainability and waste tracking metrics
campaign_performance	weeklyreport_campaign_performance[]	Optional	Active campaign performance during reporting period
sales_target_performance	weeklyreport_sales_target_performance[]	Optional	Sales target achievement and variance analysis
recommendations	weeklyreport_recommendation[]	Optional	Data-driven recommendations and action items
previous_week_comparison	any	Optional	Week-over-week performance comparison
previous_year_comparison	any	Optional	Year-over-year performance comparison
forecast_next_weekdeprecated	any	Optional	Legacy forecast field - use forecast_comprehensive instead
forecast_comprehensive	weeklyreport_forecast_comprehensive	Optional	Comprehensive 14-day forecast for sales, customers, and categories

weeklyreport_data

Complete weekly report data structure including v1 and v2 models

Field	Type	Required	Description
week_num	number	Required	Week number in the year
businessdays	string[]	Optional	List of business day identifiers for the week
pos_list	any	Optional	Weeklyreport v1
company	any	Optional	Weeklyreport v1
billing	any	Optional	Weeklyreport v1
cash	weeklyreport_cash[]	Optional	Weeklyreport v1
feesdeprecated	any	Optional	Weeklyreport v1
daysales	weeklyreport_daysales[]	Optional	Weeklyreport v1
taxsales	weeklyreport_taxsales[]	Optional	Weeklyreport v1
marketingdeprecated	any[]	Required	Weeklyreport v1
tendersales	weeklyreport_tendersales	Optional	Weeklyreport v1
working_hours	number	Required	Weeklyreport v1
netsales_total	number	Optional	Weeklyreport v1
editsdeprecated	any[]?	Required	Weeklyreport v1
weeklyreport_v2	weeklyreport_v2	Optional	—

weeklyreport

has idtablecompany-scoped

Main weekly report entity for restaurant and cafeteria operations

Field	Type	Required	Description
location_id	id	Required	Reference to the location this report covers
weekstart	string	Required	Start date of the reporting week
weekend	string	Required	End date of the reporting week
open	boolean	Required	Whether the report period is still open for modifications
data	weeklyreport_data	Required	Comprehensive weekly report data structure

wastage_item

Field	Type	Required	Description
unit	string	Required	—
multiplier	number	Required	—
count	number	Required	—
value	number	Optional	—

wastage_line

Field	Type	Required	Description
plu_id	guid	Required	—
unit	string	Required	—
count	number	Required	—
multiplier	number	Required	—

wastage_data_entry

Field	Type	Required	Description
plu_id	guid	Required	—
items	wastage_item[]	Required	—

wastage_data

Field	Type	Required	Description
reason	string	Optional	—
lines	wastage_line[]	Optional	—
data	wastage_data_entry[]	Optional	—

wolt_oauth_access_response

Field	Type	Required	Description
url	string	Required	OAuth URL to redirect user to