Data models
This page contains data models that are utilized across multiple resources.
The property type convention in this context follows the notation of C# (.NET). The presence of a quotation mark (?
) indicates the nullability of a value. For example, a string
property cannot be null, whereas a property of type string?
can have a null value.
Address
Property name | Type | Description |
---|---|---|
|
| Street name, office number and/or building number. |
|
| City |
|
| Postal code |
|
| Country |
ApiKey
Property name | Type | Description |
---|---|---|
|
| Unique identifier. |
|
| Public API key. |
|
| API secret key, used to hash request payload. |
|
| Indicates whether given API key can be used. |
|
| Date and time, when the API key was created. |
|
| Something users will recognize and trust. |
|
| This is displayed to all potential users of your application. |
|
| User identifier associated with given API key. |
|
| Device name associated with given API key. |
|
| Collection of permissions associated with given API key. |
|
| Resource version. This property is tracked and updated by API. |
ArticleCategory
Each product or service within the PORTOS system is linked to a specific category, which is referred to as the article category. This categorization helps in organizing and classifying items, allowing for efficient management and navigation within the system.
Property name | Type | Description |
---|---|---|
|
| Unique abbreviation of article category description, which may contain up to 3 characters. |
|
| Full name (descripition) of article category, visible for cashiers. |
|
| Full description for customer (used mostly in menus) |
|
| Optional course number that will be initially applied to product associated with given article category. |
|
| Color in RGB format, including leading |
|
| Optional sort hint (to order article categories in cash register application) |
|
| Optional collection of tags (used in statistics). |
| Ordering settings for article category. | |
|
| Resource version. This property is tracked and updated by API. |
SortHint
property is used to achieve user defined article categories sorting in cash register application(s). This optional property is of nullable integer type. Article categories with lowest value are displayed first, null
have lowest priority. Categories with same SortHint
value are sorted alphabetically.
Example:
SortHint | Description |
---|---|
0 | Beers |
0 | Drinks |
1 | Pizza |
2 | Wine |
null | Beverages |
null | Specials |
ArticleCategoryOrderingItem
Settings for article category (ArticleCategory
) ordering related to specific OrderOrigin
.
Property name | Type | Description |
---|---|---|
| Order origin associated with this item. | |
|
| Determines whether given type of order origin is enabled for associated Article category. |
| Gets ordering weekly schedule. If value is |
PluPackaging
AuthResult
Name | Type | Description |
---|---|---|
|
| The JWT token using for authenticating requests. |
|
| The refresh token. |
| The user profile consists of information about the user themselves and the settings of the device they are logged onto. Depending on the device type, the structure of |
BackOfficeDeviceSettings
No properties are currently defined. Settings are managed directly in PORTOS BackOffice application.
BankAccount
Property name | Type | Description |
---|---|---|
|
| The country where the bank associated with the account is located. It represents the jurisdiction and regulatory framework under which the bank operates. |
|
| The name of the bank where the account is held. |
|
| International Bank Account Number. A standardized numerical code used to identify a specific bank account internationally. |
|
| Bank account number in older (non international) format. |
|
| SWIFT code (also known as BIC - Bank Identifier Code) is a unique identification code assigned to each bank globally. |
CashRegisterDeviceSettings
Name | Type | Description |
---|---|---|
|
| Maximal quantity user can specify in single ticket item. |
|
| Determines name of fiscal device associated with cash register. Usage of different fiscal device may be conditioned by rights of authorized user. |
|
| Determines whether user can specify unit price of ticket item different than product's unit price. |
|
| Determines whether insufficient PLU stock quantity would be indicated to authorized user. |
|
| Determines whether PLU stock quantities can be visible for authorized user. Otherwise, application must not display such information. |
|
| Determines name of order endpoint device associated with cash register. Usage of different order endpoint may be conditioned by rights of authorized user. |
|
| Determines name of stock associated with cash register. Usage of different stock may be conditioned by rights of authorized user. |
All other settings are managed directly in the PORTOS Cash register application (PORTOS Pokladลa).
CashTransfer
Property name | Type | Description |
---|---|---|
| Cash transfer operation amount. Positive for deposit or negative for withdrawal. | |
|
| Date and time of cash transfer operation |
| Employee who performed cash transfer operation. |
Company
Name | Type | Description |
---|---|---|
|
| Unique company identifier. If not specified, ID is generated by API. |
|
| Gets whether this company is active and can be used (e.g. paired with stock transfers). |
|
| Company name. |
|
| Company registration number (known as IฤO, in Slovak Republic) |
|
| VAT ID (known as Iฤ DPH, in Slovak Republic) |
|
| TAX ID (known as DIฤ, in Slovak Republic) |
|
| Gets whether this company is tax payer. |
|
| The company's entry in the business register |
|
| The number of days given to a company for payment after issuing an invoice. |
| The company categorization. | |
|
| Discount rate percentage, with value between 0 and 100, with precision up to two decimal places, that is automatically assigned to invoice associated with given company. |
|
| When |
| The addresses associated with company. | |
| The bank accounts associated with company. | |
| The contacts associated with company. | |
|
| Resource version. This property is tracked and updated by API. |
CompanyType
Enumeration with the following values:
Value | Description |
---|---|
| Type used when company is not exclusively supplier nor purchaser. |
| Company that is responsible for producing or delivering the products. |
| Also known as a buyer, is a company acquires goods or services from a merchant. |
CompanyAddress
Property name | Type | Description |
---|---|---|
|
| Street name, office number and/or building number. |
|
| City |
|
| Postal code |
|
| Country |
| Specifies purpose of address. |
CompanyAddressType
Enumeration with the following values:
Value | Description |
---|---|
| The specific purpose or nature of the address is not known or specified. It might be used when the address information is incomplete or when there is a lack of information about the purpose of the address. |
| An office address refers to the physical location where a company or organization conducts its business operations. |
| The address to which invoices, bills, or payment requests are sent. |
| Tthe destination address where goods or products are to be delivered. |
| Any address that does not fit into the predefined types mentioned above. |
CompanyBankAccount
Property name | Type | Description |
---|---|---|
|
| The country where the bank associated with the account is located. It represents the jurisdiction and regulatory framework under which the bank operates. |
|
| The name of the bank where the account is held. |
|
| International Bank Account Number. A standardized numerical code used to identify a specific bank account internationally. |
|
| Bank account number in older (non international) format. |
|
| SWIFT code (also known as BIC - Bank Identifier Code) is a unique identification code assigned to each bank globally. |
|
| Indicates whether the bank account is set as the primary account for company. |
Contact
Property name | Type | Description |
---|---|---|
|
| Fax number associated with a person. |
|
| Telephone number associated with a person's landline or fixed-line phone. |
|
| Telephone number associated with a person's mobile device. |
|
| Person's email address. |
CompanyContact
Property name | Type | Description |
---|---|---|
|
| Given or first name of an individual. |
|
| The inherited or family name of an individual. |
|
| Person's email address. |
|
| Telephone number associated with a person's mobile device. |
|
| Telephone number associated with a person's landline or fixed-line phone. |
|
| Fax number associated with a person. |
|
| Indicates whether a particular contact is primary contact for associated company. |
|
| Helds any relevant additional information or comments about the contact. It can be used to include any specific details or instructions related to the contact or communication with the person. |
CountQueryResult
This model is returned for all GET collection routes when $count
query parameter is set to true
. Opposing to QueryResult
, This model is used to retrieve only count of elements, not elements themself.
Property name | Type | Description |
---|---|---|
|
| Number of elements matching the query. |
|
| Number of total resources available. Value may differ from |
Currency
Property name | Type | Description |
---|---|---|
|
| The three-letter currency code ISO4217 standard. |
|
| Visual representation used to denote a specific currency in written or printed form. For example, the symbol for the United States Dollar is $, while the Euro is represented by โฌ. |
|
| Indicates whether a currency is considered the domestic currency of a particular country or region. |
|
| Represents the rate at which one currency can be exchanged for another. Domestic currency's exchange rate is equal to 1. |
|
| Currency's full name. |
|
| Resource version. This property is tracked and updated by API. |
Customer
Name | Type | Description |
---|---|---|
|
| Unique customer identifier. If not specified, ID is generated by API. |
|
| Unique identifier provided by external system. |
|
| Gets whether this customer is active and can be used (e.g. paired with tickets). |
|
| Customer state. One of following: |
|
| Date and time since customer is active. |
|
| Date and time until customer is acive. |
|
| First name. |
|
| Second name. |
|
| Full or display name (if not provided, combination of |
|
|
|
|
| Birth date. |
|
| Customer email. |
|
| Phone number. |
|
| Specifies wheter customer is associated with company. |
| Information about company associated with customer. | |
| Customer address. | |
| Customer delivery address. | |
| Cash balance on customer account. | |
| History of financial operations that affects | |
| Collection of cards associated with customer. | |
|
| Cashback coeficient. If set to |
|
| Discount rate with value between 0 and 100. Up to 2 decimal places. |
|
| Optional note. |
meta | Object that holds additional data (usually supplied by external system). | |
|
| Resource version. This property is tracked and updated by API. |
CustomerAddress
Name | Type | Description |
---|---|---|
|
| Street name and building number |
|
| City |
|
| Postal code |
|
| Country |
| GPS coordinates | |
|
| Note related to customer address |
CustomerCard
Name | Type | Description |
---|---|---|
|
| |
|
| Specifies whether this card is active and can be used. |
|
| Specifies whether this card has physical representation. |
|
| Unique serial number. This value is unique across all customers stored in system. |
|
|
|
| Card status. | |
|
| Date and time of last status change. |
|
| Status change reason. |
|
| The date and time from which the card will be valid. |
|
| The date and time until which the card will be valid. |
|
| Optional note related to this customer card. |
| Object that holds additional data (usually supplied by external system). | |
|
| Resource version. This property is tracked and updated by API. |
CustomerCardStatus
Enumeration with the following values:
NotIssued
: the card is created in system, but not issued yet.IssueFailed
: card issuing failed.IssueCanceled
: card issuing has been canceled.IssueSkipped
: card issuing has been skipped, as one or more conditions were not met.ReissueRequested
: a reissue was requested.Valid
: card is issued and valid (active already and not yet expired)NotYetValid
: Card is issued but not yet valid (activationTime
has not been reached yet).Expired
: card is expired (expirationTime
has been reached).Blocked
: card is blocked (e.g. has been lost or compromised)DisposeRequested
: card disposal has been requested.Disposed
: card has been disposed.
CustomerCompany
Name | Type | Description |
---|---|---|
|
| Company name. |
|
| Company registration number (IฤO). |
|
| Company VAT identifier (Iฤ DPH) |
|
| Company TAX identifier (DIฤ) |
CustomerCreditTransaction
Name | Type | Description |
---|---|---|
|
| Unique transaction identifier. |
|
| External identifier supplied by client-side or external system. |
|
| Transactions sequence number. Value is supplied by API. |
| Transaction amount. Can be positive or negative number. | |
| Type of transaction. | |
| Resulting credit balance after transaction. | |
|
| Date and time of transaction. |
|
| Optional note related to transaction. |
| Object that holds additional data (usually supplied by external system). |
CustomerCreditTransactionType
Enumeration with the following values:
adjustment
: credit consumption or cash-backdeposit
: credit top upwithdrawal
: funds withdrawalcorrection
: manual balance correctionother
: none of above
DailySalesReport
Name | Type | Description |
---|---|---|
|
| Unique identifier. If not specified, ID is generated by API. |
|
| Name of fiscal device associated with given daily sales report. |
|
| Daily sales report sequence number, unique within specific |
|
| Serial number of fiscal memory inserted in fiscal device. |
|
| Date and time of daily sales report creation (related to first ticket closure or first cash transfer since previous daily sales report). |
|
| Date and time of daily sales report closure. |
|
| Label of currency, in which all money information is stored for this daily sales report |
| Collection of cash transfers. | |
| Information determined during fiscal daily sales report closing procedure. Is null when | |
| ||
|
| Resource version. This property is tracked and updated by API. |
DailySalesReportCopyContext
This model is used to specify the daily sales report for which a copy is going to be printed. The daily sales report can be identified by either its number (dailySalesReportNumber
property) or the closing date of the report (dailySalesReportDate
properties).
Name | Type | Description |
---|---|---|
|
| Daily sales report number. |
|
| Daily sales report close date. |
DailySalesReportFiscalInfo
Property name | Type | Description |
---|---|---|
|
| |
| ||
|
| |
| ||
|
| |
| ||
|
| Number of ticket items with |
| Total amount of ticket items with | |
|
| Number of ticket items with |
| Total amount of ticket items with | |
|
| Number of ticket items with |
| Total amount of ticket items with | |
|
| Number of ticket items with |
| Total amount of ticket items with | |
|
| Number of ticket items with |
| Total amount of ticket items with | |
|
| Number of ticket items with |
| Total amount of ticket items with | |
|
| Number of ticket items with |
| Total amount of ticket items with | |
|
| Number of ticket items with |
| Total amount of ticket items with | |
| Total turnovers grouped by VAT category and rate. | |
grandTotalAmountIncludingVat | Cumulative total turnover across all daily sales reports for given fiscal device and fical memory serial number. | |
roundingDown | Sum of roundings towards zero. | |
roundingUp | Sum of roundings away from zero. |
DailySalesReportStatus
Enumeration with the following values:
Value | Description |
---|---|
| Daily sales report is opened. Additional tickets and cash transfers can be associated with given daily sales report. |
| Associated daily sales report is marked as closed (value of |
| Daily sales report is closed. |
DayOfWeek
Specifies the day of the week. Enumeration with the following values:
Value | Description |
---|---|
| Indicates Sunday. |
| Indicates Monday. |
| Indicates Tuesday. |
| Indicates Wednesday. |
| Indicates Thursday. |
| Indicates Friday. |
| Indicates Saturday. |
Device
Property name | Type | Description |
---|---|---|
|
| Unique device name. |
|
| Indicates whether a device is active and can be associated with user session. |
|
| Name of the device environment. |
|
| Human readable device description (e.g. "Cash register 1"). |
|
| Collection of user rights that are initially associated to user, when user is given access to this device. Roles collection can be adjusted for every user. |
|
| Object containing user-specific preferences for this device. Reserved for future use. |
| An object with string properties, that is used to store device settings. The value of each property within the object corresponds to a specific type based on the | |
|
| Resource version. This property is tracked and updated by API. |
EmailTicketFormOptions
Name | Type | Description |
---|---|---|
|
| The e-mail address of the recipient (customer) to whom the e-receipt is sent. |
|
| The optional text that is displayed on end of receipt. Only non-control characters are allowed (and CR + LF). |
Fiscal
Property name | Type | Description |
---|---|---|
|
| Unique fiscal device name. |
|
| Indicates whether given fiscal device can be used in ticket closing procedure. |
|
| Type of hardware device. |
|
| Reserved for future use. |
|
| Unique cash register code (also known as DKP in Slovak republic). |
|
| Settings related to given fiscal device. Object may vary based on |
|
| Resource version. This property is tracked and updated by API. |
ForeignPrice
Similiar to Price
, however this model can hold information about non-domestic currency.
Property name | Type | Description |
---|---|---|
|
| Up to 2 decimal places. |
|
| 3-characters long foreign currency label (ISO 4217). |
|
| 3-characters long domestic currency label (ISO 4217). |
|
| Conversion rate between foreign and domestic currency. When currency is equal to domestic currency, exchange rate is equal to 1. |
GeoCoordinates
Represents GPS coordinates.
Property name | Type | Description |
---|---|---|
|
| Value in range of -180 to 180. |
|
| Value in range of -90 to 90. |
IntervalSalesReportContext
This model is used to specify the interval of daily sales reports, for which a interval sales report is going to be printed. The interval can be defined either by specifying a range of daily sales report numbers (dsrNumberFrom
and dsrNumberTo
properties) or by indicating the closing dates of the daily sales reports (dsrDateFrom
and dsrDateTo
properties).
Name | Type | Description |
---|---|---|
|
| Close date of first daily sales report in selected interval. |
|
| Close date of last daily sales report in selected interval. |
|
| Number of first daily sales report in selected interval. |
|
| Number of last daily sales report in selected interval. |
License
Name | Type | Description |
---|---|---|
|
| Unique identifier of venue, issued by PORTOS reseller. |
|
| Activation date and time. |
|
| Expiration date and time. |
|
| Date and time of last verification. |
|
| Verification interval. |
| Collection of features associated with license. | |
|
| Number of remaining days before license expiration. |
|
| Indicates whether license is expired. |
LicenseFeature
Name | Type | Description |
---|---|---|
|
| The feature identifier. |
|
| Value associated with feature. |
|
| Feature display name. |
|
| Activation date and time. |
|
| Expiration date and time. |
MeasureQuantity
Unlike the Quantity
type, this model has a known unit of measure.
Property name | Type | Description |
---|---|---|
|
| Quantity amount. |
| Measurement unit. |
MeasureUnit
Enumeration with the following values:
Value | Description | Dimension |
---|---|---|
| Gram | Weight (Mass) |
| Decagram | Weight (Mass) |
| Kilogram | Weight (Mass) |
| Milliliter | Volume |
| Deciliter | Volume |
| Liter | Volume |
| Millimeter | Length |
| Centimeter | Length |
| Decimeter | Length |
| Meter | Length |
Meta
Meta is an object with dynamic properties of string type. Can be parsed to Dictionary<string, string>
instance.
Is used to hold additional data, usually supplied by external system.
Modifier
Name | Type | Description |
---|---|---|
|
| Unique identifier |
|
| Name of modifier. Eg. "Steak doneness" |
|
| Name to be displayed for customer. Eg. "Pick steak doneness". If not provided, |
|
| Minimum count of selected unique options. This value is greater than zero if modifier is required. |
|
| Maximum count of selected unique options. If set to |
|
| The maximum number of all selected options in total that the customer can choose. |
| Options collection. |
ModifierOption
Name | Type | Description |
---|---|---|
|
| Option identifier, unique within associated modifier options collection. |
|
| Modifier option name, e.g. "medium rare". |
| Optional unit price. If not specified, price of referenced product is used. Otherwise, modifier does not modify the price of associated ticket item. | |
|
| Specifies whether |
| Optional PLU reference. | |
|
| Default selected quantity. |
|
| Maximum number of selections for this option. If set to |
NonfiscalRecordContext
Name | Type | Description |
---|---|---|
|
| Body of nonfiscal record. |
NumberingPeriodUnit
Enumeration with the following values:
Value | Description |
---|---|
| Day |
| Month |
| year |
Order
Name | Type | Description |
---|---|---|
|
| Unique identifier |
|
| Sequence number generated by API. This number may serve as pickup code for customer. |
|
| Name of device, from which the order processing request has been invoked. |
| User that invoked order processing request. | |
| Information about ticket that is associated with given order. | |
| Order items collection. |
OrderEndpoint
Name | Type | Description |
---|---|---|
|
| Unique name. |
|
| Indicates whether order endpoint is used to accept orders. |
|
| Order endpoint address (e.g. location of network printer). |
|
| Type of order endpoint (e.g. printer manufacturer and/or printer model, or kitchen tablet application/driver name). |
|
| Based on |
OrderItem
Name | Type | Description |
---|---|---|
|
| Unique item identifier within order. |
| Information related to product. | |
| Ordered product quantity. | |
|
| Optional comment/note from cashier. |
|
| This optional property serves as an indicator for the sequential delivery of food to the table. It allows for the organization and coordination of food service by assigning a specific order or sequence to each dish. This number provides valuable information to ensure that dishes are delivered to the table in the desired order, optimizing the dining experience for the customers. |
| Contains collection of state changes related to each oder endpoint this order is being processed on. |
OrderItemEndpoint
Name | Type | Description |
---|---|---|
|
| Name of associated order endpoint device. |
| History of order state changes related to associated order endpoint. | |
| Current status of order related to associated order endpoint. | |
|
| Indicates whether the order is already processed on given order endpoint. |
|
| Indiates whether the order is processable on given order endpoint (is not in terminal state). |
OrderItemEndpointStatusChange
Name | Type | Description |
---|---|---|
| Status of order at the time of change. | |
|
| Date and time of status change. |
OrderItemPlu
Name | Type | Description |
---|---|---|
|
| Name of product (PLU). |
|
| Product code (unique within given stock) |
|
| Name of the stock to which the product is associated |
OrderOrigin
Describes the origin of the order.
Value | Description |
---|---|
| Order is taken in store by cashier (personnel) |
| Order is placed online by customer (e.g. e-shop, delivery platform, etc.) |
OrderTicketInfo
Name | Type | Description |
---|---|---|
|
| Ticket identifier. |
|
| Ticket name. |
| Ticket location. | |
| Ticket purchase type. | |
| Information about customer associated with ticket. | |
|
| Version of ticket at time of order creation. |
OrderStatus
These are the various states that an order can go through during its processing and fulfillment. Each state provides valuable insights into the current status of the order, ensuring transparency and effective communication throughout the process. Please find below the detailed descriptions for each order state:
Value | Description |
---|---|
| The default state. It indicates that the order processing status is currently unknown and/or has not been initiated. |
| |
| The order has been successfully sent to the designated order endpoint for processing. |
| The order has been successfully delivered to the designated order endpoint. However, at this point, the endpoint may either accept or refuse the order. |
| The order was refused by the order endpoint, indicating that the order endpoint has declined to accept and process the order. This refusal could be caused by various reasons, such as a shortage of food supplies or a failure of the coffee machine, so it is unable to fulfill the order at that specific moment. |
| There was an attempt to send or deliver the order to the order endpoint, but it could not be completed due to an error. This could be due to technical issues or other factors preventing successful delivery. |
| The order was successfully delivered to the order endpoint, displayed, and accepted by the recipient (e.g., a chef received the order and acknowledged it). This state indicates that the recipient is ready to proceed with the fulfillment of the order. |
| The processing of the order was intentionally skipped. This could occur when the order endpoint device was marked as inactive during the processing attempt. |
| The order has been marked as completed by the order endpoint, signifying the successful execution of all necessary processing steps, and confirming that the order is now fulfilled and the goods are ready for pickup. |
Please see the state transition diagram below. The arrows between the states indicate the allowed transitions that the order can take.
Order is processable if state is created
or failed
.
The order reaches its final state when it is either refused,
processed
or processSkipped
and no further state transitions are permitted beyond this point.
OrderStatusContext
Name | Type | Description |
---|---|---|
| Desired order status. Please note that only specific order staus transitions are allowed. See |
PaymentType
Property name | Type | Description |
---|---|---|
|
| Unique payment type number. Value must be in range from 1 to 10. |
| Category of payment type. Based on payment type category, different ticket rounding rules may apply. | |
|
| Gets or sets whether payment type can be used. |
|
| Payment type description (name). |
|
| Determines whether it is possible to issue from the payment when the amount to pay is overpaid. Note: not used in current version. |
PaymentTypeCategory
Enumeration with the following values:
Value | Description |
---|---|
| Cash payment type. |
| Cashless payment type. |
| Other, non-cash payment type. |
PDADeviceSettings
Name | Type | Is required | Description |
---|---|---|---|
|
| Maximal quantity user can specify in single ticket item. | |
|
| Determines name of fiscal device associated with cash register. Usage of different fiscal device may be conditioned by rights of authorized user. | |
|
| Determines whether user can specify unit price of ticket item different than product's unit price. | |
|
| Determines mode of customer account lookup. If set to | |
|
| Determines name of order endpoint device associated with cash register. Usage of different order endpoint may be conditioned by rights of authorized user. | |
|
| Determines name of stock associated with cash register. Usage of different stock may be conditioned by rights of authorized user. |
All other settings are managed directly in the application (PORTOS Mobilnรฝ ฤaลกnรญk).
Plu
Property name | Type | Description |
---|---|---|
|
| Unique identifier. |
|
| Name of associated |
|
| Product's PLU code. Unique within associated |
|
| Collection of alternative product codes, barcodes or external system identifiers. |
|
| Product name. E.g. "Coffee". |
|
| Optional full product name. If this value is provided, it is used as display name instead of |
|
| Full description for customer, containing one or more sentences. Used mostly in menus. E.g. "Indulge in the rich and aromatic essence of our meticulously brewed coffee, a harmonious blend of carefully selected beans for a truly invigorating experience.". |
| The unit price excluding VAT.
Must be positive or zero for | |
|
| The category of associated VAT rate. |
|
| The label of associated article category. |
|
| The collection of order endpoint names. When product is ordered by customer, order is sent to all order endpoints listed in this collection that are marked as active. |
|
| Specifies default course number for given product. Used to determine the order of food and drinks brought to the table. |
|
| Up to three characters long measurement unit. |
| Type of product. | |
| This field indicates the total count of physical units currently available in inventory. Exclusively for PLUs categorized as material type. | |
| Minimal stock quantity treshold. Defines the minimum acceptable quantity of physical units. When the available inventory falls below this threshold, users can receive notifications to take necessary actions. Exclusively for PLUs categorized as material type. | |
| The stock value excluding VAT. Exclusively for PLUs categorized as material type. | |
| Last purchase price excluding VAT. Exclusively for PLUs categorized as material type. This value is automatically updated by server after each product purchase (based on created StockTransfer). | |
| Items of PLU recipe. Exclusively for PLUs categorized as | |
| Collection that tracks retail price changes. | |
|
| The RGB color code associated with this PLU, which is displayed within the cash register application. This feature aids in convenient visual identification, facilitating efficient lookups. |
|
| If set to |
|
| Determines whether discount can be placed on ticket item associated with this PLU.
Must be false for |
|
| Determines whether this PLU is accessible in cash register. If given product or service is not available, associated PLU can be marked as inactive. This is alternative approach to PLU deletion. |
|
| Determines whether unit price for ticket items associated with this PLU can be adjusted. Howewer, price change must be allowed in device settings as well. |
|
| Determines whether cashback can be provided for purchase of this PLU. When enabled, customers may receive cashback as part of their purchase. The purchase must be associated with Customer with positive, non-zero |
|
| This attribute indicates whether the given product is registered as a favorite, enabling easier retrieval within the cash register system. |
|
| This optional attribute serves as a hint for sorting articles within the cash register application, aiding in the organization and arrangement of items. |
| This attribute signifies the justification for applying a zero VAT rate to this PLU, if the rationale matches with one of the reasons defined in | |
| Information related to PLU packaging. | |
|
| Optional PLU images. |
| Purchase types settings for this product. | |
| Information related to PLU ordering, based on | |
|
| Collection of Modifier references associated with given PLU. |
|
| Resource version. This property is tracked and updated by API. |
PluId
Plu can be uniquely identified using either id
or combination of code
and stockName
.
Property name | Type | Description |
---|---|---|
|
| Plu's |
|
| Plu's |
PluImage
Property name | Type | Description |
---|---|---|
|
| String which identifies one or more image candidate strings, separated using commas (,) each specifying image resources to use under given circumstances. Each image candidate string contains an image URL and an optional width or pixel density descriptor that indicates the conditions under which that candidate should be used. Please refer to https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/srcset for more information. |
|
| Optional field. Provides fallback (alternate) text to display when the image is not loaded. Please refer to https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt for more information. |
PluModifier
Property name | Type | Description |
---|---|---|
|
| Unique modifier identifier. |
PluOrderingItem
Settings for product (PLU
) ordering related to specific OrderOrigin
.
Property name | Type | Description |
---|---|---|
| Order origin associated with this item. | |
|
| Determines whether given type of order origin is enabled for associated PLU. |
|
| Determines whether given type of order origin is temporarily paused (e.g. due to high demand or due to machine failure). |
PluPackaging
Property name | Type | Description |
---|---|---|
| Specifies the volume of the product within its packaging. Value must have positive, non-zero amount. | |
| Specifies the weight of the product packaging. Value must have positive, non-zero amount and weight unit ( | |
| When provided, this attribute specifies the PLU that represents the packaging of associated product. | |
|
| Enabling this option by setting it to |
PluPriceHistoryItem
Property name | Type | Description |
---|---|---|
|
| The date and time of retail price change. |
| The new product retail unit price (excluding VAT). |
PluPurchaseType
Settings for product (PLU
) related to specific PurchaseType
.
Property name | Type | Description |
---|---|---|
| The purchase type associated with this item. | |
|
| Determines whether given type of purchase type is enabled for product. |
|
| VAT category that is used for given PurchaseType. Retail price excluding VAT is adjusted, so retail price including VAT is preserved, after given VAT category is applied. |
PluReceiptItem
Property name | Type | Description |
---|---|---|
| The quantity that should be subtracted from the stock when a single unit of the parent PLU is sold. | |
| Identifier of PLU to be subtracted. | |
|
| The PLU referenced by |
PluType
Enumeration with the following values:
Value | Is material | Description |
---|---|---|
| Stock item (e.g. ingredient or material). A cover that can be the subject of a deposit and can be repurchased by a trader. This is an material product that has physical representation and associated stock quantity and can be processed in stock takings. | |
| Recipe (e.g. meal or complex product) that can reference other recipes, stock items or containers in recipe list. Stock quantity is not tracked for this type of product. | |
| Service that has no physical form and thus stock quantity is not tracked for this type of product. | |
| A container (cover) that can be the subject of a deposit and can be repurchased by a trader. This is an material product that has physical representation and associated stock quantity and can be processed in stock takings. |
Price
Used also as an multiplication result of Quantity
and UnitPrice
instances.
Property name | Type | Description |
---|---|---|
|
| Up to 2 decimal places. |
|
| 3-characters long currency label (ISO 4217). |
PrintPreliminaryTicketContext
Name | Type | Description |
---|---|---|
|
| The name of the order endpoint where the preliminary receipt will be printed. |
PrintTicketFormOptions
Name | Type | Description |
---|---|---|
|
| The optional text that is displayed on end of receipt. Only non-control characters are allowed (and CR + LF). |
ProcessOrdersContext
Property name | Type | Description |
---|---|---|
|
| Collection of ticket identifiers. All orders associated with given tickets will be processed. |
ProductLicenseActivation
Property name | Type | Description |
---|---|---|
|
| Activation code. |
| License to be activated. |
ProductLicenseRequest
Property name | Type | Description |
---|---|---|
|
| Unique venue identifier. |
| List of features. |
ProductLicenseRequestFeature
Name | Type | Description |
---|---|---|
|
| The feature identifier. |
|
| Value associated with feature. |
|
| Feature display name. |
|
| Activation date and time. |
|
| Expiration date and time. |
PurchaseType
Enumeration with the following values:
Value | Description |
---|---|
| Purchase type is not specified. |
| The purchase is being held at the venue. |
| The purchase is being picked up at the venue by customer. |
| The purchase will be delivered to customer. |
Quantity
Property name | Type | Description |
---|---|---|
|
| Up to 3 decimal places. |
|
| Up to 3-characters measurement unit. |
QueryResult
This models represents generic response from all API routes that returns collection of resources.
Property name | Type | Description |
---|---|---|
|
| Collection of resources that met query criteria. |
|
| Number of elements in |
|
| Number of total resources available. Value may differ from |
RecordCopyContext
This model is used to specify the ticket for which a copy is going to be printed. The ticket can be specified by providing either its ticket number and daily sales report number (ticketNumber
and dailySalesReportNumber
properties), or its ticket number along with the close date of the daily sales report (ticketNumber
and dailySalesReportDate
properties).
Name | Type | Description |
---|---|---|
|
| Ticket sequence number, unique within associated daily sales report. This value can be found in |
|
| The number of daily sales report. This value can be found in |
|
| The close date of daily sales report. |
RefreshTokenResult
Name | Type | Description |
---|---|---|
|
| The JWT token using for authenticating requests. |