---
swagger: "2.0"
info:
version: "5.19.1-b19-SNAPSHOT"
title: "GK application - OmniPOS Service API"
host: "localhost:8080"
basePath: "/pos-service/tenants/ Getter for inner key class. This DB table\_contains info about commands\
\ for POSes registered by POS server processes. Getter for inner key class. This DB table contains information about Getter for inner key class. This DB table\_contains about\
\ save and tills used on workstations. Getter for inner key class. Getter for inner key class. TODO TODO TODO TODO TODO Bank description. Bank account number in a national format, not international. Bank identification code in a national format. International bank account number (IBAN). A standard number\
\ standardized in accordance with the ECBS (European Commitee for Banking\
\ Standards) to represent bank details. Bank identification code in the international format (BIC).\
\ Uniquely identifies a bank throughout the world. This type code is used to differ between multiple bank accounts.\
\ Optional - if not provided then filled in the import. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Information about bank account. Identifier for a retail store, distribution center or administration\
\ center (internal identifier). Identifier for a group of business units. Street City Postal code Filter for searching of address Getter for inner key class. External identifier for the business unit. ID of the parent business unit group External ID of the parent business unit group A unique internal identifier for a level within the business\
\ unit grouping hierarchy. Name of the level within the business unit grouping hierarchy\
\ (external identifier of level). Global location number VAT registration number SAP time zone code ID of the time zone in the Java format (e.g. 'US/Eastern',\
\ 'Europe/Prague') ISO-Code of the language which is used in the business unit The name of the business unit The surrogate name of the business unit Effective date of the assignment to the GK Determines the assignment to the RG business unit group hierarchy Determines the assignment to the SEH business unit group\
\ hierarchy ID of the parent business unit group with the function code\
\ 'OMS' Determines whether the GK system is installed in the store\
\ or not Identifier of the main currency of the retail store. Determines whether this store provides data to the GFK organization The size of the retail store. This is usually split by the\
\ non-sales and sales areas. The size of the selling floor. In a large store this is further\
\ split by the sales floor and by the merchandise departments. Code of the MerchandiseHierarchyFunction which is relevant\
\ for that store Indicates if the prices include all applicable sales taxes\
\ or not. The company's tax number given by the tax office (this is\
\ not the sales tax ID). The second currency which is e.g. to be shown in the receipt\
\ total and to be printed on the receipt (during the time of changing of\
\ a local currency to EURO) The name of the unit which is mainly used for weighing information An organizational unit responsible for procuring materials\
\ or services for one or more plants and for negotiating general conditions\
\ of purchase with suppliers. List of receiving locations. List of company codes of the store. List of bank accounts ID of the party information Reference to the party structure List of contacts List of translations for the business unit. Internal identification of the import package (e.g. IDoc\
\ file). The identification is used for monitoring purposes. Identifier of an organizational unit responsible for the\
\ sale of certain products or services. Distribution channel is the way in which products or services\
\ reach the customer. The UTC0 date and time when the business unit was finally\
\ deleted The status of business unit. Possible values include the\
\ codes for enabled, disabled, scheduled for deletion, deleted. Geo positional co-ordinates of a business unit specifying\
\ its latitude using Decimal Degrees system (ISO 6709). Geo positional co-ordinates of a business unit specifying\
\ its longitude using Decimal Degrees system (ISO 6709). Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Translation identifier - used for the unique identification\
\ of translations in the common translation table. A retail store, distribution center or administration\
\ center at which the retailer conducts retail operations. A unique retailer assigned identifier for a retail store,\
\ distribution center or administration center (internal identifier). A unique system assigned identifier for the group of business\
\ units. Getter for inner key class. Language of the business unit group. The common name for the business unit group External identifier of the business unit group. A business function for which business unit groups are placed\
\ into separate grouping hierarchies. A unique internal identifier for a level within the business\
\ unit grouping hierarchy. The distance from the root of the business unit group tree\
\ which applies to the business unit. Is used in order to increase the performance. List of translations for business unit group. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Translation identifier - used for the unique identification\
\ of translations in the common translation table. A related group of administration centers,\
\ distribution centers and retail stores, with names like group, cluster, region,\
\ district, zone and state. A unique system assigned identifier for a group of business\
\ units. Getter for inner key class. The receipt text. List of translations for the denomination. Internal identification of the import package (e.g. IDoc\
\ file). The identification is used for monitoring purposes. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Translation identifier - used for the unique identification\
\ of translations in the common translation table. Receipt texts (header and footer). Ident of the retail store. Type of the receipt text (e.g. FOOTER) A sequence number of the receipt text. Getter for inner key class. The city, town or village component of the address. The postal or zip code of the address. The country code of the company or the person. Name of the region. Name of federal state. The first line of the address, normally the street name and\
\ number. The second line of an address, normally the Flat or Building\
\ Suite number. The third line of the address The fourth line of the address. The fifth line of the address. The extension of the postal or zip code that further specifies\
\ a particular postal district. A state, province, or other region within a country. Denotes if the contact address data can be used for marketing\
\ purposes. Tax handling code defined within the customer address (region)\
\ is used for the tax calculation. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. List of addresses Code denoting a reason for contacting a Party. A retailer assigned code denoting a method of contacting\
\ a Party. Suggested values include: WorkPhone, HomePhone, WorkFax, HomeFax,\
\ Mobile, Pager. Getter for inner key class. Internet URL List of the addresses. List of the telephone contacts. List of the email-addresses. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development List of various contacts for a Party, e.g. address,\
\ telephone, fax, email-address. The unique identifier of the business unit group. A unique, system assigned identity for a Party. A code that identifies a group of PARTY ROLES. This is used\
\ for subtyping the PARTY ROLEs A unique system assigned identifier for the particular assignment\
\ of Party to the PartyRole. Getter for inner key class. E-mail address of the company or the person. Denotes if the contact email address data can be used for\
\ marketing purposes. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. List of email addresses. Code denoting a reason for contacting a Party. A retailer assigned code denoting a method of contacting\
\ a Party. Suggested values include: WorkPhone, HomePhone, WorkFax, HomeFax,\
\ Mobile, Pager. Getter for inner key class. The complete telephone number Denotes if the contact telephone data can be used for marketing\
\ purposes. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. List of telephone and fax numbers. Code denoting a reason for contacting a Party. A retailer assigned code denoting a method of contacting\
\ a Party. Suggested values include: WorkPhone, HomePhone, WorkFax, HomeFax,\
\ Mobile, Pager. Getter for inner key class. National symbol for the main unit of currency, e.g. £, $,\
\ etc List of translations for the currency. Internal identification of the import package (e.g. IDoc\
\ file). The identification is used for monitoring purposes. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. The ISO code of the country issuing the currency. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. A name of the currency, i.e. pounds sterling, US dollars,\
\ Canadian dollars, etc. Numeric code assigned by ISO to identify national currencies. Translation identifier - used for the unique identification\
\ of translations in the common translation table. Specifies the national designation and quantitative\
\ value of monetary media used as tender. The unique identifier of the business unit group. Currency code designated by ISO to identify national currency.\
\ The unique identifier of the currency. Getter for inner key class. Defines how the result is to be rounded: Count of decimals which the result should have Additional information for rounding, possible values: Defines the denomination value that is used for rounding\
\ payment amounts on POS. Internal identification of the import package (e.g. IDoc\
\ file). The identification is used for monitoring purposes. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. RoundingRules contains fields for rounding\
\ rules for specific BUG. The unique identifier of the business unit group. Currency code designated by ISO to identify national currency. The card number (Identifier). A retailer assigned code denoting the official body that\
\ issued the PartyIdentification to the Party. Defines why this identifier is locked. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Credit card. The card type The card number (Identifier). Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Customer card A customer is a person or individual who\
\ purchases, may purchase, or did purchase goods or services from a retail store. The identifier for a group of business units. The identifier for the customer. A customer name. The street name and number The city, town or village component of the address. The postal or zip code of the address. The ISO country code Name of the region. The complete telephone number including the country code,\
\ area code, telephone number and extension number. Email address View for displaying customer contact Getter for inner key class. An external unique identifier for a group of business units. Denotes the group of allowed tenders. Credit limit of the customer. The personal number, unique key for the employee identification.\
\ (The number of the Identification that identifies the Party). Denotes the group of prohibited tenders. Remaining credit limit of the customer. (Total credit limit\
\ - amounts of invoices which haven't been paid yet). Determines whether the customer is liable to tax on sales The current status code of the customer, e.g. active, blocked. Default printout mode of the customer. The company's tax number given by the tax office (this is\
\ not the sales tax ID). Party ID List of the customer credit cards. List of the customer cards. List of CustomerGroupID's. An official number that may be used to identify a Party.\
\ People and businesses have multiple forms of such identification: Drivers\
\ License number, Passport number, Credit / Debit Card number, Company Incorporation\
\ number, Tax number, etc... Additional data for the organization if the customer is a\
\ organization. Contacts for the customer, e.g. address, telephone, fax,\
\ email-address. Reference to the party structure Additional data for the person if the customer is a person. Internal identification of the import package (e.g. IDoc\
\ file). The identification is used for monitoring purposes. Denotes if the customer declaration is available. Date of the customer declaration. Identification of person who has recorded the customer declaration\
\ (e.g. ID of logged Operator). Denotes if the customer data can be used for statistical\
\ purposes. Timestamp of the last access to the data. A unique system assigned identifier for the Customer. List of the customer partner roles. First Name Line of the customer to which this buyer / contact\
\ person belongs. Second Name Line of the customer to which this buyer / contact\
\ person belongs. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. A customer is a person or individual who purchases,\
\ may purchase, or did purchase goods or services from a retail store. A unique system assigned identifier for a group of business\
\ units. A unique identifier for the customer. An organization's legal trade name. Legal status code is a code which is used to define a tax\
\ classification of the customer. It specifies the kind of treatment for\
\ tax purpose. Additional data for the organization if the customer\
\ is a organization. A unique system assigned identifier for the Customer. The type of the partner role. Determines whether this partner role is the default one in\
\ case that multiple partner roles exist. PartnerRole. Getter for inner key class. Description of the customer tender group Determinates whether the customer tender group is to be used\
\ as default. (This flag must be set for exactly one row of the table.) Internal identification of the import package (e.g. IDoc\
\ file). The identification is used for monitoring purposes. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Customer tender rule is used for assigning\
\ 0..n tenders to a group which can be assigned to a customer. By this way customer-dependent\
\ tenders can be reached. A unique system assigned identifier for a group of business\
\ units. A unique identifier of the customer tender group Getter for inner key class. A description of the quantitative value of a specific currency. The quantitative value of a specific currency. Type code of denomination: Determines whether rolls are available. Count of coins in the roll. List of translations for the denomination. Internal identification of the import package (e.g. IDoc\
\ file). The identification is used for monitoring purposes. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Translation identifier - used for the unique identification\
\ of translations in the common translation table. Specifies the quantitative value of the referenced\
\ CURRENCY media. An identifier which uniquely identifies the quantitative\
\ value of a specific currency, e.g. $100, £50, etc. Currency code designated by ISO to identify national currency A unique system assigned identifier for a group of business\
\ units. The qualifier for the name of the dynamic item list. E.g.\
\ 'Vegetable'. The timestamp for the last change of the dynamic item list. TODO A unique system assigned identifier for a group of BusinessUnits. The list of qualifiers for the name of the dynamic item list.\
\ E.g. 'Vegetable'. Search criteria The qualifier for the name of the dynamic item list. E.g.\
\ 'Vegetable'. The timestamp for the last change of the dynamic item list. The list of pos uom item views for a given tableau Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO Customizable information for DynamicTableauItemListDO View object A unique system assigned identifier for a group of BusinessUnits. The list of qualifiers for the name of the dynamic item list.\
\ E.g. 'Vegetable'. List of language ids. List of text classes. Search criteria Translation text Text class Language id text number Pos uom item text view. The ID used to identify the item. Item number. Alphanumeric key that identifies the item uniquely. Main POS item id The uom item text list The uom item name Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for DynamicTableauItemListItemDO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for ItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Customizable information for UomItemSO Pos uom item view. Getter for inner key class. The unique system assigned identifier of the source currency. The unique system assigned identifier of the destination\
\ currency. The date on which a specific exchange rate becomes effective. Date on which the exchange rate expires and is no longer\
\ valid. The buying rate of the tender type, based on the store's\
\ local currency. Determines whether inside the calculation FromCurrencyCode\
\ -> ToCurrencyCode the amount is to be multiplied with (true) or divided\
\ by (false) the ToBuyAmount / ToSellAmount Internal identification of the import package (e.g. IDoc\
\ file). The identification is used for monitoring purposes. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. A exchange rate expresses the quantitative conversion\
\ factor between two kinds of currency, one which must be the store's home currency. The identifier for a group of business units. The unique identifier of the source currency. The unique identifier of the destination currency. A sequence number denoting the order in which Exchange rate\
\ records were created for this pairing of currencies. Getter for inner key class. Describes a gift certificate type List of translations. Internal identification of the import package (e.g. IDoc\
\ file). The identification is used for monitoring purposes. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Translation identifier - used for the unique identification\
\ of translations in the common translation table. Gift certificate class Identifies a gift certificate type. ID of the business unit group Getter for inner key class. Reference to a characteristic of this\
\ item. The identifier of the characteristic (e.g. 'color', 'size'). The identifier of the characteristic value (e.g. 'black',\
\ '38'). Getter for inner key class. The number of individual member items that are assembled\
\ into the collection Structured items (e.g. display items) consist\
\ of other items (collection members). The item collection contains references\
\ to these members. Item ID of the collection member Unit of measure of the collection member Getter for inner key class. The name by which the item is known. The textural description of the item. Class code (eg. empties, fresh food). Usage example: Via\
\ customizing is possible to disable the registration of items with this\
\ class code. A tax group which links a tax authority to the merchandise\
\ to which the tax applies. An alternative tax group which links a tax authority to the\
\ merchandise to which the tax applies. Specifies the category of the item (e.g. single item, item\
\ variant, display). A code to denote the tax exemption status from sales and\
\ use tax. The duration of the item's warranty in months Defines the number of weight units of measure for the tare. Tare UOM code. Reference to the POSDepartment the item belongs to The main POS item identifier References the default merchandise hierarchy group the item\
\ belongs to Deposit type of the item. Selling rules for this item This code defines the current state of an item within the\
\ retail store. List of item collections List of the item associations List of item characteristics with values List of POS item ID's (EANs) List of selling prices List of deposits List of text to UOMItem List of merchandise hierarchy groups Sales restriction for this item Determines whether the item is inventory-tracked Code of the base unit of measure. The base unit of measure\
\ is automatically selected if the item is registered by ItemID. Determines whether this item cannot be considered within\
\ physical inventories The number of business days the SHELF ITEM may be displayed\
\ for sale to customers and after which must be removed. Type of the label A code which is used by the loyalty engine in order to determine\
\ whether the item can get rebate/points. Possible values: 0..9 Time range (count of days) between production date and best-before\
\ date Percentage for calculating the shelf life day count The unit of measure of the 'day count' elements (day or week) Default receiving place Defines whether the item is a concession item. Concession\
\ items are not maintained by the retailer, but by a vendor itself. E.g.\
\ snacks and food in vending machines. Defines whether the item is a cost item Determines the merchandise planning - the way, how the item\
\ is ordered (automatically, manually, not orderable, ..). Reference to the main supplier of this item Determines whether this item is sold via VENSAFE. Consumer package gross content of the base UOM of the item The consumer package content, as claimed on the label. e.g.\
\ Evian Water 750ml - net content = '750 MLT' 20 count pack of diapers,\
\ net content = '20 ea.' Net/gross contents uom Quantity measured in ConsumerPackageBasePriceUOMCode units\
\ for which the base price is to be determined Example: Base price contents unit of measure Identifier of the distributing warehouse (used in the purchase\
\ order process) Identifier of the distribution method (used in the purchase\
\ order process) Identifier of the assortment (used e.g. in the purchase order\
\ process) Identifier of the 3rd party assortment (used in the purchase\
\ order process) Identifier of the transport association (used in the purchase\
\ order process) If the item is a concession item, this is the reference to\
\ its supplier The default selling unit of measure of the item Numerator for the conversion into base unit of measure Denominator for the conversion into base unit of measure The weight of the consumer package, including packaging The weight of the consumer package, excluding packaging Weight unit of measure The consumer package volume Volume unit of measure The dimension from front to back of the consumer package The dimension from left to right of the consumer package The dimension from top to bottom of the consumer package The code used to specify the units in which a value is being\
\ expressed, or manner in which a measurement has been taken. Typecode of the outer package of the item, is used for label\
\ printing Typecode of the outer package of the item, is used for label\
\ printing Handling typecode Date when the status becomes effective Maximum stock quantity Minimum stock quantity Date when the listing becomes effective Last date when the item is available for ordering List of all Customer Specific Prices for this item. The Customer Specific Price for given timestamp (if specified,\
\ null otherwise). HSN (Harmonized System of Nomenclature) is an international\
\ classification system of commodities. HSN code ensures that commodities\
\ of similar nature are classified properly. Denotes if RFID method is called and stock is updated. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. This object contains item data for one specific\
\ unit of measure. The object is a projection from the item domain object. A unique retailer assigned identifier for the business unit\
\ group Item number. Alphanumeric key that identifies the item uniquely. Unit of measure code Getter for inner key class. The number of individual member items that are assembled\
\ in this deposit collection. Item deposit collection contains\
\ a reference to the deposit item connected to this item (e.g. reference to\
\ the bottle for a beer). Reference to the member of the deposit collection The unit of measure of the member item Getter for inner key class. Getter for inner key class. Qualifier which is used to differ between MerchandiseHierarchyGroup's\
\ belonging to different functions but having the same id Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Relation of this item to a merchandise hierarchy\
\ group Unique system assigned identifier for a group or class of\
\ merchandise. Getter for inner key class. type code of the POS identity Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. Additional field for custom development. POS identity used for the item registration POS item id is a token identifier to facilitate price lookup\
\ and does not contain any descriptive information. Getter for inner key class. Association to a related item Reference to the related item. Type of the association, e.g. 'VARIANT' for item variant\
\ association. ID of the characteristic to be used for filtering (e.g. 'COLOR').\
\ Wildcards are supported. The search is case insensitive. Value name of the characteristic to be used for filtering\
\ (e.g. 'red'). Wildcards are supported. The search is case insensitive. Filter for Characteristics. Getter for inner key class. Value name of the characteristic. Characteristic view. ID of the characteristic. Value ID of the characteristic. Item number. Alphanumeric key that identifies the item uniquely. Item name which is searched in GK_BUG_ITEM_I8N_ITEM_TEXT.TEXT\
\ if exists, otherwise (if it is allowed by configuration) in AS_BSNGP_ITM.NM_ITM_GK.\
\ Merchandise Hierarchy Group Name which is searched in GK_I18N_TEXT.LOCALIZED_TEXT\
\ if exists, otherwise in CO_MRHRC_GP.NM_MRHRC_GP. Amount of the price. If true only items authorized for sale are searched (RU_ITM_SL.FL_AZN_FR_SLS\
\ is true). For filtering items with Item Collections. If true only items\
\ with Item Collection are searched. For enabling/disabling case sensitivity for search in ItemID
WssbRfcBillDocRead"
operationId: "BillDocWebService.getInvoiceData"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The BillDocRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.billdoc.BillDocRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.billdoc.BillDocResponse"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/createCustomer:
post:
tags:
- "CustomerOperationService"
summary: "Create new customer in given data provider with specified details."
description: "Create new customer in given data provider with specified details."
operationId: "CustomerOperationService.createCustomer"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the UpdateCustomerRequest"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.operation.UpdateCustomerRequest"
responses:
200:
description: "Success"
schema:
type: "string"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findCustomerById:
post:
tags:
- "CustomerOperationService"
summary: "Search customer by given ID."
description: "Search customer by given ID."
operationId: "CustomerOperationService.findCustomerById"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The FindCustomerByIdRequest"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.operation.FindCustomerByIdRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO"
500:
description: "In case an error occurs."
/com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findCustomerContactViewListByFilter:
post:
tags:
- "CustomerOperationService"
summary: "Search customer by filter."
description: "Search customer by filter."
operationId: "CustomerOperationService.findCustomerContactViewListByFilter"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The SearchCustomerRequest including the search criteria"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.customer_search_by_criteria.SearchCustomerRequest"
responses:
200:
description: "Success"
schema:
type: "array"
items:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerContactView"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findCustomerDataById:
post:
tags:
- "CustomerOperationService"
summary: "Search customer by given ID."
description: "Search customer by given ID."
operationId: "CustomerOperationService.findCustomerData"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The FindCustomerDataRequest"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.operation.FindCustomerDataRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.flow.libs.customer.CustomerData"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findCustomerDataByPartyIdentification:
post:
tags:
- "CustomerOperationService"
summary: "Find customer list by given party identification."
description: "Find customer list by given party identification."
operationId: "CustomerOperationService.findCustomerByPartyIdentification"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The FindCustomerByPartyIdentificationRequest"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.operation.FindCustomerByPartyIdentificationRequest"
responses:
200:
description: "Success"
schema:
type: "array"
items:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findLastCustomerId:
post:
tags:
- "CustomerOperationService"
operationId: "findLastCustomerId"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
type: "string"
/com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/mapCustomerDOToCustomerData:
post:
tags:
- "CustomerOperationService"
operationId: "mapCustomerDOToCustomerData"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.flow.libs.customer.CustomerData"
/com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/updateCustomer:
post:
tags:
- "CustomerOperationService"
summary: "Update customer in given data provider with specified details."
description: "Update customer in given data provider with specified details."
operationId: "CustomerOperationService.updateCustomer"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The UpdateCustomerRequest"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.operation.UpdateCustomerRequest"
responses:
200:
description: "Success"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerByIdWebService/searchCustomerById:
post:
tags:
- "CustomerByIdWebService"
summary: "Search customer by customer id"
description: "Search customer by customer id"
operationId: "CustomerByIdWebService.searchCustomerById"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CustomerWebserviceRequest including customer identifier\
\ and web service config"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerWebserviceRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerWebServiceResultSAPERP"
500:
description: "
"
/com.gk_software.pos.api.service.communication.ws.payables_account.PayablesAccountWebService/getAccountBalance:
post:
tags:
- "PayablesAccountWebService"
summary: "Queries the customer account balancing in the ERP service. "
description: "Queries the customer account balancing in the ERP service.
It\
\ gives the current status of a customer account, i.e. the (positive or negative)\
\ open amount."
operationId: "PayablesAccountWebService.getAccountBalance"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The account balance request containing the necessary information\
\ for the balance request, as web service configuration, customer id and\
\ accounting area."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.payables_account.AccountBalanceRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.payables_account.AccountBalanceResult"
500:
description: "The exception is thrown if an unexpected error occurs, i.e.:\
\
The\
\ search is able to retrieve sales orders for multiple customers,
and\
\ also to filter it by state (only open or all of them).
In addition,\
\ it is also possible to limit the number of results."
operationId: "SalesOrderBasicWebService.getSalesOrders"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Sales order search request."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_basic.SalesOrdersRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_basic.SalesOrdersResult"
/com.gk_software.pos.api.service.communication.ws.sales_order_by_id.SalesOrderByIdV3WebService/getOrderById:
post:
tags:
- "SalesOrderByIdV3WebService"
summary: "Returns details of a customer sales order in SAP ERP (a so-called\
\ \"SD sales order\") by sales order number search."
description: "Returns details of a customer sales order in SAP ERP (a so-called\
\ \"SD sales order\") by sales order number search."
operationId: "SalesOrderByIdV3WebService.getOrderById"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The sales order request containing the sales order number and\
\ web service configuration."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_by_id.SalesOrderByIdV3Request"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_by_id.SalesOrderByIdV3Result"
500:
description: "An exception is thrown if a sales order is not found or an\
\ unexpected error occurred (i.e.: web service is not reachable)."
? /com.gk_software.pos.api.service.communication.ws.sales_order_change_request_confirmation.SalesOrderChangeRequestConfirmationWebService/requestChangeSalesOrderConfirmation
: post:
tags:
- "SalesOrderChangeRequestConfirmationWebService"
summary: "Creates a sales order change confirmation."
description: "Creates a sales order change confirmation."
operationId: "SalesOrderChangeRequestConfirmationWebService.requestChangeSalesOrderConfirmation"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The request for sales order change confirmation."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_change_request_confirmation.entities.SalesOrderChangeConfirmationRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_change_request_confirmation.entities.SalesOrderChangeConfirmationResult"
500:
description: "An exception is thrown if an unexpected error occurs (i.e.:\
\ web service connection fails or sales order is not found)."
? /com.gk_software.pos.api.service.communication.ws.sales_order_change_request_confirmation.SalesOrderChangeRequestConfirmationWebService/requestVoidItemsSalesOrderConfirmation
: post:
tags:
- "SalesOrderChangeRequestConfirmationWebService"
summary: "Requests a sales order change confirmation for voiding line items\
\ from existing sales order change request."
description: "Requests a sales order change confirmation for voiding line items\
\ from existing sales order change request."
operationId: "SalesOrderChangeRequestConfirmationWebService.requestVoidItemsSalesOrderConfirmation"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The sales order change request."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_change_request_confirmation.entities.SalesOrderChangeConfirmationRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_change_request_confirmation.entities.SalesOrderChangeConfirmationResult"
500:
description: "An exception is thrown if an unexpected error occurs (i.e.:\
\ web service connection fails or sales order is not found)."
? /com.gk_software.pos.api.service.communication.ws.sales_order_create_check.SalesOrderCreateCheckWebService/createScopedTxForDeliveryOptionSelection
: post:
tags:
- "SalesOrderCreateCheckWebService"
summary: "Creates or updates a scoped transaction with given scope id by copying\
\ the customer list and "
description: "Creates or updates a scoped transaction with given scope id by\
\ copying the customer list and
line items eligible for sales order delivery\
\ from current session transaction.
The scoped transaction is identified\
\ by provided scope id. A scope id is used for identifying
a specific\
\ scoped transaction as multiple scoped transactions may coexist in the same\
\ session
for different purposes."
operationId: "SalesOrderCreateCheckWebService.createScopedTxForDeliveryOptionSelection"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The scope id used for transaction when an order delivery is\
\ selected."
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/PosTransaction"
500:
description: "The exception is thrown if an unexpected error occurs."
? /com.gk_software.pos.api.service.communication.ws.sales_order_create_check.SalesOrderCreateCheckWebService/launchValidationWsCall
: post:
tags:
- "SalesOrderCreateCheckWebService"
summary: "This service performs a sales order validation in the ERP system."
description: "This service performs a sales order validation in the ERP system.
The\
\ enterprise service allows to simulate a customer sales order in SAP ERP\
\ (a so-called \"SD sales order\").
The service gives information\
\ about the availability of items for the entered delivery date
(\"ATP\
\ check\" / ATP = availability to promise) and returns customer specific\
\ prices.
The returned prices can then be compared with the results\
\ of the POS price calculation,
and (depending on settings) a best price\
\ approach can be used.
Similarly, any warning on the availability of\
\ items can be taken into account, before in the end a sales order is created."
operationId: "SalesOrderCreateCheckWebService.launchValidationWsCall"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The sales order data to be validated."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_create_check.SalesOrderCreateCheckRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SalesOrderCommonData"
500:
description: "The exception is thrown if an unexpected error occurs (e.g.:\
\ web service is unavailable)."
? /com.gk_software.pos.api.service.communication.ws.sales_order_create_request_confirmation.SalesOrderCreateRequestConfirmationWebService/requestCreateSalesOrderConfirmation
: post:
tags:
- "SalesOrderCreateRequestConfirmationWebService"
summary: "Creates a sales order on the ERP system."
description: "Creates a sales order on the ERP system."
operationId: "SalesOrderCreateRequestConfirmationWebService.requestCreateSalesOrderConfirmation"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The sales order data."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_create_request_confirmation.entities.SalesOrderCreateConfirmationRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_create_request_confirmation.entities.SalesOrderCreateConfirmationResult"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.communication.ws.sales_order_sales_doc_read.SalesOrderSalesDocReadWebService/readOrderData:
post:
tags:
- "SalesOrderSalesDocReadWebService"
summary: "Request to read data of a given sales order."
description: "Request to read data of a given sales order."
operationId: "SalesOrderSalesDocReadWebService.readOrderData"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the sales order data read request."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_sales_doc_read.SalesOrderSalesDocReadRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_sales_doc_read.SalesOrderSalesDocReadResult"
500:
description: "if an unexpected error occured during a sales order read process\
\ (eg.: connection failure with ERP service)."
/com.gk_software.pos.api.service.coupon.CouponingService/checkCoupons:
post:
tags:
- "CouponingService"
summary: "Executes a verification of the given coupons."
description: "Executes a verification of the given coupons."
operationId: "CouponService.checkCoupons"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The checkCoupons request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.coupon.CheckCouponsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.coupon.CheckCouponsResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.coupon.CouponingService/returnCoupons:
post:
tags:
- "CouponingService"
summary: "Executes a return/redeem of coupons."
description: "This method executes a return/redeem operation of the coupons\
\ in the current transaction"
operationId: "CouponService.returnCoupons"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The returnCoupons request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.coupon.ReturnCouponsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.coupon.ReturnCouponsResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.customer.CustomerCardCodeConverterService/convertCodeToCustomerCardCode:
post:
summary: "Obtains CustomerCardCode from given strings."
description: "Obtains CustomerCardCode from given strings."
operationId: "CustomerCardCodeConverterService.convertCodeToCustomerCardCode"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "List of strings with aztec codes"
required: true
schema:
type: "array"
items:
type: "string"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.flow.libs.customer.CustomerCardCode"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.customer.CustomerCardCodeConverterService/convertCustomerCardCodeToCode:
post:
summary: "Obtains list of aztec codes parsed from given CustomerCardCode."
description: "Obtains list of aztec codes parsed from given CustomerCardCode."
operationId: "CustomerCardCodeConverterService.convertCustomerCardCodeToCode"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CustomerCardCode containing the information about customer\
\ card"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.flow.libs.customer.CustomerCardCode"
responses:
200:
description: "Success"
schema:
type: "array"
items:
type: "string"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.data_privacy_log.DataPrivacyLogService/storeCustomerDataChangedDataEvent:
post:
tags:
- "DataPrivacyLogService"
summary: "Stores a data privacy event log by the given StoreCustomerDataChangedDataEventRequest\
\ when customer data is changed."
description: "Stores a data privacy event log by the given StoreCustomerDataChangedDataEventRequest\
\ when customer data is changed."
operationId: "DataPrivacyLogService.storeCustomerDataChangedDataEvent"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The StoreCustomerDataChangedDataEventRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.data_privacy_log.StoreCustomerDataChangedDataEventRequest"
responses:
default:
description: "successful operation"
/com.gk_software.pos.api.service.data_privacy_log.DataPrivacyLogService/storeCustomerDataCreatedDataEvent:
post:
tags:
- "DataPrivacyLogService"
summary: "Stores a data privacy event log by the given StoreCustomerDataCreatedDataEventRequest\
\ when customer data is created."
description: "Stores a data privacy event log by the given StoreCustomerDataCreatedDataEventRequest\
\ when customer data is created."
operationId: "DataPrivacyLogService.storeCustomerDataCreatedDataEvent"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The StoreCustomerDataCreatedDataEventRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.data_privacy_log.StoreCustomerDataCreatedDataEventRequest"
responses:
default:
description: "successful operation"
/com.gk_software.pos.api.service.data_privacy_log.DataPrivacyLogService/storeCustomerDataReadDataEvent:
post:
tags:
- "DataPrivacyLogService"
summary: "Stores a data privacy event log by the given StoreCustomerDataReadDataEventRequest\
\ when customer data is read."
description: "Stores a data privacy event log by the given StoreCustomerDataReadDataEventRequest\
\ when customer data is read."
operationId: "DataPrivacyLogService.storeCustomerDataReadDataEvent"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The StoreCustomerDataReadDataEventRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.data_privacy_log.StoreCustomerDataReadDataEventRequest"
responses:
default:
description: "successful operation"
/com.gk_software.pos.api.service.data_privacy_log.DataPrivacyLogService/storeCustomerSearchCriteriaEvent:
post:
tags:
- "DataPrivacyLogService"
summary: "Stores a data privacy event log by the given StoreCustomerSearchCriteriaEventRequest\
\ when customer data is se..."
description: "Stores a data privacy event log by the given StoreCustomerSearchCriteriaEventRequest\
\ when customer data is searched
by criteria."
operationId: "DataPrivacyLogService.storeCustomerSearchCriteriaEvent"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The StoreCustomerSearchCriteriaEventRequest"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.data_privacy_log.StoreCustomerSearchCriteriaEventRequest"
responses:
default:
description: "successful operation"
/com.gk_software.pos.api.service.digital_receipt.DigitalReceiptService/processDigitalReceipt:
post:
tags:
- "DigitalReceiptService"
summary: "This method sends, uploads or stores the digital combined PDF receipts."
description: "This method sends, uploads or stores the digital combined PDF\
\ receipts."
operationId: "DigitalReceiptService.processDigitalReceipt"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The processDigitalReceipt request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.digital_receipt.ProcessDigitalReceiptRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.digital_receipt.ProcessDigitalReceiptResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.event_log.EventLogService/searchEventLog:
post:
tags:
- "EventLogService"
summary: "Searches for event log messages meeting the given search criteria."
description: "Searches for event log messages meeting the given search criteria."
operationId: "EventLogService.searchEventLog"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The EventLogSearchParameters."
required: true
schema:
$ref: "#/definitions/EventLogSearchParameters"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/EventLogSearchResult"
/com.gk_software.pos.api.service.event_log.EventLogService/storeEventLog:
post:
tags:
- "EventLogService"
summary: "Stores the given event log messages."
description: "Stores the given event log messages."
operationId: "EventLogService.storeEventLog"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The EventLogStoreRequest containing the event log messages to\
\ be stored."
required: true
schema:
$ref: "#/definitions/EventLogStoreRequest"
responses:
default:
description: "successful operation"
/com.gk_software.pos.api.service.ewic.EwicItemCategoryService/findWicCategoryByKey:
post:
tags:
- "EwicItemCategoryService"
summary: "Find eWIC item category"
description: "Find eWIC item category"
operationId: "EwicItemCategoryService.findWicCategoryByKey"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the benefits request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.ewic.EwicItemSubcategoryBenefitsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.item_wic.dto.dom.WicCategoryDO"
500:
description: "if an error occurs while attempting to read master data"
/com.gk_software.pos.api.service.ewic.EwicItemCategoryService/getBasketMatchingPrescription:
post:
tags:
- "EwicItemCategoryService"
summary: "Gets the items which match the prescription"
description: "Gets the items which match the prescription"
operationId: "EwicItemCategoryService.getBasketMatchingPrescription"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the basket request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.ewic.EwicBasketRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.ewic.EwicMatchingPrescriptionResult"
500:
description: "if an error occurs while attempting to get the basket"
/com.gk_software.pos.api.service.ewic.EwicItemCategoryService/resetNTEItemPrice:
post:
tags:
- "EwicItemCategoryService"
summary: "Reset the Item Price with NTE Price"
description: "Reset the Item Price with NTE Price"
operationId: "EwicItemCategoryService.resetNTEItemPrice"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.external.cart.ExternalCartService/addItemToExternalCartForCustomer:
post:
tags:
- "ExternalCartService"
summary: "Adds an item to a customer cart"
description: "Adds an item to a customer cart"
operationId: "ExternalCartService.addItemToExternalCartForCustomer"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ExternalCartLineItemRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartLineItemRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.ExternalLineItemData"
/com.gk_software.pos.api.service.external.cart.ExternalCartService/createExternalCartForAnonymous:
post:
tags:
- "ExternalCartService"
summary: "Creates a session cart for anonymous"
description: "Creates a session cart for anonymous"
operationId: "ExternalCartService.createExternalCartForAnonymous"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartData"
/com.gk_software.pos.api.service.external.cart.ExternalCartService/createExternalCartForCustomer:
post:
tags:
- "ExternalCartService"
summary: "Creates a new cart for a customer"
description: "Creates a new cart for a customer"
operationId: "ExternalCartService.createExternalCartForCustomer"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ExternalCartRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartData"
/com.gk_software.pos.api.service.external.cart.ExternalCartService/getExternalCart:
post:
tags:
- "ExternalCartService"
summary: "Get cart by customerID and cartID"
description: "Get cart by customerID and cartID"
operationId: "ExternalCartService.getExternalCart"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ExternalCartRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartData"
/com.gk_software.pos.api.service.external.cart.ExternalCartService/getExternalCartsForCustomer:
post:
tags:
- "ExternalCartService"
summary: "Get Cart list by customerID"
description: "Get Cart list by customerID"
operationId: "ExternalCartService.getExternalCartsForCustomer"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ExternalCartRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartRequest"
responses:
200:
description: "successful operation"
schema:
type: "array"
items:
$ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartData"
/com.gk_software.pos.api.service.external.cart.ExternalCartService/mergeAnonymousCart:
post:
tags:
- "ExternalCartService"
summary: "Merges an anonymous cart to a customer cart"
description: "Merges an anonymous cart to a customer cart"
operationId: "ExternalCartService.mergeAnonymousCart"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ExternalCartRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartData"
/com.gk_software.pos.api.service.external.customer.ExternalCustomerService/addAddress:
post:
tags:
- "ExternalCustomerService"
summary: "Adds new address to existing external customer."
description: "Adds new address to existing external customer."
operationId: "ExternalCustomerService.addAddress"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ExternalCustomerAddressRequest containing the new address"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.customer.ExternalCustomerAddressRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.contact.dto.dom.ContactAddress"
/com.gk_software.pos.api.service.external.customer.ExternalCustomerService/findCustomer:
post:
tags:
- "ExternalCustomerService"
summary: "Search for external customer for given criteria."
description: "Search for external customer for given criteria."
operationId: "ExternalCustomerService.findCustomer"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ExternalCustomerDetailsRequest containing lookup information"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.customer.ExternalCustomerDetailsRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO"
/com.gk_software.pos.api.service.external.item.ExternalItemQueryService/getItemImageUrl:
post:
tags:
- "ExternalItemQueryService"
summary: "Gets the external item image url."
description: "Gets the external item image url."
operationId: "ExternalItemQueryService.getItemImageUrl"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the ExternalItemInformationRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.item.ExternalItemInformationRequest"
responses:
200:
description: "successful operation"
schema:
type: "string"
/com.gk_software.pos.api.service.external.item.ExternalItemQueryService/getItemInformation:
post:
tags:
- "ExternalItemQueryService"
summary: "Gets the external item information pos item id."
description: "Gets the external item information pos item id."
operationId: "ExternalItemQueryService.getItemInformation"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ExternalItemInformationRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.item.ExternalItemInformationRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.model.dom.app.ItemInformation.ItemInformation"
/com.gk_software.pos.api.service.external.item.ExternalItemQueryService/getPosUOMItemDO:
post:
tags:
- "ExternalItemQueryService"
summary: "Get PosUOMItemDO from external item service by ExternalItemInformationRequest"
description: "Get PosUOMItemDO from external item service by ExternalItemInformationRequest"
operationId: "ExternalItemQueryService.getPosUOMItemDO"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ExternalItemInformationRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.item.ExternalItemInformationRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemDO"
/com.gk_software.pos.api.service.external.item.ExternalItemQueryService/searchItemInformationList:
post:
tags:
- "ExternalItemQueryService"
summary: "Find external item list by filter."
description: "Find external item list by filter."
operationId: "ExternalItemQueryService.searchItemInformationList"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ExternalItemSearchRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.item.ExternalItemSearchRequest"
responses:
200:
description: "successful operation"
schema:
type: "array"
items:
$ref: "#/definitions/com.gk_software.pos.api.model.dom.app.ItemInformation.ItemInformation"
/com.gk_software.pos.api.service.external_order.ExternalOrderService/addDeliveryCostsToTransaction:
post:
tags:
- "ExternalOrderService"
summary: "Adds delivery costs line item to the POS Transaction"
description: "Adds delivery costs line item to the POS Transaction"
operationId: "ExternalOrderService.addDeliveryCostsToTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ExternalCartRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
/com.gk_software.pos.api.service.external_order.ExternalOrderService/preCalculateOrderWithDeliveryCosts:
post:
tags:
- "ExternalOrderService"
summary: "Calculates the delivery costs for the current order in preparation"
description: "Calculates the delivery costs for the current order in preparation"
operationId: "ExternalOrderService.preCalculateOrderWithDeliveryCosts"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ExternalCartRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartData"
/com.gk_software.pos.api.service.external_order.ExternalOrderService/setDeliveryAddress:
post:
tags:
- "ExternalOrderService"
summary: "Sets a delivery address to an order in preparation"
description: "Sets a delivery address to an order in preparation"
operationId: "ExternalOrderService.setDeliveryAddress"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The DeliveryAddressRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external_order.DeliveryAddressRequest"
responses:
default:
description: "successful operation"
/com.gk_software.pos.api.service.external_order.ExternalOrderService/setDeliveryMode:
post:
tags:
- "ExternalOrderService"
summary: "Sets a delivery model to an order in preparation"
description: "Sets a delivery model to an order in preparation"
operationId: "ExternalOrderService.setDeliveryMode"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The DeliveryModeRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external_order.DeliveryModeRequest"
responses:
default:
description: "successful operation"
/com.gk_software.pos.api.service.external_order.ExternalOrderService/setPaymentDetails:
post:
tags:
- "ExternalOrderService"
summary: "Sets payment details (like billing address)"
description: "Sets payment details (like billing address)"
operationId: "ExternalOrderService.setPaymentDetails"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PaymentDetailsRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external_order.PaymentDetailsRequest"
responses:
default:
description: "successful operation"
/com.gk_software.pos.api.service.external_order.ExternalOrderService/simulateOrder:
post:
tags:
- "ExternalOrderService"
summary: "Checks if the prepared order is valid for invocation"
description: "Checks if the prepared order is valid for invocation"
operationId: "ExternalOrderService.simulateOrder"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ExternalCartRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartRequest"
responses:
200:
description: "successful operation"
schema:
type: "boolean"
/com.gk_software.pos.api.service.hospitality.HospitalityService/activateHospitalityReceipt:
post:
tags:
- "HospitalityService"
summary: "This method will activate or deactivate hospitality receipt."
description: "This method will activate or deactivate hospitality receipt"
operationId: "HospitalityService.activateHospitalityReceipt"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The activateHospitalityReceipt request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.ActivateHospitalityReceiptRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.hospitality.HospitalityService/addLineItemCourseNumber:
post:
tags:
- "HospitalityService"
summary: "Adds course number to line item."
description: "Adds course number to line item."
operationId: "HospitalityService.addLineItemCourseNumber"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The 'add line item course number' request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.AddLineItemCourseNumberRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.hospitality.HospitalityService/changeTableOwner:
post:
tags:
- "HospitalityService"
summary: "This method will change the table owner of the given tables."
description: "This method will change the table owner of the given tables."
operationId: "HospitalityService.changeTableOwner"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The 'change table owner' request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.ChangeTableOwnerRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.ChangeTableOwnerResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.hospitality.HospitalityService/createBelatedTipTransaction:
post:
tags:
- "HospitalityService"
summary: "This method will create a transaction for 'belated tip' purpose."
description: "This method will create a transaction for 'belated tip' purpose."
operationId: "HospitalityService.createBelatedTipTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The createBelatedTipTransaction request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.CreateBelatedTipTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.CreateBelatedTipTransactionResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.hospitality.HospitalityService/createOrRetrieveTransaction:
post:
tags:
- "HospitalityService"
summary: "Create or retrieve a transaction."
description: "Create or retrieve a transaction."
operationId: "HospitalityService.createOrRetrieveTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The createOrRetrieveTransaction request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.CreateOrRetrieveTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.CreateOrRetrieveTransactionRequest"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.hospitality.HospitalityService/deleteLineItemCourseNumber:
post:
tags:
- "HospitalityService"
summary: "Deletes course number from line item."
description: "Deletes course number from line item."
operationId: "HospitalityService.deleteLineItemCourseNumber"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The 'delete line item course number' request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.DeleteLineItemCourseNumberRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.hospitality.HospitalityService/executeBelatedVoidLineItem:
post:
tags:
- "HospitalityService"
summary: "This method executed the belated voiding of a line item."
description: "This method executed the belated voiding of a line item."
operationId: "HospitalityService.executeBelatedVoidLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The executeBelatedVoidLineItem request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.BelatedVoidLineItemRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.BelatedVoidLineItemResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.hospitality.HospitalityService/finalizeMovementTransactions:
post:
tags:
- "HospitalityService"
summary: "This method will finalize all transactions (of type movement)."
description: "This method will finalize all transactions (of type movement)"
operationId: "HospitalityService.finalizeMovementTransactions"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The finalizeMovementTransactions request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.FinalizeMovementTransactionsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.MoveLineItemsResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.hospitality.HospitalityService/isLineItemAddedOrVoided:
post:
tags:
- "HospitalityService"
summary: "It is checked, if line items were added or if already ordered line\
\ items were voided belated."
description: "It is checked, if line items were added or if already ordered\
\ line items were voided belated."
operationId: "HospitalityService.isLineItemAddedOrVoided"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The isLineItemAddedOrVoided request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.IsLineItemAddedOrVoidedRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.PreparePrintOrderDataResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.hospitality.HospitalityService/loadComboMealItems:
post:
tags:
- "HospitalityService"
summary: "This method will load combo meal items."
description: "load combo meal items."
operationId: "HospitalityService.loadComboMealItems"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The 'load combo leam items' request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.LoadComboMealItemsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.LoadComboMealItemsResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.hospitality.HospitalityService/loadCondiments:
post:
tags:
- "HospitalityService"
summary: "This method will load condiments."
description: "This method will load condiments."
operationId: "HospitalityService.loadCondiments"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The 'load conditments' request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.LoadCondimentsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.LoadCondimentsResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.hospitality.HospitalityService/loadTableStatus:
post:
tags:
- "HospitalityService"
summary: "Load the table status."
description: "Load the table status."
operationId: "HospitalityService.loadTableStatus"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The loadTableStatus request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.LoadTableStatusRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.LoadTableStatusResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.hospitality.HospitalityService/moveLineItems:
post:
tags:
- "HospitalityService"
summary: "This method will move line item(s) from one transaction to another."
description: "This method will move line item(s) from one transaction to another."
operationId: "HospitalityService.moveLineItems"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The moveLineItems request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.MoveLineItemsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.MoveLineItemsResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.hospitality.HospitalityService/preparePrintOrderData:
post:
tags:
- "HospitalityService"
summary: "Prepares print order related data."
description: "Prepares print order related data."
operationId: "HospitalityService.preparePrintOrderData"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The preparePrintOrderData request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.PreparePrintOrderDataRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.PreparePrintOrderDataResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.hospitality.HospitalityService/recoverTransaction:
post:
tags:
- "HospitalityService"
summary: "This method will recover a hospitality related transaction"
description: "This method will recover a hospitality related transaction"
operationId: "HospitalityService.recoverTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The recoverTransaction request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.RecoverTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.RecoverTransactionResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.hospitality.HospitalityService/registerCondiments:
post:
tags:
- "HospitalityService"
summary: "Register condiments."
description: "Register condiments."
operationId: "HospitalityService.registerCondiments"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The 'register condiment' request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.RegisterCondimentsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.hospitality.HospitalityService/resetToFoodOrderTransaction:
post:
tags:
- "HospitalityService"
summary: "Resets the current transaction to a food order transaction."
description: "Resets the current transaction to a food order transaction."
operationId: "HospitalityService.resetToFoodOrderTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The resetToFoodOrderTransaction request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.ResetToFoodOrderTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.hospitality.CreateOrRetrieveTransactionRequest"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.layaway.LayawayService/calculatePaymentPlan:
post:
tags:
- "LayawayService"
summary: "Adds a payment plan to transaction."
description: "Adds a payment plan to transaction."
operationId: "LayawayService.calculatePaymentPlan"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PaymentPlanRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.layaway.PaymentPlanRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.layaway.PaymentPlanResult"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.layaway.LayawayService/createCompleteVoidTransaction:
post:
tags:
- "LayawayService"
summary: "Creates a new void transaction (complete layaway void) for the given\
\ request."
description: "Creates a new void transaction (complete layaway void) for the\
\ given request."
operationId: "LayawayService.createCompleteVoidTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CreateCompleteVoidTransactionRequest request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.layaway.CreateCompleteVoidTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "The exception is thrown if an unexpected error occurs."
/com.gk_software.pos.api.service.layaway.LayawayService/createCustomerTransaction:
post:
tags:
- "LayawayService"
summary: "Creates a new transaction with customer for the given request."
description: "Creates a new transaction with customer for the given request."
operationId: "LayawayService.createCustomerTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CreateCustomerTransactionRequest request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.layaway.CreateCustomerTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "The exception is thrown if an unexpected error occurs."
/com.gk_software.pos.api.service.layaway.LayawayService/createDownPaymentAndFeeLineItem:
post:
tags:
- "LayawayService"
summary: "Creates a new layaway down payment and fee line item for the given\
\ request."
description: "Creates a new layaway down payment and fee line item for the given\
\ request."
operationId: "LayawayService.createDownPaymentAndFeeLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The DownPaymentAndFeeLineItemRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.layaway.DownPaymentAndFeeLineItemRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "The exception is thrown if an unexpected error occurs."
/com.gk_software.pos.api.service.layaway.LayawayService/createDownPaymentTransaction:
post:
tags:
- "LayawayService"
summary: "Creates a new layaway down payment transaction for the given request."
description: "Creates a new layaway down payment transaction for the given request."
operationId: "LayawayService.createDownPaymentTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The DownPaymentTransactionRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.layaway.DownPaymentTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "The exception is thrown if an unexpected error occurs."
/com.gk_software.pos.api.service.layaway.LayawayService/createFinalPaymentTransaction:
post:
tags:
- "LayawayService"
summary: "Creates a final payment transaction for the given request."
description: "Creates a create final payment transaction for the given request."
operationId: "LayawayService.createFinalPaymentTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The FinalPaymentTransactionRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.layaway.FinalPaymentTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "The exception is thrown if an unexpected error occurs."
/com.gk_software.pos.api.service.layaway.LayawayService/createLayawayExtendTransaction:
post:
tags:
- "LayawayService"
summary: "Creates a new layaway extend transaction for the given request."
description: "Creates a new layaway extend transaction for the given request."
operationId: "LayawayService.createLayawayExtendTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The createLayawayExtendTransaction request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.layaway.CreateLayawayExtendTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "The exception is thrown if an unexpected error occurs."
/com.gk_software.pos.api.service.layaway.LayawayService/createPartialVoidTransaction:
post:
tags:
- "LayawayService"
summary: "Creates a new void transaction (partial layaway void) for the given\
\ request."
description: "Creates a new void transaction (partial layaway void) for the\
\ given request."
operationId: "LayawayService.createPartialVoidTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CreatePartialVoidTransactionRequest request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.layaway.CreatePartialVoidTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "The exception is thrown if an unexpected error occurs."
/com.gk_software.pos.api.service.layaway.LayawayService/createRetrieveMoneyTransaction:
post:
tags:
- "LayawayService"
summary: "Creates a new retrieve money transaction for the given request."
description: "Creates a new retrieve money transaction for the given request."
operationId: "LayawayService.createRetrieveMoneyTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CreateRetrieveMoneyTransactionRequest request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.layaway.CreateRetrieveMoneyTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "The exception is thrown if an unexpected error occurs."
/com.gk_software.pos.api.service.layaway.LayawayService/findLayawayByCriteria:
post:
tags:
- "LayawayService"
summary: "Find a Layaway by criteria."
description: "Find a Layaway by criteria."
operationId: "LayawayService.findLayawayByCriteria"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The FindLayawayByCriteriaRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.layaway.FindLayawayByCriteriaRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.layaway.FindLayawayByCriteriaResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.layaway.LayawayService/findLayawayListByCriteria:
post:
tags:
- "LayawayService"
summary: "Find layaway list by criteria."
description: "Find layaway list by criteria."
operationId: "LayawayService.findLayawayListByCriteria"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The FindLayawayListByCriteriaRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.layaway.FindLayawayListByCriteriaRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.layaway.FindLayawayListByCriteriaResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.layaway.LayawayService/openScopedTxForLayaway:
post:
tags:
- "LayawayService"
summary: "Creates a scoped transaction with given information in the request\
\ object (e.g. the layaway)"
description: "Creates a scoped transaction with given information in the request\
\ object (e.g. the layaway). SaleReturnLineItems of the layaway and other\
\ needed information will be copied to the transaction"
operationId: "LayawayService.openScopedTxForLayaway"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The open transaction request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.layaway.OpenScopedTxForLayawayRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/PosTransaction"
500:
description: "The exception is thrown if an unexpected error occurs."
/com.gk_software.pos.api.service.layaway.LayawayService/validateLayaway:
post:
tags:
- "LayawayService"
summary: "Validate Layaway."
description: "Validate Layaway."
operationId: "LayawayService.validateLayaway"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ValidateLayawayRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.layaway.ValidateLayawayRequest"
responses:
200:
description: "Success"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.loyalty.LoyaltySystemService/redeemPoints:
post:
tags:
- "LoyaltySystemService"
summary: "This method redeems points."
description: "This method redeems points."
operationId: "LoyaltySystemService.redeemPoints"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Request with customer cardNumber and customerId"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.loyalty.types.PointsRequest"
responses:
200:
description: "Success"
schema:
type: "string"
500:
description: "with ErrorCodes WS_INTERNAL_ERROR, WS_CONNECTION_ERROR"
/com.gk_software.pos.api.service.loyalty.LoyaltySystemService/refundPoints:
post:
tags:
- "LoyaltySystemService"
summary: "This method returns points."
description: "This method returns points."
operationId: "LoyaltySystemService.refundPoints"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PointsRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.loyalty.types.PointsRequest"
responses:
200:
description: "Success"
schema:
type: "string"
500:
description: "with ErrorCodes WS_CONNECTION_ERROR, WS_INTERNAL_ERROR"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findAllScaleDomains:
post:
tags:
- "MasterDataService"
summary: "Finds all scale domains available for given business unit group id."
description: "Finds all scale domains available for given business unit group\
\ id."
operationId: "MasterDataService.findAllScaleDomains"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The business unit group ID"
required: true
schema:
type: "integer"
format: "int64"
responses:
200:
description: "successful operation"
schema:
type: "array"
items:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.scale_domain.dto.dom.ScaleDomainDO"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findBusinessUnitDOListByFilter:
post:
tags:
- "MasterDataService"
summary: "Gets a list of BusinessUnitDO object for the given filter."
description: "Gets a list of BusinessUnitDO object for the given filter."
operationId: "MasterDataService.findBusinessUnitDOListByFilter"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The BusinessUnitByFilterRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.model.dom.md.business_unit.BusinessUnitListByFilterRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.model.dom.md.business_unit.BusinessUnitDOListByFilterResult"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findBusinessUnitTextListByReceiptTextId:
post:
tags:
- "MasterDataService"
summary: "Method find BusinessUnitText by businessUnitID and receiptTextID."
description: "Method find BusinessUnitText by businessUnitID and receiptTextID."
operationId: "MasterDataService.findBusinessUnitTextListByReceiptTextId"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The BusinessUnitTextRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.BusinessUnitTextRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.BusinessUnitTextResponse"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findBusinessUnitViewListByFilter:
post:
tags:
- "MasterDataService"
summary: "Gets a list of BusinessUnitView object for the given filter."
description: "Gets a list of BusinessUnitView object for the given filter."
operationId: "MasterDataService.findBusinessUnitViewListByFilter"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The BusinessUnitByFilterRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.model.dom.md.business_unit.BusinessUnitListByFilterRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.model.dom.md.business_unit.BusinessUnitViewListByFilterResult"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findCurrencyRoundingRule:
post:
tags:
- "MasterDataService"
summary: "Finds currency rounding rule"
description: "Finds currency rounding rule"
operationId: "MasterDataService.findCurrencyRoundingRule"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CurrencyRoundingRuleRequest request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.CurrencyRoundingRuleRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.currency_rounding_rule.dto.dom.CurrencyRoundingRuleDO"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findCustomer:
post:
tags:
- "MasterDataService"
summary: "Finds customer according to customer identifier"
description: "Finds customer according to customer identifier"
operationId: "MasterDataService.findCustomer"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The customer ID"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findCustomerContactViewListByFilter:
post:
tags:
- "MasterDataService"
summary: "Finds customers overview according to criteria in filter object"
description: "Finds customers overview according to criteria in filter object"
operationId: "MasterDataService.findCustomerContactViewListByFilter"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CustomerContactViewRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.CustomerContactViewRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.CustomerContactViewResult"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findCustomerListByPartyIdentification:
post:
tags:
- "MasterDataService"
summary: "Finds customers according to party identifier"
description: "Finds customers according to party identifier"
operationId: "MasterDataService.findCustomerListByPartyIdentification"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The party identification"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.CustomerResult"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findCustomerTenderGroups:
post:
tags:
- "MasterDataService"
summary: "Returns a list of customer tender groups matching the given customer\
\ group code."
description: "Returns a list of customer tender groups matching the given customer\
\ group code."
operationId: "MasterDataService.findCustomerTenderGroups"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The customer tender group code"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
type: "array"
items:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.customer_tender_rule.dto.dom.CustomerTenderGroupDO"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findMHGroup:
post:
tags:
- "MasterDataService"
summary: "Gets a merchandise hierarchy group by ID"
description: "Gets a merchandise hierarchy group by ID"
operationId: "MasterDataService.findMHGroup"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The merchandise hierarchy group ID"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.swee.ses.api.server.md.mhg.dto.so.MhgSO"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findMHGroupSubGroups:
post:
tags:
- "MasterDataService"
summary: "Gets a merchandise hierarchy group by filter"
description: "Gets a merchandise hierarchy group by filter"
operationId: "MasterDataService.findMHGChildren"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The MHGroupRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.MHGroupRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.MHGroupResult"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findOperator:
post:
tags:
- "MasterDataService"
summary: "Finds the operator object for the given id"
description: "Finds the operator object for the given id"
operationId: "MasterDataService.findOperator"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The operator id"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.swee.ses.api.server.um.operator.dto.so.AbstractOperatorSO"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findSalesRestriction:
post:
tags:
- "MasterDataService"
summary: " Gets SalesRestrictionSO by ID."
description: "Gets SalesRestrictionSO by ID."
operationId: "MasterDataService.findSalesRestriction"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.swee.ses.api.server.md.mhg.dto.so.MhgSO"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findScaleDomain:
post:
tags:
- "MasterDataService"
summary: "Finds ScaleDomain by scaleDomainRequest"
description: "Finds ScaleDomain by scaleDomainRequest"
operationId: "MasterDataService.findScaleDomain"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The scale domain request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.ScaleDomainRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.ScaleDomainResult"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findTenderAdjustmentRules:
post:
tags:
- "MasterDataService"
summary: "Gets a list of TenderAdjustmentRuleDO objects for the given tender\
\ type codes."
description: "Gets a list of TenderAdjustmentRuleDO objects for the given tender\
\ type codes."
operationId: "MasterDataService.findTenderAdjustmentRules"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The TenderAdjustmentRuleRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.TenderAdjustmentRuleRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.TenderAdjustmentRuleResult"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findTenderByCurrencyAndClassCode:
post:
tags:
- "MasterDataService"
summary: "Searches for a tender by currency ID and tender class code"
description: "Searches for a tender by currency ID and tender class code"
operationId: "MasterDataService.findTenderByCurrencyAndClassCode"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The TenderRequest} object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.TenderRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findTenderByCurrencyAndGroupCode:
post:
tags:
- "MasterDataService"
summary: "Searches for a tender by currency ID and tender group code"
description: "Searches for a tender by currency ID and tender group code"
operationId: "MasterDataService.findTenderByCurrencyAndGroupCode"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The TenderRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.TenderRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findTenderByTypeCode:
post:
tags:
- "MasterDataService"
summary: "Searches for a tender by tender type code"
description: "Searches for a tender by tender type code"
operationId: "MasterDataService.findTenderByTypeCode"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The tender type code"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findUnitOfMeasure:
post:
tags:
- "MasterDataService"
summary: "Finds unit of measure for given code"
description: "Finds unit of measure for given code"
operationId: "MasterDataService.findUnitOfMeasure"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The unit of measure code"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.swee.ses.api.server.md.uom.dto.so.UomSO"
/com.gk_software.pos.api.service.masterdata.MasterDataService/findWorkerDO:
post:
tags:
- "MasterDataService"
summary: "Gets the WorkerDO for the given criteria"
description: "Gets the WorkerDO for the given criteria"
operationId: "MasterDataService.findWorker"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The WorkerRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.WorkerRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.worker.dto.dom.WorkerDO"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getBaseClientMasterData:
post:
tags:
- "MasterDataService"
summary: "Returns base client master data."
description: "Returns base client master data."
operationId: "MasterDataService.getBaseClientMasterData"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The BaseClientMasterDataRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.BaseClientMasterDataRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.BaseClientMasterDataResult"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getBusinessUnit:
post:
tags:
- "MasterDataService"
summary: "Get business unit for given ID."
description: "Get business unit for given ID."
operationId: "MasterDataService.getBusinessUnit"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The business unit ID"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.business_unit.dto.dom.BusinessUnitDO"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getCalculationModuleVersion:
post:
tags:
- "MasterDataService"
summary: "Returns the calculation module version that is certified by the PTB."
description: "Returns the calculation module version that is certified by the\
\ PTB."
operationId: "MasterDataService.getCalculationModuleVersion"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
type: "string"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getCurrencies:
post:
tags:
- "MasterDataService"
summary: "Get the available currencies for the business unit group which is\
\ associated with the current session."
description: "Get the available currencies for the business unit group which\
\ is associated with the current session."
operationId: "MasterDataService.getCurrencies"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/CurrencyResult"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getCurrenciesAndExchangeRates:
post:
tags:
- "MasterDataService"
summary: "Get the available currencies and corresponding exchange rates which\
\ are related to the default currency of the busine..."
description: "Get the available currencies and corresponding exchange rates\
\ which are related to the default currency of the business unit
group\
\ which is associated to the current session."
operationId: "MasterDataService.getCurrenciesAndExchangeRates"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/CurrencyResult"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getCurrenciesForBusinessUnit:
post:
tags:
- "MasterDataService"
summary: "Get the available currencies for given business unit ID."
description: "Get the available currencies for given business unit ID."
operationId: "MasterDataService.getCurrenciesForBusinessUnit"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The business unit ID"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/CurrencyResult"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getDefaultCurrency:
post:
tags:
- "MasterDataService"
summary: "Get the default currency for the business unit group which is associated\
\ with the current session."
description: "Get the default currency for the business unit group which is\
\ associated with the current session."
operationId: "MasterDataService.getDefaultCurrency"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.currency.dto.dom.CurrencyDO"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getDefaultCurrencyForBusinessUnit:
post:
tags:
- "MasterDataService"
summary: "Get the default currency for the for the business unit group which\
\ is associated with given business unit."
description: "Get the default currency for the for the business unit group which\
\ is associated with given business unit."
operationId: "MasterDataService.getDefaultCurrencyForBusinessUnit"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The business unit ID"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.currency.dto.dom.CurrencyDO"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getDenominations:
post:
tags:
- "MasterDataService"
summary: "Gets available DenominationDO."
description: "Gets available DenominationDO."
operationId: "MasterDataService.getDenominations"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The DenominationRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.DenominationRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.DenominationResult"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getDiscountInfoIcons:
post:
tags:
- "MasterDataService"
summary: "Returns a list of promotions for a given item"
description: "Returns a list of promotions for a given item"
operationId: "MasterDataService.getDiscountInfoIcons"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PromotionItemRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.PromotionItemRequest"
responses:
200:
description: "successful operation"
schema:
type: "array"
items:
$ref: "#/definitions/com.gk_software.pos.flow.libs.transaction.DiscountIconList"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getEndDateTimestampExtension:
post:
tags:
- "MasterDataService"
summary: "Returns transaction extension for end date timestamp"
description: "Returns transaction extension for end date timestamp"
operationId: "MasterDataService.getEndDateTimestampExtension"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionExtension"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getExchangeRatesForCurrency:
post:
tags:
- "MasterDataService"
summary: "Get the available currencies and corresponding exchange rates which\
\ are related to the given currency of the business..."
description: "Get the available currencies and corresponding exchange rates\
\ which are related to the given currency of the business unit
group which\
\ is associated to the current session."
operationId: "MasterDataService.getExchangeRatesForCurrency"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The code of the currency"
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/ExchangeRatesResult"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getGiftCertificateClass:
post:
tags:
- "MasterDataService"
summary: "Gets the gift certificate class"
description: "Gets the gift certificate class"
operationId: "MasterDataService.getGiftCertificateClass"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The gc type code"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.gift_certificate_class.dto.dom.GiftCertificateClassDO"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getPromotion:
post:
tags:
- "MasterDataService"
summary: "Gets the data for the given promotion."
description: "Gets the data for the given promotion."
operationId: "MasterDataService.getPromotion"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ID of the promotion."
required: true
schema:
type: "integer"
format: "int64"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.swee.ses.api.server.md.promotion.dto.so.PromotionSO"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getPromotionByExternalId:
post:
tags:
- "MasterDataService"
summary: "Gets the data for the given external promotion ID."
description: "Gets the data for the given external promotion ID."
operationId: "MasterDataService.getPromotionByExternalId"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ID of the promotion."
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.swee.ses.api.server.md.promotion.dto.so.PromotionSO"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getReasonCodeGroup:
post:
tags:
- "MasterDataService"
summary: "Gets the reason code group with the given ID."
description: "Gets the reason code group with the given ID."
operationId: "MasterDataService.getReasonCodeGroup"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The group ID"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.ReasonResult"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getSimpleTaxList:
post:
tags:
- "MasterDataService"
summary: "Returns a consolidated tax list with simple data structure TAX_GROUP_ID\
\ = percent value."
description: "Returns a consolidated tax list with simple data structure TAX_GROUP_ID\
\ = percent value.
Used for fiscalization!"
operationId: "MasterDataService.getSimpleTaxList"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the business unit group ID"
required: true
schema:
type: "integer"
format: "int64"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.SimpleTaxListResult"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getSimpleTaxValue:
post:
tags:
- "MasterDataService"
summary: "Returns a consolidated tax percent value for the given tax group ID."
description: "Returns a consolidated tax percent value for the given tax group\
\ ID.
Used for fiscalization!"
operationId: "MasterDataService.getSimpleTaxValue"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The business unit group ID"
required: true
schema:
type: "integer"
format: "int64"
- in: "body"
name: "body"
description: "The tax group ID"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
type: "number"
format: "double"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getTenders:
post:
tags:
- "MasterDataService"
summary: "Gets all available tenders."
description: "Gets all available tenders."
operationId: "MasterDataService.getTenders"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.TenderResult"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getTendersByRequest:
post:
tags:
- "MasterDataService"
summary: "Get all tenders associated to a reason."
description: "Get all tenders associated to a reason."
operationId: "MasterDataService.getTendersByRequest"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The TenderRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.TenderRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.TenderResult"
/com.gk_software.pos.api.service.masterdata.MasterDataService/getTimePeriods:
post:
tags:
- "MasterDataService"
summary: "Get available TimePeriods for a given internalTimeGroupId (of a timegroup)"
description: "Get available TimePeriods for a given internalTimeGroupId(of a\
\ timegroup)"
operationId: "MasterDataService.getTimePeriods"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The internal time group id"
required: true
schema:
type: "integer"
format: "int64"
responses:
200:
description: "successful operation"
schema:
type: "array"
items:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.time_group.dto.dom.TimePeriod"
/com.gk_software.pos.api.service.masterdata.MasterDataService/isImmediateVoidingAllowed:
post:
tags:
- "MasterDataService"
summary: "Searches for a tender by given tender type code and returns immediateVoidingAllowedFlag."
description: "Searches for a tender by given tender type code and returns immediateVoidingAllowedFlag."
operationId: "MasterDataService.isImmediateVoidingAllowed"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The tender type code"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
type: "boolean"
/com.gk_software.pos.api.service.masterdata.MasterDataService/isPosUOMItemAvailable:
post:
tags:
- "MasterDataService"
summary: "Checks whether an PosUOMItemDO with the specified POS item ID exists\
\ or not."
description: "Checks whether an PosUOMItemDO with the specified POS item ID\
\ exists or not."
operationId: "MasterDataService.isPosUOMItemAvailable"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The POS item ID"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
type: "boolean"
/com.gk_software.pos.api.service.masterdata.MasterDataService/isPromotionAvailable:
post:
tags:
- "MasterDataService"
summary: "Checks whether a promotion with given external promotion ID exists."
description: "Checks whether a promotion with given external promotion ID exists."
operationId: "MasterDataService.isPromotionAvailable"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The external promotion ID"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
type: "boolean"
/com.gk_software.pos.api.service.masterdata.item.ItemQueryService/findPosUOMItemSearchViewListByFilter:
post:
tags:
- "ItemQueryService"
summary: "Find pos uom item search view list by filter."
description: "Find pos uom item search view list by filter."
operationId: "ItemQueryService.findPosUOMItemSearchViewListByFilter"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ItemSearchRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.item.bl.ItemSearchRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/ItemSearchResponse"
/com.gk_software.pos.api.service.masterdata.item.ItemQueryService/getInformationStockInfo:
post:
tags:
- "ItemQueryService"
summary: "Gets the stock details for given POS items. For each requested ID\
\ an ItemInformation object containing"
description: "Gets the stock details for given POS items. For each requested\
\ ID an ItemInformation object containing
the details is returned."
operationId: "ItemQueryService.getInformationStockInfo"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The InformationStockInfoRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.item.InformationStockInfoRequest"
responses:
200:
description: "successful operation"
schema:
type: "array"
items:
$ref: "#/definitions/com.gk_software.pos.api.model.dom.app.ItemInformation.ItemInformation"
/com.gk_software.pos.api.service.masterdata.item.ItemQueryService/getItemInformationPosItemId:
post:
tags:
- "ItemQueryService"
summary: "Gets the item information for an item with specified POS item id."
description: "Gets the item information for an item with specified POS item\
\ id."
operationId: "ItemQueryService.getItemInformationPosItemId"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ItemInformationRequest"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.item.ItemInformationRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.model.dom.app.ItemInformation.ItemInformation"
/com.gk_software.pos.api.service.masterdata.item.ItemQueryService/getItemInformationStockInfo:
post:
tags:
- "ItemQueryService"
summary: "Gets the stock info prepared for an item with specified POS item id."
description: "Gets the stock info prepared for an item with specified POS item\
\ id."
operationId: "ItemQueryService.getItemInformationStockInfo"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the ItemInformationStockInfoRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.item.ItemInformationStockInfoRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.model.dom.app.ItemInformation.ItemInformation"
/com.gk_software.pos.api.service.masterdata.item.ItemQueryService/loadItemDOByKey:
post:
tags:
- "ItemQueryService"
summary: "Loads item master data for specified POS itemDO key."
description: "Loads item master data for specified POS item ID."
operationId: "ItemQueryService.loadItemDOByKey"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the POS itemDO key"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.item.LoadItemDOByKeyRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemDO"
/com.gk_software.pos.api.service.masterdata.item.ItemQueryService/loadItemDOByPosItemId:
post:
tags:
- "ItemQueryService"
summary: "Loads item master data for specified POS item ID."
description: "Loads item master data for specified POS item ID."
operationId: "ItemQueryService.loadItemDOByPosItemId"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the POS item ID"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemDO"
/com.gk_software.pos.api.service.masterdata.item.ItemQueryService/loadItemDOListByPosItemIdList:
post:
tags:
- "ItemQueryService"
summary: "Loads list of items for the specified POS item IDs."
description: "Loads list of items for the specified POS item IDs."
operationId: "ItemQueryService.loadItemDOListByPosItemIdList"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "List of POS item IDs"
required: true
schema:
type: "array"
items:
type: "string"
responses:
200:
description: "successful operation"
schema:
type: "array"
items:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemDO"
/com.gk_software.pos.api.service.masterdata.item.ItemQueryService/loadSimplePosUomItemDO:
post:
tags:
- "ItemQueryService"
summary: "Loads item data for given item ID and returns it in form of SimplePosUomItemDO."
description: "Loads item data for given item ID and returns it in form of SimplePosUomItemDO."
operationId: "ItemQueryService.loadSimplePosUomItemDO"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The item ID"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.masterdata.item.SimplePosUomItemDO"
/com.gk_software.pos.api.service.order.SalesOrderService/addLineItemsToInitializedSalesOrders:
post:
tags:
- "SalesOrderService"
summary: "Sends one or more order change requests of existing initialized orders\
\ to SAP ERP with new items ordered by customer."
description: "Sends one or more order change requests of existing initialized\
\ orders to SAP ERP with new items ordered by customer."
operationId: "SalesOrderService.addLineItemsToInitializedSalesOrders"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Map with change order requests for each sales order data. The\
\ map key consists of a TransactionExtension created for a sales order.\
\ The transaction extension value consists of sales order data grouped by\
\ a semi-column separator. Each sales order data field is part of an array\
\ of String, which possible indexes and contants can be seen in SalesOrderConstants.\
\ The map value must contain a SalesOrderChangeConfirmationRequest for correspondent\
\ sales order data key."
required: true
schema:
type: "object"
additionalProperties:
$ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_change_request_confirmation.entities.SalesOrderChangeConfirmationRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "PosException if an unexpected exception occurs."
/com.gk_software.pos.api.service.order.SalesOrderService/updateSalesOrderDownPayments:
post:
tags:
- "SalesOrderService"
summary: "Update sales order down payments on the current session main transaction."
description: "Update sales order down payments on the current session main transaction.
The\
\ update process consists of checking all current sales orders currently available\
\ in the transaction and
voiding all down payments for one or more sales\
\ orders if the sum of down payments specific to this sales order
is\
\ greater than the sales order amount and then a new down payment line item\
\ is created containing the sales order amount sum."
operationId: "SalesOrderService.updateSalesOrderDownPayments"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "if an unexpected exception occurs."
/com.gk_software.pos.api.service.payment.PaymentService/addCashChangeAmountAlreadyPaidExtensions:
post:
tags:
- "PaymentService"
summary: "Adds the cash change amount already paid extensions."
description: "Adds the cash change amount already paid extensions."
operationId: "PaymentService.addCashChangeAmountAlreadyPaidExtensions"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the config"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.payment.PaymentService/addTerminalPrintoutsToLineItem:
post:
tags:
- "PaymentService"
summary: "Appends merchant and/or customer terminal receipts to line item."
description: "Appends merchant and/or customer terminal receipts to line item."
operationId: "PaymentService.addTerminalPrintoutsToLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.AddTerminalPrintoutsToLineItemRequest"
responses:
200:
description: "Success"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.payment.PaymentService/calculateChangeAfterGivenAmount:
post:
tags:
- "PaymentService"
summary: "Calculates the change once the given amount is accounted."
description: "Calculates the change once the given amount is accounted."
operationId: "PaymentService.calculateChangeAfterGivenAmount"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The amount that will be payed or received to be considered during\
\ change calculation."
required: true
schema:
type: "number"
format: "double"
responses:
200:
description: "Success"
schema:
type: "number"
format: "double"
500:
description: "If any error occurs."
/com.gk_software.pos.api.service.payment.PaymentService/cancelPayment:
post:
tags:
- "PaymentService"
summary: "Cancel payment mode before moving to registration mode"
description: "Cancel payment mode before moving to registration mode"
operationId: "PaymentService.cancelPayment"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "including error code TRANSACTION_NOT_FOUND"
/com.gk_software.pos.api.service.payment.PaymentService/checkLimits:
post:
tags:
- "PaymentService"
summary: "Checks an entered payment amount according to minimum and maximum\
\ accepted amount of the tender"
description: "Checks an entered payment amount according to minimum and maximum\
\ accepted amount of the tender"
operationId: "PaymentService.checkLimits"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The AmountValidationRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.AmountValidationRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.AmountValidationResult"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.payment.PaymentService/checkMaxDenominationDifference:
post:
tags:
- "PaymentService"
summary: "Checks an entered payment amount according to maximum denomination\
\ difference for the used currency"
description: "Checks an entered payment amount according to maximum denomination\
\ difference for the used currency"
operationId: "PaymentService.checkMaxDenominationDifference"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The AmountValidationRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.AmountValidationRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.AmountValidationResult"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.payment.PaymentService/createChangeAndGetPaymentAmounts:
post:
tags:
- "PaymentService"
summary: "Calculates the change amount and creates a change tender line item\
\ in case of overpayment for the transaction which is"
description: "Calculates the change amount and creates a change tender line\
\ item in case of overpayment for the transaction which is
associated\
\ with the current session"
operationId: "PaymentService.createChangeAndGetPaymentAmounts"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PaymentRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PaymentRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PaymentResult"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.payment.PaymentService/createTenderExchangeTransaction:
post:
tags:
- "PaymentService"
summary: "Creates and prepares the transaction for tender exchange for finalization."
description: "Creates and prepares the transaction for tender exchange for finalization."
operationId: "PaymentService.createTenderExchangeTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PaymentRequest for the tender exchange."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PaymentRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PaymentResult"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.payment.PaymentService/filterPerTender:
post:
tags:
- "PaymentService"
summary: "Filter per tender. Several checks are executed on all tenders of the\
\ TenderCollection. In case that a check a..."
description: "Filter per tender. Several checks are executed on all tenders\
\ of the TenderCollection. In case that a check applies
on a tender the\
\ tender will be forbidden."
operationId: "PaymentService.filterPerTender"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The FilterPerTenderRequest request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.FilterPerTenderRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/FilterPerTenderResult"
500:
description: "If any error occurs."
/com.gk_software.pos.api.service.payment.PaymentService/getCustomerExclusiveTenderGroupCode:
post:
tags:
- "PaymentService"
summary: "Get the tender group code if there exists an customer exclusive tender."
description: "Get the tender group code if there exists an customer exclusive\
\ tender."
operationId: "PaymentService.getCustomerExclusiveTenderGroupCode"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The customer id to check the tenders for"
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
type: "string"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.payment.PaymentService/getExclusiveCustomerTender:
post:
tags:
- "PaymentService"
summary: "Get the exclusive customer tender, if there exists one."
description: "Get the exclusive customer tender, if there exists one."
operationId: "PaymentService.getExclusiveCustomerTender"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.payment.PaymentService/getFoodStampsTotal:
post:
tags:
- "PaymentService"
summary: "Calculates the sum of all items allowed for payment with Foods stamps."
description: "Calculates the sum of all items allowed for payment with Foods\
\ stamps."
operationId: "PaymentService.getFoodStampsTotal"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "indicates whether discounts should be considered"
required: true
schema:
type: "boolean"
responses:
200:
description: "Success"
schema:
type: "number"
format: "double"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.payment.PaymentService/getPaymentAmounts:
post:
tags:
- "PaymentService"
summary: "Calculates the change amount for the transaction which is associated\
\ with the current session"
description: "Calculates the change amount for the transaction which is associated\
\ with the current session"
operationId: "PaymentService.getPaymentAmounts"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PaymentRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PaymentRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PaymentAmountsResult"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.payment.PaymentService/getSpecialReturnAmountLookupKey:
post:
tags:
- "PaymentService"
summary: "Get the lookup key for the return amounts processing"
description: "Get the lookup key for the return amounts processing"
operationId: "PaymentService.getSpecialReturnAmountLookupKey"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.SpecialReturnAmountLookupKeyRequest"
responses:
200:
description: "Success"
schema:
type: "string"
500:
description: "If any error occurs."
/com.gk_software.pos.api.service.payment.PaymentService/getTenderExchangeAmounts:
post:
tags:
- "PaymentService"
summary: "Calculates the amounts after tender exchange."
description: "Calculates the amounts after tender exchange."
operationId: "PaymentService.getTenderExchangeAmounts"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PaymentRequest for the tender exchange."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PaymentRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PaymentAmountsResult"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.payment.PaymentService/getTenderPayableAmount:
post:
tags:
- "PaymentService"
summary: "Gets the tender payable amount"
description: "Gets the tender payable amount"
operationId: "PaymentService.getTenderPayableAmount"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PaymentRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PaymentRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PayableAmountResult"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.payment.PaymentService/getTotalTenderAmount:
post:
tags:
- "PaymentService"
summary: "Calculates the total tender amount (given payments) for the transaction\
\ which is associated with the current session"
description: "Calculates the total tender amount (given payments) for the transaction\
\ which is associated with the current session"
operationId: "PaymentService.getTotalTenderAmount"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
type: "number"
format: "double"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.payment.PaymentService/getTotalTenderAmountForTender:
post:
tags:
- "PaymentService"
summary: "Calculates the total tender amount (given payments) of a specific\
\ tender for the transaction which is associated with..."
description: "Calculates the total tender amount (given payments) of a specific\
\ tender for the transaction which is associated with the
current session"
operationId: "PaymentService.getTotalTenderAmountForTender"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Tender to be checked"
required: true
schema:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO"
responses:
200:
description: "Success"
schema:
type: "number"
format: "double"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.payment.PaymentService/isReplaceSubtotalRequired:
post:
tags:
- "PaymentService"
summary: "Checks whether the subtotal rounding should be replaced."
description: "Checks whether the subtotal rounding should be replaced."
operationId: "PaymentService.isReplaceSubtotalRequired"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
type: "boolean"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.payment.PaymentService/isTenderAllowedForAllCustomer:
post:
tags:
- "PaymentService"
summary: "Checks whether a tender is allowed for all customers in general according\
\ to default settings."
description: "Checks whether a tender is allowed for all customers in general\
\ according to default settings."
operationId: "PaymentService.isTenderAllowedForAllCustomer"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the tender type code"
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
type: "boolean"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.payment.PaymentService/isTenderAllowedForCustomer:
post:
tags:
- "PaymentService"
summary: "Checks whether a tender is allowed for customer of customers assigned\
\ to the current transaction."
description: "Checks whether a tender is allowed for customer of customers assigned\
\ to the current transaction."
operationId: "PaymentService.isTenderAllowedForCustomer"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the tender type code"
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
type: "boolean"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.payment.PaymentService/isTenderAllowedForCustomerGroup:
post:
tags:
- "PaymentService"
summary: "Checks whether a tender is allowed for customer groups of customers\
\ assigned to the current transaction."
description: "Checks whether a tender is allowed for customer groups of customers\
\ assigned to the current transaction."
operationId: "PaymentService.isTenderAllowedForCustomerGroup"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the tender type code"
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
type: "boolean"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.payment.PaymentService/isTenderAllowedForSaleReturnLineItemReason:
post:
tags:
- "PaymentService"
summary: "Checks whether a tender is allowed for sale return line item reasons\
\ of items with the given item type in current"
description: "Checks whether a tender is allowed for sale return line item reasons\
\ of items with the given item type in current
transaction."
operationId: "PaymentService.isTenderAllowedForSaleReturnLineItemReason"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the tender type code"
required: true
schema:
type: "string"
- in: "body"
name: "body"
description: "the sale return line item item type"
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
type: "boolean"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.payment.PaymentService/reduceTaxableAmountForEwic:
post:
tags:
- "PaymentService"
summary: "Calculates the sum of all items minus amount allowed for payment with\
\ eWIC."
description: "Calculates the sum of all items minus amount allowed for payment\
\ with eWIC."
operationId: "PaymentService.resetTaxForEwicTender"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.ReduceTaxableAmountRequest"
responses:
200:
description: "Success"
schema:
type: "number"
format: "double"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.payment.PaymentService/reduceTaxableAmountForFoodStamp:
post:
tags:
- "PaymentService"
summary: "Calculates the sum of all items minus amount allowed for payment with\
\ Foods stamps."
description: "Calculates the sum of all items minus amount allowed for payment\
\ with Foods stamps."
operationId: "PaymentService.reduceTaxableAmountForFoodStamp"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the amount"
required: true
schema:
type: "number"
format: "double"
responses:
200:
description: "Success"
schema:
type: "number"
format: "double"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.payment.PaymentService/reduceTaxableAmountForWicVoucher:
post:
tags:
- "PaymentService"
summary: "Calculates the sum of all items minus amount allowed for payment with\
\ Wic Voucher."
description: "Calculates the sum of all items minus amount allowed for payment\
\ with Wic Voucher."
operationId: "PaymentService.reduceTaxableAmountForWicVoucher"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the amount"
required: true
schema:
type: "number"
format: "double"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.payment.PaymentService/registerCashPayment:
post:
tags:
- "PaymentService"
summary: "Adds a tender line item to transaction which is associated with the\
\ current session. If there is a cashback value >..."
description: "Adds a tender line item to transaction which is associated with\
\ the current session. If there is a cashback value > 0 a
cashback\
\ tender line item with appropriate value will be added to the transaction."
operationId: "PaymentService.registerCashPayment"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CashPaymentRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.CashPaymentRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PaymentResult"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.payment.PaymentService/registerCheckPayment:
post:
tags:
- "PaymentService"
summary: "Adds a TenderLineItem with check payment information to the transaction"
description: "Adds a TenderLineItem with check payment information to the transaction"
operationId: "PaymentService.registerCheckPayment"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CheckPaymentRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.CheckPaymentRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PaymentResult"
500:
description: "In case that access to transaction data fails."
/com.gk_software.pos.api.service.payment.PaymentService/registerCreditPayment:
post:
tags:
- "PaymentService"
summary: "Adds a tender line item to transaction which is associated with the\
\ current session."
description: "Adds a tender line item to transaction which is associated with\
\ the current session."
operationId: "PaymentService.registerCreditPayment"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CreditPaymentRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.CreditPaymentRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PaymentResult"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.payment.PaymentService/registerGiftCertificatePayment:
post:
tags:
- "PaymentService"
summary: "Adds a TenderLineItem with gift certificate payment information to\
\ the transaction"
description: "Adds a TenderLineItem with gift certificate payment information\
\ to the transaction"
operationId: "PaymentService.registerGiftCertificatePayment"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The GiftCertificatePaymentRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.GiftCertificatePaymentRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PaymentResult"
500:
description: "In case that access to transaction data fails."
/com.gk_software.pos.api.service.payment.PaymentService/registerGiftCertificateSpvPayment:
post:
tags:
- "PaymentService"
summary: "Adds a SaleReturnLineItem with single purpose voucher information\
\ to the transaction"
description: "Adds a SaleReturnLineItem with gift certificate single purpose\
\ voucher payment information to the transaction"
operationId: "PaymentService.registerGiftCertificateSpvPayment"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The GiftCertificateSpvPaymentRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.GiftCertificateSpvPaymentRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PaymentResult"
500:
description: "In case that access to transaction data fails."
/com.gk_software.pos.api.service.payment.PaymentService/registerMobilePayment:
post:
tags:
- "PaymentService"
summary: "Registers a payment position with custom tenderClassCode for mobile\
\ payment"
description: "Registers a payment position with custom tenderClassCode for mobile\
\ payment"
operationId: "PaymentService.registerMobilePayment"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PaymentRequest for the tender exchange"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PaymentRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PaymentResult"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.payment.PaymentService/registerPointsPayment:
post:
tags:
- "PaymentService"
summary: "Adds a tender line item to transaction which is associated with the\
\ current session. If there is a cashback value >..."
description: "Adds a tender line item to transaction which is associated with\
\ the current session. If there is a cashback value > 0 a
cashback\
\ tender line item with appropriate value will be added to the transaction."
operationId: "PaymentService.registerPointsPayment"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PointsPaymentRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PointsPaymentRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PaymentResult"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.payment.PaymentService/registerTerminalPayment:
post:
tags:
- "PaymentService"
summary: "Adds a CreditDebitCard TenderLineItem to the transaction which is\
\ associated with current session."
description: "Adds a CreditDebitCard TenderLineItem to the transaction which\
\ is associated with current session."
operationId: "PaymentService.registerTerminalPayment"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The TerminalPaymentRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.TerminalPaymentRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.PaymentResult"
500:
description: "In case that access to transaction data fails."
/com.gk_software.pos.api.service.payment.PaymentService/updateTerminalTenderAuthorization:
post:
tags:
- "PaymentService"
summary: "Updates terminal tender authorization with basic payment data."
description: "Updates terminal tender authorization with basic payment data."
operationId: "PaymentService.updateTerminalTenderAuthorization"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The TerminalPaymentRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.TerminalPaymentRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "In case that access to transaction data fails."
/com.gk_software.pos.api.service.payment.PaymentService/validateAmount:
post:
tags:
- "PaymentService"
summary: "Validate an entered payment amount"
description: "Validate an entered payment amount"
operationId: "PaymentService.validateAmount"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The AmountValidationRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.AmountValidationRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.payment.AmountValidationResult"
500:
description: "in case of any error"
/com.gk_software.pos.api.service.posgroup.PosGroupManagementService/login:
post:
tags:
- "PosGroupManagementService"
summary: "Performs a pos group login. It will do the authentication for the\
\ operator and creation of a new pos session."
description: "Performs a pos group login. It will do the authentication for\
\ the operator and creation of a new pos session."
operationId: "PosGroupManagementService.login"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PosGroupOperatorLoginRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.posgroup.PosGroupOperatorLoginRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.posgroup.PosGroupOperatorLoginResult"
500:
description: "If the request contains illegal arguments. If there is no\
\ business unit found for the given identifier or the authentication failed\
\ because of invalid login credentials."
/com.gk_software.pos.api.service.posgroup.PosGroupManagementService/logout:
post:
tags:
- "PosGroupManagementService"
summary: "Performs a pos group logout (just removes the pos session)."
description: "Performs a pos group logout (just removes the pos session)."
operationId: "PosGroupManagementService.logout"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PosGroupOperatorLogoutRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.posgroup.PosGroupOperatorLogoutRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.posgroup.PosGroupOperatorLogoutResult"
500:
description: "If there is no session with the identifier given in the request."
/com.gk_software.pos.api.service.posgroup.PosGroupManagementService/logoutAllOperators:
post:
tags:
- "PosGroupManagementService"
operationId: "logoutAllOperators"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
default:
description: "successful operation"
/com.gk_software.pos.api.service.prepaid.GkrSvsPrepaidServerService/acquirePrepaidPin:
post:
tags:
- "GkrSvsPrepaidServerService"
summary: "Calls \"acquire prepaid pin\" on underlying prepaid service. "
description: "Calls \"acquire prepaid pin\" on underlying prepaid service.
For\
\ each containing prepaid item a prepaid PIN is sold. The PIN status on the\
\ server is set to “sold”."
operationId: "GkrSvsPrepaidServerService.acquirePrepaidPin"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PrepaidPinRequest containing the prepaid items."
required: true
schema:
$ref: "#/definitions/PrepaidPinRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/PrepaidPinResponse"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.promotion.LoyaltyRewardService/processLoyaltyRewardCoupon:
post:
tags:
- "LoyaltyRewardService"
summary: "Process active loyalty reward promotions which lead to coupon issuance"
description: "Process active loyalty reward promotions which lead to coupon\
\ issuance"
operationId: "LoyaltyRewardService.processLoyaltyRewardCoupon"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.promotion.LoyaltyRewardService/processLoyaltyRewardCouponByRequest:
post:
tags:
- "LoyaltyRewardService"
summary: "Process active loyalty reward promotions which lead to coupon issuance"
description: "Process active loyalty reward promotions which lead to coupon\
\ issuance"
operationId: "LoyaltyRewardService.processLoyaltyRewardCouponByRequest"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.promotion.LoyaltyRewardService/processLoyaltyRewardGiftCertificate:
post:
tags:
- "LoyaltyRewardService"
summary: "Process active loyalty reward promotions which lead to gift certificate\
\ issuance"
description: "Process active loyalty reward promotions which lead to gift certificate\
\ issuance"
operationId: "LoyaltyRewardService.processLoyaltyRewardGiftCertificate"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The LoyaltyRewardGiftCertificateRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.promotion.LoyaltyRewardGiftCertificateRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.promotion.PricingService/recalculateTransaction:
post:
tags:
- "PricingService"
summary: "Recalculates whole transaction, all relevant data are passed to LE\
\ and result is applied to transaction."
description: "Recalculates whole transaction, all relevant data are passed to\
\ LE and result is applied to transaction."
operationId: "PricingService.recalculateTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The Transaction to process."
required: true
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.promotion.PromotionTriggerService/addLineItemPromotionTrigger:
post:
tags:
- "PromotionTriggerService"
summary: "Adds a promotion trigger to a line item (manual line item discount)."
description: "Adds a promotion trigger to a line item (manual line item discount).
If\
\ no transaction exists in the current session, a new one is created with\
\ a new line item containing the requested promotion trigger.
Otherwise,\
\ the current session transaction is updated.
The line item to which\
\ a promotion trigger is applied is referenced by the line item key sent in\
\ the service request.
If the line item key is not provided and there\
\ is an open line item, the open line item is used for inserting the new trigger.
If\
\ the line item key is not provided and there is no open line item, or the\
\ provided line item key can not be found,
a new line item is created\
\ and the promotion trigger added to it.
The promotion trigger is\
\ always applied to a main line item. That means the main line item for an\
\ item is used
if the line item key present in the request relates to\
\ a linked item.
After the promotion trigger is added to the line item,\
\ it is checked whether the discount has been correctly applied.
If for\
\ some reason the discount has not been applied, the trigger is removed from\
\ the line item and the error
(LINE_PROMOTION_TRIGGER__TRIGGER_NOT_APPLIED)\
\ will be described in the result object in the failure field.
If\
\ the discount is successfully processed, a SaleReturnLineItemExtension with\
\ key MAX_REBATE_QUANTITY
key is added to the line item containing the\
\ maximum allowed quantity for the line item.
Finally, the transaction\
\ is recalculated and the active customer id and the active customer order\
\ sequence number are stored in the line item, if set in the request,
and\
\ the updated transaction is stored."
operationId: "PromotionTriggerService.addLineItemPromotionTrigger"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The request for applying a promotion trigger to the line item."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.promotion.PromotionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "The exception is thrown if an unexpected error occurs."
/com.gk_software.pos.api.service.promotion.PromotionTriggerService/addTransactionPromotionTrigger:
post:
tags:
- "PromotionTriggerService"
summary: "Adds a promotion trigger at transaction level (manual receipt discount)\
\ to the current session transaction, or to a n..."
description: "Adds a promotion trigger at transaction level (manual receipt\
\ discount) to the current session transaction, or to a new transaction if\
\ current session has no transaction.
The transaction is then recalculated\
\ and stored."
operationId: "PromotionTriggerService.addTransactionPromotionTrigger"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The promotion request containing all information necessary for\
\ adding the promotion trigger to the transaction."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.promotion.PromotionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "The exception is thrown if an unexpected error occurs."
/com.gk_software.pos.api.service.promotion.PromotionTriggerService/processPromotionInputValues:
post:
tags:
- "PromotionTriggerService"
summary: "Processes promotion input values entered by operator for manual promotion\
\ triggers and creates new promotion triggers."
description: "Processes promotion input values entered by operator for manual\
\ promotion triggers and creates new promotion triggers.
This service\
\ can be used for processing triggers at both transaction and line item level.
If\
\ line item is set in the request, the trigger for a line item is processed,\
\ otherwise, the trigger for the transaction
will be processed.
The\
\ transaction is then recalculated and stored."
operationId: "PromotionTriggerService.processPromotionInputValues"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The request for processing promotion input values entered by\
\ operator."
required: true
schema:
$ref: "#/definitions/PromotionInputResponse"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
/com.gk_software.pos.api.service.promotion.PromotionTriggerService/providePromotionInputRequestList:
post:
tags:
- "PromotionTriggerService"
summary: "Removes current promotion input requests from line item with given\
\ line item key, or current transaction (if line ite..."
description: "Removes current promotion input requests from line item with given\
\ line item key, or current transaction (if line item is not set in the request)
and\
\ retrieves new promotion input requests for operator.
The transaction\
\ is then recalculated and stored.
Note: The pricing engine (PE) does\
\ not support this call and will never return a promotion input list for an\
\ operator through this call.
This call is currently only used for supporting\
\ loyalty engine (LE)."
operationId: "PromotionTriggerService.providePromotionInputRequestList"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The key corresponding to a line item for which the promotion\
\ input requests should be retrieved for. This field is optional
\t\
and if not provided the service will provide promotion input requests for\
\ complete transaction."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
/com.gk_software.pos.api.service.promotion.PromotionTriggerService/removeLineItemPromotionTriggers:
post:
tags:
- "PromotionTriggerService"
summary: "Removes all promotion triggers from a line item (manual line item\
\ discounts), only if the line item is still open."
description: "Removes all promotion triggers from a line item (manual line item\
\ discounts), only if the line item is still open.
If a line item key\
\ is provided in the request, the service will check the promotion triggers\
\ of the specified line item.
Otherwise, the last open line item is used,\
\ if any exists. If a promotion trigger is removed, the transaction is recalculated\
\ and stored."
operationId: "PromotionTriggerService.removeLineItemPromotionTriggers"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The request object for removing promotion triggers for a line\
\ item."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.promotion.PromotionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "The exception is thrown if any unexpected error occurs."
/com.gk_software.pos.api.service.promotion.PromotionTriggerService/removeTransactionPromotionTriggers:
post:
tags:
- "PromotionTriggerService"
summary: "Removes all promotion triggers at transaction level (manual receipt\
\ discounts), if any exists."
description: "Removes all promotion triggers at transaction level (manual receipt\
\ discounts), if any exists.
The transaction is then recalculated and\
\ stored."
operationId: "PromotionTriggerService.removeTransactionPromotionTriggers"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "The exception is thrown if any unexpected error occurs."
/com.gk_software.pos.api.service.promotion.PromotionTriggerService/validateLineItemPromotionTriggers:
post:
tags:
- "PromotionTriggerService"
summary: "Validates current promotion triggers on line item provided by request\
\ (manual line item discounts).
"
description: "Validates current promotion triggers on line item provided by\
\ request (manual line item discounts).
A promotion trigger validation\
\ consists of:
"
operationId: "PromotionTriggerService.validateLineItemPromotionTriggers"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The request object containing all information necessary for\
\ validating promotion triggers on a specific line item."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.promotion.PromotionTriggerValidationRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/PromotionValidationResultType"
500:
description: "The validation exception is thrown for the following validation\
\ errors:
"
/com.gk_software.pos.api.service.promotion.PromotionTriggerService/validateTransactionPromotionTriggers:
post:
tags:
- "PromotionTriggerService"
summary: "Validates promotion triggers from current transaction at transaction\
\ level (manual receipt discounts)."
description: "Validates promotion triggers from current transaction at transaction\
\ level (manual receipt discounts).
A transaction promotion trigger validation\
\ consists of:
"
operationId: "PromotionTriggerService.validateTransactionPromotionTriggers"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The request object containing all information necessary for\
\ validating promotion triggers at transaction level."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.promotion.PromotionTriggerValidationRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/PromotionValidationResultType"
500:
description: "The validation exception is thrown for the following validation\
\ errors:
"
/com.gk_software.pos.api.service.rescan.RescanService/copyExternalTransactionLineItemsFullRescan:
post:
tags:
- "RescanService"
summary: "This methods copies line items from retrieved customer transaction\
\ to the current transaction."
description: "This methods copies line items from retrieved customer transaction\
\ to the current transaction."
operationId: "RescanService.copyExternalTransactionLineItemsFullRescan"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The copyExternalTransactionLineItemsFullRescan request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.CopyExternalTransactionLineItemsFullRescanRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.CopyExternalTransactionLineItemsFullRescanResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.rescan.RescanService/copyGiftCertificateLineItemFullRescan:
post:
tags:
- "RescanService"
summary: "This methods copies a gift certificate line item from retrieved customer\
\ transaction to the current transaction."
description: "This methods copies a gift certificate line item from retrieved\
\ customer transaction to the current transaction."
operationId: "RescanService.copyGiftCertificateLineItemFullRescan"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The copyGiftCertificateLineItemFullRescan request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.CopyGiftCertificateLineItemFullRescanRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.CopyGiftCertificateLineItemFullRescanResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.rescan.RescanService/executeRescanAnalysis:
post:
tags:
- "RescanService"
summary: "Executes the rescan analysis and adds the result to the transaction."
description: "Executes the rescan analysis and adds the result to the transaction."
operationId: "RescanService.executeRescanAnalysis"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The executeRescanAnalysis request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.ExecuteRescanAnalysisRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.ExecuteRescanAnalysisResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.rescan.RescanService/finishFullRescan:
post:
tags:
- "RescanService"
summary: "This method will execute the finish steps for the full rescan."
description: "This method will execute the finish steps for the full rescan."
operationId: "RescanService.finishFullRescan"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The finishFullRescan request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.FinishFullRescanRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.FinishFullRescanResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.rescan.RescanService/finishPartialRescan:
post:
tags:
- "RescanService"
summary: "This method will execute the finish steps for the partial rescan."
description: "This method will execute the finish steps for the partial rescan."
operationId: "RescanService.finishPartialRescan"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The finishPartialRescan request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.FinishPartialRescanRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.FinishPartialRescanResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.rescan.RescanService/prepareFullRescan:
post:
tags:
- "RescanService"
summary: "Prepares various objects in the POS Session to be ready for a full\
\ rescan."
description: "Prepares various objects in the POS Session to be ready for a\
\ full rescan."
operationId: "RescanService.prepareFullRescan"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The prepareFullRescan request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.PrepareFullRescanRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.PrepareFullRescanResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.rescan.RescanService/preparePartialRescan:
post:
tags:
- "RescanService"
summary: "Prepares various objects in the POS Session to be ready for a partial\
\ rescan."
description: "Prepares various objects in the POS Session to be ready for a\
\ partial rescan."
operationId: "RescanService.preparePartialRescan"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The preparePartialRescan request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.PreparePartialRescanRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.PreparePartialRescanResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.rescan.RescanService/processBarcodePartialRescan:
post:
tags:
- "RescanService"
summary: "This methods performs the barcode processing for partial rescan."
description: "This methods performs the barcode processing for partial rescan."
operationId: "RescanService.processBarcodePartialRescan"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The processBarcodePartialRescan request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.ProcessBarcodePartialRescanRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.ProcessBarcodePartialRescanResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.rescan.RescanService/suspendAndRetrieveRescanTransaction:
post:
tags:
- "RescanService"
summary: "Suspends the current transaction and retrieves it to a new transaction."
description: "Suspends the current transaction and retrieves it to a new transaction."
operationId: "RescanService.suspendAndRetrieveRescanTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The suspendAndRetrieveRescanTransaction request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.SuspendAndRetrieveRescanTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.SuspendAndRetrieveRescanTransactionResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.rescan.RescanService/validateQuantityPartialRescan:
post:
tags:
- "RescanService"
summary: "This method will execute the quantity validation for the last sale\
\ return line item."
description: "This method will execute the quantity validation for the last\
\ sale return line item."
operationId: "RescanService.validateQuantityPartialRescan"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The validateQuantityPartialRescan request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.rescan.ValidateQuantityPartialRescanRequest"
responses:
200:
description: "Success"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.security.AuthenticationService/authenticate:
post:
tags:
- "AuthenticationService"
summary: "Performs a login based on passed data in AuthenticationRequest."
description: "Performs a login based on passed data in AuthenticationRequest."
operationId: "AuthenticationService.authenticate"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The AuthenticationRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.security.AuthenticationRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.security.AuthenticationResult"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.security.AuthenticationService/updatePassword:
post:
tags:
- "AuthenticationService"
summary: "Update the operator password"
description: "Update the operator password"
operationId: "AuthenticationService.updatePassword"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The UpdatePasswordRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.security.UpdatePasswordRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.security.UpdatePasswordResult"
/com.gk_software.pos.api.service.security.AuthorizationService/authorize:
post:
tags:
- "AuthorizationService"
summary: "Performs authorization of operator for defined right"
description: "Performs authorization of operator for defined right"
operationId: "AuthorizationService.authorize"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link AuthorizationRequest}"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.security.AuthorizationRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.security.AuthorizationResult"
500:
description: "if authorization failed"
/com.gk_software.pos.api.service.security.AuthorizationService/clearResourceOverrideCache:
post:
tags:
- "AuthorizationService"
summary: "Clear resource override cache related to given operator."
description: "Clear resource override cache related to given operator."
operationId: "AuthorizationService.clearResourceOverrideCache"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the operator id"
required: true
schema:
type: "string"
responses:
default:
description: "successful operation"
/com.gk_software.pos.api.service.session.PosSessionService/activateMainTransaction:
post:
tags:
- "PosSessionService"
summary: "Sets main transaction as active."
description: "Sets main transaction as active."
operationId: "PosSessionService.activateMainTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.session.PosSessionService/activateNewMainTransaction:
post:
tags:
- "PosSessionService"
summary: "Activates provided transaction as a new main transaction in current\
\ session."
description: "Activates provided transaction as a new main transaction in current\
\ session."
operationId: "PosSessionService.activateNewMainTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.session.PosSessionService/createAnonymousLogin:
post:
tags:
- "PosSessionService"
summary: "Creates an anonymous session/login."
description: "Creates an anonymous session/login."
operationId: "PosSessionService.createAnonymousLogin"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The LoginRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.LoginRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.LoginResult"
500:
description: "If authentication failed."
/com.gk_software.pos.api.service.session.PosSessionService/createAnonymousSession:
post:
tags:
- "PosSessionService"
summary: "Creates an anonymous session."
description: "Creates an anonymous session."
operationId: "PosSessionService.createAnonymousSession"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The LoginRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.LoginRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.session.PosSessionId"
500:
description: "If authentication failed."
deprecated: true
/com.gk_software.pos.api.service.session.PosSessionService/getSession:
post:
tags:
- "PosSessionService"
summary: "Gets the session associated with the session id."
description: "Gets the session associated with the session id."
operationId: "PosSessionService.getSession"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The session id."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.session.PosSessionId"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/PosSession"
/com.gk_software.pos.api.service.session.PosSessionService/getSessions:
post:
tags:
- "PosSessionService"
summary: "Gets all existing sessions."
description: "Gets all existing sessions."
operationId: "PosSessionService.getSessions"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
type: "object"
additionalProperties:
type: "object"
/com.gk_software.pos.api.service.session.PosSessionService/isValidSession:
post:
tags:
- "PosSessionService"
summary: "Checks whether the given session id is valid."
description: "Checks whether the given session id is valid."
operationId: "PosSessionService.isValidSession"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The session id to be verified."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.session.PosSessionId"
responses:
200:
description: "successful operation"
schema:
type: "boolean"
/com.gk_software.pos.api.service.session.PosSessionService/lockSession:
post:
tags:
- "PosSessionService"
summary: "Performs a lock for the associated session. After this, the session\
\ is locked."
description: "Performs a lock for the associated session. After this, the session\
\ is locked."
operationId: "PosSessionService.lockSession"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
/com.gk_software.pos.api.service.session.PosSessionService/login:
post:
tags:
- "PosSessionService"
summary: "Logs in with password."
description: "Logs in with password."
operationId: "PosSessionService.login"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.LoginRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.LoginResult"
500:
description: "If authentication failed."
/com.gk_software.pos.api.service.session.PosSessionService/logoutIfAnonymous:
post:
tags:
- "PosSessionService"
summary: "Logs out if the current session is a anonymous session."
description: "Logs out if the current session is a anonymous session."
operationId: "PosSessionService.logoutIfAnonymous"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.LogoutResult"
/com.gk_software.pos.api.service.session.PosSessionService/logoutIfNecessary:
post:
tags:
- "PosSessionService"
summary: "Checks whether a sign on transaction exists for the given parameters."
description: "Checks whether a sign on transaction exists for the given parameters.
If\
\ a sign on transaction exists a sign off transaction with operator/worker/till\
\ from the sign on transaction will be
created. Furthermore logout of\
\ operator and till is executed on Login manager."
operationId: "PosSessionService.logoutIfNecessary"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The request object, with the relevant businessUnitId and the\
\ workstationId"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.LogoutRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.LogoutResult"
/com.gk_software.pos.api.service.session.PosSessionService/logoutPreserveSession:
post:
tags:
- "PosSessionService"
summary: "Performs a technical logout for the associated session. "
description: "Performs a technical logout for the associated session.
Technical\
\ logout means:
After this, the session is still\
\ valid."
operationId: "PosSessionService.logoutPreserveSession"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.LogoutResult"
/com.gk_software.pos.api.service.session.PosSessionService/logoutWithRequest:
post:
tags:
- "PosSessionService"
summary: "Performs a logout for the associated session with validation of the\
\ user credentials if requested. Internally an auth..."
description: "Performs a logout for the associated session with validation of\
\ the user credentials if requested. Internally an authentication request
with\
\ the operatorId out of the session and the passed password is performed.\
\ On success the session will be removed. If an
authentication failure\
\ occurs a {@link AuthenticationFailedException} is thrown."
operationId: "PosSessionService.logout"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.LogoutRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.LogoutResult"
500:
description: "If the authentication fails for any reason"
/com.gk_software.pos.api.service.session.PosSessionService/removeSession:
post:
tags:
- "PosSessionService"
summary: "Removes/invalidates actual session."
description: "Removes/invalidates actual session."
operationId: "PosSessionService.removeSession"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
default:
description: "successful operation"
/com.gk_software.pos.api.service.session.PosSessionService/removeSessionRequest:
post:
tags:
- "PosSessionService"
summary: "Removes/invalidates actual session."
description: "Removes/invalidates actual session."
operationId: "PosSessionService.removeSessionRequest"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The request with session id and clear session holder possibility."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.RemoveSessionRequest"
responses:
default:
description: "successful operation"
/com.gk_software.pos.api.service.session.PosSessionService/setActiveTransaction:
post:
tags:
- "PosSessionService"
summary: "Sets transaction for given scope as active transaction"
description: "Sets transaction for given scope as active transaction"
operationId: "PosSessionService.setActiveTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The scope"
required: true
schema:
type: "string"
responses:
default:
description: "successful operation"
/com.gk_software.pos.api.service.session.PosSessionService/setLanguageSettings:
post:
tags:
- "PosSessionService"
summary: "Sets the language settings (active scope and language hierarchies)\
\ for the current session."
description: "Sets the language settings (active scope and language hierarchies)\
\ for the current session."
operationId: "PosSessionService.setLanguageSettings"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The language settings."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.LanguageSettings"
responses:
default:
description: "successful operation"
/com.gk_software.pos.api.service.session.PosSessionService/setLastServerStatus:
post:
tags:
- "PosSessionService"
summary: "Sets last server status."
description: "Sets last server status."
operationId: "PosSessionService.setLastServerStatus"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
required: true
schema:
type: "boolean"
responses:
200:
description: "Success"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.session.PosSessionService/setPosSessionData:
post:
tags:
- "PosSessionService"
summary: "Sets store specific data to pos session"
description: "Sets store specific data to pos session"
operationId: "PosSessionService.setPosSessionData"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.session.PosSessionData"
responses:
default:
description: "successful operation"
/com.gk_software.pos.api.service.session.PosSessionService/unlockByForeignUser:
post:
tags:
- "PosSessionService"
summary: "Performs an unlock for the associated session with a new user. If\
\ the authentication for the new user is successful, ..."
description: "Performs an unlock for the associated session with a new user.\
\ If the authentication for the new user is successful, then the
previous\
\ user will be logged out, the new user is logged in and unlocks the session."
operationId: "PosSessionService.unlockByForeignUser"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The request object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.LoginRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.SwitchUserResult"
500:
description: "If authentication failed"
/com.gk_software.pos.api.service.session.PosSessionService/unlockSessionRequest:
post:
tags:
- "PosSessionService"
summary: "Performs a unlock for the associated session."
description: "Performs a unlock for the associated session."
operationId: "PosSessionService.unlockSession"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The unlock request."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.session.UnlockSessionRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
/com.gk_software.pos.api.service.session.PosSessionService/updateScopedTransaction:
post:
tags:
- "PosSessionService"
summary: "Overrides the scoped transaction in session"
description: "Overrides the scoped transaction in session"
operationId: "PosSessionService.updateScopedTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The scoped Transaction"
required: true
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
responses:
default:
description: "successful operation"
/com.gk_software.pos.api.service.smartpos.SmartPOSMDReplicationStateProviderService/getLastReplicatedChangedEntityId:
post:
tags:
- "SmartPOSMDReplicationStateProviderService"
summary: "Gets the last replicated changed entity id."
description: "Gets the last replicated changed entity id."
operationId: "SmartPOSMDReplicationStateProviderService.getLastReplicatedChangedEntityId"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
type: "string"
/com.gk_software.pos.api.service.smartpos.SmartPOSMDReplicationStateProviderService/getMDReplicationEndEvent:
post:
tags:
- "SmartPOSMDReplicationStateProviderService"
summary: "Gets the replication end event."
description: "Gets the replication end event."
operationId: "SmartPOSMDReplicationStateProviderService.getMDReplicationEndEvent"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.smartpos.MDReplicationEndEvent"
/com.gk_software.pos.api.service.smartpos.SmartPOSMDReplicationStateProviderService/getMDReplicationProgressEvent:
post:
tags:
- "SmartPOSMDReplicationStateProviderService"
summary: "Gets the replication progress event."
description: "Gets the replication progress event."
operationId: "SmartPOSMDReplicationStateProviderService.getMDReplicationProgressEvent"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.smartpos.MDReplicationProgressEvent"
/com.gk_software.pos.api.service.smartpos.SmartPOSMDReplicationStateProviderService/isReplicationFinished:
post:
tags:
- "SmartPOSMDReplicationStateProviderService"
summary: "Checks if replication is finished."
description: "Checks if replication is finished."
operationId: "SmartPOSMDReplicationStateProviderService.isReplicationFinished"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
type: "boolean"
/com.gk_software.pos.api.service.smartpos.SmartPOSMDReplicationStateProviderService/isReplicationSucess:
post:
tags:
- "SmartPOSMDReplicationStateProviderService"
summary: "Checks if replication finished with success."
description: "Checks if replication finished with success."
operationId: "SmartPOSMDReplicationStateProviderService.isReplicationSucess"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
type: "boolean"
/com.gk_software.pos.api.service.smartpos.SmartPOSService/checkAvailabilityAndCleanup:
post:
tags:
- "SmartPOSService"
summary: "This service is used for checking the availability of this service\
\ instance (ping) and performing"
description: "This service is used for checking the availability of this service\
\ instance (ping) and performing
a cleanup if necessary.
The cleanup\
\ consists of updating offline keys if a main transaction is active as well\
\ as creating
a new {@link TransactionExtension} containing the timestamp\
\ of the service switch (OFFLINE if
this is a slave service instance\
\ or ONLINE if this is the master service instance), and removal of
invalid\
\ session if it exists. If an invalid session with an unfinished transaction\
\ exists, the transaction is
also deleted from database. Finally the last\
\ finalized transactions present in the request are stored
in this service\
\ instance in order to guarantee updated sequence numbers and last transaction\
\ status."
operationId: "SmartPOSService.checkAvailabilityAndCleanup"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The request object contains the last finalized transactions\
\ to be stored in this service instance
in order to avoid gaps and duplicates\
\ of sequence numbers, in addition to client current information in order
to\
\ remove invalid sessions."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.smartpos.CheckAvailabilityAndCleanupRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "if any unexpected error occurs during the process."
/com.gk_software.pos.api.service.smartpos.SmartPOSService/takeOverSession:
post:
tags:
- "SmartPOSService"
summary: "This service is used for transferring the current client session after\
\ communication with active service instance fails"
description: "This service is used for transferring the current client session\
\ after communication with active service instance fails
and client connects\
\ to a new smart pos service instance.
The session is transfered\
\ as follows:
"
operationId: "SmartPOSService.takeOverSession"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The take over request contains all information necessary to\
\ update the transaction database
but it is still not finalized in this\
\ service instance.
This indicates that the transaction in current service\
\ instance
database is not up to date and then the transaction is stored\
\ in
this instance with complete information persisted at client.
The\
\ last finalized retail transaction must always be compared with the last\
\
finalized transaction in order to make sure the last finalized retail\
\ transaction
is also persisted in case the POS is abruptly stopped and\
\ the service switch
occurs during POS startup, and the last finalized\
\ transaction in this case
would be control transactions created by terminal,\
\ but we also need to store
the last finalized retail transaction properly\
\ in order to avoid an outdated unfinished
retail transaction to be recovered\
\ at the POS or avoid duplicated sequence numbers,
if it has already\
\ been finalized before in a different service instance.
the\
\ new service instance. If a valid session already exists, it is reused, and\
\ its date is updated
with current values from request (active and scoped\
\ transactions, session data and language settings,
in addition to a new\
\ reference to the loyalty engine).
If an invalid session exists, it is\
\ removed and any existing active unfinished main transaction is deleted,
then\
\ a new session is created with values from request.
Finally, if no session\
\ exists, a new one is created with values from request.
and to restore the session at a new\
\ service instance."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.smartpos.TakeOverSessionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "if any unexpected error occurs during the process."
/com.gk_software.pos.api.service.stock.StockService/getStockInfo:
post:
tags:
- "StockService"
summary: "Silently retrieves item stock information from external service."
description: "Silently retrieves item stock information from external service.
The\
\ current service implementation considers only the first item and the first\
\ store provided in the correspondent lists,
and perform a query in the\
\ provided service URI. The current service implementation may return null
\
\ if an error occurs
(eg.: could not connect to service) and will not\
\ throw an exception in this case."
operationId: "StockService.getStockInfo"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "provides information for item request on external service. See\
\ {@link StockServiceRequest}."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.stock.StockServiceRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.swee.ses.api.server.cd.data_provider.dto.so.StockAmountSO"
/com.gk_software.pos.api.service.stored_value_server.StoredValueServerService/cancelGiftCertOnCurrentTransaction:
post:
tags:
- "StoredValueServerService"
summary: "Service for canceling (voiding) a gift certificate from current session\
\ transaction."
description: "Service for canceling (voiding) a gift certificate from current\
\ session transaction."
operationId: "StoredValueServerService.cancelGiftCertOnCurrentTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "A request object containing the information required for canceling\
\ a gift certificate (see {@link GiftCertificateRequest})."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.stored_value_server.GiftCertificateRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.model.dom.app.gift_certificate_service.GiftCertServiceResult"
500:
description: "An exception is throw if an error occurs during selling process\
\ (eg.: invalid gift certificate type is sent in the request)."
/com.gk_software.pos.api.service.stored_value_server.StoredValueServerService/cancelGiftCertTransaction:
post:
tags:
- "StoredValueServerService"
summary: "Service for canceling (voiding) a gift certificate."
description: "Service for canceling (voiding) a gift certificate."
operationId: "StoredValueServerService.cancelGiftCertTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "A request object containing the information required for canceling\
\ a gift certificate (see {@link CancelGiftCertTransactionRequest})."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.stored_value_server.CancelGiftCertTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.model.dom.app.gift_certificate_service.GiftCertServiceResult"
500:
description: "An exception is throw if an error occurs during selling process\
\ (eg.: invalid gift certificate type is sent in the request)."
/com.gk_software.pos.api.service.stored_value_server.StoredValueServerService/getGiftCertInfoList:
post:
tags:
- "StoredValueServerService"
summary: "Queries gift certificate information on stored value server."
description: "Queries gift certificate information on stored value server."
operationId: "StoredValueServerService.getGiftCertInfoList"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Request object containing information used for performing gift\
\ certificate query."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.stored_value_server.GiftCertificateRequest"
responses:
200:
description: "Success"
schema:
type: "array"
items:
$ref: "#/definitions/com.gk_software.pos.api.model.dom.app.gift_certificate_service.GiftCertInfo"
/com.gk_software.pos.api.service.stored_value_server.StoredValueServerService/payWithGiftCertificate:
post:
tags:
- "StoredValueServerService"
summary: "Service for payment with a gift certificate."
description: "Service for payment with a gift certificate."
operationId: "StoredValueServerService.payWithGiftCertificate"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "A request object containing the information required for paying\
\ with a gift certificate (see {@link GiftCertificateRequest})."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.stored_value_server.GiftCertificateRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.model.dom.app.gift_certificate_service.GiftCertServiceResult"
500:
description: "An exception is throw if an error occurs during selling process\
\ (eg.: invalid gift certificate type is sent in the request)."
/com.gk_software.pos.api.service.stored_value_server.StoredValueServerService/returnGiftCertificate:
post:
tags:
- "StoredValueServerService"
summary: "Service for returning a gift certificate according to request parameters."
description: "Service for returning a gift certificate according to request\
\ parameters.
This service will delegate a call to proper service in stored\
\ value server depending on the gift certificate type.
If a gift card\
\ ({@link StoredValueServer#TYPE__GIFT_CARD}) is sent in the request, a debit\
\ operation is performed for reducing the current available amount on the\
\ gift card.
Otherwise, if this is a gift certificate ({@link StoredValueServer#TYPE__GIFT_CERT})or\
\ a promotion gift certificate ({@link StoredValueServer#TYPE__GC_BON}),
a\
\ redeem request is sent to stored value server."
operationId: "StoredValueServerService.returnGiftCertificate"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "A request object containing information required for returning\
\ a gift certificate (see {@link GiftCertificateRequest})."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.stored_value_server.GiftCertificateRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.model.dom.app.gift_certificate_service.GiftCertServiceResult"
500:
description: "An exception is throw if an error occurs during selling process\
\ (eg.: invalid gift certificate type is sent in the request)."
/com.gk_software.pos.api.service.stored_value_server.StoredValueServerService/sellGiftCertificate:
post:
tags:
- "StoredValueServerService"
summary: "Sells a gift certificate according to request parameters. "
description: "Sells a gift certificate according to request parameters.
This\
\ service will delegate a call to proper service in stored value server depending\
\ on the gift certificate type.
If a gift card ({@link StoredValueServer#TYPE__GIFT_CARD})\
\ is sent in the request, a top up operation is performed.
Else, if this\
\ is a gift certificate ({@link StoredValueServer#TYPE__GIFT_CERT}), a sell\
\ operation is called.
Finally, this is a promotion gift certificate ({@link\
\ StoredValueServer#TYPE__GC_BON}), a request for creation of gift certificate\
\ is sent to stored value server."
operationId: "StoredValueServerService.sellGiftCertificate"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "giftCertificateRequest"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.stored_value_server.GiftCertificateRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.model.dom.app.gift_certificate_service.GiftCertServiceResult"
500:
description: "An exception is throw if an error occurs during selling process\
\ (eg.: invalid gift certificate type is sent in the request)."
/com.gk_software.pos.api.service.subtotal.SubtotalService/processSubtotal:
post:
tags:
- "SubtotalService"
summary: "Process sub-total. During subtotal processing, taxes, promotions and\
\ transaction totals are calculated."
description: "Process sub-total. During subtotal processing, taxes, promotions\
\ and transaction totals are calculated."
operationId: "SubtotalService.processSubtotal"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "containing configuration for handling line item positions."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "An exception is thrown if an unexpected error occurs (eg.:\
\ no valid tax authority rule for tax group ID exists)"
deprecated: true
/com.gk_software.pos.api.service.subtotal.SubtotalService/processSubtotalCalculation:
post:
tags:
- "SubtotalService"
summary: "Process sub-total. During subtotal processing, taxes, promotions and\
\ transaction totals are calculated."
description: "Process sub-total. During subtotal processing, taxes, promotions\
\ and transaction totals are calculated."
operationId: "SubtotalService.processSubtotalCalculation"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "containing configuration for handling line item positions."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SubtotalOperationResult"
500:
description: "An exception is thrown if an unexpected error occurs (eg.:\
\ no valid tax authority rule for tax group ID exists)"
/com.gk_software.pos.api.service.system.SystemService/applicationInfo:
get:
tags:
- "SystemService"
summary: "Get information about service application (version, revision, build\
\ number, jdk version and build date)."
description: "Get information about service application (version, revision,\
\ build number, jdk version and build date)."
operationId: "SystemService.getApplicationInfo"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.system.ApplicationInfo"
500:
description: "thrown if an unexpected error occurs (current implementation\
\ should never throw it)."
/com.gk_software.pos.api.service.system.SystemService/clearAllCaches:
get:
tags:
- "SystemService"
summary: "Clears all caches that may exist in service cache manager."
description: "Clears all caches that may exist in service cache manager."
operationId: "SystemService.clearAllCaches"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
default:
description: "successful operation"
/com.gk_software.pos.api.service.system.SystemService/commandProcessed:
post:
tags:
- "SystemService"
summary: "Deletes a command for given key from server. Involves remote call\
\ to the server."
description: "Deletes a command for given key from server. Involves remote call\
\ to the server.
This method should be used for confirming an execution\
\ of a command at client requested by server."
operationId: "SystemService.commandProcessed"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "{@link WorkstationCommand#Key} of command to be deleted from\
\ server."
required: true
schema:
$ref: "#/definitions/com.gk_software.gkr.api.login_manager.dto.WorkstationCommand.Key"
responses:
200:
description: "Success"
500:
description: "if an error occurs during attempt to delete command from server\
\ (eg.: server is offline)."
/com.gk_software.pos.api.service.system.SystemService/ping:
post:
tags:
- "SystemService"
summary: "This service sends workstation status to POS-Server and retrieves\
\ any pending command for client execution."
description: "This service sends workstation status to POS-Server and retrieves\
\ any pending command for client execution."
operationId: "SystemService.ping"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link PingRequest} request object containing information\
\ from workstation."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.system.PingRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.system.PingResponse"
500:
description: "if an error occurs during attempt to delete command from server\
\ (eg.: server is offline or business unit id is not found)."
/com.gk_software.pos.api.service.system.SystemService/prdApplicationInfo:
get:
tags:
- "SystemService"
summary: "Get information about product service application (version, revision,\
\ build number, jdk version and build date)."
description: "Get information about service application (version, revision,\
\ build number, jdk version and build date)."
operationId: "SystemService.getPrdApplicationInfo"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.system.ApplicationInfo"
500:
description: "thrown if an unexpected error occurs (current implementation\
\ should never throw it)."
/com.gk_software.pos.api.service.system.SystemService/prjApplicationInfo:
get:
tags:
- "SystemService"
summary: "Get information about project service application (version, revision,\
\ build number, jdk version and build date)."
description: "Get information about project service application (version, revision,\
\ build number, jdk version and build date)."
operationId: "SystemService.getPrjApplicationInfo"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.system.ApplicationInfo"
500:
description: "thrown if an unexpected error occurs (current implementation\
\ should never throw it)."
/com.gk_software.pos.api.service.system.SystemService/simplePing:
post:
tags:
- "SystemService"
summary: "This service performs no action and can be used to simply check availability\
\ of services for heartbeat verification."
description: "This service performs no action and can be used to simply check\
\ availability of services for heartbeat verification."
operationId: "SystemService.simplePing"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
default:
description: "successful operation"
/com.gk_software.pos.api.service.system.SystemService/whoami:
get:
tags:
- "SystemService"
summary: "Returns who is currently authenticated."
description: "Returns who is currently authenticated.
This is just for OAuth2\
\ implementation verification.
TODO Should be eventually removed or replaced\
\ by something useful."
operationId: "SystemService.whoami"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
type: "string"
/com.gk_software.pos.api.service.tableau.DynamicTableauDataService/FindDynamicTableauItemListUpdateViewsByCriteria:
post:
tags:
- "DynamicTableauService"
summary: "Find dynamic tableau item list update views by criteria."
description: "Find dynamic tableau item list update views by criteria."
operationId: "DynamicTableauService.FindDynamicTableauItemListUpdateViewsByCriteria"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The FindDynamicTableauItemListUpdateViewsRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.tableau.FindDynamicTableauItemListUpdateViewsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.tableau.FindDynamicTableauItemListUpdateViewsResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.tableau.DynamicTableauDataService/FindDynamicTableauItemListViewsByCriteria:
post:
tags:
- "DynamicTableauService"
summary: "Find dynamic tableau item list views by criteria."
description: "Find dynamic tableau item list views by criteria."
operationId: "DynamicTableauService.FindDynamicTableauItemListViewsByCriteria"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The FindDynamicTableauItemListViewsRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.tableau.FindDynamicTableauItemListViewsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.tableau.FindDynamicTableauItemListViewsResponse"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.taxengine.TaxEngineService/calculateTax:
post:
tags:
- "TaxEngineService"
summary: "Calculates the taxes in the transaction, and applies the results to\
\ it. Also calculates retail transaction totals. Incoming transaction is expected\
\ to be populated with necessary fields for tax calculation, no backfilling\
\ of missing fields is performed."
description: "Calculates the taxes in the transaction, and applies the results\
\ to it. Also calculates retail transaction totals. Incoming transaction is\
\ expected to be populated with necessary fields for tax calculation, no backfilling\
\ of missing fields is performed."
operationId: "TaxEngineService.calculateTax"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The Transaction to process."
required: true
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.till.TillService/getAvailableTills:
post:
tags:
- "TillService"
summary: "Retrieves one till assigned to given business unit id and workstation\
\ id. If no till is found,"
description: "Retrieves one till assigned to given business unit id and workstation\
\ id. If no till is found,
another attempt is performed by searching tills\
\ assigned to given operator id and business unit id."
operationId: "TillService.getAvailableTills"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Request for retrieving available tills. See {@link TillRequest}."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.till.TillRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.till.TillResponse"
500:
description: "if some error occurs during the search process, for example,\
\ if given business unit id is not found."
/com.gk_software.pos.api.service.till.TillService/getTillDOsByIds:
post:
tags:
- "TillService"
summary: "Gets the tillDOs for given TillIds."
description: "Gets the tillDOs for given TillIds."
operationId: "TillService.getTillDOsByIds"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "tillRequest"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.till.TillRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.till.TillResponse"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.till.TillService/getTillTenderSummary:
post:
tags:
- "TillService"
summary: "Gets the till tender summary for given parameters"
description: "Gets the till tender summary for given parameters"
operationId: "TillService.getTillTenderSummary"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.till.TillTenderSummaryRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.till.TillTenderSummaryResponse"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.till.TillService/isOperatorTillCompatible:
post:
tags:
- "TillService"
summary: "Checks whether at least one of the tills provided in the request has\
\ a valid assignment"
description: "Checks whether at least one of the tills provided in the request\
\ has a valid assignment
either to the given workstation id and business\
\ unit id or to the given operator id and business unit id."
operationId: "TillService.isOperatorTillCompatible"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link TillRequest} containing a collection of tills to\
\ be verified for given business unit id, workstation id and operator id."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.till.TillRequest"
responses:
200:
description: "Success"
schema:
type: "boolean"
500:
description: "if an unexpected error occurs during the verification."
/com.gk_software.pos.api.service.transaction.LineItemService/activateTaxExempt:
post:
tags:
- "LineItemService"
summary: "Activates tax exempt for line item"
description: "Activates tax exempt for line item"
operationId: "LineItemService.activateTaxExempt"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ActivateTaxExemptRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.ActivateTaxExemptRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.transaction.LineItemService/addOrderInformationToItem:
post:
tags:
- "LineItemService"
summary: "Retrieves the last registered item and adds information about the\
\ active order to it."
description: "Retrieves the last registered item and adds information about\
\ the active order to it."
operationId: "LineItemService.addOrderInformationToItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SalesOrderPosition"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case that setting of price fails for any reason."
/com.gk_software.pos.api.service.transaction.LineItemService/addRetailTransactionLineItemComment:
post:
tags:
- "LineItemService"
summary: "Adds comment to line item."
description: "Adds comment to line item."
operationId: "LineItemService.addRetailTransactionLineItemComment"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.transaction.LineItemService/cancelGiftCertLineItem:
post:
tags:
- "LineItemService"
summary: "Cancels successful booked gift certificate line items by call of stored\
\ value service."
description: "Cancels successful booked gift certificate line items by call\
\ of stored value service."
operationId: "LineItemService.cancelGiftCertLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CancelGiftCertLineItemRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.CancelGiftCertLineItemRequest"
responses:
200:
description: "Success"
schema:
type: "string"
500:
description: "In case of any error"
/com.gk_software.pos.api.service.transaction.LineItemService/checkPriceLimitExceeded:
post:
tags:
- "LineItemService"
summary: "Checks whether a price change is inside of defined limits (absolute\
\ and percental)."
description: "Checks whether a price change is inside of defined limits (absolute\
\ and percental)."
operationId: "LineItemService.checkPriceLimitExceeded"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CheckPriceLimitRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.CheckPriceLimitRequest"
responses:
200:
description: "Success"
500:
description: "PRICE_DIFFERENCE_POSITION_LIMIT_EXCEEDED in case of price\
\ position limit exceeded"
/com.gk_software.pos.api.service.transaction.LineItemService/checkQuantityInputProhibited:
post:
tags:
- "LineItemService"
summary: "Checks if quantity input is prohibited by selling rule for selected\
\ line item throws exception in case of prohibition"
description: "Checks if quantity input is prohibited by selling rule for selected\
\ line item throws exception in case of prohibition"
operationId: "LineItemService.checkQuantityInputProhibited"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CheckQuantityInputProhibitedRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.CheckQuantityInputProhibitedRequest"
responses:
200:
description: "Success"
500:
description: "with causing exception as cause."
/com.gk_software.pos.api.service.transaction.LineItemService/checkQuantityInputProhibitedByItemSellingRule:
post:
tags:
- "LineItemService"
summary: "Checks if quantity input is prohibited by selling rule for selected\
\ line item throws exception in case of prohibition."
description: "Checks if quantity input is prohibited by selling rule for selected\
\ line item throws exception in case of prohibition."
operationId: "LineItemService.checkQuantityInputProhibitedByItemSellingRule"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The line item key"
required: true
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem.Key"
responses:
200:
description: "Success"
500:
description: "with causing exception as cause."
/com.gk_software.pos.api.service.transaction.LineItemService/clearItemTraceableUnitIDs:
post:
tags:
- "LineItemService"
summary: "Clears the ItemTraceableUnitID for all items in the current transaction."
description: "Clears the ItemTraceableUnitID for all items in the current transaction."
operationId: "LineItemService.clearItemTraceableUnitIDs"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If the transaction cannot be updated"
/com.gk_software.pos.api.service.transaction.LineItemService/createAndAddCustomerAccountPaymentItem:
post:
tags:
- "LineItemService"
summary: "Creates new line item for customer account payment"
description: "Creates new line item for customer account payment"
operationId: "LineItemService.createAndAddCustomerAccountPaymentItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The RegisterCustomerAccountPaymentRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RegisterCustomerAccountPaymentRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case that request fails for any reason."
/com.gk_software.pos.api.service.transaction.LineItemService/createAndAddDownpaymentLineItem:
post:
tags:
- "LineItemService"
summary: "Creates a new line item for a down payment."
description: "Creates a new line item for a down payment."
operationId: "LineItemService.createAndAddDownpaymentLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CreateDownpaymentLineItemRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.CreateDownpaymentLineItemRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case that setting of price fails for any reason."
/com.gk_software.pos.api.service.transaction.LineItemService/createAndAddInvoicePaymentLineItem:
post:
tags:
- "LineItemService"
summary: "Creates a new line item for an invoice payment."
description: "Creates a new line item for an invoice payment."
operationId: "LineItemService.createAndAddInvoicePaymentLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CreateInvoicePaymentLineItemRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.CreateInvoicePaymentLineItemRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case that setting of price fails for any reason."
/com.gk_software.pos.api.service.transaction.LineItemService/createAndAddPayInOutLineItem:
post:
tags:
- "LineItemService"
summary: "Creates and adds a pay-in/pay-out line item to the currently active\
\ transaction. The entered reason-specific data is ..."
description: "Creates and adds a pay-in/pay-out line item to the currently active\
\ transaction. The entered reason-specific data is saved with the
line\
\ item."
operationId: "LineItemService.createAndAddPayInOutLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PayInOutLineItemRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.PayInOutLineItemRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "the transaction operation failed exception"
/com.gk_software.pos.api.service.transaction.LineItemService/createAndAddRetailTransactionLineItemAssociations:
post:
tags:
- "LineItemService"
summary: "Creates and adds retail transaction line item associations."
description: "Creates and adds retail transaction line item associations. In\
\ case of an error the whole operation is aborted/cancelled, either all associations\
\ are created or none."
operationId: "PosTransactionService.createAndAddRetailTransactionLineItemAssociations"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CreateTransactionLineItemAssociationsRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.CreateTransactionLineItemAssociationsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "In case an error occurs."
/com.gk_software.pos.api.service.transaction.LineItemService/createAndAddRetailTransactionLineItemExtension:
post:
tags:
- "LineItemService"
summary: "Add key value pair to a line item extension"
description: "Add key value pair to a line item extension"
operationId: "LineItemService.createAndAddRetailTransactionLineItemExtension"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The LineItemExtensionRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.LineItemExtensionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case an error occurs during the process."
/com.gk_software.pos.api.service.transaction.LineItemService/createAndAddRetrievedSalesOrderItems:
post:
tags:
- "LineItemService"
summary: "Creates and adds new line item(s) for retrieved sales order items."
description: "Creates and adds new line item(s) for retrieved sales order items."
operationId: "LineItemService.createAndAddRetrievedSalesOrderItems"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link RegisterRetrievedSalesOrderRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RegisterRetrievedSalesOrderRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case that setting of price fails for any reason."
/com.gk_software.pos.api.service.transaction.LineItemService/createAndAddSaleReturnLineItemExtension:
post:
tags:
- "LineItemService"
summary: "Adds extension record on specified item in transaction."
description: "Adds extension record on specified item in transaction."
operationId: "LineItemService.createAndAddSaleReturnLineItemExtension"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The LineItemExtensionRequest the request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.LineItemExtensionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "if the transaction operation failed exception"
/com.gk_software.pos.api.service.transaction.LineItemService/createAndAddSaleReturnLineItemExtensions:
post:
tags:
- "LineItemService"
summary: "Adds a list of extension records on sale return line items in transaction."
description: "Adds a list of extension records on sale return line items in\
\ transaction."
operationId: "LineItemService.createAndAddSaleReturnLineItemExtensions"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The LineItemExtensionRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.LineItemExtensionsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "if the transaction operation failed exception"
/com.gk_software.pos.api.service.transaction.LineItemService/createAndAddScaleTransactionItems:
post:
tags:
- "LineItemService"
summary: "Creates new line item(s) for scale transaction items"
description: "Creates new line item(s) for scale transaction items"
operationId: "LineItemService.createAndAddScaleTransactionItems"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The RegisterScaleTransactionRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RegisterScaleTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case that during the line item creation an error occurs"
/com.gk_software.pos.api.service.transaction.LineItemService/createAndAddWorkerDiscountLineItem:
post:
tags:
- "LineItemService"
summary: "Creates and adds a worker discount line item to the currently active\
\ transaction."
description: "Creates and adds a worker discount line item to the currently\
\ active transaction."
operationId: "LineItemService.createAndAddWorkerDiscountLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CreateWorkerDiscountLineItemRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.CreateWorkerDiscountLineItemRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "the transaction operation failed exception"
/com.gk_software.pos.api.service.transaction.LineItemService/createMerchandiseCategorySaleItem:
post:
tags:
- "LineItemService"
summary: "Creates and add a merchandise category sale line item to currently\
\ active transaction."
description: "Creates and add a merchandise category sale line item to currently\
\ active transaction."
operationId: "LineItemService.createAndAddLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CreateLineItemRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.CreateLineItemRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.transaction.LineItemService/deactivateTaxExempt:
post:
tags:
- "LineItemService"
summary: "Deactivates tax exempt for line item."
description: "Deactivates tax exempt for line item."
operationId: "LineItemService.deactivateTaxExempt"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The DeactivateTaxExemptRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.DeactivateTaxExemptRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.transaction.LineItemService/deleteRetailTransactionLineItemComment:
post:
tags:
- "LineItemService"
summary: "Deletes comment from line item."
description: "Deletes comment from line item."
operationId: "LineItemService.deleteRetailTransactionLineItemComment"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "In case that the operation fails for any reason"
/com.gk_software.pos.api.service.transaction.LineItemService/recalculateTransactionPromotions:
post:
tags:
- "LineItemService"
summary: "Recalculation to apply temp promotions."
description: "Recalculation to apply temp promotions."
operationId: "LineItemService.recalculateTransactionPromotions"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
/com.gk_software.pos.api.service.transaction.LineItemService/reduceLineItems:
post:
tags:
- "LineItemService"
summary: "Reduces the line items for given line item keys into multiple positions\
\ in the currently active transaction according to provided quantity."
description: "Reduces the line items for given line item keys into multiple\
\ positions in the currently active transaction according to provided quantity."
operationId: "LineItemService.reduceLineItems"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ReduceLineItemsRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.ReduceLineItemsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case that splitting of positions fails for any reason."
/com.gk_software.pos.api.service.transaction.LineItemService/registerExternalLineItem:
post:
tags:
- "LineItemService"
summary: "Adds a line item to the currently active transaction. If the transaction\
\ is not opened right now, a new one is create..."
description: "Adds a line item to the currently active transaction. If the transaction\
\ is not opened right now, a new one is created. The
registration of the\
\ item might fail for several reasons; e.g. the item is not valid of some\
\ data is missing. The result
contains the according information."
operationId: "LineItemService.registerExternalLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The RegistrationRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RegistrationExternalRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case that the registration fails for any reason."
/com.gk_software.pos.api.service.transaction.LineItemService/registerInternalLineItem:
post:
tags:
- "LineItemService"
summary: "Adds a internal line item to the currently active transaction. If\
\ the transaction is not opened right now, a new one ..."
description: "Adds a internal line item to the currently active transaction.\
\ If the transaction is not opened right now, a new one is created. The
registration\
\ of the item might fail for several reasons; e.g. the item is not valid of\
\ some data is missing. The result
contains the according information."
operationId: "LineItemService.registerInternalLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The RegistrationInternalRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RegistrationInternalRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case that the registration fails for any reason."
/com.gk_software.pos.api.service.transaction.LineItemService/registerLineItem:
post:
tags:
- "LineItemService"
summary: "Adds a line item to the currently active transaction. If the transaction\
\ is not opened right now, a new one is create..."
description: "Adds a line item to the currently active transaction. If the transaction\
\ is not opened right now, a new one is created. The
registration of the\
\ item might fail for several reasons; e.g. the item is not valid of some\
\ data is missing. The result
contains the according information."
operationId: "LineItemService.registerLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The RegistrationRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RegistrationRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RegistrationResult"
500:
description: "in case that the registration fails for any reason."
/com.gk_software.pos.api.service.transaction.LineItemService/registerServiceFeeLineItem:
post:
tags:
- "LineItemService"
summary: "Adds a service fee line item to the currently active transaction."
description: "Adds a service fee line item to the currently active transaction."
operationId: "LineItemService.registerServiceFeeLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The RegistrationRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RegistrationServiceFeeRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case that the registration fails for any reason."
/com.gk_software.pos.api.service.transaction.LineItemService/removeLastLineItemIfOpen:
post:
tags:
- "LineItemService"
summary: "Removes the last retail transaction line item of currently active\
\ transaction, in case that it is open."
description: "Removes the last retail transaction line item of currently active\
\ transaction, in case that it is open."
operationId: "LineItemService.removeLastLineItemIfOpen"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "if the transaction operation failed exception"
/com.gk_software.pos.api.service.transaction.LineItemService/removeLastSaleReturnLineItemIfOpen:
post:
tags:
- "LineItemService"
summary: "Removes the last sale return line item of currently active transaction,\
\ in case that it is open."
description: "Removes the last sale return line item of currently active transaction,\
\ in case that it is open."
operationId: "LineItemService.removeLastSaleReturnLineItemIfOpen"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "if the transaction operation failed exception"
/com.gk_software.pos.api.service.transaction.LineItemService/removeSaleReturnLineItemsExtensions:
post:
tags:
- "LineItemService"
summary: "Removes sale return line extensions containing given keys from given\
\ line items."
description: "Removes sale return line extensions containing given keys from\
\ given line items."
operationId: "LineItemService.removeSaleReturnLineItemsExtensions"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The RemoveLineItemsExtensionsRequest the request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RemoveLineItemsExtensionsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "if the transaction operation failed exception"
/com.gk_software.pos.api.service.transaction.LineItemService/repeatLineItem:
post:
tags:
- "LineItemService"
summary: "Repeat the specified line item."
description: "Repeat the specified line item."
operationId: "LineItemService.repeatLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The RepeatLineItemRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RepeatLineItemRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case line item repetition fails for any reason."
/com.gk_software.pos.api.service.transaction.LineItemService/requestPointsRefund:
post:
tags:
- "LineItemService"
summary: "Sends request to refund of loyalty points to respective service."
description: "Sends request to refund of loyalty points to respective service."
operationId: "LineItemService.requestPointsRefund"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link PointsRefundRequest}"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.PointsRefundRequest"
responses:
200:
description: "Success"
schema:
type: "string"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.transaction.LineItemService/rollbackQuantityAccumulation:
post:
tags:
- "LineItemService"
summary: "Rollback the quantity accumulation process."
description: "Rollback the quantity accumulation process."
operationId: "LineItemService.rollbackQuantityAccumulation"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case an error occurs during the process."
/com.gk_software.pos.api.service.transaction.LineItemService/setCustomFields:
post:
tags:
- "LineItemService"
summary: "Set line item custom field values on the given line item on the transaction\
\ which is associated with the passed sessi..."
description: "Set line item custom field values on the given line item on the\
\ transaction which is associated with the passed session. If
the close\
\ position configuration indicates that the previous position should be closed\
\ a new line item with the given value
will be created. The behavior depends\
\ on close position configuration of the passed {@link PositionOperationConfig}."
operationId: "LineItemService.setCustomFields"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The SetLineItemCustomFieldsRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SetLineItemCustomFieldsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case that setting of custom fields fails for any reason."
/com.gk_software.pos.api.service.transaction.LineItemService/setLineItemsTaxGroupId:
post:
tags:
- "LineItemService"
summary: "Validates and sets the tax group IDs to the related line items according\
\ to the request."
description: "Validates and sets the tax group IDs to the related line items\
\ according to the request.
The tax group IDs are set only if all tax\
\ group IDs in the request are successfully validated."
operationId: "LineItemService.setLineItemsTaxGroupId"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "contains the tax group ids that must be set and the keys to\
\ the line items that should be modified."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.StoreLineItemTaxGroupIdRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "An exception is thrown if an error occurs either during the\
\ tax group id validation or storage of new changes."
/com.gk_software.pos.api.service.transaction.LineItemService/setPrice:
post:
tags:
- "LineItemService"
summary: "Sets/updates the price of the last line item in the currently active\
\ transaction. If the close position configuration"
description: "Sets/updates the price of the last line item in the currently\
\ active transaction. If the close position configuration
indicates that\
\ the previous position should be closed a new line item with the given value\
\ will be created. The behavior
depends on close position configuration\
\ of the passed {@link PositionOperationConfig}."
operationId: "LineItemService.setPrice"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The RegistrationRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RegistrationRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case that setting of price fails for any reason."
/com.gk_software.pos.api.service.transaction.LineItemService/setQuantity:
post:
tags:
- "LineItemService"
summary: "Sets/updates the quantity of line item in the currently active transaction.\
\ If the close position configuration indic..."
description: "Sets/updates the quantity of line item in the currently active\
\ transaction. If the close position configuration indicates
that the\
\ previous position should be closed a new line item with the given value\
\ will be created. The behavior depends on
close position configuration\
\ of the passed {@link PositionOperationConfig}."
operationId: "LineItemService.setQuantity"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The SetQuantityRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SetQuantityRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case that setting of quantity fails for any reason."
/com.gk_software.pos.api.service.transaction.LineItemService/setRetailTransactionLineItemExtension:
post:
tags:
- "LineItemService"
summary: "Update or add key value pair to a line item extension"
description: "Update or add key value pair to a line item extension"
operationId: "LineItemService.setRetailTransactionLineItemExtension"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The LineItemExtensionRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.LineItemExtensionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case an error occurs during the process."
/com.gk_software.pos.api.service.transaction.LineItemService/setSaleReturnLineItemsExtensions:
post:
tags:
- "LineItemService"
summary: "Sets the extension records with provided keys on specified line items\
\ in transaction with given values."
description: "Sets the extension records with provided keys on specified line\
\ items in transaction with given values."
operationId: "LineItemService.setSaleReturnLineItemsExtensions"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The LineItemExtensionsRequest the request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.LineItemExtensionsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "if the transaction operation failed exception"
/com.gk_software.pos.api.service.transaction.LineItemService/setSalesPersonNumber:
post:
tags:
- "LineItemService"
summary: "Sets the sales person number. Sets/updates the workerId of the last\
\ line item in the currently active transaction."
description: "Sets the sales person number. Sets/updates the workerId of the\
\ last line item in the currently active transaction."
operationId: "LineItemService.setSalesPersonNumber"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The SalesPersonNumberRequest"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SalesPersonNumberRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.transaction.LineItemService/setSerialNumber:
post:
tags:
- "LineItemService"
summary: "Sets/updates serial number of last line item in the transaction. If\
\ the close position configuration indicates that the"
description: "Sets/updates serial number of last line item in the transaction.\
\ If the close position configuration indicates that the
previous position\
\ should be closed a new line item with the given value will be created. The\
\ behavior depends on close
position configuration of the passed {@link\
\ PositionOperationConfig}."
operationId: "LineItemService.setSerialNumber"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The SetSerialNumberRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SetSerialNumberRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case that setting of serial number fails for any reason."
/com.gk_software.pos.api.service.transaction.LineItemService/syncLineItemsItemsTraceableUnitID:
post:
tags:
- "LineItemService"
summary: "Synchronizes the traceable unit id with line items registered in the\
\ current transaction in session."
description: "Synchronizes the traceable unit id with line items registered\
\ in the current transaction in session."
operationId: "LineItemService.syncLineItemsTraceableUnitID"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "contains the tax group ids that must be set and the keys to\
\ the line items that should be modified."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SyncLineItemsTraceableUnitIDRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "An exception is thrown if an error occurs either during the\
\ void item process or transaction storage process."
/com.gk_software.pos.api.service.transaction.LineItemService/updateSaleReturnTaxLineItem:
post:
tags:
- "LineItemService"
summary: "Overrides tax for line item. Changes taxValue or taxAmount depending\
\ on which parameter is null."
description: "Overrides tax for line item. Changes taxValue or taxAmount depending\
\ on which parameter is null."
operationId: "LineItemService.updateSaleReturnTaxLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ReturnLineItemRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.ReturnLineItemRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "if the transaction operation failed exception"
/com.gk_software.pos.api.service.transaction.LineItemService/updateSalesOrderItemInformation:
post:
tags:
- "LineItemService"
summary: "retrieves the last registered item and adds information about the\
\ active order to it."
description: "retrieves the last registered item and adds information about\
\ the active order to it."
operationId: "LineItemService.updateSalesOrderItemInformation"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link UpdateSalesOrderItemRequest} object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.UpdateSalesOrderItemRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case that setting of price fails for any reason."
/com.gk_software.pos.api.service.transaction.LineItemService/updateSalesOrderSelectedDeliveryItemInformation:
post:
tags:
- "LineItemService"
summary: "Update sales order selected delivery item information."
description: "Update sales order selected delivery item information."
operationId: "LineItemService.updateSalesOrderSelectedDeliveryItemInformation"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "the UpdateSalesOrderSelectedDeliveryItemRequest"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.UpdateSalesOrderSelectedDeliveryItemRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.transaction.LineItemService/voidLineItem:
post:
tags:
- "LineItemService"
summary: "Voids the specified line item."
description: "Voids the specified line item."
operationId: "LineItemService.voidLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The VoidLineItemRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.VoidLineItemRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "if the transaction operation failed exception"
/com.gk_software.pos.api.service.transaction.LineItemService/voidLineItemBatch:
post:
tags:
- "LineItemService"
summary: "Voids a batch of line items."
description: "Voids a batch of line items."
operationId: "LineItemService.voidLineItemBatch"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The VoidLineItemBatchRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.VoidLineItemBatchRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "if the transaction operation failed exception"
/com.gk_software.pos.api.service.transaction.LineItemService/voidPointsLineItems:
post:
tags:
- "LineItemService"
summary: "Sends request to refund loyalty points and void internally refunded\
\ line items."
description: "Sends request to refund loyalty points and void internally refunded\
\ line items."
operationId: "LineItemService.voidPointsLineItems"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PointsRefundBatchRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.PointsRefundBatchRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case of any error."
/com.gk_software.pos.api.service.transaction.LineItemService/voidTenderLineItem:
post:
tags:
- "LineItemService"
summary: "Voids the specified tender line item."
description: "Voids the specified tender line item."
operationId: "LineItemService.voidTenderLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The VoidTenderLineItemRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.VoidTenderLineItemRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "if the transaction operation failed exception"
/com.gk_software.pos.api.service.transaction.PosTransactionService/activateSendByEmail:
post:
tags:
- "PosTransactionService"
summary: "Activates send receipt as email for the transaction assigned to the\
\ session."
description: "Activates send receipt as email for the transaction assigned to\
\ the session."
operationId: "PosTransactionService.activateSendByEmail"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link ReceiptAsEmailActivationRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.ReceiptAsEmailActivationRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session."
/com.gk_software.pos.api.service.transaction.PosTransactionService/activateTaxExempt:
post:
tags:
- "PosTransactionService"
summary: "Activates tax exempt for the transaction assigned to the session."
description: "Activates tax exempt for the transaction assigned to the session."
operationId: "PosTransactionService.activateTaxExempt"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link PosTransactionRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.PosTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session or if the\
\ tax exempt is already active for the transaction."
/com.gk_software.pos.api.service.transaction.PosTransactionService/addExternalTransactionAdditionalPrintout:
post:
tags:
- "PosTransactionService"
summary: "Adds additional external printouts to the transaction."
description: "Adds additional external printouts to the transaction."
operationId: "PosTransactionService.addExternalTransactionAdditionalPrintout"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link AddExternalTransactionAdditionalPrintoutRequest}\
\ object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.AddExternalTransactionAdditionalPrintoutRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "Only in case of an unexpected error."
/com.gk_software.pos.api.service.transaction.PosTransactionService/addFiscalizationDataToTransaction:
post:
tags:
- "PosTransactionService"
summary: "Adds and stores fiscalization data like receipt number given by fiscal\
\ printer and current open fiscal day number to"
description: "Adds and stores fiscalization data like receipt number given by\
\ fiscal printer and current open fiscal day number to
transaction. Will\
\ be called from client after fiscal receipt was printed on fiscal printer."
operationId: "PosTransactionService.addFiscalizationDataToTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link AddFiscalizationDataToTransactionRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.AddFiscalizationDataToTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If the transaction cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/addReturnInfoToTransaction:
post:
tags:
- "PosTransactionService"
summary: "Adds a TransactionCategory for the return info to the transaction.\
\ If there is a transaction identifier given..."
description: "Adds a TransactionCategory for the return info to the transaction.\
\ If there is a transaction identifier given, then
it is tried to load\
\ the matching transaction. If there is no matching transaction, then it is\
\ checked for a transaction
already assigned to the session. If there\
\ is also no transaction assigned to the session, then a new transaction is\
\ created."
operationId: "PosTransactionService.addReturnInfoToTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The transaction identifier."
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "Only in case of an unexpected error."
/com.gk_software.pos.api.service.transaction.PosTransactionService/addTransactionAdditionalPrintouts:
post:
tags:
- "PosTransactionService"
summary: "Adds additional printouts to the transaction."
description: "Adds additional printouts to the transaction."
operationId: "PosTransactionService.addTransactionAdditionalPrintouts"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link AddTransactionAdditionalPrintoutsRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.AddTransactionAdditionalPrintoutsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session."
/com.gk_software.pos.api.service.transaction.PosTransactionService/addTransactionExtensionToTransaction:
post:
tags:
- "PosTransactionService"
summary: "Adds a single given transaction extension to the transaction. If there\
\ is no transaction assigned to the session, the..."
description: "Adds a single given transaction extension to the transaction.\
\ If there is no transaction assigned to the session, then a new
transaction\
\ is created."
operationId: "PosTransactionService.addTransactionExtensionToTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The AddTransactionExtensionRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.AddTransactionExtensionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "Only in case of an unexpected error."
/com.gk_software.pos.api.service.transaction.PosTransactionService/addTransactionExtensionsToTransaction:
post:
tags:
- "PosTransactionService"
summary: "Adds the given transaction extensions to the transaction. The transaction\
\ assigned to the session is used as long as ..."
description: "Adds the given transaction extensions to the transaction. The\
\ transaction assigned to the session is used as long as there is
not\
\ transaction identifier set in the request. If there is a transaction identifier\
\ set, then it is tried to load the
matching transaction."
operationId: "PosTransactionService.addTransactionExtensionsToTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The AddTransactionExtensionsRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.AddTransactionExtensionsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If the transaction cannot be found, when a transaction identifier\
\ was given or if the transaction cannot be stored."
/com.gk_software.pos.api.service.transaction.PosTransactionService/calculateReturnUnitPrices:
post:
tags:
- "PosTransactionService"
summary: "Calculates the return unit prices for line items of the transaction\
\ assigned to the session."
description: "Calculates the return unit prices for line items of the transaction\
\ assigned to the session."
operationId: "PosTransactionService.calculateReturnUnitPrices"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link CalculateReturnUnitPricesRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.CalculateReturnUnitPricesRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session."
/com.gk_software.pos.api.service.transaction.PosTransactionService/cancelAllExternalLineItemsOnVoidingTransaction:
post:
tags:
- "PosTransactionService"
summary: "Cancels all external line items on current voiding transaction (assigned\
\ to the session) in the following order:"
description: "Cancels all external line items on current voiding transaction\
\ (assigned to the session) in the following order:
not, an according exception is thrown."
operationId: "PosTransactionService.checkItemAvailable"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The RetailTransactionLineItem containing the item to be checked."
required: true
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem"
responses:
200:
description: "Success"
500:
description: "If no matching item was found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/checkReturnableLineItemsAvailable:
post:
tags:
- "PosTransactionService"
summary: "Checks whether the returnable line items of the transaction for the\
\ given identifier are available in the master data..."
description: "Checks whether the returnable line items of the transaction for\
\ the given identifier are available in the master data. If
not, an according\
\ exception is raised."
operationId: "PosTransactionService.checkReturnableItemsAvailable"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The transaction identifier of the transaction to check."
required: true
schema:
type: "string"
responses:
200:
description: "Success"
500:
description: "If one or more items are not available or no transaction was\
\ found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/checkTransactionVoidable:
post:
tags:
- "PosTransactionService"
summary: "Checks, whether the given transaction is voidable. If not, an according\
\ exception is thrown."
description: "Checks, whether the given transaction is voidable. If not, an\
\ according exception is thrown."
operationId: "PosTransactionService.checkTransactionVoidable"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link CheckTransactionVoidableRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.CheckTransactionVoidableRequest"
responses:
200:
description: "Success"
500:
description: "with according error code in case transaction is not cancellable."
/com.gk_software.pos.api.service.transaction.PosTransactionService/checkUnexportedTransactions:
post:
tags:
- "PosTransactionService"
summary: "Checks whether all transactions are already processed by transaction\
\ pool."
description: "Checks whether all transactions are already processed by transaction\
\ pool."
operationId: "PosTransactionService.checkUnexportedTransactions"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The retail store identifier, which is used to determine business\
\ unit group identifier for the search.
Can be left null
\
\ to search for all stores."
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
type: "boolean"
500:
description: "If the business unit for the given identifier cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/closeLastLineItem:
post:
tags:
- "PosTransactionService"
summary: "Closes the last position of the transaction, if there is one open\
\ position."
description: "Closes the last position of the transaction, if there is one open\
\ position."
operationId: "PosTransactionService.closeLastLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link PositionOperationConfig} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction or the last position cannot be\
\ closed."
/com.gk_software.pos.api.service.transaction.PosTransactionService/convertScaleSuspendCodes:
post:
tags:
- "PosTransactionService"
summary: "Converts suspend code to ConvertedSuspendCodesResponse object."
description: "Converts scale suspend code to ConvertedSuspendCodesResponse object."
operationId: "PosTransactionService.convertScaleSuspendCodes"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ConvertSuspendCodesRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.ConvertSuspendCodesRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.ConvertSuspendCodesResponse"
500:
description: "In case an error occurs."
/com.gk_software.pos.api.service.transaction.PosTransactionService/convertSuspendCodes:
post:
tags:
- "PosTransactionService"
summary: "Converts suspend code to ConvertedSuspendCodesResponse object."
description: "Converts suspend code to ConvertedSuspendCodesResponse object."
operationId: "PosTransactionService.convertSuspendCodes"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ConvertSuspendCodesRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.ConvertSuspendCodesRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.ConvertSuspendCodesResponse"
500:
description: "In case an error occurs."
/com.gk_software.pos.api.service.transaction.PosTransactionService/countSuspendedTransactions:
post:
tags:
- "PosTransactionService"
summary: "Searches and counts suspended transactions that matches the given\
\ criteria."
description: "Searches and counts suspended transactions that matches the given\
\ criteria."
operationId: "PosTransactionService.countSuspendedTransactions"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link SearchSuspendedTransactionsRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SearchSuspendedTransactionsRequest"
responses:
200:
description: "Success"
schema:
type: "integer"
format: "int32"
500:
description: "In case of an unexpected exception (if no transaction is found,\
\ no exception is thrown, but the return value is 0)"
/com.gk_software.pos.api.service.transaction.PosTransactionService/createAndAddRetailTransactionCouponSummary:
post:
tags:
- "PosTransactionService"
summary: "Creates and adds a {@link RetailTransactionCouponSummary} based on\
\ the given information to the transaction. If there..."
description: "Creates and adds a {@link RetailTransactionCouponSummary} based\
\ on the given information to the transaction. If there is no
transaction\
\ assigned to the session a new transaction will be created."
operationId: "PosTransactionService.createAndAddRetailTransactionCouponSummary"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link EnterCouponRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.EnterCouponRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If the request contains a privilege type that is unknown."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createAndAddTransactionBinaryData:
post:
tags:
- "PosTransactionService"
summary: "Creates and adds transaction binary data to the transaction assigned\
\ to the session or if a transaction identifier wa..."
description: "Creates and adds transaction binary data to the transaction assigned\
\ to the session or if a transaction identifier was given
to the matching\
\ loaded transaction."
operationId: "PosTransactionService.createAndAddTransactionBinaryData"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link TransactionBinaryDataRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionBinaryDataRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
/com.gk_software.pos.api.service.transaction.PosTransactionService/createAndAddTransactionBinaryDataWithExtension:
post:
tags:
- "PosTransactionService"
summary: "Creates and adds transaction binary data to the transaction assigned\
\ to the session or if a transaction identifier wa..."
description: "Creates and adds transaction binary data to the transaction assigned\
\ to the session or if a transaction identifier was given
to the matching\
\ loaded transaction."
operationId: "PosTransactionService.createAndAddTransactionBinaryDataWithExtension"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link TransactionBinaryDataWithExtensionRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionBinaryDataWithExtensionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session or if the\
\ transaction cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createCancelDrawerAccountsTransaction:
post:
tags:
- "PosTransactionService"
summary: "Creates the transaction for drawer accounts cancellation."
description: "Creates the transaction for drawer accounts cancellation."
operationId: "PosTransactionService.createCancelDrawerAccountsTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CreateDrawerAccountsRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.CreateDrawerAccountsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "In case an error occurs."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createCashRecyclerCashExchangeTransaction:
post:
tags:
- "PosTransactionService"
summary: "Create an Cash Recycler Cash Exchange Transaction"
description: "Create an Cash Recycler Cash Exchange Transaction"
operationId: "PosTransactionService.createCashRecyclerCashExchangeTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The POS transaction request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.PosTransactionCRSCashExchangeRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "In case an error occurs."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createCashRecyclerVerificationTransaction:
post:
tags:
- "PosTransactionService"
summary: "Create an CashRecycler Verification Transaction"
description: "Create an CashRecycler Verification Transaction"
operationId: "PosTransactionService.createCashRecyclerVerificationTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.PosTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "In case an error occurs."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createDrawerAccountsTransactions:
post:
tags:
- "PosTransactionService"
summary: "Creates the transactions for drawer accounts."
description: "Creates the transactions for drawer accounts."
operationId: "PosTransactionService.createDrawerAccountsTransactions"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CreateDrawerAccountsRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.CreateDrawerAccountsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "In case an error occurs."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createFailFiscalTransaction:
post:
tags:
- "PosTransactionService"
summary: "Creates a fail fiscal transaction for given request."
description: "Creates a fail fiscal transaction for given request."
operationId: "PosTransactionService.createFailFiscalTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link CreateFailFiscalTransactionRequest} request."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.CreateFailFiscalTransactionRequest"
responses:
200:
description: "Success"
500:
description: "If there is a session and the given transaction identifier\
\ does not match with the transaction assigned to the session. If there\
\ is no session and there is no business unit found for the given identifier."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createFiscalControlTransaction:
post:
tags:
- "PosTransactionService"
summary: "Creates a fiscal control transaction."
description: "Creates a fiscal control transaction."
operationId: "PosTransactionService.createFiscalControlTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "Only in case of an unexpected error."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createFiscalStartTransaction:
post:
tags:
- "PosTransactionService"
summary: "Creates a fiscal start control transaction."
description: "Creates a fiscal start control transaction."
operationId: "PosTransactionService.createFiscalStartTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "Only in case of an unexpected error."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createInvoiceNumber:
post:
tags:
- "PosTransactionService"
summary: "Creates the invoice number and sets it to the transaction assigned\
\ to the session or if a transaction identifier was ..."
description: "Creates the invoice number and sets it to the transaction assigned\
\ to the session or if a transaction identifier was given to
the matching\
\ loaded transaction."
operationId: "PosTransactionService.createInvoiceNumber"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link InvoiceNumberRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.InvoiceNumberRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session or if the\
\ transaction cannot be found or stored."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createItemInfoTransaction:
post:
tags:
- "PosTransactionService"
summary: "Creates item information transaction and stores it."
description: "Creates item information transaction and stores it. Creates {@link\
\ com.gk_software.gkr.api.txpool.dto.Transaction}, {@link com.gk_software.gkr.api.txpool.dto.RetailTransaction}\
\ with RetailTransactionTypeCode=II, {@link com.gk_software.gkr.api.txpool.dto.SaleReturnLineItem}\
\ with itemType=II. {@link com.gk_software.gkr.api.txpool.dto.SaleReturnLineItem}\
\ is created from {@link com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemDO}."
operationId: "PosTransactionService.createItemInfoTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
/com.gk_software.pos.api.service.transaction.PosTransactionService/createOpenDrawerTransaction:
post:
tags:
- "PosTransactionService"
summary: "Creates an open till/drawer control transaction."
description: "Creates an open till/drawer control transaction."
operationId: "PosTransactionService.createOpenDrawerTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PosTransactionRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.PosTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If the operator for the given identifier was not found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createPrintTransaction:
post:
tags:
- "PosTransactionService"
summary: "Creates the print transaction for an existing transaction."
description: "Creates the print transaction for an existing transaction."
operationId: "PosTransactionService.createPrintTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link TransactionPrintRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionPrintRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "If the transaction cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createSuspendCodes:
post:
tags:
- "PosTransactionService"
summary: "Creates suspend code from transaction. This codes will be added to\
\ binary data."
description: " Creates suspend code from transaction. This codes will be added\
\ to binary data."
operationId: "PosTransactionService.createSuspendCodes"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.CreateSuspendCodeRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "In case an error occurs."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createTenderAmountAdjustmentTransaction:
post:
tags:
- "PosTransactionService"
summary: "Creates the tender amount adjustment transaction."
description: "Creates the tender amount adjustment transaction."
operationId: "PosTransactionService.createTenderAmountAdjustmentTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link TransactionTenderRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionTenderRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "Only in case of an unexpected error."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createTenderLoanTransaction:
post:
tags:
- "PosTransactionService"
summary: "Creates the tender loan transaction."
description: "Creates the tender loan transaction."
operationId: "PosTransactionService.createTenderLoanTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link TransactionTenderRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionTenderRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "Only in case of an unexpected error."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createTenderPickupTransaction:
post:
tags:
- "PosTransactionService"
summary: "Creates the tender pickup transaction."
description: "Creates the tender pickup transaction."
operationId: "PosTransactionService.createTenderPickupTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link TransactionTenderRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionTenderRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "Only in case of an unexpected error."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createTerminalDiagnosticTransaction:
post:
tags:
- "PosTransactionService"
summary: "Creates the terminal diagnostic transaction."
description: "Creates the terminal diagnostic transaction."
operationId: "PosTransactionService.createTerminalDiagnosticTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link PosTransactionRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.PosTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "If the business unit for the given identifier cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createTerminalEodTransaction:
post:
tags:
- "PosTransactionService"
summary: "Create terminal end of day control transaction."
description: "Create terminal end of day control transaction."
operationId: "PosTransactionService.createTerminalEodTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link PosTransactionRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.PosTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "If the business unit for the given identifier cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createTerminalLoginTransaction:
post:
tags:
- "PosTransactionService"
summary: "Create terminal login control transaction."
description: "Create terminal login control transaction."
operationId: "PosTransactionService.createTerminalLoginTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link PosTransactionRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.PosTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "If the business unit for the given identifier cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createTerminalReprintTransaction:
post:
tags:
- "PosTransactionService"
summary: "Creates the terminal reprint transaction."
description: "Creates the terminal reprint transaction."
operationId: "PosTransactionService.createTerminalReprintTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link PosTransactionRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.PosTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "If the business unit for the given identifier cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createTillTenderSettlementTransaction:
post:
tags:
- "PosTransactionService"
summary: "Creates till tender settlement transaction."
description: "Creates till tender settlement transaction."
operationId: "PosTransactionService.createTillTenderSettlementTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link TransactionTenderRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionTenderRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "Only in case of an unexpected error."
/com.gk_software.pos.api.service.transaction.PosTransactionService/createVoidTransaction:
post:
tags:
- "PosTransactionService"
summary: "Creates a new void transaction for given request."
description: "Creates a new void transaction for given request."
operationId: "PosTransactionService.createVoidTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CreateVoidTransactionRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.CreateVoidTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction for the given transaction identifier\
\ or if the transaction is not voidable."
/com.gk_software.pos.api.service.transaction.PosTransactionService/deactivateSendByEmail:
post:
tags:
- "PosTransactionService"
summary: "Deactivates send receipt as email for the transaction assigned to\
\ the session."
description: "Deactivates send receipt as email for the transaction assigned\
\ to the session."
operationId: "PosTransactionService.deactivateSendByEmail"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link ReceiptAsEmailActivationRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.ReceiptAsEmailActivationRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session."
/com.gk_software.pos.api.service.transaction.PosTransactionService/deactivateTaxExempt:
post:
tags:
- "PosTransactionService"
summary: "Deactivates tax exempt for the transaction assigned to the session."
description: "Deactivates tax exempt for the transaction assigned to the session."
operationId: "PosTransactionService.deactivateTaxExempt"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session or if the\
\ tax exempt was not activated before."
/com.gk_software.pos.api.service.transaction.PosTransactionService/deleteScopedTransaction:
post:
tags:
- "PosTransactionService"
summary: "Delete the scoped transaction from the session."
description: "Delete the scoped transaction from the session."
operationId: "PosTransactionService.deleteScopedTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The scope"
required: true
schema:
type: "string"
responses:
200:
description: "Success"
500:
description: "If there is no current transaction."
/com.gk_software.pos.api.service.transaction.PosTransactionService/deleteTransaction:
post:
tags:
- "PosTransactionService"
summary: "Delete the transaction from the session and database. If the transaction\
\ is a fiscal transaction it will only be remo..."
description: "Delete the transaction from the session and database. If the transaction\
\ is a fiscal transaction it will only be removed from
session, but not\
\ deleted in database (the deletion is then silently skipped)."
operationId: "PosTransactionService.deleteTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
500:
description: "TRANSACTION_NOT_FOUND - If no transaction is assigned to session
TRANSACTION_COULD_NOT_BE_DELETED\
\ - If transaction could not be deleted"
/com.gk_software.pos.api.service.transaction.PosTransactionService/fillTransactionFinalData:
post:
tags:
- "PosTransactionService"
summary: "Fill final data by the promotion service to the transaction."
description: "Fill final data by the promotion service to the transaction."
operationId: "PosTransactionService.fillTransactionFinalData"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session."
/com.gk_software.pos.api.service.transaction.PosTransactionService/finalizeControlTransaction:
post:
tags:
- "PosTransactionService"
summary: "Finalize a control transaction."
description: "Finalize a control transaction."
operationId: "PosTransactionService.finalizeControlTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The transaction identifier."
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "In case an error occurs"
/com.gk_software.pos.api.service.transaction.PosTransactionService/finalizeTransaction:
post:
tags:
- "PosTransactionService"
summary: "Finalize the transaction. If the request does not contain a transaction\
\ identifier, then the transaction assigned to the"
description: "Finalize the transaction. If the request does not contain a transaction\
\ identifier, then the transaction assigned to the
session is used."
operationId: "PosTransactionService.finalizeTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The FinalizeTransactionRequest"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.FinalizeTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "In case an error occurs."
/com.gk_software.pos.api.service.transaction.PosTransactionService/finishLocalAccountingTransactions:
post:
tags:
- "PosTransactionService"
summary: "Finish local accounting transactions."
description: "Finish local accounting transactions."
operationId: "PosTransactionService.finishLocalAccountingTransactions"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
type: "array"
items:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "In case an error occurs"
/com.gk_software.pos.api.service.transaction.PosTransactionService/finishUnfinishedTransactions:
post:
tags:
- "PosTransactionService"
summary: "Finish for the unfinished transactions that matches the given criteria.\
\ The matching transactions will be deleted and..."
description: "Finish for the unfinished transactions that matches the given\
\ criteria. The matching transactions will be deleted and a fail
control\
\ transaction will be created for the original transaction."
operationId: "PosTransactionService.finishUnfinishedTransactions"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "unfinishedTransactionsRequest"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.UnfinishedTransactionsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionIdsResult"
500:
description: "If transactions cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/getCurrentChange:
post:
tags:
- "PosTransactionService"
summary: "Find current change by LOAN transactions in local DB."
description: "Find current change by LOAN transactions in local DB."
operationId: "PosTransactionService.getCurrentChange"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
type: "number"
format: "double"
/com.gk_software.pos.api.service.transaction.PosTransactionService/getCustomerInfoTransactionDataViewsByIds:
post:
tags:
- "PosTransactionService"
summary: "Get {@link CustomerInfoTransactionData} objects for the given list\
\ of transaction identifiers."
description: "Get {@link CustomerInfoTransactionData} objects for the given\
\ list of transaction identifiers."
operationId: "PosTransactionService.getCustomerInfoTransactionDataViewsByIds"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link TransactionIdsRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionIdsRequest"
responses:
200:
description: "Success"
schema:
type: "array"
items:
$ref: "#/definitions/com.gk_software.pos.api.model.dom.app.views.CustomerInfoTransactionData"
500:
description: "If a transaction cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/getNewPKORKODocumentNumber:
post:
tags:
- "PosTransactionService"
summary: "Retrieves a new document number for PKO/RKO reports."
description: "Retrieves a new document number for PKO/RKO reports."
operationId: "PosTransactionService.getNewPKORKODocumentNumber"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link PKORKONumberRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.PKORKONumberRequest"
responses:
200:
description: "Success"
schema:
type: "string"
500:
description: "If no transaction was found for the given identifier."
/com.gk_software.pos.api.service.transaction.PosTransactionService/getNewSessionTransactionInvoiceNumber:
post:
tags:
- "PosTransactionService"
operationId: "getNewSessionTransactionInvoiceNumber"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
type: "string"
deprecated: true
/com.gk_software.pos.api.service.transaction.PosTransactionService/getOrCreateEndDateTimestampExtension:
post:
tags:
- "PosTransactionService"
summary: "Gets or creates a new TransactionExtension for temporary end date\
\ timestamp."
description: "Gets or creates a new TransactionExtension for temporary end date\
\ timestamp."
operationId: "PosTransactionService.getOrCreateEndDateTimestampExtension"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.GetOrCreateEndDateTimestampExtensionResult"
500:
description: "Only in case of an unexpected error."
/com.gk_software.pos.api.service.transaction.PosTransactionService/getOrCreateEndDateTimestampExtensionFromRequest:
post:
tags:
- "PosTransactionService"
summary: "Gets or creates a new TransactionExtension for temporary end date\
\ timestamp."
description: "Gets or creates a new TransactionExtension for temporary end date\
\ timestamp."
operationId: "PosTransactionService.getOrCreateEndDateTimestampExtensionFromRequest"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link GetEndDateTimestampExtensionRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.GetEndDateTimestampExtensionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.GetOrCreateEndDateTimestampExtensionResult"
500:
description: "If there is no transaction for the given transaction identifier."
/com.gk_software.pos.api.service.transaction.PosTransactionService/getOrCreateEndDateTimestampLoginLogoutRequestExtension:
post:
tags:
- "PosTransactionService"
summary: "Gets or creates a new TransactionExtension for temporary end date\
\ timestamp."
description: "Gets or creates a new TransactionExtension for temporary end date\
\ timestamp."
operationId: "PosTransactionService.getOrCreateEndDateTimestampLoginLogoutRequestExtension"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link GetEndDateTimestampExtensionRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.GetEndDateTimestampExtensionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.GetOrCreateEndDateTimestampExtensionResult"
500:
description: "If there is no transaction for the given transaction identifier."
/com.gk_software.pos.api.service.transaction.PosTransactionService/getOrCreateScopedCopyTransaction:
post:
tags:
- "PosTransactionService"
summary: "Gets or creates a scoped {@link PosTransaction}. The created scoped\
\ {@link PosTransaction} will include a copy of the"
description: "Gets or creates a scoped {@link PosTransaction}. The created scoped\
\ {@link PosTransaction} will include a copy of the
transaction associated\
\ to the session, if there exists a transaction associated to the session."
operationId: "PosTransactionService.getOrCreateScopedCopyTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The scope"
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/PosTransaction"
500:
description: "If the creation of new scoped transaction is not possible."
/com.gk_software.pos.api.service.transaction.PosTransactionService/getOrCreateScopedTransaction:
post:
tags:
- "PosTransactionService"
summary: "Gets or creates a scoped {@link PosTransaction}."
description: "Gets or creates a scoped {@link PosTransaction}."
operationId: "PosTransactionService.getOrCreateScopedTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The scope"
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/PosTransaction"
500:
description: "If the creation of new scoped transaction is not possible."
/com.gk_software.pos.api.service.transaction.PosTransactionService/getOrCreateTransaction:
post:
tags:
- "PosTransactionService"
summary: "Gets the current {@link PosTransaction} associated with the session.\
\ If there is no transaction associated to current"
description: "Gets the current {@link PosTransaction} associated with the session.\
\ If there is no transaction associated to current
session, then a new\
\ {@link PosTransaction} will be created and associated to the session."
operationId: "PosTransactionService.getOrCreateTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/PosTransaction"
500:
description: "If the creation of new transaction is not possible."
/com.gk_software.pos.api.service.transaction.PosTransactionService/getOrCreateTransactionById:
post:
tags:
- "PosTransactionService"
summary: "Gets or creates the current RetailTransaction associated with the\
\ session. If the transaction has to be created it wi..."
description: "Gets or creates the current RetailTransaction associated with\
\ the session. If the transaction has to be created it will be
created\
\ with the given transaction UUID. If the transaction UUID is null
,\
\ then it will be generated by
transaction pool."
operationId: "PosTransactionService.getOrCreateTransactionById"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The transaction UUID."
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/PosTransaction"
500:
description: "If the creation of new transaction is not possible."
/com.gk_software.pos.api.service.transaction.PosTransactionService/getRefundTransactionById:
post:
tags:
- "PosTransactionService"
summary: "Load {@link RefundTransaction} based on its key attribute."
description: "Load {@link RefundTransaction} based on its key attribute."
operationId: "PosTransactionService.getRefundTransactionById"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The transaction identifier"
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.refund_service.dto.RefundTransaction"
500:
description: "If it is not possible to load a refund transaction with the\
\ given transaction identifier."
/com.gk_software.pos.api.service.transaction.PosTransactionService/getTerminalToRefundDataOnVoidingTransaction:
post:
tags:
- "PosTransactionService"
summary: "Get terminal line items data to refund during voiding transaction."
description: "Get terminal line items data to refund during voiding transaction."
operationId: "PosTransactionService.getTerminalToRefundDataOnVoidingTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TerminalToRefundData"
500:
description: "If there is not transaction assigned to the session."
/com.gk_software.pos.api.service.transaction.PosTransactionService/getTransaction:
post:
tags:
- "PosTransactionService"
summary: "Gets the current active {@link PosTransaction} associated with the\
\ session."
description: "Gets the current active {@link PosTransaction} associated with\
\ the session."
operationId: "PosTransactionService.getTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/PosTransaction"
500:
description: "If there is no current transaction."
/com.gk_software.pos.api.service.transaction.PosTransactionService/getTransactionById:
post:
tags:
- "PosTransactionService"
summary: "Load transaction based on its key attribute."
description: "Load transaction based on its key attribute."
operationId: "PosTransactionService.getTransactionById"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The transaction identifier"
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "If it is not possible to load a transaction with the given\
\ transaction identifier."
/com.gk_software.pos.api.service.transaction.PosTransactionService/getTransactionSearchViewsByIds:
post:
tags:
- "PosTransactionService"
summary: "Get {@link TransactionSearchView} objects for the given list of transaction\
\ identifiers."
description: "Get {@link TransactionSearchView} objects for the given list of\
\ transaction identifiers."
operationId: "PosTransactionService.getTransactionSearchViewsByIds"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link TransactionIdsRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionIdsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionSearchViewsResult"
500:
description: "If a transaction cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/isAtLeastOneFiscalStartTransactionCreated:
post:
tags:
- "PosTransactionService"
summary: "Checks whether there is at least one fiscal start transaction matching\
\ the given data."
description: "Checks whether there is at least one fiscal start transaction\
\ matching the given data."
operationId: "PosTransactionService.isAtLeastOneFiscalStartTransactionCreated"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link SearchFiscalStartTransactionRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SearchFiscalStartTransactionRequest"
responses:
200:
description: "Success"
schema:
type: "boolean"
500:
description: "Only in case of an unexpected error."
/com.gk_software.pos.api.service.transaction.PosTransactionService/isReturnableForRestrictionTypeCodes:
post:
tags:
- "PosTransactionService"
summary: "Determines whether the transaction is returnable, given the restriction\
\ type codes."
description: "Determines whether the transaction is returnable, given the restriction\
\ type codes. It is expected that the {@link com.gk_software.pos.api.model.config.process.flows.ReturnTenderRule}\
\ has been checked, and special tender handling should be performed. The restriction\
\ type codes are used to find matching tenders from the given {@link Transaction}.\
\ Return rules are used to determine whether there are any valid return tenders."
operationId: "ReturnWithTransactionService.isReturnableForRestrictionTypeCodes"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The ReturnableForRestrictionTypeCodesRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.ReturnableForRestrictionTypeCodesRequest"
responses:
200:
description: "Success"
schema:
type: "boolean"
/com.gk_software.pos.api.service.transaction.PosTransactionService/isTransactionPrinted:
post:
tags:
- "PosTransactionService"
summary: "Checks whether the transaction for the given identifier is printed."
description: "Checks whether the transaction for the given identifier is printed."
operationId: "PosTransactionService.isTransactionPrinted"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The transaction identifier."
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
type: "boolean"
500:
description: "If the transaction cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/isTransactionVoided:
post:
tags:
- "PosTransactionService"
summary: "Checks whether the transaction for the given identifier is voided."
description: "Checks whether the transaction for the given identifier is voided."
operationId: "PosTransactionService.isTransactionVoided"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The transaction identifier."
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
type: "boolean"
500:
description: "If the transaction cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/loadCompleteTransaction:
post:
tags:
- "PosTransactionService"
summary: "Loads the complete transaction."
description: "Loads the complete transaction."
operationId: "PosTransactionService.loadCompleteTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The transaction ID"
required: true
schema:
type: "string"
- in: "body"
name: "body"
description: "The flag which indicates if the tx is searched localy only."
required: true
schema:
type: "boolean"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.CompleteTransaction"
500:
description: "If it is not possible to load the complete transaction."
/com.gk_software.pos.api.service.transaction.PosTransactionService/overtakeScaleScopedTransactionItems:
post:
tags:
- "PosTransactionService"
summary: "Overtakes items from scoped scale transaction."
description: "Overtakes items from scoped scale transaction."
operationId: "PosTransactionService.overtakeScaleScopedTransactionItems"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If it is not possible to overtake items from scale scoped\
\ transaction."
/com.gk_software.pos.api.service.transaction.PosTransactionService/prepareLastSuspendOpenSSCTransaction:
post:
tags:
- "PosTransactionService"
summary: "Suspends open SSC Transaction that matches the given criteria."
description: "Suspends open SSC Transaction that matches the given criteria."
operationId: "PosTransactionService.prepareLastSuspendOpenSSCTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The RetrieveOpenSSCTransactionRequest object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RetrieveOpenSSCTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "In case an error occurs."
/com.gk_software.pos.api.service.transaction.PosTransactionService/recalculateLineItems:
post:
tags:
- "PosTransactionService"
summary: "Recalculates amounts of items and return the items back."
description: "Recalculates amounts of items and return the items back."
operationId: "PosTransactionService.recalculateLineItems"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link RecalculateLineItemsRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RecalculateLineItemsRequest"
responses:
200:
description: "Success"
schema:
type: "array"
items:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem"
500:
description: "If the calculation failed by any reason."
/com.gk_software.pos.api.service.transaction.PosTransactionService/recalculateTaxesOnActiveTransaction:
post:
tags:
- "PosTransactionService"
summary: "Recalculates taxes on the transaction assigned to the session."
description: "Recalculates taxes on the transaction assigned to the session."
operationId: "PosTransactionService.recalculateTaxesOnActiveTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session or the\
\ tax calculation failed."
/com.gk_software.pos.api.service.transaction.PosTransactionService/recoverTransaction:
post:
tags:
- "PosTransactionService"
summary: "Checks whether there is an open transaction stored in the persistence.\
\ If yes, it is loaded and set as the current"
description: "Checks whether there is an open transaction stored in the persistence.\
\ If yes, it is loaded and set as the current
transaction. This method\
\ is used in order to recover from a failed/crashed POS in order to restore\
\ the transaction."
operationId: "PosTransactionService.recoverTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/PosTransaction"
500:
description: "If the recovery of the transaction is not possible."
/com.gk_software.pos.api.service.transaction.PosTransactionService/recoverTransactionById:
post:
tags:
- "PosTransactionService"
operationId: "recoverTransactionById"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/PosTransaction"
/com.gk_software.pos.api.service.transaction.PosTransactionService/recoverTransactionWithRequest:
post:
tags:
- "PosTransactionService"
summary: "Checks whether there is an open transaction stored in the persistence.\
\ If yes, it is loaded and set as the current"
description: "Checks whether there is an open transaction stored in the persistence.\
\ If yes, it is loaded and set as the current
transaction. This method\
\ is used in order to recover from a failed/crashed POS in order to restore\
\ the transaction."
operationId: "PosTransactionService.recoverTransactionWithRequest"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The RecoverTransactionRequest object."
required: false
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RecoverTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/PosTransaction"
500:
description: "If the recovery of the transaction is not possible."
/com.gk_software.pos.api.service.transaction.PosTransactionService/refundNonVoidedTendersInMainCurrencyCash:
post:
tags:
- "PosTransactionService"
summary: "Creates a new cash {@link TenderLineItem} in main currency in order\
\ to refund all non voided tender line items from the"
description: "Creates a new cash {@link TenderLineItem} in main currency in\
\ order to refund all non voided tender line items from the
transaction\
\ assigned to the session. Before any action it is also verified that the\
\ given transaction identifier in the
request matches the transaction\
\ identifier from the transaction assigned to the session."
operationId: "PosTransactionService.refundNonVoidedTendersInMainCurrencyCash"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link CashRefundRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.CashRefundRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session or the\
\ transaction identifiers does not match."
/com.gk_software.pos.api.service.transaction.PosTransactionService/registerEmptiesTransaction:
post:
tags:
- "PosTransactionService"
summary: "Retrieves and registers an empties return transaction."
description: "Retrieves and registers an empties return transaction."
operationId: "PosTransactionService.registerEmptiesTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link RegisterEmptiesTransactionRequest}"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RegisterEmptiesTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RegisterEmptiesTransactionResult"
500:
description: "In case of an error during retrieve of the empties return\
\ transaction or an invalid state."
/com.gk_software.pos.api.service.transaction.PosTransactionService/registerScaleTransaction:
post:
tags:
- "PosTransactionService"
summary: "Retrieves and registers a scale transaction."
description: "Retrieves and registers a scale transaction."
operationId: "PosTransactionService.registerScaleTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link RegisterScaleTransactionRequest}"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RegisterScaleTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RegisterScaleTransactionResult"
500:
description: "In case of an error during retrieve of the scale transaction\
\ or an invalid state."
/com.gk_software.pos.api.service.transaction.PosTransactionService/removeBinaryDataFromTransaction:
post:
tags:
- "PosTransactionService"
summary: "Removes all binary data from transaction related to the given name"
description: "Removes all binary data from transaction related to the given\
\ name"
operationId: "PosTransactionService.removeBinaryDataFromTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "name to be removed"
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "In case an error occurs."
/com.gk_software.pos.api.service.transaction.PosTransactionService/removeBrokenTenderAuthorizations:
post:
tags:
- "PosTransactionService"
summary: "Removes broken tender authorizations."
description: "Removes broken tender authorizations. This is the case if TenderLineItemSequenceNumber\
\ is null."
operationId: "PosTransactionService.removeBrokenTenderAuthorizations"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "In case an error occurs."
/com.gk_software.pos.api.service.transaction.PosTransactionService/removeExtensionsFromAllSaleReturnLineItems:
post:
tags:
- "PosTransactionService"
summary: "Removes all extensions with given keys from all sale return line items\
\ contained in current session's transaction."
description: "Removes all extensions with given keys from all sale return line\
\ items contained in current session's transaction."
operationId: "PosTransactionService.removeExtensionsFromAllSaleReturnLineItems"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Object containing the keys of extensions to be removed and a\
\ storeTransaction flag, which can be used for persisting the
transaction\
\ after the extensions are removed."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RemoveSaleReturnLineItemExtensionsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "if transaction does not exist in current session or requested\
\ transaction storage fails."
/com.gk_software.pos.api.service.transaction.PosTransactionService/removeTransactionAdditionalPrintouts:
post:
tags:
- "PosTransactionService"
summary: "Removes transaction additional printouts."
description: "Removes transaction additional printouts."
operationId: "PosTransactionService.removeTransactionAdditionalPrintouts"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link RemoveTransactionAdditionalPrintoutsRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RemoveTransactionAdditionalPrintoutsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session."
/com.gk_software.pos.api.service.transaction.PosTransactionService/removeTransactionExtensionFromTransaction:
post:
tags:
- "PosTransactionService"
summary: "Removes the given transaction extension from the transaction assigned\
\ to the session."
description: "Removes the given transaction extension from the transaction assigned\
\ to the session."
operationId: "PosTransactionService.removeTransactionExtensionFromTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The key from the transaction extension to be removed from the\
\ transaction."
required: true
schema:
type: "string"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session."
/com.gk_software.pos.api.service.transaction.PosTransactionService/removeTransactionExtensionFromTransactionRequest:
post:
tags:
- "PosTransactionService"
summary: "Removes the given transaction extension from the transaction referred\
\ to by the id."
description: "Removes the given transaction extension from the transaction referred\
\ to by the id."
operationId: "PosTransactionService.removeTransactionExtensionFromTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The RemoveTransactionExtensionRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RemoveTransactionExtensionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If the transaction cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/reopenLastScaleTransactionForActiveOperator:
post:
tags:
- "PosTransactionService"
summary: "Reopen last scale transaction for active operator."
description: "Reopen last scale transaction for active operator."
operationId: "PosTransactionService.reopenLastScaleTransactionForActiveOperator"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Transaction search request details"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SearchRetailTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If transaction cannot be open."
/com.gk_software.pos.api.service.transaction.PosTransactionService/retrieveSuspendedRetailTransactionsByIds:
post:
tags:
- "PosTransactionService"
summary: "Retrieves suspended transactions for the given list of transaction\
\ identifiers."
description: "Retrieves suspended transactions for the given list of transaction\
\ identifiers."
operationId: "PosTransactionService.retrieveSuspendedRetailTransactionsByIds"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link RetrieveSuspendedRetailTransactionsByIdsRequest}\
\ object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RetrieveSuspendedRetailTransactionsByIdsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If suspended transactions cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/retrieveTransactionFromConvertedSuspendCodes:
post:
tags:
- "PosTransactionService"
summary: "Retrieves transaction from converted suspend codes."
description: "Retrieves transaction from converted suspend codes."
operationId: "PosTransactionService.retrieveTransactionFromConvertedSuspendCodes"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The RetrieveTransactionFromSuspendCodeRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.RetrieveTransactionFromSuspendCodeRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.ConvertSuspendCodesResponse"
500:
description: "In case an error occurs."
/com.gk_software.pos.api.service.transaction.PosTransactionService/returnLineItemsWithTransaction:
post:
tags:
- "PosTransactionService"
summary: "Returns a list of line items of a given transaction and adds according\
\ return line items to current transaction."
description: "Returns a list of line items of a given transaction and adds according\
\ return line items to current transaction."
operationId: "PosTransactionService.returnLineItemsWithTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link ReturnLineItemBulkRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.ReturnLineItemBulkRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If a line item cannot be returned or the transaction cannot\
\ be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/returnTransaction:
post:
tags:
- "PosTransactionService"
summary: "Returns all line items of the given transaction and adds according\
\ return line items to this transaction."
description: "Returns all line items of the given transaction and adds according\
\ return line items to this transaction."
operationId: "PosTransactionService.returnTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link ReturnTransactionRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.ReturnTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If the transaction cannot be returned or found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/returnTransactionWithTempSession:
post:
tags:
- "PosTransactionService"
summary: "Returns one or more items of a given transaction, or the complete\
\ transaction depending on the provided data."
description: "Returns one or more items of a given transaction, or the complete\
\ transaction depending on the provided data."
operationId: "PosTransactionService.returnTransactionWithTempSession"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link ReturnTransactionWithTempSessionRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.ReturnTransactionWithTempSessionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If the transaction cannot be returned or found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/searchAndRetrieveSuspendedRetailTransactions:
post:
tags:
- "PosTransactionService"
summary: "Searches and retrieves suspended transactions that matches the given\
\ criteria."
description: "Searches and retrieves suspended transactions that matches the\
\ given criteria."
operationId: "PosTransactionService.searchAndRetrieveSuspendedRetailTransactions"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link SearchAndRetrieveSuspendedRetailTransactionsRequest}\
\ object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SearchAndRetrieveSuspendedRetailTransactionsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If suspended transactions cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/searchCustomerTransactionViews:
post:
tags:
- "PosTransactionService"
summary: "Searches for the customer transactions that matches the given criteria."
description: "Searches for the customer transactions that matches the given\
\ criteria."
operationId: "PosTransactionService.searchCustomerTransactionViews"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link SearchCustomerTransactionsRequest} object"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SearchCustomerTransactionsRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionSearchViewsResult"
/com.gk_software.pos.api.service.transaction.PosTransactionService/searchCustomerTransactions:
post:
tags:
- "PosTransactionService"
summary: "Searches for customer transactions that matches the given criteria."
description: "Searches for customer transactions that matches the given criteria."
operationId: "PosTransactionService.searchCustomerTransactions"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link SearchCustomerTransactionsRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SearchCustomerTransactionsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionIdsResult"
500:
description: "If customer transactions cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/searchDuplicatePrintTransactionSearchViews:
post:
tags:
- "PosTransactionService"
summary: "Searches for the duplicate print out transactions that matches the\
\ given criteria."
description: "Searches for the duplicate print out transactions that matches\
\ the given criteria."
operationId: "PosTransactionService.searchDuplicatePrintTransactionSearchViews"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "request"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.DuplicatePrintOutTransactionsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionSearchViewsResult"
500:
description: "If printout transactions cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/searchLastFinalizedRetailTransaction:
post:
tags:
- "PosTransactionService"
summary: "Searches for last finalized retail transaction."
description: "Searches for last finalized retail transaction."
operationId: "PosTransactionService.searchLastFinalizedRetailTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The SearchLastFinalizedRetailTransactionRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SearchLastFinalizedRetailTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "If no single matching transaction can be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/searchLastTransaction:
post:
tags:
- "PosTransactionService"
summary: "Searches for last transaction that matches given criteria."
description: "Searches for last transaction that matches given criteria."
operationId: "PosTransactionService.searchLastTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The SearchRetailTransactionRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SearchRetailTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "If no single matching transaction can be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/searchLastTransactionId:
post:
tags:
- "PosTransactionService"
summary: "Searches for last transaction that matches given criteria."
description: "Searches for last transaction that matches given criteria."
operationId: "PosTransactionService.searchLastTransactionId"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The SearchRetailTransactionRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SearchRetailTransactionRequest"
responses:
200:
description: "Success"
schema:
type: "string"
500:
description: "If no single matching transaction identifier can be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/searchLastUnfinishedRetailTransaction:
post:
tags:
- "PosTransactionService"
summary: "Searches for last unfinished retail transaction."
description: "Searches for last unfinished retail transaction."
operationId: "PosTransactionService.searchLastUnfinishedRetailTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The SearchLastUnfinishedRetailTransactionRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SearchLastUnfinishedRetailTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
500:
description: "If no single matching transaction can be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/searchPrintOutTransactionSearchViews:
post:
tags:
- "PosTransactionService"
summary: "Searches for printout transactions that matches the given criteria."
description: "Searches for printout transactions that matches the given criteria."
operationId: "PosTransactionService.searchPrintOutTransactionSearchViews"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link PrintOutTransactionsRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.PrintOutTransactionsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionSearchViewsResult"
500:
description: "If printout transactions cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/searchSingleFinishedRetailTransaction:
post:
tags:
- "PosTransactionService"
summary: "Searches for single transaction that matches given criteria."
description: "Searches for single transaction that matches given criteria."
operationId: "PosTransactionService.searchSingleFinishedRetailTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The SearchRetailTransactionRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SearchRetailTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/PosTransaction"
500:
description: "If no single matching transaction can be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/searchSingleFinishedRetailTransactionId:
post:
tags:
- "PosTransactionService"
summary: "Searches for single transaction that matches given criteria."
description: "Searches for single transaction that matches given criteria."
operationId: "PosTransactionService.searchSingleFinishedRetailTransactionId"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The SearchRetailTransactionRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SearchRetailTransactionRequest"
responses:
200:
description: "Success"
schema:
type: "string"
500:
description: "If no single matching transaction can be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/searchSuspendedTransactionSearchViews:
post:
tags:
- "PosTransactionService"
summary: "Searches for the suspended transactions that matches the given criteria."
description: "Searches for the suspended transactions that matches the given\
\ criteria."
operationId: "PosTransactionService.searchSuspendedTransactionSearchViews"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link SearchSuspendedTransactionsRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SearchSuspendedTransactionsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionSearchViewsResult"
500:
description: "If no suspended transaction was found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/searchSuspendedTransactions:
post:
tags:
- "PosTransactionService"
summary: "Searches for the suspended transactions that matches the given criteria."
description: "Searches for the suspended transactions that matches the given\
\ criteria."
operationId: "PosTransactionService.searchSuspendedTransactions"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link SearchSuspendedTransactionsRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SearchSuspendedTransactionsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionIdsResult"
500:
description: "If no matching suspended transaction exists."
/com.gk_software.pos.api.service.transaction.PosTransactionService/searchUnfinishedTransactions:
post:
tags:
- "PosTransactionService"
summary: "Searches for the unfinished transactions that matches the given criteria."
description: "Searches for the unfinished transactions that matches the given\
\ criteria."
operationId: "PosTransactionService.searchUnfinishedTransactions"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "unfinishedTransactionsRequest"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.UnfinishedTransactionsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionIdsResult"
500:
description: "If no matching transaction exists."
/com.gk_software.pos.api.service.transaction.PosTransactionService/setCustomFields:
post:
tags:
- "PosTransactionService"
summary: "Set transaction custom field (e.g. XXCustom01) values on the transaction\
\ which is associated to the session."
description: "Set transaction custom field (e.g. XXCustom01) values on the transaction\
\ which is associated to the session."
operationId: "PosTransactionService.setCustomFields"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The SetTransactionCustomFieldsRequest with the custom field\
\ values."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SetTransactionCustomFieldsRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "Only in case of an unexpected error."
/com.gk_software.pos.api.service.transaction.PosTransactionService/setFiscalReceiptNumber:
post:
tags:
- "PosTransactionService"
summary: "Sets the fiscal receipt number to the current transaction."
description: "Sets the fiscal receipt number to the current transaction."
operationId: "PosTransactionService.setFiscalReceiptNumber"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link SetFiscalReceiptNumberRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SetFiscalReceiptNumberRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If the transaction cannot be found."
/com.gk_software.pos.api.service.transaction.PosTransactionService/setInvoicePrintoutTypeCode:
post:
tags:
- "PosTransactionService"
summary: "Sets the invoice printout type code to the transaction assigned to\
\ the session."
description: "Sets the invoice printout type code to the transaction assigned\
\ to the session."
operationId: "PosTransactionService.setInvoicePrintoutTypeCode"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link InvoicePrintoutTypeCodeRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.InvoicePrintoutTypeCodeRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session."
/com.gk_software.pos.api.service.transaction.PosTransactionService/setPrintoutRelatedAttributes:
post:
tags:
- "PosTransactionService"
summary: "Sets the printout related attributes to the transaction assigned to\
\ the session."
description: "Sets the printout related attributes to the transaction assigned\
\ to the session."
operationId: "PosTransactionService.setPrintoutRelatedAttributes"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link PrintoutRelatedAttributesRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.PrintoutRelatedAttributesRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session."
/com.gk_software.pos.api.service.transaction.PosTransactionService/setSuspendedLineItemsNotEditable:
post:
tags:
- "PosTransactionService"
summary: "Add extension (non editable) to the suspended line items on the transaction."
description: "Add extension (non editable) to the suspended line items on the\
\ transaction."
operationId: "PosTransactionService.setSuspendedLineItemsNotEditable"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "In case an error occurs."
/com.gk_software.pos.api.service.transaction.PosTransactionService/setTransactionEndWorkstationId:
post:
tags:
- "PosTransactionService"
summary: "Sets transaction end attributes for a transaction."
description: "Sets transaction end attributes for a transaction."
operationId: "PosTransactionService.setTransactionEndAttributes"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link SetTransactionEndAttributesRequest} object. It must\
\ have at least a filled transaction identifier and a workstation identifier."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SetTransactionEndAttributesRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If the request contains illegal arguments or if there is no\
\ transaction for the given identifier."
/com.gk_software.pos.api.service.transaction.PosTransactionService/setTransactionExtension:
post:
tags:
- "PosTransactionService"
summary: "Adds the given transaction extension to the transaction assigned to\
\ the session. If it is already existing, then the"
description: "Adds the given transaction extension to the transaction assigned\
\ to the session. If it is already existing, then the
transaction extension\
\ is updated."
operationId: "PosTransactionService.setTransactionExtension"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The AddTransactionExtensionsRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.AddTransactionExtensionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session."
/com.gk_software.pos.api.service.transaction.PosTransactionService/setTransactionReason:
post:
tags:
- "PosTransactionService"
summary: "Sets the reason data to a transaction. If there is no transaction\
\ identifier given, then the transaction assigned to the"
description: "Sets the reason data to a transaction. If there is no transaction\
\ identifier given, then the transaction assigned to the
session is used."
operationId: "PosTransactionService.setTransactionReason"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link SetTransactionReasonRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SetTransactionReasonRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
/com.gk_software.pos.api.service.transaction.PosTransactionService/storeTransaction:
post:
tags:
- "PosTransactionService"
summary: "Stores the current active {@link RetailTransaction} associated with\
\ the session."
description: "Stores the current active {@link RetailTransaction} associated\
\ with the session."
operationId: "PosTransactionService.storeTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/PosTransaction"
500:
description: "If there is no transaction assigned to the session."
/com.gk_software.pos.api.service.transaction.PosTransactionService/suspendTransaction:
post:
tags:
- "PosTransactionService"
summary: "Suspends an uncompleted transaction which is associated to the session."
description: "Suspends an uncompleted transaction which is associated to the\
\ session."
operationId: "PosTransactionService.suspendTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The SuspendTransactionRequest"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.SuspendTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If no transaction is assigned to session"
/com.gk_software.pos.api.service.transaction.PosTransactionService/updateTaxGroupRelatedAttributes:
post:
tags:
- "PosTransactionService"
summary: "Updates the tax group related attributes on all line items of the\
\ transaction assigned to the session, dependent on the"
description: "Updates the tax group related attributes on all line items of\
\ the transaction assigned to the session, dependent on the
current {@link\
\ AlternativeTaxInfos}s and maybe performs tax recalculation."
operationId: "PosTransactionService.updateTaxGroupRelatedAttributes"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The {@link AlternativeTaxRequest} object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.AlternativeTaxRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session."
/com.gk_software.pos.api.service.transaction.PosTransactionService/updateTransactionCorrelations:
post:
tags:
- "PosTransactionService"
summary: "Updates transaction correlations from the transaction assigned to\
\ the session."
description: "Updates transaction correlations from the transaction assigned\
\ to the session."
operationId: "PosTransactionService.updateTransactionCorrelations"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session."
/com.gk_software.pos.api.service.transaction.PosTransactionService/updateTransactionExtensionFromTransaction:
post:
tags:
- "PosTransactionService"
summary: "Updates the given transaction extension from the transaction assigned\
\ to the session."
description: "Updates the given transaction extension from the transaction assigned\
\ to the session."
operationId: "PosTransactionService.updateTransactionExtensionFromTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The UpdateTransactionExtensionRequest object."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.UpdateTransactionExtensionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If there is no transaction assigned to the session."
/com.gk_software.pos.api.service.transaction.PosTransactionService/voidTransactionConsolidateCashInMainCurrency:
post:
tags:
- "PosTransactionService"
summary: "Consolidate cash tender line items in main currency and maybe add\
\ additional cashRefundAmount. Cash refund is the sum..."
description: "Consolidate cash tender line items in main currency and maybe\
\ add additional cashRefundAmount. Cash refund is the sum of all
payments\
\ (e.g. by terminal or points), where voiding was not possible anymore. The\
\ amount is then refunded in cash."
operationId: "PosTransactionService.voidTransactionConsolidateCashInMainCurrency"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The VoidTransactionConsolidateCashInMainCurrencyRequest"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.VoidTransactionConsolidateCashInMainCurrencyRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "In case that the voiding fails for any reason."
/com.gk_software.pos.api.service.transaction.consolidation.ConsolidationService/consolidateTransaction:
post:
operationId: "consolidateTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
/com.gk_software.pos.api.service.transaction.customer.CustomerTransactionService/createAndAddOrUpdateRetailTransactionCustomer:
post:
tags:
- "CustomerTransactionService"
summary: "Assign customer to current transaction by adding or updating existing\
\ customer."
description: "Assign customer to current transaction by adding or updating existing\
\ customer."
operationId: "CustomerTransactionService.createAndAddOrUpdateRetailTransactionCustomer"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CustomerAssignmentRequest, it customer data required for\
\ assignment"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.customer.CustomerAssignmentRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
/com.gk_software.pos.api.service.transaction.customer.CustomerTransactionService/createAndAddRetailTransactionCustomer:
post:
tags:
- "CustomerTransactionService"
summary: "Assign customer to current transaction"
description: "Assign customer to current transaction"
operationId: "CustomerTransactionService.createAndAddRetailTransactionCustomer"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CustomerAssignmentRequest, it consist of data required for\
\ assignment"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.customer.CustomerAssignmentRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
/com.gk_software.pos.api.service.transaction.customer.CustomerTransactionService/registerCustomer:
post:
tags:
- "CustomerTransactionService"
summary: "Registers a customer to current transaction."
description: "Registers a customer to current transaction.
Following steps\
\ are done dependent on config/request values:
"
operationId: "CustomerTransactionService.registerCustomer"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CustomerRegistrationRequest"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.customer.CustomerRegistrationRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "in case of error"
/com.gk_software.pos.api.service.transaction.customer.CustomerTransactionService/removeCustomerFromTransaction:
post:
tags:
- "CustomerTransactionService"
summary: "Remove customer from current transaction"
description: "Remove customer from current transaction"
operationId: "CustomerTransactionService.removeCustomerFromTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The CustomerRemovalRequest"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.customer.CustomerRemovalRequest"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
/com.gk_software.pos.api.service.transaction.customer.CustomerTransactionService/removeCustomerFromTransactionByTypeCode:
post:
tags:
- "CustomerTransactionService"
summary: "Remove customer from current transaction for given address type code."
description: "Remove customer from current transaction for given address type\
\ code."
operationId: "CustomerTransactionService.removeCustomerFromTransactionByTypeCode"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The addressTypdeCode"
required: true
schema:
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
? /com.gk_software.pos.api.service.transaction.gift_certificate.GiftCertificateTransactionService/cancelAllGiftCertLineItemsOnCurrentTransaction
: post:
tags:
- "GiftCertificateTransactionService"
summary: "Cancels all gift certificate line items on a currently active transaction"
description: "Cancels all gift certificate line items on a currently active\
\ transaction"
operationId: "GiftCertificateTransactionService.cancelAllGiftCertLineItemsOnCurrentTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "{@link CancelGiftCertTransactionRequest}, request containing\
\ data about gift certificate to cancel."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.stored_value_server.CancelGiftCertTransactionRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If the cancellation of gift certificate line item fails"
? /com.gk_software.pos.api.service.transaction.gift_certificate.GiftCertificateTransactionService/createAndAddGiftCertificateLineItem
: post:
tags:
- "GiftCertificateTransactionService"
summary: "Creates a gift certificate line item."
description: "Creates a gift certificate line item."
operationId: "GiftCertificateTransactionService.createAndAddGiftCertificateLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The GiftCertificateRegistrationRequest, contains data of gift\
\ certificate"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.gift_certificate.GiftCertificateRegistrationRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If the line item cannot be registered"
/com.gk_software.pos.api.service.transaction.prepaid.PrepaidCreditTransactionService/addPrepaidLineItems:
post:
tags:
- "PrepaidCreditTransactionService"
summary: "Adds a list of failed prepaid line items to the return receipt for\
\ refunding."
description: "Adds a list of failed prepaid line items to the return receipt\
\ for refunding."
operationId: "PrepaidCreditTransactionService.addPrepaidLineItems"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PrepaidCreditRefundRequest containing all data for refunding\
\ the prepaid line items."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.prepaid.PrepaidCreditRefundRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "In case of any error"
/com.gk_software.pos.api.service.transaction.prepaid.PrepaidCreditTransactionService/createAndAddPrepaidCreditLineItem:
post:
tags:
- "PrepaidCreditTransactionService"
summary: "Creates a line item for prepaid credit sale."
description: "Creates a line item for prepaid credit sale."
operationId: "PrepaidCreditTransactionService.createAndAddPrepaidCreditLineItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PrepaidCreditSaleRegistrationRequest containing all data\
\ for prepaid credit sale"
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.prepaid.PrepaidCreditSaleRegistrationRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If the line item cannot be registered"
/com.gk_software.pos.api.service.transaction.prepaid.PrepaidCreditTransactionService/updatePrepaidItem:
post:
tags:
- "PrepaidCreditTransactionService"
summary: "Updates a line item for prepaid credit sale."
description: "Updates a line item for prepaid credit sale."
operationId: "PrepaidCreditTransactionService.updatePrepaidItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "The PrepaidCreditSaleUpdateRequest containing all data for updating\
\ the prepaid credit sale line item."
required: true
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.prepaid.PrepaidCreditSaleUpdateRequest"
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult"
500:
description: "If the line item cannot be updated"
definitions:
CurrencyResult:
type: "object"
properties:
baseCurrency:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.currency.dto.dom.CurrencyDO"
currencies:
type: "array"
items:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.currency.dto.dom.CurrencyDO"
exchangeRates:
type: "object"
additionalProperties:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.exchange_rate.dto.dom.ExchangeRateDO"
CustomerCardCodeConverterService:
type: "object"
ErrorCode:
type: "object"
properties:
errorCode:
type: "string"
message:
type: "string"
messageKey:
type: "string"
arguments:
type: "array"
items:
type: "string"
EventLogMessageDO:
type: "object"
properties:
key:
$ref: "#/definitions/Key"
created:
type: "string"
format: "date-time"
createdUTC0:
type: "string"
format: "date-time"
type:
type: "string"
subType:
type: "string"
level:
type: "string"
application:
type: "string"
stationID:
type: "string"
nodeID:
type: "string"
businessUnitGroupID:
type: "integer"
format: "int64"
operatorID:
type: "string"
payload:
type: "array"
items:
type: "string"
format: "byte"
payloadDataID:
type: "string"
processData01:
type: "string"
processData02:
type: "string"
processData03:
type: "string"
processData04:
type: "string"
processData05:
type: "string"
processData06:
type: "string"
processData07:
type: "string"
processData08:
type: "string"
processData09:
type: "string"
processData10:
type: "string"
xid:
type: "integer"
format: "int64"
xxcustom06:
type: "string"
xxcustom07:
type: "string"
xxcustom08:
type: "string"
xxcustom09:
type: "string"
xxcustom10:
type: "string"
xxcustom01:
type: "string"
xxcustom02:
type: "string"
xxcustom03:
type: "string"
xxcustom04:
type: "string"
xxcustom05:
type: "string"
EventLogMessageSearchCriteria:
type: "object"
properties:
createdFrom:
type: "string"
format: "date-time"
createdTo:
type: "string"
format: "date-time"
type:
type: "string"
subType:
type: "string"
application:
type: "string"
level:
type: "string"
retailStoreID:
type: "string"
retailStoreIDList:
type: "array"
items:
type: "string"
businessUnitGroupID:
type: "integer"
format: "int64"
businessUnitGroupIDList:
type: "array"
items:
type: "integer"
format: "int64"
stationID:
type: "string"
nodeID:
type: "string"
operatorID:
type: "string"
workstationID:
type: "string"
payloadDataID:
type: "string"
processData01:
type: "string"
processData02:
type: "string"
processData03:
type: "string"
processData04:
type: "string"
processData05:
type: "string"
processData06:
type: "string"
processData07:
type: "string"
processData08:
type: "string"
processData09:
type: "string"
processData10:
type: "string"
processData01List:
type: "array"
items:
type: "string"
processData02List:
type: "array"
items:
type: "string"
processData03List:
type: "array"
items:
type: "string"
processData04List:
type: "array"
items:
type: "string"
processData05List:
type: "array"
items:
type: "string"
processData06List:
type: "array"
items:
type: "string"
processData07List:
type: "array"
items:
type: "string"
processData08List:
type: "array"
items:
type: "string"
processData09List:
type: "array"
items:
type: "string"
processData10List:
type: "array"
items:
type: "string"
isLastEventLog:
type: "boolean"
distance:
type: "integer"
format: "int32"
xxcustom01List:
type: "array"
items:
type: "string"
xxcustom02List:
type: "array"
items:
type: "string"
xxcustom03List:
type: "array"
items:
type: "string"
xxcustom04List:
type: "array"
items:
type: "string"
xxcustom05List:
type: "array"
items:
type: "string"
xxcustom06List:
type: "array"
items:
type: "string"
xxcustom07List:
type: "array"
items:
type: "string"
xxcustom08List:
type: "array"
items:
type: "string"
xxcustom09List:
type: "array"
items:
type: "string"
xxcustom10List:
type: "array"
items:
type: "string"
xxcustom06:
type: "string"
xxcustom07:
type: "string"
xxcustom08:
type: "string"
xxcustom09:
type: "string"
xxcustom10:
type: "string"
xxcustom01:
type: "string"
xxcustom02:
type: "string"
xxcustom03:
type: "string"
xxcustom04:
type: "string"
xxcustom05:
type: "string"
EventLogSearchParameters:
type: "object"
properties:
messageCriteria:
$ref: "#/definitions/EventLogMessageSearchCriteria"
paging:
$ref: "#/definitions/PagingParameters"
requestedValues:
$ref: "#/definitions/RequestedValues"
EventLogSearchResult:
type: "object"
properties:
paging:
$ref: "#/definitions/PagingParameters"
haveMoreData:
type: "boolean"
messageList:
type: "array"
items:
$ref: "#/definitions/EventLogMessageDO"
EventLogStoreRequest:
type: "object"
properties:
asynchronous:
type: "boolean"
messageList:
type: "array"
items:
$ref: "#/definitions/EventLogMessageDO"
ExchangeRatesResult:
type: "object"
properties:
fromCurrency:
type: "string"
exchangeRatesByCurrencyCode:
type: "object"
additionalProperties:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.exchange_rate.dto.dom.ExchangeRateDO"
FilterPerTenderResult:
type: "object"
properties:
allowedTender:
type: "array"
uniqueItems: true
items:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO"
allowedTenderAmounts:
type: "object"
additionalProperties:
type: "number"
forbiddenTender:
type: "array"
uniqueItems: true
items:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO"
authorizationNeededTender:
type: "array"
uniqueItems: true
items:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO"
tenderErrorCodeMap:
type: "object"
additionalProperties:
$ref: "#/definitions/ErrorCode"
IBasicFilterCondition:
type: "object"
IBasicFilterConditionString:
type: "object"
ItemSearchResponse:
type: "object"
properties:
listPosUOMItemSearchView:
type: "array"
items:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemSearchView"
Key:
type: "object"
properties:
retailStoreID:
type: "string"
workstationID:
type: "string"
id:
type: "string"
Money:
type: "object"
properties:
amount:
type: "integer"
format: "int32"
currency:
type: "string"
PagingParameters:
type: "object"
properties:
orderingType:
type: "string"
pageStart:
type: "string"
pageSize:
type: "integer"
format: "int32"
PinInfoType:
type: "object"
properties:
serialNumber:
type: "string"
pinCode:
type: "string"
validTo:
type: "string"
format: "date-time"
printoutText:
type: "string"
PosSession:
type: "object"
properties:
id:
$ref: "#/definitions/com.gk_software.pos.api.session.PosSessionId"
transaction:
$ref: "#/definitions/PosTransaction"
tenantId:
type: "string"
workstationId:
type: "string"
workstationTypeCode:
type: "string"
operatorId:
type: "string"
deviceId:
type: "string"
tillId:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.till.dto.dom.TillDO.Key"
clientVersion:
type: "string"
activeLanguageScope:
type: "string"
enum:
- "Operator"
- "Customer"
- "Transaction"
- "MasterData"
trainingMode:
type: "boolean"
readOnlyLastSetTimestamp:
type: "integer"
format: "int64"
workstationStatus:
$ref: "#/definitions/com.gk_software.gkr.api.login_manager.dto.WorkstationStatus"
workstationTenderRepositoryStatus:
$ref: "#/definitions/com.gk_software.gkr.api.login_manager.dto.WorkstationTenderRepositoryStatus"
posServerLogoutRequested:
type: "boolean"
useLoginTypeTechnicalForLoginManager:
type: "boolean"
promotionServiceEnabled:
type: "boolean"
packagePricingSession:
$ref: "#/definitions/com.gk_software.package_pricing.pos.api.calculation.PackagePricingSession"
packagePricingServiceEnabled:
type: "boolean"
additionalSessionCriteria_01:
type: "string"
additionalSessionCriteria_02:
type: "string"
dataPrivacyEnabled:
type: "boolean"
posSessionData:
$ref: "#/definitions/com.gk_software.pos.api.session.PosSessionData"
lastServerStatusOnline:
type: "boolean"
tempTransactionBoundCache:
type: "object"
additionalProperties:
type: "object"
retailStore:
$ref: "#/definitions/com.gk_software.gkr.api.server.md.business_unit.dto.dom.BusinessUnitDO"
mainTransaction:
$ref: "#/definitions/PosTransaction"
temoraryPromotionSO:
type: "array"
items:
$ref: "#/definitions/com.gk_software.swee.ses.api.server.md.promotion.dto.so.PromotionSO"
PosTransaction:
type: "object"
properties:
transaction:
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction"
PrepaidInfoType:
type: "object"
properties:
faceValue:
$ref: "#/definitions/Money"
itemId:
type: "string"
quantity:
type: "integer"
format: "int32"
prepaidType:
type: "string"
PrepaidPinRequest:
type: "object"
properties:
uuid:
type: "string"
country:
type: "string"
store:
type: "string"
posNumber:
type: "string"
posTimestamp:
type: "string"
format: "date-time"
voucherNo:
type: "string"
voucherId:
type: "string"
prepaidInfos:
type: "array"
items:
$ref: "#/definitions/PrepaidInfoType"
prepaidTypes:
type: "array"
items:
$ref: "#/definitions/PrepaidType"
PrepaidPinResponse:
type: "object"
properties:
returnCode:
type: "string"
prepaidReturnInfos:
type: "array"
items:
$ref: "#/definitions/PrepaidReturnInfoType"
PrepaidReturnInfoType:
type: "object"
properties:
returnCode:
type: "string"
pinInfos:
type: "array"
items:
$ref: "#/definitions/PinInfoType"
PrepaidType:
type: "object"
properties:
smId:
type: "integer"
format: "int32"
itemId:
type: "string"
providerCode:
type: "string"
resourceId:
type: "string"
PromotionInputResponse:
type: "object"
properties:
promotionInputRequestList:
type: "array"
items:
$ref: "#/definitions/com.gk_software.pos.api.model.dom.app.promotion_input_request.PromotionInputRequest"
startSequence:
type: "integer"
format: "int32"
PromotionValidationResultType:
type: "object"
properties:
value:
type: "string"
RequestedValues:
type: "object"
properties:
payloadEnabled:
type: "boolean"
com.gk_software.gkr.api.layaway.dto.LayawayLineItem:
type: "object"
required:
- "retailTransactionLineItem"
properties:
retailTransactionLineItem:
description: "RetailTransactionLineItem"
$ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem"
description: "LayawayLineItem
"
com.gk_software.gkr.api.login_manager.dto.WorkstationStatus.Key:
type: "object"
required:
- "businessUnitGroupID"
- "sessionID"
- "workstationID"
properties:
businessUnitGroupID:
type: "string"
example: "100000000000000000"
description: "store ID"
workstationID:
type: "string"
description: "workstation ID"
sessionID:
type: "string"
description: "designed for POS server functions - the unique id from special\
\ pool will be generated'0' for POS"
description: "WorkstationStatus.Key Inner class for composite key attributes"
com.gk_software.gkr.api.login_manager.dto.WorkstationTenderRepositoryStatus:
type: "object"
required:
- "exclusiveLevel"
- "key"
- "tenderRepositoryClassType"
properties:
key:
description: "
\tThe responsibility of a sales\
\ organization may include legal liability for products and customer claims.
\tTypical examples of distribution channels are\
\ wholesale, retail, or direct sales.
\tThe lowest level of BusinessUnitGroup is\
\ in a one-to-one relationship with business unit. ie: The lowest level of each\
\ BusinessUnitGroupFunction hierarchy is a BusinessUnitGroup containing one\
\ & only one BusinessUnit.
\tUsed also for\
\ postalCodeOfPOBox.
\tUsed also for district.
\tUsed also for poBox.
\tAlso used for salutation.
"
enum:
- "NO_ROUNDING"
- "ROUND_HALF_UP"
- "ROUND_DOWN"
- "ROUND_UP"
- "ROUND_HALF_DOWN"
roundDecimalCount:
type: "integer"
format: "int32"
description: "
\t
\t
\t\
\t
\t
"
roundPaymentAmount:
type: "number"
format: "double"
description: "
\t
\t
\tUsed also for\
\ postalCodeOfPOBox.
\tUsed also for district.
"
enum:
- "PERSON"
- "ORGANIZATION"
emailAddress:
type: "string"
description: "
\t
\t\
\tThis grouping has no relation with the already\
\ existing tender groups.
"
enum:
- "COIN"
- "NOTE"
- "AMOUNT"
rollAvailableFlag:
type: "boolean"
description: "
\t
\t
\t
\tIf no taxGroupID is delivered, the taxGroup\
\ with 0% is to be searched out and used. If no taxGroup with 0% exists,\
\ the import of the item fails.
\t(00/null - normal, item is taxable, 01 - no tax).
\tAn item's state limits what actions may be taken\
\ on an item in terms of ordering, receiving, selling, returns, transfers,\
\ counting and so on.
\tSample statuses include active, inactive, discontinued,\
\ pending, etc.
\tThis attribute\
\ is used for perishable produce items, drugs, and other time sensitive\
\ items (like newspapers). * e.g. can of peaches
"
baseUOMConsumerPackageNetContent:
type: "number"
format: "double"
description: "
* gross content =\
\ 500
* net content = 385
* contents UOM = ml * base price UOM = g
"
baseUOMConsumerPackageBasePriceContentsUOMCode:
type: "string"
description: "
* base price content\
\ = 100
* base price = 2,99
* ==> base price = 2,99\
\ per 100 g
"
item_XX_CUSTOM_01:
type: "string"
description: "
\t
\t\
* ('10'\
\ for internally generated POS identity with POSItemID = itemID )
"
xx_CUSTOM_01:
type: "string"
description: "
\t
Example - in DB are items where AS_BSNGP_ITM.ID_ITM\
\ = { A001, a001 }
For filtering according to the code of the POS identity.\
\
Search option whether the POS item identifier should be loaded\
\ and filled to provided view. If this flag is set to false the {@link PosUOMItemSearchView#posItemId}\
\ field in the view is always null.
Search option whether the Characteristics should be loaded\
\ and filled to provided view. If this flag is set to false the {@link PosUOMItemSearchView#characteristicViewList}\
\ field in the view is always null.
Filter for Characteristics.
Search option whether the {@link #itemID} should be used\
\ also for searching by Root Item ID in associations. It means that it searches\
\ all item with this root, in other words all child items for requested\
\ item.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Filter for search view.
A unique retailer assigned identifier for the business unit\
\ group
Item number. Alphanumeric key that identifies the item uniquely.
Unit of measure code
The name by which the item is known.
The main POS item identifier
Unit of measure code
Merchandise Hierarchy Group Name
Amount of the price
Formatted price amount. To be filled by clients, not filled\
\ by server
True if the item has an Item Collection.
The POS item identifier. Filled only when the {@link com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemSearchFilter#optionLoadPosIdentity}
\tis set to true.
List of characteristic views.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Simplified view for PosUOMItem.
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemSellingPriceDO.Key" priceExpirationDate: type: "string" example: "2018-05-16T16:09:24.394" description: "Expiration (end) time stamp of the price
Amount of the price
Additional information concerning the price (e.g. campaign\
\ number)
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Selling price
A unique retailer assigned identifier for the business unit\
\ group
Item number. Alphanumeric key that identifies the item uniquely.
Unit of measure code
Type code of price (00 = default price, 01 = special price,\
\ PG = group price)
Effective (start) time stamp of the price
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemText.Key" text: type: "string" description: "Text in the nominated language
A flag to indicate if the text contains a link to the picture\
\ file for this item.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Item text for the specific unit of measure
Text number (number of the row)
Text class (as part of the reference to the text)
A combination of ISO-639-1 and ISO-3661-1 or an own identifier\
\ to denote the language
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.item_wic.dto.dom.WicCategoryDO.Key" wicCategoryDescription: type: "string" description: "Category descriptor.
Subcategory descriptor.
Descriptor for the UOM of the Benefit.
Represents one Wic Category.
Code indicating the eWic Category.
Code indicating the Sub Category of the eWic Category.
State Identifier.
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.party.dto.dom.PartyBankAccount.Key" bankDescription: type: "string" description: "Bank description.
Bank account number in a national format, not international.
Bank identification code in a national format.
International bank account number (IBAN). A standard number\
\ standardized in accordance with the ECBS (European Commitee for Banking\
\ Standards) to represent bank details.
Bank identification code in the international format (BIC).\
\ Uniquely identifies a bank throughout the world.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Information about bank account.
A unique, system assigned identity for a Party.
A unique system assigned identifier for a group of BusinessUnits.
This type code is used to differ between multiple bank accounts.\
\ Optional - if not provided then filled in the import.
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.party.dto.dom.PartyDO.Key" organizationTypeCode: type: "string" description: "The type code of the organization.
The type code of the party.
The 1st line of the description of the business of the customer;\
\ this information is e.g. to be printed on invoices in Greece due to tax\
\ law requirements.
The 2nd line of the description of the business of the customer;\
\ this information is e.g. to be printed on invoices in Greece due to tax\
\ law requirements.
List of PartyRoleAssignment
List of PartyIdentification
List of PartyBankAccount
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
An individual or firm that exchanges information and/or\
\ goods and services with the store.
A unique, system assigned identity for the party.
A unique system assigned identifier for a business unit group.
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.party.dto.dom.PartyIdentification.Key" identifier: type: "string" description: "The number on the Identification that identifies the Party,\
\ e. g. BusinessNumber, SalesTaxNumber..
A retailer assigned code denoting the official body that\
\ issued the PartyIdentification to the Party. Used for information about\
\ customer cards.
Defines why this identifier is locked. Used for information\
\ about customer cards.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
An official number that may be used to identify\
\ the Party. People have multiple forms of such identification: Drivers License\
\ number , Passport number, Credit / Debit Card number, Social Security number,\
\ Tax number, etc... Businesses may also have multiple identifiers to prove\
\ that they are a legal entity: Company Incorporation number, Tax number, etc...
A unique, system assigned identity for the party.
A unique system assigned identifier for a group of BusinessUnits.
A code denoting a form of identification, e. g. BusinessTypeCode,\
\ TaxTypeCode.
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.party.dto.dom.PartyRoleAssignment.Key" xxcustom01: type: "string" description: "Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Temporal record of when the Party became\
\ (and ceased to be) related to the Retail Enterprise via the PartyRole.
A unique, system assigned identity for the party.
A unique system assigned identifier for the business unit\
\ group.
A code that identifies a group of PARTY ROLES. This is used\
\ for subtyping the PARTY ROLEs.
A unique system assigned identifier for the particular assignment\
\ of Party to the PartyRole.
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.person.dto.dom.PersonDO.Key" languageID: type: "string" description: "A combination of ISO-639-1 and ISO-3661-1 to denote a language\
\ as spoken in a particular country.
Extra words that don't form part of the person's name but\
\ are normally printed before the FirstName as a courtesy title. For instance,\
\ Mr. Ms., Miss, Dr., Prof. etc. This represents the primary salutation\
\ for this Person.
A person's first name. In western cultures, this is the given\
\ name, in other cultures it may be the family name.
A person's last name. In western cultures, this is the family\
\ (or patronymic) name, in other cultures it may be the given name.
The year part of the Person's date of birth.
A number in the range 1-12 denoting the month part of the\
\ Person's date of birth.
A number in the range 1-31denoting the day of the month part\
\ of the Person's date of birth.
A code for specifying a person's gender.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
A individual of interest to the retail store or retail\
\ enterprise.
A unique system assigned identifier for a group of business\
\ units.
A unique, system assigned identity for a Party.
The identifier of a contract which was created for a customer\
\ or customer group
Reference to the Item.
The POS Item ID.
The UOM of the Item.
Effective (start) Time Stamp of that price.
Expiration (end) Time Stamp of that price.
The agreed sales unit price for the item.
A unique system assigned identifier for the Customer.
Customer group ID.
The view object which consolidates data from\
\ Price Contract tables.
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.related_item_association_type.dto.dom.RelatedItemAssociationTypeDO.Key" name: type: "string" description: "The name of the association type
A sequential number that indicates the order being used when\
\ displaying the association types in the launchpad function.
The type of the purpose of the item association.
\t\
Values:
* null - default, used for e.g. Variant,\ \ Bundle, Subtype, Ingredient" translationList: type: "array" description: "
* Meal - Component without Alternative\ \ items
* MealAlternative - Component with Alternative items
* Condiment - Condiment component
List of translations
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Translation identifier - used for the unique identification\
\ of translations in the common translation table.
Generated,\
\ not imported.
The type of the association
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.scale_domain.dto.dom.ScaleDomainDO.Key" description: type: "string" description: "Scales domain description
Internal identification of the import package (e.g. IDoc\
\ file). The identification is used for monitoring purposes.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Scale domains are used for grouping scale items,\
\ e.g. meat, cheese, sausages.
The unique identifier of the business unit group.
Scales domain identifier
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO.Key" tenderClassCode: type: "string" description: "A code to denote a group of tenders with common characteristics,\
\ e.g. payment cards, certificates, etc.
Description of the tender type.
The minimum value that can be accepted for an individual\
\ tender. For example, certain retailers will not accept card payments below\
\ $5.
The maximum amount that can be accepted for a specific tender\
\ type.
A flag to signify that specific groups of items cannot be\
\ purchased using certain tender types. For example, food stamps cannot\
\ be used to purchase alcohol or tobacco items.
A flag that signifies that the cash drawer opens if a certain\
\ specific tender type is offered by the customer. For example, cash.
The maximum change that can be offered to a customer for\
\ a specific tender type.
Determines whether the tender should be shown in accounting\
\ functions for tills.
Determines whether denomination is applicable for the tender.
Defines type of tender pickup:
Determines whether change is possible.
Defines if the tender count is registered in accounting functions.
Defines if the tender amount is registered in accounting\
\ functions.
Defines whether a sales transaction which contains this tender\
\ can be voided later.
Determines whether this tender is allowed for deposit.
Determines whether this tender can be used for payment and\
\ accounting.
A typecode to define how a tender is picked up from safe\
\ / delivered to bank:
Determines whether the tender should be shown in safe accounting\
\ functions.
Defines whether payment amount should be entered.
Defines what amount is allowed.
Defines the tender group used by POS payment functions:
This flag determines whether the current value of the tender\
\ in the till is checked.
If this flag is set to true, a warning is shown on POS in\
\ the case that the actual amount of the till for that tender is equal or\
\ larger than the PickupWarningLimit
Defines the limit for a tender pickup from the till, see\
\ also PickupWarningFlag
Defines whether this tender can be voided during the tender\
\ registration process (i.e. while the transaction is not finished yet)
Additional tender description which is used on POS side.
Defines whether this tender can be used only exclusively,\
\ i.e. no other tenders can be combined with it in one transaction.
Determines whether the tender can be used only for sales,\
\ only for returns, or for both:
Sort sequence for tenders in reports and backoffice functions.
Determines whether this tender will be counted for safe.
Determines whether for this tender will be printed sales\
\ receipt:
Determines whether negative values can be input; is used\
\ in the context of foreign turnover registration.
A typecode to signify that only a specific group of items\
\ can be purchased using this tender.
\tPossible values:
Determines whether the tender amount has to be rounded according\
\ to the rounding rules of the main currency
Reference to the tender handling rule (tender fields additional\
\ to ARTS)
List of tender restriction rules.
List of translations for the tender.
Internal identification of the import package (e.g. IDoc\
\ file). The identification is used for monitoring purposes.
The identifier of the currency used for the tender.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Translation identifier - used for the unique identification\
\ of translations in the common translation table.
Tender includes all the forms of payment that are accepted\
\ by the retail store in settling sales and other transactions.
A unique system assigned identifier for a group of business\
\ units.
A code which uniquely identifies the type of tender, e.g.\
\ cash, check, payment card, etc.
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderRestrictionRule.Key" xxcustom01: type: "string" description: "Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Describes in which situations which tenders\
\ are forbidden
A unique system assigned identifier for a group of business\
\ units.
A code which uniquely identifies the type of tender, ie cash,\
\ check, credit card, etc.
Transaction type;
\t0 = irrelevant (tender is forbidden\
\ for any transaction type)
Position type;
\t0 = irrelevant (tender is forbidden\
\ for any position type)
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender_rule.dto.dom.TenderAdjustmentRuleDO.Key" packageID: type: "string" example: "100000000000000000" description: "Internal identification of the import package (e.g. IDoc\
\ file). The identification is used for monitoring purposes.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Possible transformations from one tender\
\ to another.
A unique system assigned identifier for a group of business\
\ units.
Tender from which is to be transformed.
Tender to which is to be transformed.
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.till.dto.dom.TillDO.Key" defaultOpeningCashBalanceAmount: type: "number" format: "double" description: "The opening Tender balance with which the Till will typically\
\ start.
Determines whether function 'loan' requires counting the\
\ cash money and registering the counted amount, or whether counting is\
\ skipped and the default amount is used
Determines whether the loan function should be used
Determines whether the till is locked
The barcode of the till
The assignment mode which is used for that till
ID of the workstation. It is only filled if till is assigned\
\ to workstation.
The list operators that are allowed to use the till.
Determines how the till is to be cleared
Defines the settlement mode
Internal identification of the import package (e.g. IDoc\
\ file). The identification is used for monitoring purposes.
Determines whether the till is used for education.
date and time of the till status
TODO
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Tills
The unique identifier for the till.
A unique system assigned identifier for a group of business\
\ units.
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.till.dto.dom.TillOperatorDO.Key" packageID: type: "string" example: "100000000000000000" description: "Internal identification of the import package (e.g. IDoc\
\ file). The identification is used for monitoring purposes.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Allowed operators
Identifier of the operator
A unique system assigned identifier for a group of business\
\ units.
The unique identifier for the till.
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.time_group.dto.dom.TimePeriod.Key" dayOfWeek: type: "string" description: "A 2 character code denoting the day of the week that the\
\ time period falls on.
The time of day that the time period commences.
The duration included in the time period from the start time.
The time restriction in cron format.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Time periods.
A unique system assigned identifier for a group of business\
\ units.
Internal generated ID for time period.
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.worker.dto.dom.WorkerDO.Key" partyID: type: "string" example: "100000000000000000" description: "A unique, system assigned identity for a party.
Personal information
Contact
List of the discount groups assigned to the employee.
Origin of the import
Internal identification of the import package (e.g. IDoc\
\ file). The identification is used for monitoring purposes.
TaxID of the sales representative
The worker level in worker hierarchy. Used for security purposes\
\ - if a worker can maintain or see (GDPR) another user.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
A person who provides services to a retail store. May\
\ be either an employee or a contractor.
A unique system assigned identifier for a group of business\
\ units.
A unique system-assigned identifier for the person who is\
\ a particular worker.
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.worker.dto.dom.WorkerDiscountGroupAssignment.Key" xxcustom01: type: "string" description: "Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
A group of employees who share\
\ the same employee discount privilege.
The unique identifier of the business unit group.
The identifier for a specific employee discount group.
A unique system-assigned identifier for the person who is\
\ a particular worker.
Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.tco.dto.TillCopyObjectEntry.Key" foreignCurrencyAmount: type: "number" format: "double" description: "Target value of the tender" amount: type: "number" format: "double" description: "Target value of the tender in main currency" mediaUnitQuantity: type: "integer" format: "int32" description: "Target value of the tender" xxcustom01: type: "string" description: "Standard extension pattern for extending object in project" xxcustom02: type: "string" description: "Standard extension pattern for extending object in project" xxcustom03: type: "string" description: "Standard extension pattern for extending object in project" xxcustom04: type: "string" description: "Standard extension pattern for extending object in project" xxcustom05: type: "string" description: "Standard extension pattern for extending object in project" description: "TillCopyObjectEntryGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.AdditionalBonusDiscountLineItem.Key" promotionID: type: "string" example: "100000000000000000" description: "The unique identifier for a promotion." priceDerivationRuleID: type: "string" example: "100000000000000000" description: "A identifier for a specific price derivation rule." priceDerivationRuleEligibilityID: type: "string" example: "100000000000000000" description: "A unique identifier for a Price Derivation Rule Eligibility." additionalBonusID: type: "string" description: "The ident of the additional bonus. This is needed by PCE in\ \ order to establish a relationship between additional bonus items being\ \ provided to it in the request as additional bonus line items on the one\ \ hand and the corresponding promotion price derivation rules of type 'additional\ \ bonus' on the other hand." itemID: type: "string" description: "Reference to BusinessUnitGroupItem" unitOfMeasureCode: type: "string" description: "The UOM of the Item" merchandiseHierarchyGroupIDQualifier: type: "string" description: "Qualifier which is used to differ between MerchandiseHierarchyGroup's\ \ belonging to different functions but having the same id" merchandiseHierarchyGroupID: type: "string" description: "Unique system assigned identifier for a group or class of merchandise." merchandiseSetGroupID: type: "string" example: "100000000000000000" description: "System-generated unique identifier for a merchandise set (group\ \ of mechandise set elements). This is needed for technical reasons." merchandiseSetID: type: "string" example: "100000000000000000" description: "Unique (within the context of the merchandise set) system-generated\ \ identifier of the mechandise set element" totalAdditionalBonusQuantity: type: "number" format: "double" description: "Denotes the total additional bonus quantity that should be granted.\ \ Is 0 in case the AdditionalBonusDiscountLineItem does not belong to any\ \ applied promotion." quantityDifference: type: "number" format: "double" description: "Denotes the difference between TotalAdditionalBonusQuantity\ \ and the additional bonus items being present in the transaction (total\ \ quantity of sale return line items of type 'additional bonus' with concerning\ \ AdditionalBonusLineItem.AdditionalBonusID).positive value - there are\ \ not enough additional bonus items in the transaction providednegative\ \ value - there are too many additional bonus items in transaction provided0\ \ value - match" xxcustom06: type: "string" description: "Customizable information" xxcustom07: type: "string" description: "Customizable information" xxcustom08: type: "string" description: "Customizable information" xxcustom09: type: "string" description: "Customizable information" xxcustom10: type: "string" description: "Customizable information" xxcustom11: type: "string" description: "Customizable information" xxcustom12: type: "string" description: "Customizable information" xxcustom13: type: "string" description: "Customizable information" xxcustom14: type: "string" description: "Customizable information" xxcustom15: type: "string" description: "Customizable information" xxcustom16: type: "string" description: "Customizable information" xxcustom17: type: "string" description: "Customizable information" xxcustom18: type: "string" description: "Customizable information" xxcustom19: type: "string" description: "Customizable information" xxcustom20: type: "string" description: "Customizable information" xxcustom21: type: "string" description: "Customizable information" xxcustom22: type: "string" description: "Customizable information" xxcustom23: type: "string" description: "Customizable information" xxcustom24: type: "string" description: "Customizable information" xxcustom25: type: "string" description: "Customizable information" xxcustom26: type: "string" description: "Customizable information" xxcustom27: type: "string" description: "Customizable information" xxcustom28: type: "string" description: "Customizable information" xxcustom29: type: "string" description: "Customizable information" xxcustom30: type: "string" description: "Customizable information" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "AdditionalBonusDiscountLineItemGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.AdditionalBonusLineItem.Key" additionalBonusID: type: "string" description: "The ident of the additional bonus. This is needed by PCE in\ \ order to find the corresponding promotion price derivation rules of type\ \ 'additional bonus'." xxcustom06: type: "string" description: "Customizable information" xxcustom07: type: "string" description: "Customizable information" xxcustom08: type: "string" description: "Customizable information" xxcustom09: type: "string" description: "Customizable information" xxcustom10: type: "string" description: "Customizable information" xxcustom11: type: "string" description: "Customizable information" xxcustom12: type: "string" description: "Customizable information" xxcustom13: type: "string" description: "Customizable information" xxcustom14: type: "string" description: "Customizable information" xxcustom15: type: "string" description: "Customizable information" xxcustom16: type: "string" description: "Customizable information" xxcustom17: type: "string" description: "Customizable information" xxcustom18: type: "string" description: "Customizable information" xxcustom19: type: "string" description: "Customizable information" xxcustom20: type: "string" description: "Customizable information" xxcustom21: type: "string" description: "Customizable information" xxcustom22: type: "string" description: "Customizable information" xxcustom23: type: "string" description: "Customizable information" xxcustom24: type: "string" description: "Customizable information" xxcustom25: type: "string" description: "Customizable information" xxcustom26: type: "string" description: "Customizable information" xxcustom27: type: "string" description: "Customizable information" xxcustom28: type: "string" description: "Customizable information" xxcustom29: type: "string" description: "Customizable information" xxcustom30: type: "string" description: "Customizable information" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "AdditionalBonusLineItemGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.CheckTenderLineItem.Key" fullMICR: type: "string" description: "The complete string of characters read from the MICR (Magnetic\ \ Ink Character Recognition) strip.Content varies by Country and/or Financial\ \ Institution but it usually contains BankID, CheckAccountNumber and CheckSequenceNumber\ \ - but there may be more data encoded in the MICR." checkSequenceNumber: type: "integer" format: "int32" description: "A unique sequence number relating to a particular check authorization." adjudicationCode: type: "string" description: "A code to denote that approval has been received from the authorization\ \ center." checkCardNumber: type: "string" description: "The number from a bank issued card guaranteeing checks up to\ \ a certain value." bankID: type: "string" description: "The unique identifier of the bank or third party authorization\ \ center." checkAccountNumber: type: "string" description: "The check account number" bankIdentifierCode: type: "string" description: "Bank Identifier Code. Also known as SWIFT Code." internationalBankAccountNumber: type: "string" description: "International Bank Account Number" checkNumber: type: "string" description: "A unique sequence number relating to a particular check authorization." xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "CheckTenderLineItemGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.CompleteTransaction.Key" correlatedToList: type: "array" description: "List of transactions that influence meaning of of the transaction" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" onlineChecked: type: "boolean" description: "True if this transaction state was checked against central service.False\ \ means that the state might not be quite right, but we optimisticallyallow\ \ client to continue." checksum: type: "string" description: "Checksum of correlated transactions, to be used while construction\ \ correlation attributes" description: "CompleteTransactionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.ControlTransaction.Key" typeCode: type: "string" description: "A code that describes the type of control transaction." fuelingTransaction: description: "data for fuel" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.FuelingTransaction" posnoSaleTransactionList: type: "array" description: "data for no sale transactions" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.POSNoSaleTransaction" signOnTransactionList: type: "array" description: "data for sign on transactons" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SignOnTransaction" signOffTransactionList: type: "array" description: "data for sign off transactons" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SignOffTransaction" tillTenderSettlementTransactionList: type: "array" description: "data for till tender settlements" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TillTenderSettlementTransaction" depositBagTransactionList: type: "array" description: "data for safebag status changes" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.DepositBagTransaction" storeSafeSettlementTransactionList: type: "array" description: "data for store safe tender settlements" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.StoreSafeSettlementTransaction" depositBagSettlementTransactionList: type: "array" description: "data for safebag settlements" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.DepositBagSettlementTransaction" taxRefundTransactionList: type: "array" description: "data for tax refund" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TaxRefundTransaction" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "ControlTransactionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.DepositBagSettlementTenderDenomination.Key" typeCode: type: "string" description: "The denomination type code" pieceValue: type: "number" format: "double" description: "Piece value\_" rollFlag: type: "boolean" description: "Determines whether the DenominationCount value is expressed\ \ in coin rolls (true) or single coins/notes (false)" rollCapacity: type: "number" format: "double" description: "Count of coins in the roll\_" denominationCount: type: "number" format: "double" description: "The count of the denomination" denominationAmount: type: "number" format: "double" description: "The total amount of the denomination" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "DepositBagSettlementTenderDenominationGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.DepositBagSettlementTenderDetail.Key" tenderDescription: type: "string" description: "Description of the tender" tenderClassCode: type: "string" description: "The tender class code from master data" currencySymbol: type: "string" description: "The currency symbol" exchangeRate: type: "number" format: "double" description: "The quantitative conversion factor between foreign currency\ \ and local currency.\_Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.DepositBagSettlementTransaction.Key" depositBagID: type: "string" description: "Automatically generated (with another algorithm like reference\ \ number in bank payment) unique Safebag ID." depositBagNumber: type: "string" description: "Safe bag number entered by operator that was used to transport\ \ the Tender from the Safe to the ExternalDepository." depositBagSettlementTenderDetailList: type: "array" description: "tender details" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.DepositBagSettlementTenderDetail" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "DepositBagSettlementTransactionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.DepositBagTransaction.Key" depositBagID: type: "string" description: "automatically generated (with another algorithm like reference\ \ number in bank payment) unique Safebag ID" depositBagNumber: type: "string" description: "Safe bag number entered by operator that was used to transport\ \ the Tender from the Safe to the ExternalDepository." xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "DepositBagTransactionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.FrequentShopperPointsModifier.Key" promotionID: type: "string" example: "100000000000000000" description: "The unique identifier of the promotion." priceDerivationRuleID: type: "string" example: "100000000000000000" description: "The unique identifier of the price derivation rule.\_" priceDerivationRuleEligibilityID: type: "string" example: "100000000000000000" description: "The unique identifier of the root eligibility." triggerSequenceNumber: type: "integer" format: "int32" description: "The ident of the manual trigger (because one line item can have\ \ more than one trigger)\_" eligibilityTypeCode: type: "string" description: "The type code of the root eligibility" frequentShopperPointsEarnedCount: type: "number" format: "double" description: "The number of frequent shopper points earned\_" frequentShopperPointsEarnedAmount: type: "number" format: "double" description: "The money equivalent (expressed in local currency) to the number\ \ of frequent shopper points earned\_" appliedQuantity: type: "number" format: "double" description: "The quantity the points' modifier applies to\_" computationBaseAmount: type: "number" format: "double" description: "The amount which was used as base for the points' calculation" externalSystemOriginatorFlag: type: "boolean" description: "Determines whether this entry was created by an external system\ \ - if yes, it must not be changed, but own price modifications with higher\ \ sequence may be applied\_" prorateFrom: type: "integer" format: "int32" description: "The sequence number of the LoyaltyRewardLineItem.Only filled\ \ for point shares of transaction related points discounts." pointsPercentage: type: "number" format: "double" description: "The points calculation rule to be applied, expressed as a percentage\ \ of the calculation base. Corresponds to ItemPriceDerivationRule.PriceModificationPercent\ \ if available.Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.FuelSalesLineItem.Key" fuelSaleStatusCode: type: "string" description: "A status code denoting the mode of the Fuel Sale. Possible values\ \ are:Prepay: Where the FuelSaleLineItem happens before the FuelingTransactionPostPay:\ \ Where the FuelSaleLineItem happens after the Fueling TransactionPrepayRefund:\ \ Where the FuelSaleLineItem happens after a Prepay FuelSaleLineItem and\ \ the matching FuelingTransaction did not use all of the money" fuelGradeID: type: "string" description: "A unique system assigned identifier for the retailer's itemID\ \ (values between 01-99)" unitPrice: type: "number" format: "double" description: "The price per volume unit charged by the FUELING POINT for the\ \ fuel delivered in the FUELING TRANSACTION" fuelingPointID: type: "string" example: "100000000000000000" description: "A unique identifier for the FuelingPoint at a particular business\ \ unit group" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "FuelSalesLineItemGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.FuelingTransaction.Key" itemID: type: "string" description: "Reference to the Item" fuelingPointID: type: "string" example: "100000000000000000" description: "A unique identifier for the FuelingPoint at a particular BusinessUnitGroup" nozzleID: type: "string" example: "100000000000000000" description: "A unique identifier for the Nozzle" typeCode: type: "string" description: "A two charcter code denoting the type of FuelingTransactionEvent\ \ being recorded.Possible values includePostPay: Where the FuelingTransaction\ \ is yet to be sold by a FuelSalesLineItem in a RetailTransactionPrePayCompletion:\ \ Where money has been collected for the FuelingTransaction in a previous\ \ FuelSalesLineItem and there is no refund required.PrePayRefund: Where\ \ too much money was collected for the FuelingTransaction in a previous\ \ FuelSalesLineItem, and a further FuelSalesLineItem in a RetailTransaction\ \ is required to deal with the refund." timeStamp: type: "string" example: "2018-05-16T16:09:24.394" description: "The date & time of the completion of the fueling transaction;\ \ Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" timeStampUTC0: type: "string" format: "date-time" example: "2018-05-16T09:24:00+01:00" description: "The date & time of the completion of the fueling transaction\ \ (UTC0); UTC0 date format 'yyyy-MM-dd'T'HH:mm:ss.SSSZ' (with timezone)" volume: type: "number" format: "double" description: "The volume of fuel delivered in the fueling transaction." unitPrice: type: "number" format: "double" description: "The price per volume unit charged by the FUELING POINT for the\ \ fuel delivered in the FUELING TRANSACTION" authorizationElapsedTime: type: "number" format: "double" description: "The number of milli-seconds elapsed between CUSTOMER lifting\ \ NOZZLE and FUELING TRANSACTION commencingGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.GiftCertificateLineItem.Key" giftCertificateHandlingTypeCode: type: "string" description: "The type code of gift certificate that defines handling rules\ \ for it" giftCertificateTypeCode: type: "string" description: "Identifies a gift certificate type. Corresponds to GiftCertificateClass.GiftCertificateTypeCode\_" bookingSuccessfulTypeCode: type: "string" description: "Determines whether the transaction amount was successfully posted\ \ to the Stored Value Server. Stays null in case that this information is\ \ not relevant for the current gift certificate line item\_" bookingCancellationTypeCode: type: "string" description: "Determines whether a cancellation was successfully posted to\ \ the Stored Value Server.Stays null in case that this information is not\ \ relevant for the current gift certificate line item\_" externalSystemAdapterName: type: "string" description: "The name of the adapter of the involved external system" expirationDate: type: "string" example: "2018-05-16T16:09:24.394" description: "The expiration date of the gift certificate\_; Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" remainingBalance: type: "number" format: "double" description: "The remaining balance of the gift certificate\_" giftCertificateSerialNumber: type: "string" description: "The serial number that uniquely identifies a GIFT CERTIFICATE." gcstransactionUUID: type: "string" description: "The gift certificate server transaction ID\_" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "GiftCertificateLineItemGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.LineItemAssociate.Key" workerID: type: "string" description: "A unique system-assigned identifier for the Person who is a\ \ particular Worker.\_" actionDatetime: type: "string" example: "2018-05-16T16:09:24.394" description: "The date and time that the associate performed the action for\ \ which a commission is payable.\_; Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" workerFirstName: type: "string" description: "The first name of the worker who served the customer\_" workerLastName: type: "string" description: "The last name of the worker who served the customer\_" actionDatetimeUTC0: type: "string" format: "date-time" example: "2018-05-16T09:24:00+01:00" description: "The UTC0 date and time that the associate performed the action\ \ for which a commission is payable.\_; UTC0 date format 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'\ \ (with timezone)" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "LineItemAssociateGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.LoyaltyRewardLineItem.Key" pointsAwardedCount: type: "number" format: "double" description: "The number of loyalty points awarded.\_Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.LoyaltyRewardLineItemCouponSerial.Key" couponSerialNumber: type: "string" description: "The coupon serial number" bookingSuccessfulTypeCode: type: "string" description: "Determines whether the coupon redemption was successfully posted\ \ to the Couponing Service.Stays null in case that no Couponing Service\ \ is used.\_" bookingTransactionUUID: type: "string" description: "The couponing service transaction ID\_" xxcustom06: type: "string" description: "Customizable information" xxcustom07: type: "string" description: "Customizable information" xxcustom08: type: "string" description: "Customizable information" xxcustom09: type: "string" description: "Customizable information" xxcustom10: type: "string" description: "Customizable information" xxcustom11: type: "string" description: "Customizable information" xxcustom12: type: "string" description: "Customizable information" xxcustom13: type: "string" description: "Customizable information" xxcustom14: type: "string" description: "Customizable information" xxcustom15: type: "string" description: "Customizable information" xxcustom16: type: "string" description: "Customizable information" xxcustom17: type: "string" description: "Customizable information" xxcustom18: type: "string" description: "Customizable information" xxcustom19: type: "string" description: "Customizable information" xxcustom20: type: "string" description: "Customizable information" xxcustom21: type: "string" description: "Customizable information" xxcustom22: type: "string" description: "Customizable information" xxcustom23: type: "string" description: "Customizable information" xxcustom24: type: "string" description: "Customizable information" xxcustom25: type: "string" description: "Customizable information" xxcustom26: type: "string" description: "Customizable information" xxcustom27: type: "string" description: "Customizable information" xxcustom28: type: "string" description: "Customizable information" xxcustom29: type: "string" description: "Customizable information" xxcustom30: type: "string" description: "Customizable information" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "LoyaltyRewardLineItemCouponSerialGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.POSNoSaleTransaction.Key" tillID: type: "string" example: "100000000000000000" description: "The unique identifier of the till" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "POSNoSaleTransactionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.PrepaidLineItem.Key" bookingSuccessfulTypeCode: type: "string" description: "Determines whether the prepaid transaction was confirmed. Stays\ \ null in case that this information is not relevant for the current prepaid\ \ line item\_" prepaidProviderName: type: "string" description: "The name of the provider of the prepaid service\_" prepaidTransactionID: type: "string" description: "The prepaid transaction ID\_" externalSystemAdapterName: type: "string" description: "The name of the adapter of the involved external system" prepaidID: type: "string" description: "The ident of the prepaid PIN. The PIN itself must not be stored.\ \ The prepaid ident is needed for support purposes.\_" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "PrepaidLineItemGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.PriceModificationLineItem.Key" promotionID: type: "string" example: "100000000000000000" description: "The unique identifier of the promotion." priceDerivationRuleID: type: "string" example: "100000000000000000" description: "The unique identifier of the price derivation rule.\_" priceDerivationRuleEligibilityID: type: "string" example: "100000000000000000" description: "The unique identifier of the root eligibility." percentage: type: "number" format: "double" description: "The percentage value in case of percentage price modifiers.Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailPriceModifier.Key" promotionID: type: "string" example: "100000000000000000" description: "The unique identifier of the promotion." priceDerivationRuleID: type: "string" example: "100000000000000000" description: "The unique identifier of the price derivation rule.\_" priceDerivationRuleEligibilityID: type: "string" example: "100000000000000000" description: "The unique identifier of the root eligibility." reasonCode: type: "string" description: "The reason code for manual price overrides." previousPrice: type: "number" format: "double" description: "The unit price that was valid before manual price override.Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransaction.Key" retailTransactionTypeCode: type: "string" description: "A retailer assigned code denoting a type of RetailTransaction.\_" tillID: type: "string" example: "100000000000000000" description: "The unique identifier of the till" receiptDateTime: type: "string" example: "2018-05-16T16:09:24.394" description: "The date and time when the receipt for this transaction was\ \ printed.\_; Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" receiptPrintoutFlag: type: "boolean" description: "Determines whether for this sales transaction a receipt was\ \ printed\_" promotionTimestamp: type: "string" example: "2018-05-16T16:09:24.394" description: "The timestamp used for promotion validity checks and calculation\_\ ; Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" frequentShopperLostPointsCount: type: "number" format: "double" description: "The number of frequent shopper points that HAD been awarded\ \ for the purchase in case the customer HAD presented a loyalty cardGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionCouponSerialSummary.Key" bookingSuccessfulTypeCode: type: "string" description: "Determines whether the coupon redemption was successfully posted\ \ to the Couponing Service.Stays null in case that no Couponing Service\ \ is used.\_" bookingTransactionUUID: type: "string" description: "The couponing service transaction ID\_" expirationTimestamp: type: "string" example: "2018-05-16T16:09:24.394" description: "The last date and time when the coupon is effective\_; Date\ \ format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" expirationTimestampUTC0: type: "string" format: "date-time" example: "2018-05-16T09:24:00+01:00" description: "The last date and time in UTC0 format when the coupon is effective;\ \ UTC0 date format 'yyyy-MM-dd'T'HH:mm:ss.SSSZ' (with timezone)" appliedFlag: type: "boolean" description: "Defines if the coupon serial triggered a promotion price derivation\ \ rule." xxcustom06: type: "string" description: "Customizable information" xxcustom07: type: "string" description: "Customizable information" xxcustom08: type: "string" description: "Customizable information" xxcustom09: type: "string" description: "Customizable information" xxcustom10: type: "string" description: "Customizable information" xxcustom11: type: "string" description: "Customizable information" xxcustom12: type: "string" description: "Customizable information" xxcustom13: type: "string" description: "Customizable information" xxcustom14: type: "string" description: "Customizable information" xxcustom15: type: "string" description: "Customizable information" xxcustom16: type: "string" description: "Customizable information" xxcustom17: type: "string" description: "Customizable information" xxcustom18: type: "string" description: "Customizable information" xxcustom19: type: "string" description: "Customizable information" xxcustom20: type: "string" description: "Customizable information" xxcustom21: type: "string" description: "Customizable information" xxcustom22: type: "string" description: "Customizable information" xxcustom23: type: "string" description: "Customizable information" xxcustom24: type: "string" description: "Customizable information" xxcustom25: type: "string" description: "Customizable information" xxcustom26: type: "string" description: "Customizable information" xxcustom27: type: "string" description: "Customizable information" xxcustom28: type: "string" description: "Customizable information" xxcustom29: type: "string" description: "Customizable information" xxcustom30: type: "string" description: "Customizable information" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionCouponSerialSummaryGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionCouponSummary.Key" inputCount: type: "number" format: "double" description: "Count of registered coupons\_" appliedCount: type: "number" format: "double" description: "Number of used coupons\_Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionCustomer.Key" genderType: type: "string" description: "A code for specifying a persons gender.\_" birthDayNumber: type: "integer" format: "int32" description: "A number in the range 1-31denoting the day of the month part\ \ of the Person's date of birth.\_" birthMonthNumber: type: "integer" format: "int32" description: "A number in the range 1-12 denoting the month part of the Person's\ \ date of birth.\_" birthYearNumber: type: "integer" format: "int32" description: "The year part of the Person's date of birth.\_" addressTypeDescription: type: "string" description: "The description of the customer type code" genericFlag: type: "boolean" description: "If true, the customer is a dummy/unknown customer\_" businessDescription: type: "string" description: "The description of the business of the customer; this information\ \ is e.g. to be printed on invoices in Greece due to tax law requirements\_" customerIDEntryMethodCode: type: "string" description: "A code that describes how this customer's identification is\ \ being entered (e.g. it is scanned, keyed, etc.)\_" firstName: type: "string" description: "A person's first name." lastName: type: "string" description: "A person's last name." preferredReceiptPrintoutTypeCode: type: "string" description: "Defines the preferred printout settings for the customer" parentCustomerID: type: "string" description: "Number of the customer to which this buyer / contact person\ \ belongs." parentCustomerName1: type: "string" description: "First name line of the customer to which this buyer / contact\ \ person belongs." parentCustomerName2: type: "string" description: "Second name line of the customer to which this buyer / contact\ \ person belongs." retailTransactionCustomerAccountList: type: "array" description: "list of customer accounts" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionCustomerAccount" retailTransactionCustomerGroupAssignmentList: type: "array" description: "list of customer groups" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionCustomerGroupAssignment" retailTransactionCustomerContactMethodList: type: "array" description: "list of contact methods (address, phone, mail, ...)" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionCustomerContactMethod" retailTransactionCustomerIdentificationList: type: "array" description: "list of customer identitfication numbers" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionCustomerIdentification" organizationName: type: "string" description: "An ORGANIZATION's legal trade name." xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionCustomerGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionCustomerAccount.Key" customerAccountID: type: "string" description: "The customer account number\_" customerAccountTypeCode: type: "string" description: "Determines what kind of customer account this is." customerAccountBalance: type: "number" format: "double" description: "The current balance of the customer account\_" customerAccountQuerySuccessfulFlag: type: "boolean" description: "Determines whether the request of customer account data was\ \ completed successfully\_" customerAccountTransactionID: type: "string" description: "The external ident of the accounting transaction of the the\ \ customer account" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionCustomerAccountGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionCustomerContactMethod.Key" contactTypeCode: type: "string" description: "Describes the type of contact. Possible values include e-mail\ \ address, address, telephone, internet URL.\_" emailAddressLocalPart: type: "string" description: "The local-part portion is a domain-dependent string. In addresses,\ \ it is simply interpreted on the particular host as a name of a particular\ \ mailbox.\_" emailAddressDomainPart: type: "string" description: "The domain portion identifies the point to which the mail is\ \ delivered. In the dot-atom form, this is interpreted as an Internet domain\ \ name (either a host name or a mail exchanger name) as described in [RFC1034],\ \ [RFC1035], and [RFC1123]. In the domain-literal form, the domain is interpreted\ \ as the literal Internet address of the particular host. In both cases,\ \ how addressing is used and how messages are transported to a particular\ \ host is covered in separate documents, such as [RFC5321].\_" completePhoneNumber: type: "string" description: "The complete telephone number including the CountryCode, AreaCode,\ \ Telephone Number and ExtensionNumber.\_" internetURL: type: "string" description: "The internet URL" addressLine1: type: "string" description: "The first line of the address, normally the street number and\ \ name.\_" addressLine2: type: "string" description: "The second line of an address, normally the Flat or Building\ \ Suite number.\_" addressLine3: type: "string" description: "The third line of the address.\_" addressLine4: type: "string" description: "The fourth line of the address.\_" addressLine5: type: "string" description: "The fifth line of the address. It is normally used for the salutation.\_" city: type: "string" description: "The city, town or village component of the address\_" subTerritoryName: type: "string" description: "This field is used to specify the territory or city more concrete,\ \ for example for storing the district or suburb of a certain city.\_" postalCode: type: "string" description: "The postal or zip code of the address\_" postalCodeExtension: type: "string" description: "The extension of the postal or zip code that further specifies\ \ a particular postal district.\_" territory: type: "string" description: "The County, State, Province, Territory etc component of the\ \ address\_" territoryName: type: "string" description: "The name of the County, State, Province, Territory etc. component\ \ of the address\_" isocountryCode: type: "string" description: "The ISO-3166-1 two letter code of the country" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionCustomerContactMethodGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionCustomerGroupAssignment.Key" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionCustomerGroupAssignmentGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionCustomerIdentification.Key" identifier: type: "string" description: "The number or character sequence on the identification that\ \ identifies the party." xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionCustomerIdentificationGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionExternalTrigger.Key" triggerAmount: type: "number" format: "double" description: "The value (amount). Its type is determined by TriggerTypeCode." xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionExternalTriggerGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionGenericAttribute.Key" genericAttributeKey: type: "string" description: "The key of the generic attribute.The key may not be unique in\ \ the scope of the transaction." genericAttributeValue: type: "string" description: "The value of the generic attribute." customFlag: type: "boolean" description: "Indicates whether the generic attribute is custom (project-specific)\ \ or was added as an internal attribute for the product. This flag controls\ \ whether this generic attribute is considered in checking the configured\ \ limit (true) or not (false)." xxcustom06: type: "string" description: "Customizable information" xxcustom07: type: "string" description: "Customizable information" xxcustom08: type: "string" description: "Customizable information" xxcustom09: type: "string" description: "Customizable information" xxcustom10: type: "string" description: "Customizable information" xxcustom11: type: "string" description: "Customizable information" xxcustom12: type: "string" description: "Customizable information" xxcustom13: type: "string" description: "Customizable information" xxcustom14: type: "string" description: "Customizable information" xxcustom15: type: "string" description: "Customizable information" xxcustom16: type: "string" description: "Customizable information" xxcustom17: type: "string" description: "Customizable information" xxcustom18: type: "string" description: "Customizable information" xxcustom19: type: "string" description: "Customizable information" xxcustom20: type: "string" description: "Customizable information" xxcustom21: type: "string" description: "Customizable information" xxcustom22: type: "string" description: "Customizable information" xxcustom23: type: "string" description: "Customizable information" xxcustom24: type: "string" description: "Customizable information" xxcustom25: type: "string" description: "Customizable information" xxcustom26: type: "string" description: "Customizable information" xxcustom27: type: "string" description: "Customizable information" xxcustom28: type: "string" description: "Customizable information" xxcustom29: type: "string" description: "Customizable information" xxcustom30: type: "string" description: "Customizable information" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionGenericAttributeGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem.Key" externalCustomerOrderID: type: "string" description: "An external identifier for the related customer order." customerOrderSequenceNumber: type: "integer" format: "int32" description: "A unique system assigned identifier for the LineItem of the\ \ CustomerOrder.\_" beginDateTimestamp: type: "string" example: "2018-05-16T16:09:24.394" description: "The start time of the RETAIL TRANSACTION line item.\_; Date\ \ format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" voidFlag: type: "boolean" description: "A boolean indicator that tells if this line item is VOIDED or\ \ not." endDateTimestamp: type: "string" example: "2018-05-16T16:09:24.394" description: "The end time of the RETAIL TRANSACTION line item.\_; Date format\ \ 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" entryMethodCode: type: "string" description: "A retailer assigned code to denote how the RetailTransactionLineItem\ \ was entered at the Workstation. It is filled just for retail transaction\ \ line item." retailTransactionLineItemTypeCode: type: "string" description: "A code to denote the type of retail transaction line item, such\ \ as Sale/Return, Void, Tender ..." voidTypeCode: type: "string" description: "Describes whether the line item was voided immediately after\ \ registering it, voided by another line item or internally voided\_" workstationID: type: "string" description: "id of the workstation where the line item was created" workstationTypeCode: type: "string" description: "type of the workstation where the line item was created" keyedOfflineCode: type: "string" description: "A code that indicates the online/offline state when transaction\ \ was completed." beginDateTimestampUTC0: type: "string" format: "date-time" example: "2018-05-16T09:24:00+01:00" description: "The UTC0 start time of the RETAIL TRANSACTION line item.\_;\ \ UTC0 date format 'yyyy-MM-dd'T'HH:mm:ss.SSSZ' (with timezone)" endDateTimestampUTC0: type: "string" format: "date-time" example: "2018-05-16T09:24:00+01:00" description: "The UTC0 end time of the RETAIL TRANSACTION line item.\_; UTC0\ \ date format 'yyyy-MM-dd'T'HH:mm:ss.SSSZ' (with timezone)" retailTransactionLineItemAssociationList: type: "array" description: "list of line item associations" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemAssociation" retailTransactionLineItemAdditionalParameterList: type: "array" description: "list of additional parameters" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemAdditionalParameter" retailTransactionLineItemBinaryDataList: type: "array" description: "list of binary data" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemBinaryData" retailTransactionLineItemI18NTextList: type: "array" description: "list of translations for line item texts" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemI18NText" retailTransactionLineItemResourceOverrideList: type: "array" description: "list of data for line item related authorizations" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemResourceOverride" retailTransactionLineItemExtensionList: type: "array" description: "list of line item extensions" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemExtension" retailTransactionLineItemAuditEventList: type: "array" description: "list of line item audit events" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemAuditEvent" xxcustom06: type: "string" description: "Customizable information" xxcustom07: type: "string" description: "Customizable information" xxcustom08: type: "string" description: "Customizable information" xxcustom09: type: "string" description: "Customizable information" xxcustom10: type: "string" description: "Customizable information" xxcustom11: type: "string" description: "Customizable information" xxcustom12: type: "string" description: "Customizable information" xxcustom13: type: "string" description: "Customizable information" xxcustom14: type: "string" description: "Customizable information" xxcustom15: type: "string" description: "Customizable information" saleReturnLineItemList: type: "array" description: "sale return line item" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SaleReturnLineItem" tenderLineItemList: type: "array" description: "tender line item" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TenderLineItem" voidsLineItemList: type: "array" description: "void line item" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.VoidsLineItem" roundingLineItemList: type: "array" description: "rounding line item" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RoundingLineItem" priceModificationLineItemList: type: "array" description: "transaction related discount" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.PriceModificationLineItem" loyaltyRewardLineItemList: type: "array" description: "transaction related bonuspoints" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.LoyaltyRewardLineItem" workerDiscountLineItemList: type: "array" description: "worker discount line item" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.WorkerDiscountLineItem" taxLineItemList: type: "array" description: "transaction related tax" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TaxLineItem" giftCertificateLineItemList: type: "array" description: "additional gift certificate data for SaleReturnLineItem, TenderLineItem\ \ or VoidsLineItem" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.GiftCertificateLineItem" prepaidLineItemList: type: "array" description: "additional prepaid data for SaleReturnLineItem or VoidsLineItem" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.PrepaidLineItem" retailTransactionLineItemFrequentShopperPointsRedemptionList: type: "array" description: "additional bonuspoints redemption data" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemFrequentShopperPointsRedemption" additionalBonusDiscountLineItemList: type: "array" description: "data for additional bonus itemsA type of RETAIL TRANSACTION\ \ LINE ITEM that records PCE's response for the application of a promotion\ \ price derivation rule of type 'additional bonus'." items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.AdditionalBonusDiscountLineItem" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionLineItemGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemAdditionalParameter.Key" parameterName: type: "string" description: "The name of the parameter, e.g. the name/title of an additional\ \ input field\_" parameterValue: type: "string" description: "The value of the parameter, e.g. user input for an additional\ \ input field\_" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionLineItemAdditionalParameterGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemAssociation.Key" toTransactionID: type: "string" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionLineItemAssociationGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemAuditEvent.Key" creationTimestamp: type: "string" example: "2018-05-16T16:09:24.394" description: "Creation timestamp of the audit event; Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" creationTimestampUTC0: type: "string" format: "date-time" example: "2018-05-16T09:24:00+01:00" description: "Creation timestamp in UTC0; UTC0 date format 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'\ \ (with timezone)" workstationID: type: "string" description: "ID of the workstation" workstationTypeCode: type: "string" description: "Type code of the workstation" eventTypeCode: type: "string" description: "Type code of the audit event" content: type: "object" description: "Additional event content" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionLineItemAuditEventGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemBinaryData.Key" name: type: "string" description: "The name of the binary data entry\_" content: type: "object" description: "The binary object\_" contentLength: type: "number" format: "double" description: "The length of the binary object" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionLineItemBinaryDataGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemExtension.Key" extensionValue: type: "string" description: "The value of the key-value pair\_" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionLineItemExtensionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemFrequentShopperPointsRedemption.Key" customerAccountID: type: "string" description: "The customer account number" redemptionTransactionID: type: "string" description: "A universally unique identifier (UUID) for the redemption transaction.\ \ This may be assembled from alternate key members" frequentShopperPointsRedeemedCount: type: "number" format: "double" description: "The number of frequent shopper points redeemed" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionLineItemFrequentShopperPointsRedemptionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemI18NText.Key" text: type: "string" description: "The text in the nominated language\_" pictureFlag: type: "boolean" description: "Determines whether Text is a reference to a picture or whether\ \ Text is common text\_" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionLineItemI18NTextGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemResourceOverride.Key" resourceID: type: "string" description: "A unqiue system assigned identifier for the action to which\ \ access may be granted to some Operators and Workstations. \_" operatorID: type: "string" description: "A unique, automatically assigned number used to identify a workstation\ \ OPERATOR.\_" overrideTimestamp: type: "string" example: "2018-05-16T16:09:24.394" description: "The date and time that a transaction line item is being overridden.\_\ ; Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" entryMethodCode: type: "string" description: "A code denoting how the overriding Operator was entered. e.g.\ \ Keyed, Scanned, MCR, etc...\_" approverName: type: "string" description: "The name of the person assigned to the WorkerID that was used\ \ to approve this LineItemResourceOverride\_" approverFirstName: type: "string" description: "The first name of the person assigned to the WorkerID that was\ \ used to approve this line item resource override\_" workGroupID: type: "string" description: "A unqiue system assigned identifier for a set of WorkerID with\ \ similar resource access control permissions.\_" workerID: type: "string" description: "A unique system-assigned identifier for the Person who is a\ \ particular Worker." overrideTimestampUTC0: type: "string" format: "date-time" example: "2018-05-16T09:24:00+01:00" description: "The UTC0 date and time that a transaction line item is being\ \ overridden.\_; UTC0 date format 'yyyy-MM-dd'T'HH:mm:ss.SSSZ' (with timezone)" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionLineItemResourceOverrideGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionManufacturerCouponSummary.Key" manufacturerCompanyCode: type: "string" description: "The 6 to 12 digit GS1 Company Prefix of the manufacturer that\ \ is funding this offer. This information is derived from the ManufacturerCouponScanCode\ \ in case that the manufacturer coupon was scanned, or manually entered\ \ otherwise." manufacturerOfferCode: type: "string" description: "A 6-digit number (assigned by the holder of the ManufacturerCompanyCode)\ \ that identifies this offer. This information is derived from the ManufacturerCouponScanCode\ \ in case that the manufacturer coupon was scanned, or manually entered\ \ otherwise." keyEnteredFlag: type: "boolean" description: "A flag to denote whether the manufacturer coupon was key entered\ \ or scanned" inputCount: type: "number" format: "double" description: "The number how often the manufacturer coupon was registered" appliedCount: type: "number" format: "double" description: "The number how often the manufacturer coupon was applied" appliedIntervalCount: type: "number" format: "double" description: "The number of intervals for which the manufacturer coupon was\ \ applied" totalAmount: type: "number" format: "double" description: "The total discount amount that is granted by applying the manufacturer\ \ coupon according to its AppliedCount" tenderLineItemSequenceNumber: type: "integer" format: "int32" description: "The reference to the corresponding tender line item" saleLineItemValidationList: type: "array" description: "list of validating sale line items" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionManufacturerCouponValidation" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionManufacturerCouponSummaryGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionManufacturerCouponValidation.Key" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionManufacturerCouponValidationGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionModifierCoupon.Key" couponNumber: type: "string" description: "The coupon number that was used to trigger the modifier" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionModifierCouponGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionExternalActionParameter.Key" parameterValue: type: "string" description: "The parameter value" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionPromotionExternalActionParameterGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionExternalActionText.Key" text: type: "string" description: "The text itself" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionPromotionExternalActionTextGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionPriceDerivationRule.Key" promotionDescription: type: "string" description: "Short description of the promotion\_" receiptPrinterName: type: "string" description: "Text to be printed on the receipt\_" promotionPriceDerivationRuleSequence: type: "string" example: "100000000000000000" description: "Sequence - for collision handling\_" promotionPriceDerivationRuleResolution: type: "string" example: "100000000000000000" description: "Resolution - for collision handling\_" promotionPriceDerivationRuleTypeCode: type: "string" description: "The typecode of the promotion price derivation rule\_" transactionControlBreakCode: type: "string" description: "This type code defines the base for applying the condition and\ \ it defines the calculation time." priceModificationMethodCode: type: "string" description: "A code denoting the method of modifying the price that is being\ \ applied to the transaction resp. line item\_" priceDerivationRuleDescription: type: "string" description: "Business description for this price derivation rule.\_" promotionOriginatorTypeCode: type: "string" description: "The typecode of the originator of the promotion\_" externalPromotionID: type: "string" description: "The external identifier of the promotion\_" externalPriceDerivationRuleID: type: "string" description: "The external identifier of the price derivation rule\_" triggerQuantity: type: "number" format: "double" description: "The quantity of items fulfilling the eligibility which is required\ \ to be purchased to trigger the price derivation rule.\_" giftCertificateExpirationDate: type: "string" example: "2018-05-16T16:09:24.394" description: "End of the date range in which the gift certificate is valid\_\ ; Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" discountMethodCode: type: "string" description: "Determines how the discount influences the transaction." frequentShopperPointsFlag: type: "boolean" description: "Determines whether disocunt or frequent shopper points are awarded\ \ by the price derivation rule\_" customerGroupLoyaltyPointsDefaultQuantity: type: "number" format: "double" description: "The count of default loyalty points assigned to the customer\ \ group\_" prohibitPrintFlag: type: "boolean" description: "Determines whether the result of the applied price derivation\ \ rule is to be suppressed on displays / not printed on the receipt; e.g.\ \ line item-related default points are not printed after each position,\ \ but only summarized at the end of the receipt\_" tenderTypeCode: type: "string" description: "A code which uniquely identifies the tender in case of rebate\ \ as tender." promotionTypeName: type: "string" description: "Promotion type name\_" calculationBase: type: "string" description: "Defines the calculation base for transaction related discounts." pointsConversionAmount: type: "number" format: "double" description: "Exchange rate for the conversion from points into local currency\_" noEffectOnSubsequentPriceDerivationRulesFlag: type: "boolean" description: "Determines whether applying this price derivation rule influences\ \ the calculation base of subsequent price derivation rules (false) or not\ \ (true)." prohibitTransactionRelatedPriceDerivationRulesFlag: type: "boolean" description: "Determines whether applying this price derivation rule influences\ \ the calculation base of subsequent transaction-related price derivation\ \ rules (false) or not (true); is relevant for line item-related 'money'\ \ price derivation rules only\_" couponPrintoutID: type: "string" description: "The number of the printout coupon\_" couponPrintoutRule: type: "string" description: "The type code of the printout rule." couponPrintoutText: type: "object" description: "The formatted text of the printout coupon\_" exclusiveFlag: type: "boolean" description: "Determines whether this price derivation rule is an exclusive\ \ one\_" requireUserInteractionFlag: type: "boolean" description: "Determines whether an additional user interaction (pressing\ \ a button) is necessary in order to fulfill the eligibility for applying\ \ the price derivation rule\_" considerPreviousPriceDerivationRulesFlag: type: "boolean" description: "Indicates whether all price derivation rules which were applied\ \ before are to be considered (true) or not (false)." concurrenceControlVector: type: "string" description: "Determines how this price derivation rule works in relation\ \ to other applicable price derivation rules\_" appliedCount: type: "number" format: "double" description: "Describes how often the current price derivation rule was applied\_" printoutValidityPeriod: type: "number" format: "double" description: "Describes how long (how many days) the printed coupon/gift certificate\ \ is valid\_" externalActionID: type: "string" description: "The ident of the action which is to be performed by the client\ \ which invoked the pricing engine" externalActionDescription: type: "string" description: "The description of the action which is to be performed by the\ \ client which invoked the pricing engine" externalActionTextList: type: "array" description: "The texts for the action which is to be performed by the client\ \ which invoked the pricing engine" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionExternalActionText" externalActionParameterList: type: "array" description: "The parameters for the action which is to be performed by the\ \ client which invoked the pricing engine" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionExternalActionParameter" calculationBaseSequence: type: "string" example: "100000000000000000" description: "Determines which one of the previously applied modifiers is\ \ to be considered as calculation base for the current modification. In\ \ detail, the calculation base for the current price derivation rule is\ \ to be determined as following:- In case that no price derivation rules\ \ were applied before, it is the original price/total.- Null: all price\ \ derivation rules which were applied before the current price derivation\ \ rule are to be considered, i.e. the calculation base for the current price\ \ derivation rule equals to the new price of the price derivation rule which\ \ was applied just before it = as latest. - Otherwise, the calculation base\ \ for the current price derivation rule equals to the new price of that\ \ price derivation rule which was applied one or more steps before it having\ \ the highest sequence <= CalculationBaseSequence (or the original price\ \ if no such price derivation rule was applied)." externalOfferID: type: "string" description: "Another external ident of the promotion.It is needed by/known\ \ to the retailer." additionalPriceTypeCode: type: "string" description: "The price type code of the additional price which got applied" xxcustom06: type: "string" description: "Customizable information" xxcustom07: type: "string" description: "Customizable information" xxcustom08: type: "string" description: "Customizable information" xxcustom09: type: "string" description: "Customizable information" xxcustom10: type: "string" description: "Customizable information" xxcustom11: type: "string" description: "Customizable information" xxcustom12: type: "string" description: "Customizable information" xxcustom13: type: "string" description: "Customizable information" xxcustom14: type: "string" description: "Customizable information" xxcustom15: type: "string" description: "Customizable information" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionPromotionPriceDerivationRuleGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionTrigger.Key" triggerType: type: "string" description: "The type of the trigger (referencing to POS configuration)" triggerValue: type: "string" description: "The value of the trigger (referencing to POS configuration)" privilegeType: type: "string" description: "Defines the method for price modification." privilegeValue: type: "number" format: "double" description: "Reduction amount, reduction percent or new price amount" reasonCode: type: "string" description: "Reason code for the manual discount" reasonDescription: type: "string" description: "A narrative description describing the manual discount reason." reference_: type: "string" description: "An additional information concerning the trigger\_" triggerSequenceAddend: type: "string" example: "100000000000000000" description: "A value which is to be added to the sequence of the condition\ \ (which comes from the master data)" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionPromotionTriggerGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionTaxExemptTrigger.Key" reasonCode: type: "string" description: "Tax exempt reason code" reasonDescription: type: "string" description: "A narrative description for the tax exempt reason code.\_" taxCertificateID: type: "string" description: "The certificate number assigned to a purchaser by a tax authority\ \ exempting the purchaser from tax in that authority" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "RetailTransactionTaxExemptTriggerGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionTotal.Key" amount: type: "number" format: "double" description: "The monetary value of the transaction total.Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.ReturnLineItem.Key" returnReasonCode: type: "string" description: "The code of the return reason" returnReasonDescription: type: "string" description: "A narrative description describing the use of the retailer assigned\ \ return reason code.\_" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "ReturnLineItemGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RoundingLineItem.Key" roundUpFlag: type: "boolean" description: "A flag denoting that the amount was rounded up." amount: type: "number" format: "double" description: "The applied rounding differenceGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SaleReturnLineItem.Key" itemID: type: "string" description: "A unique identifier for the item" unitOfMeasureCode: type: "string" description: "The code used to specify the unit of the item" itemType: type: "string" description: "The type code of the line item" subItemType: type: "string" description: "The sub type code of the line item" regularUnitPrice: type: "number" format: "double" description: "The regular per-unit price" regularUnitPriceQuantity: type: "number" format: "double" description: "The number of items the regular price is defined for, i.e. 3\ \ for $1.00Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemAdditionalPrice.Key" priceAmount: type: "number" format: "double" description: "The price\_" packagePriceQuantity: type: "integer" format: "int32" description: "The quantity the price is defined for, i.e. 3 for $1.00" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "SaleReturnLineItemAdditionalPriceGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemCharacteristic.Key" characteristicValueID: type: "string" description: "The ident of the characteristic's value\_" characteristicValueName: type: "string" description: "The name of the characteristic's value" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "SaleReturnLineItemCharacteristicGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemCollection.Key" quantity: type: "integer" format: "int32" description: "The single quantity of the item" units: type: "number" format: "double" description: "The units of the item" receiptText: type: "string" description: "The receipt printout text\_" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "SaleReturnLineItemCollectionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemExtension.Key" extensionValue: type: "string" description: "The value of the key-value pair\_" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "SaleReturnLineItemExtensionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemGenericAttribute.Key" genericAttributeKey: type: "string" description: "The key of the generic attribute.The key may not be unique in\ \ the scope of a single line item." genericAttributeValue: type: "string" description: "The value of the generic attribute." customFlag: type: "boolean" description: "Indicates whether the generic attribute is custom (project-specific)\ \ or was added as an internal attribute for the product. This flag controls\ \ whether this generic attribute is considered in checking the configured\ \ limit (true) or not (false)." xxcustom06: type: "string" description: "Customizable information" xxcustom07: type: "string" description: "Customizable information" xxcustom08: type: "string" description: "Customizable information" xxcustom09: type: "string" description: "Customizable information" xxcustom10: type: "string" description: "Customizable information" xxcustom11: type: "string" description: "Customizable information" xxcustom12: type: "string" description: "Customizable information" xxcustom13: type: "string" description: "Customizable information" xxcustom14: type: "string" description: "Customizable information" xxcustom15: type: "string" description: "Customizable information" xxcustom16: type: "string" description: "Customizable information" xxcustom17: type: "string" description: "Customizable information" xxcustom18: type: "string" description: "Customizable information" xxcustom19: type: "string" description: "Customizable information" xxcustom20: type: "string" description: "Customizable information" xxcustom21: type: "string" description: "Customizable information" xxcustom22: type: "string" description: "Customizable information" xxcustom23: type: "string" description: "Customizable information" xxcustom24: type: "string" description: "Customizable information" xxcustom25: type: "string" description: "Customizable information" xxcustom26: type: "string" description: "Customizable information" xxcustom27: type: "string" description: "Customizable information" xxcustom28: type: "string" description: "Customizable information" xxcustom29: type: "string" description: "Customizable information" xxcustom30: type: "string" description: "Customizable information" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "SaleReturnLineItemGenericAttributeGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemMerchandiseHierarchyGroup.Key" timeStampEffective: type: "string" example: "2018-05-16T16:09:24.394" description: "The timestamp when this assignment becomes active\_; Date format\ \ 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" timeStampExpiration: type: "string" example: "2018-05-16T16:09:24.394" description: "The last date and time when this assignment is effective\_;\ \ Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" statusCode: type: "string" description: "Defines the current status for the assignment; examples of valid\ \ codes include: AC/null = Active, IA = Inactive" timeStampEffectiveUTC0: type: "string" format: "date-time" example: "2018-05-16T09:24:00+01:00" description: "The UTC0 timestamp when this assignment becomes active\_; UTC0\ \ date format 'yyyy-MM-dd'T'HH:mm:ss.SSSZ' (with timezone)" timeStampExpirationUTC0: type: "string" format: "date-time" example: "2018-05-16T09:24:00+01:00" description: "The last UTC0 date and time when this assignment is effective\_\ ; UTC0 date format 'yyyy-MM-dd'T'HH:mm:ss.SSSZ' (with timezone)" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "SaleReturnLineItemMerchandiseHierarchyGroupGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemModifierCoupon.Key" couponNumber: type: "string" description: "The coupon number that was used to trigger the modifier" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "SaleReturnLineItemModifierCouponGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemModifierReference.Key" referenceQuantity: type: "number" format: "double" description: "The quantity share of that line item which was necessary for\ \ fulfilling the price derivation rule eligibilities" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "SaleReturnLineItemModifierReferenceGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemPrice.Key" priceAmount: type: "number" format: "double" description: "The price\_" description: type: "string" description: "An additional information concerning the price\_" packagePriceQuantity: type: "integer" format: "int32" description: "The quantity the price is defined for, i.e. 3 for $1.00" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "SaleReturnLineItemPriceGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemPromotionTrigger.Key" triggerType: type: "string" description: "The type of the trigger (referencing to POS configuration)" triggerValue: type: "string" description: "The value of the trigger (referencing to POS configuration)" privilegeType: type: "string" description: "Defines the method for price modification." privilegeValue: type: "number" format: "double" description: "Reduction amount, reduction percent or new price amount" reasonCode: type: "string" description: "Reason code for the manual discount" reasonDescription: type: "string" description: "A narrative description describing the manual discount reason." reference_: type: "string" description: "An additional information concerning the trigger\_" triggerSequenceAddend: type: "string" example: "100000000000000000" description: "A value which is to be added to the sequence of the condition\ \ (which comes from the master data)\_" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "SaleReturnLineItemPromotionTriggerGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemSalesOrder.Key" salesOrderTypeCode: type: "string" description: "The type code of the related sales order\_" salesOrderDeliveryTypeCode: type: "string" description: "The delivery type code of the related sales order\_" requestedDeliveryDate: type: "string" example: "2018-05-16T16:09:24.394" description: "The delivery date that was requested by the customer; Date format\ \ 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "SaleReturnLineItemSalesOrderGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemSplitPackage.Key" splitQuantity: type: "integer" format: "int32" description: "The number of items this split price is applied to.see Transaction\ \ Calculation Rules" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "SaleReturnLineItemSplitPackageGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SaleReturnTaxExemptTrigger.Key" reasonCode: type: "string" description: "Tax exempt reason code" reasonDescription: type: "string" description: "A narrative description for the tax exempt reason code.\_" taxCertificateID: type: "string" description: "The certificate number assigned to a purchaser by a tax authority\ \ exempting the purchaser from tax in that authority." xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "SaleReturnTaxExemptTriggerGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SaleReturnTaxLineItem.Key" taxGroupRuleID: type: "string" example: "100000000000000000" description: "System assigned unique identifier for the TaxGroupRule.\_" taxIncludedInPricesFlag: type: "boolean" description: "A flag denoting that all applicable taxes are included in the\ \ prices for this line item, and that therefore this SaleReturnTaxLineItem\ \ is merely a summary of those taxes,\_" taxAtSourceFlag: type: "boolean" description: "A flag denoting that the goods being sold and shipped have been\ \ taxed according to the TaxAuthorityShippingRule.\_" taxableAmount: type: "number" format: "double" description: "The monetary amount for which tax is applicable.\_" taxablePercent: type: "number" format: "double" description: "The percentage of the taxable amount that is liable for tax.\ \ Usually this is 100% but where an aggregate item contains taxed and non-taxed\ \ goods this value may be less than 100%.\_Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SaleReturnTaxOverrideModifier.Key" taxGroupRuleID: type: "string" example: "100000000000000000" description: "System assigned unique identifier for the TaxGroupRule.\_" taxableAmount: type: "number" format: "double" description: "The monetary amount for which tax is applicable at the new rate.\_\Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SerializedUnitModifer.Key" serializedItemID: type: "string" description: "Fix 0" serialNumber: type: "string" description: "The serial number of the line item" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "SerializedUnitModiferGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SignOffTransaction.Key" tillID: type: "string" example: "100000000000000000" description: "The unique identifier of the till" lastWorkstationID: type: "string" description: "Last workstation where the till was used. Only filled in case\ \ of forced log out." lastWorkerID: type: "string" description: "Last worker logged on till. Only filled in case of forced log\ \ out." lastWorkerFirstName: type: "string" description: "First name of last worker logged on till. Only filled in case\ \ of forced log out." lastWorkerLastName: type: "string" description: "Last name of last worker logged on till. Only filled in case\ \ of forced log out." xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "SignOffTransactionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SignOnTransaction.Key" tillID: type: "string" example: "100000000000000000" description: "The unique identifier of the till" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "SignOnTransactionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.StoreSafeSettlementTenderDenomination.Key" typeCode: type: "string" description: "The denomination type code" pieceValue: type: "number" format: "double" description: "Piece value\_" rollFlag: type: "boolean" description: "Determines whether the DenominationCount value is expressed\ \ in coin rolls (true) or single coins/notes (false)" rollCapacity: type: "number" format: "double" description: "Count of coins in the roll\_" denominationCount: type: "number" format: "double" description: "The count of the denomination" denominationAmount: type: "number" format: "double" description: "The total amount of the denomination" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "StoreSafeSettlementTenderDenominationGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.StoreSafeSettlementTenderDetail.Key" openBalanceAmount: type: "number" format: "double" description: "The opening tender balance" openMediaUnitQuantity: type: "integer" format: "int32" description: "The opening number of discrete tender media (e.g. currency bills,\ \ coins, credit/debit card signed slips, etc.)" closeBalanceAmount: type: "number" format: "double" description: "The closing tender balance in main currencyCorresponds to the\ \ target values." closeMediaUnitQuantity: type: "integer" format: "int32" description: "The closing number of discrete tender media (e.g. currency bills,\ \ coins, credit/debit card signed slips, etc.)" countedBalanceAmount: type: "number" format: "double" description: "The counted tender balance in main currencyCorresponds to the\ \ target values." countedMediaUnitQuantity: type: "integer" format: "int32" description: "The counted number of discrete tender media (e.g. currency bills,\ \ coins, credit/debit card signed slips, etc.)" overUnderBalanceAmount: type: "number" format: "double" description: "The variance between closing balance amount and counted balance\ \ amount by subtracting the CloseBalanceAmount from the CountedBalanceAmount." overUnderMediaUnitQuantity: type: "integer" format: "int32" description: "The variance between closing media unit quantity and counted\ \ media unit quantity by subtracting the\_CloseMediaUnitQuantity from the\ \ CountedMediaUnitQuantity." currencySymbol: type: "string" description: "The currency symbol" tenderDescription: type: "string" description: "Description of the tender" unitCountRequiredFlag: type: "boolean" description: "A flag to signify that specific tender type units need to be\ \ counted and recorded by the operator prior to a pickup.\_" amountCountRequiredFlag: type: "boolean" description: "A flag to signify that a specific tender type amount needs to\ \ be counted and recorded by the operator prior to a pickup.\_" tenderClassCode: type: "string" description: "The tender class code from master data" exchangeRate: type: "number" format: "double" description: "The quantitative conversion factor between foreign currency\ \ and local currency.\_Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.StoreSafeSettlementTransaction.Key" storeSafeSettlementTenderDetailList: type: "array" description: "tender details" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.StoreSafeSettlementTenderDetail" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "StoreSafeSettlementTransactionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TaxLineItem.Key" taxIncludedInPricesFlag: type: "boolean" description: "A flag denoting that all applicable taxes are included in the\ \ prices for this line item, and that therefore this SaleReturnTaxLineItem\ \ is merely a summary of those taxes,\_" taxAtSourceFlag: type: "boolean" description: "A flag denoting that the goods being sold and shipped have been\ \ taxed according to the TaxAuthorityShippingRule.\_" taxablePercent: type: "number" format: "double" description: "The percentage of the taxable amount that is liable for tax.\ \ Usually this is 100% but where an aggregate item contains taxed and non-taxed\ \ goods this value may be less than 100%.\_Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TaxRefundTransaction.Key" taxRefundDocumentID: type: "string" description: "The unique identifier of the tax refund document. This is returned\ \ from tax refund service." externalTransactionID: type: "string" description: "A universally unique identifier (UUID) for the transaction in\ \ the external system. Provided by the service provider." storeInvoiceID: type: "string" description: "Fiscal invoice number for countries, where this is required." totalGrossAmount: type: "number" format: "double" description: "The summarized gross amout for all sale transactions of this\ \ tax refund" totalTaxAmount: type: "number" format: "double" description: "The summarized gross amout for all sale transactions of this\ \ tax refundGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TenderAmountAdjustmentTransaction.Key" tillID: type: "string" example: "100000000000000000" description: "The unique identifier of the till" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "TenderAmountAdjustmentTransactionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TenderAuthorization.Key" tenderLineItemSequenceNumber: type: "integer" format: "int32" description: "The sequence number of line item within the context of this\ \ RetailTransaction.\_" cardType: type: "string" description: "A code denoting which kind of card is being accepted.\_" accountNumber: type: "string" description: "The account number appearing on a debit/credit card and identifying\ \ the card issuer's customer account to be charged or credited for the transaction.\_" cardIssueSequenceNumber: type: "string" example: "100000000000000000" description: "The IssueSequence number of the credit card being used.\_" cardExpirationDate: type: "string" description: "The expiration date of the Credit or Debit card, as taken from\ \ the card in MMYY format.\_" referenceNumber: type: "string" description: "A unique identifier (which may be assigned by the external authorization\ \ agency) for this TenderAuthorization\_" terminalTransactionStatus: type: "integer" format: "int32" description: "The status of of the card transaction" terminalTransactionErrorNumber: type: "integer" format: "int32" description: "The last error message sent by the terminal\_" terminalTransactionType: type: "integer" format: "int32" description: "The type of the terminal transaction\_" forceOnlineFlag: type: "boolean" description: "Denotes that the Tender was authorized within the retail enterprise\ \ (usually because the connection to the host was down) and this TenderAuthorization\ \ must be approved by the host when it comes online.\_" requestedAmount: type: "number" format: "double" description: "The monetary value of the purchases for which an authorization\ \ is being requested.\_Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TenderControlTransaction.Key" tenderControlTypeCode: type: "string" description: "A code to denote the type of the tender control transaction." tenderControlTransactionTenderLineItemList: type: "array" description: "list of tender line items" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TenderControlTransactionTenderLineItem" tenderPickupTransactionList: type: "array" description: "additional pickup data" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TenderPickupTransaction" tenderLoanTransactionList: type: "array" description: "additional loan data" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TenderLoanTransaction" tenderAmountAdjustmentTransactionList: type: "array" description: "additional data for tender amount adjustments" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TenderAmountAdjustmentTransaction" tenderDepositReceiptTransactionList: type: "array" description: "additional data for inbound/outbound safe transactions" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TenderDepositReceiptTransaction" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "TenderControlTransactionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TenderControlTransactionTenderLineItem.Key" foreignCurrencyAmount: type: "number" format: "double" description: "The monetary value (in currency being moved) of the Tender being\ \ moved by the transaction.\_Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TenderControlTransactionTenderLineItemDenomination.Key" typeCode: type: "string" description: "The denomination type code" pieceValue: type: "number" format: "double" description: "Piece value\_" rollFlag: type: "boolean" description: "Determines whether the DenominationCount value is expressed\ \ in coin rolls (true) or single coins/notes (false)" rollCapacity: type: "number" format: "double" description: "Count of coins in the roll\_" denominationCount: type: "number" format: "double" description: "The count of the denomination" denominationAmount: type: "number" format: "double" description: "The total amount of the denomination" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "TenderControlTransactionTenderLineItemDenominationGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TenderDepositReceiptTransaction.Key" outboundTenderRepositoryID: type: "string" example: "100000000000000000" description: "The unique identifier for the TENDER REPOSITORY.\_" inboundTenderRepositoryID: type: "string" example: "100000000000000000" description: "The unique identifier for the TENDER REPOSITORY.\_" depositBagID: type: "string" description: "Automatically generated (with another algorithm like reference\ \ number in bank payment) unique Safebag ID." depositBagNumber: type: "string" description: "Safe bag number entered by operator that was used to transport\ \ the Tender from the Safe to the ExternalDepository.\_" safeTenderMovementCode: type: "string" description: "A code that indicates the movement of tender with respect to\ \ a SAFE. It is used to clarify whether tender is being RECEIVED into a\ \ store safe from an external repository or DEPOSITED from a safe into an\ \ external depository." doubleCheckingWorkerID: type: "string" description: "A unique system-assigned identifier for the Person who is a\ \ particular Worker." xxcustom01: type: "string" description: "Customizable information\_" xxcustom02: type: "string" description: "Customizable information\_" xxcustom03: type: "string" description: "Customizable information\_" xxcustom04: type: "string" description: "Customizable information\_" xxcustom05: type: "string" description: "Customizable information\_" description: "TenderDepositReceiptTransactionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TenderLineItem.Key" isChangeFlag: type: "boolean" description: "If true, denotes that the Tender is returned by the retailer\ \ to the Customer.\_" tenderTypeCode: type: "string" description: "A code which uniquely identifies the tenderCorresponds to Tender.TenderTypeCode" tenderAccountNumber: type: "string" description: "The tender account number" foreignCurrencyAmount: type: "number" format: "double" description: "The monetary value (in the currency submitted by the Customer)\ \ of the tender submitted by the Customer.\_" exchangeRate: type: "number" format: "double" description: "The exchange rate used to convert the tendered amount into the\ \ default currency of the retail enterprise.\_Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TenderLoanTransaction.Key" outboundSafeID: type: "string" example: "100000000000000000" description: "The unique identifier for the TENDER REPOSITORY.\_" inboundTillID: type: "string" example: "100000000000000000" description: "The unique identifier for the TENDER REPOSITORY.\_" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "TenderLoanTransactionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TenderPickupTransaction.Key" inboundSafeID: type: "string" example: "100000000000000000" description: "The unique identifier for the TENDER REPOSITORY.\_" outboundTillID: type: "string" example: "100000000000000000" description: "The unique identifier of the till" envelopeID: type: "string" description: "The identifier of the Envelope that was used for this Pickup" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "TenderPickupTransactionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TillSettlementDocument.Key" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "TillSettlementDocumentGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TillSettlementTenderDenomination.Key" typeCode: type: "string" description: "The denomination type code" pieceValue: type: "number" format: "double" description: "Piece value\_" rollFlag: type: "boolean" description: "Determines whether the DenominationCount value is expressed\ \ in coin rolls (true) or single coins/notes (false)" rollCapacity: type: "number" format: "double" description: "Count of coins in the roll\_" denominationCount: type: "number" format: "double" description: "The count of the denomination" denominationAmount: type: "number" format: "double" description: "The total amount of the denomination" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "TillSettlementTenderDenominationGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TillSettlementTenderDetail.Key" openBalanceAmount: type: "number" format: "double" description: "The opening tender balance" openMediaUnitQuantity: type: "integer" format: "int32" description: "The opening number of discrete tender media (e.g. currency bills,\ \ coins, credit/debit card signed slips, etc.)" closeBalanceAmount: type: "number" format: "double" description: "The closing tender balance in main currencyCorresponds to the\ \ target values." closeMediaUnitQuantity: type: "integer" format: "int32" description: "The closing number of discrete tender media (e.g. currency bills,\ \ coins, credit/debit card signed slips, etc.)Corresponds to the target\ \ values." countedBalanceAmount: type: "number" format: "double" description: "The counted tender balance in main currency" countedMediaUnitQuantity: type: "integer" format: "int32" description: "The counted number of discrete tender media (e.g. currency bills,\ \ coins, credit/debit card signed slips, etc.)" overUnderBalanceAmount: type: "number" format: "double" description: "The variance between closing balance amount and counted balance\ \ amount by subtracting the CloseBalanceAmount from the CountedBalanceAmount" overUnderMediaUnitQuantity: type: "integer" format: "int32" description: "The variance between closing media unit quantity and counted\ \ media unit quantity by subtracting the CloseMediaUnitQuantity from the\ \ CountedMediaUnitQuantity." currencySymbol: type: "string" description: "The currency symbol" tenderDescription: type: "string" description: "Description of the tender.\_" unitCountRequiredFlag: type: "boolean" description: "A flag to signify that specific tender type units need to be\ \ counted and recorded by the operator" amountCountRequiredFlag: type: "boolean" description: "A flag to signify that a specific tender type amount needs to\ \ be counted and recorded by the operator" tenderClassCode: type: "string" description: "The tender class code from master data" exchangeRate: type: "number" format: "double" description: "The quantitative conversion factor between foreign currency\ \ and local currency.\_Getter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TillTenderSettlementTransaction.Key" tillSettlementTenderDetailList: type: "array" description: "settlement tender details" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TillSettlementTenderDetail" tillSettlementDocumentList: type: "array" description: "settlement details" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TillSettlementDocument" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "TillTenderSettlementTransactionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction.Key" operatorID: type: "string" description: "A unique, automatically assigned number used to identify a workstation\ \ OPERATOR.\_" workstationID: type: "string" description: "The unique identifier for the WORKSTATION.\_" businessUnitID: type: "string" description: "The store id" businessDayDate: type: "string" example: "2018-05-16T16:09:24.394" description: "The calendar date of the BusinessDay.\_; Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" sequenceNumber: type: "integer" format: "int32" description: "The sequence number of the transaction (incremental number for\ \ each workstation). It is formatted according to minimum and maximum value\ \ and it could be reset every day to minimum value. So in comparison to\ \ InternalSequenceNumber it must not be unique for business unit and workstation.It\ \ is used for export, reporting, search and display." transactionTypeCode: type: "string" description: "A code to denote the type of Transaction." beginDateTimestamp: type: "string" example: "2018-05-16T16:09:24.394" description: "The time and date a transaction is initiated.\_; Date format\ \ 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" endDateTimestamp: type: "string" example: "2018-05-16T16:09:24.394" description: "The time and date stamp a transaction is completed.\_; Date\ \ format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" cancelledFlag: type: "boolean" description: "A flag denoting that this entire transaction has been cancelled\ \ before it was completed at the POS.\_" suspendedFlag: type: "boolean" description: "Defines if the transaction was suspended." trainingFlag: type: "boolean" description: "A flag to signify whether the transaction was created in training\ \ mode." keyedOfflineFlag: type: "string" description: "A code that indicates the online/offline state when transaction\ \ was completed." reasonCode: type: "string" description: "A unique retailer defined reason code for an action that is\ \ taken (or not taken) at a Workstation." reasonDescription: type: "string" description: "A narrative description describing the uses of the retailer\ \ assigned reason code. Corresponds to Reason.Description" workerID: type: "string" description: "A unique system-assigned identifier for the Worker." workerFirstName: type: "string" description: "The worker's first name" workerLastName: type: "string" description: "The worker's last name" softwareVersion: type: "string" description: "The software version which was used in order to create the transaction." suspendNumber: type: "string" description: "Number for suspending, can be used for multiple transactions" internalSequenceNumber: type: "integer" format: "int32" description: "The sequence number of the transaction (incremental number for\ \ each workstation). It is unique for business unit and workstation." fiscalSequenceNumber: type: "string" description: "The sequence number being created\_either by the POS,\_the fiscal\ \ printer, or other device used for fiscalization" fiscalFlag: type: "boolean" description: "Determines whether this is a fiscal transaction." fiscalDayNumber: type: "string" description: "The fiscal day counter" fiscalPrinterID: type: "string" description: "The identifier of the fiscal printer" fiscalSignature: type: "string" description: "Fiscal signature of the transaction." transactionTimestamp: type: "string" example: "2018-05-16T16:09:24.394" description: "The timestamp which is relevant for the transaction processing.\ \ Depending on configuration, this can be the BeginDateTimestamp or the\ \ EndDateTimestamp.\_; Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" beginDateTimestampUTC0: type: "string" format: "date-time" example: "2018-05-16T09:24:00+01:00" description: "The UTC0 time and date a transaction is initiated.\_; UTC0 date\ \ format 'yyyy-MM-dd'T'HH:mm:ss.SSSZ' (with timezone)" endDateTimestampUTC0: type: "string" format: "date-time" example: "2018-05-16T09:24:00+01:00" description: "The UTC0 time and date stamp a transaction is completed.\_;\ \ UTC0 date format 'yyyy-MM-dd'T'HH:mm:ss.SSSZ' (with timezone)" transactionTimestampUTC0: type: "string" format: "date-time" example: "2018-05-16T09:24:00+01:00" description: "The UTC0 timestamp which is relevant for the transaction processing.\ \ Depending on configuration, this can be the BeginDateTimestampUTC0 or\ \ the EndDateTimestampUTC0. UTC0 date format 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'\ \ (with timezone)" transactionAdditionalPrintoutList: type: "array" description: "List of additional printouts" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionAdditionalPrintout" transactionAssociationList: type: "array" description: "List of associated transactions" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionAssociation" transactionBinaryDataList: type: "array" description: "List of binary data" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionBinaryData" transactionCategoryList: type: "array" description: "List of transaction categories" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionCategory" transactionExtensionList: type: "array" description: "List of transaction extensions" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionExtension" transactionResourceOverrideList: type: "array" description: "List of data for authorization related to transaction level" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionResourceOverride" endWorkstationID: type: "string" description: "WorkstationID were the transaction was finalized." transactionAuditEventList: type: "array" description: "List of audit events" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionAuditEvent" xxcustom06: type: "string" description: "Customizable information" xxcustom07: type: "string" description: "Customizable information" xxcustom08: type: "string" description: "Customizable information" xxcustom09: type: "string" description: "Customizable information" xxcustom10: type: "string" description: "Customizable information" xxcustom11: type: "string" description: "Customizable information" xxcustom12: type: "string" description: "Customizable information" xxcustom13: type: "string" description: "Customizable information" xxcustom14: type: "string" description: "Customizable information" xxcustom15: type: "string" description: "Customizable information" isocurrencyCode: type: "string" description: "Main currency of the store" retailTransactionList: type: "array" description: "retail transaction data" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransaction" controlTransactionList: type: "array" description: "control transaction data" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.ControlTransaction" tenderControlTransactionList: type: "array" description: "tender control transaction data" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TenderControlTransaction" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "TransactionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionAdditionalPrintout.Key" triggerID: type: "string" description: "The trigger type ident of the additional printout (e.g. customer\ \ group, user function, tender)." triggerValue: type: "string" description: "The trigger value for the additional printout (e.g. the number\ \ of the customer group, the number of user function, the tender class code)." reportName: type: "string" description: "The name of the report template\_" printoutCount: type: "number" format: "double" description: "The count of printout copies\_" printoutContent: type: "string" description: "Parameter / data for printout\_" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "TransactionAdditionalPrintoutGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionAssociation.Key" toTransactionID: type: "string" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "TransactionAssociationGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionAuditEvent.Key" creationTimestamp: type: "string" example: "2018-05-16T16:09:24.394" description: "Creation timestamp of the audit event; Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" creationTimestampUTC0: type: "string" format: "date-time" example: "2018-05-16T09:24:00+01:00" description: "Creation timestamp in UTC0; UTC0 date format 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'\ \ (with timezone)" workstationID: type: "string" description: "ID of the workstation" workstationTypeCode: type: "string" description: "Type code of the workstation" eventTypeCode: type: "string" description: "Type code of the audit event" content: type: "object" description: "Additional event content" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "TransactionAuditEventGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionBinaryData.Key" name: type: "string" description: "The name of the binary data entry\_" content: type: "object" description: "The binary object\_" contentLength: type: "number" format: "double" description: "The length of the binary object" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "TransactionBinaryDataGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionCategory.Key" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "TransactionCategoryGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionExtension.Key" extensionValue: type: "string" description: "The value of the key-value pair" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "TransactionExtensionGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionResourceOverride.Key" resourceID: type: "string" description: "A unqiue system assigned identifier for the action to which\ \ access may be granted. \_" operatorID: type: "string" description: "A unique, automatically assigned number used to identify a workstation\ \ OPERATOR.\_" overrideTimestamp: type: "string" example: "2018-05-16T16:09:24.394" description: "The date and time that a transaction line item is being overridden.\_\ ; Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" entryMethodCode: type: "string" description: "A code denoting how the overriding Operator was entered. e.g.\ \ Keyed, Scanned, MCR, etc...\_" approverName: type: "string" description: "The name of the person assigned to the WorkerID that was used\ \ to approve this TransactionResourceOverride\_" approverFirstName: type: "string" description: "The first name of the person assigned to the WorkerID that was\ \ used to approve this transaction resource override\_" workGroupID: type: "string" description: "A unqiue system assigned identifier for a set of Operators with\ \ similar resource access control permissions.\_" workerID: type: "string" description: "A unique system-assigned identifier for the Person who is a\ \ particular Worker." overrideTimestampUTC0: type: "string" format: "date-time" example: "2018-05-16T09:24:00+01:00" description: "The UTC0 date and time that a transaction line item is being\ \ overridden.\_; UTC0 date format 'yyyy-MM-dd'T'HH:mm:ss.SSSZ' (with timezone)" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "TransactionResourceOverrideGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.VoidsLineItem.Key" voidsLineItemSequenceNumber: type: "integer" format: "int32" description: "Link to the sequence number of the voided line item.\_" reasonCode: type: "string" description: "A unique retailer defined reason code for the VoidsLineItem." reasonCodeGroupCode: type: "string" description: "A retailer assigned code denoting the family of related reason\ \ codes for classifying data and actions within the systems of the retail\ \ enterprise.\_" reasonDescription: type: "string" description: "A narrative description describing the uses of the retailer\ \ assigned reason code." xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "VoidsLineItemGetter for inner key class.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.WorkerDiscountLineItem.Key" workerID: type: "string" description: "A unique system-assigned identifier for the Person who is a\ \ particular Worker.\_" workerFirstName: type: "string" description: "The worker's first name\_" workerLastName: type: "string" description: "The worker's last name" xxcustom01: type: "string" description: "Customizable information" xxcustom02: type: "string" description: "Customizable information" xxcustom03: type: "string" description: "Customizable information" xxcustom04: type: "string" description: "Customizable information" xxcustom05: type: "string" description: "Customizable information" description: "WorkerDiscountLineItemSession identifier for a given package pricing calculation\
\ context.
The Package Pricing Context stores all data needed for the\
\ processing of package prices.
\tThis attribute can be used during\
\ recalculation of a Transaction on an already initialized session.
Customizable information.
Customizable information.
Customizable information.
Customizable information.
Customizable information.
Customizable information.
Customizable information.
Customizable information.
Customizable information.
Customizable information.
Customizable information.
Customizable information.
Customizable information.
Customizable information.
Customizable information.
Session to store context of Package Pricing\
\ Engine calculation.
Entry ID
" itemId: type: "string" description: "Item number of the prepaid item
" providerCode: type: "string" description: "Provider code of the prepaid item
" resourceId: type: "string" description: "Resource key of the prepaid receipt
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PrepaidTypeEntity prepaid type
" com.gk_software.pos.api.model.config.process.action.EwicPaymentOperationConfig: type: "object" required: - "allowedAmountTypeCode" - "askForAmount" - "confirmCancelEwicPayment" - "confirmPartialPayment" - "cvbUomCode" - "ewicMaxOnline" - "ewicMaxSmart" - "ewicMerchantID" - "ewicPhone" - "ewicSplit" - "ewicStore" - "ewicStraddled" - "ewicType" - "inputAmountConstraint" - "limitExceededConfirmDialogConfig" - "previousTenderAllowed" - "straddleSubcategory" - "tenderClassCode" properties: amount: type: "number" format: "double" description: "This parameter defines the payment amount which is used by\ \ the function (in the case of fixed amounts which are assigned to keys).
" askForAmount: type: "boolean" description: "This parameter specifies whether the operator should be asked\
\ to enter the amount (in an additional view).
\tIt is only taken into\
\ account if the amount input for the tender is 'optional' or 'required'.
values: 01, 02
This parameter defines the assignment to a particular tender\ \ in the master data.
" currencyCode: type: "string" description: "This parameter defines the code of the currency which is\ \ used. It overrides the currency selection.
" confirmPartialPayment: type: "boolean" description: "This parameter specifies whether the payment amount must\ \ be confirmed for partial payments. It is only taken into account if the\ \ amount input for the tender must be confirmed.
value: 04
This parameter defines the input amount constraint.
value: InputAmountConstraint [TENDER, REQUIRED, OPTIONAL, PROHIBITED,\ \ CONFIRM]
This parameter defines the allowed amount type code.
value: AllowedAmountTypeCode [TENDER, EXACTLY, EXACTLYANDLESS,\ \ EXACTLYANDMORE, ALL]
This parameter specifies whether the eWIC functionality is\ \ active for the store.
values: true, false" ewicType: type: "integer" format: "int32" description: "
This parameter specifies whether the store takes 'WIC Online\ \ EBT Cards', 'WIC Smart Cards', or both.
values: 1, 2, 3" ewicPhone: type: "string" description: "
This parameter specifies the telephone number to call for\ \ offline authorizations to State Agency.
" ewicStraddled: type: "integer" format: "int32" description: "This parameter specifies the number of items that may be\ \ split among a regular subcategory and a broad band subcategory in a transaction.
" ewicSplit: type: "integer" format: "int32" description: "This parameter specifies the number of items that may be\ \ split tendered between an eWIC tender and a customer provided tender in\ \ a transaction.
" ewicMaxOnline: type: "integer" format: "int32" description: "This parameter specifies the maximum number of items allowed\ \ to be paid for with eWIC tender in a transaction when WIC Online EBT Card\ \ is used.
" ewicMaxSmart: type: "integer" format: "int32" description: "This parameter specifies the maximum number of items allowed\ \ to be paid for with eWIC tender in a transaction when WIC Smart Card is\ \ used.
" ewicMerchantID: type: "string" description: "This parameter specifies the eWIC Merchant Identification.
" straddleSubcategory: type: "string" description: "This parameter specifies the straddle subcategory identification.
" cvbUomCode: type: "string" description: "This parameter specifies the cash sign for CVB. The Cash\ \ Value Benefit (CVB) provides a cash amount of benefits instead of an UOM\ \ Code.
" confirmCancelEwicPayment: type: "boolean" description: "This parameter specifies whether the confirm dialog to confirm\ \ the cancellation of the eWIC payment should be displayed or not.
values: true, false" limitExceededConfirmDialogConfig: description: "
This config defines the dialog for eWIC items limit exceeded\ \ action.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.ui.MessageDialogConfig" previousTenderAllowed: type: "array" description: "This parameter specifies the list of allowed tenders before\ \ eWIC payment. If there is not restriction for previous tender the value\ \ should be null.
" items: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "EwicPaymentOperationConfigThis configuration entity defines\ \ eWIC payment related operations.
" com.gk_software.pos.api.model.config.process.action.PositionOperationConfig: type: "object" required: - "allowedWithArea" - "allowedWithLength" - "allowedWithMeasure" - "allowedWithVolume" - "allowedWithWeight" - "amountLimitExceedAction" - "closeCurrent" - "closePrevious" - "filterResult" - "forceQuantityInput" - "maximumQuantity" - "priceDeviationType" - "priceDifferenceAbsolutePositionLimit" - "priceDifferenceLimitExceedAction" - "priceDifferencePercentPositionLimit" - "priceInputOrder" - "priceNegDeviationType" - "priceNegDifferenceLimitExceedAction" - "pricePositionLimit" - "pricePositionZeroAllowed" - "priceTransactionLimit" - "quantityInputOrder" - "quantityLimitExceedAction" properties: forceQuantityInput: type: "boolean" description: "This parameter indicates whether the quantity input for each\ \ item is forced.
values: true, false" pricePositionLimit: type: "number" format: "double" description: "
This parameter defines the price position limit. Default\ \ set to 100,000.00. -1 means disabled.
" pricePositionZeroAllowed: type: "boolean" description: "This parameter defines whether positions with zero price\ \ are allowed.
" priceTransactionLimit: type: "number" format: "double" description: "This parameter defines the price transaction limit. Default\ \ set to 100,000.00. -1 means disabled.
" priceDifferencePercentPositionLimit: type: "number" format: "double" description: "This parameter defines the price difference limit in percent.
" priceDifferenceAbsolutePositionLimit: type: "number" format: "double" description: "This parameter defines the price difference limit as an absolute\ \ value.
" priceDifferenceLimitExceedAction: type: "string" description: "This parameter defines the price difference limit exceed\ \ action for positive items.
value: LimitExceedAction [WARN,\ \ AUTHORIZE, FORBID, UNCHECKED]
This parameter defines the price difference limit exceed\ \ action for negative items.
value: LimitExceedAction [WARN,\ \ AUTHORIZE, FORBID, UNCHECKED]
This parameter defines the close current position.
value: ClosePositionAction [REQUIRED, IFPOSSIBLE, DISABLED]
This parameter defines the close previous position.
value: ClosePositionAction [REQUIRED, IFPOSSIBLE, DISABLED]
This parameter indicates whether results can be filtered.
values: true, false" allowedWithWeight: type: "boolean" description: "
This parameter indicates whether the single quantity for\ \ a weight item is allowed. It has the flag 'ALLOWED_WITH_WEIGHT'.
values: true, false" allowedWithLength: type: "boolean" description: "
This parameter indicates whether the single quantity for\ \ a length item is allowed. It has the flag 'ALLOWED_WITH_LENGTH'.
values: true, false" allowedWithArea: type: "boolean" description: "
This parameter indicates whether the single quantity for\ \ an area item is allowed. It has the flag 'ALLOWED_WITH_AREA'.
values:\ \ true, false" allowedWithVolume: type: "boolean" description: "
This parameter indicates whether the single quantity for\ \ a volume item is allowed. It has the flag 'ALLOWED_WITH_VOLUME'.
values: true, false" allowedWithMeasure: type: "boolean" description: "
This parameter indicates whether the single quantity for\ \ a measure item is allowed. It has the flag 'ALLOWED_WITH_MEASURE'.
values: true, false" maximumQuantity: type: "integer" format: "int32" description: "
This parameter defines the maximum single quantity.
" minimumQuantity: type: "integer" format: "int32" description: "This parameter defines the minimum single quantity.
" quantityInputOrder: type: "string" description: "This parameter indicates the input order for quantities.
value: InputOrder [BEFOREORAFTER, BEFORE, AFTER]
This parameter indicates the input order for prices.
value: InputOrder [BEFOREORAFTER, BEFORE, AFTER]
This parameter defines the quantity limit exceed action.
value: LimitExceedAction [WARN, AUTHORIZE, FORBID, UNCHECKED]
This parameter defines the amount limit exceed action.
value: LimitExceedAction [WARN, AUTHORIZE, FORBID, UNCHECKED]
This parameter defines the multiplication factor for weight\ \ quantities.
" measureUnitFactor: type: "number" format: "double" description: "This parameter defines the multiplication factor for dimensions\ \ quantities.
" priceDeviationType: type: "string" description: "This parameter defines the deviation with respect to the\ \ previously valid price in case of sales line items.
value:\ \ DeviationType [ALL, EQUALORLESS, EQUALORGREATER]
This parameter defines the deviation with respect to the\ \ previously valid price in case of return line items.
value:\ \ DeviationType [ALL, EQUALORLESS, EQUALORGREATER]
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PositionOperationConfigThis configuration entity defines position\ \ related operations.
" com.gk_software.pos.api.model.config.process.action.PositionRepetitionConfig: type: "object" required: - "repeatManualDiscounts" - "repeatQuantity" properties: repeatQuantity: type: "boolean" description: "This parameter specifies whether the quantity input of the\ \ old line item is applied to the new line item in case of repetitions.
values: true, false
This parameter specifies whether manual discounts are copied\ \ to the new line item in case of repetitions.
values: true,\ \ false
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PositionRepetitionConfigThis Configuration entity defines position\ \ repetition related operations.
" com.gk_software.pos.api.model.config.process.action.ProcessBarcodeConfig: type: "object" required: - "barcodeTypes" properties: barcodeTypes: type: "array" description: "This parameter defines a list of barcode types for the evaluation\ \ of manual barcode inputs. For inputs by scanners the barcode type is provided\ \ by the scanner itself.
" items: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ProcessBarcodeConfigThis configuration entity defines barcode\ \ processes.
" com.gk_software.pos.api.model.config.process.action.PromotionOperationConfig: type: "object" required: - "maxSequence" - "priceDeviationType" - "privilegeType" - "sequenceType" - "startSequence" - "triggerType" - "triggerValue" properties: triggerType: type: "string" description: "This parameter defines the trigger type for the loyalty engine.\ \ (e.g. CO)
" triggerValue: type: "string" description: "This parameter defines the trigger value for the loyalty\ \ engine.
" privilegeType: type: "string" description: "This parameter defines the price modification type code.
value: PromotionTriggerPrivilegeType [REBATESINGLE, REBATEPERCENT,\ \ NEWPRICE, REBATEAMOUNT]
This parameter defines the predefined discount or reduction\ \ value.
" sequenceType: type: "string" description: "This parameter defines the sequence handling type code.
value: PromotionTriggerSequenceType [FIX, MAX, SAME]
This parameter defines the start sequence number of promotions\ \ with the same trigger value.
" maxSequence: type: "integer" format: "int32" description: "This parameter defines the maximum number of promotions with\ \ the same trigger value.
" maxLimitWarn: type: "number" format: "double" description: "This parameter defines the maximum percentage deviation from\ \ the unit price of the item. A warning message is displayed, if the defined\ \ maxLimitWarn is exceeded.
" maxLimitAuthorize: type: "number" format: "double" description: "This parameter defines the maximum percentage deviation from\ \ the unit price of the item. An authorization is required, if the defined\ \ maxLimitAuthorize is exceeded.
" maxLimitForbid: type: "number" format: "double" description: "This parameter defines the maximum percentage deviation from\ \ the unit price of the item. An error message is required, if the defined\ \ maxLimitForbid is exceeded. The operation will be canceled.
" priceDeviationType: type: "string" description: "This parameter defines which price deviation type is allowed.
value: PriceDeviationType [ALL, EQUAL_LESS, EQUAL_GREATER]
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PromotionOperationConfigThis configuration entity defines promotion\ \ related operations.
" com.gk_software.pos.api.model.config.process.flows.AdditionalAttributes: type: "object" required: - "hsnRequired" properties: hsnRequired: type: "boolean" description: "Indicates whether hsn code should be added to sale return\
\ line item extension.
\tHSN (Harmonized System of Nomenclature) is\
\ an international classification system of commodities. HSN code ensures\
\ that commodities of similar nature are classified properly.
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AdditionalAttributesThis entity defines the item related additional\ \ attributes to be assigned to sale return line item extensions during item\ \ registration
" com.gk_software.pos.api.model.config.process.flows.AllowedTendersConfig: type: "object" required: - "checkCustomerGroupTender" - "checkNegativeTotal" - "checkReasonTender" - "filterRulesChain" - "overrideAdmissibilityPossible" - "processId" - "returnTenderRule" - "useTenderFromMasterData" properties: processId: type: "string" description: "This parameter defines the unique process ID.
" authorizationConfig: description: "This config defines authorization related processes.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig" checkReasonTender: type: "boolean" description: "This parameter enables admissibility checks based on payin/payout\ \ reasons.
" checkCustomerGroupTender: type: "boolean" description: "This parameter enables admissibility checks based on a customer\ \ group assignment.
" checkNegativeTotal: type: "boolean" description: "This parameter enables additional admissibility checks in\
\ case of a negative receipt total.
\t@deprecated - since 5.9.2 this\
\ is not longer used.
\tUse instead: returnTenderRule
\tfalse\
\ -> RETURN_TO_ANY
\ttrue -> RETURN_TO_ANY_MAPPED
Type of additional allowed tender validation to perform for\ \ returns.
" enum: - "RETURN_TO_ANY" - "RETURN_TO_ANY_MAPPED" - "RETURN_TENDER_TOTAL_TO_MAPPED" - "RETURN_ITEM_TOTAL_TO_MAPPED" useTenderFromMasterData: type: "boolean" description: "This parameter indicates whether tenders are used from the\ \ master data or taken from an existing collection for collection creation/updates.
" filterRulesChain: type: "array" description: "This parameter defines the tender filter rules chain (filters\ \ are executed in order).
" items: type: "string" overrideAdmissibilityPossible: type: "boolean" description: "This parameter specifies whether it is possible to override\ \ the admissibility of the selected tender for a customer temporary.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AllowedTendersConfigThis configuration entity defines the allowed\ \ tenders process.
" com.gk_software.pos.api.model.config.process.flows.AlternativeTaxConfig: type: "object" required: - "alternativeTaxInfos" - "processId" properties: processId: type: "string" description: "This parameter defines the unique process ID.
" authorizationConfig: description: "This config defines authorization related processes.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig" alternativeTaxInfos: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AlternativeTaxConfigConfiguration for alternative tax process
" com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos: type: "object" required: - "alternativeTaxMode" - "checkMerchandiseCategory" properties: alternativeTaxMerchandiseCategories: type: "array" description: "List of merchandise categories for which the alternative\ \ sales tax is to be used.
" items: type: "string" alternativeTaxMerchandiseCategoryList: type: "string" description: "The parameter defines a list of merchandise hierarchy groups\ \ IDs separated by semicolon. The alternative tax will be applied to all\ \ line items with the merchandise hierarchy group defined in this list.
If filled then the parameter alternativeTaxMerchandiseCategories\ \ will be ignored.
" checkMerchandiseCategory: type: "boolean" description: "Controls whether the merchandise category assignment is checked.
True: Assignment to merchandise category defined in alternativeTaxMerchandiseCategoryList/alternativeTaxMerchandiseCategories\
\ is checked.
\tFalse: Assignment to merchandise category defined in\
\ alternativeTaxMerchandiseCategoryList/alternativeTaxMerchandiseCategories\
\ is not checked.
Alternative tax group
" alternativeTaxMode: type: "boolean" description: "false: The original tax group is used by default for each\
\ receipt. The toggle button is disabled.
\ttrue: The alternative tax\
\ group is used by default for each receipt. The toggle button is enabled.
List of tax groups for which the alternative sales tax is\ \ not applied.
" items: type: "string" description: "AlternativeTaxInfosThis configuration entity defines the AlternativeTaxInfos.
" com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig: type: "object" required: - "askIfAlreadyAuthorized" - "authorizationMode" - "authorizationRequired" - "controlTransactionRelevant" - "dialogType" - "lineItemRelevant" - "passwordRequired" - "requiredRight" - "retailTransactionRelevant" - "tenderControlTransactionRelevant" properties: authorizationRequired: type: "boolean" description: "This parameter indicates whether an explicit authorization\ \ is needed or not.
values: true, false" requiredRight: type: "string" description: "
If the parameter authorizationRequired is enabled the operator\ \ permissions are checked against this right.
" authorizationMode: type: "string" description: "This parameter defines the mode of authorization.
value: AuthorizationMode [SINGLE, FOUREYES]
This parameter specifies whether a cancellation is allowed.\ \ If it is set to true the authorization is allowed to be cancelled.
values: true, false" passwordRequired: type: "boolean" description: "
This parameter specifies whether the password is required\ \ to pass the authorization.
values: true, false" dialogType: type: "string" description: "
This parameter specifies the dialog type.
value:\ \ AuthorizationDialogType [MANUAL, SCAN]
This parameter is only relevant for the four eyes authorization.
values: true, false
This parameter specifies the predefined login name.
" authorizingProcessNameKey: type: "string" description: "This parameter defines the translation key for the name of\ \ the authorizing process.
" authorizingReasonText: type: "string" description: "Prepared reason text of the authorizing process.
" authorizingReasonTextKey: type: "string" description: "Translation key for the reason text of the authorizing process.
" authorizingReasonTextParameters: type: "array" description: "Placeholder parameters for the reason text of the authorizing\ \ process.
" items: type: "string" askIfAlreadyAuthorized: type: "boolean" description: "True - Regardless of whether an authorization has already\ \ been done in the current receipt,
the authorization\ \ shall be carried out.
False: Is already noted a sufficient\ \ authorization, then this is used.
" lineItemRelevant: type: "boolean" description: "True - resourceId will be stored to line Item.
" retailTransactionRelevant: type: "boolean" description: "False - resourceId will be not stored in RetailTransaction.
" controlTransactionRelevant: type: "boolean" description: "False - resourceId will be not stored in ControlTransaction.
" tenderControlTransactionRelevant: type: "boolean" description: "False - resourceId will be not stored in TenderControlTransaction.
" activeOperatorRequired: type: "boolean" description: "True: Error if no POS Group operator is active. Null/False:\ \ No activate POS Group operator check.
" operatorSelectionAction: type: "string" description: "This parameter defines pos group operator selection action.
" enum: - "ASK_ALWAYS" - "ASK_IF_NOT_AVAILABLE" - "ASK_NEVER" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AuthorizationConfigThis configuration entity defines authorization\ \ related topics.
" com.gk_software.pos.api.model.config.process.flows.ConditionSplitConfig: type: "object" required: - "discountRoundingConfig" - "finalPriceRoundingConfig" - "finalRoundingDifferenceCorrectionEnabled" - "manualDiscountRoundingConfig" - "manualDiscountTypes" - "pointsRoundingConfig" properties: manualDiscountTypes: type: "array" description: "List of condition types for price reduction
" items: type: "string" discountRoundingConfig: description: "RoundingConfig for discounts.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.ConditionSplitRoundingConfig" manualDiscountRoundingConfig: description: "RoundingConfig for manual discounts.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.ConditionSplitRoundingConfig" finalPriceRoundingConfig: description: "RoundingConfig for the final price.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.ConditionSplitRoundingConfig" pointsRoundingConfig: description: "RoundingConfig for points.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.ConditionSplitRoundingConfig" finalRoundingDifferenceCorrectionEnabled: type: "boolean" description: "It defines if the correction of rounding differences is processed.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ConditionSplitConfigThe condition split config.
" com.gk_software.pos.api.model.config.process.flows.ConditionSplitRoundingConfig: type: "object" required: - "decimalPlacesCount" - "destinationValue" - "roundingMethod" properties: roundingMethod: type: "string" description: "It defines the rounding method for money discounts.
One value from the list.
" enum: - "Commercial" - "Down" - "Up" decimalPlacesCount: type: "integer" format: "int32" description: "Number of decimal places used for rounding of money discounts
\tPossible values: 0 - 4
It defines the rounding destination value for money discounts,\
\ which are used to round the value to the proper denomination.
\tAdditional rounding information:
One value from the list.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ConditionSplitRoundingConfigThe condition split rounding config.
" com.gk_software.pos.api.model.config.process.flows.CreateLayawayConfig: type: "object" required: - "cancellationFeeAmount" - "cancellationFeePercent" - "customerIdentificationConfig" - "deletingTime" - "initialDownPayment" - "initialFixAmount" - "layawayValidDays" - "paymentDays" - "penaltyFeeAmount" - "penaltyFeePercent" - "positionOperationConfig" - "processId" - "serviceFeeAmount" - "serviceFeePercent" - "toleranceTime" properties: processId: type: "string" description: "This parameter defines the unique process ID.
" authorizationConfig: description: "This config defines authorization related processes.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig" allowedItemNrEanList: type: "string" description: "The parameter defines a list of item numbers/ EANs (ItemID\ \ | POSItemID | MainPOSItemID) of the items, which are allowed to be part\ \ of the Layaway. If the list is empty, the value of this parameter is not\ \ checked. The defined items are separated by semicolons ';'.
" allowedMhgList: type: "string" description: "The parameter defines a list of merchandise hierarchy groups\ \ IDs, which are allowed to be part of the Layaway. If the list is empty,\ \ the value of this parameter is not checked. The defined merchandise hierarchy\ \ groups IDs are separated by semicolons ';'.
" initialDownPayment: type: "number" format: "double" description: "The parameter defines the initial down payment amount in\ \ %.
" initialFixAmount: type: "number" format: "double" description: "The parameter defines the initial down payment amount as\ \ a fix amount in main currency.
" layawayValidDays: type: "integer" format: "int32" description: "The parameter defines the validation time of the Layaway\ \ in days to calculate the final payment date based on the current date.
Example: Date of today = 13.02.2018, layawayValidDays = 28, final\ \ payment date = 13.03.2018
" layawayValidDate: type: "string" description: "The parameter defines the validation date of the Layaway\
\ independent from the creation date of the layaway. If this parameter <>\
\ null, the value of parameter layawayValidDays is not used.
\tFormat:\
\ YYYY-MM-DD, e.g.: 2019-09-27
\tExample:
\tDate of today = 01.10.2019,\
\ layawayValidDate = 31.10.2019, final payment date = 31.10.2019
\t\
Date of today = 03.10.2019, layawayValidDate = 31.10.2019, final payment\
\ date = 31.10.2019
The parameter defines every how many days a payment should\
\ be done, e.g. every 7 days or every 14 days
\tExample: Date of today\
\ = 13.02.2018, paymentDays=7, pament dates = 20.02.2018, 27.02.2018, 06.03.2018,\
\ 13.03.2018
The parameter defines how many days the final payment rate\
\ can be paid later than expected to calculate the latest final payment\
\ date.
\tIf the tolerance time is exceeded, the Layaway is canceled\
\ and the item goes back to the Store Stock.
Example: final\ \ payment date = 13.03.2018, toleranceTime = 3, latest final payment date\ \ = 16.03.2018
" deletingTime: type: "integer" format: "int32" description: "The parameter defines after how many days, beginning from\ \ the final expiration date (LatestFinalPaymentDate), the Layaway can be\ \ deleted. If the deleting time is exceeded, no actions (also no retrieving\ \ money from expired Layaway) can be performed.
Example: final\ \ expiration date = 01.03.2018, deletingTime = 200, deleting date = 17.09.2018
" serviceFeePercent: type: "number" format: "double" description: "The parameter defines the Service Fee in %.
" serviceFeeAmount: type: "number" format: "double" description: "The parameter defines the Amount of the Service Fee.
" cancellationFeePercent: type: "number" format: "double" description: "The parameter defines the Cancellation Fee in % which is\ \ calculated, if the Layaway is voided.
" cancellationFeeAmount: type: "number" format: "double" description: "The parameter defines the Amount of the Cancellation Fee\ \ which is calculated, if the Layaway is voided.
" penaltyFeePercent: type: "number" format: "double" description: "The parameter defines the percentage from the total layaway\ \ amount which is calculated, if the calculated payment date (defined by\ \ parameter layawayValidDays) + the tolerance time (defined by parameter\ \ toleranceTime) have expired.
" penaltyFeeAmount: type: "number" format: "double" description: "The parameter defines the fixed amount which is calculated,\ \ if the calculated payment date (defined by parameter layawayValidDays)\ \ + the tolerance time (defined by parameter toleranceTime) have expired.
" feeTaxGroupId: type: "string" description: "The parameter defines the tax group of the several fees.
" customerIdentificationConfig: description: "Config for customer identification sub process
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.CustomerIdentificationConfig" positionOperationConfig: description: "Config for positionOperationConfig
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateLayawayConfigThis configuration entity defines the create\ \ layaway process.
" com.gk_software.pos.api.model.config.process.flows.CustomerIdentificationConfig: type: "object" properties: customerCardType: type: "string" description: "This parameter defines the card type which has to be used\ \ for the customer identification (set only if a restriction is neccessary).
" customerIdentificationFunction: type: "string" description: "This parameter defines the customer identification function\ \ to use.
value: CustomerIdentificationFunction [CUSTOMERREGISTRATION,\ \ CUSTOMERSEARCH, CUSTOMERDATAENTRY]
This parameter controls whether it is mandatory to enter\ \ a customer.
values: true, false" customerRequiredAudibleAlert: type: "boolean" description: "
This parameter controls if a missing customer identification\ \ will be signaled by an audible alert (it will work not before audible\ \ alerts can be implemented).
values: true, false" customerRequiredMessage: type: "string" description: "
This parameter controls if a message shall be triggered if\ \ the customer is required. At the same time there is a key for hinting\ \ a message.
" customerDataMissingMessage: type: "string" description: "If one of the required conditions is not fulfilled then the\ \ warning customer data incomplete is displayed.
" retrieveCustomerId: type: "boolean" description: "This parameter controls if the customer identification process\ \ shall provide a customer ID of an identified customer for the use by calling\ \ the process.
values: true, false" customerRegistrationConfigId: type: "string" description: "
This parameter defines the config for the CustomerRegistration\ \ process. It is only in use if the customerIdentificationFunction is set\ \ to CustomerRegistration.
" customerSearchConfigId: type: "string" description: "This parameter defines the config for the CustomerSearch\ \ process. It is only in use if the customerIdentificationFunction is set\ \ to CustomerSearch.
" customerDataEntryConfigId: type: "string" description: "This parameter defines the config for the CustomerDataEntry\ \ process. It is only in use if the customerIdentificationFunction is set\ \ to CustomerDataEntry.
" firstNameRequired: type: "boolean" description: "It defines if the first name of the customer is required.
" lastNameRequired: type: "boolean" description: "It defines if the last name of the customer is required.
" streetRequired: type: "boolean" description: "It defines if the street of the default home address of the\ \ customer is required.
" cityRequired: type: "boolean" description: "It defines if the city of the default home address of the\ \ customer is required.
" postalCodeRequired: type: "boolean" description: "It defines if the postal code of the default home address\ \ of the customer is required.
" federalStateRequired: type: "boolean" description: "It defines if the federal state of the default home address\ \ of the customer is required.
" countryRequired: type: "boolean" description: "It defines if the country of the default home address of\ \ the customer is required.
" taxIdRequired: type: "boolean" description: "It defines if the tax id of the customer is required.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerIdentificationConfigThis config entity defines the CustomerIdentification\ \ process.
" com.gk_software.pos.api.model.config.process.flows.CustomerOrderData: type: "object" properties: customerOrderId: type: "string" customerOrderSequenceNumber: type: "integer" format: "int32" salesOrderTypeCode: type: "string" salesOrderDeliveryTypeCode: type: "string" requestedDeliveryDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerOrderData TODO: undocumented" com.gk_software.pos.api.model.config.process.flows.EmptiesReturnConfig: type: "object" required: - "onlyOneEmptiesReturnLineItem" - "processId" - "toggleEmptiesReturnModeConfig" properties: processId: type: "string" description: "This parameter defines the unique process ID.
" authorizationConfig: description: "This config defines authorization related processes.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig" onlyOneEmptiesReturnLineItem: type: "boolean" description: "It specifies whether the empties return mode will be finished\ \ automatically after one empties return line item.
values:\ \ true, false" toggleEmptiesReturnModeConfig: type: "string" fixEmptiesReturnItem: type: "string" description: "
It specifies an item for empties return.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "EmptiesReturnConfigThis configuration entity defines the empties\ \ return process.
" com.gk_software.pos.api.model.config.process.flows.FindTransactionConfig: type: "object" required: - "promptReceiptDataConfig" - "resultType" properties: promptReceiptDataConfig: description: "This config defines the PromptReceiptData dialog.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.ui.PromptReceiptDataConfig" resultType: type: "string" description: "This parameter defines the data object which the parent process\ \ needs to get retrieved (either transaction id or transaction itself).
value: FindTransactionResultType [TRANSACTION, TRANSACTION_ID]
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FindTransactionConfigThis configuration entity defines the find\ \ process for transactions.
" com.gk_software.pos.api.model.config.process.flows.GoodsReturnConfig: type: "object" required: - "allowedTendersConfig" - "createReturnReceipt" - "customerIdentificationConfig" - "onlyOneReturnPosition" - "originalBusinessUnitIdRequired" - "originalDateRequired" - "originalFiscalDayNumberRequired" - "originalFiscalDeviceNumberRequired" - "originalFiscalSequenceNumberRequired" - "originalSequenceNumberRequired" - "originalWorkstationIdRequired" - "processId" - "registerCustomer" - "withOutOriginalSc" properties: processId: type: "string" description: "This parameter defines the unique process ID.
" authorizationConfig: description: "This config defines authorization related processes.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig" withOutOriginalSc: type: "boolean" description: "This parameter specifies whether a return is performed without\ \ original receipt.
values: true, false" registerCustomer: type: "boolean" description: "
This parameter specifies whether a customer must be assigned\ \ to the return.
values: true, false" onlyOneReturnPosition: type: "boolean" description: "
This parameter specifies whether the return mode will be\ \ finished automatically after one return line item.
values:\ \ true, false" createReturnReceipt: type: "boolean" description: "
This parameter specifies whether a return receipt is created.\ \ This receipt includes only return line items.
values: true,\ \ false" customerIdentificationConfig: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.CustomerIdentificationConfig" allowedTendersConfig: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AllowedTendersConfig" originalBusinessUnitIdRequired: type: "boolean" description: "
It defines if the original business unit id must be entered\ \ in case of return without receipt.
" originalDateRequired: type: "boolean" description: "It defines if the original date must be entered in case of\ \ return without receipt.
" originalWorkstationIdRequired: type: "boolean" description: "It defines if the original workstation id must be entered\ \ in case of return without receipt.
" originalSequenceNumberRequired: type: "boolean" description: "It defines if the original receipt number must be entered\ \ in case of return without receipt.
" originalFiscalDeviceNumberRequired: type: "boolean" description: "It defines if the original fiscal device number must be entered\ \ in case of return without receipt.
" originalFiscalSequenceNumberRequired: type: "boolean" description: "It defines if the original fiscal sequence number must be\ \ entered in case of return without receipt.
" originalFiscalDayNumberRequired: type: "boolean" description: "It defines if the original fiscal day number must be entered\ \ in case of return without receipt.
" requiredOriginalReceiptData: type: "object" description: "Map of original receipt data to save in sale return line\ \ item extensions.
" additionalProperties: type: "string" returnWithTransactionConfig: description: "This config defines the return with transaction process.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.ReturnWithTransactionConfig" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "GoodsReturnConfigThis configuration entity defines the goods\ \ return process.
" com.gk_software.pos.api.model.config.process.flows.ItemEntryConfig: type: "object" required: - "confirmDialogAgeVerifacation" - "forceManualWeight" - "itemIDCaseSensitive" - "itemNotFoundAuthorizationConfig" - "itemRegistrationConfig" - "manualPriceAcousticSignalConfigId" - "negativePositionProhibited" - "positionOperationConfig" - "priceDifferenceLimitExceedAuthConfig" - "processId" - "promotionOperationConfig" - "promptForReceiptTextConfig" - "promptForSerialNumberConfig" - "quantityAccumulation" - "quantityAcousticSignalConfigId" - "remoteServiceNotAvailableAuthorizationConfig" - "returnManualPriceRequired" - "serialNumberAcousticSignalConfigId" - "setQuantityForLineItemConfigId" properties: processId: type: "string" description: "This parameter defines the unique process ID.
" authorizationConfig: description: "This config defines authorization related processes.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig" fixedItemNrEan: type: "string" description: "This parameter defines a fixed item number/ EAN for fixed\ \ item keys.
" itemNrEan: type: "string" description: "This parameter defines the input for the item number/ EAN.
" itemTraceableUnitID: type: "string" description: "Input parameter for item traceable unit id (used for EPC\ \ codes scanned by RFID, for example)
" registrationNumber: type: "string" description: "Raw barcode used for registration.
" textClassIds: type: "array" description: "This parameter defines text class IDs.
" items: type: "string" uomCode: type: "string" description: "This parameter defines the unit of measure code.
" checkSalesRestrictions: type: "boolean" description: "This parameter specifies whether sales restrictions are verified.\ \ The default is set at true.
values: true, false" checkSalesRestrictionsForReturn: type: "boolean" description: "
This parameter specifies whether sales restrictions are verified\ \ for return items. The default is set at false.
values: true,\ \ false" checkForVariants: type: "boolean" description: "
This parameter specifies whether a check is made for item\ \ variants. The default is set at false.
values: true, false" checkTaxGroup: type: "boolean" description: "
This parameter specifies whether the tax group should be\
\ validated.
\t
\tThis means that the tax group exists in\
\ master data and fulfills the following conditions: TaxGroupRule.EffectiveDateTime\
\ <= {current timestamp} and TaxGroupRule.ExpirationDateTime >= {current\
\ timestamp}.
\t
\tThe default is set at true.
values: true, false" takeoverSetComponents: type: "boolean" description: "
This parameter specifies whether set components are applied\ \ instead of the header item. The default is set at false.
values:\ \ true, false" askForQuantity: type: "boolean" description: "
This parameter specifies whether a quantity is requested.\ \ The default is set at false.
values: true, false" ageVerificationRequired: type: "boolean" checkSellerAgeRestrictions: type: "boolean" description: "
This parameter specifies whether seller age should be checked.
" confirmDialogAgeVerifacation: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.ui.MessageDialogConfig" positionAmount: type: "number" format: "double" description: "This parameter defines the line item amount.
" itemPrice: type: "number" format: "double" description: "This parameter defines the unit price.
" factor: type: "number" format: "double" description: "This parameter defines the packaging quantity of an item.
" itemQuantity: type: "integer" format: "int32" description: "The parameter defines the single quantity in case of piece\ \ items.
" weight: type: "number" format: "double" serialNumber: type: "string" description: "This parameter defines the serial number.
" saleableWithoutPrice: type: "boolean" description: "This parameter specifies whether an item is salable even\ \ if no price exists. The default is set at true.
values:\ \ true, false" switchToItemSearch: type: "boolean" description: "
This parameter specifies whether the system switches to Item\ \ Search if no search term exists. The default is set at true.
values:\ \ true, false" askForReceiptText: type: "boolean" description: "
This parameter specifies whether the receipt text of the\ \ item is requested. The default is set at false.
values:\ \ true, false" mode: type: "integer" format: "int32" description: "
This parameter defines the mode. The default is set at 0.
values: 0, 1, 2
This parameter specifies whether the total price entry is\ \ requested in case of return of weighing items. The value is set by Goods\ \ Return.
values: true, false" returnReasonRequired: type: "boolean" description: "
This parameter specifies whether the reason is requested\ \ in case of returns. The value is set by Goods Return.
values:\ \ true, false" returnManualPriceRequired: type: "boolean" description: "
This parameter specifies whether a manual price entry is\ \ requested in case of returns. The value is set by Goods Return.
values: true, false" promptForReceiptTextConfig: description: "
This config defines the Enter ReceiptText Dialog.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.ui.PromptUserDialogConfig" promptForSerialNumberConfig: description: "This config defines the Enter SerialNumber Dialog.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.ui.PromptUserDialogConfig" positionOperationConfig: description: "This config defines the position operation for registering.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" priceDifferenceLimitExceedAuthConfig: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig" promotionOperationConfig: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PromotionOperationConfig" forceManualWeight: type: "boolean" quantityAccumulation: type: "boolean" description: "It defines if the quantity of line items with the same item\ \ should be accumulated.
values: true, false" itemRegistrationConfig: description: "
It references the item details config to determine if additional\ \ info is needed
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.ItemRegistrationConfig" itemIDCaseSensitive: type: "boolean" manualPriceAcousticSignalConfigId: type: "string" description: "It references the acoustic signal configuration identifier\ \ for manual price input
" quantityAcousticSignalConfigId: type: "string" description: "It references the acoustic signal configuration identifier\ \ for quantity input
" serialNumberAcousticSignalConfigId: type: "string" description: "It references the acoustic signal configuration identifier\ \ for serial number input
" setQuantityForLineItemConfigId: type: "string" description: "It references the SetQuantityForLineItemConfig identifier\ \ for the SetQuantityForLineItem sub process call.
" negativePositionProhibited: type: "boolean" customerOrderData: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.CustomerOrderData" registerLineItemAddOnData: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.RegisterLineItemAddonData" additionalAttributes: description: "References the instance of configuration which indicates\ \ additional item related attributes to be assigned to sale return line\ \ item extensions during item registration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AdditionalAttributes" registerFuelLineItem: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.RegisterFuelLineItem" removeOpenLineItemOnError: type: "boolean" description: "It defines if an open line item (without item) will be removed\
\ if item entry fails with error.
\tIt should be set to true for barcode\
\ rules with multiple actions where second action is the item entry process.
\tDefault: null/false
config item not found authorization. Mainly to be used by\ \ POS clients that will display an authorization error on item search failure\ \ (Ex: SCO)
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig" remoteServiceNotAvailableAuthorizationConfig: description: "config to handle remote service not available authorization\ \ errors, when doing remote item searches in SDC / SAP
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig" itemProvider: type: "string" description: "The parameter defines the provider for the item data. Default\ \ Local.
" enum: - "Local" - "LocalAndRemote" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ItemEntryConfigThis configuration entity defines itemEntry processes.
" com.gk_software.pos.api.model.config.process.flows.ItemRegistrationConfig: type: "object" required: - "alternativeTaxConfig" - "createLayawayConfig" - "defaultTareConfig" - "discountInfoEnabled" - "emptiesReturnConfig" - "goodsReturnConfig" - "itemImageEnabled" - "itemInfoEnabled" - "payTowerErrorDialog" - "processBarcodeConfig" - "processId" - "promptReceiptDataConfig" - "rescanConfig" - "subtotalPositionOperationConfig" - "toggleTareFixConfig" - "transactionPreviewContextConfig" - "transactionPreviewShowMessage" properties: processId: type: "string" description: "This parameter defines the unique process ID.
" authorizationConfig: description: "This config defines authorization related processes.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig" processBarcodeConfig: description: "This configuration defines barcode processes.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.ProcessBarcodeConfig" transactionPreviewContextConfig: description: "This configuration defines the transaction preview.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.ui.TransactionPreviewContextConfig" transactionPreviewShowMessage: description: "This parameter defines the configuration for the transaction\ \ preview in connection with the function Show Message.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.ui.TransactionPreviewContextConfig" subtotalPositionOperationConfig: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" promptReceiptDataConfig: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.ui.PromptReceiptDataConfig" payTowerErrorDialog: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.ui.MessageDialogConfig" goodsReturnConfig: description: "This configuration defines the goods return process.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.GoodsReturnConfig" emptiesReturnConfig: description: "This configuration defines the empties return process.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.EmptiesReturnConfig" alternativeTaxConfig: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AlternativeTaxConfig" defaultTareConfig: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.SetDefaultTareConfig" toggleTareFixConfig: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.ToggleTareFixConfig" permanentCustomerInformationConfig: description: "This configuration defines the permanent customer information\ \ panel.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.PermanentCustomerInformationConfig" createLayawayConfig: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.CreateLayawayConfig" rescanConfig: description: "It defines the rescan configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.RescanConfig" discountInfoEnabled: type: "boolean" description: "It defines if the discount info should be displayed in transaction\ \ preview.
" itemInfoEnabled: type: "boolean" description: "It defines if the item info should be displayed in transaction\ \ preview.
" itemImageEnabled: type: "boolean" iconSalesInfoTextTypeCodes: type: "array" description: "It defines a list of text type codes that should be displayed\ \ as icon sales info.
" items: type: "string" textSalesInfoTextTypeCodes: type: "array" description: "It defines a list of text type codes that should be displayed\ \ as text sales info.
" items: type: "string" salesInfoTextLimit: type: "integer" format: "int32" terminalDisplayLinesConfigId: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ItemRegistrationConfigThis configuration entity defines the\ \ item registration process.
" com.gk_software.pos.api.model.config.process.flows.MerchandiseHierarchyGroupPrinterAssignmentConfig: type: "object" properties: merchandiseHierarchyGroupIdSet: type: "string" description: "The parameter defines a list of merchandise hierarchy groups\ \ IDs separated by semicolon. All line items of the order with the merchandise\ \ hierarchy group defined in this list, are printed on the printer which\ \ has a reference to this parameter.
" merchandiseHierarchyGroupIdQualifier: type: "string" description: "The parameter defines the qualifier of the merchandise hierarchy\ \ group.
" reportId: type: "string" description: "The parameter defined the report ID which should be used\ \ for the printout.
" externalMerchandiseHierarchyGroupId: type: "string" description: "The parameter defines an external merchandise hierarchy group\ \ ID list as integer, which is used on the KDS system to display the ordered\ \ items on the corresponding screens (e.g. food items on kitchen display,\ \ drinks on the bar display).
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "MerchandiseHierarchyGroupPrinterAssignmentConfigThe configuration\ \ entity defines the MHG to printer assignment.
" com.gk_software.pos.api.model.config.process.flows.PermanentCustomerInformationConfig: type: "object" required: - "displayAllowedTenderGroup" - "displayBuyerName" - "displayBuyerNumber" - "displayCustomerName" - "displayCustomerNumber" - "processId" properties: processId: type: "string" description: "This parameter defines the unique process ID.
" authorizationConfig: description: "This config defines authorization related processes.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig" displayCustomerNumber: type: "boolean" description: "This parameter specifies whether the customer number is displayed\ \ permanently in the Permanent Customer Information Panel.
values:\ \ true, false" displayCustomerName: type: "boolean" description: "
This parameter specifies whether the customer name is displayed\ \ permanently in the Permanent Customer Information Panel.
values:\ \ true, false" displayBuyerNumber: type: "boolean" description: "
This parameter specifies whether the buyer number is displayed\ \ permanently in the Permanent Customer Information Panel.
values:\ \ true, false" displayBuyerName: type: "boolean" description: "
This parameter specifies whether the buyer name is displayed\ \ permanently in the Permanent Customer Information Panel.
values:\ \ true, false" displayAllowedTenderGroup: type: "boolean" description: "
This parameter specifies whether the allowed tender group\
\ is displayed permanently in the Permanent Customer Information Panel.
\tThe allowed tender group is the CustomerTenderGroup.CustomerTenderGroupDescription\
\ of the Customer.AllowedTermsOfPayment.
values: true, false" xXCustom06: type: "string" description: "
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PermanentCustomerInformationConfigThis configuration entity\ \ defines the permanent customer information panel.
" com.gk_software.pos.api.model.config.process.flows.PrintOrderConfig: type: "object" required: - "merchandiseHierarchyGroupPrinterAssignmentConfigs" properties: merchandiseHierarchyGroupPrinterAssignmentConfigs: type: "array" description: "It defines a set of printing rules.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.MerchandiseHierarchyGroupPrinterAssignmentConfig" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PrintOrderConfigThis configuration entity defines the print\ \ order process.
" com.gk_software.pos.api.model.config.process.flows.RegisterFuelLineItem: type: "object" properties: fuelingPointId: type: "string" description: "Defines the Fueling Point Id (pump) where the transaction\ \ started
" gradeId: type: "string" description: "Defines grade Id of the fuel product
" stackPosition: type: "integer" format: "int32" description: "Defines internal transaction number for the fuel services
" fuelSaleStatusCode: type: "string" description: "This parameter defines fuel transaction type
values:\ \ PREPAY, PREPAYREFUND, PREPAYREFUNDZERO, PREPAYREFUND_CASH, POSTPAY, PAYATPUMP,\ \ PAYATPUMPZERO" presetAmount: type: "number" format: "double" description: "
Defines the preset amount in case of prepay transactions
" fuelPrepayItem: type: "string" description: "Defines the pos item id for the generic prepay item
" fuelPrepayItemUOMCode: type: "string" description: "Defines the pos item UOM code for the generic prepay item
" description: "RegisterFuelLineItemThis entity defines fuel data from app enablement\ \ to be assigned to fuel sale return line item during item registration
" com.gk_software.pos.api.model.config.process.flows.RegisterLineItemAddonData: type: "object" properties: language: type: "string" isoCurrencyCode: type: "string" actualUnitPrice: type: "number" format: "double" itemType: type: "string" retailPriceModifierList: type: "array" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.ExternalRetailPriceModifier" lineItemExtensionList: type: "array" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.LineItemExtension" printAdditionalLineItemTextLineList: type: "array" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.PrintAdditionalLineItemTextLine" description: "RegisterLineItemAddonData TODO: undocumented" com.gk_software.pos.api.model.config.process.flows.RescanConfig: type: "object" required: - "rescanEnabled" properties: rescanEnabled: type: "boolean" description: "Specifies whether the rescan feature is enabled or not.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RescanConfigThe configuration entity defines global configurations\ \ of the rescan processes.
" com.gk_software.pos.api.model.config.process.flows.ReturnWithTransactionConfig: type: "object" required: - "checkIfItemsExistInMasterData" - "conditionSplitConfig" - "differentStoreAllowed" - "findTransactionConfig" - "promptUserConfig" - "returnLineItem" - "returnPrepaidAllowed" - "returnReasonGroupCode" - "returnReasonRequired" - "returnTransaction" - "takeOverCustomersFromOriginalSc" - "transactionPreview" properties: returnTransaction: description: "PositionOperationConfig
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" returnLineItem: description: "PositionOperationConfig
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" promptUserConfig: description: "This config defines the prompt usage.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.ui.PromptUserDialogConfig" transactionPreview: description: "This parameter defines the configuration for the transaction\ \ preview. The config parameters will be passed to the transaction preview\ \ component, controller, report and datasource.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.ui.TransactionPreviewContextConfig" returnReasonRequired: type: "boolean" description: "This parameter specifies whether the reason is requested\ \ in case of returns.
values: true, false" returnPrepaidAllowed: type: "boolean" description: "
This parameter specifies whether it is allowed to return\ \ prepaid line items in case of a return with receipt data.
values:\ \ true, false" differentStoreAllowed: type: "boolean" description: "
This parameter specifies whether it is allowed to perform\ \ a return with a original receipt for receipts from other stores.
values: true, false" takeOverCustomersFromOriginalSc: type: "boolean" description: "
This parameter specifies whether the customer data is transferred\ \ from the original receipt.
values: true, false" returnReasonCode: type: "string" description: "
This parameter defines the reason for the return.
" returnReasonGroupCode: type: "string" description: "This parameter filters reasons with the following reason\ \ group code.
" findTransactionConfig: description: "FindTransactionConfig
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.FindTransactionConfig" checkIfItemsExistInMasterData: type: "boolean" description: "It defines if the items must exist in master data for return\ \ with transaction.
" conditionSplitConfig: description: "ConditionSplitConfig
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.ConditionSplitConfig" manualDiscountTypes: type: "array" description: "This parameter defines the list of condition types for price\
\ reduction.
\t@deprecated as of 5.6.0. Use instead: conditionSplitConfig.manualDiscountTypes
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ReturnWithTransactionConfigThis configuration entity defines\ \ the return process with an available transaction.
" com.gk_software.pos.api.model.config.process.flows.SetDefaultTareConfig: type: "object" required: - "defaultTareNotificationOnOperatorChange" - "processId" properties: processId: type: "string" description: "This parameter defines the unique process ID.
" authorizationConfig: description: "This config defines authorization related processes.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig" deviceId: type: "string" defaultTare: type: "integer" format: "int32" defaultTareNotificationOnOperatorChange: type: "boolean" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SetDefaultTareConfig TODO: undocumented" com.gk_software.pos.api.model.config.process.flows.ToggleTareFixConfig: type: "object" required: - "processId" properties: processId: type: "string" description: "This parameter defines the unique process ID.
" authorizationConfig: description: "This config defines authorization related processes.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig" deviceId: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ToggleTareFixConfig TODO: undocumented" com.gk_software.pos.api.model.config.process.ui.MessageDialogConfig: type: "object" required: - "cancelButtonKey" - "messageKey" - "messageType" - "okButtonKey" - "titleKey" properties: titleKey: type: "string" description: "This parameter defines the translation key for the title.
" signalConfigId: type: "string" description: "This parameter defines the configuration identifier for a\ \ SignalConfig instance. The resolved configuration will be used for an\ \ acoustic signal performed in combination with the message dialog.
" messageType: type: "string" description: "This parameter defines the type of the message to display.
value: DialogMessageType [INFO, CONFIRMATION, WARNING, ERROR]
This parameter defines the translation for the message.
" okButtonKey: type: "string" description: "This parameter defines the translation of the OK button.
" cancelButtonKey: type: "string" description: "This parameter defines the translation of the cancel button.
" isTimeControlled: type: "boolean" description: "This parameter specifies whether a dialog is time-controlled.
values: true, false" duration: type: "integer" format: "int32" description: "
This parameter defines the duration in msec for the time-controlled\ \ dialog.
" leaveAfterError: type: "boolean" description: "if true the process will be left, after an error was handled,\ \ otherwise the main step will be reentered.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "MessageDialogConfig TODO: undocumented" com.gk_software.pos.api.model.config.process.ui.PromptReceiptDataConfig: type: "object" required: - "businessDayDateEditable" - "businessDayDateRequired" - "businessDayDateUseCurrent" - "businessUnitIdEditable" - "businessUnitIdRequired" - "businessUnitIdUseCurrent" - "processId" - "receiptNumberEditable" - "receiptNumberRequired" - "receiptNumberUseCurrent" - "workstationIdEditable" - "workstationIdRequired" - "workstationIdUseCurrent" properties: processId: type: "string" description: "This parameter defines the unique process ID.
" dialogTitleKey: type: "string" description: "This parameter defines the key value for the prompt receipt\ \ data dialog title.
" forceManualInput: type: "boolean" description: "Force manual input. The input dialog will shown even all\ \ predefined values are filled
" businessUnitIdRequired: type: "boolean" description: "This parameter specifies whether a business unit ID will\ \ be returned and whether a business unit ID field will be visible in a\ \ dialog.
values: true, false" businessUnitIdEditable: type: "boolean" description: "
This parameter specifies whether a business unit ID field\ \ is editable.
values: true, false" businessUnitIdPredefined: type: "string" description: "
This parameter specifies a predefined business unit ID.
" businessUnitIdUseCurrent: type: "boolean" description: "This parameter specifies whether a current business unit\ \ ID shall be used if no predefined business unit ID is given.
values:\ \ true, false" businessDayDateRequired: type: "boolean" description: "
This parameter specifies whether a business day date will\ \ be returned and whether a business day date field will be visible in a\ \ dialog.
values: true, false" businessDayDateEditable: type: "boolean" description: "
This parameter specifies whether a business day date field\ \ is editable.
values: true, false" businessDayDatePredefined: type: "string" example: "'2018-05-16T16:09:24.394'" description: "
This parameter specifies whether a predefined value is used\ \ for the business day date. Example value: 2015-01-22
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" businessDayDateUseCurrent: type: "boolean" description: "This parameter specifies whether a current business day date\ \ shall be used if no predefined business day date is given.
values:\ \ true, false" workstationIdRequired: type: "boolean" description: "
This parameter specifies whether a workstation ID will be\ \ returned and whether a workstation ID field will be visible in a dialog.
values: true, false" workstationIdEditable: type: "boolean" description: "
This parameter specifies whether a workstation ID field is\ \ editable.
values: true, false" workstationIdPredefined: type: "string" description: "
This parameter specifies whether a predefined value is used\ \ for the workstation ID.
" workstationIdUseCurrent: type: "boolean" description: "This parameter specifies whether a current workstation ID\ \ shall be used if no predefined workstation ID is given.
values:\ \ true, false" receiptNumberRequired: type: "boolean" description: "
This parameter specifies whether a transaction sequence number\ \ will be returned and whether a transaction sequence number field will\ \ be visible in a dialog.
values: true, false" receiptNumberEditable: type: "boolean" description: "
This parameter specifies whether a transaction sequence number\ \ field will be editable.
values: true, false" receiptNumberPredefined: type: "string" description: "
This parameter specifies whether a predefined transaction\ \ sequence number is used.
" receiptNumberUseCurrent: type: "boolean" description: "This parameter specifies whether a current transaction sequence\ \ number shall be used if no predefined transaction sequence number is given.
values: true, false" useLastNonVoidedReceiptNumber: type: "boolean" description: "
This parameter specifies, whether only non voided retail\ \ transaction receipts should be considered?
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PromptReceiptDataConfigThis configuration entity defines the\ \ PromptReceiptData process.
" com.gk_software.pos.api.model.config.process.ui.PromptUserDialogConfig: type: "object" required: - "cancelAllowed" - "inputDomain" - "inputMandatory" - "titleKey" properties: titleKey: type: "string" description: "This parameter defines the translation key for the title.
" signalConfigId: type: "string" description: "This parameter defines the configuration identifier for a\ \ SignalConfig instance. The resolved configuration will be used for an\ \ acoustic signal performed in combination with the message dialog.
" inputDomain: type: "string" description: "This parameter defines the input domain for the input field.
" inputMandatory: type: "boolean" description: "This parameter specifies whether an input is mandatory.
values: true, false" cancelAllowed: type: "boolean" description: "
This parameter specifies whether the cancellation of the\ \ dialog is allowed.
values: true, false" labelTextKey: type: "string" description: "
This parameter defines an optional translation key for the\ \ label text.
" maxLengthOfTitleToSplit: type: "integer" format: "int32" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PromptUserDialogConfigThis configuration entity defines the\ \ process for prompting the user.
" com.gk_software.pos.api.model.config.process.ui.TransactionPreviewContextConfig: type: "object" required: - "advancedSelectionMode" - "cellEditAllowed" - "clearSelectionsForLastChangedRow" - "considerScopeTransactions" - "editLastChangedRow" - "horizontalPositioningType" - "rowSelectionAllowed" - "selectLastChangedRow" - "showChangeRounding" - "showHeader" - "showInlinePanel" - "showLastChangedRow" - "showLineItems" - "showReturnableQuantity" - "showSubtotalRounding" - "showTotals" - "showVoidedLineItems" - "templateName" properties: templateName: type: "string" description: "Name of the report template.
" languageScope: type: "string" description: "The language scope for the transaction preview report translations.\ \ Leave empty (null) to set the Transaction scope (with the system default\ \ locale) as default.
" enum: - "Operator" - "Customer" - "Transaction" - "MasterData" horizontalPositioningType: type: "string" enum: - "Char" - "Pixel" verticalLinePadding: type: "integer" format: "int32" verticalLineSpacing: type: "integer" format: "int32" considerScopeTransactions: type: "boolean" showHeader: type: "boolean" description: "This parameter specifies whether the header should be displayed\ \ or not.
values: true, false" showTotals: type: "array" description: "
This parameter specifies whether the total should be displayed\ \ or not.
" items: type: "string" rowSelectionAllowed: type: "boolean" description: "This parameter specifies whether a row selection is allowed\ \ in general.
values: true, false" cellEditAllowed: type: "boolean" description: "
This parameter specifies whether inline cell editing is allowed\ \ in general.
values: true, false" showReturnableQuantity: type: "boolean" description: "
Not supported.
\t@deprecated - never implemented in\
\ any release.
\tThis parameter specifies whether the returnable quantity\
\ for a line item should be displayed or not.
values: true,\ \ false" showLastChangedRow: type: "boolean" description: "
This parameter specifies whether the last changed row should\ \ be made visible.
values: true, false" selectLastChangedRow: type: "boolean" editLastChangedRow: type: "boolean" description: "
This parameter specifies whether the last changed row should\ \ be edited.
values: true, false" clearSelectionsForLastChangedRow: type: "boolean" advancedSelectionMode: type: "boolean" showVoidedLineItems: type: "boolean" showSubtotalRounding: type: "boolean" description: "
This parameter specifies whether the sub total rounding should\ \ be displayed or not.
values: true, false" showChangeRounding: type: "boolean" description: "
This parameter specifies whether the change rounding should\ \ be displayed or not.
values: true, false" showInlinePanel: type: "boolean" showLineItems: type: "array" description: "
This parameter specifies whether the line items for the given\ \ type codes should be displayed or not.
" items: type: "string" selectableLineItems: type: "array" description: "This parameter specifies whether line items for the given\ \ type codes are selectable or not.
" items: type: "string" selectableSaleReturnLineItems: type: "array" description: "This parameter specifies whether sale return line items for\ \ the given type codes are selectable or not. Has no effect if selectableLineItems\ \ does not include sale return line items.
" items: type: "string" saleReturnLineItemReturnTypes: type: "array" items: type: "string" editableLineItems: type: "array" description: "This parameter specifies whether line items for the given\ \ type codes are inline editable (cell editors) or not.
" items: type: "string" showFooter: type: "boolean" description: "Set whether the footer should be displayed or not. Default\ \ value is false.
values: true, false" xXCustom06: type: "string" description: "
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TransactionPreviewContextConfigThis configuration entity defines\ \ the transaction preview. The config parameters will be passed to the transaction\ \ preview component, controller, report and datasource.
" com.gk_software.pos.api.model.dom.app.ItemInformation.ItemInformation: type: "object" properties: businessUnitGroupID: type: "string" description: "The business unit group ID
" itemID: type: "string" description: "The item ID
" uomCode: type: "string" description: "The unit of measure code
" uomName: type: "string" description: "The unit of measure name
" name: type: "string" description: "Name of the item
" mainPOSItemId: type: "string" description: "The main pos item id
" merchandiseHierarchyGroupName: type: "string" description: "Name of assigned merchandise hierarchy group.
" validPriceAmount: type: "number" format: "double" description: "Amount of the actual price.
" regularPriceAmount: type: "number" format: "double" description: "Amount of the regular price.
" validPriceExpiryDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "Expiration (end) time stamp of the actual price.
Date\ \ format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" deposit: type: "number" format: "double" description: "Amount of the deposit
" color: type: "string" description: "Specifies the color of the item.
\tItem characteristics\
\ entry with id COLOR is used to fill this value.
Specifies the size, e.g. in case of fashion the dress size.
\tItem characteristics entry with id SIZE is used to fill this value.
Code of related tax group.
" imageSrcIds: type: "string" description: "Item image url.
" authorisedForSale: type: "boolean" description: "A flag to indicate that the retail store is authorized to\ \ stock this particular item.
" internalStock: description: "Stock details related to local store.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.ItemInformation.StockAmountDetail" externalStocks: type: "array" description: "List of stock details from surrounding stores.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.ItemInformation.StockAmountDetail" itemView: description: "The ItemInformationView instance.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.ItemInformation.ItemInformationView" uomItemTextList: type: "array" description: "It contains extended item information. The content is a filtered\ \ view on uom item text list. Filtering is done by text class ids defined\ \ in configuration.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.ItemInformation.UomItemText" prices: type: "array" description: "List of aviable price entries.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.ItemInformation.Price" itemInfoIcons: type: "array" description: "It contains details about item info icons. The content is\ \ a filtered view on uom item text list. Filtering is done by text class\ \ ids defined in configuration.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.ItemInformation.UomItemText" discountInfoIcons: type: "array" description: "It contains details about available promotions - e.g. Pay\ \ 2 get 3, 10% off...
" items: $ref: "#/definitions/com.gk_software.pos.flow.libs.transaction.DiscountIconList" webshopItemInfoData: description: "It contains item informations requested from web shop system.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.ItemInformation.WebshopItemInfoData" variantsAvailable: type: "boolean" description: "It contains info about variants available for this item
" ePriceTypeCode: type: "string" description: "Type code of the actual price (00 = default price, 01 = special\ \ price)
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ItemInformationObject to consolidate item information (e.g.\ \ master data, stock details, etc.).
" com.gk_software.pos.api.model.dom.app.ItemInformation.ItemInformationView: type: "object" properties: validPriceAmount: type: "string" description: "Amount of the actual price.
" regularPriceAmount: type: "string" description: "Amount of the regular price.
" deposit: type: "string" description: "Amount of the deposit
" freeStock: type: "string" description: "Number of available items
" reservedStock: type: "string" description: "Number of reserved items.
" transferStock: type: "string" description: "Number of items with stock state TRANSFER
" inTransitStock: type: "string" description: "Number of items with stock state IN-TRANSIT.
" validPriceExpiryDate: type: "string" description: "Expiration (end) time stamp of the actual price.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ItemInformationView TODO: undocumented" com.gk_software.pos.api.model.dom.app.ItemInformation.Price: type: "object" properties: sequenceNumber: type: "integer" format: "int32" description: "The price entry sequence number. It defines the order (ascending)
" description: type: "string" description: "The description of the price.
" unitPrice: type: "number" format: "double" description: "The price for the unit.
" discountAmount: type: "number" format: "double" description: "In case of price modification this contains the discount\ \ amount.
" newPrice: type: "number" format: "double" description: "It contains the price after price modification or in case\ \ of regular/actual price the amount.
" priceQuantity: type: "integer" format: "int32" description: "The price quantity (the number of items the price is defined\ \ for, i.e. 3 for $1.00).
" quantity: type: "integer" format: "int32" description: "The item quantity which was used to calculate some value\ \ for this price entity.
" unitPriceWithCurrency: type: "string" description: "The unit price with currency attached.
\tPrice.PriceQuantity\
\ '/' Price.UnitPrice, if Price.PriceQuantity <> 1
\tPrice.UnitPrice\
\ otherwise
The discount amount with currency attached. As existing field\ \ is a double type, this one was added to accommodate currency.
" newPriceWithCurrency: type: "string" description: "The new price amount with currency attached. As existing\ \ field is a double type, this one was added to accommodate currency.
" priceGroupId: type: "string" description: "The price group id if exists.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PriceList of prices / price modifications.
\tIt contains\
\ entries for regular and actual price plus entries for each price modifier.
The item id
" uomCode: type: "string" description: "The unit of mesaure code.
" mainPOSItemId: type: "string" description: "The main pos item ID.
" storeId: type: "string" description: "The business unit id.
" storeDescription: type: "string" description: "Store description
" address: type: "string" description: "Store address
" phoneNumber: type: "string" description: "Store phone number
" distance: type: "number" format: "double" description: "Distance between that and the local store.
" name: type: "string" description: "Name of the item
" stock: type: "number" format: "double" description: "Number of item with stock state DEFAULT.
" inTransitStock: type: "number" format: "double" description: "Number of items with stock state IN-TRANSIT.
" reservedStock: type: "number" format: "double" description: "Number of reserved items.
" transferStock: type: "number" format: "double" description: "Number of items with stock state TRANSFER
" freeStock: type: "number" format: "double" description: "Number of items with stock state FREE
" inFlow: type: "number" format: "double" description: "Sum of items in TRANSFER and IN-TRANSIT state.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "StockAmountDetailEntity which contains stock details for one\ \ location.
" com.gk_software.pos.api.model.dom.app.ItemInformation.UomItemText: type: "object" properties: index: type: "integer" format: "int32" description: "The index of the entry.
" text: type: "string" description: "The value.
" description: "UomItemTextObject representing an instance of an UOM item text\ \ element.
" com.gk_software.pos.api.model.dom.app.ItemInformation.WebshopItemInfoData: type: "object" properties: description: type: "string" description: "The description of the item.
" name: type: "string" description: "The item name.
" averageRating: type: "number" format: "double" description: "The average rating.
" imageUrl: type: "string" description: "The image url
" stock: type: "string" description: "Number of item with stock state.
" code: type: "string" description: "The uom code
" manufacturer: type: "string" description: "The manufacturer.
" price: type: "string" description: "The item price
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "WebshopItemInfoDataItem informations from web shop.
" com.gk_software.pos.api.model.dom.app.amount.Amount: type: "object" properties: amount: type: "number" format: "double" description: "The monetary amount value.
" currency: description: "Holds the currency for the amount (see [master_data_gkr.currency.v1_0_0.Currency]).
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.currency.dto.dom.CurrencyDO" description: "AmountA data object which encapsulates a monetary amount value\ \ for a certain currency.
" com.gk_software.pos.api.model.dom.app.gift_certificate_service.AttributeValue: type: "object" properties: name: type: "string" description: "Attribute name.
" value: type: "string" description: "Attribute value
" description: "AttributeValueAn additional attribute for gift certificates\ \ with a name and a value.
" com.gk_software.pos.api.model.dom.app.gift_certificate_service.GiftCertInfo: type: "object" properties: gcId: type: "integer" format: "int32" description: "Gift certificate id.
" gcNumber: type: "string" description: "Gift certificate number.
" amount: description: "Amount of the gift certificate.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" state: type: "string" description: "Gift certificate status: SELLABLE, REDEEMABLE, LOCKED, INVALID.
" validFrom: type: "string" example: "'2018-05-16T16:09:24.394'" description: "Start of gift certificate validity period.
Date format\ \ 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" validTo: type: "string" example: "'2018-05-16T16:09:24.394'" description: "End of gift certificate validity period
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" uuid: type: "string" description: "An unique transaction ID for the requested operation.
" overpaymentType: type: "string" description: "Defines the handling of over payments (NOT_ACCEPTED, NO_CHANGE,\ \ GIFT_CERTIFICATE_CHANGE, CASH_CHANGE).
" blacklistedItems: type: "array" description: "Items that are not included when comparing the receipt total\ \ with the minimum transaction amount (MinSale).
" items: type: "string" blacklistedArticleGroupNumbers: type: "array" description: "Merchandise categories that are not included when comparing\ \ the receipt total with the minimum transaction amount (MinSale).
" items: type: "string" includeDiscountedArticlesToMinimumSale: type: "boolean" description: "Defines if discounted items will be included into minimum\ \ sale check.
" minimumTransactionAmount: description: "Minimum amount for this gift certificate.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" additionalInfo: type: "array" description: "Additional attributes for gift certificates sent by stored\ \ value server.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.gift_certificate_service.AttributeValue" track2: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "GiftCertInfoContains gift certificate attributes returned by\ \ the stored value server.
" com.gk_software.pos.api.model.dom.app.gift_certificate_service.GiftCertServiceResult: type: "object" properties: gcNumber: type: "string" description: "Gift certificate number.
" oldAmount: description: "Amount of the gift certificate before the transaction.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" newAmount: description: "Amount of the gift certificate after the transaction.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" validFrom: type: "string" example: "'2018-05-16T16:09:24.394'" description: "Start of gift certificate validity period.
Date format\ \ 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" validTo: type: "string" example: "'2018-05-16T16:09:24.394'" description: "End of gift certificate validity period
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" additionalInfo: type: "array" description: "List of additional attributes of the gift certificate.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.gift_certificate_service.AttributeValue" uuid: type: "string" description: "An unique transaction ID for the requested operation.
" track2: type: "string" description: "Gift certificate track2 data.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "GiftCertServiceResultA data object which is returned as a result\ \ of gift certificate operations.
" com.gk_software.pos.api.model.dom.app.promotion_input_request.PromotionInputRequest: type: "object" properties: promotionDescription: type: "string" description: "The promotion description.
" triggerValue: type: "string" description: "The promotion trigger value.
" thresholdValue: type: "number" format: "double" description: "The promotion threshold value.
" intervalValue: type: "number" format: "double" description: "The promotion interval value.
" limitValue: type: "number" format: "double" description: "The promotion limit value.
" privilegeType: type: "string" description: "The promotion privilege type.
" pointsFlag: type: "boolean" description: "A flag to indicate promotion points.
" lineItemSequenceNumber: type: "integer" format: "int32" description: "The line item sequence number.
" privilegeValue: type: "number" format: "double" description: "The promotion privilege value.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PromotionInputRequestA data object for request from promotion\ \ service to set additional input
" com.gk_software.pos.api.model.dom.app.services.transaction.ExternalRetailPriceModifier: type: "object" properties: retailPriceModifierSequenceNumber: type: "integer" format: "int32" description: "Retail price modifier line item sequence number.
" percent: type: "number" format: "double" description: "The percentage value in case of percentage price modifiers.
" amount: type: "number" format: "double" description: "The monetary value of the price modification that was given.
" extendedAmountBeforeModification: type: "number" format: "double" description: "The retail sale total price of the transaction before applying\ \ the current price modification line item.
" extendedAmountAfterModification: type: "number" format: "double" description: "The retail sale total price of the line item after applying\ \ the current price modifier.
" appliedQuantity: type: "number" format: "double" description: "The quantity the price modifier applies to.
" triggerSequenceNumber: type: "integer" format: "int32" description: "The identification of the manual trigger (because one line\ \ item can have more than one trigger).
" extraAmount: type: "number" format: "double" description: "A monetary amount which results from applying a price modifier\ \ but does not affect the line item total.
" roundingAmount: type: "number" format: "double" description: "The monetary amount that the price modifier was adjusted\ \ by.
" calculationBaseAmount: type: "number" format: "double" description: "The amount which was used as base for calculation of the\ \ price modification.
" retailTransactionPriceDerivationRule: description: "Retail transaction price derivation rule.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionPriceDerivationRule" saleReturnLineItemPromotionTriggerList: type: "array" description: "List of sale return line item promotion triggers.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.SaleReturnLineItemPromotionTrigger" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ExternalRetailPriceModifierExternal retail price modifier object.
" com.gk_software.pos.api.model.dom.app.services.transaction.LineItemExtension: type: "object" required: - "ExtensionKey" - "ExtensionValue" properties: ExtensionKey: type: "string" description: "Key identifier for line item extension.
" ExtensionValue: type: "string" description: "Value containing additional information for line item.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LineItemExtensionLine item extension entity. Line item extensions\ \ is used for providing additional information in retail transaction line items.
" com.gk_software.pos.api.model.dom.app.services.transaction.PosUOMItemDoKey: type: "object" required: - "businessUnitGroupID" - "itemID" - "uomCode" properties: businessUnitGroupID: type: "string" description: "A unique system assigned identifier for a group of BusinessUnits.
" itemID: type: "string" description: "Item identifier.
" uomCode: type: "string" description: "The code used to specify the unit of measure in which a value\ \ is being expressed, or manner in which a measurement has been taken.
" description: "PosUOMItemDoKeyKey identifier for POS item unit of measure object.
" com.gk_software.pos.api.model.dom.app.services.transaction.PrintAdditionalLineItemTextLine: type: "object" properties: text: type: "string" description: "Text value to be printed.
" sortOrder: type: "string" description: "Defines whether the text is printed before or after the line\
\ item.
\tPossible values: 'afterLineItem', 'beforeLineItem' and 'beforeSubtotalLine'.
Style identifier for a text printout.
\tPossible values:\
\ 'NormalPlain' and 'NormalBold'
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PrintAdditionalLineItemTextLineRequest object for printing additional\ \ text lines on receipts. This request object is used for instance in the processing\ \ of additional printout documents requested through app enablement feature.
" com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey: type: "object" required: - "businessUnitGroupID" - "retailTransactionLineItemSequenceNumber" - "transactionID" properties: businessUnitGroupID: type: "string" description: "A unique system assigned identifier for a group of BusinessUnits.
" transactionID: type: "string" description: "A universally unique identifier (UUID) for the Transaction.
" retailTransactionLineItemSequenceNumber: type: "integer" format: "int32" description: "The sequence number of line item within the context of this\ \ RetailTransaction.
" description: "RetailTransactionLineItemKeyKey identifier for retail transaction\ \ line items.
" com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionPriceDerivationRule: type: "object" required: - "exclusiveFlag" - "noEffectOnSubsequentPriceDerivationRulesFlag" - "printoutValidityPeriod" - "prohibitPrintFlag" - "prohibitTransactionRelatedPriceDerivationRulesFlag" - "promotionID" properties: promotionID: type: "string" description: "The unique identifier of the promotion.
" priceDerivationRuleID: type: "string" description: "The unique identifier of the price derivation rule.
" priceDerivationRuleEligibilityID: type: "string" description: "The unique identifier of the root eligibility.
" promotionDescription: type: "string" description: "Short description of the promotion.
" receiptPrinterName: type: "string" description: "Text to be printed on the receipt.
" promotionPriceDerivationRuleSequence: type: "string" description: "Promotion price derivation rule Sequence used for collision\
\ handling (multiple possible promotions applied to same transaction/line\
\ item).
\tUsed in combination with promotionPriceDerivationRuleResolution.
Promotion price derivation resolution used for collision\
\ handling (multiple possible promotions applied to same transaction/line\
\ item).
\tUsed in combination with promotionPriceDerivationRuleSequence.
The type code of the promotion price derivation rule.
" priceModificationMethodCode: type: "string" description: "A code denoting the method of modifying the price that is\ \ being applied to the transaction line item.
" priceDerivationRuleDescription: type: "string" description: "Business description for this price derivation rule.
" promotionOriginatorTypeCode: type: "string" description: "The type code of the originator of the promotion.
" externalPromotionID: type: "string" description: "The external identifier of the promotion.
" externalPriceDerivationRuleID: type: "string" description: "The external identifier of the price derivation rule.
" triggerQuantity: type: "number" format: "double" description: "The quantity of items fulfilling the eligibility which is\ \ required in order to trigger the price derivation rule.
" giftCertificateExpirationDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "End of the date range in which the gift certificate is valid.
\ \ Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" discountMethodCode: type: "string" description: "Determines how the discount influences the transaction.
" prohibitPrintFlag: type: "boolean" description: "Determines whether the result of the applied price derivation\ \ rule is to be suppressed on displays / not printed on the receipt; e.g.\ \ line item-related default points are not printed after each position,\ \ but only summarized at the end of the receipt.
" tenderTypeCode: type: "string" description: "A code which uniquely identifies the tender in case of rebate\ \ as tender.
" promotionTypeName: type: "string" description: "Promotion type name
" calculationBase: type: "string" noEffectOnSubsequentPriceDerivationRulesFlag: type: "boolean" description: "Determines whether applying this price derivation rule influences\ \ the calculation base of subsequent price derivation rules (false) or not\ \ (true).
" prohibitTransactionRelatedPriceDerivationRulesFlag: type: "boolean" description: "Determines whether applying this price derivation rule influences\ \ the calculation base of subsequent transaction-related price derivation\ \ rules (false) or not (true); is relevant for line item-related 'money'\ \ price derivation rules only.
" couponPrintoutID: type: "string" description: "The number of the printout coupon.
" couponPrintoutRule: type: "string" description: "The type code of the printout rule.
" couponPrintoutText: type: "string" description: "The formatted text of the printout coupon.
" exclusiveFlag: type: "boolean" description: "Determines whether this price derivation rule is an exclusive\ \ one.
" concurrenceControlVector: type: "string" description: "Determines how this price derivation rule works in relation\ \ to other applicable price derivation rules.
" appliedCount: type: "number" format: "double" description: "Describes how often the current price derivation rule was\ \ applied.
" printoutValidityPeriod: type: "number" format: "double" description: "Describes how long (how many days) the printed coupon/gift\ \ certificate is valid.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RetailTransactionPriceDerivationRuleRetail transaction price\ \ derivation rule describes a promotion rule.
" com.gk_software.pos.api.model.dom.app.services.transaction.SaleReturnLineItemPromotionTrigger: type: "object" required: - "PrivilegeType" - "PrivilegeValue" - "TriggerType" - "TriggerValue" - "triggerSequenceNumber" properties: triggerSequenceNumber: type: "integer" format: "int32" description: "The identification of the manual trigger (because one line\ \ item can have more than one trigger).
" TriggerType: type: "string" description: "The type of the trigger (referencing to POS configuration).
" TriggerValue: type: "string" description: "The value of the trigger (referencing to POS configuration).
" PrivilegeType: type: "string" description: "Defines the method for price modification.
" PrivilegeValue: type: "number" format: "double" description: "Reduction amount, reduction percent or new price amount.
" ReasonCode: type: "string" description: "Reason code for the manual discount.
" ReasonDescription: type: "string" description: "A narrative description describing the manual discount reason.
" TriggerSequenceAddend: type: "string" description: "A value which is to be added to the sequence of the condition\ \ (which comes from the master data).
" description: "SaleReturnLineItemPromotionTriggerPromotion trigger for a sale\ \ return line item.
" com.gk_software.pos.api.model.dom.app.services.transaction.SaleReturnTaxLineItemKey: type: "object" required: - "businessUnitGroupID" - "retailTransactionLineItemSequenceNumber" - "taxSequenceNumber" - "transactionID" properties: businessUnitGroupID: type: "string" description: "A unique system assigned identifier for a group of BusinessUnits.
" transactionID: type: "string" description: "A universally unique identifier (UUID) for the Transaction.
" retailTransactionLineItemSequenceNumber: type: "integer" format: "int32" description: "The sequence number of line item within the context of a\ \ retail transaction.
" taxSequenceNumber: type: "integer" format: "int32" description: "Line item sequence number of the tax entry.
" description: "SaleReturnTaxLineItemKeyKey identifier for sale return tax line\ \ items.
" com.gk_software.pos.api.model.dom.app.services.transaction.TenderAuthorizationKey: type: "object" required: - "businessUnitGroupID" - "tenderAuthorizationSequenceNumber" - "transactionID" properties: businessUnitGroupID: type: "string" description: "A unique system assigned identifier for a group of BusinessUnits.
" transactionID: type: "string" description: "A universally unique identifier (UUID) for the Transaction.
" tenderAuthorizationSequenceNumber: type: "integer" format: "int32" description: "A unique sequence number for this TenderAuthorization.
\tNote: A particular TenderLineItem may have more than one TenderAuthorization\
\ attempt.
Key identifier for tender authorization.
" com.gk_software.pos.api.model.dom.app.services.transaction.TillDoKey: type: "object" required: - "businessUnitGroupID" - "tillID" properties: businessUnitGroupID: type: "string" description: "A unique system assigned identifier for a group of BusinessUnits.
" tillID: type: "string" description: "The unique identifier of a till.
" description: "TillDoKeyKey identifier for tills.
" com.gk_software.pos.api.model.dom.app.services.transaction.TransactionAdditionalPrintoutKey: type: "object" required: - "businessUnitGroupID" - "printoutSequenceNumber" - "transactionID" properties: businessUnitGroupID: type: "string" description: "A unique system assigned identifier for a group of BusinessUnits.
" transactionID: type: "string" description: "A universally unique identifier (UUID) for the Transaction.
" printoutSequenceNumber: type: "integer" format: "int32" description: "Line item sequence number corresponding to the additional\ \ printout.
" description: "TransactionAdditionalPrintoutKeyKey identifier for transaction\ \ additional printouts.
" com.gk_software.pos.api.model.dom.app.tender.TenderRegistration: type: "object" required: - "baseCurrencyCashAmount" - "baseCurrencyCoinsAmount" - "baseCurrencyNotesAmount" - "baseCurrencyRollsAmount" - "defaultCurrencyAmount" - "foreignCurrenciesCashAmount" - "foreignCurrencyAmounts" - "otherTenders" - "otherTendersAmount" - "tenderAmounts" - "totalAmount" properties: baseCurrencyNotesAmount: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationFormattedAmount" baseCurrencyCoinsAmount: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationFormattedAmount" baseCurrencyRollsAmount: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationFormattedAmount" baseCurrencyCashAmount: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationFormattedAmount" foreignCurrenciesCashAmount: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationFormattedAmount" otherTendersAmount: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationFormattedAmount" totalAmount: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationFormattedAmount" defaultCurrencyAmount: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationDefaultCurrencyTenderAmount" foreignCurrencyAmounts: type: "array" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationTenderAmount" otherTenders: type: "array" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationTenderAmount" tenderAmounts: type: "array" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationTenderAmount" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TenderRegistration TODO: undocumented" com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationCashTender: type: "object" required: - "amount" - "denominationDescription" - "denominationPieceValue" - "quantity" properties: quantity: type: "integer" format: "int32" denominationPieceValue: type: "number" format: "double" denominationDescription: type: "string" amount: type: "number" format: "double" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TenderRegistrationCashTender TODO: undocumented" com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationDefaultCurrencyTenderAmount: type: "object" required: - "amount" - "amounts" - "coins" - "currencySymbol" - "foreignCurrencyAmount" - "foreignCurrencyCode" - "foreignCurrencySymbol" - "formattedValue" - "notes" - "rolls" - "tender" - "tenderDescription" properties: tender: $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO" tenderDescription: type: "string" amount: type: "number" format: "double" currencySymbol: type: "string" foreignCurrencyAmount: type: "number" format: "double" foreignCurrencyCode: type: "string" foreignCurrencySymbol: type: "string" formattedValue: type: "string" notes: type: "array" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationCashTender" coins: type: "array" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationCashTender" rolls: type: "array" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationRoll" amounts: type: "array" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationTenderAmount" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TenderRegistrationDefaultCurrencyTenderAmount TODO: undocumented" com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationFormattedAmount: type: "object" required: - "currencyCode" - "formattedValue" - "value" properties: value: type: "number" format: "double" formattedValue: type: "string" currencyCode: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TenderRegistrationFormattedAmount TODO: undocumented" com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationRoll: type: "object" required: - "amount" - "denominationDescription" - "denominationPieceValue" - "quantity" - "rollCapacity" properties: quantity: type: "integer" format: "int32" denominationPieceValue: type: "number" format: "double" denominationDescription: type: "string" amount: type: "number" format: "double" rollCapacity: type: "integer" format: "int32" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TenderRegistrationRoll TODO: undocumented" com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationTenderAmount: type: "object" required: - "amount" - "currencySymbol" - "foreignCurrencyAmount" - "foreignCurrencyCode" - "foreignCurrencySymbol" - "formattedValue" - "tender" - "tenderDescription" properties: tender: $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO" tenderDescription: type: "string" amount: type: "number" format: "double" currencySymbol: type: "string" foreignCurrencyAmount: type: "number" format: "double" foreignCurrencyCode: type: "string" foreignCurrencySymbol: type: "string" formattedValue: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TenderRegistrationTenderAmount TODO: undocumented" com.gk_software.pos.api.model.dom.app.views.CustomerInfoTransactionData: type: "object" properties: timeStamp: type: "string" transactionDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" transactionTime: type: "string" lineItems: type: "string" value: type: "number" format: "double" storeId: type: "string" city: type: "string" id: type: "string" suspended: type: "boolean" suspendNumber: type: "string" totalAmount: type: "number" format: "double" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerInfoTransactionData TODO: undocumented" com.gk_software.pos.api.model.dom.app.views.TransactionSearchView: type: "object" properties: businessUnitGroupID: type: "string" transactionID: type: "string" operatorID: type: "string" workstationID: type: "string" businessUnitID: type: "string" businessUnitAddress: type: "string" sequenceNumber: type: "integer" format: "int32" beginDateTimestamp: type: "string" example: "'2018-05-16T16:09:24.394'" description: "Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" endDateTimestamp: type: "string" example: "'2018-05-16T16:09:24.394'" description: "Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" transactionTimestamp: type: "string" example: "'2018-05-16T16:09:24.394'" description: "Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" suspendedFlag: type: "boolean" suspendNumber: type: "string" totalAmount: type: "number" format: "double" totalLineItemCount: type: "integer" format: "int32" canceledFlag: type: "boolean" workerID: type: "string" workerFirstName: type: "string" workerLastName: type: "string" workerFullName: type: "string" transactionTypeCode: type: "string" transactionFactCriteriaTransactionTypeCode: type: "string" tillID: type: "string" description: "The unique identifier of the till.
" customerID: type: "string" description: "The unique system assigned identifier for the Customer(Buyer).
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TransactionSearchViewTransaction search view entity.
" com.gk_software.pos.api.model.dom.md.business_unit.BusinessUnitDOListByFilterResult: type: "object" properties: businessUnitDOs: type: "array" description: "businessUnitDOs
" items: $ref: "#/definitions/com.gk_software.gkr.api.server.md.business_unit.dto.dom.BusinessUnitDO" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "BusinessUnitDOListByFilterResultBusinessUnitDOListByFilterResult\ \
" com.gk_software.pos.api.model.dom.md.business_unit.BusinessUnitListByFilterRequest: type: "object" properties: businessUnitContactFilter: description: "businessUnitContactFilter
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.business_unit.dto.dom.BusinessUnitContactFilter" maxResultsCount: type: "integer" format: "int32" description: "maxResultsCount
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "BusinessUnitListByFilterRequestBusinessUnitListByFilterRequest\ \
" com.gk_software.pos.api.model.dom.md.business_unit.BusinessUnitView: type: "object" properties: businessUnitID: type: "string" businessUnitGroupID: type: "string" description: "businessUnitGroupID.
" name: type: "string" description: "name.
" territoryName: type: "string" description: "territoryName.
" city: type: "string" description: "city.
" postalCode: type: "string" description: "postalCode
" street: type: "string" description: "street
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "BusinessUnitViewBusinessUnitView
" com.gk_software.pos.api.model.dom.md.business_unit.BusinessUnitViewListByFilterResult: type: "object" properties: businessUnitViews: type: "array" description: "businessUnitViews
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.md.business_unit.BusinessUnitView" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "BusinessUnitViewListByFilterResultBusinessUnitDOListByFilterResult\ \
" com.gk_software.pos.api.service.client.hardware.scale.WeightResult: type: "object" required: - "pricingCapableScale" - "printoutDone" properties: posItemId: type: "string" weight: type: "number" format: "double" totalPrice: type: "number" format: "double" tare: type: "number" format: "double" weightType: type: "integer" format: "int32" dataHash: type: "string" pricingCapableScale: type: "boolean" printoutDone: type: "boolean" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "WeightResult TODO: undocumented" com.gk_software.pos.api.service.communication.ws.billdoc.BillDocRequest: type: "object" properties: invoiceNumber: type: "string" description: "The invoice number
" retailStoreId: type: "string" description: "The retailStore id
" workStationId: type: "string" description: "The workStation id
" trainingMode: type: "boolean" description: "Indicates whether service is called on training mode.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "BillDocRequestRequest object for the BillDocWebService
" com.gk_software.pos.api.service.communication.ws.billdoc.BillDocResponse: type: "object" required: - "amountOpenNow" - "netValue" - "taxAmount" properties: returnCode: type: "string" description: "The return code
" billType: type: "string" description: "The bill type
" netValue: type: "number" format: "double" description: "The net value
" taxAmount: type: "number" format: "double" description: "The tax amount
" amountOpenNow: type: "number" format: "double" description: "The open amount
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "BillDocResponseResponse object for the BillDocWebService
" com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerPhoneNumber: type: "object" properties: areaID: type: "string" description: "The area id
" subscriberID: type: "string" description: "The subscriber id
" extensionID: type: "string" description: "The extension id
" countryDiallingCode: type: "string" description: "The country dialling code
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerPhoneNumberBean class for Customer By Id WebService\ \ results interface.
" com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerWebServiceResultSAPERP: type: "object" properties: customerId: type: "string" description: "The customer id
" customerName: type: "string" description: "The customer name
" customerStreet: type: "string" description: "The customer street
" customerPostalCode: type: "string" description: "The customer postal code
" customerCity: type: "string" description: "The customer city
" customerHouseId: type: "string" description: "The customer house id
" emailAddress: type: "string" description: "The email address
" phoneNumber: description: "The phone number
" $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerPhoneNumber" cellPhoneNumber: description: "The cell phone number
" $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerPhoneNumber" faxPhoneNumber: description: "The fax phone number
" $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerPhoneNumber" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerWebServiceResultSAPERPBean class for Customer By Id\ \ WebService results interface.
" com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerWebserviceRequest: type: "object" properties: customerId: type: "string" description: "The customer id
" trainingMode: type: "boolean" description: "Indicates whether service should be called in training mode.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerWebserviceRequestRequest object for the CustomerByIdWebService
" com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerWebserviceResult: type: "object" properties: usedWebservice: type: "string" description: "The used web service
" sapErpResult: description: "The sap erp result
" $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerWebServiceResultSAPERP" crmResponse: description: "The crm response
" $ref: "#/definitions/com.gk_software.pos.api.service.crm.types.CustomerQueryResponse" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerWebserviceResultResult object for the CustomerByIdWebService
" com.gk_software.pos.api.service.communication.ws.customer_search_by_criteria.SearchCustomerRequest: type: "object" properties: customerId: type: "string" customerName: type: "string" customerStreet: type: "string" customerCity: type: "string" customerFederalState: type: "string" customerPostalCode: type: "string" customerCountry: type: "string" maxSearchResult: type: "integer" format: "int32" dataProvider: type: "string" phoneNumber: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SearchCustomerRequest TODO: undocumented" com.gk_software.pos.api.service.communication.ws.operation.FindCustomerByIdRequest: type: "object" properties: customerId: type: "string" description: "The customer id to search for.
" dataProvider: type: "string" description: "ID of data provider.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FindCustomerByIdRequestRequest object for the CustomerOperationService
" com.gk_software.pos.api.service.communication.ws.operation.FindCustomerByPartyIdentificationRequest: type: "object" properties: partyIdentification: type: "string" description: "An official number that is used to identify the party.
" dataProvider: type: "string" description: "ID of data provider.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FindCustomerByPartyIdentificationRequestRequest object for the\ \ CustomerOperationService
" com.gk_software.pos.api.service.communication.ws.operation.FindCustomerDataRequest: type: "object" properties: customerId: type: "string" description: "The customer id to search for.
" dataProvider: type: "string" description: "ID of data provider.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FindCustomerDataRequestRequest object for the CustomerOperationService
" com.gk_software.pos.api.service.communication.ws.operation.UpdateCustomerRequest: type: "object" properties: dataProvider: type: "string" description: "ID of data provider.
" customerData: description: "Customer data
" $ref: "#/definitions/com.gk_software.pos.flow.libs.customer.CustomerData" reason: description: "Specifies reason for update
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO" oldCustomer: description: "Old customer data. It must contain the state BEFORE update\ \ was applied.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO" customerDeclarationRequired: type: "boolean" description: "Defines if the customer declaration is necessary for permanent\ \ storage of the customer data.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "UpdateCustomerRequestRequest object for the CustomerOperationService
" com.gk_software.pos.api.service.communication.ws.payables_account.AccountBalanceRequest: type: "object" properties: customerID: type: "string" description: "The customer id.
" accountingArea: type: "string" description: "The accounting area.
" trainingMode: type: "boolean" description: "Indicates whether service is called in training mode.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AccountBalanceRequestRequest object for querying customer's\ \ account balance.
" com.gk_software.pos.api.service.communication.ws.payables_account.AccountBalanceResult: type: "object" properties: balanceEntries: type: "array" description: "The balance entry list.
" items: type: "number" format: "double" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AccountBalanceResultResult object for customer's account balance\ \ request.
" com.gk_software.pos.api.service.communication.ws.sales_order_basic.SalesOrdersRequest: type: "object" required: - "numberOfResults" - "onlyOpen" properties: customerIds: type: "array" description: "List of customer numbers used for sales orders search.
" items: type: "string" onlyOpen: type: "boolean" description: "Specifies whether only open orders are searched.
" numberOfResults: type: "integer" format: "int32" description: "Maximum number of search results.
" trainingMode: type: "boolean" description: "Indicates whether the service should be called in training\ \ mode.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrdersRequestRequest object for the SalesOrderBasicWebService.
" com.gk_software.pos.api.service.communication.ws.sales_order_basic.SalesOrdersResult: type: "object" properties: salesOrderBasicResults: type: "array" description: "The sales order basic result list.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_wrapper.SalesOrderBasicResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrdersResultResult object containing sales order details\ \ for sales order search.
" com.gk_software.pos.api.service.communication.ws.sales_order_by_id.SalesOrderByIdV3Request: type: "object" properties: orderNumber: type: "string" description: "The sales order number.
" trainingMode: type: "boolean" description: "Indicates whether service should be called in training mode.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrderByIdV3RequestRequest object for retrieving sales order\ \ details by its id.
" com.gk_software.pos.api.service.communication.ws.sales_order_by_id.SalesOrderByIdV3Result: type: "object" properties: id: type: "string" description: "The sales order id.
" date: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The sales order date.
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" totalValuesGrossAmount: type: "number" format: "double" description: "The total gross amount.
" totalValuesNetAmount: type: "number" format: "double" description: "The total net amount.
" totalValuesTaxAmount: type: "number" format: "double" description: "The total tax amount.
" statusCustomerOrderLifeCycleStatusCode: type: "string" description: "The customer order life cycle status code.
" processingTypeCode: type: "string" description: "Processing type code of sales order based on delivery type.
The customer id.
" priceComponents: type: "array" description: "The price component list.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_wrapper.SalesOrderPriceComponentV3" items: type: "array" description: "The item list.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_by_id.SalesOrderExtendedItemDataV3" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrderByIdV3ResultThe sales order details returned froma\ \ sales order search by id.
" com.gk_software.pos.api.service.communication.ws.sales_order_by_id.SalesOrderExtendedItemDataV3: type: "object" required: - "requestedQuantity" properties: id: type: "string" description: "The id
" description: type: "string" description: "The description
" productInternalId: type: "string" description: "The productInternalId
" productSalesMeasureUnitCode: type: "string" description: "The productSalesMeasureUnitCode
" requestDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The requestDate
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" deliveryTermsDeliveryPlantId: type: "string" description: "The deliveryTermsDeliveryPlantId
" requestedQuantity: type: "number" format: "double" description: "The requestedQuantity
" receivingPointId: type: "string" description: "The receivingPointId
" productStandardId: type: "string" description: "The product standard id
" productRejectionReasonCode: type: "string" description: "The product rejection reason code.
" itemPriceComponents: type: "array" description: "The item price component list.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_wrapper.SalesOrderPriceComponentV3" totalValuesRequestedQuantity: type: "number" format: "double" description: "The requested quantity.
" totalValuesConfirmedQuantity: type: "number" format: "double" description: "The confirmed quantity.
" totalValuesDeliveredQuantity: type: "number" format: "double" description: "The delivered quantity.
" totalValuesNetAmount: type: "number" format: "double" description: "The total net amount.
" totalValuesNetPrice: type: "number" format: "double" description: "The total net price.
" totalValuesTaxAmount: type: "number" format: "double" description: "The total tax amount.
" scheduleLines: type: "array" description: "The schedule line list.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SalesOrderCommonScheduleLine" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrderExtendedItemDataV3Sales order extended item data based\ \ on sales order common data.
" com.gk_software.pos.api.service.communication.ws.sales_order_change_request_confirmation.entities.ChangeConfirmationRequestItem: type: "object" properties: id: type: "string" description: "The item id.
" description: type: "string" description: "The item receipt text description.
" product_internalId: type: "string" description: "The product internal id.
" product_salesMeasureUnitCode: type: "string" description: "The product sales measure unit code.
" dateTerms_requestDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The delivery date.
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" deliveryTerms_deliveryPlantId: type: "string" description: "The id of plant where items will be delivered to. E.g.: store\ \ id.
" totalValues_requestedQuantity: type: "number" format: "double" description: "The requested quantity.
" salesTerms_rejectionReasonCode: type: "string" description: "Rejection reason (Token 0-2) for reversal of sales orders\ \ or order items.
" receivingPointParty_internalId: type: "string" description: "Pick up destination. This field describes the receiving point\
\ party for the items.
\tFor example, it is the current store id if\
\ it is an immediate pickup,
\tor another store's id if the sales\
\ order will be retrieved in a different store.
Price component condition data for the item.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_change_request_confirmation.entities.ChangeConfirmationRequestItemPriceComponent" buyerDocument_Id: type: "string" description: "Buyer document id (Token 1-35).
\tFormat: ffffddddddkkkbbbbbb
Action code for the request (Token 2).
\tPossible values:\
\
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ChangeConfirmationRequestItemRequest object of the Change Confirmation\ \ Item
" ? com.gk_software.pos.api.service.communication.ws.sales_order_change_request_confirmation.entities.ChangeConfirmationRequestItemPriceComponent : type: "object" properties: priceSpecificationElementTypeCode: type: "string" description: "It defines the price condition type in the SAP ERP system\ \ (eg.: 'VKP0').
" rate_DecimalValue: type: "number" format: "double" description: "Price condition value.
" rate_BaseDecimalValue: type: "number" format: "double" description: "The rate base decimal value.
" actionCode: type: "string" description: "Action code for the request (Token 2).
\tPossible values:\
\
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ChangeConfirmationRequestItemPriceComponentRequest object of\ \ the Change Confirmation Item Price Component
" ? com.gk_software.pos.api.service.communication.ws.sales_order_change_request_confirmation.entities.ChangeConfirmationRequestPriceComponent : type: "object" properties: priceSpecificationElementTypeCode: type: "string" description: "It defines the price condition type in the SAP ERP system\ \ (eg.: 'VKP0').
" rate_DecimalValue: type: "number" format: "double" description: "Price condition value.
" actionCode: type: "string" description: "Action code for the request (Token 2).
\tPossible values:\
\
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ChangeConfirmationRequestPriceComponentRequest object of the\ \ Change Confirmation Price Component.
" ? com.gk_software.pos.api.service.communication.ws.sales_order_change_request_confirmation.entities.SalesOrderChangeConfirmationRequest : type: "object" properties: storeId: type: "string" description: "The store id.
" date: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The date.
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no\ \ timezone)" posId: type: "string" description: "The POS id.
" sequenceNumber: type: "integer" format: "int32" description: "Sales order sequence number. This number is used for assembling\ \ a header uui for a sales order operation.
" deliveryBlockingReasonCode: type: "string" description: "The delivery blocking reason code.
" salesOrderId: type: "string" description: "Sales order number (Token of length 1-10).
" priceComponents: type: "array" description: "Price components containing condition data of the sales order.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_change_request_confirmation.entities.ChangeConfirmationRequestPriceComponent" items: type: "array" description: "Sales order items.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_change_request_confirmation.entities.ChangeConfirmationRequestItem" trainingMode: type: "boolean" description: "Indicates whether service is called on training mode.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrderChangeConfirmationRequestRequest object for creating\ \ a sales order change confirmation.
" ? com.gk_software.pos.api.service.communication.ws.sales_order_change_request_confirmation.entities.SalesOrderChangeConfirmationResult : type: "object" properties: id: type: "string" description: "Sales order number (Token of length 1-10).
" description: "SalesOrderChangeConfirmationResultResult object of the Sales\ \ Order Change Confirmation.
" com.gk_software.pos.api.service.communication.ws.sales_order_create_check.SalesOrderCreateCheckRequest: type: "object" properties: buyerDocument_Id: type: "string" description: "The buyer document id.
\tFormat: ffffddddddkkkbbbbbb
Processing type code of sales order based on delivery type.
Store number (Token of length 1-20).
" distributionChannelCode: type: "string" description: "It defines the code of the distribution channel in the SAP\ \ ERP system (Token of length 1-2). E.g.: 'V1'.
" divisionCode: type: "string" description: "It defines the division/section in the SAP ERP system (Token\ \ of length 1-2). E.g.: 'R1'.
" customerAdrType: type: "string" description: "The customer address type (e.g.: the customer card type from\ \ customer identification configuration is used in the POS client).
" customerId: type: "string" description: "The customer id.
" storeId: type: "string" description: "The store id.
" items: type: "array" description: "The item list.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_wrapper.SalesOrderCommonRequestItemData" trainingMode: type: "boolean" description: "Indicates whether the service call should be performed in\ \ training mode.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrderCreateCheckRequestRequest object for the SalesOrderCreateCheckWebService.
" com.gk_software.pos.api.service.communication.ws.sales_order_create_request_confirmation.entities.CreateConfirmationRequestItem: type: "object" properties: id: type: "string" description: "The item id.
" description: type: "string" description: "The item receipt text description.
" product_internalId: type: "string" description: "The product internal id.
" product_salesMeasureUnitCode: type: "string" description: "The product sales measure unit code.
" dateTerms_requestDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The delivery date.
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" deliveryTerms_deliveryPlantId: type: "string" description: "The id of plant where items will be delivered to. E.g.: store\ \ id.
" totalValues_requestedQuantity: type: "number" format: "double" description: "The requested quantity.
" receivingPointParty_internalId: type: "string" description: "Id of receiving point party (Token of length 1-32). E.g.:\ \ store id.
" priceComponents: type: "array" description: "Line item condition data.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_create_request_confirmation.entities.CreateConfirmationRequestItemPriceComponent" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateConfirmationRequestItemRequest object for a sales order\ \ item creation.
" ? com.gk_software.pos.api.service.communication.ws.sales_order_create_request_confirmation.entities.CreateConfirmationRequestItemPriceComponent : type: "object" properties: priceSpecificationElementTypeCode: type: "string" description: "It defines the price condition type in the SAP ERP system\ \ (eg.: 'VKP0').
" rate_DecimalValue: type: "number" format: "double" description: "Price condition value.
" rate_BaseDecimalValue: type: "number" format: "double" description: "The rate base decimal value.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateConfirmationRequestItemPriceComponentRequest object for\ \ the line item price component.
" ? com.gk_software.pos.api.service.communication.ws.sales_order_create_request_confirmation.entities.CreateConfirmationRequestPriceComponent : type: "object" properties: priceSpecificationElementTypeCode: type: "string" description: "It defines the price condition type in the SAP ERP system\ \ (eg.: 'VKP0').
" rate_DecimalValue: type: "number" format: "double" description: "Price condition value.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateConfirmationRequestPriceComponentRequest object for the\ \ sales order price component creation.
" ? com.gk_software.pos.api.service.communication.ws.sales_order_create_request_confirmation.entities.SalesOrderCreateConfirmationRequest : type: "object" properties: storeId: type: "string" description: "The store id.
" date: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The date.
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no\ \ timezone)" posId: type: "string" description: "The POS id.
" sequenceNumber: type: "integer" format: "int32" description: "Sales order sequence number. This number is used for assembling\ \ a header uui for a sales order operation.
" deliveryBlockingReasonCode: type: "string" description: "The delivery blocking reason code.
" processingTypecode: type: "string" description: "Processing type code of sales order based on delivery type.
Buyer document id (Token of length 1-35). Format: ffffddddddkkkbbbbbb
\tffff – store id with leading zeros
\tdddddd – date in format\
\ ddmmyy (each with leading zeros)
\tkkk – pos/workstation number with\
\ leading zeros
\tbbbbbb – transaction sequence number with leading\
\ zeros
Store number (Token of length 1-20).
" distributionChannelCode: type: "string" description: "It defines the code of the distribution channel in the SAP\ \ ERP system (Token of length 1-2). E.g.: 'V1'.
" divisionCode: type: "string" description: "It defines the division/section in the SAP ERP system (Token\ \ of length 1-2). E.g.: 'R1'.
" buyerParty_InternalId: type: "string" description: "Customer number (Token of length 1-12).
" priceComponents: type: "array" description: "Customer order condition data.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_create_request_confirmation.entities.CreateConfirmationRequestPriceComponent" items: type: "array" description: "The item list.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.sales_order_create_request_confirmation.entities.CreateConfirmationRequestItem" trainingMode: type: "boolean" description: "Indicates whether the service should be called in training\ \ mode.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrderCreateConfirmationRequestRequest object for a sales\ \ order creation.
" ? com.gk_software.pos.api.service.communication.ws.sales_order_create_request_confirmation.entities.SalesOrderCreateConfirmationResult : type: "object" properties: id: type: "string" description: "Sales order number (Token of length 1-10).
" uuid: type: "string" description: "Unique transaction ID.
" description: "SalesOrderCreateConfirmationResultResult object for the sales\ \ order creation.
" com.gk_software.pos.api.service.communication.ws.sales_order_sales_doc_read.SalesOrderSalesDocReadRequest: type: "object" properties: orderNumber: type: "string" description: "The order number of a sales order to be retrieved.
" storeId: type: "string" description: "The store id performing the request.
" workstationId: type: "string" description: "The workstation id performing the request.
" trainingMode: type: "boolean" description: "Indicates whether service is called on training mode.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrderSalesDocReadRequestRequest object for reading an existing\ \ sales order.
" com.gk_software.pos.api.service.communication.ws.sales_order_sales_doc_read.SalesOrderSalesDocReadResult: type: "object" properties: originalPrepayment: type: "number" format: "double" description: "The original prepayment.
" openPrepayment: type: "number" format: "double" description: "The open prepayment.
" actualPayment: type: "number" format: "double" description: "The actual payment.
" payedOpen: type: "number" format: "double" description: "The open payed amount.
" salesDocItems: type: "array" description: "The sales order document item list.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SalesOrderSalesDocItem" currency: type: "string" description: "The currency.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrderSalesDocReadResultThe result of a sales order read\ \ operation.
" com.gk_software.pos.api.service.communication.ws.sales_order_wrapper.SalesOrderBasicResult: type: "object" properties: id: type: "string" description: "The sales order number.
" date: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The date.
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no\ \ timezone)" creationDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The creation date.
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" total: type: "number" format: "double" description: "The total net value.
" formattedCreationDate: type: "string" description: "The formatted creation date.
" status: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrderBasicResultThe result object of a sales order search\ \ request.
" com.gk_software.pos.api.service.communication.ws.sales_order_wrapper.SalesOrderCommonRequestItemData: type: "object" required: - "requestedQuantity" properties: id: type: "string" description: "The id
" description: type: "string" description: "The description
" productInternalId: type: "string" description: "The productInternalId
" productSalesMeasureUnitCode: type: "string" description: "The productSalesMeasureUnitCode
" requestDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The requestDate
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" deliveryTermsDeliveryPlantId: type: "string" description: "The deliveryTermsDeliveryPlantId
" requestedQuantity: type: "number" format: "double" description: "The requestedQuantity
" receivingPointId: type: "string" description: "The receivingPointId
" priceComponentList: type: "array" description: "The price component list.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SalesOrderCommonPriceComponent" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrderCommonRequestItemDataBean class for Sales Order common\ \ request item data.
" com.gk_software.pos.api.service.communication.ws.sales_order_wrapper.SalesOrderPriceComponentV3: type: "object" properties: priceSpecificationElementTypeCode: type: "string" description: "The price specification element type code.
" rateDecimalValue: type: "number" format: "double" description: "The rate decimal value.
" rateBaseDecimalValue: type: "number" format: "double" description: "The rate base decimal value.
" calculatedAmount: type: "number" format: "double" description: "The calculated amount.
" effectiveIndicator: type: "boolean" description: "The effective indicator.
" inactivityReasonCode: type: "string" description: "The inactivity reason code.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrderPriceComponentV3Sales order price component object.
" com.gk_software.pos.api.service.coupon.CheckCouponRequestData: type: "object" required: - "couponSerialNumber" properties: couponSerialNumber: type: "string" description: "The coupon identifier
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CheckCouponRequestDataEntity for the coupon data in the request.
" com.gk_software.pos.api.service.coupon.CheckCouponsRequest: type: "object" required: - "coupons" - "header" - "uuid" properties: header: description: "The header data of the request.
" $ref: "#/definitions/com.gk_software.pos.api.service.coupon.CouponingRequestHeaderData" uuid: type: "string" description: "The uuid of the request.
" coupons: type: "array" description: "The coupon data of the request.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.coupon.CheckCouponRequestData" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CheckCouponsRequestRequest entity for 'Check Coupons' service.
" com.gk_software.pos.api.service.coupon.CheckCouponsResponse: type: "object" required: - "status" properties: status: description: "The status of the response
" $ref: "#/definitions/com.gk_software.pos.api.service.coupon.CouponingResponseStatus" coupons: type: "array" description: "The coupon data of the response
" items: $ref: "#/definitions/com.gk_software.pos.api.service.coupon.CheckCouponsResultData" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CheckCouponsResponseResponse entity for 'Check Coupons' service.
" com.gk_software.pos.api.service.coupon.CheckCouponsResultData: type: "object" properties: couponSerialNumber: type: "string" description: "The coupon identifier
" status: type: "string" description: "The state of the coupon
" enum: - "VALID" - "REDEEMED" - "EXPIRED" - "INVALID" - "BLOCKED" offerNumber: type: "string" description: "The offer number of the coupon
" remainingUseCount: type: "integer" format: "int32" description: "The remaining useable count of the coupon
" expirationTimestamp: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The expiry date of the coupon
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CheckCouponsResultDataEntity for the coupon data in the response.
" com.gk_software.pos.api.service.coupon.CouponingRequestHeaderData: type: "object" required: - "iSOCountryCode" properties: businessUnitId: type: "string" description: "Business unit of the requesting client
" workstationId: type: "string" description: "Workstation id of the requesting client
" transactionId: type: "string" description: "Transaction id of the client transaction
" softwareVersion: type: "string" description: "Software version of the requesting client
" clientAddress: type: "string" description: "Address of the requesting client
" iSOCountryCode: type: "string" description: "Country code where requesting client is located
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CouponingRequestHeaderDataEntity for the request header data.
" com.gk_software.pos.api.service.coupon.CouponingResponseError: type: "object" properties: code: type: "string" description: "The error code which occurred.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CouponingResponseErrorThe entity of the request execution error\ \ in the response.
" com.gk_software.pos.api.service.coupon.CouponingResponseStatus: type: "object" required: - "code" properties: code: type: "string" description: "The status code of the response
" enum: - "OK" - "ERROR" - "OFFLINE" error: description: "The error which may happen during the request execution.
" $ref: "#/definitions/com.gk_software.pos.api.service.coupon.CouponingResponseError" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CouponingResponseStatusThe entity of the status in the response.
" com.gk_software.pos.api.service.coupon.ReturnCouponsRequest: type: "object" required: - "header" properties: header: description: "The header data of the request.
" $ref: "#/definitions/com.gk_software.pos.api.service.coupon.CouponingRequestHeaderData" markAppliedCouponSerials: type: "boolean" description: "Flag if coupon serials should be marked as 'applied' on the\ \ transaction during return/redeem of coupons
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ReturnCouponsRequestRequest entity for 'Return/Redeem Coupons'\ \ service.
" com.gk_software.pos.api.service.coupon.ReturnCouponsResponse: type: "object" required: - "status" properties: status: description: "The status of the response
" $ref: "#/definitions/com.gk_software.pos.api.service.coupon.CouponingResponseStatus" transactionOperationResult: description: "The entity describing the result of the operation.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult" coupons: type: "array" description: "The coupon result data of the response
" items: $ref: "#/definitions/com.gk_software.pos.api.service.coupon.ReturnCouponsResultData" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ReturnCouponsResponseResponse entity for 'Return/Redeem Coupons'\ \ service.
" com.gk_software.pos.api.service.coupon.ReturnCouponsResultData: type: "object" properties: couponSerialNumber: type: "string" description: "The coupon identifier
" resultCode: type: "string" description: "The result code of the coupon return
" enum: - "SUCCESSFUL" - "ALREADY_REDEEMED" - "INVALID" - "EXPIRED" - "FAILED" - "BLOCKED" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ReturnCouponsResultDataEntity for the coupon result data in\ \ the response.
" com.gk_software.pos.api.service.crm.types.Address: type: "object" properties: addressLine1: type: "string" description: "String: The first line of the address, normally the street\ \ number and name.
" addressLine2: type: "string" description: "String: The second line of an address, normally the Flat\ \ or Building Suite number.
" addressLine3: type: "string" description: "String: The third line of the address.
" addressLine4: type: "string" description: "String: The fourth line of the address.
" addressLine5: type: "string" description: "String: The fifth line of the address.It is normally used\ \ for the salutation.
" city: type: "string" description: "String: The city, town or village component of the address.
" territory: type: "string" description: "String: The County, State, Province, Territory etc component\ \ of the address.
" territoryName: type: "string" description: "String: The name of the County, State, Province, Territory\ \ etc. component of the address.
" subTerritoryName: type: "string" description: "String: This field is used to specify the territory or city\ \ more concrete, for example for storing the district or suburb of a certain\ \ city.
" postalCode: type: "string" description: "String: The postal or zip code of the address.
" postalCodeExtension: type: "string" description: "String: The extension of the postal or zip code that further\ \ specifies a particular postal district.
" isoCountryCode: type: "string" description: "String: The ISO country code of the address.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AddressObject for address data
" com.gk_software.pos.api.service.crm.types.ContactMethod: type: "object" properties: contactPurposeTypeCode: type: "string" description: "String: contact purpose
DEFAULT\ \ – Default" contactMethodTypeCode: type: "string" description: "
INVOICE – Invoice
DELIVERY –\ \ Delivery
String: contact method
Address:" address: description: "
HOME - home address
HOMEPOSTALBOX - home\ \ postal box
WORK - work address
WORKPOSTALBOX\ \ - work postal box
CONTACT - contact address
\ \ Telephone:
HOMETELEPHONE – home telephone
\ \ HOMEMOBILEPHONE – home mobile phone
HOMEFAX\ \ – home fax
WORKTELEPHONE – work telephone
\ \ WORKMOBILEPHONE – work mobile phone
WORKFAX – work\ \ fax
Email:
HOMEEMAIL - home
\ \ WORKEMAIL
Address: address data
" $ref: "#/definitions/com.gk_software.pos.api.service.crm.types.Address" telephone: description: "Telephone: telephone data
" $ref: "#/definitions/com.gk_software.pos.api.service.crm.types.Telephone" eMailAddress: type: "string" description: "String: e-mail address
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ContactMethodData object for contact method
" com.gk_software.pos.api.service.crm.types.CustomerAccount: type: "object" properties: accountID: type: "string" description: "String: customer account number
" accountTypeCode: type: "string" description: "String: account type
00 - turnover\ \ of current year" balance: description: "
01 - discount of current year
\ \ 02 - points
Money: account balance
" $ref: "#/definitions/com.gk_software.pos.api.service.crm.types.Money" accountQueryReturnCode: type: "string" description: "String: return code for the customer account request
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerAccountData object customer account
" com.gk_software.pos.api.service.crm.types.CustomerGroup: type: "object" properties: customerGroupID: type: "string" description: "String: customer group ID
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerGroupData object CustomerGroup
" com.gk_software.pos.api.service.crm.types.CustomerIdentification: type: "object" properties: identifier: type: "string" description: "Identification number
" partyIdentificationTypeCode: type: "string" description: "Type of the identification number
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerIdentificationEntity for customer identification
" com.gk_software.pos.api.service.crm.types.CustomerQueryResponse: type: "object" required: - "crmOffline" properties: customerID: type: "string" description: "String: customer ID
" accountID: type: "string" description: "String: account ID
" person: description: "EntityInformation_Person: person entity information
" $ref: "#/definitions/com.gk_software.pos.api.service.crm.types.EntityInformation_Person" contactMethodList: type: "array" description: "ContactMethod: contact method list
" items: $ref: "#/definitions/com.gk_software.pos.api.service.crm.types.ContactMethod" customerGroupList: type: "array" description: "CustomerGroup: customer group list
" items: $ref: "#/definitions/com.gk_software.pos.api.service.crm.types.CustomerGroup" customerAccountList: type: "array" description: "CustomerAccount: customer account list
" items: $ref: "#/definitions/com.gk_software.pos.api.service.crm.types.CustomerAccount" customerIdentificationList: type: "array" description: "CustomerIdentification: customer identifications list
" items: $ref: "#/definitions/com.gk_software.pos.api.service.crm.types.CustomerIdentification" crmOffline: type: "boolean" description: "boolean: Indicates that CRM is offline
" cardNumber: type: "string" description: "String: card number
" preferredReceiptPrintoutTypeCode: type: "string" description: "String : preferredReceiptPrintoutTypeCode
\tIt defines\
\ the preferred printout type code of the customer:
\tCLIENT - Printout\
\ depends on client settings.
\tPRINTONLY - Customer wants to have\
\ a printed receipt.
\tMAILONLY - Customer wants to have the receipt\
\ per mail.
\tNOTHING - Customer wants to have nothing.
\tPRINTANDMAIL\
\ - Customer wants to have a printed receipt and a mail.
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerQueryResponseresponse object customer query
" com.gk_software.pos.api.service.crm.types.EntityInformation_Person: type: "object" properties: firstName: type: "string" description: "String: first name
" lastName: type: "string" description: "String: last name
" birthDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "Date: birth date
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" genderType: type: "string" description: "String: gender type
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "EntityInformation_PersonObject for holding person entity information
" com.gk_software.pos.api.service.crm.types.Money: type: "object" properties: amount: type: "number" format: "double" description: "Double: Amount with decimal places
" currency: type: "string" description: "String: Currency of the amount
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "MoneyData object Money
" com.gk_software.pos.api.service.crm.types.Telephone: type: "object" properties: countryDiallingCode: type: "string" description: "String: country dialling code
" areaID: type: "string" description: "String: area
" subscriberID: type: "string" description: "String: subscriber ID
" extensionID: type: "string" description: "String: extension ID
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TelephoneData object for telephone data
" com.gk_software.pos.api.service.data_privacy_log.StoreCustomerDataChangedDataEventRequest: type: "object" required: - "newCustomer" - "oldCustomer" - "reason" properties: oldCustomer: description: "The old customer data
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO" newCustomer: description: "The new customer data
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO" reason: description: "The reason for the change
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "StoreCustomerDataChangedDataEventRequestRequest object for StoreCustomerDataChangedDataEvent
" com.gk_software.pos.api.service.data_privacy_log.StoreCustomerDataCreatedDataEventRequest: type: "object" required: - "customer" - "reason" properties: customer: description: "The created customer data
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO" reason: description: "The reason for the creation
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "StoreCustomerDataCreatedDataEventRequestRequest object for StoreCustomerDataCreatedDataEvent
" com.gk_software.pos.api.service.data_privacy_log.StoreCustomerDataReadDataEventRequest: type: "object" required: - "customer" properties: customer: description: "The customer data
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "StoreCustomerDataReadDataEventRequestRequest object for StoreCustomerDataReadDataEvent
" com.gk_software.pos.api.service.data_privacy_log.StoreCustomerSearchCriteriaEventRequest: type: "object" required: - "customerContactFilter" properties: customerContactFilter: description: "The customer filter/search criteria
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerContactFilter" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "StoreCustomerSearchCriteriaEventRequestRequest object for StoreCustomerSearchCriteriaEvent
" com.gk_software.pos.api.service.digital_receipt.ProcessDigitalReceiptRequest: type: "object" required: - "pdf" properties: pdf: type: "string" description: "The pdf attachment that is the PDF base64 encoded combined\ \ receipts binary stream data
" digitalReceiptAction: type: "string" description: "The action code which should be executed for the digital\ \ receipt (EMail / QRCode)
" enum: - "None" - "Email" - "QRCode" digitalReceiptEmailAction: type: "string" description: "The action code for the email handling (Client / Backend)
" enum: - "Backend" - "Client" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ProcessDigitalReceiptRequestRequest entity for 'Add Digital\ \ Receipt' service.
" com.gk_software.pos.api.service.digital_receipt.ProcessDigitalReceiptResponse: type: "object" required: - "statusCode" - "transactionOperationResult" properties: statusCode: type: "string" description: "The status of the response.
" enum: - "OK" - "ERROR" - "OFFLINE" transactionOperationResult: description: "The entity describing the transaction result of the operation.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ProcessDigitalReceiptResponseResponse entity for 'Add Digital\ \ Receipt' service.
" com.gk_software.pos.api.service.ewic.EwicBasketRequest: type: "object" properties: transaction: description: "Transaction : The current transaction
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" stateCode: type: "string" description: "String : State code for eWIC card
" expirationDate: type: "string" description: "String : Expiration date for eWIC card
" prescription: type: "array" description: "EwicItemSubcategoryBenefitsResult[] : Benefits, UOM and Item\ \ SubCategory Description
" items: $ref: "#/definitions/com.gk_software.pos.api.service.ewic.EwicItemSubcategoryBenefitsResult" ewicPaymentOperationConfig: description: "EwicPaymentOperationConfig : The eWIC payment config
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.EwicPaymentOperationConfig" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "EwicBasketRequestRequest object for the EwicBasketRequest.
" com.gk_software.pos.api.service.ewic.EwicBasketResult: type: "object" properties: itemDescription: type: "string" description: "String : Item description from master data
" quantity: type: "number" format: "double" description: "double : Quantity of item purchased
" uomDesc: type: "string" description: "String : UOM description
" itemPrice: type: "number" format: "double" description: "double : Item extended amount
" categoryDesc: type: "string" description: "String : eWIC category description
" subcategoryDesc: type: "string" description: "String : eWIC sub-category description
" baseUOMCode: type: "string" description: "String : UOM code
" category: type: "string" description: "String : eWIC category code
" subcategory: type: "string" description: "String : eWIC sub-category code
" upcPluNumber: type: "string" description: "String : Item number
" lineNumber: type: "integer" format: "int32" description: "short: Item index
" benefitQuantity: type: "number" format: "double" description: "double: Quantity that is eligible to receive benefits, as\ \ obtained from the eWIC prescription
" ntePrice: type: "number" format: "double" description: "double: Not to exceed price
" status: type: "string" description: "EwicItemStatusType: Whether to apply WIC benefits for this\ \ item
" enum: - "WIC" - "NO_WIC" - "VOID" wicPurchaseIndicator: type: "boolean" description: "boolean: Specifies whether the item can be straddled
" splitEwicTender: type: "boolean" description: "boolean: Specifies whether the item will be tendered partially\ \ with eWIC
" regularUnitPrice: type: "number" format: "double" description: "double: Item regular unit price
" extendedDiscountAmount: type: "number" format: "double" description: "double: Item extended discount amount
" amount: type: "number" format: "double" description: "double: Item quantity multiply by item benefits quantity
" itemDisplayPrice: type: "number" format: "double" description: "double: Item price for confirmation screen
" itemVariance: type: "number" format: "double" description: "double: Item variance price for NTE
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "EwicBasketResultResult object for the EwicBasketResult.
" com.gk_software.pos.api.service.ewic.EwicItemSubcategoryBenefitsRequest: type: "object" properties: categoryCode: type: "string" description: "String : Item Category Code
" subcategoryCode: type: "string" description: "String : Item Sub Category Code
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "EwicItemSubcategoryBenefitsRequestRequest object for the EWicItemSubCategoryBenefits.
" com.gk_software.pos.api.service.ewic.EwicItemSubcategoryBenefitsResult: type: "object" properties: benefits: type: "number" format: "double" description: "double: Benefits
" uom: type: "string" subcategoryDesc: type: "string" description: "String : Item Sub Category Description
" category: type: "string" description: "String : eWIC category code
" subcategory: type: "string" description: "String : eWIC sub-category code
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "EwicItemSubcategoryBenefitsResultResult object for the EwicItemSubCategoryLib.
" com.gk_software.pos.api.service.ewic.EwicMatchingPrescriptionResult: type: "object" properties: ewicBasketresult: type: "array" items: $ref: "#/definitions/com.gk_software.pos.api.service.ewic.EwicBasketResult" failure: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "EwicMatchingPrescriptionResult TODO: undocumented" com.gk_software.pos.api.service.external.cart.ExternalCartData: type: "object" required: - "cartId" properties: cartId: type: "string" description: "The cart ID.
" customerId: type: "string" description: "The customer ID.
" totalItems: type: "integer" format: "int32" description: "The total item count of this cart.
" pickupItems: type: "integer" format: "int32" description: "The count of items to pick up in a store.
" deliveryItems: type: "integer" format: "int32" description: "The count of items to be delivered.
" totalPrice: description: "The total price of the whole cart, including discounts and\ \ delivery costs.
" $ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartDataPrice" deliveryCost: description: "The costs for delivery, usually calculated after the external\ \ service has all parameters, like delivery mode and delivery address.
" $ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartDataPrice" totalDiscounts: description: "The total amount of discounts applied to the cart by the\ \ external service.
" $ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartDataPrice" orderCalculated: type: "boolean" description: "A flag signaling if the cart has been calculated and is ready\ \ for order.
" totalPriceWithTax: description: "The total price including taxes applied by the external service
" $ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartDataPrice" entries: type: "array" description: "The line items of the cart.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartDataEntry" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ExternalCartDataRepresentation of an external cart provided\ \ by an external order service
" com.gk_software.pos.api.service.external.cart.ExternalCartDataEntry: type: "object" required: - "entryNumber" - "product" - "quantity" - "totalPrice" properties: entryNumber: type: "integer" format: "int32" description: "The reference number of the entry (usually an index number)
" product: description: "The product occupying this cart entry
" $ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartDataProduct" quantity: type: "integer" format: "int32" description: "The quantity of the product in the cart entry
" totalPrice: description: "The total price of this cart entry
" $ref: "#/definitions/com.gk_software.pos.api.service.external.cart.ExternalCartDataPrice" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ExternalCartDataEntryA single line item entry in the external\ \ cart.
" com.gk_software.pos.api.service.external.cart.ExternalCartDataPrice: type: "object" required: - "currencyIso" - "value" properties: currencyIso: type: "string" description: "the price currency expressed as ISO code
" value: type: "number" format: "double" description: "the price value
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ExternalCartDataPriceThe pricing information type used in the\ \ ExternalCart
" com.gk_software.pos.api.service.external.cart.ExternalCartDataProduct: type: "object" required: - "code" - "name" properties: code: type: "string" description: "The product identifier
" name: type: "string" description: "The name of the product
" purchasable: type: "boolean" description: "A flag signaling if product is currently purchasable or not
" stock: type: "integer" format: "int32" description: "The stock information, if available.
" url: type: "string" description: "A deeplink url to the product on the external service
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ExternalCartDataProductA single product representation.
" com.gk_software.pos.api.service.external.cart.ExternalCartLineItemRequest: type: "object" required: - "cartID" - "customerID" - "itemID" - "quantity" properties: cartID: type: "string" description: "The cart id.
" customerID: type: "string" description: "The customer id.
" itemID: type: "string" description: "The item id.
" quantity: type: "integer" format: "int32" description: "The quantity amount.
" pickupStore: type: "string" description: "Optional store identifier for pickups.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ExternalCartLineItemRequestAdd a lineitem to an external cart\ \ in external service
" com.gk_software.pos.api.service.external.cart.ExternalCartRequest: type: "object" required: - "anonymousCartGUID" - "cartID" - "customerID" properties: cartID: type: "string" description: "The cart id.
" customerID: type: "string" description: "The customer id.
" anonymousCartGUID: type: "string" description: "The anonymous cart id.
Note: some external\ \ services use different cart id schemes. See implementation for details" xXCustom06: type: "string" description: "
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ExternalCartRequestLookup request object for external cart information
" com.gk_software.pos.api.service.external.customer.ExternalCustomerAddressRequest: type: "object" required: - "addressLine1" - "addressLine2" - "city" - "customerID" - "isoCountryCode" - "postalCode" - "territory" properties: customerID: type: "string" description: "The customer id.
" city: type: "string" description: "Name of city.
" postalCode: type: "string" description: "Postal code.
" isoCountryCode: type: "string" description: "The ISO country code.
" addressLine1: type: "string" description: "The address line 1
" addressLine2: type: "string" description: "The address line 2
" territory: type: "string" description: "Name of territory
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ExternalCustomerAddressRequestCreate a new customer address\ \ in external repository
" com.gk_software.pos.api.service.external.customer.ExternalCustomerDetailsRequest: type: "object" required: - "customerID" properties: customerID: type: "string" description: "The customer id.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ExternalCustomerDetailsRequestLookup request object for external\ \ customer information
" com.gk_software.pos.api.service.external.item.ExternalItemInformationRequest: type: "object" required: - "ItemID" - "currency" - "language" properties: ItemID: type: "string" description: "The item id.
" language: type: "string" description: "The language code used for I18N.
" currency: type: "string" description: "The currency code.
" getImages: type: "boolean" description: "Specifies whether image urls should be resolved.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ExternalItemInformationRequestLookup request object for external\ \ item information
" com.gk_software.pos.api.service.external.item.ExternalItemSearchRequest: type: "object" required: - "currency" - "language" - "query" properties: query: type: "string" description: "The query used for item search.
" language: type: "string" description: "describe language
" currency: type: "string" description: "The currency code.
" recordCount: type: "integer" format: "int32" description: "Specifies the max. record count to return.
" getImages: type: "boolean" description: "Specifies whether image urls should be resolved.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ExternalItemSearchRequestSearch request object for external\ \ item information
" com.gk_software.pos.api.service.external_order.Address: type: "object" required: - "country" - "firstName" - "lastName" - "line1" - "postalCode" - "title" - "town" properties: title: type: "string" firstName: type: "string" description: "First name of the customer
" lastName: type: "string" description: "Last name of the customer
" line1: type: "string" description: "Address line 1
" line2: type: "string" description: "Address line 2
" town: type: "string" description: "The city
" postalCode: type: "string" description: "The zipcode
" country: type: "string" description: "The country to deliver to.
Check the implementation\ \ for valid options." region: type: "string" description: "
The region to deliver to.
Check the implementation\ \ for valid options." xXCustom06: type: "string" description: "
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AddressAddress object for deliveries and invoices used by the\ \ external order service
" com.gk_software.pos.api.service.external_order.DeliveryAddressRequest: type: "object" required: - "cartID" - "country" - "customerID" - "firstName" - "lastName" - "line1" - "postalCode" - "town" properties: customerID: type: "string" description: "The customers' ID
" cartID: type: "string" description: "The cart ID to set the address to
" firstName: type: "string" description: "First name of the customer
" lastName: type: "string" description: "Last name of the customer
" line1: type: "string" description: "Address line 1
" line2: type: "string" description: "Address line 2
" town: type: "string" description: "The city
" postalCode: type: "string" description: "The zipcode
" country: type: "string" description: "The country to deliver to. Check the implementation for valid\ \ options.
" region: type: "string" description: "The region to deliver to. Check the implementation for valid\ \ options.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "DeliveryAddressRequestRequest object for creating a delivery\ \ address on the external order service
" com.gk_software.pos.api.service.external_order.DeliveryModeRequest: type: "object" required: - "cartID" - "customerID" - "mode" properties: customerID: type: "string" description: "The customers' ID
" cartID: type: "string" description: "The cart ID to set the address to
" mode: type: "string" description: "The mode how the order is delivered.
Check\ \ the implementation for valid options." xXCustom06: type: "string" description: "
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "DeliveryModeRequestRequest object for setting the delivery mode\ \ on the external order service
" com.gk_software.pos.api.service.external_order.PaymentDetailsRequest: type: "object" required: - "accountHolderName" - "billingAddress" - "cardNumber" - "cardType" - "cartID" - "currency" - "customerID" - "defaultPayment" - "expiryMonth" - "expiryYear" - "language" properties: customerID: type: "string" description: "The customer's ID
" cartID: type: "string" billingAddress: description: "The billing address for the external order
" $ref: "#/definitions/com.gk_software.pos.api.service.external_order.Address" accountHolderName: type: "string" description: "The account holder of the credit card
" cardNumber: type: "string" description: "The credit card number
" cardType: type: "string" description: "The credit card type.
" expiryMonth: type: "string" description: "The cards' expiry month
" expiryYear: type: "string" description: "The cards' expiry year
" defaultPayment: type: "string" description: "A flag for setting this method as the future default payment
" language: type: "string" description: "ISO language code
" currency: type: "string" description: "ISO currency code
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PaymentDetailsRequestRequest object to set payment details for\ \ the external order
Note: Some external services need credit\ \ card informations to satisfy their interfaces. See implementation for details." com.gk_software.pos.api.service.hospitality.ActivateHospitalityReceiptRequest: type: "object" required: - "activate" properties: activate: type: "boolean" description: "
Flag to activate or deactivate hospitality receipt print.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ActivateHospitalityReceiptRequestRequest entity for 'activateHospitalityReceipt'\ \ service.
" com.gk_software.pos.api.service.hospitality.AddLineItemCourseNumberRequest: type: "object" required: - "courseNumber" - "createReturnReceipt" - "emptiesReturnMode" - "quantityAccumulationEnabled" - "returnMode" properties: operationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" returnMode: type: "boolean" description: "Indicated whether the item should be returned or registered.
" emptiesReturnMode: type: "boolean" description: "Flag indicating client is in empties return mode.
" createReturnReceipt: type: "boolean" description: "This parameter specifies whether a return receipt should\
\ be created for returned items.
\tThis has only an impact in case\
\ returnMode=true.
Specifies whether quantity accumulation is enabled.
" courseNumber: type: "string" description: "The course number for adding to selected line item.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AddLineItemCourseNumberRequestRequest entity for 'Add Line Item\ \ Course Number Request' service.
" com.gk_software.pos.api.service.hospitality.BelatedVoidLineItemRequest: type: "object" required: - "copyVoidedLineItem" - "offlineMode" - "storeTransaction" - "toVoidQuantity" properties: operationConfiguration: description: "The operation configuration
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The key of the line item to void
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" tenderAuthorizationKey: description: "The key of the tender authorization related to voided line\ \ item
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.TenderAuthorizationKey" voidTypeCode: type: "string" description: "Describes whether the line item was cancelled immediately\ \ after registering it, voided by another line item or internally voided.
" copyVoidedLineItem: type: "boolean" description: "Flag indicating whether to copy the line item.
" giftCertCancellationId: type: "string" description: "A gift certificate service result, it is filled only if a\ \ gift certificate line item is canceled online
" storeTransaction: type: "boolean" description: "Indicates whether the transaction should be stored.
" offlineMode: type: "boolean" description: "The offline mode
" keyedOnline: type: "boolean" description: "The keyed on line state.
" serviceScaleMode: type: "boolean" description: "Indicates whether the POS is in service scale mode.
" voidReason: description: "The reason for the void.
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO" toVoidQuantity: type: "integer" format: "int32" description: "The quantity which should be voided from the line item.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "BelatedVoidLineItemRequestRequest entity for 'BelatedVoidLineItem'\ \ service.
" com.gk_software.pos.api.service.hospitality.BelatedVoidLineItemResponse: type: "object" required: - "copyVoidedLineItem" - "offlineMode" - "storeTransaction" properties: operationConfiguration: description: "The operation configuration
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The key of the line item to void
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" tenderAuthorizationKey: description: "The key of the tender authorization related to voided line\ \ item
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.TenderAuthorizationKey" voidTypeCode: type: "string" description: "Describes whether the line item was cancelled immediately\ \ after registering it, voided by another line item or internally voided.
" copyVoidedLineItem: type: "boolean" description: "Flag indicating whether to copy the line item.
" giftCertCancellationId: type: "string" description: "A gift certificate service result, it is filled only if a\ \ gift certificate line item is canceled online
" storeTransaction: type: "boolean" description: "Indicates whether the transaction should be stored.
" offlineMode: type: "boolean" description: "The offline mode
" keyedOnline: type: "boolean" description: "The keyed on line state.
" serviceScaleMode: type: "boolean" description: "Indicates whether the POS is in service scale mode.
" voidReason: description: "The reason for the void.
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO" transactionOperationResult: description: "The entity describing the transaction result of the operation.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "BelatedVoidLineItemResponseResponse entity for 'BelatedVoidLineItem'\ \ service.
" com.gk_software.pos.api.service.hospitality.ChangeTableOwnerRequest: type: "object" properties: tableStatusList: type: "array" description: "The list of 'Table Status' object which should b used to\ \ update the table owner.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.hospitality.TableStatus" operationConfiguration: description: "The position operation configuration (need e.g. finalization\ \ of transactions)
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ChangeTableOwnerRequestRequest entity for 'Change Table Owner'\ \ service.
" com.gk_software.pos.api.service.hospitality.ChangeTableOwnerResponse: type: "object" properties: transactionList: type: "array" description: "The list of transaction objects which were created.
" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ChangeTableOwnerResponseResponse entity for 'Change Table Owner'\ \ service.
" com.gk_software.pos.api.service.hospitality.CreateBelatedTipTransactionRequest: type: "object" properties: xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateBelatedTipTransactionRequestRequest entity for 'Create\ \ Belated Tip Transaction' service.
" com.gk_software.pos.api.service.hospitality.CreateBelatedTipTransactionResponse: type: "object" properties: transactionOperationResult: description: "The entity describing the transaction result of the operation.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateBelatedTipTransactionResponseResponse entity for 'Create\ \ Belated Tip Transaction' service.
" com.gk_software.pos.api.service.hospitality.CreateOrRetrieveTransactionRequest: type: "object" properties: tableName: type: "string" description: "Table name of a new table
" lastTransactionId: type: "string" description: "TransactionId of the last transaction of the table
" lastTransaction: description: "Transaction DO of the last transaction of the table
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" transactionTypeCode: type: "string" description: "Transaction type code of the transaction which is created\ \ or retrieved.
" enum: - "FOOD_ORDER" - "SALE" - "MOVEMENT" scopedTransaction: type: "boolean" description: "Defines if the created or retrieved transaction should be\ \ a scoped transaction (default: false)
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateOrRetrieveTransactionRequestRequest entity for 'CreateOrRetrieveTransaction'\ \ service.
" com.gk_software.pos.api.service.hospitality.CreateOrRetrieveTransactionResponse: type: "object" properties: transactionOperationResult: description: "The entity describing the transaction result of the operation.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateOrRetrieveTransactionResponseResponse entity for 'CreateOrRetrieveTransaction'\ \ service.
" com.gk_software.pos.api.service.hospitality.DeleteLineItemCourseNumberRequest: type: "object" required: - "lineItemKey" - "operationConfiguration" - "quantityAccumulation" properties: lineItemKey: description: "The line item key of the line item in source transaction\ \ which should be modified.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" operationConfiguration: description: "The position operation configuration (need e.g. for internal\ \ void operations).
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" quantityAccumulation: type: "boolean" description: "It defines if the quantity of line items with the same item\ \ should be accumulated.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "DeleteLineItemCourseNumberRequestRequest entity for 'Delete\ \ Line Item Course Number Request' service.
" com.gk_software.pos.api.service.hospitality.FinalizeMovementTransactionsRequest: type: "object" properties: operationConfiguration: description: "The position operation configuration (need e.g. for internal\ \ void operations).
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FinalizeMovementTransactionsRequestRequest entity for 'FinalizeMovementTransactions'\ \ service.
" com.gk_software.pos.api.service.hospitality.FinalizeMovementTransactionsResponse: type: "object" properties: transactionOperationResult: description: "The entity describing the transaction result of the operation.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FinalizeMovementTransactionsResponseResponse entity for 'FinalizeMovementTransactions'\ \ service.
" com.gk_software.pos.api.service.hospitality.IsLineItemAddedOrVoidedRequest: type: "object" properties: xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "IsLineItemAddedOrVoidedRequestRequest entity for 'IsLineItemAddedOrVoided'\ \ service.
" com.gk_software.pos.api.service.hospitality.IsLineItemAddedOrVoidedResponse: type: "object" required: - "lineItemAddedOrModified" properties: lineItemAddedOrModified: type: "boolean" description: "Flag that contains the result of the operation. It indicates\ \ if the transaction contains new or voided positions.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "IsLineItemAddedOrVoidedResponseResponse entity for 'IsLineItemAddedOrVoided'\ \ service.
" com.gk_software.pos.api.service.hospitality.LoadComboMealItemsRequest: type: "object" required: - "businessUnitGroupId" - "itemId" properties: businessUnitGroupId: type: "string" description: "The unique identifier of the business unit group
" itemId: type: "string" description: "The item id
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LoadComboMealItemsRequestRequest entity for loading of 'ComboMeal'\ \ items
" com.gk_software.pos.api.service.hospitality.LoadComboMealItemsResponse: type: "object" properties: comboMealItem: description: "The loaded combo meal item
" $ref: "#/definitions/com.gk_software.pos.api.service.hospitality.PosComboMealItem" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LoadComboMealItemsResponseResponse entity for loading of 'ComboMeal'\ \ items
" com.gk_software.pos.api.service.hospitality.LoadCondimentsRequest: type: "object" required: - "businessUnitGroupId" properties: businessUnitGroupId: type: "string" description: "The business unit group ID.
" mainMerchandiseHierarchyGroupId: type: "string" description: "The main merchandise hierarchy group ID.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LoadCondimentsRequestRequest entity for loading of condiments.
" com.gk_software.pos.api.service.hospitality.LoadCondimentsResponse: type: "object" properties: relatedComponents: type: "array" description: "List of condiment components.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.hospitality.PosCondimentComponent" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LoadCondimentsResponseResponse entity for loading of condiments.
" com.gk_software.pos.api.service.hospitality.LoadTableStatusRequest: type: "object" properties: businessUnitId: type: "string" description: "The business unit ID (Retail Store ID).
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LoadTableStatusRequestRequest entity for 'Load Table Status'\ \ service.
" com.gk_software.pos.api.service.hospitality.LoadTableStatusResponse: type: "object" properties: tableStatusList: type: "array" description: "List of tables in the response.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.hospitality.TableStatus" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LoadTableStatusResponseResponse entity for 'Load Table Status'\ \ service.
" com.gk_software.pos.api.service.hospitality.MoveLineItem: type: "object" required: - "lineItemKey" - "toMoveQuantity" properties: lineItemKey: description: "The line item key of the line item in source transaction\ \ which should be moved.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" toMoveQuantity: type: "integer" format: "int32" description: "The quantity of the line item in source transaction which\ \ should be moved to targetTransaction.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "MoveLineItemEntity with information of the line item which should\ \ be moved.
" com.gk_software.pos.api.service.hospitality.MoveLineItemsRequest: type: "object" properties: sourceTransactionKey: type: "string" description: "The identifier for the source transaction.
" targetTransactionKey: type: "string" description: "The identifier for the target transaction.
" operationConfiguration: description: "The position operation configuration (need e.g. for internal\ \ void operations).
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" moveAllLineItems: type: "boolean" description: "Flag is all line items should be moved.
" lineItemList: type: "array" description: "List of line items which should be moved.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.hospitality.MoveLineItem" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "MoveLineItemsRequestRequest entity for 'MoveLineItems' service.
" com.gk_software.pos.api.service.hospitality.MoveLineItemsResponse: type: "object" properties: transactionOperationResult: description: "The entity describing the transaction result of the operation.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "MoveLineItemsResponseResponse entity for 'MoveLineItems' service.
" com.gk_software.pos.api.service.hospitality.PosComboMealComponent: type: "object" properties: relatedItemAssociationType: description: "The related association type of the combo meal item component
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.related_item_association_type.dto.dom.RelatedItemAssociationTypeDO" relatedItems: type: "array" description: "List of related items (standard items)
" items: $ref: "#/definitions/com.gk_software.pos.api.service.hospitality.PosRelatedItem" relatedItemsMaxPrice: type: "number" format: "double" description: "The max price of all standard items of the component.
" alternativeRelatedItems: type: "array" description: "List of alternative related items (alternative items)
" items: $ref: "#/definitions/com.gk_software.pos.api.service.hospitality.PosRelatedItem" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PosComboMealComponentEntity for a combo meal item component
" com.gk_software.pos.api.service.hospitality.PosComboMealItem: type: "object" properties: name: type: "string" description: "Name of the combo meal item
" relatedComponents: type: "array" description: "List of components of the combo meal item
" items: $ref: "#/definitions/com.gk_software.pos.api.service.hospitality.PosComboMealComponent" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PosComboMealItemEntity for the Combo meal item (main item)
" com.gk_software.pos.api.service.hospitality.PosCondimentComponent: type: "object" properties: relatedItemAssociationType: description: "The related association type of the combo meal item component
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.related_item_association_type.dto.dom.RelatedItemAssociationTypeDO" relatedItems: type: "array" description: "List of related items.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.hospitality.PosRelatedItem" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PosCondimentComponentEntity for a condiment item component
" com.gk_software.pos.api.service.hospitality.PosRelatedItem: type: "object" required: - "quantity" properties: quantity: type: "integer" format: "int32" description: "The quantity.
" itemView: description: "The original related item
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.item.dto.dom.pos.RelatedItemView" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PosRelatedItemEntity for a related items.
" com.gk_software.pos.api.service.hospitality.PreparePrintOrderDataRequest: type: "object" properties: printOrderConfig: description: "The print order configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.PrintOrderConfig" transaction: description: "The transaction to use. This is an optional parameter, if\ \ it is not set the current active transaction will be used.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" lineItemList: type: "array" description: "List of line items to use. The is used as provided, no filter\ \ is applied.
" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PreparePrintOrderDataRequestRequest entity for 'PreparePrintOrderData'\ \ service.
" com.gk_software.pos.api.service.hospitality.PreparePrintOrderDataResponse: type: "object" properties: printOrderDataList: type: "array" description: "The result list contains the collected data that must be\ \ printed.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.hospitality.PrintOrderData" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PreparePrintOrderDataResponseResponse entity for 'PreparePrintOrderData'\ \ service.
" com.gk_software.pos.api.service.hospitality.PrintOrderData: type: "object" properties: config: description: "The MHG2Printer assignment configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.MerchandiseHierarchyGroupPrinterAssignmentConfig" courseNumber: type: "string" description: "The course number for the printer report
" lineItemList: type: "array" description: "List of line items that matches the corresponding configuration.
" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PrintOrderDataEntity that describes printo order data. One instance\ \ consists of configuration plus list of related line items.
" com.gk_software.pos.api.service.hospitality.RecoverTransactionRequest: type: "object" properties: tableStatus: description: "The table status that matches the table name of transaction\ \ to recover.
" $ref: "#/definitions/com.gk_software.pos.api.service.hospitality.TableStatus" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RecoverTransactionRequestRequest entity for 'RecoverTransaction'\ \ service.
" com.gk_software.pos.api.service.hospitality.RecoverTransactionResponse: type: "object" required: - "recoveryAborted" - "tableRelationCleared" properties: transaction: description: "May contain the transaction that is used for recovery.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" recoveryAborted: type: "boolean" description: "Indicates whether the recovery was aborted.
" tableRelationCleared: type: "boolean" description: "Indicates whether the table relation was cleared.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RecoverTransactionResponseResponse entity for 'RecoverTransaction'\ \ service.
" com.gk_software.pos.api.service.hospitality.RegisterCondimentsRequest: type: "object" required: - "createReturnReceipt" - "emptiesReturnMode" - "quantityAccumulationEnabled" - "returnMode" properties: operationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" returnMode: type: "boolean" description: "Indicated whether the item should be returned or registered.
" emptiesReturnMode: type: "boolean" description: "Flag indicating client is in empties return mode.
" createReturnReceipt: type: "boolean" description: "This parameter specifies whether a return receipt should\
\ be created for returned items.
\tThis has only an impact in case\
\ returnMode=true.
Specifies whether quantity accumulation is enabled.
" alternativeTaxInfos: description: "The alternative tax infos for updating the tax group.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos" relatedComponents: type: "array" description: "List of components containing the selected condiments that\ \ should be registered.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.hospitality.PosCondimentComponent" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RegisterCondimentsRequestThe request entity of 'Enter Condiment'\ \ service.
" com.gk_software.pos.api.service.hospitality.ResetToFoodOrderTransactionRequest: type: "object" properties: storeTransaction: type: "boolean" description: "Flag if transaction should be stored after the reset changes\ \ (default is true).
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ResetToFoodOrderTransactionRequestRequest entity for 'ResetToFoodOrderTransaction'\ \ service.
" com.gk_software.pos.api.service.hospitality.ResetToFoodOrderTransactionResponse: type: "object" properties: transactionOperationResult: description: "The entity describing the transaction result of the operation.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ResetToFoodOrderTransactionResponseResponse entity for 'ResetToFoodOrderTransaction'\ \ service.
" com.gk_software.pos.api.service.hospitality.TableStatus: type: "object" required: - "tableName" properties: tableName: type: "string" description: "Number of the table (e.g. 10 or 10.1)
" total: type: "number" format: "double" description: "Current total of all open/unpaid line items of the table
" status: type: "string" description: "Status of the table
" enum: - "EMPTY" - "OPEN" - "IN_PROGRESS" currentWorkstationId: type: "string" description: "Workstation where the table is currently in progress. Only\ \ filled if Status = InProgress
" lastTransactionId: type: "string" description: "TransactionId of the last transaction of the table. The 'linked'\ \ transaction contains all relevant data of the table
" lastTransaction: description: "Transaction DO of the last transaction
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" lastWorkstationId: type: "string" description: "Workstation of the last modification
" tableOwnerId: type: "string" description: "Id of the table owner (opened the table or handover)
" tableOwnerFirstName: type: "string" description: "First name of the table owner
" tableOwnerLastName: type: "string" description: "Last name of the table owner
" checksum: type: "string" description: "Checksum of the transaction
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TableStatusEntity which represents the status of a table.
" com.gk_software.pos.api.service.layaway.CreateCompleteVoidTransactionRequest: type: "object" required: - "layaway" properties: layaway: description: "The layaway which should be used to create the complete void\ \ transaction out of it.
" $ref: "#/definitions/com.gk_software.gkr.api.layaway.dto.LayawaySummary" downPaymentReceiptText: type: "string" description: "The receipt text for DownPayment LineItem.
" cancellationFeeReceiptText: type: "string" description: "The receipt text for Fee LineItem.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateCompleteVoidTransactionRequestThe entity CreateCompleteVoidTransactionRequest
" com.gk_software.pos.api.service.layaway.CreateCustomerTransactionRequest: type: "object" required: - "layaway" properties: layaway: $ref: "#/definitions/com.gk_software.gkr.api.layaway.dto.LayawaySummary" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateCustomerTransactionRequestThe Entity CreateCustomerTransactionRequest
" com.gk_software.pos.api.service.layaway.CreateLayawayExtendTransactionRequest: type: "object" required: - "deletingTime" - "layaway" - "layawayValidDays" - "newExpirationDate" - "paymentDays" - "toleranceTime" properties: layaway: description: "The Layaway which should be used to create the extend expiration\ \ date transaction out of it.
" $ref: "#/definitions/com.gk_software.gkr.api.layaway.dto.LayawaySummary" layawayValidDays: type: "integer" format: "int32" description: "Count of valid days.
" paymentDays: type: "integer" format: "int32" description: "Count of payment days.
" toleranceTime: type: "integer" format: "int32" description: "Time after expiration Layway can shipped.
" deletingTime: type: "integer" format: "int32" description: "Time when Layaway will be deleted if expired.
" newExpirationDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "Time when Layaway will be expired. Substitutes defined expiration\ \ date on Layaway creation.
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateLayawayExtendTransactionRequestThe entity CreateLayawayExtendTransactionRequest
" com.gk_software.pos.api.service.layaway.CreatePartialVoidTransactionRequest: type: "object" required: - "layaway" - "lineItemInfoList" properties: layaway: description: "Layaway is a data object to hold attributes for layaway process\ \
" $ref: "#/definitions/com.gk_software.gkr.api.layaway.dto.LayawaySummary" lineItemInfoList: type: "array" description: "List of partial void line item information which holds the\ \ selection (quantity) data
" items: $ref: "#/definitions/com.gk_software.pos.api.service.layaway.PartialVoidLineItemInfo" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreatePartialVoidTransactionRequestThe entity CreatePartialVoidTransactionRequest.
" com.gk_software.pos.api.service.layaway.CreateRetrieveMoneyTransactionRequest: type: "object" required: - "layaway" properties: layaway: description: "The layaway which should be used to create the complete void\ \ transaction out of it.
" $ref: "#/definitions/com.gk_software.gkr.api.layaway.dto.LayawaySummary" downPaymentReceiptText: type: "string" description: "The receipt text for DownPayment LineItem.
" penaltyFeeReceiptText: type: "string" description: "The receipt text for Fee LineItem.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateRetrieveMoneyTransactionRequestThe entity CreateRetrieveMoneyTransactionRequest
" com.gk_software.pos.api.service.layaway.DownPaymentAndFeeLineItemRequest: type: "object" required: - "downPaymentAmount" - "downPaymentReceiptText" - "serviceFeeAmount" - "serviceFeeReceiptText" properties: downPaymentAmount: type: "number" format: "double" description: "initial down payment amount has to be paid.
" serviceFeeAmount: type: "number" format: "double" description: "Service fee amount has to be paid.
" serviceFeeReceiptText: type: "string" description: "The receipt text for service fee line item.
" downPaymentReceiptText: type: "string" description: "The receipt text for down payment line item.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "DownPaymentAndFeeLineItemRequestThe entity DownPaymentAndFeeLineItemRequest
" com.gk_software.pos.api.service.layaway.DownPaymentTransactionRequest: type: "object" required: - "createDownpayment" - "downPaymentAmount" - "downPaymentReceiptText" - "layaway" properties: layaway: description: "Layaway is a data object to hold attributes for layaway process
" $ref: "#/definitions/com.gk_software.gkr.api.layaway.dto.LayawaySummary" createDownpayment: type: "boolean" description: "The parameter defines, if a negative or a positive down payment\ \ line item is created.
" downPaymentAmount: type: "number" format: "double" description: "The down payment amount
" downPaymentReceiptText: type: "string" description: "The receipt text for down payment line item.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "DownPaymentTransactionRequestThe entity DownPaymentTransactionRequest
" com.gk_software.pos.api.service.layaway.FinalPaymentTransactionRequest: type: "object" required: - "downPaymentReceiptText" - "layaway" properties: layaway: description: "Layaway is a data object to hold attributes for layaway process
" $ref: "#/definitions/com.gk_software.gkr.api.layaway.dto.LayawaySummary" downPaymentReceiptText: type: "string" description: "The receipt text for down payment line item.
" promotionHandling: type: "string" description: "The parameter controls the promotion behavior for the final\ \ payment of the layaway. Possible values are: BEST_PRICE, INITIAL_PRICE,\ \ FINAL_PRICE (Default is BEST_PRICE).
" enum: - "BEST_PRICE" - "INITIAL_PRICE" - "FINAL_PRICE" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FinalPaymentTransactionRequestThe entity FinalPaymentTransactionRequest
" com.gk_software.pos.api.service.layaway.FindLayawayByCriteriaRequest: type: "object" properties: businessUnitId: type: "string" description: "The criterion which is used to find the layaway summary
" workstationId: type: "string" description: "The criterion which is used to find the layaway summary
" endWorkstationId: type: "string" description: "aThe criterion which is used to find the layaway summary
" businessDayDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The criterion which is used to find the layaway summary
\ \ Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" sequenceNumber: type: "string" description: "The criterion which is used to find the layaway summary
" transactionId: type: "string" description: "The criterion which is used to find the layaway summary
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FindLayawayByCriteriaRequestThe entity FindLayawayByCriteriaRequest
" com.gk_software.pos.api.service.layaway.FindLayawayByCriteriaResponse: type: "object" properties: layawaySummary: description: "Layaway is a data object to hold attributes for layaway process
" $ref: "#/definitions/com.gk_software.gkr.api.layaway.dto.LayawaySummary" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FindLayawayByCriteriaResponseThe entity FindLayawayByCriteriaResponse
" com.gk_software.pos.api.service.layaway.FindLayawayListByCriteriaRequest: type: "object" properties: businessUnitId: type: "string" description: "The business unit ID which is used to find the layaway summary
" suspended: type: "boolean" description: "Whether to include suspended layaways in the search
" terminated: type: "boolean" description: "Whether to include terminated layaways in the search
" fulfilled: type: "boolean" description: "Whether to include fulfilled layaways in the search
" voided: type: "boolean" description: "Whether to include voided layaways in the search
" expired: type: "boolean" description: "Whether to include expired layaways in the search
" customerId: type: "string" description: "The customer ID which is used to find the layaway summary
" customerAddressTypeCode: type: "string" description: "The address type code of the customer which is used to find\ \ the layaway summary
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FindLayawayListByCriteriaRequestThe entity FindLayawayListByCriteriaRequest
" com.gk_software.pos.api.service.layaway.FindLayawayListByCriteriaResponse: type: "object" properties: layawaySummaryList: type: "array" description: "All matching layaway data objects holding attributes for\ \ layaway process
" items: $ref: "#/definitions/com.gk_software.gkr.api.layaway.dto.LayawaySummary" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FindLayawayListByCriteriaResponseThe entity FindLayawayListByCriteriaResponse
" com.gk_software.pos.api.service.layaway.OpenScopedTxForLayawayRequest: type: "object" required: - "layaway" - "scope" properties: scope: type: "string" description: "The scope which should be used for the scoped transaction.
" layaway: description: "The layaway which should be used to create the scoped transaction\ \ out of it.
" $ref: "#/definitions/com.gk_software.gkr.api.layaway.dto.LayawaySummary" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "OpenScopedTxForLayawayRequestThe entity OpenScopedTxForLayawayRequest
" com.gk_software.pos.api.service.layaway.PartialVoidLineItemInfo: type: "object" required: - "lineItemSequenceNumber" - "voidQuantity" properties: lineItemSequenceNumber: type: "integer" format: "int32" description: "Original sequence number of the line item in the layaway\ \
" voidQuantity: type: "number" format: "double" description: "Selected quantity which should be voided vor the line item
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PartialVoidLineItemInfoThe entity for holding information about\ \ the original line item from layaway (sequence number) and the selected 'for\ \ void' quantity
" com.gk_software.pos.api.service.layaway.PaymentPlanRequest: type: "object" properties: layawayValidDays: type: "integer" format: "int32" description: "Count of valid Days.
" paymentDays: type: "integer" format: "int32" description: "Count of payment Days.
" toleranceTime: type: "integer" format: "int32" description: "Time after expiration layway can shipped.
" deletingTime: type: "integer" format: "int32" description: "Time when Layaway will be deleted if expired.
" cancellationFeePercent: type: "number" format: "double" description: "Fee Percent for cancellation a Layaway.
" cancellationFeeAmount: type: "number" format: "double" description: "Fee Amount for cancellation a Layaway.
" penaltyFeePercent: type: "number" format: "double" description: "penalty fee percent if layway expired or cancelled.
" penaltyFeeAmount: type: "number" format: "double" description: "penalty fee amount if layway expired or cancelled.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PaymentPlanRequestRequest of a Calculation of Payment Plan
" com.gk_software.pos.api.service.layaway.PaymentPlanResult: type: "object" properties: xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PaymentPlanResultempty Result, plan is inside transaction.
" com.gk_software.pos.api.service.layaway.ValidateLayawayRequest: type: "object" properties: callingFunction: type: "string" description: "The process from which the validation is called
" layawaySummary: description: "Layaway is a data object to hold attributes for layaway process
" $ref: "#/definitions/com.gk_software.gkr.api.layaway.dto.LayawaySummary" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ValidateLayawayRequestThe Entity ValidateLayawayRequest
" com.gk_software.pos.api.service.loyalty.types.PointsRequest: type: "object" properties: accountID: type: "string" description: "String: account ID
" points: type: "number" format: "double" description: "double: points
" storeID: type: "string" description: "String: store ID
" transactionID: type: "string" description: "String: transaction ID
" trainingMode: type: "boolean" description: "Indicates whether service should be called in training mode.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PointsRequestThe entity PointsRequest
" com.gk_software.pos.api.service.masterdata.BaseClientMasterDataRequest: type: "object" properties: businessUnitId: type: "string" businessUnitTextFooterLinesRequest: $ref: "#/definitions/com.gk_software.pos.api.service.masterdata.BusinessUnitTextRequest" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "BaseClientMasterDataRequestString: business unit iD
\t\
BusinessUnitTextRequest: BusinessUnitTextRequest
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "BaseClientMasterDataResult TODO: undocumented" com.gk_software.pos.api.service.masterdata.BusinessUnitTextRequest: type: "object" properties: businessUnitID: type: "string" description: "String: business unit iD
" receiptTextID: type: "string" description: "String: receipt text iD
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "BusinessUnitTextRequestRequest object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.BusinessUnitTextResponse: type: "object" properties: businessUnitTextList: type: "array" description: "List of BusinessUnitTextDO: businessUnitTextDOs
" items: $ref: "#/definitions/com.gk_software.gkr.api.server.md.business_unit_text.dto.dom.BusinessUnitTextDO" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "BusinessUnitTextResponseResult object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.CurrencyRoundingRuleRequest: type: "object" properties: businessUnitGroupId: type: "string" description: "long: business unit group id
" isoCurrencyCode: type: "string" description: "String: iso currency code
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CurrencyRoundingRuleRequestRequest object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.CustomerContactViewRequest: type: "object" required: - "maxResultsCount" properties: customerContactFilter: description: "CustomerContactFilter: customer contact filter
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerContactFilter" maxResultsCount: type: "integer" format: "int32" description: "int: max results count
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerContactViewRequestRequest object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.CustomerContactViewResult: type: "object" properties: customerContactViews: type: "array" description: "List of CustomerContactView: customerContactViews
" items: $ref: "#/definitions/com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerContactView" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerContactViewResultResult object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.CustomerResult: type: "object" properties: customerDOs: type: "array" description: "List of CustomerDO: customerDOs
" items: $ref: "#/definitions/com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerResultResult object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.DenominationRequest: type: "object" properties: denominationTypeCode: type: "string" description: "String: denomination type code
" currencyCode: type: "string" description: "String: currency code
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "DenominationRequestRequest object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.DenominationResult: type: "object" properties: denominationDOs: type: "array" description: "List of DenominationDO: denominationDOs
" items: $ref: "#/definitions/com.gk_software.gkr.api.server.md.denomination.dto.dom.DenominationDO" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "DenominationResultResult object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.MHGroupRequest: type: "object" properties: businessUntiGroupId: type: "string" description: "long: business unit group id
" merchandiseHierarchyGroupId: type: "string" description: "String: merchandise hierarchy group id
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "MHGroupRequestRequest object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.MHGroupResult: type: "object" properties: mhgSOs: type: "array" description: "List of MhgSO: mhgDOs
" items: $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.mhg.dto.so.MhgSO" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "MHGroupResultResult object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.PromotionItemRequest: type: "object" properties: businessUnitGroupId: type: "string" description: "long: business unit group id
" promotionItemFilter: description: "Filter Object for service request
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.promotion.dto.so.PromotionItemFilterSO" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PromotionItemRequestRequest object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.ReasonResult: type: "object" properties: reasonGroup: description: "ReasonCodeGroupSO: The reasonGroup
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonCodeGroupSO" reasons: type: "array" description: "List of ReasonSO: reasons
" items: $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ReasonResultResult object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.ScaleDomainRequest: type: "object" properties: businessUnitGroupId: type: "string" description: "long: business unit group id
" scaleDomainId: type: "string" description: "String: scale domain id
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ScaleDomainRequestRequest object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.ScaleDomainResult: type: "object" properties: scaleDomainDO: description: "ScaleDomainDO: scale domain DO
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.scale_domain.dto.dom.ScaleDomainDO" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ScaleDomainResultResult object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.SimpleTaxListResult: type: "object" properties: simpleTaxList: type: "object" description: "Map with taxGroupId as key and the tax percent as value.
" additionalProperties: type: "number" format: "double" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SimpleTaxListResultResult object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.TenderAdjustmentRuleRequest: type: "object" properties: originalTenderTypeCode: type: "string" description: "originalTenderTypeCode
" newTenderTypeCode: type: "string" description: "newTenderTypeCode
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TenderAdjustmentRuleRequestRequest object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.TenderAdjustmentRuleResult: type: "object" properties: tenderAdjustmentRuleDOs: type: "array" description: "List of TenderAdjustmentRuleDO: tenderAdjustmentRuleDOs
" items: $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender_rule.dto.dom.TenderAdjustmentRuleDO" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TenderAdjustmentRuleResultResult object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.TenderRequest: type: "object" properties: businessUnitGroupId: type: "string" description: "long: business unit group id
" reasonCode: type: "string" description: "String: reason code
" reasonCodeGroupCode: type: "string" description: "String: reason code group code
" isoCurrencyCode: type: "string" description: "String: iso currency code
" tenderClassCode: type: "string" description: "String: tender class code
" tenderGroupCode: type: "string" description: "TenderGroupCode: tender group code
" enum: - "CASH" - "TERMINAL" - "GIFT_CERT" - "COUPON" - "CHEQUE" - "CREDIT" - "PROMOTION" - "POINTS" - "CASHENGINE" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TenderRequestRequest object for the MasterDataService
" com.gk_software.pos.api.service.masterdata.TenderResult: type: "object" properties: tenderDOs: type: "array" description: "List of TenderDO: tenderDOs
" items: $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TenderResultResult object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.WorkerRequest: type: "object" properties: businessUnitGroupId: type: "string" description: "long: business unit group id
" workerId: type: "string" description: "String: worker id
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "WorkerRequestRequest object used by MasterDataService
" com.gk_software.pos.api.service.masterdata.item.InformationStockInfoRequest: type: "object" properties: posItemIds: type: "array" description: "The pos item id.
" items: type: "string" buId: type: "string" description: "The business unit id (retail store id)
" skipMasterDataResolution: type: "boolean" description: "Specifies whether master data should be resolved or not.
\tIf it is set to false the related attributes in the reponse will be\
\ empty (item name, uom code, ...)
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "InformationStockInfoRequestRequest object for requesting stock\ \ details for specified item.
" com.gk_software.pos.api.service.masterdata.item.ItemInformationLoadConfig: type: "object" properties: itemInformation: description: "An existing item information object that has to be added\ \ to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.ItemInformation.ItemInformation" loadItemInfo: type: "boolean" description: "Defines whether general item info should be loaded.
" loadStockInfo: type: "boolean" description: "Defines whether stock info should be loaded.
" loadAdditionalInfo: type: "boolean" description: "Defines whether additional item info should be loaded.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ItemInformationLoadConfigConfig that defines what item info\ \ needs to be loaded.
" com.gk_software.pos.api.service.masterdata.item.ItemInformationRequest: type: "object" required: - "displayPromotionPrices" - "itemIDCaseSensitive" - "requestStock" properties: posItemId: type: "string" description: "String: pos item id
" additionalTextInfoTextTypeCodes: type: "array" description: "List String: additional text info text type codes
" items: type: "string" systemLanguage: type: "string" description: "String: system language
" discountInfoEnabled: type: "boolean" description: "It defines if the discount info should be displayed in transaction\ \ preview.
" itemInfoEnabled: type: "boolean" description: "It defines if the item info should be displayed in transaction\ \ preview.
" iconSalesInfoTextTypeCodes: type: "array" description: "It defines a list of text type codes that should be displayed\ \ as icon sales info.
" items: type: "string" buId: type: "string" description: "the clients current buId
" displayPromotionPrices: type: "boolean" description: "Specifies that promotion prices should be calculated for\
\ the item.
\tIt is calculated based on actual basket.
It specifies whether the group price is additionally displayed\ \ if a single item price is valid.
" itemIDCaseSensitive: type: "boolean" description: "Specifies treating of posItemID for item look-up. If true\ \ then is checked the posItemID in case sensitive mode.
" requestStock: type: "boolean" description: "Specifies if item stock information should be requested from\ \ stock information system. Default value is true.
" price: type: "number" format: "double" description: "It defines the unit price which should be used for the price\ \ calculation.
" priceQuantity: type: "integer" format: "int32" description: "It defines the unit price quantity which should be used for\ \ the price calculation (i.e. '3 for $1.00').
" quantity: type: "integer" format: "int32" description: "It defines the quantity of the item.
" unit: type: "number" format: "double" description: "It defines the units of the item.
" itemInformationLoadConfig: $ref: "#/definitions/com.gk_software.pos.api.service.masterdata.item.ItemInformationLoadConfig" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ItemInformationRequestRequest object for item information
" com.gk_software.pos.api.service.masterdata.item.ItemInformationStockInfoRequest: type: "object" properties: posItemId: type: "string" description: "The pos item id.
" buId: type: "string" description: "The business unit id (retail store id)
" skipMasterDataResolution: type: "boolean" description: "Specifies whether master data should be resolved or not.
\tIf it is set to false the related attributes in the reponse will be\
\ empty (item name, uom code, ...)
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ItemInformationStockInfoRequestRequest object for requesting\ \ stock details for specified item.
" com.gk_software.pos.api.service.masterdata.item.LoadItemDOByKeyRequest: type: "object" properties: itemKey: description: "Key identifier for POS item unit of measure object.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.PosUOMItemDoKey" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LoadItemDOByKeyRequestRequest object for loading item master\ \ data for specified POS UOM itemDO key.
" com.gk_software.pos.api.service.masterdata.item.SimplePosUomItemDO: type: "object" properties: mainPosItemId: type: "string" description: "String: main pos item id
" posUOMItemPosIdentityTypeCode: type: "string" description: "String: pos UOM item pos identity type code
" itemUOMCode: type: "string" description: "String: item UOM code
" itemSellingRuleQuantityInputMethod: type: "string" description: "String: item selling rule quantity input method
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SimplePosUomItemDOData object SimplePosUomItemDO - Bean class\ \ for performant item operations
" com.gk_software.pos.api.service.masterdata.item.bl.ItemSearchRequest: type: "object" required: - "businessUnitGroupId" - "cacheEnabled" - "packageSelection" - "recordCount" - "skipEnteredItem" properties: businessUnitGroupId: type: "string" description: "long: The unique identifier of the business unit group (store\ \ number).
" filter: description: "PosUOMItemSearchFilter: Filter for search view
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemSearchFilter" recordCount: type: "integer" format: "int32" description: "int: Limits the search by number
" packageSelection: type: "boolean" description: "boolean: It specifies whether search is limited to package\ \ items only.
" requiredUomCode: type: "string" description: "String: It defines the required unit of measure code of the\ \ displayed package units.
" skipEnteredItem: type: "boolean" description: "boolean: Specifies whether the entered item is excluded from\ \ the selection.
" textClassId: type: "string" description: "String: Specifies the text class Id.
" cacheEnabled: type: "boolean" description: "boolean: Specifies, whether the item search results should\ \ be cached globally (until replication data changes) in case global master\ \ data caching is activated via configuration. (check GlobalMasterDataCacheServiceConfig.cacheSize)
" itemName: type: "string" description: "String: Specifies the text itemName.
" itemId: type: "string" description: "String: Specifies the itemId.
" itemMerchandiseHierarchyGroup: type: "string" description: "String: Specifies the itemMerchandiseHierarchyGroup.
" itemNormalPrice: type: "string" description: "String: Specifies the itemNormalPrice.
" setsOnly: type: "boolean" description: "boolean: Specifies the setsOnly flag.
" itemColor: type: "string" description: "String: Specifies the itemColor.
" itemSize: type: "string" description: "String: Specifies the itemSize.
" itemLength: type: "string" description: "String: Specifies the itemLength.
" itemSeason: type: "string" description: "String: Specifies the itemSeason.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ItemSearchRequestRequest object for searching specified item.
" com.gk_software.pos.api.service.payment.AddTerminalPrintoutsToLineItemRequest: type: "object" required: - "tenderLineItem" properties: tenderLineItem: description: "The retail transaction line item with the tender line item.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem" merchantReceipt: type: "string" description: "The merchant terminal receipt.
" customerReceipt: type: "string" description: "The customer terminal receipt.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AddTerminalPrintoutsToLineItemRequestRequest object to add terminal\ \ receipts that were printed to retail transaction line item as binary.
" com.gk_software.pos.api.service.payment.AmountValidationRequest: type: "object" required: - "amount" - "currentTenderTotalPaymentAmount" properties: amount: type: "number" format: "double" description: "double : amount
" tender: description: "TenderDO : tender
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO" isoCurrencyCode: type: "string" description: "String : iso currency code
" currentTenderTotalPaymentAmount: type: "number" format: "double" description: "double : current tender total payment amount
" paymentState: type: "string" description: "String : payment state
" allowedAmountTypeCode: type: "string" description: "String : allowed amount type code
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AmountValidationRequestA request wrapper for all informations\ \ required to validate and check a payment amount
" com.gk_software.pos.api.service.payment.AmountValidationResult: type: "object" required: - "amountLimit" - "isAmountInvalid" - "isAmountMaximumLimitExceeded" - "isAmountMinimumLimitExceeded" - "isAmountTooHigh" - "isAmountTooSmall" - "isOkay" properties: isOkay: type: "boolean" description: "boolean : is okay
" isAmountInvalid: type: "boolean" description: "boolean : is amount invalid
" isAmountTooHigh: type: "boolean" description: "boolean : is amount too high
" isAmountTooSmall: type: "boolean" description: "boolean : is amount too small
" isAmountMinimumLimitExceeded: type: "boolean" description: "boolean : is amount minimum limit exceeded
" isAmountMaximumLimitExceeded: type: "boolean" description: "boolean : is amount maximum limit exceeded
" amountLimit: type: "number" format: "double" description: "double : amount limit
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AmountValidationResultA result wrapper for all informations\ \ after a validation and check of a payment amount
" com.gk_software.pos.api.service.payment.CashPaymentRequest: type: "object" required: - "exchangeRate" - "multiplyFlag" properties: positionOperationConfig: description: "PositionOperationConfig: position operation config
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" tender: description: "TenderDO: tender
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO" amount: description: "Amount: amount
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" tipAmount: description: "Amount: tip amount
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" baseIsoCurrencyCode: type: "string" description: "String: base iso currency code
" foreignIsoCurrencyCode: type: "string" description: "String: foreign iso currency code
" exchangeRate: type: "number" format: "double" description: "double: exchange rate
" multiplyFlag: type: "boolean" description: "boolean: multiply flag
" tenderClassCode: type: "string" description: "String : tender class code
" paymentDescription: type: "string" description: "String : payment description
" keyedOnline: type: "boolean" changeAmountPaid: type: "boolean" description: "flag to indicate whether the change amount was already paid\ \ (e.g. by cash recycler)
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CashPaymentRequestRequest object used by cash payment operations.
" com.gk_software.pos.api.service.payment.CheckPaymentRequest: type: "object" required: - "exchangeRate" - "multiplyFlag" - "success" properties: positionOperationConfig: description: "PositionOperationConfig: position operation config
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" tender: description: "TenderDO: tender
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO" amount: description: "Amount: amount
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" tipAmount: description: "Amount: tip amount
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" baseIsoCurrencyCode: type: "string" description: "String: base iso currency code
" foreignIsoCurrencyCode: type: "string" description: "String: foreign iso currency code
" exchangeRate: type: "number" format: "double" description: "double: exchange rate
" multiplyFlag: type: "boolean" description: "boolean: multiply flag
" tenderClassCode: type: "string" description: "String : tender class code
" paymentDescription: type: "string" description: "String : payment description
" keyedOnline: type: "boolean" success: type: "boolean" description: "success
" fullMicrData: type: "string" description: "fullMicrData
" checkSequenceNumber: type: "string" description: "checkSequenceNumber
" adjudicationCode: type: "string" description: "adjudicationCode
" bankId: type: "string" description: "bankId
" checkAccountNumber: type: "string" description: "checkAccountNumber
" merchantPrintCache: type: "string" description: "merchantPrintCache
" customerPrintCache: type: "string" description: "customerPrintCache
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CheckPaymentRequestRequest object used by check payment operations.
" com.gk_software.pos.api.service.payment.CreditPaymentRequest: type: "object" required: - "exchangeRate" - "multiplyFlag" properties: positionOperationConfig: description: "PositionOperationConfig: position operation config
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" tender: description: "TenderDO: tender
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO" amount: description: "Amount: amount
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" tipAmount: description: "Amount: tip amount
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" baseIsoCurrencyCode: type: "string" description: "String: base iso currency code
" foreignIsoCurrencyCode: type: "string" description: "String: foreign iso currency code
" exchangeRate: type: "number" format: "double" description: "double: exchange rate
" multiplyFlag: type: "boolean" description: "boolean: multiply flag
" tenderClassCode: type: "string" description: "String : tender class code
" paymentDescription: type: "string" description: "String : payment description
" keyedOnline: type: "boolean" documentNumber: type: "string" description: "long : document number
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreditPaymentRequestRequest object used by credit payment operations.
" com.gk_software.pos.api.service.payment.FilterPerTenderRequest: type: "object" required: - "baseCurrencyRemainingPaymentAmount" - "baseCurrencyTotalPaymentAmount" - "wicMode" properties: wicMode: type: "boolean" description: "boolean : wic mode
" baseCurrencyTotalPaymentAmount: type: "number" format: "double" description: "double : base currency total payment amount
" baseCurrencyRemainingPaymentAmount: type: "number" format: "double" description: "double : base currency remaining payment amount
" allowedTender: type: "array" description: "List of TenderDO : allowed tender
" items: $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO" forbiddenTender: type: "array" description: "List of TenderDO : forbidden tender
" items: $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO" allowedTendersConfig: description: "AllowedTendersConfig : allowed tenders config
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AllowedTendersConfig" lastTender: $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO" lastTenderAmount: type: "number" format: "double" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FilterPerTenderRequestRequest object used by PaymentService
" com.gk_software.pos.api.service.payment.GiftCertificatePaymentRequest: type: "object" required: - "bookingSuccessful" - "exchangeRate" - "gcsUsage" - "multiplyFlag" properties: positionOperationConfig: description: "PositionOperationConfig: position operation config
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" tender: description: "TenderDO: tender
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO" amount: description: "Amount: amount
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" tipAmount: description: "Amount: tip amount
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" baseIsoCurrencyCode: type: "string" description: "String: base iso currency code
" foreignIsoCurrencyCode: type: "string" description: "String: foreign iso currency code
" exchangeRate: type: "number" format: "double" description: "double: exchange rate
" multiplyFlag: type: "boolean" description: "boolean: multiply flag
" tenderClassCode: type: "string" description: "String : tender class code
" paymentDescription: type: "string" description: "String : payment description
" keyedOnline: type: "boolean" gcNumber: type: "string" description: "String : gc number
" gcType: type: "string" description: "String : gc type
" gcsUsage: type: "boolean" description: "boolean : gcs usage
" bookingSuccessful: type: "boolean" description: "boolean : booking successful
" gcsTransactionUuid: type: "string" description: "String : gcs transaction uuid
" externalSystemAdapterName: type: "string" description: "String : external system adapter name
" remainingBalance: description: "Amount : remaining balance
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" gcQuantity: type: "integer" format: "int32" description: "int : gc quantity
" expiryDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "Date : gc expiration date
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" gcTrack2: type: "string" additionalInfo: type: "array" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.gift_certificate_service.AttributeValue" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "GiftCertificatePaymentRequestA data structure holding all necessary\ \ parameters for creation of gift certificate tender line item.
" com.gk_software.pos.api.service.payment.GiftCertificateSpvPaymentRequest: type: "object" required: - "bookingSuccessful" - "exchangeRate" - "gcsUsage" - "multiplyFlag" properties: positionOperationConfig: description: "PositionOperationConfig: position operation config
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" tender: description: "TenderDO: tender
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO" amount: description: "Amount: amount
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" tipAmount: description: "Amount: tip amount
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" baseIsoCurrencyCode: type: "string" description: "String: base iso currency code
" foreignIsoCurrencyCode: type: "string" description: "String: foreign iso currency code
" exchangeRate: type: "number" format: "double" description: "double: exchange rate
" multiplyFlag: type: "boolean" description: "boolean: multiply flag
" tenderClassCode: type: "string" description: "String : tender class code
" paymentDescription: type: "string" description: "String : payment description
" keyedOnline: type: "boolean" gcNumber: type: "string" description: "String : gc number
" gcType: type: "string" description: "String : gc type
" gcsUsage: type: "boolean" description: "boolean : gcs usage
" bookingSuccessful: type: "boolean" description: "boolean : booking successful
" gcsTransactionUuid: type: "string" description: "String : gcs transaction uuid
" externalSystemAdapterName: type: "string" description: "String : external system adapter name
" remainingBalance: description: "Amount : remaining balance
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" gcQuantity: type: "integer" format: "int32" description: "int : gc quantity
" expiryDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "Date : gc expiration date
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" gcTrack2: type: "string" additionalInfo: type: "array" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.gift_certificate_service.AttributeValue" gcItem: type: "string" description: "It defines the gift certificate item (e.g. for Single Purpose\
\ Vouchers).
\tIf filled then it will be used for sale return line\
\ item creation.
Amount returned by the Stored Value Server (abs(GiftCertStatus.old_amount\ \ – GiftCertStatus.new_amount))
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "GiftCertificateSpvPaymentRequestA data structure holding all\ \ necessary parameters for creation of single purpose voucher sale return line\ \ item.
" com.gk_software.pos.api.service.payment.PayableAmountResult: type: "object" required: - "additionalEntries" - "baseCurrencyTenderPayableAmount" - "changeAmount" - "foreignCurrencyChangeAmount" - "foreignCurrencyGrandTotalAmount" - "foreignCurrencyPayedAmount" - "foreignCurrencyTenderPayableAmount" - "grandTotalAmount" - "mghTenderPermissionRulesChecked" - "payedAmount" - "tipAmount" properties: primaryEntry: description: "The primary transaction result entry.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" additionalEntries: type: "array" description: "Additional result entries.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" filtered: type: "boolean" description: "Indicates whether the transaction result is filtered. A filtered\ \ transaction does not contain the details of a retail transaction object\ \ in order to optimize service communication.
" failure: description: "Reference to a failure entity in case a failure occurs during\ \ a service execution. This field can be used when a managed exception occurs\ \ and we still want to synchronize the resulting transaction instead of\ \ throwing an exception containing no information on transaction updates.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult" changeAmount: type: "number" format: "double" description: "double : change amount
" foreignCurrencyChangeAmount: type: "number" format: "double" description: "double : foreign currency change amount
" grandTotalAmount: type: "number" format: "double" description: "double : grand total amount
" foreignCurrencyGrandTotalAmount: type: "number" format: "double" description: "double : foreign currency grand total amount
" payedAmount: type: "number" format: "double" description: "double : payed amount
" foreignCurrencyPayedAmount: type: "number" format: "double" description: "double : foreign currency payed amount
" tipAmount: type: "number" format: "double" description: "Amount: tip amount
" baseCurrencyTenderPayableAmount: type: "number" format: "double" description: "double : base currency tender payable amount
" foreignCurrencyTenderPayableAmount: type: "number" format: "double" description: "double : foreign currency tender payable amount
" mghTenderPermissionRulesChecked: type: "boolean" description: "boolean : mgh tender permission rules checked
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PayableAmountResultResult object of the PaymentService
" com.gk_software.pos.api.service.payment.PaymentAmountsResult: type: "object" required: - "additionalEntries" - "changeAmount" - "foreignCurrencyChangeAmount" - "foreignCurrencyGrandTotalAmount" - "foreignCurrencyPayedAmount" - "grandTotalAmount" - "payedAmount" - "tipAmount" properties: primaryEntry: description: "The primary transaction result entry.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" additionalEntries: type: "array" description: "Additional result entries.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" filtered: type: "boolean" description: "Indicates whether the transaction result is filtered. A filtered\ \ transaction does not contain the details of a retail transaction object\ \ in order to optimize service communication.
" failure: description: "Reference to a failure entity in case a failure occurs during\ \ a service execution. This field can be used when a managed exception occurs\ \ and we still want to synchronize the resulting transaction instead of\ \ throwing an exception containing no information on transaction updates.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult" changeAmount: type: "number" format: "double" description: "double : change amount
" foreignCurrencyChangeAmount: type: "number" format: "double" description: "double : foreign currency change amount
" grandTotalAmount: type: "number" format: "double" description: "double : grand total amount
" foreignCurrencyGrandTotalAmount: type: "number" format: "double" description: "double : foreign currency grand total amount
" payedAmount: type: "number" format: "double" description: "double : payed amount
" foreignCurrencyPayedAmount: type: "number" format: "double" description: "double : foreign currency payed amount
" tipAmount: type: "number" format: "double" description: "Amount: tip amount
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PaymentAmountsResultResult object of the PaymentService
" com.gk_software.pos.api.service.payment.PaymentRequest: type: "object" required: - "exchangeRate" - "multiplyFlag" properties: positionOperationConfig: description: "PositionOperationConfig: position operation config
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" tender: description: "TenderDO: tender
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO" amount: description: "Amount: amount
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" tipAmount: description: "Amount: tip amount
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" baseIsoCurrencyCode: type: "string" description: "String: base iso currency code
" foreignIsoCurrencyCode: type: "string" description: "String: foreign iso currency code
" exchangeRate: type: "number" format: "double" description: "double: exchange rate
" multiplyFlag: type: "boolean" description: "boolean: multiply flag
" tenderClassCode: type: "string" description: "String : tender class code
" paymentDescription: type: "string" description: "String : payment description
" keyedOnline: type: "boolean" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PaymentRequestBasic request data structure for payment operation\ \ done on server. It is used mainly for tender line
\ \ item creation. If you need to send some additional data for the operation,\ \ you should extend this request object" com.gk_software.pos.api.service.payment.PaymentResult: type: "object" required: - "additionalEntries" - "changeAmount" - "foreignCurrencyChangeAmount" - "foreignCurrencyGrandTotalAmount" - "foreignCurrencyPayedAmount" - "grandTotalAmount" - "payedAmount" - "tipAmount" - "transactionPayed" properties: primaryEntry: description: "
The primary transaction result entry.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" additionalEntries: type: "array" description: "Additional result entries.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" filtered: type: "boolean" description: "Indicates whether the transaction result is filtered. A filtered\ \ transaction does not contain the details of a retail transaction object\ \ in order to optimize service communication.
" failure: description: "Reference to a failure entity in case a failure occurs during\ \ a service execution. This field can be used when a managed exception occurs\ \ and we still want to synchronize the resulting transaction instead of\ \ throwing an exception containing no information on transaction updates.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult" changeAmount: type: "number" format: "double" description: "double : change amount
" foreignCurrencyChangeAmount: type: "number" format: "double" description: "double : foreign currency change amount
" grandTotalAmount: type: "number" format: "double" description: "double : grand total amount
" foreignCurrencyGrandTotalAmount: type: "number" format: "double" description: "double : foreign currency grand total amount
" payedAmount: type: "number" format: "double" description: "double : payed amount
" foreignCurrencyPayedAmount: type: "number" format: "double" description: "double : foreign currency payed amount
" tipAmount: type: "number" format: "double" description: "Amount: tip amount
" transactionPayed: type: "boolean" description: "boolean : transaction payed
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PaymentResultResult object of the PaymentService
" com.gk_software.pos.api.service.payment.PointsPaymentRequest: type: "object" required: - "exchangeRate" - "multiplyFlag" properties: positionOperationConfig: description: "PositionOperationConfig: position operation config
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" tender: description: "TenderDO: tender
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO" amount: description: "Amount: amount
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" tipAmount: description: "Amount: tip amount
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" baseIsoCurrencyCode: type: "string" description: "String: base iso currency code
" foreignIsoCurrencyCode: type: "string" description: "String: foreign iso currency code
" exchangeRate: type: "number" format: "double" description: "double: exchange rate
" multiplyFlag: type: "boolean" description: "boolean: multiply flag
" tenderClassCode: type: "string" description: "String : tender class code
" paymentDescription: type: "string" description: "String : payment description
" keyedOnline: type: "boolean" customerAccountId: type: "string" description: "String : customer account id
" redemptionTransactionId: type: "string" description: "String : redemption transaction id
" pointsRedemptionConversionFactor: type: "number" format: "double" description: "double : points redemption conversion factor
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PointsPaymentRequestRequest object used by points payment operations.
" com.gk_software.pos.api.service.payment.ReduceTaxableAmountRequest: type: "object" required: - "amount" properties: amount: type: "number" format: "double" description: "Tender amount applied to use when reducing taxable amounts.
" ewicBasketResults: type: "array" description: "Selected eWIC items to apply benefits to.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.ewic.EwicBasketResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ReduceTaxableAmountRequestRequest object to reduce the taxable\ \ amount for the transaction.
" com.gk_software.pos.api.service.payment.SpecialReturnAmountLookupKeyRequest: type: "object" properties: tender: description: "TenderDO : tender to obtain tender type code and item restriction\ \ type code from.
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO" tenderTypeCode: type: "string" description: "String : tender type code to use to generate lookup key.\ \ Required if tender is null. If specified when tender is not null, this\ \ tender type code and the Tender's item restriction typecode will be used\ \ to generate the lookup key.
" itemRestrictionTypeCode: type: "string" description: "String : item restriction type code to use to generate lookup\ \ key. Optional; null should be passed in if not relevant. Only used if\ \ tender is null.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SpecialReturnAmountLookupKeyRequestRequest object to obtain\
\ a special return amount lookup key.
\tRequest must contain either the\
\ tender or both tenderTypeCode and itemRestrictionTypeCode.
PositionOperationConfig: position operation config
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" tender: description: "TenderDO: tender
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO" amount: description: "Amount: amount
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" tipAmount: description: "Amount: tip amount
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" baseIsoCurrencyCode: type: "string" description: "String: base iso currency code
" foreignIsoCurrencyCode: type: "string" description: "String: foreign iso currency code
" exchangeRate: type: "number" format: "double" description: "double: exchange rate
" multiplyFlag: type: "boolean" description: "boolean: multiply flag
" tenderClassCode: type: "string" description: "String : tender class code
" paymentDescription: type: "string" description: "String : payment description
" keyedOnline: type: "boolean" success: type: "boolean" description: "boolean : success
" autoCancellation: type: "boolean" description: "boolean : auto cancellation
" cancellation: type: "boolean" description: "boolean : cancellation
" cardType: type: "string" description: "String : card type
" cardIssuerCode: type: "string" description: "String : card issue code
" accountNumber: type: "string" description: "String : account number
" cardEntryMethodCode: type: "string" description: "String : card entry method code
" cashbackAmount: type: "number" format: "double" description: "double: cashbackAmount
" entrySourceCode: type: "string" description: "String : entry source code
" personalIDRequiredTypeCode: type: "string" description: "String : personal iD required type code
" personalIDReferenceNumber: type: "integer" format: "int32" description: "int : personal iD reference number
" authorizationMethodCode: type: "string" description: "String : authorization method code
" adjudicationCode: type: "string" description: "String : adjudication code
" cardExpirationDate: type: "string" description: "String : card expiration date
" cardHolderName: type: "string" description: "String : card holder name
" cardIssueSequenceNumber: type: "string" description: "String : card Issue sequence number
" cardStartDate: type: "string" description: "String : card start date
" serviceCode: type: "string" description: "String : service code
" terminalTransactionID: type: "string" description: "String : terminal transaction iD
" terminalID: type: "string" description: "String : terminal iD
" terminalTransactionStatus: type: "integer" format: "int32" description: "int : terminal transaction status
" terminalTransactionResult: type: "string" description: "String : terminal transaction status
" terminalTransactionTypeCode: type: "string" description: "TerminalTransactionTypeCode: terminal transaction type code
" enum: - "Offline" - "Online" cardNumber: type: "string" description: "String : card number
" merchantPrintCache: type: "string" description: "String : merchant print cache
" customerPrintCache: type: "string" description: "String : customer print cache
" merchantCachePrinted: type: "boolean" description: "boolean : merchant cache printed
" customerCachePrinted: type: "boolean" description: "boolean : customer cache printed
" approvalCode: type: "string" description: "String : approval code
" terminalType: type: "string" description: "String : terminal type
" merchantNumber: type: "string" description: "String : merchant number
" isoCurrencyNumber: type: "string" description: "String : iso currency number
" currentDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "Date : current date
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" transactionStatus: type: "integer" format: "int32" description: "int : transaction status
" forceOffline: type: "boolean" description: "boolean : force offline
" cardHolderVerificationTypeCode: type: "string" description: "String : card holder verification type code
" hostAuthorizedFlag: type: "boolean" description: "boolean : host authorized flag
" traceNumber: type: "integer" format: "int32" description: "int : trace number
" terminalTransactionErrorNumber: type: "integer" format: "int32" description: "int : terminal transaction error number
" adjuctionText: type: "string" description: "String : adjuction text
" currentTenderAuthorizationKey: description: "TenderAuthorizationKey : current tender authorization key
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.TenderAuthorizationKey" recoveryValues: $ref: "#/definitions/com.gk_software.pos.flow.libs.payment.TerminalTransactionRecoveryValues" requestType: type: "string" enum: - "CREATE_TENDER_AUTHORIZATION" - "REMOVE_RECOVERY_DATA" - "REGISTER_TERMINAL_PAYMENT" - "UPDATE_AFTER_IMMEDIATE_VOIDING" - "UPDATE_TO_INTERMEDIATE_RESULT" - "UPDATE_TO_FINAL_RESULT" - "UPDATE_TRANSACTION_STATE_ONLY" - "CUSTOM_01" - "CUSTOM_02" - "CUSTOM_03" - "CUSTOM_04" - "CUSTOM_05" - "CUSTOM_06" - "CUSTOM_07" - "CUSTOM_08" - "CUSTOM_09" - "CUSTOM_10" origTenderAuthorizationNumber: type: "integer" format: "int32" voidingLineItemSequenceNumber: type: "integer" format: "int32" terminalReferenceNumber: type: "string" description: "String : terminal Reference Number
" token: type: "string" description: "String : token that comes back from USA Payment servers.\ \ Used with T+
" signatureFormat: type: "string" description: "String : format of the signature data ex. png, bmp
" signatureData: type: "string" description: "String : signature data
" internationalBankAccountNumber: type: "string" bankIdentifierCode: type: "string" creditorID: type: "string" mandateID: type: "string" prenotificationText: type: "string" terminalTenderDescription: type: "string" description: "Tender description.
" applicationID: type: "string" description: "Application identifier
" encryptedPAN: type: "string" description: "Masked application PAN.
" terminalTransactionCurrencyCode: type: "string" description: "Currency key (default 978).
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TerminalPaymentRequestRequest object used by terminal payment\ \ operations.
" com.gk_software.pos.api.service.promotion.LoyaltyRewardGiftCertificateRequest: type: "object" properties: externalSystemAdapterName: type: "string" description: "String : external system adapter name
" giftCertificateServerUse: type: "boolean" description: "boolean : gift certificate server use
" giftCertificatePrefix: type: "string" description: "String : gift certificate prefix
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LoyaltyRewardGiftCertificateRequestRequest object for the gift\ \ certificate loyalty reward process.
" com.gk_software.pos.api.service.promotion.PromotionRequest: type: "object" required: - "checkIfRebateWasApplied" - "createReturnReceipt" - "emptiesReturnMode" - "promotionValue" - "returnMode" properties: operationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" returnMode: type: "boolean" description: "Indicated whether the item should be returned or registered.
" emptiesReturnMode: type: "boolean" description: "Flag indicating client is in empties return mode.
" createReturnReceipt: type: "boolean" description: "This parameter specifies whether a return receipt should\
\ be created for returned items.
\tThis has only an impact in case\
\ returnMode=true.
Promotion configuration used for checking line item promotion\ \ triggers.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PromotionOperationConfig" reason: description: "Object describing the reason of a promotion.
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO" reference: type: "string" description: "An additional information concerning the promotion trigger\ \ (see {@link com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemPromotionTrigger#reference_}).
" promotionValue: type: "number" format: "double" description: "The promotion value. The meaning of this field depends on\ \ the privilege type present in the promotion configuration (promotionOperationConfig)\ \ as following:
This parameter specifies whether a condition which relates\ \ to a trigger will be checked.
" maximumQuantity: type: "number" format: "double" description: "This parameter defines the maximal line item quantity when\ \ a promotion trigger is allowed.
" activeCustomerOrderId: type: "string" description: "The active customer order id in the client context, if any\ \ is available.
" customerSequenceNumber: type: "integer" format: "int32" description: "A unique system assigned identifier for the LineItem of the\
\ CustomerOrder.
\tThat means, the sequence number of an active customer\
\ order.
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PromotionRequestRequest object for a promotion trigger process.
" com.gk_software.pos.api.service.promotion.PromotionTriggerValidationRequest: type: "object" required: - "promotionValue" - "validationMode" properties: promotionOperationConfig: description: "Promotion configuration used for checking line item promotion\ \ triggers.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PromotionOperationConfig" positionOperationConfig: description: "Position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The key of the line item to have its promotion triggers validated.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" promotionValue: type: "number" format: "double" description: "The promotion value. The meaning of this field depends on\ \ the privilege type present in the promotion configuration (promotionOperationConfig)\ \ as following:
Attribute currently not used.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PromotionTriggerValidationRequestRequest object for validating\ \ line item promotion triggers.
" com.gk_software.pos.api.service.rescan.CopyExternalTransactionLineItemsFullRescanRequest: type: "object" required: - "toAssociationTypeCode" - "toTransactionID" properties: toAssociationTypeCode: type: "string" description: "The association type code to the line items of the external\ \ transaction
" toTransactionID: type: "string" description: "The transaction ID to the line items of the external transaction
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CopyExternalTransactionLineItemsFullRescanRequestRequest entity\ \ for 'copy external transaction line item' service.
" com.gk_software.pos.api.service.rescan.CopyExternalTransactionLineItemsFullRescanResponse: type: "object" properties: transactionOperationResult: description: "The entity describing the result of the operation.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CopyExternalTransactionLineItemsFullRescanResponseResponse entity\ \ for 'copy external transaction line item' service.
" com.gk_software.pos.api.service.rescan.CopyGiftCertificateLineItemFullRescanRequest: type: "object" required: - "giftCertificateSerialNumber" properties: giftCertificateSerialNumber: type: "string" description: "The giftCertificateSerialNumber of the gift certificate which\ \ should be copied.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CopyGiftCertificateLineItemFullRescanRequestRequest entity for\ \ 'copy gift certificate line item' service.
" com.gk_software.pos.api.service.rescan.CopyGiftCertificateLineItemFullRescanResponse: type: "object" properties: transactionOperationResult: description: "The entity describing the result of the operation.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CopyGiftCertificateLineItemFullRescanResponseResponse entity\ \ for 'copy gift certificate line item' service.
" com.gk_software.pos.api.service.rescan.ExecuteRescanAnalysisRequest: type: "object" properties: xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ExecuteRescanAnalysisRequestRequest entity for 'Rescan Analysis'\ \ service.
" com.gk_software.pos.api.service.rescan.ExecuteRescanAnalysisResponse: type: "object" properties: transactionOperationResult: description: "The entity describing the result of the operation.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ExecuteRescanAnalysisResponseResponse entity for 'Rescan Analysis'\ \ service.
" com.gk_software.pos.api.service.rescan.FinishFullRescanRequest: type: "object" properties: xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FinishFullRescanRequestRequest entity for 'finish full rescan'\ \ service.
" com.gk_software.pos.api.service.rescan.FinishFullRescanResponse: type: "object" properties: transactionOperationResult: description: "The entity describing the result of the operation.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult" differencesFound: type: "boolean" description: "true if there is any difference in the relevant data between\ \ the customer scanned transaction and the rescan transaction.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FinishFullRescanResponseResponse entity for 'finish full rescan'\ \ service.
" com.gk_software.pos.api.service.rescan.FinishPartialRescanRequest: type: "object" properties: xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FinishPartialRescanRequestRequest entity for 'finish partial\ \ rescan' service.
" com.gk_software.pos.api.service.rescan.FinishPartialRescanResponse: type: "object" properties: transactionOperationResult: description: "The entity describing the result of the operation.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FinishPartialRescanResponseResponse entity for 'finish partial\ \ rescan' service.
" com.gk_software.pos.api.service.rescan.PrepareFullRescanRequest: type: "object" properties: xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PrepareFullRescanRequestRequest entity for preparing 'Full Rescan'\ \ functionality.
" com.gk_software.pos.api.service.rescan.PrepareFullRescanResponse: type: "object" properties: transactionOperationResult: description: "The entity describing the result of the operation.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PrepareFullRescanResponseResponse entity for preparing 'Full\ \ Rescan' functionality.
" com.gk_software.pos.api.service.rescan.PreparePartialRescanRequest: type: "object" properties: xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PreparePartialRescanRequestRequest entity for preparing 'Partial\ \ Rescan' functionality.
" com.gk_software.pos.api.service.rescan.PreparePartialRescanResponse: type: "object" required: - "numberToRescan" properties: numberToRescan: type: "integer" format: "int32" description: "Contains number of items to rescan.
" transactionOperationResult: description: "The entity describing the result of the operation.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PreparePartialRescanResponseResponse entity for preparing 'Partial\ \ Rescan' functionality.
" com.gk_software.pos.api.service.rescan.ProcessBarcodePartialRescanRequest: type: "object" properties: positionOperationConfig: description: "Contains the position operation config for the line item\ \ handling.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" barcode: type: "string" description: "Contains barcode of the scanned item.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ProcessBarcodePartialRescanRequestRequest entity for 'process\ \ barcode partial rescan' service.
" com.gk_software.pos.api.service.rescan.ProcessBarcodePartialRescanResponse: type: "object" properties: transactionOperationResult: description: "The entity describing the result of the operation.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ProcessBarcodePartialRescanResponseResponse entity for 'process\ \ barcode partial rescan' service.
" com.gk_software.pos.api.service.rescan.SuspendAndRetrieveRescanTransactionRequest: type: "object" properties: xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SuspendAndRetrieveRescanTransactionRequestRequest entity for\ \ 'Suspend and Retrieve Rescan Transaction' service.
" com.gk_software.pos.api.service.rescan.SuspendAndRetrieveRescanTransactionResponse: type: "object" properties: transactionOperationResult: description: "The entity describing the result of the operation.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SuspendAndRetrieveRescanTransactionResponseResponse entity for\ \ 'Suspend and Retrieve Rescan Transaction' service.
" com.gk_software.pos.api.service.rescan.ValidateQuantityPartialRescanRequest: type: "object" properties: xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ValidateQuantityPartialRescanRequestRequest entity for quantity\ \ validation of a specific item.
" com.gk_software.pos.api.service.security.AuthenticationRequest: type: "object" required: - "passwordRequired" properties: loginName: type: "string" description: "The operator login name
" password: type: "string" description: "The operator password
" businessUnitId: type: "string" description: "The business unit id.
" passwordRequired: type: "boolean" description: "boolean : password required
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AuthenticationRequestRequest object for the AuthenticationService
" com.gk_software.pos.api.service.security.AuthenticationResult: type: "object" properties: resolvedOperator: description: "OperatorSO: resolved operator
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.um.operator.dto.so.AbstractOperatorSO" realmId: type: "string" expirationCountDays: type: "integer" format: "int32" description: "If password is before expiration it contains the expiration\ \ count in days
" passwordBeforeExpiration: type: "boolean" description: "Indicate whether the password is before expiration
" passwordExceptionType: type: "string" description: "The passwordExceptionType.
" enum: - "PASSWORD_INITIAL" - "PASSWORD_EXPIRED" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AuthenticationResultRequest object for the AuthenticationService
" com.gk_software.pos.api.service.security.AuthorizationRequest: type: "object" required: - "authorizingOperatorMustHaveRights" - "skipPasswordCheck" properties: originalOperatorLoginName: type: "string" description: "String : original operator login name
" authorizingOperatorLoginName: type: "string" description: "String : authorizing operator login name
" authorizingOperatorPassword: type: "string" description: "String : authorizing operator password
" rightId: type: "string" description: "String : right id
" EntryMethodCode: type: "string" description: "String : entry method code. It specifies how the action was\ \ triggered (keyed, scanned, ...)
" lineItemRelevant: type: "boolean" description: "Indicates that operation is related to line item.
" retailTransactionRelevant: type: "boolean" description: "Indicates that operation is related to retail transaction.
" controlTransactionRelevant: type: "boolean" description: "Indicates that operation is related to control transaction.
" tenderControlTransactionRelevant: type: "boolean" description: "Indicates that operation is related to tender control transaction.
" authorizingOperatorMustHaveRights: type: "boolean" description: "boolean : authorizing operator must have rights
" skipPasswordCheck: type: "boolean" description: "boolean : skip password check
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AuthorizationRequestRequest object for the AuthorizationService
" com.gk_software.pos.api.service.security.AuthorizationResult: type: "object" properties: operator: description: "OperatorSO : operatorSO
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.um.operator.dto.so.AbstractOperatorSO" permittedResources: type: "array" description: "List of String : ids of permitted resources
" items: type: "string" authenticationResult: description: "Authentication result.
" $ref: "#/definitions/com.gk_software.pos.api.service.security.AuthenticationResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AuthorizationResultResult object used by AuthorizationService.
" com.gk_software.pos.api.service.security.TransactionResourceOverrideData: type: "object" properties: businessUnitGroupID: type: "string" description: "Long : business unit group id.
" operator: description: "OperatorSO : The operator data
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.um.operator.dto.so.AbstractOperatorSO" rightId: type: "string" description: "String : right id
" entryMethodCode: type: "string" description: "String : entry method code. It specifies how the action was\ \ triggered (keyed, scanned, ...)
" lineItemRelevant: type: "boolean" description: "Indicates that operation is related to line item.
" retailTransactionRelevant: type: "boolean" description: "Indicates that operation is related to retail transaction.
" controlTransactionRelevant: type: "boolean" description: "Indicates that operation is related to control transaction.
" tenderControlTransactionRelevant: type: "boolean" description: "Indicates that operation is related to tender control transaction.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TransactionResourceOverrideDataTransactionResourceOverrideData
" com.gk_software.pos.api.service.security.UpdatePasswordRequest: type: "object" properties: loginName: type: "string" description: "The operator login name.
" newPassword: type: "string" description: "New password.
" oldPassword: type: "string" description: "Old password.
" storeId: type: "string" description: "The retail store id.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "UpdatePasswordRequestRequest object for the AuthenticationService
" com.gk_software.pos.api.service.security.UpdatePasswordResult: type: "object" properties: xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "UpdatePasswordResultResult object used by AuthenticationService.
" com.gk_software.pos.api.service.session.LanguageSettings: type: "object" properties: activeLanguageScope: type: "string" description: "LanguageScope : active language scope
" enum: - "Operator" - "Customer" - "Transaction" - "MasterData" hierarchyMap: type: "object" description: "String array of LanguageScope : hierarchy map
" additionalProperties: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LanguageSettingsTransport object for language dependent setting\ \ like active scope and hierarchies.
" com.gk_software.pos.api.service.session.LoginRequest: type: "object" required: - "trainingMode" properties: retailStoreId: type: "string" description: "String : retail store id
" workstationId: type: "string" description: "String : workstation id
" workstationAddress: type: "string" description: "String : workstation address
" workstationTypeCode: type: "string" description: "String : workstation type code
" clientVersion: type: "string" description: "String : client version
" loginName: type: "string" description: "String : login name
" tillId: description: "TillDoKey : till id
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.TillDoKey" password: type: "string" description: "String : password
" overrideData: $ref: "#/definitions/com.gk_software.pos.api.service.security.TransactionResourceOverrideData" trainingMode: type: "boolean" finalizeControlTransactionFlag: type: "boolean" useLoginTypeTechnicalForLoginManager: type: "boolean" description: "boolean: use login type TECHNICAL for login manager calls\ \ (default is false)
" authorizerLoginName: type: "string" description: "Login name of an authorizing operator e.g. used for 'password\ \ forgotten' or other functionalities where the original user doesn't have\ \ the required credentials.
" authorizerPassword: type: "string" description: "Password of an authorizing operator e.g. used for 'password\ \ forgotten' or other functionalities where the original user doesn't have\ \ the required credentials.
" additionalSessionCriteria01: type: "string" description: "Additional data that can be set/used to identify a session.
" additionalSessionCriteria02: type: "string" description: "Additional data that can be set/used to identify a session.
" posServerLoginEnabled: type: "boolean" description: "Flag indicating, if POS server login is performed.
" signOnTransactionEnabled: type: "boolean" description: "Flag indicating, if sign on transaction should be created.
" online: type: "boolean" description: "Flag indicating, if session is online
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LoginRequestRequest object for the PosSessionService.
" com.gk_software.pos.api.service.session.LoginResult: type: "object" required: - "additionalEntries" - "dataPrivacyEnabled" properties: primaryEntry: description: "The primary transaction result entry.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" additionalEntries: type: "array" description: "Additional result entries.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" filtered: type: "boolean" description: "Indicates whether the transaction result is filtered. A filtered\ \ transaction does not contain the details of a retail transaction object\ \ in order to optimize service communication.
" failure: description: "Reference to a failure entity in case a failure occurs during\ \ a service execution. This field can be used when a managed exception occurs\ \ and we still want to synchronize the resulting transaction instead of\ \ throwing an exception containing no information on transaction updates.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult" posSessionId: description: "PosSessionId : pos session id
" $ref: "#/definitions/com.gk_software.pos.api.session.PosSessionId" operator: description: "OperatorSO : operator
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.um.operator.dto.so.AbstractOperatorSO" permittedResources: type: "array" description: "List of String : permitted resources
" items: type: "string" businessUnit: description: "BusinessUnitDO : business unit
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.business_unit.dto.dom.BusinessUnitDO" businessUnitGroup: description: "BusinessUnitGroupDO : business unit group
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.business_unit_group.dto.dom.BusinessUnitGroupDO" dataPrivacyEnabled: type: "boolean" description: "boolean: Flag to indicate data privacy logging is enabled\ \ (true) or not (false)
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LoginResultResult object for the PosSessionService.
" com.gk_software.pos.api.service.session.LogoutRequest: type: "object" required: - "validatePassword" properties: retailStoreId: type: "string" description: "String : retail store id
" workstationId: type: "string" description: "String : workstation id
" clientVersion: type: "string" description: "String : client version
" password: type: "string" description: "Encrypted password used for logout
" validatePassword: type: "boolean" description: "Indicates whether password should be validated
" overrideData: description: "Override data used for logout
" $ref: "#/definitions/com.gk_software.pos.api.service.security.TransactionResourceOverrideData" posServerLogoutEnabled: type: "boolean" signOutTransactionEnabled: type: "boolean" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LogoutRequestRequest object for the PosSessionService
" com.gk_software.pos.api.service.session.LogoutResult: type: "object" required: - "additionalEntries" - "success" properties: primaryEntry: description: "The primary transaction result entry.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" additionalEntries: type: "array" description: "Additional result entries.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" filtered: type: "boolean" description: "Indicates whether the transaction result is filtered. A filtered\ \ transaction does not contain the details of a retail transaction object\ \ in order to optimize service communication.
" failure: description: "Reference to a failure entity in case a failure occurs during\ \ a service execution. This field can be used when a managed exception occurs\ \ and we still want to synchronize the resulting transaction instead of\ \ throwing an exception containing no information on transaction updates.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult" success: type: "boolean" description: "boolean : success
" operator: description: "OperatorSO : operator
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.um.operator.dto.so.AbstractOperatorSO" businessUnit: description: "BusinessUnitDO : business unit
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.business_unit.dto.dom.BusinessUnitDO" workstationStatusToken: type: "string" description: "The new POS-Server login manager status token from POS-Server\ \ logout response.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LogoutResultResult object for the PosSessionService.
" com.gk_software.pos.api.service.session.RemoveSessionRequest: type: "object" required: - "posSessionId" properties: posSessionId: description: "PosSessionId : the pos session id
" $ref: "#/definitions/com.gk_software.pos.api.session.PosSessionId" clearSessionHolder: type: "boolean" description: "String : indicates that the SessionHolder should be cleared.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RemoveSessionRequestResult object for the PosSessionService\ \ for remove session operation.
" com.gk_software.pos.api.service.session.SwitchUserResult: type: "object" required: - "additionalEntries" properties: primaryEntry: description: "The primary transaction result entry.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" additionalEntries: type: "array" description: "Additional result entries.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" filtered: type: "boolean" description: "Indicates whether the transaction result is filtered. A filtered\ \ transaction does not contain the details of a retail transaction object\ \ in order to optimize service communication.
" failure: description: "Reference to a failure entity in case a failure occurs during\ \ a service execution. This field can be used when a managed exception occurs\ \ and we still want to synchronize the resulting transaction instead of\ \ throwing an exception containing no information on transaction updates.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult" loginResult: description: "LoginResult : login result
" $ref: "#/definitions/com.gk_software.pos.api.service.session.LoginResult" logoutResult: description: "LogoutResult : logout result
" $ref: "#/definitions/com.gk_software.pos.api.service.session.LogoutResult" authenticationResult: $ref: "#/definitions/com.gk_software.pos.api.service.security.AuthenticationResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SwitchUserResultResult object for the PosSessionService for\ \ switch user operations.
" com.gk_software.pos.api.service.session.UnlockSessionRequest: type: "object" properties: transactionResourceOverrideData: description: "Transaction resource override data used during unlock.
" $ref: "#/definitions/com.gk_software.pos.api.service.security.TransactionResourceOverrideData" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "UnlockSessionRequestRequest for workstation unlock.
" com.gk_software.pos.api.service.session.posgroup.PosGroupOperatorLoginRequest: type: "object" required: - "trainingMode" properties: retailStoreId: type: "string" description: "The retail store identifier.
" workstationId: type: "string" description: "The workstation identifier.
" workstationTypeCode: type: "string" description: "The workstation type code.
" clientVersion: type: "string" description: "The client version.
" loginName: type: "string" description: "The operator login name.
" password: type: "string" description: "The operator password.
" passwordRequired: type: "boolean" description: "A flag to indicate whether the password is required or not.
" tillId: description: "The till identifier.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.TillDoKey" requiredRight: type: "string" description: "If set the pos group operator permissions are checked against\ \ this right.
" trainingMode: type: "boolean" description: "A flag to indicate whether training mode is active or not.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PosGroupOperatorLoginRequestRequest object to perform a pos\ \ group operator login.
" com.gk_software.pos.api.service.session.posgroup.PosGroupOperatorLoginResult: type: "object" properties: posSessionId: description: "The new created pos session identifier.
" $ref: "#/definitions/com.gk_software.pos.api.session.PosSessionId" operator: description: "The resolved operator.
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.um.operator.dto.so.AbstractOperatorSO" permittedResources: type: "array" description: "A list of permitted resources for the operator.
" items: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PosGroupOperatorLoginResultResult object for a pos group operator\ \ login.
" com.gk_software.pos.api.service.session.posgroup.PosGroupOperatorLogoutRequest: type: "object" required: - "posGroupOperatorActive" properties: posSessionId: description: "The pos session identifier.
" $ref: "#/definitions/com.gk_software.pos.api.session.PosSessionId" posGroupOperatorActive: type: "boolean" description: "A flag to indicate whether the pos group operator to logout\ \ is currently activated (true) or deactivated (false) at the POS.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PosGroupOperatorLogoutRequestRequest object to perform a pos\ \ group operator logout.
" com.gk_software.pos.api.service.session.posgroup.PosGroupOperatorLogoutResult: type: "object" properties: xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PosGroupOperatorLogoutResultResult object for a pos group operator\ \ logout.
" com.gk_software.pos.api.service.session.posgroup.PosGroupUnfinishedTransactionCleanUpResponse: type: "object" required: - "status" properties: status: type: "string" description: "The status.
" enum: - "DeactivateRequired" - "Finished" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PosGroupUnfinishedTransactionCleanUpResponseResponse object\ \ for a clean up of unfinished transactions.
" com.gk_software.pos.api.service.session.posgroup.SyncPosGroupSessionResult: type: "object" properties: xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SyncPosGroupSessionResultResult object for a synchronization\ \ of pos sessions within the pos group.
" com.gk_software.pos.api.service.smartpos.CheckAvailabilityAndCleanupRequest: type: "object" properties: retailStoreId: type: "string" description: "The store identifier (business unit id).
" workstationId: type: "string" description: "The workstation id.
" clientVersion: type: "string" description: "The client application version.
" mainTransaction: description: "The main transaction currently in client transaction context.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" lastFinalizedTransaction: description: "Complete last finalized transaction object.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" lastFinalizedRetailTransaction: description: "Complete last finalized retail transaction object.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CheckAvailabilityAndCleanupRequestRequest object for the checking\ \ service availability and cleaning up sessions and transactions on an active\ \ service instance.
" com.gk_software.pos.api.service.smartpos.MDReplicationEndEvent: type: "object" properties: storeNumber: type: "string" description: "The store id (business unit id).
" success: type: "boolean" description: "Indicates if process ended without failure.
" newPumpUsed: type: "boolean" description: "Indicates if new pump was downloaded, data transfered to\ \ database and databases were switched.
" newTransportObjectsSaved: type: "boolean" description: "Indicates whether new transport objects were saved during\ \ master data replication.
" lastChangedEntityId: type: "string" description: "Id of last changed entity during master data replication.
" failKey: type: "string" description: "Message key of failure cause.
" failCause: type: "string" description: "Localized message of failure cause.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "MDReplicationEndEventEvent object for master data replication\ \ end.
" com.gk_software.pos.api.service.smartpos.MDReplicationProgressEvent: type: "object" properties: eventId: type: "string" description: "The event id.
" type: type: "string" description: "The retail store id.
" storeNumber: type: "string" description: "The retail store id.
" currentStep: type: "string" description: "Returns current step (or count for count event) of action.\ \ Exact meaning of step may be different for different actions.
" stepsCount: type: "string" description: "Returns steps count of action. Exact meaning of step may\ \ be different for different actions.
" progress: type: "number" format: "double" description: "Translates progress to interval <0, 1> Values <\ \ 0 and > 1 indicates that this is before/after. For count event 1.0\ \ is always returned.
" beforeEvent: type: "boolean" description: "Indicates if this is event called before the action started.
" afterEvent: type: "boolean" description: "Indicates if this is event called after the action was completed.
" progressEvent: type: "boolean" description: "Indicates that this event is progress event
" countEvent: type: "boolean" description: "Indicates that this event is count event (similar to progress,\ \ but with unknown stepsCount)
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "MDReplicationProgressEventEvent object for master data replication\ \ progress.
" com.gk_software.pos.api.service.smartpos.TakeOverSessionRequest: type: "object" properties: operatorId: type: "string" description: "The operator login id.
" retailStoreId: type: "string" description: "The store identifier (business unit id).
" workstationId: type: "string" description: "The workstation id.
" clientVersion: type: "string" description: "The client application version.
" tillId: description: "The till identifier.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.TillDoKey" mainTransaction: description: "The main transaction currently in client transaction context.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" scopedTransactions: type: "object" description: "Scoped transactions currently present in client transaction\ \ context.
" additionalProperties: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" activatedTransactionId: type: "string" description: "The transaction id of the active transaction in client transaction\ \ context.
" lastFinalizedTransaction: description: "Complete last finalized transaction object.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" lastFinalizedRetailTransaction: description: "Complete last finalized retail transaction object.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" posSessionData: description: "The current pos session data in the client administration\ \ context.
" $ref: "#/definitions/com.gk_software.pos.api.session.PosSessionData" languageSettings: description: "The current language settings in the client administration\ \ context.
" $ref: "#/definitions/com.gk_software.pos.api.service.session.LanguageSettings" enforceTakeOver: type: "boolean" description: "If true, the session take over will be enforced without further\ \ checks.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TakeOverSessionRequestRequest object for session take over during\ \ a service switch due to communication failure on other existing service instances.
" com.gk_software.pos.api.service.stock.StockServiceRequest: type: "object" properties: itemIds: type: "array" description: "Item identifiers for stock information request.
" items: type: "string" storeIds: type: "array" description: "Store identifiers requesting the stock information.
" items: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "StockServiceRequestRequest object for stock service.
" com.gk_software.pos.api.service.stored_value_server.CancelGiftCertTransactionRequest: type: "object" required: - "ignoreFailures" - "voidTenderLineItems" properties: serviceId: type: "string" description: "Specific id of gift certificate service to use.
" positionOperationConfig: description: "Configuration for dealing with position operations when performing\ \ a gift certificate cancel.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" callingProcess: type: "string" description: "Calling process identifier.
" storedValuesServiceId: type: "string" description: "Stored values service identifier.
" transactionId: type: "string" description: "Transaction id for transaction containing the gift certificate\ \ to be canceled.
" receiptNumber: type: "string" description: "Number of receipt of transaction canceling the gift certificate\ \ (transaction sequence number).
" giftCertTransactionId: type: "string" description: "Transaction ID of the transaction to be canceled at stored\ \ value server (eg.: top up transaction id).
" giftCertNumber: type: "string" description: "Gift certificate number.
" Track2: type: "string" description: "Gift certificate track2 data.
" giftCertAmount: type: "number" format: "double" description: "Gift certificate amount.
" isoCurrencyCode: type: "string" description: "ISO currency code.
" approvalCode: type: "string" description: "Approval code from terminal related to gift card transaction.
" terminalReferenceNumber: type: "string" description: "The terminal reference number.
" gcsTransactionUUID: type: "string" description: "The original transaction UUID from registration.
" ignoreFailures: type: "boolean" description: "Indicates whether failures should be ignored during the cancellation\ \ process and tries to cancel all gift certificates.
" voidTenderLineItems: type: "boolean" description: "Indicates whether tender line items should be voided during\ \ the cancellation process.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CancelGiftCertTransactionRequestRequest object for canceling\ \ (voiding) a gift certificate.
" com.gk_software.pos.api.service.stored_value_server.GiftCertificateRequest: type: "object" required: - "openPaymentAmount" properties: serviceId: type: "string" description: "Service identifier.
" giftCertificateType: type: "string" description: "Specifies the gift certificate type.
\tPossible values\
\ are:
\tgift certificate as '01'
\tgift card as '02'
\t\
foreign gift certificate as '03'
\tpromotion gift certificate as '04'
Gift certificate number.
" giftTrack2: type: "string" description: "Gift certificate track2 data.
" amount: description: "Amount of the gift certificate, its meaning depends on the\ \ operation.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" expiryDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "Expiration date.
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" gcsTransactionUUID: type: "string" description: "Universally unique transaction ID.
" openPaymentAmount: type: "number" format: "double" description: "The remaining payment amount for the base currency.
" callingProcess: type: "string" description: "Calling process identifier.
" additionalInfo: type: "array" description: "List of additional info attributes and values.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.gift_certificate_service.AttributeValue" trainingMode: type: "boolean" description: "Indicates whether service has been started on training mode.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "GiftCertificateRequestRequest object for the StoredValueServerService.
" com.gk_software.pos.api.service.system.ApplicationInfo: type: "object" properties: appVersion: type: "string" description: "Application version.
" appRevision: type: "string" description: "Application revision number.
" appBuildNumber: type: "string" description: "Application build number.
" appFormattedDate: type: "string" description: "Application build date.
" appJdkVersion: type: "string" description: "JDK version used in application build.
" fiscalizationInfo: type: "object" description: "A key-value pair map of strings for fiscalization information.\ \ Extension point for projects to load fiscalization specific information\ \ into this map.
" additionalProperties: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ApplicationInfoData object for service application information.
" com.gk_software.pos.api.service.system.PingRequest: type: "object" properties: businessUnitId: type: "string" description: "Business unit id.
" workstationId: type: "string" description: "Workstation id.
" workstationAddress: type: "string" description: "Workstation address.
" workstationStatusToken: type: "string" description: "The POS-Server / Login-Manager workstation status token that\ \ was received in prev. call.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PingRequestRequest object for the SystemService ping.
" com.gk_software.pos.api.service.system.PingResponse: type: "object" properties: workstationCommand: description: "Workstation command pending for client execution.
" $ref: "#/definitions/com.gk_software.gkr.api.login_manager.dto.WorkstationCommand" workstationStatusToken: type: "string" description: "The POS-Server / Login-Manager workstation status token.\ \ It must be stored and resend with next request.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PingResponseResponse object for the SystemService ping.
" com.gk_software.pos.api.service.tableau.FindDynamicTableauItemListUpdateViewsRequest: type: "object" required: - "dynamicTableauItemListUpdateViewCriteria" properties: dynamicTableauItemListUpdateViewCriteria: $ref: "#/definitions/com.gk_software.gkr.api.server.md.dynamic_tableau.dto.dom.DynamicTableauItemListUpdateViewCriteria" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FindDynamicTableauItemListUpdateViewsRequest TODO: undocumented" com.gk_software.pos.api.service.tableau.FindDynamicTableauItemListUpdateViewsResponse: type: "object" properties: dynamicTableauItemListUpdateViews: type: "array" items: $ref: "#/definitions/com.gk_software.gkr.api.server.md.dynamic_tableau.dto.dom.DynamicTableauItemListUpdateView" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FindDynamicTableauItemListUpdateViewsResponse TODO: undocumented" com.gk_software.pos.api.service.tableau.FindDynamicTableauItemListViewsRequest: type: "object" required: - "dynamicTableauItemListViewCriteria" properties: dynamicTableauItemListViewCriteria: $ref: "#/definitions/com.gk_software.gkr.api.server.md.dynamic_tableau.dto.dom.DynamicTableauItemListViewCriteria" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FindDynamicTableauItemListViewsRequest TODO: undocumented" com.gk_software.pos.api.service.tableau.FindDynamicTableauItemListViewsResponse: type: "object" properties: dynamicTableauItemListViews: type: "array" items: $ref: "#/definitions/com.gk_software.gkr.api.server.md.dynamic_tableau.dto.dom.DynamicTableauItemListView" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FindDynamicTableauItemListViewsResponse TODO: undocumented" com.gk_software.pos.api.service.till.TillRequest: type: "object" properties: operatorId: type: "string" description: "The operator id used for till assignments.
" workstationId: type: "string" description: "The workstation id used for till assignments.
" businessUnitId: type: "string" description: "The business unit id used for till assignments.
" tillIds: type: "array" description: "Collection of till identifiers.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.TillDoKey" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TillRequestRequest object for the TillService
" com.gk_software.pos.api.service.till.TillResponse: type: "object" properties: tills: type: "array" description: "Collection of tills assigned to the given workstation or\ \ operator.
" items: $ref: "#/definitions/com.gk_software.gkr.api.server.md.till.dto.dom.TillDO" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TillResponseResponse object for the TillService containing assigned\ \ tills for given request.
" com.gk_software.pos.api.service.till.TillTenderSummaryRequest: type: "object" required: - "businessUnitGroupId" - "tillId" - "trainingFlag" properties: businessUnitGroupId: type: "string" description: "Business unit group id used for till tender summary.
" tillId: type: "string" description: "Till identifier.
" workstationId: type: "string" description: "Workstation id.
" trainingFlag: type: "boolean" description: "Flag for indicating whether training mode is enabled.
" refreshStrategy: type: "string" description: "Refresh strategy of till copy object (eg.: ForceRefresh,\ \ RefreshAndOfflineFallback and CachedOrInitialize).
" enum: - "ForceRefresh" - "RefreshAndOfflineFallback" - "CachedOrInitialize" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TillTenderSummaryRequestRequest object for till tender summaries.
" com.gk_software.pos.api.service.till.TillTenderSummaryResponse: type: "object" properties: tillCopyObject: description: "The till copy object.
" $ref: "#/definitions/com.gk_software.gkr.api.tco.dto.TillCopyObject" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TillTenderSummaryResponseResponse object for the TillService\ \ containing a summary of till tenders.
" com.gk_software.pos.api.service.transaction.ActivateTaxExemptRequest: type: "object" properties: lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" customerIdentifier: type: "string" description: "The customer id.
" reason: description: "The reason for activating tax exemption.
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ActivateTaxExemptRequestRequest object for activating tax exemption.
" com.gk_software.pos.api.service.transaction.AddExternalTransactionAdditionalPrintoutRequest: type: "object" properties: reportId: type: "string" description: "The report identifier.
" transactionId: type: "string" content: type: "array" description: "A list of print additional line item text lines.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.PrintAdditionalLineItemTextLine" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AddExternalTransactionAdditionalPrintoutRequestRequest object\ \ to add additional external printouts.
" com.gk_software.pos.api.service.transaction.AddFiscalizationDataToTransactionRequest: type: "object" properties: transactionId: type: "string" description: "The identifier of the transaction where the fiscalization\ \ data should be set.
" fiscalDayNumber: type: "string" description: "The fiscalization day number.
" fiscalPrinterId: type: "string" description: "The fiscalization printer identifier.
" fiscalReceipt: type: "boolean" description: "A flag to indicate if it is a fiscalization receipt/transaction.
" fiscalReceiptNumber: type: "string" description: "The fiscalization receipt number.
" fiscalSignature: type: "string" description: "The fiscalization signature.
" fiscalReceiptText: type: "string" description: "The fiscalization receipt text.
" fiscalEncodedBarcodeImage: type: "string" description: "The encoded fiscalization barcode image.
" fiscalBarcodeReference: type: "string" description: "The fiscalization barcode reference.
" positionOperationConfig: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" fiscalSecurity: description: "The fiscalization receipt security code.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.FiscalTagFieldResult" fiscalTaxId: description: "The fiscalization receipt tax identifier.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.FiscalTagFieldResult" fiscalCode: description: "The fiscalization receipt fiscal code.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.FiscalTagFieldResult" fiscalYear: type: "integer" format: "int32" description: "The fiscalization year.
" keyVersion: type: "string" description: "The fiscalization signing key version.
" signatureSumDaily: description: "Daily sum of digital signatures
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.FiscalTagFieldResult" signatureSumPerpetual: description: "Total sum of digital signatures
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.FiscalTagFieldResult" timestamp: description: "Date and time of signature
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.FiscalTagFieldResult" esdId: description: "ESD serial number
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.FiscalTagFieldResult" receiptPrinted: type: "boolean" description: "deprecated: as of 5.5.0. Use instead proper service to set\
\ flag
\tA flag to indicate that the receipt was printed.
Additional extensions
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.Extension" binaryDataExtensions: type: "array" description: "Additional binary data extensions
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.Extension" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AddFiscalizationDataToTransactionRequestRequest object to add\ \ fiscalization data to a transaction.
" com.gk_software.pos.api.service.transaction.AddTransactionAdditionalPrintoutsRequest: type: "object" properties: transactionId: type: "string" transactionAdditionalPrintouts: type: "array" description: "A list of transaction additional printouts.
" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionAdditionalPrintout" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AddTransactionAdditionalPrintoutsRequestRequest object to add\ \ additional printouts to a transaction.
" com.gk_software.pos.api.service.transaction.AddTransactionExtensionRequest: type: "object" properties: transactionId: type: "string" description: "The identifier of the transaction where the transaction extensions\ \ should be added.
" extensionKey: type: "string" description: "The transaction extension key to be added to transaction.
" extensionValue: type: "string" description: "The transaction extension value to be added to transaction.
" storeTransaction: type: "boolean" description: "A flag to indicate if the transaction should be stored. The\ \ default value is false.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AddTransactionExtensionRequestRequest object for adding a transaction\ \ extension to the transaction.
" com.gk_software.pos.api.service.transaction.AddTransactionExtensionsRequest: type: "object" properties: requests: type: "array" description: "A list of AddTransactionExtensionRequest objects. To add\ \ a single transaction extension for each request object in the list.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.AddTransactionExtensionRequest" transactionId: type: "string" description: "The identifier of the transaction where the transaction extensions\ \ should be added.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AddTransactionExtensionsRequestRequest object for adding a list\ \ of transaction extensions to the transaction.
" com.gk_software.pos.api.service.transaction.AlternativeTaxRequest: type: "object" required: - "alternativeTaxInfos" - "calculateTax" properties: alternativeTaxInfos: description: "The alternative tax informations for updating the tax group.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos" calculateTax: type: "boolean" description: "A flag to indicate the recalculation of taxes.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "AlternativeTaxRequestRequest object for alternative tax.
" com.gk_software.pos.api.service.transaction.CalculateReturnUnitPricesRequest: type: "object" properties: positionOperationConfig: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" conditionSplitConfig: description: "The condition split configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.ConditionSplitConfig" manualDiscountTypes: type: "array" description: "This parameter defines the list of condition types for price\
\ reduction.
\t@deprecated as of 5.6.0. Use instead: conditionSplitConfig.manualDiscountTypes
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CalculateReturnUnitPricesRequestRequest object to calculate\ \ return unit prices during payment end.
" com.gk_software.pos.api.service.transaction.CancelAllExternalLineItemsRequest: type: "object" properties: positionOperationConfig: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" callingProcess: type: "string" description: "The name of the calling process.
" trainingMode: type: "boolean" description: "Indicates whether service should be started in training mode.
" couponingServiceHeader: description: "The header object which should be used (and is needed) for\ \ the couponing service request
" $ref: "#/definitions/com.gk_software.pos.api.service.coupon.CouponingRequestHeaderData" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CancelAllExternalLineItemsRequestRequest object to cancel all\ \ external line items.
" com.gk_software.pos.api.service.transaction.CancelAllExternalLineItemsResult: type: "object" required: - "additionalEntries" - "failedFrequentShopperPointsEarnedAmounts" properties: primaryEntry: description: "The primary transaction result entry.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" additionalEntries: type: "array" description: "Additional result entries.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" filtered: type: "boolean" description: "Indicates whether the transaction result is filtered. A filtered\ \ transaction does not contain the details of a retail transaction object\ \ in order to optimize service communication.
" failure: description: "Reference to a failure entity in case a failure occurs during\ \ a service execution. This field can be used when a managed exception occurs\ \ and we still want to synchronize the resulting transaction instead of\ \ throwing an exception containing no information on transaction updates.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult" atLeastOneLoyaltyPointsItemRefunded: type: "boolean" description: "A flag to indicate that at least one loyalty points item\ \ was cancelled successful.
" atLeastOneGiftCertCancelled: type: "boolean" description: "A flag to indicate that at least one gift certificate was\ \ cancelled successful.
" failedFrequentShopperPointsEarnedAmounts: type: "number" format: "double" description: "The amount of earned frequent shopper points that could not\ \ be cancelled successful.
" atLeastOneCheckoutCouponCanceled: type: "boolean" description: "A flag to indicate that at least one checkout coupon was\ \ canceled successful.
" atLeastOneCouponRedemptionCanceled: type: "boolean" description: "A flag to indicate that at least one coupon redemption was\ \ canceled successful.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CancelAllExternalLineItemsResultResult object for service call\ \ to cancel all external line items.
" com.gk_software.pos.api.service.transaction.CancelGiftCertLineItemRequest: type: "object" properties: lineItemKey: description: "The key of the retail transaction line item.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" transactionId: type: "string" description: "The transactionId
" receiptNumber: type: "string" description: "The receiptNumber
" callingProcess: type: "string" description: "The callingProcess
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CancelGiftCertLineItemRequestThe entity CancelGiftCertLineItemRequest
" com.gk_software.pos.api.service.transaction.CancelTransactionRequest: type: "object" required: - "finalizeTransaction" properties: reason: description: "The reason.
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO" finalizeTransaction: type: "boolean" description: "A flag to indicate if the transaction should be finalized.\ \ The default value is true.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CancelTransactionRequestRequest object for cancelling a transaction.
" com.gk_software.pos.api.service.transaction.CashRefundRequest: type: "object" properties: transactionId: type: "string" description: "The identifier of the transaction to refund.
" positionOperationConfig: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CashRefundRequestRequest object for cash refund.
" com.gk_software.pos.api.service.transaction.CheckPriceLimitRequest: type: "object" properties: absolutePositionLimit: type: "number" format: "double" description: "The absolute price position limit.
" percentPositionLimit: type: "number" format: "double" description: "The percentage price position limit.
" oldPrice: type: "number" format: "double" description: "The old price.
" newPrice: type: "number" format: "double" description: "The new price.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CheckPriceLimitRequestRequest object for checking of price limits.
" com.gk_software.pos.api.service.transaction.CheckQuantityInputProhibitedRequest: type: "object" properties: posItemId: type: "string" description: "The pos item Id
" businessUnitId: type: "string" description: "The business unit Id
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CheckQuantityInputProhibitedRequestThe check quantity input\ \ prohibited request object
" com.gk_software.pos.api.service.transaction.CheckTransactionVoidableRequest: type: "object" properties: transactionToVoidId: type: "string" description: "The identifier of transaction to void.
" receiptAgeAllowedInDays: type: "integer" format: "int32" description: "The allowed age of the transaction to void in days. If a\ \ receipt is older than allowed it is not voidable anymore.
" giftCertCancelAllowed: type: "boolean" description: "Indicates if cancellation of gift certificates is allowed.
" onlySamePosAllowed: type: "boolean" description: "Indicates cancellation of receipts of other workstations\ \ is allowed or not. If only same workstation is allowed. The currentWorkstationId\ \ must match the workstation identifier in the transaction.
" currentWorkstationId: type: "string" description: "The current workstation identifier.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CheckTransactionVoidableRequestRequest object to check if a\ \ transaction is voidable.
" com.gk_software.pos.api.service.transaction.ComboMealRegistrationRequest: type: "object" required: - "mainLineItem" properties: mainLineItem: type: "boolean" description: "Flag if line item to register is the main line item of the\ \ 'Combo Meal'
" mainLineItemKey: description: "The line item key of the 'Combo Meal' main line item. This\ \ field should only be set for related item registration.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" relatedLineItemOriginalPrice: type: "number" format: "double" description: "The original price of the 'Combo Meal' related line item\
\ (max(ComponentItem.currentPrice) of all standard items of the component).\
\
\tThis field should only be set for related item registration and\
\ if the related item is an alternative item.
Flag if 'discount shares calculation' should be processed\ \ during registration.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ComboMealRegistrationRequestDomain object for ComboMealRegistration
" com.gk_software.pos.api.service.transaction.ConvertSuspendCodesRequest: type: "object" properties: suspendCodes: type: "array" description: "List of suspend codes.
" items: type: "string" numberFormat: type: "object" description: "The number format for prices.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ConvertSuspendCodesRequestRequest object to convert suspend\ \ codes to transaction.
" com.gk_software.pos.api.service.transaction.ConvertSuspendCodesResponse: type: "object" properties: transactionFromConvertedSuspendCodes: description: "Transaction created with information from code.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" skippedItems: type: "array" description: "List of skipped items.
" items: $ref: "#/definitions/com.gk_software.pos.flow.libs.transaction.SuspendCodeSkippedItem" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ConvertSuspendCodesResponseResponse object from convert suspend\ \ codes function.
" com.gk_software.pos.api.service.transaction.CreateDownpaymentLineItemRequest: type: "object" properties: externalCustomerOrderID: type: "string" description: "The external customerOrderID
" salesOrderTypeCode: type: "string" description: "The salesOrder typeCode
" receiptAmount: type: "string" description: "The receipt amount
" documentInfos: type: "array" description: "The documentInfos
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SalesOrderSalesDocItem" saleReturnLineItemDataRequest: description: "{@link com.gk_software.pos.api.service.transaction.SaleReturnLineItemDataRequest}\ \ data
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SaleReturnLineItemDataRequest" languageDifferent: type: "boolean" description: "The language different
" operationConfiguration: description: "PositionOperationConfig
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" recalculateTransaction: type: "boolean" description: "Indicates whether the transaction should be recalculated.\ \ Default value is 'true'.
" storeTransaction: type: "boolean" description: "Indicates whether the transaction should be stored. Default\ \ value is 'true'.
" entryMethodCode: type: "string" description: "Contains the method with which the item was registered (keyed\ \ in, scanned through bar code, etc).
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateDownpaymentLineItemRequestRequest object for creating\ \ a CreateDownpaymentLineItem
" com.gk_software.pos.api.service.transaction.CreateDrawerAccountsRequest: type: "object" properties: tenderRegistration: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.tender.TenderRegistration" manualChange: type: "number" format: "double" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateDrawerAccountsRequest TODO: undocumented" com.gk_software.pos.api.service.transaction.CreateFailFiscalTransactionRequest: type: "object" required: - "fiscalizationData" properties: fiscalizationData: description: "The fiscalization data that should be added to the fiscal\ \ fail transaction.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.AddFiscalizationDataToTransactionRequest" originalTransactionID: type: "string" description: "The identifier of the original transaction for that the fiscal\ \ fail transaction should be created.
" retailStoreId: type: "string" description: "The retail store identifier.
" workstationId: type: "string" description: "The workstation identifier.
" clientVersion: type: "string" description: "The client version.
" operatorId: type: "string" description: "The operator identifier.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateFailFiscalTransactionRequestRequest object to create a\ \ fiscal fail transaction.
" com.gk_software.pos.api.service.transaction.CreateInvoicePaymentLineItemRequest: type: "object" properties: operationConfiguration: description: "The operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" saleReturnLineItemDataRequest: description: "The saleReturnLineItemData request
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SaleReturnLineItemDataRequest" customerReceiptText: type: "string" description: "The customer receipt text.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateInvoicePaymentLineItemRequestRequest object for creating\ \ a InvoicePaymentLineItem
" com.gk_software.pos.api.service.transaction.CreateLineItemRequest: type: "object" properties: operationConfiguration: description: "The operationConfiguration
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" customerReceiptText: type: "string" description: "The customerReceiptText
" saleReturnLineItemRequestData: description: "The saleReturnLineItemRequestData
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SaleReturnLineItemDataRequest" tenderRequestData: description: "The tenderRequestData
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TenderLineItemDataRequest" additionalParameterMap: type: "object" description: "Map<String,String> map for additional parameters for\ \ retailLineItem
" additionalProperties: type: "string" sellerId: type: "string" description: "String to store seller Id
" sellerRelationMethod: type: "string" description: "sellerRelationMethod to store the currently defined seller\ \ assignment method
" enum: - "CurrentLineItemOnly" - "CurrentAndFollowingLineItemsOfCurrentTransaction" - "CurrentAndFollowingLineItemsOfCurrentAndFollowingTransactions" - "AllLineItemsOfCurrentTransaction" - "FollowingLineItemsOfCurrentTransaction" - "FollowingLineItemsOfCurrentAndFollowingTransactions" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateLineItemRequestThe entity CreateLineItemRequest
" com.gk_software.pos.api.service.transaction.CreateSuspendCodeRequest: type: "object" properties: transaction: description: "Transaction from which will be created suspend code.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" maxSizeOf2DCode: type: "integer" format: "int32" description: "Max size of one created 2D code.
" codeVersion: type: "string" description: "Version of created code.
" suspendNumber: type: "string" description: "Entered or generated suspend number.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateSuspendCodeRequestRequest object to create suspend code\ \ from transaction.
" com.gk_software.pos.api.service.transaction.CreateTransactionLineItemAssociationRequest: type: "object" properties: fromLineItemKey: description: "The line item key of the from line item.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" toLineItemKey: description: "The line item key of the to line item.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" lineItemAssociationTypeCode: type: "string" description: "The line item association type code.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateTransactionLineItemAssociationRequestRequest object to\ \ create a retail transaction line item association.
" com.gk_software.pos.api.service.transaction.CreateTransactionLineItemAssociationsRequest: type: "object" properties: requests: type: "array" description: "The list of request objects to create a single retail line\ \ item association one by one.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.CreateTransactionLineItemAssociationRequest" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateTransactionLineItemAssociationsRequestRequest object to\ \ create multiple retail transaction line item associations.
" com.gk_software.pos.api.service.transaction.CreateVoidTransactionRequest: type: "object" properties: transactionToVoidId: type: "string" description: "The identifier of the transaction to void.
" reasonCode: type: "string" description: "The reason code.
" reasonDescription: type: "string" description: "The reason description.
" giftCertCancellationAllowed: type: "boolean" description: "A flag to indicate that gift certificate cancellation is\ \ allowed.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateVoidTransactionRequestRequest object to create a void\ \ transaction.
" com.gk_software.pos.api.service.transaction.CreateWorkerDiscountLineItemRequest: type: "object" properties: workerID: type: "string" description: "The worker id.
" receiptText: type: "string" description: "The receipt text for a worker discount.
" operationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CreateWorkerDiscountLineItemRequestRequest object for creating\ \ worker discounts.
" com.gk_software.pos.api.service.transaction.DeactivateTaxExemptRequest: type: "object" properties: lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "DeactivateTaxExemptRequestRequest object for deactivating tax\ \ exemption.
" com.gk_software.pos.api.service.transaction.DuplicatePrintOutTransactionsRequest: type: "object" properties: transactionIsNotVoided: type: "boolean" description: "A flag to indicate that only transactions that are not voided\ \ should be searched.
" CancelledFlag: type: "boolean" description: "A flag to indicate that only transactions that are cancelled\ \ should be searched.
" SuspendedFlag: type: "boolean" description: "A flag to indicate that only transactions that are suspended\ \ should be searched.
" workstationID: type: "string" description: "The workstation identifier.
" businessUnitGroupID: type: "string" description: "The business unit group identifier.
" businessUnitID: type: "string" description: "The business unit identifier.
" maxReceiptCount: type: "integer" format: "int32" description: "Limits the number of found receipts to the given value.
" originalTransactionId: type: "string" description: "The identifier for the original transaction (as part of the\ \ search criteria).
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "DuplicatePrintOutTransactionsRequestRequest object to search\ \ for duplicate printout transactions.
" com.gk_software.pos.api.service.transaction.EnterCouponRequest: type: "object" properties: couponNumber: type: "string" description: "The coupon number.
" privilegeType: type: "string" description: "The coupon privilege type.
" enum: - "DISCOUNT_PERCENT" - "DISCOUNT_ABSOLUTE" - "PRICE_ABSOLUTE" privilegeValue: type: "number" format: "double" description: "The coupon privilege value.
" positionOperationConfig: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" couponSerialData: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.EnterCouponSerialData" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "EnterCouponRequestRequest object for entering coupons.
" com.gk_software.pos.api.service.transaction.EnterCouponSerialData: type: "object" properties: couponSerialNumber: type: "string" bookingSuccessfulTypeCode: type: "string" bookingTransactionUuid: type: "string" expirationTimestamp: type: "string" example: "'2018-05-16T16:09:24.394'" description: "Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "EnterCouponSerialData TODO: undocumented" com.gk_software.pos.api.service.transaction.Extension: type: "object" properties: extensionKey: type: "string" description: "Extension key
" extensionValue: type: "string" description: "Extension value
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ExtensionExtension object
" com.gk_software.pos.api.service.transaction.ExternalItemRegistrationRequest: type: "object" required: - "isoCurrencyCode" - "locale" properties: isoCurrencyCode: type: "string" description: "The ISO currency code.
" locale: type: "string" description: "The locale.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ExternalItemRegistrationRequestDomain object used for registration\ \ of external line items
" com.gk_software.pos.api.service.transaction.ExternalLineItemData: type: "object" required: - "actualUnitPrice" - "quantity" - "receiptText" properties: posItemID: type: "string" description: "The pos item ID - IdentityAlphaNumeric40.
" itemID: type: "string" description: "The item ID - IdentityUUID.
" posDepartmentID: type: "string" description: "The pos department ID - IdentityAlphaNumeric40.
" unitOfMeasureCode: type: "string" description: "The unit of measure code - Code4
" itemType: type: "string" description: "The item type - Code4
" regularUnitPrice: type: "number" format: "double" description: "The regular unit price - MoneyShortRetail
" regularUnitPriceQuantity: type: "integer" format: "int32" description: "The number of items the regular price is defined for, i.e.\ \ 3 for $1.00
" actualUnitPrice: type: "number" format: "double" description: "The actual unit price - MoneyShortRetail
" actualUnitPriceQuantity: type: "integer" format: "int32" description: "The number of items the actual price is defined for, i.e.\ \ 3 for $1.00
" quantity: type: "integer" format: "int32" description: "The quantity - QuantityIntegerGK
" units: type: "number" format: "double" description: "The units - Quantity
" quantityInputMethod: type: "string" description: "The quantity input method - Code2
" length: type: "number" format: "double" description: "The length - Quantity
" width: type: "number" format: "double" description: "The width - Quantity
" height: type: "number" format: "double" description: "The height - Quantity
" receiptText: type: "string" description: "The receipt text - NNameGK
" receiptDescription: type: "string" description: "The receipt description - NDescriptionShortGK
" wicFlag: type: "boolean" description: "The wic flag - BIT
" allowFoodStampFlag: type: "boolean" description: "The allow food stamp flag -> BIT
" registrationNumber: type: "string" description: "The registration number - DescriptionShort
" discountFlag: type: "boolean" description: "The discount flag - BIT
" frequentShopperPointsEligibilityFlag: type: "boolean" description: "The frequent shopper points eligibility flag - BIT
" discountTypeCode: type: "string" description: "The discount type code - VARCHAR(1)
" priceChangeTypeCode: type: "string" description: "The price change type code - Code2
" priceTypeCode: type: "string" description: "The price type code - Code2
" notConsideredByLoyaltyEngineFlag: type: "boolean" description: "The not considered by loyalty engine flag - BIT
" merchandiseHierarchyGroupName: type: "string" description: "The merchandise hierarchy group name - Name
" merchandiseHierarchyGroupDescription: type: "string" description: "The merchandise hierarchy group description - DescriptionShort
" itemClassCode: type: "string" description: "The item class code - Code4
" prohibitTaxExemptFlag: type: "boolean" description: "The prohibit tax exempt flag - BIT
" prohibitReturnFlag: type: "boolean" description: "The prohibit return flag - BIT
" warrantyDuration: type: "number" format: "double" description: "The warranty duration - QuantityTransactionCount
" depositTypeCode: type: "string" description: "The deposit type code - Code2
" taxExemptCode: type: "string" description: "The tax exempt code - Code2
" mainPOSItemID: type: "string" description: "The main POS item ID - IdentityGTIN
" mainMerchandiseHierarchyGroupIDQualifier: type: "string" description: "The main merchandise hierarchy group ID qualifier - Code4
" mainMerchandiseHierarchyGroupID: type: "string" description: "The main merchandise hierarchy group ID - IdentityAlphaNumeric40
" taxGroupID: type: "string" description: "The tax group ID - Code
" tareCount: type: "number" format: "double" description: "The tare ount - Quantity16_3GK
" saleReturnLineItemCharacteristicList: type: "array" description: "The sale return line item characteristic list - SaleReturnLineItemCharacteristic[0..*]
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SaleReturnLineItemCharacteristic" saleReturnLineItemMerchandiseHierarchyGroupList: type: "array" description: "The sale return line item merchandise hierarchy group list\ \ - SaleReturnLineItemMerchandiseHierarchyGroup[0..*]
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SaleReturnLineItemMerchandiseHierarchyGroup" retailTransactionLineItemI18NTextList: type: "array" description: "The retail transaction line item I18N text list - RetailTransactionLineItemI18NText[0..*]
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.RetailTransactionLineItemI18NText" serializedUnitModifer: description: "The serialized unit modifer - SerializedUnitModifer
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SerializedUnitModifer" saleReturnLineItemSalesOrder: description: "The sale return line item sales order - SaleReturnLineItemSalesOrder
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SaleReturnLineItemSalesOrder" reasonCode: type: "string" description: "The reason code
" reasonCodeGroupCode: type: "string" description: "The reason code group code
" reasonDescription: type: "string" description: "The reason description
" retailTransactionLineItemAdditionalParameterList: type: "array" description: "The retail transaction line item additional parameter list
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.RetailTransactionLineItemAdditionalParameter" retailPriceModifierList: type: "array" description: "The retail price modifier list
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.ExternalRetailPriceModifier" lineItemExtensionList: type: "array" description: "The line item extension list
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.LineItemExtension" printAdditionalLineItemTextLineList: type: "array" description: "The print additional line item text line list
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.PrintAdditionalLineItemTextLine" description: "ExternalLineItemDataManual line item creation with external\ \ data.
" com.gk_software.pos.api.service.transaction.FinalizeTransactionRequest: type: "object" required: - "ignoreParentOffline" properties: positionOperationConfig: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" ignoreParentOffline: type: "boolean" description: "Indicates whether correlation checking should be ignored\ \ if parent pool is offline.
" omitParentExport: type: "boolean" description: "Indicates that the export of finalized transaction must be\ \ omit.
" transactionId: type: "string" description: "The identifier for the transaction.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FinalizeTransactionRequestRequest to finalize a transaction.
" com.gk_software.pos.api.service.transaction.FiscalTagFieldResult: type: "object" properties: label: type: "string" description: "The label that must be printed on the receipt.
" value: type: "string" description: "The fiscal value that must be printed on the receipt.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "FiscalTagFieldResultResult of an single object that contains\ \ the tag field value related to each signature result.
" com.gk_software.pos.api.service.transaction.GetEndDateTimestampExtensionRequest: type: "object" properties: transactionId: type: "string" description: "The transaction identifier for the transaction to get the\ \ end date timestamp from.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "GetEndDateTimestampExtensionRequestRequest object to get the\ \ end date timestamp from transaction extensions of a transaction.
" com.gk_software.pos.api.service.transaction.GetOrCreateEndDateTimestampExtensionResult: type: "object" required: - "additionalEntries" properties: primaryEntry: description: "The primary transaction result entry.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" additionalEntries: type: "array" description: "Additional result entries.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" filtered: type: "boolean" description: "Indicates whether the transaction result is filtered. A filtered\ \ transaction does not contain the details of a retail transaction object\ \ in order to optimize service communication.
" failure: description: "Reference to a failure entity in case a failure occurs during\ \ a service execution. This field can be used when a managed exception occurs\ \ and we still want to synchronize the resulting transaction instead of\ \ throwing an exception containing no information on transaction updates.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult" endDateTimestampExtension: description: "The end date timestamp transaction extension.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionExtension" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "GetOrCreateEndDateTimestampExtensionResultResult object for\ \ getting or creating the end date timestamp extension.
" com.gk_software.pos.api.service.transaction.InternalLineItemData: type: "object" properties: posItemID: type: "string" description: "Item identification.
" itemID: type: "string" description: "Item identification.
" amount: type: "number" format: "double" description: "Item amount.
" taxGroupID: type: "string" description: "Item tax group id.
" itemReceiptText: type: "string" description: "Item description
" description: "InternalLineItemData TODO: undocumented" com.gk_software.pos.api.service.transaction.InvoiceNumberRequest: type: "object" properties: positionOperationConfig: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" invoicetransactionId: type: "string" description: "The invoice transaction identifier.
" invoiceNumberFormat: type: "string" description: "The invoice number format pattern.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "InvoiceNumberRequestRequest object to create the invoice number\ \ and set it to transaction.
" com.gk_software.pos.api.service.transaction.InvoicePrintoutTypeCodeRequest: type: "object" properties: positionOperationConfig: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" invoicePrintoutTypeCode: type: "string" description: "The invoice printout type code.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "InvoicePrintoutTypeCodeRequestRequest object to set the invoice\ \ printout type code.
" com.gk_software.pos.api.service.transaction.ItemIdentificator: type: "object" properties: itemID: type: "string" description: "The id of the item to register.
" uomCode: type: "string" description: "The id of the item to register.
" description: "ItemIdentificatorDomain object for ItemIdentificator.
" com.gk_software.pos.api.service.transaction.LimitExceedResult: type: "object" required: - "limitExceedAction" - "newPrice" - "oldPrice" properties: limitExceedAction: type: "string" description: "The limit exceed action
" oldPrice: type: "number" format: "double" description: "The old price
" newPrice: type: "number" format: "double" description: "The new price
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LimitExceedResultThe limit exceed result
" com.gk_software.pos.api.service.transaction.LineItemExtensionRequest: type: "object" required: - "createReturnReceipt" - "emptiesReturnMode" - "returnMode" properties: operationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" returnMode: type: "boolean" description: "Indicated whether the item should be returned or registered.
" emptiesReturnMode: type: "boolean" description: "Flag indicating client is in empties return mode.
" createReturnReceipt: type: "boolean" description: "This parameter specifies whether a return receipt should\
\ be created for returned items.
\tThis has only an impact in case\
\ returnMode=true.
The extension Key.
" extensionValue: type: "string" description: "The extension Value.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LineItemExtensionRequestDomain object for LineItemExtensionRequest.
" com.gk_software.pos.api.service.transaction.LineItemExtensionsRequest: type: "object" properties: extensionRequests: type: "array" description: "The extensions request.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.LineItemExtensionRequest" operationConfiguration: description: "The operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LineItemExtensionsRequestDomain object for LineItemExtensionsRequest.
" com.gk_software.pos.api.service.transaction.LineItemsReductionDetail: type: "object" properties: lineItemKey: description: "The key identifier for the line item to be reduced.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" maximumReductionQuantity: type: "integer" format: "int32" description: "Describes the maximum number of reductions to be performed\ \ on given line item.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LineItemsReductionDetailEntity containing details for performing\ \ the item reduction.
" com.gk_software.pos.api.service.transaction.LinkedItemRegistrationRequest: type: "object" properties: linkedItemId: type: "string" description: "The id of the linked item to be registered.
" linkedItemUOMCode: type: "string" description: "the UOM code of the linked item to be registered.
" mainItemId: type: "string" description: "The id of the main item linked to this linked item.
" actionCode: type: "string" description: "The actionCode of this linked item.
" units: type: "number" format: "double" description: "The units of this linked item.
" quantity: type: "integer" format: "int32" description: "The quantity of the mainitem.
" maintemSequenceNumber: type: "integer" format: "int32" description: "linkedLineItemSequenceNumber of this linked item.
" mainLineItem: description: "RetailTransactionLineItem
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "LinkedItemRegistrationRequestRequest object for registering\ \ linked items.
" com.gk_software.pos.api.service.transaction.PKORKONumberRequest: type: "object" properties: invoicetransactionId: type: "string" description: "The identifier for the invoice transaction.
" invoiceNumberFormat: type: "string" description: "The invoice number format pattern.
" transactionType: type: "string" description: "The transaction type.
" generatorName: type: "string" description: "The generator name.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PKORKONumberRequestRequest object to retrieve new document number\ \ for PKO/RKO reports.
" com.gk_software.pos.api.service.transaction.PayInOutLineItemRequest: type: "object" properties: reason: description: "The reason
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO" amount: type: "number" format: "double" description: "The amount
" taxGroupId: type: "string" description: "The taxGroupId
" itemType: type: "string" description: "The PayInOutType
" enum: - "PAY_IN_LINEITEM" - "PAY_IN_RECEIPT" - "PAY_OUT_LINEITEM" - "PAY_OUT_RECEIPT" operationConfiguration: description: "The operationConfiguration
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" receiptText: type: "string" description: "The receiptText
" customerReceiptText: type: "string" description: "The customerReceiptText
" reasonParams: description: "The PayInOutReasonParam
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.PayInOutReasonParam" alternativeTaxInfos: description: "The alternative tax infos for updating the tax group.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos" sellerId: type: "string" description: "String to store seller Id
" sellerRelationMethod: type: "string" description: "sellerRelationMethod to store the currently defined seller\ \ assignment method
" enum: - "CurrentLineItemOnly" - "CurrentAndFollowingLineItemsOfCurrentTransaction" - "CurrentAndFollowingLineItemsOfCurrentAndFollowingTransactions" - "AllLineItemsOfCurrentTransaction" - "FollowingLineItemsOfCurrentTransaction" - "FollowingLineItemsOfCurrentAndFollowingTransactions" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PayInOutLineItemRequestDomain object for CreatePayInOutLineItem\ \ Request
" com.gk_software.pos.api.service.transaction.PayInOutReasonParam: type: "object" properties: input0_name: type: "string" description: "The input0_name.
" input1_name: type: "string" description: "The input1_name.
" input2_name: type: "string" description: "The input2_name.
" input3_name: type: "string" description: "The input3_name.
" input0_value: type: "string" description: "The input0_value.
" input1_value: type: "string" description: "The input1_value.
" input2_value: type: "string" description: "The input2_value.
" input3_value: type: "string" description: "The input3_value.
" input0_id: type: "string" description: "The input0_id.
" input1_id: type: "string" description: "The input1_id.
" input2_id: type: "string" description: "The input2_id.
" input3_id: type: "string" description: "The input3_id.
" description: "PayInOutReasonParamDomain object for PayInOutReasonParam
" com.gk_software.pos.api.service.transaction.PointsRefundBatchRequest: type: "object" properties: positionOperationConfiguration: description: "Position operation configuration
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" retailTransactionLineItems: type: "array" description: "The retailTransactionLineItems
" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem" businessUnitId: type: "string" description: "The businessUnitId
" trainingMode: type: "boolean" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PointsRefundBatchRequestThe entity for refunding batch of points\ \ line items.
" com.gk_software.pos.api.service.transaction.PointsRefundRequest: type: "object" required: - "ignoreFailures" - "voidTenderLineItems" properties: retailTransactionLineItem: description: "The retailTransactionLineItem
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem" businessUnitId: type: "string" description: "The businessUnitId
" ignoreFailures: type: "boolean" description: "Indicates whether failures should be ignored during the cancellation\ \ process and tries to cancel all points.
" voidTenderLineItems: type: "boolean" description: "Indicates whether tender line items should be voided during\ \ the cancellation process.
" trainingMode: type: "boolean" description: "Indicates whether service call should be performed in training\ \ mode.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PointsRefundRequestThe entity PointsRefundRequest
" com.gk_software.pos.api.service.transaction.PosTransactionCRSCashExchangeRequest: type: "object" properties: operatorId: type: "string" description: "String: the operator ID
" amountToPayOut: type: "number" format: "double" description: "Double: the amount that should be payed out
" amountPayedOut: type: "number" format: "double" description: "Double: the amount that was payed out
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PosTransactionCRSCashExchangeRequestRequest object to create\ \ a cash recycler exchange transaction.
" com.gk_software.pos.api.service.transaction.PosTransactionRequest: type: "object" properties: retailStoreId: type: "string" description: "The retail store identifier.
" workstationId: type: "string" description: "The workstation identifier.
" clientVersion: type: "string" description: "The client version.
" operatorId: type: "string" description: "The operator identifier.
" terminalCache: type: "string" description: "The terminal cache.
" reason: description: "The reason.
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO" taxCertificateId: type: "string" description: "The tax certificate identifier.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PosTransactionRequestRequest object for multiple PosTransactionService\ \ calls, e.g. to create special control transactions.
" com.gk_software.pos.api.service.transaction.PrintOutTransactionsRequest: type: "object" properties: onlySalesReprintable: type: "boolean" description: "A flag to indicate that only transaction of type code 'RETAIL'\ \ and category code 'SALE' should be searched.
" TransactionTypeCode: type: "string" description: "The transaction type code.
" RetailTransactionTypeCode: type: "string" description: "The retail transaction type code.
" transactionIsNotVoided: type: "boolean" description: "A flag to indicate that only transactions that are not voided\ \ should be searched.
" CancelledFlag: type: "boolean" description: "A flag to indicate that only transactions that are cancelled\ \ should be searched.
" SuspendedFlag: type: "boolean" description: "A flag to indicate that only transactions that are suspended\ \ should be searched.
" workstationID: type: "string" description: "The workstation identifier.
" endWorkstationID: type: "string" businessUnitGroupID: type: "string" description: "The business unit group identifier.
" receiptIsPrintable: type: "boolean" description: "A flag to indicate that only transactions that are printable\ \ should be searched.
" maxReceiptCount: type: "integer" format: "int32" description: "Limits the number of found receipts to the given value.
" beginDateTimestampGreaterOrEquals: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The begin date timestamp greater or equals (as part of the\ \ search criteria).
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" parentCustomerIds: type: "array" description: "A list of parent customer identifiers.
" items: type: "string" customerIds: type: "array" description: "A list of customer identifiers.
" items: type: "string" customerAddressTypeCode: type: "string" description: "A card type which has to be used for the customer identification.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PrintOutTransactionsRequestRequest object to search for printout\ \ transactions.
" com.gk_software.pos.api.service.transaction.PrintoutRelatedAttributesRequest: type: "object" properties: transaction: description: "The transaction on which the receiptPrintoutFlag should be\ \ set.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" receiptPrintoutFlag: type: "boolean" description: "A flag to indicate that for the transaction a receipt was\ \ printed.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PrintoutRelatedAttributesRequestRequest object to set printout\ \ related attributes.
" com.gk_software.pos.api.service.transaction.QuantityInput: type: "object" properties: pieces: type: "integer" format: "int32" description: "The pieces.
" length: type: "number" format: "double" description: "The length.
" width: type: "number" format: "double" description: "The width.
" height: type: "number" format: "double" description: "The height.
" measure: type: "number" format: "double" description: "The measure.
" weight: type: "number" format: "double" description: "The weight.
" manualWeightInput: type: "boolean" description: "The manual weight input.
" units: type: "number" format: "double" description: "The units.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "QuantityInputRequest object for quantity input.
" com.gk_software.pos.api.service.transaction.RecalculateLineItemsRequest: type: "object" properties: items: type: "array" description: "A list of retail transaction line items for recalculation.
" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem" currencyCode: type: "string" description: "The currency code.
" businessUnitGroupId: type: "string" description: "The business unit group identifier.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RecalculateLineItemsRequestRequest object for recalculation\ \ of line items PosTransactionService.
" com.gk_software.pos.api.service.transaction.ReceiptAsEmailActivationRequest: type: "object" required: - "emailRequestedFlag" properties: emailRequestedFlag: type: "boolean" description: "A flag to enable/disable receipt as email.
" emailAddress: type: "string" description: "The user email address.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ReceiptAsEmailActivationRequestRequest object for receipt as\ \ email activation.
" com.gk_software.pos.api.service.transaction.RecoverTransactionRequest: type: "object" properties: xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RecoverTransactionRequestRequest object to check for an open\ \ transaction in the persistence and if a transaction exits to load it and set\ \ as current active transaction.
" com.gk_software.pos.api.service.transaction.ReduceLineItemsRequest: type: "object" required: - "positionOperationConfiguration" properties: positionOperationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemsReductionDetail: type: "array" description: "List of entities containing details for performing the item\ \ reduction.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.LineItemsReductionDetail" keyedOnline: type: "boolean" description: "The keyed online state.
" offlineMode: type: "boolean" description: "A flag to indicate whether offline mode registration is active\ \ or not.
" storeTransaction: type: "boolean" description: "Indicates whether the transaction should be stored.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ReduceLineItemsRequest TODO: undocumented" com.gk_software.pos.api.service.transaction.RegisterCustomerAccountPaymentRequest: type: "object" required: - "checkForVariants" - "closeLineItem" - "createReturnReceipt" - "doPriceDifferenceLimitCheck" - "emptiesReturnMode" - "getPromoIcons" - "layawayMode" - "linkedEmptiesItem" - "orderMode" - "postValidationSalesRestrictionIds" - "returnMode" - "returnReasonRequired" - "salesRestrictionsCheckNeeded" - "takeAwaySaleMode" - "takeOverSetItems" - "wicMode" properties: operationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" returnMode: type: "boolean" description: "Indicated whether the item should be returned or registered.
" emptiesReturnMode: type: "boolean" description: "Flag indicating client is in empties return mode.
" createReturnReceipt: type: "boolean" description: "This parameter specifies whether a return receipt should\
\ be created for returned items.
\tThis has only an impact in case\
\ returnMode=true.
The barcode of the item to register. At least the barcode\ \ OR the itemIdentificator are mandatory request attributes.
" itemIdentificator: description: "The item identificator. At least the barcode OR the itemIdentificator\ \ are mandatory request attributes.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.ItemIdentificator" wicMode: type: "boolean" description: "Wic mode flag.
" takeOverSetItems: type: "boolean" description: "Indicated whether set items should be registered individually\ \ or be added to head item.
" orderMode: type: "boolean" description: "The order mode.
" layawayMode: type: "boolean" description: "Indicates whether the layaway mode is active.
" takeAwaySaleMode: type: "boolean" description: "Indicates whether the take away sale mode is active.
" checkForVariants: type: "boolean" description: "Indicates if variant check should be performed.
" salesRestrictionsCheckNeeded: type: "boolean" description: "Indicates if validation process should check sales restrictions.
" returnReasonRequired: type: "boolean" description: "indicates if variant check should be performed.
" linkedEmptiesItem: type: "boolean" description: "Indicates the request is for a linked empties deposit item.
" closeLineItem: type: "boolean" description: "Indicates whether line item should be closed during the registration\ \ (used for empties return using deposit collections).
" getPromoIcons: type: "boolean" description: "Indicates whether promo icons should be retrieved.
" emptiesReturnQuantity: type: "integer" format: "int32" description: "Quantity to be overwritten for deposit item registered as\ \ empties during item registration.
" priceVariant: type: "string" description: "price variant to use.
" enum: - "Normal" - "Special" - "Actual" - "Group" overridingPrice: type: "number" format: "double" description: "The overriding price.
" overridingQuantity: description: "the overriding quantity.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.QuantityInput" overridingPositionAmount: type: "number" format: "double" description: "The overriding position amount.
" weightResult: description: "The weight result from a previously done weighing process\ \ (e.g. item required weight input).
" $ref: "#/definitions/com.gk_software.pos.api.service.client.hardware.scale.WeightResult" doPriceDifferenceLimitCheck: type: "boolean" description: "Indicates whether the price difference limit checks should\ \ be done or not.
" priceTypeCode: type: "string" description: "Price type code (for price change).
" setPriceMode: type: "string" description: "Set price mode (for price change).
" reasonCode: type: "string" description: "A reason code for this request (e.g. reason for returns).
" reasonCodeGroupCode: type: "string" description: "A reason code group code for this request (e.g. reason for\ \ returns).
" reasonDescription: type: "string" description: "A reason description for this request (e.g. reason for returns).
" reasonParameter: description: "A reason parameter used for handling of salable information.
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonParameterSO" priceChangeReasonCode: type: "string" description: "A price change reason code.
" priceChangeReasonCodeGroupCode: type: "string" description: "A price change reason code group code.
" priceChangeReasonDescription: type: "string" description: "A price change reason description.
" serialNumber: type: "string" description: "Serial number to set.
" itemTraceableUnitID: type: "string" description: "A universally unique identifier (min=0, max=32) used to identify\ \ an instance of a distinguishable instance of a retail item. The item traceable\ \ unit ID is similar to a serial number in that it allows each selling unit\ \ to be explicitly identified and distinguished from other selling units\ \ of the same Item.
" receiptText: type: "string" description: "Receipt text to set.
" linkedItemRegistrationRequest: description: "Object for linked item information.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.LinkedItemRegistrationRequest" externalItemRegistrationRequest: description: "A request to register an external item to transaction.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.ExternalItemRegistrationRequest" factor: type: "number" format: "double" description: "Double.
" activeCustomerOrderId: type: "string" description: "The active customer order id.
" customerSequenceNumber: type: "integer" format: "int32" description: "The customer oder sequence number.
\t@deprecated use\
\ customerOrderSequenceNumber instead.
The customer order sequence number.
" salesOrderTypeCode: type: "string" description: "The sales order type code.
" salesOrderDeliveryTypeCode: type: "string" description: "The sales order delivery type code.
" requestedDeliveryDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The requested delivery date for the item.
Date format\ \ 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" itemEntryConfig: description: "ItemEntryConfig - bring config to server side.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.ItemEntryConfig" salesPersonNumberRequest: description: "Request for Sales Person Number.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SalesPersonNumberRequest" alternativeTaxInfos: description: "The alternative tax infos for updating the tax group.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos" entryMethodCode: type: "string" description: "The entry method code. It specifies how the action was triggered\ \ (keyed, scanned, ...).
" scaleTransactionParams: description: "Scale transaction parameters to add to transaction.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.ScaleTransactionParams" keyedOnline: type: "boolean" description: "The keyed online state.
" postValidationSalesRestrictionIds: type: "array" description: "The list of post validation sales restriction ids to add\ \ to SaleReturnLineItem.
" items: type: "string" promotionTriggerActive: type: "boolean" description: "The promotion trigger active state.
" lineItemItemType: type: "string" description: "The qualified line item type.
" retailPriceModifierList: type: "array" description: "The list of external retail price modifier to add to transaction.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.ExternalRetailPriceModifier" lineItemExtensionList: type: "array" description: "The list of external retail price modifier to add to transaction.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.LineItemExtension" printAdditionalLineItemTextLineList: type: "array" description: "The print list for additional line item text to print.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.PrintAdditionalLineItemTextLine" scaleMode: type: "string" description: "The current active scale mode.
" enum: - "SelfService" - "Prepackaging" - "Service" scaleSellingMode: type: "string" enum: - "Standard" - "Fast" courseNumber: type: "string" description: "The course Number to be set on line item
" itemProvider: type: "string" description: "The parameter defines the provider for the item data.
" enum: - "Local" - "Remote" comboMealRegistrationRequest: description: "The parameter consists all information for a combo meal item\ \ registration
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.ComboMealRegistrationRequest" itemType: type: "string" description: "The itemType
" i18NTextPayOut: type: "string" description: "The i18NTextPayOut
" i18NTextPayIn: type: "string" description: "The i18NTextPayIn
" languageDifferent: type: "boolean" description: "The languageDifferent
" customerAccountText: type: "string" description: "The customerAccountText
" customerId: type: "string" description: "The customerId
" receiptTextPI: type: "string" description: "The receiptTextPI
" receiptTextPO: type: "string" description: "The receiptTextPO
" openAmount: type: "number" format: "double" description: "The openAmount
" amount: type: "number" format: "double" description: "The amount
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RegisterCustomerAccountPaymentRequestThe entity RegisterCustomerAccountPaymentRequest
" com.gk_software.pos.api.service.transaction.RegisterEmptiesTransactionRequest: type: "object" required: - "addAsOneLineItem" - "returnMode" - "statusNotFoundConfirmed" - "statusOfflineConfirmed" - "statusRedeemedConfirmed" properties: positionOperationConfig: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" returnMode: type: "boolean" description: "A flag to indicate that return mode is active.
" collectiveNumber: type: "string" description: "The collective number. When add as one line item is wanted\ \ or necessary the item with collective number is used for empties return\ \ transaction registration.
" transactionIdentifier: type: "string" description: "The transaction identifier for the empties return transaction.
" amount: type: "number" format: "double" description: "The amount. In case of collective item usage the unit price\ \ amount for the line item registration.
" amount1: type: "number" format: "double" description: "The amount1. In case of collective item usage and amount\ \ is not used the unit price amount for the one-way and multi-way returnable\ \ deposit type 1 line item registration.
" amount2: type: "number" format: "double" description: "The amount2. In case of collective item usage and amount\ \ is not used the unit price amount for the one-way and multi-way returnable\ \ deposit type 2 line item registration.
" oneWayItemNumber: type: "string" description: "The one-way deposit item number.
" multiWayItemNumber: type: "string" description: "The multi-way deposit item number.
" depositType1: type: "string" description: "The deposit type 1.
" enum: - "RETURNABLE" - "NON_RETURNABLE" depositType2: type: "string" description: "The deposit type 2.
" enum: - "RETURNABLE" - "NON_RETURNABLE" addAsOneLineItem: type: "boolean" description: "A flag to indicate that the empties return line items should\ \ be registered as one collective line item.
" statusOfflineConfirmed: type: "boolean" description: "A flag to indicate that the status 'offline' was confirmed.
" statusRedeemedConfirmed: type: "boolean" description: "A flag to indicate that the status 'redeemed' was confirmed.
" statusNotFoundConfirmed: type: "boolean" description: "A flag to indicate that the status 'not found' was confirmed.
" emptiesTransaction: description: "A complete transaction holding the retrieved empties return\ \ transaction.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.CompleteTransaction" alternativeTaxInfos: description: "The alternative tax information for updating the tax group.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos" storeId: type: "string" description: "The retail store identifier.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RegisterEmptiesTransactionRequestRequest object for the retrieve\ \ empties transaction process.
" com.gk_software.pos.api.service.transaction.RegisterEmptiesTransactionResult: type: "object" required: - "additionalEntries" - "statusOkay" properties: primaryEntry: description: "The primary transaction result entry.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" additionalEntries: type: "array" description: "Additional result entries.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" filtered: type: "boolean" description: "Indicates whether the transaction result is filtered. A filtered\ \ transaction does not contain the details of a retail transaction object\ \ in order to optimize service communication.
" failure: description: "Reference to a failure entity in case a failure occurs during\ \ a service execution. This field can be used when a managed exception occurs\ \ and we still want to synchronize the resulting transaction instead of\ \ throwing an exception containing no information on transaction updates.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult" statusOkay: type: "boolean" description: "A flag to indicate whether the registration status is okay\ \ or not in a simple way.
" statusResult: type: "string" description: "The status result (in detail).
" enum: - "Success" - "Offline" - "NotFound" - "Cancelled" - "Voided" - "Redeemed" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RegisterEmptiesTransactionResultResult object for the retrieve\ \ empties transaction process.
" com.gk_software.pos.api.service.transaction.RegisterRetrievedSalesOrderRequest: type: "object" properties: externalCustomerOrderID: type: "string" description: "The externalCustomerOrderID
" itemPositions: type: "array" description: "The itemPositions List
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SalesOrderPosition" clearedDownpaymentPosition: type: "string" description: "The clearedDownpaymentPosition
" dcActionCode: type: "string" description: "The dcActionCode
" dcReceiptText: type: "string" description: "The dcReceiptText
" dcRegularUnitPrice: type: "number" format: "double" description: "The dcRegularUnitPrice
" dcQuantity: type: "integer" format: "int32" description: "The dcQuantity
" languageDifferent: type: "boolean" description: "The languageDifferent
" dcI18NText: type: "string" description: "The dcI18NText
" operationConfiguration: description: "The operationConfiguration
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" alternativeTaxInfos: description: "The alternative tax infos for updating the tax group.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RegisterRetrievedSalesOrderRequestThe entity RegisterRetrievedSalesOrderRequest
" com.gk_software.pos.api.service.transaction.RegisterScaleTransactionRequest: type: "object" required: - "returnMode" - "statusNotFoundConfirmed" - "statusOfflineConfirmed" - "statusRedeemedConfirmed" properties: positionOperationConfig: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" returnMode: type: "boolean" description: "A flag to indicate that return mode is active.
" collectiveNumber: type: "string" description: "The collective number. When single item resolving is not\ \ wanted or possible the item with collective number is used for scale transaction\ \ registration.
" transactionIdentifier: type: "string" description: "The transaction identifier for the scale transaction.
" amount: type: "number" format: "double" description: "The amount. In case of collective item usage the unit price\ \ amount for the line item registration.
" statusOfflineConfirmed: type: "boolean" description: "A flag to indicate that the status 'offline' was confirmed.
" statusRedeemedConfirmed: type: "boolean" description: "A flag to indicate that the status 'redeemed' was confirmed.
" statusNotFoundConfirmed: type: "boolean" description: "A flag to indicate that the status 'not found' was confirmed.
" scaleTransaction: description: "A complete transaction holding the retrieved scale transaction.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.CompleteTransaction" alternativeTaxInfos: description: "The alternative tax informations for updating the tax group.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos" suspendCodeTransaction: description: "A Transaction which was converted from a suspend code.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RegisterScaleTransactionRequestRequest object for the retrieve\ \ scale transaction process.
" com.gk_software.pos.api.service.transaction.RegisterScaleTransactionResult: type: "object" required: - "additionalEntries" - "statusOkay" properties: primaryEntry: description: "The primary transaction result entry.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" additionalEntries: type: "array" description: "Additional result entries.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" filtered: type: "boolean" description: "Indicates whether the transaction result is filtered. A filtered\ \ transaction does not contain the details of a retail transaction object\ \ in order to optimize service communication.
" failure: description: "Reference to a failure entity in case a failure occurs during\ \ a service execution. This field can be used when a managed exception occurs\ \ and we still want to synchronize the resulting transaction instead of\ \ throwing an exception containing no information on transaction updates.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult" statusOkay: type: "boolean" description: "A flag to indicate whether the registration status is okay\ \ or not in a simple way.
" statusResult: type: "string" description: "The status result (in detail).
" enum: - "Success" - "Offline" - "NotFound" - "Cancelled" - "Voided" - "Redeemed" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RegisterScaleTransactionResultResult object for the retrieve\ \ scale transaction process.
" com.gk_software.pos.api.service.transaction.RegistrationExternalRequest: type: "object" required: - "createReturnReceipt" - "emptiesReturnMode" - "returnMode" properties: operationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" returnMode: type: "boolean" description: "Indicated whether the item should be returned or registered.
" emptiesReturnMode: type: "boolean" description: "Flag indicating client is in empties return mode.
" createReturnReceipt: type: "boolean" description: "This parameter specifies whether a return receipt should\
\ be created for returned items.
\tThis has only an impact in case\
\ returnMode=true.
Manual line item creation with external data.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.ExternalLineItemData" salesPersonNumber: type: "string" description: "The seller id.
" sellerRelationMethod: type: "string" description: "The seller relation method.
" enum: - "CurrentLineItemOnly" - "CurrentAndFollowingLineItemsOfCurrentTransaction" - "CurrentAndFollowingLineItemsOfCurrentAndFollowingTransactions" - "AllLineItemsOfCurrentTransaction" - "FollowingLineItemsOfCurrentTransaction" - "FollowingLineItemsOfCurrentAndFollowingTransactions" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RegistrationExternalRequestDomain object for Registration External\ \ Request.
" com.gk_software.pos.api.service.transaction.RegistrationInternalRequest: type: "object" required: - "createReturnReceipt" - "emptiesReturnMode" - "returnMode" properties: operationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" returnMode: type: "boolean" description: "Indicated whether the item should be returned or registered.
" emptiesReturnMode: type: "boolean" description: "Flag indicating client is in empties return mode.
" createReturnReceipt: type: "boolean" description: "This parameter specifies whether a return receipt should\
\ be created for returned items.
\tThis has only an impact in case\
\ returnMode=true.
All the data needed to create a new internal Line Item.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.InternalLineItemData" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RegistrationInternalRequest TODO: undocumented" com.gk_software.pos.api.service.transaction.RegistrationRequest: type: "object" required: - "checkForVariants" - "closeLineItem" - "createReturnReceipt" - "doPriceDifferenceLimitCheck" - "emptiesReturnMode" - "getPromoIcons" - "layawayMode" - "linkedEmptiesItem" - "orderMode" - "postValidationSalesRestrictionIds" - "returnMode" - "returnReasonRequired" - "salesRestrictionsCheckNeeded" - "takeAwaySaleMode" - "takeOverSetItems" - "wicMode" properties: operationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" returnMode: type: "boolean" description: "Indicated whether the item should be returned or registered.
" emptiesReturnMode: type: "boolean" description: "Flag indicating client is in empties return mode.
" createReturnReceipt: type: "boolean" description: "This parameter specifies whether a return receipt should\
\ be created for returned items.
\tThis has only an impact in case\
\ returnMode=true.
The barcode of the item to register. At least the barcode\ \ OR the itemIdentificator are mandatory request attributes.
" itemIdentificator: description: "The item identificator. At least the barcode OR the itemIdentificator\ \ are mandatory request attributes.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.ItemIdentificator" wicMode: type: "boolean" description: "Wic mode flag.
" takeOverSetItems: type: "boolean" description: "Indicated whether set items should be registered individually\ \ or be added to head item.
" orderMode: type: "boolean" description: "The order mode.
" layawayMode: type: "boolean" description: "Indicates whether the layaway mode is active.
" takeAwaySaleMode: type: "boolean" description: "Indicates whether the take away sale mode is active.
" checkForVariants: type: "boolean" description: "Indicates if variant check should be performed.
" salesRestrictionsCheckNeeded: type: "boolean" description: "Indicates if validation process should check sales restrictions.
" returnReasonRequired: type: "boolean" description: "indicates if variant check should be performed.
" linkedEmptiesItem: type: "boolean" description: "Indicates the request is for a linked empties deposit item.
" closeLineItem: type: "boolean" description: "Indicates whether line item should be closed during the registration\ \ (used for empties return using deposit collections).
" getPromoIcons: type: "boolean" description: "Indicates whether promo icons should be retrieved.
" emptiesReturnQuantity: type: "integer" format: "int32" description: "Quantity to be overwritten for deposit item registered as\ \ empties during item registration.
" priceVariant: type: "string" description: "price variant to use.
" enum: - "Normal" - "Special" - "Actual" - "Group" overridingPrice: type: "number" format: "double" description: "The overriding price.
" overridingQuantity: description: "the overriding quantity.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.QuantityInput" overridingPositionAmount: type: "number" format: "double" description: "The overriding position amount.
" weightResult: description: "The weight result from a previously done weighing process\ \ (e.g. item required weight input).
" $ref: "#/definitions/com.gk_software.pos.api.service.client.hardware.scale.WeightResult" doPriceDifferenceLimitCheck: type: "boolean" description: "Indicates whether the price difference limit checks should\ \ be done or not.
" priceTypeCode: type: "string" description: "Price type code (for price change).
" setPriceMode: type: "string" description: "Set price mode (for price change).
" reasonCode: type: "string" description: "A reason code for this request (e.g. reason for returns).
" reasonCodeGroupCode: type: "string" description: "A reason code group code for this request (e.g. reason for\ \ returns).
" reasonDescription: type: "string" description: "A reason description for this request (e.g. reason for returns).
" reasonParameter: description: "A reason parameter used for handling of salable information.
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonParameterSO" priceChangeReasonCode: type: "string" description: "A price change reason code.
" priceChangeReasonCodeGroupCode: type: "string" description: "A price change reason code group code.
" priceChangeReasonDescription: type: "string" description: "A price change reason description.
" serialNumber: type: "string" description: "Serial number to set.
" itemTraceableUnitID: type: "string" description: "A universally unique identifier (min=0, max=32) used to identify\ \ an instance of a distinguishable instance of a retail item. The item traceable\ \ unit ID is similar to a serial number in that it allows each selling unit\ \ to be explicitly identified and distinguished from other selling units\ \ of the same Item.
" receiptText: type: "string" description: "Receipt text to set.
" linkedItemRegistrationRequest: description: "Object for linked item information.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.LinkedItemRegistrationRequest" externalItemRegistrationRequest: description: "A request to register an external item to transaction.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.ExternalItemRegistrationRequest" factor: type: "number" format: "double" description: "Double.
" activeCustomerOrderId: type: "string" description: "The active customer order id.
" customerSequenceNumber: type: "integer" format: "int32" description: "The customer oder sequence number.
\t@deprecated use\
\ customerOrderSequenceNumber instead.
The customer order sequence number.
" salesOrderTypeCode: type: "string" description: "The sales order type code.
" salesOrderDeliveryTypeCode: type: "string" description: "The sales order delivery type code.
" requestedDeliveryDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The requested delivery date for the item.
Date format\ \ 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" itemEntryConfig: description: "ItemEntryConfig - bring config to server side.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.ItemEntryConfig" salesPersonNumberRequest: description: "Request for Sales Person Number.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SalesPersonNumberRequest" alternativeTaxInfos: description: "The alternative tax infos for updating the tax group.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos" entryMethodCode: type: "string" description: "The entry method code. It specifies how the action was triggered\ \ (keyed, scanned, ...).
" scaleTransactionParams: description: "Scale transaction parameters to add to transaction.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.ScaleTransactionParams" keyedOnline: type: "boolean" description: "The keyed online state.
" postValidationSalesRestrictionIds: type: "array" description: "The list of post validation sales restriction ids to add\ \ to SaleReturnLineItem.
" items: type: "string" promotionTriggerActive: type: "boolean" description: "The promotion trigger active state.
" lineItemItemType: type: "string" description: "The qualified line item type.
" retailPriceModifierList: type: "array" description: "The list of external retail price modifier to add to transaction.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.ExternalRetailPriceModifier" lineItemExtensionList: type: "array" description: "The list of external retail price modifier to add to transaction.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.LineItemExtension" printAdditionalLineItemTextLineList: type: "array" description: "The print list for additional line item text to print.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.PrintAdditionalLineItemTextLine" scaleMode: type: "string" description: "The current active scale mode.
" enum: - "SelfService" - "Prepackaging" - "Service" scaleSellingMode: type: "string" enum: - "Standard" - "Fast" courseNumber: type: "string" description: "The course Number to be set on line item
" itemProvider: type: "string" description: "The parameter defines the provider for the item data.
" enum: - "Local" - "Remote" comboMealRegistrationRequest: description: "The parameter consists all information for a combo meal item\ \ registration
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.ComboMealRegistrationRequest" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RegistrationRequestDomain object for Registration Request.
" com.gk_software.pos.api.service.transaction.RegistrationResult: type: "object" required: - "accumulateExistingQuantity" - "additionalEntries" - "comboMealItem" - "emptiesReturn" - "forcePriceInput" - "forceQuantityInput" - "forceReturnReasonInput" - "forceSerialNumberInput" - "hasInvalidQuantity" - "hasLinkedItems" - "prepaidItem" - "price" - "priceInputSignal" - "promotionTriggerSignal" - "promotionTriggerSignalType" - "quantityInputSignal" - "statusOk" - "variantItemsAvailable" properties: primaryEntry: description: "The primary transaction result entry.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" additionalEntries: type: "array" description: "Additional result entries.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" filtered: type: "boolean" description: "Indicates whether the transaction result is filtered. A filtered\ \ transaction does not contain the details of a retail transaction object\ \ in order to optimize service communication.
" failure: description: "Reference to a failure entity in case a failure occurs during\ \ a service execution. This field can be used when a managed exception occurs\ \ and we still want to synchronize the resulting transaction instead of\ \ throwing an exception containing no information on transaction updates.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult" statusOk: type: "boolean" description: "indicates if the registration could be proceeded without\ \ error or callback
" mainPOSItemId: type: "string" description: "the unique id of this item
" itemName: type: "string" description: "the item name
" itemTare: type: "number" format: "double" description: "a tare value for this item
" forcePriceInput: type: "boolean" description: "The manually entered price
" forceQuantityInput: type: "boolean" description: "The manually entered quantity
" priceInputSignal: type: "boolean" description: "The price input signal
" quantityInputSignal: type: "boolean" description: "The quantity input signal
" promotionTriggerSignal: type: "boolean" description: "The promotion trigger signal
" promotionTriggerSignalType: type: "string" description: "The promotion trigger signal type
" enum: - "OK" - "FORBIDDEN" - "AUTHORIZATION" - "WARNING" - "HIGHER_PRICE_FORBIDDEN" - "LOWER_PRICE_FORBIDDEN" - "ZERO_PRICE_FORBIDDEN" - "PRICE_CHANGE_FORBIDDEN" - "LINE_ITEM_NOT_REBATABLE" - "PROMOTION_TRIGGER_NOT_APPLIED" salesRestrictions: type: "array" description: "list of sales restrictions
" items: type: "string" salesRestrictionList: type: "array" description: "The sales restriction list
" items: $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.sales_restriction.dto.so.SalesRestrictionSO" prepaidItem: type: "boolean" description: "not used atm
" hasLinkedItems: type: "boolean" description: "not used atm
" reasonResult: description: "reason objects for selection
" $ref: "#/definitions/com.gk_software.pos.api.service.masterdata.ReasonResult" forceReturnReasonInput: type: "boolean" description: "ask for return reason
" forceSerialNumberInput: type: "boolean" description: "ask for serial number
" variantItemsAvailable: type: "boolean" description: "indicates if there exist variants and one must be selected
" emptiesReturn: type: "boolean" description: "The empties return object
" accumulateExistingQuantity: type: "boolean" description: "The accumulate existing quantity
" price: type: "number" format: "double" description: "if price could be calculated it is stored in here
" quantityInputMethod: type: "string" description: "quantity input method of this item
" preregisteredQuantity: type: "integer" format: "int32" description: "quantity registered before item registration
" itemKey: description: "key of the item about to be registered
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.PosUOMItemDoKey" usedBarcode: type: "string" description: "String - he barcode originally used to register the item
" limitExceedResult: description: "The limit exceed result
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.LimitExceedResult" discountIconList: type: "array" description: "A list of discount item icon info
" items: $ref: "#/definitions/com.gk_software.pos.flow.libs.transaction.DiscountIconList" prepaidType: description: "The limit exceed action for price difference checks
" $ref: "#/definitions/com.gk_software.pos.api.model.config.component.server.prepaid_type.PrepaidType" hasInvalidQuantity: type: "boolean" description: "The has invalid quantity flag
" packagePriceQuantity: type: "integer" format: "int32" description: "The quantity for which the unit price is applied to.
" comboMealItem: type: "boolean" description: "The register combo meal flag
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RegistrationResultThe entity RegistrationResult
" com.gk_software.pos.api.service.transaction.RegistrationServiceFeeRequest: type: "object" required: - "operationConfiguration" - "preCommissioningRoundMethod" - "preCommissioningThresholdList" - "preCommissioningTypeCode" - "preCommissioningValue" properties: operationConfiguration: description: "This config defines a PositionOperationConfig for registering\ \ of Service Fee Line Item.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" preCommissioningThresholdList: type: "array" description: "This parameter defines a list of thresholds for pre-commissioning.
" items: type: "string" preCommissioningValue: type: "array" description: "This parameter defines a list of absolute values (PreCommissioningTypeCode\ \ = 'PS') or percentage rates (PreCommissioningTypeCode = 'TP').
" items: type: "string" preCommissioningTypeCode: type: "string" description: "This parameter defines whether a percentage of the total\ \ or an absolute value is set as price for the service item.
values:\ \ PS, TP
This parameter defines the rounding rule in case of PreCommissioningTypeCode\ \ = 'TP'.
values: NO_ROUNDING, ROUND_HALF_UP, ROUND_DOWN,\ \ ROUND_UP, ROUND_HALF_DOWN
This parameter defines the TaxGroupID for the service item,\ \ if needed.
" receiptText: type: "string" description: "This parameter defines the receipt text.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RegistrationServiceFeeRequestThe entity RegistrationServiceFeeRequest
" com.gk_software.pos.api.service.transaction.RemoveLineItemExtensionRequest: type: "object" properties: lineItemKey: description: "The line item key from which the extensions will be removed.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" extensionKey: type: "string" description: "The extension key used for the extension line items lookup.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RemoveLineItemExtensionRequestDomain object for removing batch\ \ of line item extensions from one line item.
" com.gk_software.pos.api.service.transaction.RemoveLineItemsExtensionsRequest: type: "object" properties: removeExtensionRequests: type: "array" description: "The list of requests for removing extensions from one or\ \ more single line items.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.RemoveLineItemExtensionRequest" operationConfiguration: description: "The operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RemoveLineItemsExtensionsRequestDomain object for removing batch\ \ of line item extensions from one or more line items.
" com.gk_software.pos.api.service.transaction.RemoveSaleReturnLineItemExtensionsRequest: type: "object" required: - "extensionKeys" - "storeTransaction" properties: extensionKeys: type: "array" description: "Extension keys of sale return line item extensions.
" items: type: "string" storeTransaction: type: "boolean" description: "Indicates whether transaction should be persisted after modifications.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RemoveSaleReturnLineItemExtensionsRequestRequest for removing\ \ sale return line item extensions from sale return line items.
" com.gk_software.pos.api.service.transaction.RemoveTransactionAdditionalPrintoutsRequest: type: "object" properties: transactionId: type: "string" transactionAdditionalPrintoutKeys: type: "array" description: "A list of transaction additional printout keys to be removed\ \ from transaction.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.TransactionAdditionalPrintoutKey" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RemoveTransactionAdditionalPrintoutsRequestRequest object to\ \ remove additional printout contents from a transaction.
" com.gk_software.pos.api.service.transaction.RemoveTransactionExtensionRequest: type: "object" properties: extensionKey: type: "string" description: "The transaction extension key to be removed to transaction.
" transactionId: type: "string" description: "The identifier of the transaction to remove the extension\ \ key from.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RemoveTransactionExtensionRequestRequest object for removing\ \ a transaction extension from the transaction.
" com.gk_software.pos.api.service.transaction.RepeatLineItemRequest: type: "object" required: - "accumulateQuantity" properties: lineItem: description: "The lineItem
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem" mainlineItem: description: "The mainlineItem
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem" positionOperationConfiguration: description: "The positionOperationConfiguration
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" positionRepetitionConfig: description: "The positionRepetitionConfig
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionRepetitionConfig" accumulateQuantity: type: "boolean" description: "Indicates whether the line item quantity should be accumulated.
" quantity: description: "The quantity
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.QuantityInput" lineItemKey: description: "The line item key.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem" keyedOnline: type: "boolean" description: "The keyed on line state.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RepeatLineItemRequestDomain object for RepeatLineItem Request
" com.gk_software.pos.api.service.transaction.RetailTransactionLineItemAdditionalParameter: type: "object" properties: externalParameterID: type: "string" description: "The external Parameter ID
" parameterName: type: "string" description: "The parameter Name
" ParameterValue: type: "string" description: "The parameter value.
" description: "RetailTransactionLineItemAdditionalParameterThe retail transaction\ \ line item additional parameter
" com.gk_software.pos.api.service.transaction.RetailTransactionLineItemI18NText: type: "object" required: - "createReturnReceipt" - "emptiesReturnMode" - "returnMode" properties: operationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" returnMode: type: "boolean" description: "Indicated whether the item should be returned or registered.
" emptiesReturnMode: type: "boolean" description: "Flag indicating client is in empties return mode.
" createReturnReceipt: type: "boolean" description: "This parameter specifies whether a return receipt should\
\ be created for returned items.
\tThis has only an impact in case\
\ returnMode=true.
The text sequence number
" languageID: type: "string" description: "The language ID
" category: type: "string" description: "The category
" text: type: "string" description: "The text
" pictureFlag: type: "boolean" description: "The picture flag
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RetailTransactionLineItemI18NTextThe retail transaction lineItem\ \ I18N text
" com.gk_software.pos.api.service.transaction.RetrieveOpenSSCTransactionRequest: type: "object" properties: storeId: type: "string" description: "The retail store identifier (as part of the search criteria).
" workstationId: type: "string" description: "The workstation identifier (as part of the search criteria).
" customerId: type: "string" description: "The customer identifier (as part of the search criteria).
" customerCardType: type: "string" description: "The customer card type (as part of the search criteria).
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RetrieveOpenSSCTransactionRequestRequest object to retrieve\ \ open transactions with workstation type code for self scanning.
" com.gk_software.pos.api.service.transaction.RetrieveSuspendedRetailTransactionsByIdsRequest: type: "object" properties: transactionIds: type: "array" description: "A list of transaction identifiers.
" items: type: "string" onlySSCTransactions: type: "boolean" description: "A flag to indicate that only suspended transaction with workstation\ \ type code for self scanning are wanted.
" overtakeCustomerFromOriginalReceipt: type: "boolean" description: "A flag to indicate that the customer assignment from the\ \ suspended transaction should be taken over to the current transaction.
" alternativeTaxInfos: description: "The alternative tax informations for updating the tax group.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos" allowOtherStores: type: "boolean" description: "A flag to indicate whether transactions from other stores\ \ are allowed.
" promotionHandling: type: "string" description: "The promotion handling. If set to 'OLDDISCOUNTS' the retail\ \ price modifier for the retrieved item gets the flag externalSystemOriginatorFlag\ \ set to true.
" consolidateLineItemsRetrieve: type: "boolean" description: "The parameter defines, if the consolidation of retrieving\ \ transactions should be executed.
" consolidateReturnItems: type: "boolean" description: "The parameter controls, whether items with SaleReturnLineItem.ActionCode\ \ = RI should be consolidated or not.
" rescanEnabled: type: "boolean" description: "The parameter defines, if rescan feature is enabled.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RetrieveSuspendedRetailTransactionsByIdsRequestRequest object\ \ for retrieving suspended retail transactions
" com.gk_software.pos.api.service.transaction.RetrieveTransactionFromSuspendCodeRequest: type: "object" properties: transactionFromConvertedSuspendCodes: description: "Transaction created with information from code.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" alternativeTaxInfos: description: "The alternative tax informations for updating the tax group.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos" consolidateLineItemsRetrieve: type: "boolean" description: "The parameter defines, if the consolidation of retrieving\ \ transactions should be executed.
" consolidateReturnItems: type: "boolean" description: "The parameter controls, whether items with SaleReturnLineItem.ActionCode\ \ = RI should be consolidated or not.
" rescanEnabled: type: "boolean" description: "The parameter defines, if rescan feature is enabled.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "RetrieveTransactionFromSuspendCodeRequestRequest object to suspend\ \ transaction converted from suspend codes.
" com.gk_software.pos.api.service.transaction.ReturnLineItemBulkRequest: type: "object" required: - "createReturnReceipt" properties: returnWithTransactionConfig: description: "The return with transaction configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.ReturnWithTransactionConfig" refundTransactionID: type: "string" description: "The identifier for the refund transaction.
" reasonGroupCode: type: "string" description: "The reason group code.
" salesPersonNumber: type: "string" returnLineItemElementList: type: "array" description: "A list of return line items that should be returned.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.ReturnLineItemElement" createReturnReceipt: type: "boolean" description: "It specifies whether a return receipt is created. This receipt\ \ includes return line items only.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ReturnLineItemBulkRequestRequest object for the the return line\ \ item operation.
" com.gk_software.pos.api.service.transaction.ReturnLineItemElement: type: "object" required: - "units" properties: lineItemKey: description: "The line item key.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" quantity: type: "integer" format: "int32" description: "The line item quantity.
" units: type: "number" format: "double" description: "The line item units.
" reasonCode: type: "string" description: "The reason code.
" entryMethodCode: type: "string" description: "The entry method code of the return action.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ReturnLineItemElementList element type for ReturnLineItemBulkRequest
" com.gk_software.pos.api.service.transaction.ReturnLineItemRequest: type: "object" required: - "quantity" - "units" properties: returnWithTransactionConfig: description: "The operation configuration
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.ReturnWithTransactionConfig" lineItemKeyToReturn: description: "Id of the line item to return
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" taxLineItemKey: description: "The SaleReturnTaxLineItem Key
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.SaleReturnTaxLineItemKey" lineItem: description: "Line item to be filled
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem" taxPercent: type: "number" format: "double" description: "The tax percent
" taxAmount: type: "number" format: "double" description: "The tax amount
" reason: description: "The tax reason
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO" quantity: type: "integer" format: "int32" description: "Quantity to return.
" units: type: "number" format: "double" description: "Units to return.
" reasonCode: type: "string" description: "The reason code
" reasonGroupCode: type: "string" description: "The reason group Code
" extensionKey: type: "string" description: "The extension key
" extensionValue: type: "string" description: "The extension value
" customerIdentifier: type: "string" description: "The customerIdentifier
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ReturnLineItemRequestRequest object for the the return line\ \ item operation.
" com.gk_software.pos.api.service.transaction.ReturnTransactionRequest: type: "object" required: - "createReturnReceipt" properties: returnWithTransactionConfig: description: "The return with transaction configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.ReturnWithTransactionConfig" transactionToReturn: type: "string" description: "The identifier for the transaction to return.
" reasonCode: type: "string" description: "The reason code.
" reasonGroupCode: type: "string" description: "The reason group code.
" salesPersonNumber: type: "string" createReturnReceipt: type: "boolean" description: "It specifies whether a return receipt is created. This receipt\ \ includes return line items only.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ReturnTransactionRequestRequest object for the the return transaction\ \ operation.
" com.gk_software.pos.api.service.transaction.ReturnTransactionWithTempSessionRequest: type: "object" properties: operatorId: type: "string" storeId: type: "string" workstationId: type: "string" workstationTypeCode: type: "string" clientVersion: type: "string" trainingMode: type: "boolean" createReturnReceipt: type: "boolean" salesPersonNumber: type: "string" transactionID: type: "string" takeOverCustomersFromOriginalSc: type: "boolean" returnPrepaidAllowed: type: "boolean" reasonCode: type: "string" reasonGroupCode: type: "string" conditionSplitConfig: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.ConditionSplitConfig" returnLineItemElementList: type: "array" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.ReturnLineItemElement" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ReturnTransactionWithTempSessionRequest TODO: undocumented" com.gk_software.pos.api.service.transaction.ReturnableForRestrictionTypeCodesRequest: type: "object" properties: transactionToReturnId: type: "string" description: "The identifier of the return transaction to interrogate.
" restrictionTypeCodes: type: "array" description: "The restriction types codes of the tenders used in the original\ \ transaction.
" items: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ReturnableForRestrictionTypeCodesRequestRequest object used\ \ to determine whether the transaction is returnable, given a set of restriction\ \ type codes.
" com.gk_software.pos.api.service.transaction.SaleReturnLineItemCharacteristic: type: "object" required: - "createReturnReceipt" - "emptiesReturnMode" - "returnMode" properties: operationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" returnMode: type: "boolean" description: "Indicated whether the item should be returned or registered.
" emptiesReturnMode: type: "boolean" description: "Flag indicating client is in empties return mode.
" createReturnReceipt: type: "boolean" description: "This parameter specifies whether a return receipt should\
\ be created for returned items.
\tThis has only an impact in case\
\ returnMode=true.
The characteristic ID
" characteristicValueID: type: "string" description: "The characteristic value ID
" characteristicValueName: type: "string" description: "The characteristic value name
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SaleReturnLineItemCharacteristicThe sale return line item characteristic
" com.gk_software.pos.api.service.transaction.SaleReturnLineItemDataRequest: type: "object" properties: itemType: type: "string" description: "The itemType.
" subItemType: type: "string" description: "The subItemType
" actionCode: type: "string" description: "The actionCode
" units: type: "number" format: "double" description: "The units
" quantity: type: "integer" format: "int32" description: "The quantity
" quantityInputMethod: type: "string" description: "The quantityInputMethod
" itemId: type: "string" description: "The itemId
" mainPOSItemId: type: "string" description: "The mainPOSItemId
" posItemId: type: "string" description: "The posItemId
" registrationNumber: type: "string" description: "The registrationNumber
" mainMerchandiseHierarchyGroupId: type: "string" description: "The mainMerchandiseHierarchyGroupId
" mainMerchandiseHierarchyGroupIdQualifier: type: "string" description: "The mainMerchandiseHierarchyGroupIdQualifier
" merchandiseHierarchyGroupName: type: "string" description: "The merchandiseHierarchyGroupName
" merchandiseHierarchyGroupDescription: type: "string" description: "The merchandiseHierarchyGroupDescription
" receiptText: type: "string" description: "The receiptText
" receiptDescription: type: "string" description: "The receiptDescription
" regularUnitPrice: type: "number" format: "double" description: "The regularUnitPrice
" actualUnitPrice: type: "number" format: "double" description: "The actualUnitPrice
" priceTypeCode: type: "string" description: "The priceTypeCode
" taxGroupID: type: "string" description: "The taxGroupID
" discountFlag: type: "boolean" description: "The discountFlag
" frequentShopperPointsEligibilityFlag: type: "boolean" description: "The frequentShopperPointsEligibilityFlag
" discountTypeCode: type: "string" description: "The discountTypeCode
" invoiceId: type: "string" description: "The invoiceId
" priceModifierList: type: "array" description: "The price modifier list.
" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailPriceModifier" promotion: description: "The promotion.
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.promotion.dto.so.PromotionSO" alternativeTaxInfos: description: "The alternative tax infos for updating the tax group.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos" priceChangeTypeCode: type: "string" description: "The price change type code
" prohibitReturnFlag: type: "boolean" description: "The prohibit return flag
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SaleReturnLineItemDataRequestRequest object for the item registration\ \ process.
" com.gk_software.pos.api.service.transaction.SaleReturnLineItemMerchandiseHierarchyGroup: type: "object" required: - "createReturnReceipt" - "emptiesReturnMode" - "returnMode" properties: operationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" returnMode: type: "boolean" description: "Indicated whether the item should be returned or registered.
" emptiesReturnMode: type: "boolean" description: "Flag indicating client is in empties return mode.
" createReturnReceipt: type: "boolean" description: "This parameter specifies whether a return receipt should\
\ be created for returned items.
\tThis has only an impact in case\
\ returnMode=true.
The merchandise hierarchy group ID qualifier
" MerchandiseHierarchyGroupID: type: "string" description: "The merchandise hierarchy group ID
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SaleReturnLineItemMerchandiseHierarchyGroupThe sale return line\ \ item merchandise hierarchy group
" com.gk_software.pos.api.service.transaction.SaleReturnLineItemSalesOrder: type: "object" required: - "createReturnReceipt" - "emptiesReturnMode" - "returnMode" properties: operationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" returnMode: type: "boolean" description: "Indicated whether the item should be returned or registered.
" emptiesReturnMode: type: "boolean" description: "Flag indicating client is in empties return mode.
" createReturnReceipt: type: "boolean" description: "This parameter specifies whether a return receipt should\
\ be created for returned items.
\tThis has only an impact in case\
\ returnMode=true.
The external customer order ID
" customerOrderSequenceNumber: type: "integer" format: "int32" description: "The customer order sequence number
" salesOrderTypeCode: type: "string" description: "The sales order type code
" salesOrderDeliveryTypeCode: type: "string" description: "The sales order delivery type code
" requestedDeliveryDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The requested delivery date
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SaleReturnLineItemSalesOrderThe sale return line item sales\ \ order.
" com.gk_software.pos.api.service.transaction.SalesOrderCommonData: type: "object" required: - "SAP_DUMMY_ORDER_ID" - "totalGross" - "totalNet" - "totalTax" properties: resultCode: type: "string" description: "The result code for a ERP service call. If the result code\ \ is equal to 5, the call was not successful.
" priceComponentList: type: "array" description: "The customer order condition data.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SalesOrderExtendedPriceComponent" totalGross: type: "number" format: "double" description: "The order amount (gross).
" totalNet: type: "number" format: "double" description: "The order amount (net).
" totalTax: type: "number" format: "double" description: "The total tax amount.
" itemList: type: "array" description: "The order line items.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SalesOrderExtendedItemData" SAP_DUMMY_ORDER_ID: type: "string" description: "Dummy identifier for actual SAP sales order.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrderCommonDataEntity describing common sales order data.
" com.gk_software.pos.api.service.transaction.SalesOrderCommonPriceComponent: type: "object" required: - "conditionBase" - "conditionRate" properties: conditionTypeCode: type: "string" description: "conditionTypeCode
" conditionRate: type: "number" format: "double" description: "conditionRate
" conditionBase: type: "number" format: "double" description: "conditionBase
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrderCommonPriceComponentThe entity SalesOrderCommonPriceComponent
" com.gk_software.pos.api.service.transaction.SalesOrderCommonScheduleLine: type: "object" required: - "confirmedQuantity" - "requestedQuantity" properties: deliveryDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The deliveryDate
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" requestedQuantity: type: "number" format: "double" description: "The requestedQuantity
" confirmedQuantity: type: "number" format: "double" description: "The confirmedQuantity
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrderCommonScheduleLineThe entity SalesOrderCommonScheduleLine
" com.gk_software.pos.api.service.transaction.SalesOrderExtendedItemData: type: "object" required: - "confirmedQuantity" - "deliveredQuantity" - "netAmount" - "netPrice" - "requestedQuantity" - "taxAmount" properties: id: type: "string" description: "The id
" description: type: "string" description: "The description
" productInternalId: type: "string" description: "The productInternalId
" productSalesMeasureUnitCode: type: "string" description: "The productSalesMeasureUnitCode
" requestDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The requestDate
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" deliveryTermsDeliveryPlantId: type: "string" description: "The deliveryTermsDeliveryPlantId
" requestedQuantity: type: "number" format: "double" description: "The requestedQuantity
" receivingPointId: type: "string" description: "The receivingPointId
" productStandardId: type: "string" description: "The productStandardId
" itemPriceComponentList: type: "array" description: "The itemPriceComponentList
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SalesOrderExtendedPriceComponent" confirmedQuantity: type: "number" format: "double" description: "The confirmedQuantity
" deliveredQuantity: type: "number" format: "double" description: "The deliveredQuantity
" rejectionReasonCode: type: "string" description: "The rejectionReasonCode
" netAmount: type: "number" format: "double" description: "The netAmount
" netPrice: type: "number" format: "double" description: "The netPrice
" taxAmount: type: "number" format: "double" description: "The taxAmount
" scheduleLineList: type: "array" description: "The scheduleLineList
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SalesOrderCommonScheduleLine" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrderExtendedItemDataThe entity SalesOrderExtendedItemData
" com.gk_software.pos.api.service.transaction.SalesOrderExtendedPriceComponent: type: "object" required: - "conditionActive" - "conditionBase" - "conditionRate" - "total" properties: conditionTypeCode: type: "string" description: "conditionTypeCode
" conditionRate: type: "number" format: "double" description: "conditionRate
" conditionBase: type: "number" format: "double" description: "conditionBase
" total: type: "number" format: "double" description: "The total
" conditionActive: type: "boolean" description: "The condition active
" inactivityReasonCode: type: "string" description: "The inactivity reasonCode
" priceSpecificationElementTypeCode: type: "string" description: "The priceSpecificationElement typeCode
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrderExtendedPriceComponentThe entity SalesOrderExtendedPriceComponent
" com.gk_software.pos.api.service.transaction.SalesOrderPosition: type: "object" properties: canceledValue: type: "number" format: "double" description: "The canceled value
" deliveryTypeCode: type: "string" description: "The delivery type code
" quantity: type: "integer" format: "int32" description: "The quantity
" units: type: "number" format: "double" description: "The units
" regularPrice: type: "number" format: "double" description: "The regularPrice
" receiptText: type: "string" description: "The receiptText
" posItemId: type: "string" description: "The posItemId
" itemTypeCode: type: "string" description: "The itemTypeCode
" subItemTypeCode: type: "string" description: "The sub item type code
" customerOrderSequenceNumber: type: "integer" format: "int32" description: "The customerOrderSequenceNumber
" deliveryDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The deliveryDate
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" orderId: type: "string" description: "The orderId
" discountGP: type: "number" format: "double" description: "The discountGP
" sapDebatesPromotionId: type: "string" description: "The sapDebatesPromotionId
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrderPositionThe entity SalesOrderPosition
" com.gk_software.pos.api.service.transaction.SalesOrderSalesDocItem: type: "object" properties: grossValue: type: "number" format: "double" description: "GrossValue of the item
" description: type: "string" description: "description of the item
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesOrderSalesDocItemThe SalesOrderSalesDocItem
" com.gk_software.pos.api.service.transaction.SalesPersonNumberRequest: type: "object" required: - "createReturnReceipt" - "emptiesReturnMode" - "returnMode" properties: operationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" returnMode: type: "boolean" description: "Indicated whether the item should be returned or registered.
" emptiesReturnMode: type: "boolean" description: "Flag indicating client is in empties return mode.
" createReturnReceipt: type: "boolean" description: "This parameter specifies whether a return receipt should\
\ be created for returned items.
\tThis has only an impact in case\
\ returnMode=true.
set sales Person Number (for Entered salesperson number).
" sellerRelationMethod: type: "string" description: "The Seller Relation Method.
" enum: - "CurrentLineItemOnly" - "CurrentAndFollowingLineItemsOfCurrentTransaction" - "CurrentAndFollowingLineItemsOfCurrentAndFollowingTransactions" - "AllLineItemsOfCurrentTransaction" - "FollowingLineItemsOfCurrentTransaction" - "FollowingLineItemsOfCurrentAndFollowingTransactions" sellerAssignmentNeeded: type: "boolean" description: "Defines whether the input of a sellerId is needed.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SalesPersonNumberRequestDomain object for SalesPersonNumberRequest
" com.gk_software.pos.api.service.transaction.ScaleTransactionParams: type: "object" required: - "offlineMode" properties: offlineMode: type: "boolean" description: "A flag to indicate whether offline mode registration is active\ \ or not.
" collectiveNumber: type: "string" description: "The collective number. When single item resolving is not\ \ wanted or possible the item with collective number is used for scale transaction\ \ registration.
" transactionIdentifier: type: "string" description: "The transaction identifier for the scale transaction.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "ScaleTransactionParamsWrapper object used for offline scale\ \ transaction registration.
" com.gk_software.pos.api.service.transaction.SearchAndRetrieveSuspendedRetailTransactionsRequest: type: "object" properties: businessUnitId: type: "string" description: "The business unit identifier.
" suspendNumber: type: "string" description: "The suspend number.
" parentCustomerIds: type: "array" description: "A list of parent customer identifiers.
" items: type: "string" customerIds: type: "array" description: "A list of customer identifiers.
" items: type: "string" customerRequired: type: "boolean" description: "A flag to indicate if a customer assignment is required.\ \ If the list of customer identifiers is not used but this flag is set to\ \ true, then the customer assignment of the current active transaction is\ \ used (if there is one).
" onlySSCTransactions: type: "boolean" description: "A flag to indicate that only suspended transaction with workstation\ \ type code for self scanning are wanted.
" overtakeCustomerFromOriginalReceipt: type: "boolean" description: "A flag to indicate that the customer assignment from the\ \ suspended transaction should be taken over to the current transaction.
" endDateTimestampFrom: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The end date timestamp from. If set only suspended transactions\ \ with matching criteria are searched.
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" customerAddressTypeCode: type: "string" description: "A card type which has to be used for the customer identification.
" alternativeTaxInfos: description: "The alternative tax informations for updating the tax group.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos" allowOtherStores: type: "boolean" description: "A flag to indicate whether transactions from other stores\ \ are allowed.
" promotionHandling: type: "string" description: "The promotion handling. If set to 'OLDDISCOUNTS' the retail\ \ price modifier for the retrieved item gets the flag externalSystemOriginatorFlag\ \ set to true.
" consolidateLineItemsRetrieve: type: "boolean" description: "The parameter defines, if the consolidation of retrieving\ \ transactions should be executed.
" consolidateReturnItems: type: "boolean" description: "The parameter controls, whether items with SaleReturnLineItem.ActionCode\ \ = RI should be consolidated or not.
" rescanEnabled: type: "boolean" description: "The parameter defines, if rescan feature is enabled.
" iSOCurrencyCode: type: "string" description: "The ISO currency code. If set only suspended transactions\ \ with matching criteria are searched.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SearchAndRetrieveSuspendedRetailTransactionsRequestRequest object\ \ for searching and retrieving suspended retail transactions.
" com.gk_software.pos.api.service.transaction.SearchCustomerTransactionsRequest: type: "object" properties: customerIds: type: "array" description: "A list of customer identifiers.
" items: type: "string" beginDateTimestampGreaterOrEquals: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The begin date timestamp greater or equals (as part of the\ \ search criteria).
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" workstationTypeCode: type: "string" description: "The workstation type code.
" maxReceiptCount: type: "integer" format: "int32" description: "The maximum count of receipts. The search result will be\ \ limited to that number.
" suspendedFlag: type: "boolean" description: "The suspended flag. If set to true only transactions with\ \ isSuspended flag true and isRetrieved flag false are searched.
" iSOCurrencyCode: type: "string" description: "The ISO currency code. If set only suspended transactions\ \ with matching criteria are searched.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SearchCustomerTransactionsRequestRequest object for the search\ \ customer transactions operation.
" com.gk_software.pos.api.service.transaction.SearchFiscalStartTransactionRequest: type: "object" properties: businessUnitId: type: "string" description: "The business unit identifier.
" fiscalPrinterId: type: "string" description: "The identifier for the fiscal printer.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SearchFiscalStartTransactionRequestRequest object to search\ \ fiscal start transaction.
" com.gk_software.pos.api.service.transaction.SearchLastFinalizedRetailTransactionRequest: type: "object" properties: businessUnitId: type: "string" description: "The business unit identifier.
" workstationId: type: "string" description: "The workstation identifier.
" operatorId: type: "string" description: "The operator identifier.
" localSearchOnly: type: "boolean" description: "If the search should be done only in the local database.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SearchLastFinalizedRetailTransactionRequestRequest object for\ \ the the search last finalized retail transaction operation.
" com.gk_software.pos.api.service.transaction.SearchLastUnfinishedRetailTransactionRequest: type: "object" properties: businessUnitId: type: "string" description: "The business unit identifier.
" workstationId: type: "string" description: "The workstation identifier.
" operatorId: type: "string" description: "The operator identifier.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SearchLastUnfinishedRetailTransactionRequestRequest object for\ \ the the search last unfinished retail transaction operation.
" com.gk_software.pos.api.service.transaction.SearchRetailTransactionRequest: type: "object" properties: businessUnitId: type: "string" description: "The business unit identifier.
" workstationId: type: "string" description: "The workstation identifier.
" endWorkstationId: type: "string" description: "The end workstation identifier.
" businessDayDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The business day date.
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" sequenceNumber: type: "string" description: "The sequence number.
" operatorId: type: "string" description: "The operator identifier.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SearchRetailTransactionRequestRequest object for the the search\ \ retail transaction operation.
" com.gk_software.pos.api.service.transaction.SearchSuspendedTransactionsRequest: type: "object" properties: businessUnitId: type: "string" description: "The business unit identifier.
" suspendNumber: type: "string" description: "The suspend number.
" parentCustomerIds: type: "array" description: "A list of parent customer identifiers.
" items: type: "string" customerIds: type: "array" description: "A list of customer identifiers.
" items: type: "string" customerRequired: type: "boolean" description: "A flag to indicate if a customer assignment is required.\ \ If the list of customer identifiers is not used but this flag is set to\ \ true, then the customer assignment of the current active transaction is\ \ used (if there is one).
" onlySSCTransactions: type: "boolean" description: "A flag to indicate that only suspended transaction with workstation\ \ type code for self scanning are wanted.
" overtakeCustomerFromOriginalReceipt: type: "boolean" description: "A flag to indicate that the customer assignment from the\ \ suspended transaction should be taken over to the current transaction.
" endDateTimestampFrom: type: "string" example: "'2018-05-16T16:09:24.394'" description: "The end date timestamp from. If set only suspended transactions\ \ with matching criteria are searched.
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" customerAddressTypeCode: type: "string" description: "A card type which has to be used for the customer identification.
" iSOCurrencyCode: type: "string" description: "The ISO currency code. If set only suspended transactions\ \ with matching criteria are searched.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SearchSuspendedTransactionsRequestRequest object for the search\ \ suspended transactions operation.
" com.gk_software.pos.api.service.transaction.SerializedUnitModifer: type: "object" required: - "createReturnReceipt" - "emptiesReturnMode" - "returnMode" properties: operationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" returnMode: type: "boolean" description: "Indicated whether the item should be returned or registered.
" emptiesReturnMode: type: "boolean" description: "Flag indicating client is in empties return mode.
" createReturnReceipt: type: "boolean" description: "This parameter specifies whether a return receipt should\
\ be created for returned items.
\tThis has only an impact in case\
\ returnMode=true.
The serial number
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SerializedUnitModiferThe serialized unit modifer
" com.gk_software.pos.api.service.transaction.SetFiscalReceiptNumberRequest: type: "object" properties: fiscalReceiptNumber: type: "string" description: "The fiscalization receipt number to set.
" positionOperationConfig: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SetFiscalReceiptNumberRequestThe request object for setting\ \ a fiscal receipt number to the transaction.
" com.gk_software.pos.api.service.transaction.SetLineItemCustomFieldsRequest: type: "object" required: - "createReturnReceipt" - "emptiesReturnMode" - "returnMode" properties: operationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" returnMode: type: "boolean" description: "Indicated whether the item should be returned or registered.
" emptiesReturnMode: type: "boolean" description: "Flag indicating client is in empties return mode.
" createReturnReceipt: type: "boolean" description: "This parameter specifies whether a return receipt should\
\ be created for returned items.
\tThis has only an impact in case\
\ returnMode=true.
Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SetLineItemCustomFieldsRequestThe entity SetLineItemCustomFieldsRequest.
" com.gk_software.pos.api.service.transaction.SetQuantityRequest: type: "object" required: - "createReturnReceipt" - "emptiesReturnMode" - "exceededSingleQuantityAuthorized" - "returnMode" - "validate" properties: operationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" returnMode: type: "boolean" description: "Indicated whether the item should be returned or registered.
" emptiesReturnMode: type: "boolean" description: "Flag indicating client is in empties return mode.
" createReturnReceipt: type: "boolean" description: "This parameter specifies whether a return receipt should\
\ be created for returned items.
\tThis has only an impact in case\
\ returnMode=true.
The quantity input.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.QuantityInput" activeCustomerOrderId: type: "string" description: "The active customer order id.
" customerSequenceNumber: type: "integer" format: "int32" description: "The customer sequence number.
" validate: type: "boolean" description: "Set to false if validations should be skip. Default value\ \ is true.
" exceededSingleQuantityAuthorized: type: "boolean" description: "Set to true if single quantity limit was exceeded and successfully\ \ authorized
" processTrigger: type: "string" description: "The trigger of the SetQuantityForLineItem process.
" enum: - "QUANTITY_BUTTON" - "ENTER_NEW_ITEM" - "REPEAT_DIVISIBLE_ITEM" - "REPEAT_SCALABLE_ITEM" - "MENU_TABLES" - "PLUS_BUTTON" - "MINUS_BUTTON" - "ENTER_NEW_QUANTITY" - "ENTER_SKIPPED_QUANTITY" weightResult: description: "The weight result of a previously executed weighing process.
" $ref: "#/definitions/com.gk_software.pos.api.service.client.hardware.scale.WeightResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SetQuantityRequestDomain object for SetQuantity Request
" com.gk_software.pos.api.service.transaction.SetSerialNumberRequest: type: "object" required: - "createReturnReceipt" - "emptiesReturnMode" - "returnMode" properties: operationConfiguration: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The line item key the operation refers to.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" returnMode: type: "boolean" description: "Indicated whether the item should be returned or registered.
" emptiesReturnMode: type: "boolean" description: "Flag indicating client is in empties return mode.
" createReturnReceipt: type: "boolean" description: "This parameter specifies whether a return receipt should\
\ be created for returned items.
\tThis has only an impact in case\
\ returnMode=true.
Serial number to set.
" reasonCode: type: "string" description: "A reason code for this request (e.g. reason for price change).
" reasonCodeGroupCode: type: "string" description: "A reason code group code for this request (e.g. reason for\ \ price change).
" reasonDescription: type: "string" description: "A reason description for this request (e.g. reason for price\ \ change).
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SetSerialNumberRequestA request for setting serial numbers.
" com.gk_software.pos.api.service.transaction.SetTransactionCustomFieldsRequest: type: "object" properties: positionOperationConfig: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SetTransactionCustomFieldsRequestRequest object to set custom\ \ field values for currently active transaction.
" com.gk_software.pos.api.service.transaction.SetTransactionEndAttributesRequest: type: "object" properties: transactionId: type: "string" description: "The identifier of the transaction.
" workstationId: type: "string" description: "The workstation identifier.
" tillId: type: "string" description: "The till identifier.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SetTransactionEndAttributesRequestRequest object to set transaction\ \ end attributes to a transaction.
" com.gk_software.pos.api.service.transaction.SetTransactionReasonRequest: type: "object" properties: transactionId: type: "string" description: "The identifier of the transaction where the reason should\ \ be set.
" reasonCode: type: "string" description: "The reason code.
" reasonDescription: type: "string" description: "The reason description.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SetTransactionReasonRequestRequest object for setting a reason\ \ to a transaction.
" com.gk_software.pos.api.service.transaction.StoreLineItemTaxGroupIdRequest: type: "object" required: - "taxGroupIdLineItem" properties: taxGroupIdLineItem: type: "array" description: "Tax group id line item object
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TaxGroupIdLineItem" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "StoreLineItemTaxGroupIdRequestRequest object to store the tax\ \ group id to the sales return line items
" com.gk_software.pos.api.service.transaction.SubtotalOperationResult: type: "object" required: - "additionalEntries" - "allContractPricesLoaded" properties: primaryEntry: description: "The primary transaction result entry.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" additionalEntries: type: "array" description: "Additional result entries.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" filtered: type: "boolean" description: "Indicates whether the transaction result is filtered. A filtered\ \ transaction does not contain the details of a retail transaction object\ \ in order to optimize service communication.
" failure: description: "Reference to a failure entity in case a failure occurs during\ \ a service execution. This field can be used when a managed exception occurs\ \ and we still want to synchronize the resulting transaction instead of\ \ throwing an exception containing no information on transaction updates.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult" allContractPricesLoaded: type: "boolean" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SubtotalOperationResult TODO: undocumented" com.gk_software.pos.api.service.transaction.SuspendTransactionRequest: type: "object" required: - "finalizeTransaction" properties: suspendNumber: type: "string" description: "The suspend number for the transaction.
" barCodePrefix: type: "string" description: "Specifies the barcode prefix of the suspended receipt
" positionOperationConfig: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" finalizeTransaction: type: "boolean" description: "A flag to indicate whether the transaction should be finalized.\ \ The default value is true.
" consolidateLineItemsSuspending: type: "boolean" consolidateReturnItems: type: "boolean" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SuspendTransactionRequestRequest object to suspend currently\ \ active transaction.
" com.gk_software.pos.api.service.transaction.SyncLineItemsTraceableUnitIDRequest: type: "object" required: - "eanByTraceableUnitIDMap" - "positionOperationConfiguration" properties: positionOperationConfiguration: $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" keyedOnline: type: "boolean" offlineMode: type: "boolean" eanByTraceableUnitIDMap: type: "object" additionalProperties: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SyncLineItemsTraceableUnitIDRequest TODO: undocumented" com.gk_software.pos.api.service.transaction.TaxGroupIdLineItem: type: "object" required: - "lineItemKey" - "taxGroupId" properties: lineItemKey: description: "Sale return Line item key
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" taxGroupId: type: "string" description: "Tax group id
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TaxGroupIdLineItemSimple object that contains the tax line item\ \ group id
" com.gk_software.pos.api.service.transaction.TenderLineItemDataRequest: type: "object" properties: tenderAmount: type: "number" format: "double" description: "The tender amount.
" tenderDescription: type: "string" description: "The tender description.
" tenderGroupCode: type: "string" description: "The tender group code.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TenderLineItemDataRequestThe entity TenderLineItemDataRequest
" com.gk_software.pos.api.service.transaction.TerminalToRefundData: type: "object" required: - "tenderAuthorizations" - "terminalTenderLineItems" properties: terminalTenderLineItems: type: "array" description: "A list of retail transaction line items, which contains all\ \ terminal tender line items.
" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem" tenderAuthorizations: type: "array" description: "A list of all tender authorizations.
" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TenderAuthorization" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TerminalToRefundDataResult object for terminal line items to\ \ refund during voiding of transaction.
" com.gk_software.pos.api.service.transaction.TransactionBinaryDataRequest: type: "object" properties: positionOperationConfig: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" name: type: "string" description: "The transaction binary data name.
" data: type: "string" description: "The transaction binary data content.
" transactionID: type: "string" description: "The transaction identifier.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TransactionBinaryDataRequestRequest object to set transaction\ \ binary data to a transaction.
" com.gk_software.pos.api.service.transaction.TransactionBinaryDataWithExtensionRequest: type: "object" properties: positionOperationConfig: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" name: type: "string" description: "The transaction binary data name.
" data: type: "string" description: "The transaction binary data content.
" dataEncoded: type: "boolean" description: "Defines that the data is already encoded. It means it should\ \ be decoded again to be stored correctly.
" transactionID: type: "string" description: "The transaction identifier.
" extensionValue: type: "string" description: "The value for the connected / referenced extension
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TransactionBinaryDataWithExtensionRequestRequest object to set\ \ transaction binary data to a transaction and additionally an entry to transaction\ \ extension data.
" com.gk_software.pos.api.service.transaction.TransactionIdsRequest: type: "object" properties: transactionIds: type: "array" description: "A list of transaction identifiers.
" items: type: "string" onlySSCTransactions: type: "boolean" description: "A flag to indicate that only suspended transaction with workstation\ \ type code for self scanning are wanted.
" overtakeCustomerFromOriginalReceipt: type: "boolean" description: "A flag to indicate that the customer assignment from the\ \ suspended transaction should be taken over to the current transaction.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TransactionIdsRequestRequest object for requesting views of\ \ transaction search data.
" com.gk_software.pos.api.service.transaction.TransactionIdsResult: type: "object" properties: transactionIds: type: "array" description: "A list of transaction identifiers.
" items: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TransactionIdsResultResult object for transaction searches,\ \ holding a list of transaction identifiers.
" com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult: type: "object" properties: errorCode: type: "string" description: "The error code
" errorMessage: type: "string" description: "The error message
" messageKey: type: "string" description: "The message key
" arguments: type: "array" description: "The arguments
" items: type: "string" description: "TransactionOperationFailureResultThe transaction operation failure\ \ result
" com.gk_software.pos.api.service.transaction.TransactionOperationResult: type: "object" required: - "additionalEntries" properties: primaryEntry: description: "The primary transaction result entry.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" additionalEntries: type: "array" description: "Additional result entries.
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry" filtered: type: "boolean" description: "Indicates whether the transaction result is filtered. A filtered\ \ transaction does not contain the details of a retail transaction object\ \ in order to optimize service communication.
" failure: description: "Reference to a failure entity in case a failure occurs during\ \ a service execution. This field can be used when a managed exception occurs\ \ and we still want to synchronize the resulting transaction instead of\ \ throwing an exception containing no information on transaction updates.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TransactionOperationResultThe entity TransactionOperationResult\ \ contains the result of a service execution and is used for providing transaction\ \ updates fields updates for service clients.
" com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry: type: "object" required: - "addedOrModifiedLineItems" - "addedOrModifiedSaleReturnLineItemPrices" - "addedOrModifiedTransactionExtensions" - "addedPriceDerivationRules" - "addedTransactionAdditionalPrintouts" - "closedLineItems" - "deletedLineItems" - "deletedTransactionAdditionalPrintouts" - "promotionInputRequests" properties: transaction: description: "The resulting transaction after a service execution.
" $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.Transaction" addedOrModifiedLineItems: type: "array" description: "The line items added or modified by a service execution.
" uniqueItems: true items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem" deletedLineItems: type: "array" description: "The line items deleted by a service execution.
" uniqueItems: true items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" closedLineItems: type: "array" description: "The line items closed during a service execution.
" uniqueItems: true items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" promotionInputRequests: type: "array" description: "The promotion input requests resulting from a service execution.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.promotion_input_request.PromotionInputRequest" addedOrModifiedTransactionExtensions: type: "array" description: "The transaction extensions added or modified by a service\ \ execution.
" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionExtension" addedTransactionAdditionalPrintouts: type: "array" description: "The transaction additional printouts added or modified by\ \ a service execution.
" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.TransactionAdditionalPrintout" addedPriceDerivationRules: type: "array" description: "The price derivation rules added by a service execution.
" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionPriceDerivationRule" addedOrModifiedSaleReturnLineItemPrices: type: "array" description: "The sale return line item prices added or modified by a service\ \ execution.
" uniqueItems: true items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemPrice" deletedTransactionAdditionalPrintouts: type: "array" description: "The transaction additional printouts deleted by a service\ \ execution.
" uniqueItems: true items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.TransactionAdditionalPrintoutKey" priceModificationResultCode: type: "string" description: "This parameter defines the price difference limit exceed\ \ action for positive items (warn, authorize, forbid, unchecked) if a set\ \ or change price operation is attempted.
" serialNumberModificationResultCode: type: "string" description: "The serial number set to a line item.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TransactionOperationResultEntryAn entity describing an operation\ \ result entry.
" com.gk_software.pos.api.service.transaction.TransactionPrintRequest: type: "object" required: - "duplicate" - "finalizeTransaction" properties: printedTransactionId: type: "string" description: "The identifier for the transaction to print.
" duplicate: type: "boolean" description: "A flag to indicate that it is a duplicate print transaction.
" finalizeTransaction: type: "boolean" description: "A flag to indicate if the transaction should be finalized.\ \ The default value is true.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TransactionPrintRequestRequest object for creating a print transaction\ \ for an existing transaction (e.g. for printout repetition).
" com.gk_software.pos.api.service.transaction.TransactionSearchViewsResult: type: "object" properties: transactionSearchViews: type: "array" description: "A list of transaction search views.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.views.TransactionSearchView" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TransactionSearchViewsResultResult object, holding a list of\ \ TransactionSearchView.
" com.gk_software.pos.api.service.transaction.TransactionTenderRequest: type: "object" required: - "canceled" properties: tenderRegistration: description: "The tender registration.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.tender.TenderRegistration" canceled: type: "boolean" description: "A flag to indicate whether the transaction should be marked\ \ as cancelled or not.
" leadNumber: type: "string" description: "The lead number used for the tender pickup transaction envelope\ \ identifier.
" finalizeTransaction: type: "boolean" description: "A flag to indicate whether the transaction should be finalized.
" useBalanceAmountFromTillCopyObject: type: "boolean" description: "boolean: this flag should be set to 'true' if the values\ \ for balance amount should be copied from tillCopyObject and not from the\ \ tender request. Active balance amount from CRS is only taken for cash\ \ in main currency. Default is 'false'
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TransactionTenderRequestRequest object for creation of various\ \ tender related transactions.
" com.gk_software.pos.api.service.transaction.UnfinishedTransactionsRequest: type: "object" properties: businessUnitId: type: "string" description: "The business unit identifier.
" workStationId: type: "string" description: "The workstation identifier.
" transactionTypeCodes: type: "array" description: "A list of transaction type codes. If set only unfinished\ \ transactions with a matching transaction type code are processed.
" items: type: "string" transactionCategoryCode: type: "string" description: "The transaction category code. Only used for finishing unfinished\ \ transactions and if it is set to 'AUTO' for an automatic fail control\ \ transaction.
" transactionIds: type: "array" description: "A list of transaction identifiers.
" items: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "UnfinishedTransactionsRequestRequest object for operations with\ \ unfinished transactions (e.g. searching unfinished transactions).
" com.gk_software.pos.api.service.transaction.UpdateSalesOrderItemRequest: type: "object" required: - "extendOrderMode" - "includeSalesTax" - "usePosPrices" properties: orderId: type: "string" description: "The order id.
" usePosPrices: type: "boolean" description: "The use pos prices.
" extendOrderMode: type: "boolean" description: "The extend order mode.
" responseData: description: "The response data.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SalesOrderCommonData" salesOrderStandardPriceSpecificationElementTypeCode: type: "string" description: "The sales order standard price specification element type\ \ code.
" includeSalesTax: type: "boolean" description: "The include sales tax.
" priceTypeCode: type: "string" description: "The price type code.
" sapRebatesPromotionId: type: "string" description: "The sap debates promotion id.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "UpdateSalesOrderItemRequestThe entity UpdateSalesOrderItemRequest
" com.gk_software.pos.api.service.transaction.UpdateSalesOrderSelectedDeliveryItemRequest: type: "object" required: - "extendOrderMode" - "includeSalesTax" - "usePosPrices" properties: orderId: type: "string" description: "The order id.
" usePosPrices: type: "boolean" description: "The use pos prices.
" extendOrderMode: type: "boolean" description: "The extend order mode.
" responseData: description: "The response data.
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SalesOrderCommonData" salesOrderStandardPriceSpecificationElementTypeCode: type: "string" description: "The sales order standard price specification element type\ \ code.
" includeSalesTax: type: "boolean" description: "The include sales tax.
" priceTypeCode: type: "string" description: "The price type code.
" sapRebatesPromotionId: type: "string" description: "The sap debates promotion id.
" lineItemList: type: "array" description: "The line item list
" items: $ref: "#/definitions/com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem" operationConfiguration: description: "The operation configuration
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" deliveryTypeCode: type: "string" description: "T delivery type code
" salesOrderFinalPricePosPriceSpecificationElementTypeCode: type: "string" description: "The salesorder final price pos price specification element\ \ type code
" salesOrderDefaultPrepaymentPriceSpecificationElementTypeCode: type: "string" description: "The sales order default prepayment price specification element\ \ type code
" deliveryPlantID: type: "string" description: "The delivery plant ID
" uuid: type: "string" description: "The uuid
" downpaymentNotAllowed: type: "boolean" description: "The down payment not allowed
" downPaymentRequest: description: "The down payment request object
" $ref: "#/definitions/com.gk_software.pos.api.service.transaction.CreateDownpaymentLineItemRequest" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "UpdateSalesOrderSelectedDeliveryItemRequestThe update sales\ \ order selected delivery item request object
" com.gk_software.pos.api.service.transaction.UpdateTransactionExtensionRequest: type: "object" properties: transactionId: type: "string" extensionKey: type: "string" description: "The transaction extension key to be updated in the transaction.
" extensionValue: type: "string" description: "The new transaction extension value to be set in the transaction.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "UpdateTransactionExtensionRequestRequest object for updating\ \ a transaction extension.
" com.gk_software.pos.api.service.transaction.VoidLineItemBatchRequest: type: "object" required: - "offlineMode" - "storeTransaction" - "voidLineItemDetails" properties: operationConfiguration: description: "The operation configuration
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" voidLineItemDetails: type: "array" description: "The void line item details
" items: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.VoidLineItemDetail" storeTransaction: type: "boolean" description: "The store transaction
" offlineMode: type: "boolean" description: "The offline mode
" keyedOnline: type: "boolean" description: "The keyed on line state
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "VoidLineItemBatchRequestThe void line item batch request
" com.gk_software.pos.api.service.transaction.VoidLineItemDetail: type: "object" properties: lineItemKey: description: "Thw line item key
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" voidTypeCode: type: "string" description: "The void type code
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "VoidLineItemDetailThe void line item detail
" com.gk_software.pos.api.service.transaction.VoidLineItemRequest: type: "object" required: - "copyVoidedLineItem" - "offlineMode" - "storeTransaction" properties: operationConfiguration: description: "The operation configuration
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" lineItemKey: description: "The key of the line item to void
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" tenderAuthorizationKey: description: "The key of the tender authorization related to voided line\ \ item
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.TenderAuthorizationKey" voidTypeCode: type: "string" description: "Describes whether the line item was cancelled immediately\ \ after registering it, voided by another line item or internally voided.
" copyVoidedLineItem: type: "boolean" description: "Flag indicating whether to copy the line item.
" giftCertCancellationId: type: "string" description: "A gift certificate service result, it is filled only if a\ \ gift certificate line item is canceled online
" storeTransaction: type: "boolean" description: "Indicates whether the transaction should be stored.
" offlineMode: type: "boolean" description: "The offline mode
" keyedOnline: type: "boolean" description: "The keyed on line state.
" serviceScaleMode: type: "boolean" description: "Indicates whether the POS is in service scale mode.
" voidReason: description: "The reason for the void.
" $ref: "#/definitions/com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "VoidLineItemRequestDomain object for VoidLineItem Request
" com.gk_software.pos.api.service.transaction.VoidTenderLineItemRequest: type: "object" properties: positionOperationConfig: description: "The operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" retailTransactionLineItemKey: description: "The key of the line item to void
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" voidTypeCode: type: "string" description: "Describes whether the line item was cancelled immediately\ \ after registering it, voided by another line item or internally voided.
" tenderGroupCode: type: "string" description: "Describes whether the line item was cancelled immediately\ \ after registering it, voided by another line item or internally voided.
" enum: - "CASH" - "TERMINAL" - "GIFT_CERT" - "COUPON" - "CHEQUE" - "CREDIT" - "PROMOTION" - "POINTS" - "CASHENGINE" terminalTenderCancellationAuthorizationKey: description: "Terminal tender authorization key.
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.TenderAuthorizationKey" pointsCancellationTransactionId: type: "string" description: "A gift certificate service result, it is filled only if a\ \ gift certificate line item is canceled online
" giftCertCancellationTransactionId: type: "string" description: "A gift certificate service result, it is filled only if a\ \ gift certificate line item is canceled online
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "VoidTenderLineItemRequestDomain object for VoidTenderLineItem\ \ Request
" com.gk_software.pos.api.service.transaction.VoidTransactionConsolidateCashInMainCurrencyRequest: type: "object" properties: positionOperationConfig: description: "The position operation configuration.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" voidingTransactionId: type: "string" description: "The identifier for the voiding transaction.
" cashRefundAmount: type: "number" format: "double" description: "The cash refund amount.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "VoidTransactionConsolidateCashInMainCurrencyRequestRequest to\ \ consolidate cash in main currency for process VoidTransaction.
" com.gk_software.pos.api.service.transaction.customer.CustomerAssignmentRequest: type: "object" properties: customerId: type: "string" description: "String : customer id
" customerCardType: type: "string" description: "String : customer card type
" customerCardTypeDescription: type: "string" description: "String : customer card type description
" customerGroupId: type: "string" description: "String : customer group id
" customerDO: description: "CustomerDO : customerDO
" $ref: "#/definitions/com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO" customerTenderGroup: $ref: "#/definitions/com.gk_software.gkr.api.server.md.customer_tender_rule.dto.dom.CustomerTenderGroupDO" customerData: description: "CustomerData : customer data used for customer data entry\ \ process
" $ref: "#/definitions/com.gk_software.pos.flow.libs.customer.CustomerData" customerWebServiceData: description: "CustomerWebserviceResult : customer web service data
" $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerWebserviceResult" searchForIdentificationNumber: type: "boolean" description: "boolean : searchFor identification number
" customerIDEntryMethodCode: type: "string" description: "String : customer iD entry method code
" preferredReceiptPrintoutTypeCode: type: "string" description: "String : preferredReceiptPrintoutTypeCode
\tIt defines\
\ the preferred printout type code of the customer:
The organization name
" dataProvider: type: "string" description: "The data provider id
" genericFlag: type: "boolean" description: "It specifies if the customer is a dummy/unknown customer\ \
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerAssignmentRequestRequest object for operation which\ \ assign customer to active transaction
" com.gk_software.pos.api.service.transaction.customer.CustomerRegistrationRequest: type: "object" required: - "searchDatabase" - "searchForIdentificationNumber" properties: identifier: type: "string" description: "The customer identifier (customer id / party identification)
" customerGroupId: type: "string" description: "The customer group id
" customerCardType: type: "string" description: "The customer card type
" customerCardNumber: type: "string" description: "The customer card number
" customerCardTypeDescriptionKey: type: "string" description: "The customer card type description key
" useWebService: type: "string" description: "In case that 'searchDatabase' setting is set to false the\
\ value of
\tthat property is used to determine where the search should\
\ be executed.
\tPossible values are:
Indicates whether the customer should be searched in local\ \ MD database.
" searchForIdentificationNumber: type: "boolean" description: "This parameters works only in combination with searchDatabase=true,\
\ it
\tspecifies the type of customer identifier:
Indicates if the service was started in training mode.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerRegistrationRequestRequest object for the CustomerTransactionService
" com.gk_software.pos.api.service.transaction.customer.CustomerRemovalRequest: type: "object" required: - "addressTypeCode" - "businessUnitGroupID" - "customerID" - "transactionID" properties: businessUnitGroupID: type: "string" description: "long : business unit group iD
" transactionID: type: "string" description: "String : transaction iD
" customerID: type: "string" description: "String : customer iD
" addressTypeCode: type: "string" description: "String : address type code
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerRemovalRequestRequest object for operation which removes\ \ customer from active transaction
" com.gk_software.pos.api.service.transaction.gift_certificate.GiftCertificateRegistrationRequest: type: "object" required: - "createReturnReceipt" - "gcsUsage" - "online" - "takeAwaySaleMode" properties: positionOperationConfig: description: "PositionOperationConfig : position operation config
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" gcNumber: type: "string" description: "String : gift certificate number
" gcItemNumber: type: "string" description: "String : gift certificate item number
" gcAmount: description: "String : gift certificate amount
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.amount.Amount" serviceResult: description: "GiftCertServiceResult : service result
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.gift_certificate_service.GiftCertServiceResult" gcDescription: type: "string" description: "String : gift certificate description
" online: type: "boolean" description: "boolean : online
" createReturnReceipt: type: "boolean" description: "Specifies if a return receipt should be created.
" externalSystemAdapterName: type: "string" description: "String : external system adapter name
" gcClass: type: "string" description: "String : gc class
" expiryDate: type: "string" example: "'2018-05-16T16:09:24.394'" description: "Date : expiry date
Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS'\ \ (no timezone)" quantity: type: "integer" format: "int32" description: "int : quantity
" actionCode: type: "string" description: "String : action code
" gcType: type: "string" description: "String : gift certificate type
" gcsUsage: type: "boolean" description: "boolean : gcs usage
" taxGroupID: type: "string" description: "String : tax group iD
" alternativeTaxInfos: description: "The alternative tax infos for updating the tax group.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos" track2: type: "string" description: "Track2 data.
" additionalInfo: type: "array" description: "Contains additional information.
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.gift_certificate_service.AttributeValue" salesPersonNumberRequest: $ref: "#/definitions/com.gk_software.pos.api.service.transaction.SalesPersonNumberRequest" takeAwaySaleMode: type: "boolean" description: "Indicates whether the take away sale mode is active.
" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "GiftCertificateRegistrationRequestRequest object for operations\ \ which create a SaleReturnLineItem on active transaction.
" com.gk_software.pos.api.service.transaction.prepaid.PrepaidCreditRefundRequest: type: "object" properties: refundReasonCode: type: "string" description: "The refund reason code
" refundReasonGroupCode: type: "string" description: "The refund reason group code
" invalidItems: type: "array" description: "List of line item keys for the invalid items
" items: $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" positionOperationConfig: description: "The position operation configuration for the refund position\ \ creation
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PrepaidCreditRefundRequestRequest object for adding failed prepaid\ \ line items for refunding.
" com.gk_software.pos.api.service.transaction.prepaid.PrepaidCreditSaleRegistrationRequest: type: "object" properties: amount: type: "number" format: "double" description: "The amount value.
" quantity: type: "integer" format: "int32" description: "The quantity value.
" actionCode: type: "string" description: "The action code for the line item. The default value is 'SI'.
" adapterType: type: "string" description: "The adapter type for the call to the external system for\ \ prepaid credit sales.
" sm_id: type: "integer" format: "int32" description: "The entry identifier from prepaidType configuration.
" item_id: type: "string" description: "The item identifier of the prepaid item
" provider_code: type: "string" description: "The provider code of the prepaid item
" resource_id: type: "string" description: "The resource key of the prepaid receipt
" positionOperationConfig: description: "The position operation configuration for the SaleReturnLineItem\ \ registration
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" alternativeTaxInfos: description: "The alternative tax infos for updating the tax group.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos" sellerId: type: "string" description: "String to store seller Id
" sellerRelationMethod: type: "string" description: "sellerRelationMethod to store the currently defined seller\ \ assignment method
" enum: - "CurrentLineItemOnly" - "CurrentAndFollowingLineItemsOfCurrentTransaction" - "CurrentAndFollowingLineItemsOfCurrentAndFollowingTransactions" - "AllLineItemsOfCurrentTransaction" - "FollowingLineItemsOfCurrentTransaction" - "FollowingLineItemsOfCurrentAndFollowingTransactions" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PrepaidCreditSaleRegistrationRequestRequest object for operations\ \ which create a SaleReturnLineItem for a prepaid credit sale on the active\ \ transaction.
" com.gk_software.pos.api.service.transaction.prepaid.PrepaidCreditSaleUpdateRequest: type: "object" properties: lineItemKey: description: "The line item key
" $ref: "#/definitions/com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey" returnCode: type: "string" description: "The return code of the stored value server call.
" serialNumber: type: "string" description: "The serial number of the prepaid card.
" positionOperationConfig: description: "The position operation configuration for the SaleReturnLineItem\ \ update.
" $ref: "#/definitions/com.gk_software.pos.api.model.config.process.action.PositionOperationConfig" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PrepaidCreditSaleUpdateRequestRequest object for updating a\ \ SaleReturnLineItem of a prepaid credit sale.
" com.gk_software.pos.api.session.PosSessionData: type: "object" properties: sessionDataMap: type: "object" description: "Map that holds session data.
" additionalProperties: type: "string" description: "PosSessionDataStore specific session data.
" com.gk_software.pos.api.session.PosSessionId: type: "object" required: - "id" properties: id: type: "string" description: "The session id.
" description: "PosSessionIdIdentifies a session.
" com.gk_software.pos.flow.libs.customer.CustomerCardCode: type: "object" properties: storeNumber: type: "string" date: type: "string" example: "'2018-05-16T16:09:24.394'" description: "Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" cardNumber: type: "string" salutation: type: "string" firstName: type: "string" lastName: type: "string" street: type: "string" zip: type: "string" city: type: "string" federalState: type: "string" country: type: "string" email: type: "string" telephone: type: "string" mobilePhone: type: "string" fax: type: "string" businessTelephone: type: "string" taxId: type: "string" gender: type: "string" birthday: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerCardCode TODO: undocumented" com.gk_software.pos.flow.libs.customer.CustomerData: type: "object" properties: customerId: type: "string" firstName: type: "string" lastName: type: "string" salutation: type: "string" gender: type: "string" birthday: type: "string" example: "'2018-05-16T16:09:24.394'" description: "Date format 'yyyy-MM-dd'T'HH:mm:ss.SSS' (no timezone)" street: type: "string" postalCode: type: "string" city: type: "string" customerState: type: "string" country: type: "string" homePhone: type: "string" email: type: "string" fax: type: "string" mobile: type: "string" workPhone: type: "string" taxId: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "CustomerData TODO: undocumented" com.gk_software.pos.flow.libs.payment.TerminalTransactionRecoveryValues: type: "object" properties: cardNr: type: "string" cardExpirationDate: type: "string" immediateCancellation: type: "boolean" isoCurrencyNr: type: "string" lastErrorMessage: type: "string" lastErrorMessageForCustomer: type: "string" offlinePayment: type: "boolean" paymentType: type: "integer" format: "int32" processMode: type: "string" signatureRequired: type: "boolean" successful: type: "boolean" tenderAuthorizationSequenceNumber: type: "integer" format: "int32" terminalId: type: "string" terminalTransactionNr: type: "string" transactionResultCode: type: "integer" format: "int32" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "TerminalTransactionRecoveryValues TODO: undocumented" com.gk_software.pos.flow.libs.transaction.DiscountIconList: type: "object" properties: icon: type: "string" iconDisabled: type: "string" promotionId: type: "string" eligibilityId: type: "string" ruleId: type: "string" enabled: type: "boolean" overlayText: type: "string" placeHolders: type: "array" items: $ref: "#/definitions/com.gk_software.pos.flow.libs.transaction.PlaceHolder" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "DiscountIconList TODO: undocumented" com.gk_software.pos.flow.libs.transaction.PlaceHolder: type: "object" properties: placeholder: type: "string" content: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "PlaceHolder TODO: undocumented" com.gk_software.pos.flow.libs.transaction.SuspendCodeSkippedItem: type: "object" properties: itemID: type: "string" registrationNumber: type: "string" quantity: type: "string" unitOfMeasure: type: "string" reason: type: "string" xXCustom06: type: "string" description: "Customizable information
" xXCustom07: type: "string" description: "Customizable information
" xXCustom08: type: "string" description: "Customizable information
" xXCustom09: type: "string" description: "Customizable information
" xXCustom10: type: "string" description: "Customizable information
" xXCustom11: type: "string" description: "Customizable information
" xXCustom12: type: "string" description: "Customizable information
" xXCustom13: type: "string" description: "Customizable information
" xXCustom14: type: "string" description: "Customizable information
" xXCustom15: type: "string" description: "Customizable information
" xXCustom01: type: "string" description: "Customizable information
" xXCustom02: type: "string" description: "Customizable information
" xXCustom03: type: "string" description: "Customizable information
" xXCustom04: type: "string" description: "Customizable information
" xXCustom05: type: "string" description: "Customizable information
" description: "SuspendCodeSkippedItem TODO: undocumented" com.gk_software.swee.ses.api.server.cd.data_provider.dto.so.BusinessUnitDetailSO: type: "object" properties: retailStoreID: type: "string" storeDescription: type: "string" postalCode: type: "string" city: type: "string" street: type: "string" phoneNumber: type: "string" distance: type: "number" format: "double" xxcustom01: type: "string" xxcustom02: type: "string" xxcustom03: type: "string" xxcustom04: type: "string" xxcustom05: type: "string" description: "BusinessUnitDetailSOA unique system assigned identifier for the item selling\
\ rule.
\tGenerated, not imported.
A flag to denote that the retail price is to be manually\
\ entered when this item is sold.
A flag to denote whether or not this item may be returned.\
\ (Eg: freezer or chilled merchandise)
A flag to indicate whether food stamps can be tendered for\
\ this item.
A flag denoting if this item is allowed in a WIC transaction.
A flag to indicate if the item can be delivered to the customer.
Determines whether a prepayment/downpayment position should\
\ be retained when an order of the item is voided (e.g. the prepayment could\
\ be retained if the order of a special measured item is voided)
A flag to indicate if the customer may take an item home\
\ to test it
Defines if the registration of the item requires a serial\
\ number input
A flag to denote if no tax exemption is allowed for the item.\
\ True = no tax exemption allowed.
A flag to indicate that the retail store is authorized to\
\ stock this particular item.
A flag to indicate whether this item can be discounted.
Determines whether bonus points are allowed for the item
Type code for controlling the quantity input
Determines how the input of quantity is done on POS
Date when selling of the item becomes effective
Last date when the item is available for sale
If this flag is set to true, automatically a negative position\
\ is created when registering this item
Type code for the manual price change.
\tValues:
Determines whether the price is to be hided (not printed)\
\ on the receipt and to be hided (not shown)
Determines whether this item is to be shown on the customer\
\ display
Bar code handling method
A flag to denote that the weight is to be registered when\
\ this item is sold
Determines whether it is possible to register a price on\
\ scales
Flag AllowLayawayFlag defines if an item is allowed for Layaway\
\ or not.
Flag LayawayDiscountFlag defines if promotions are allowed\
\ for the 'Layaway' item.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
This object is a set of rules used for item\
\ selling.
\tThe rules can be referred from the item object and merchandise\
\ hierarchy group object.
The fields of this rule object are\
\ imported directly on the item / MHG, but saved as a separate domain object\
\ to save storage place.
Import from masterData_Item.xml from\
\ the element Item.UOMItem.ItemSellingRule.
\tImport from masterData_BusinessUnit.xml\
\ from the element BusinessUnit.MerchandiseHierarchyGroupDetail.ItemSellingRule:\
\ DiscountFlag, BonusPointsFlag and NegativePositionFlag.
Language ISO code identification.
Import:
\tmasterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.TranslationList.Language.@ID
Description in the given language.
Import:
\tmasterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.TranslationList.Language.TranslatedDescription
Translation for description of the merchandise\
\ hierarchy group in one language.
Import:
\tmasterData_MerchandiseHierarchyGroup.xml:\
\ MerchandiseHierarchyGroup.TranslationList.Language
Identifier of the merchandise hierarchy group.
Import:
\tmasterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.MerchandiseHierarchyGroupID
\tmasterData_BusinessUnit.xml: BusinessUnit.MerchandiseHierarchyGroupDetail.MerchandiseHierarchyGroupID.
merchandise HierarchyGroup ID Qualifier
The name of the merchandise hierarchy group.
Import:
\tmasterData_MerchandiseHierarchyGroup.xml: first 40\
\ characters from MerchandiseHierarchyGroup.Description
The description of the merchandise hierarchy group.
Import:
\tmasterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.Description
The tax group assigned to the merchandise hierarchy group.
Import:
\tmasterData_MerchandiseHierarchyGroup.xml:\
\ MerchandiseHierarchyGroup.TaxGroupID
Reference to the ItemSellingRule object.
Import:
\tmasterData_BusinessUnit.xml:
Reference to the ItemMerchandiseManagementRule object.
Import:
\tmasterData_MerchandiseHierarchyGroup.xml:
masterData_BusinessUnit.xml:
Internal identification of the import package (e.g. IDoc\
\ file). The identification is used for monitoring purposes.
Generated, not imported.
A unique system assigned identifier for the level within\
\ the merchandise hierarchy tree.
Not imported. Generated\
\ for the levelName.
Name for the level within the merchandise hierarchy tree.
Import:
\tmasterData_MerchandiseHierarchyGroup.xml:\
\ MerchandiseHierarchyGroup.LevelName
Translation identifier - used for the unique identification\
\ of translations in the common translation table.
Generated,\
\ not imported.
List of translations for description of the merchandise hierarchy\
\ group.
Import:
\tmasterData_MerchandiseHierarchyGroup.xml:\
\ MerchandiseHierarchyGroup.TranslationList
Additional field for custom development
Import:
\tmasterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.xx_custom_01
Additional field for custom development
Import:
\tmasterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.xx_custom_02
Additional field for custom development
Import:
\tmasterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.xx_custom_03
Additional field for custom development
Import:
\tmasterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.xx_custom_04
Additional field for custom development
Import:
\tmasterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.xx_custom_05
Merchandise hierarchy group definition.
Import\
\ from masterData_MerchandiseHierarchyGroup.xml and masterData_BusinessUnit.xml.
\tThe definition of merchandise hierarchy groups is imported from masterData_MerchandiseHierarchyGroup.xml.\
\ The masterData_BusinessUnit.xml allows import additional details. If the MHG\
\ from masterData_BusinessUnit.xml does not exist, it is created.
A unique identifier for the rule eligibility
Generated, not imported.
A code that indicates the type of Price Derivation Rule Eligibility.
\tPossible types:
Import:
Reference to the root eligibility of the condition eligibility\
\ tree
Not imported.
Reference to the parent eligibility in the condition eligibility\
\ tree
Not imported.
Level in the eligibility tree the eligibility belongs to
Not imported.
The timestamp this eligibility becomes active
Not imported.
The last date and time that this eligibility is effective
Not imported.
Defines the current status for the eligibility. Examples\
\ of valid codes include: AC/null = Active, IA = Inactive
Import:
Determines whether the eligibility must be fulfilled (false)\
\ or not (true) in order that the price derivation rule can be applied
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Promotion eligibility
Import:
A identifier for a specific price derivation rule.
Generated, not imported.
Price derivation rule name
Not imported.
Business description for this price derivation rule.
Import:
This is a special code that determines when, during the entry\
\ of a sale transaction, this rule will be applied. For example a price\
\ change rule may be applied on a line item by line item basis (which is\
\ DETAIL TIME), a price change rule may be triggered after a transaction\
\ is totaled -- but before tax and tender entry (i.e. MERCHANDISE SUBTOTAL\
\ TIME).
Import:
Defines the current status for the price derivation rule.\
\ Examples of valid codes include: Pending, Active, Canceled, Inactive
Import:
Defines the type of price derivation rule.
The following type is reserved for usage by Loyalty Engine itself.\
\ It cannot be used in promotion master data.
Import:
\tThe value is filled\
\ according to the used rule type from Promotion.Condition.Rule.
External ident of the price derivation rule
Import:
Determines whether rebate or bonus points are awarded by\
\ the rule
Import:
Determines how the calculated reduction amount is to be rounded;
Requested number of decimal places of the calculated reduction\
\ amount;
Additional information for rounding,
\tpossible values:
Determines how the rebate influences the transaction:
Import:
End of the date range in which the gift certificate is valid
Import:
A code which uniquely identifies the type of tender, ie cash,\
\ check, credit card, etc.
Import:
Determines whether applying this condition influences the\
\ calculation base of subsequent transaction-related conditionens (false)\
\ or not (true); is relevant for position-related 'money' conditions only
Import:
Determines, in which sequence items get rebate:
Import:
Determines whether applying this condition influences the\
\ calculation base of subsequent conditions (false) or not (true); is relevant\
\ for position-related 'money' conditions only
Import:
Base of the calculation:
number of the printout coupon
Import:
Type code of the printout rule
Import:
Formated Text of the printout coupon
Import:
Indicates whether all conditions are to be considered which\
\ were applied before (true) or not (false).
Import:
Validity period for printout coupons or gift certificates
Import:
Translation identifier - used for the unique identification\
\ of translations in the common translation table.
Generated,\
\ not imported.
List of translations
External ID of the condition rule (filled with PromotionConditionID)
Determines which one of the previously applied modifiers\
\ is to be considered as calculation base for the current modification.\
\ In detail, the calculation base for the current price derivation rule\
\ is to be determined as following:
\t- In case that no price derivation\
\ rules were applied before, it is the original price/total.
\t- Null:\
\ all price derivation rules which were applied before the current price\
\ derivation rule are to be considered, i.e. the calculation base for the\
\ current price derivation rule equals to the new price of the price derivation\
\ rule which was applied just before it = as latest.
\t- Otherwise,\
\ the calculation base for the current price derivation rule equals to the\
\ new price of that price derivation rule which was applied one or more\
\ steps before it having the highest sequence <= CalculationBaseSequence\
\ (or the original price if no such price derivation rule was applied).
The system-generated identifier of the rounding rule which\
\ applies for discounts/bonus points counts resulting from applying the\
\ price derivation rule
The system-generated identifier of the rounding rule which\
\ applies for shares resulting from prorating basket-related discounts or\
\ bonus points resulting from applying the price derivation rule
The system-generated identifier of the rounding rule applies\
\ for monetary equivalents to bonus points counts resulting from applying\
\ the price derivation rule
Determines whether the price derivation rule is applicable\
\ in general (false) or only in the case that no other monetary discounts\
\ were granted before (true).
This flag decides whether a promotion price derivation rule\
\ or a particular price is allowed to increase the price in comparison to\
\ the latest calculated discount sales price.
Possible\
\ values:
For measured items (e.g. pre-packed weighed items), the package\
\ limit quantity limits the maximum package count that can receive a benefit.\
\ A price derivation rule containing a package limit quantity being not\
\ null and greater than zero can be applied to measured items only, but\
\ not to piece items.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Promotion condition rule
Import:
Language id
Translation of the rule name
Translation of the description
Translation of the printout coupon text
Translation of condition\
\ rule texts in one language
The unique identifier for a promotion.
Mapped\
\ from promotion.
A identifier for a condition.
Generared,\
\ not imported.
A identifier for a specific price derivation rule.
Generated, not imported.
A unique identifier for a Price Derivation Rule eligibility.\
\ It is the ID of the root eligibility of the condition. (useful if the\
\ combination eligibility is used).
Time restrictions
Import:
Code of the condition type
Rule data
Eligibility data (tree)
Sequence - for collision handling
Resolution - for collision handling
Determines whether the result of the applied condition is\
\ to be suppressed on displays / not printed on the receipt; e.g. position-dependent\
\ default points are not printed after each position, but only summarized\
\ at the end of the receipt.
Short description
Receipt text (overwrites the receipt text of the promotion)
Operator display text (overwrites the operator display text\
\ of the promotion)
Customer display text (overwrites the customer display text\
\ of the promotion)
'vector' which describes which discount typecodes are allowed\
\ for usage by the loyalty server; Item.DiscountTypeCode is used as an index\
\ in order to find the right position inside the vector;
\tPossible\
\ values for each position are:
Determines whether the condition can be used only for sales,\
\ only for returns, or for both:
Determines whether the condition can be used only for sales,\
\ only for amendments, or for both:
determines whether this condition is an exclusive condition
Import:
ID of the icon that should be displayed as sales information\
\ on POS
Import:
Determines how this condition works in relation to other\
\ applicable conditions
Describes whether the promotion is prohibited/cannot be applied\
\ in line item mode.
Translation identifier - used for the unique identification\
\ of translations in the common translation table.
Generated,\
\ not imported.
List of translations
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Condition of the promotion
Import:
List of time periods
Import:
ID of the time group
Generated, not imported.
Time restriction
Language id
Translation of the operator display text.
Translation of the customer display text.
Translation of the receipt text.
Translation of the short description
Translation of condition texts\
\ in one language
This domain object contains the promotion\
\ data relevant for the Loyalty Engine.
Import from:
The imports from masterData_Promotion.xml and\
\ masterData_CustomerPromotion.xml are not intended for further use.
The unique identifier of the business unit group.
External ident of the promotion
Import:
Date and time when the promotion becomes effective
Import:
The last date and time when this promotion is effective.
Import:
Text to be displayed to the operator.
Text to be displayed to the customer.
Text which is to be printed on the receipt
Origin of the promotion
Promotion description
Promotion type
Import:
list of promotion conditions
The unique identifier for a promotion.
Not\
\ imported, generated.
Internal identification of the import package (e.g. IDoc\
\ file). The identification is used for monitoring purposes.
Not imported, generated.
Translation identifier - used for the unique identification\
\ of translations in the common translation table.
Generated,\
\ not imported.
Another external ident of the promotion.
\tIt is needed\
\ by/known to the retailer.
The date and time when the promotion was changed at latest.
List of translations
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
Additional field for custom development.
Import\
\ from masterdata_Promotion_SE.xml only.
This domain object contains the promotion data relevant\
\ for the Loyalty Engine.
Import from:
The imports from masterData_Promotion.xml and\
\ masterData_CustomerPromotion.xml are not intended for further use.
Language id
Import:
Translation of the text to be displayed to the operator.
Import:
Translation of the text to be displayed to the customer.
Import:
Translation of the text to be printed on the receipt
Import:
Translation of the short description
Import:
Translation of the promotion texts in\
\ one language
A 2 character code denoting the day of the week that the\
\ time period falls on
Import:
The time of day that the time period commences
The duration included in the time period from the start time
ID of the time period
Generated, not imported.
The time restriction in cron format.
Time period
Import:
Code of the reason group
Reason code group parameter code
Reason code group parameter name
Parameter defined for the reason group
A retailer assigned code denoting the family of related reason\
\ codes for classifying data and actions within the systems of the retail\
\ enterprise.
The unique identifier of the business unit group.
Import:
\tmasterData_Reason.xml: BusinessUnitGroupID or the\
\ BusinessUnitGroupID for the ExternalBusinessUnitGroupID from ReasonCodeGroup.BugHeader\
\ or if not filled, then from ReasonCodeGroupMasterData.BugHeader. If not\
\ filled, then the data is globally valid.
Description of the reason code group
List of parameters defined for this reason code group
Not used, not imported.
Translation identifier
List of translations
Additional field for custom development
Additional field for custom development
Additional field for custom development
Additional field for custom development
Additional field for custom development
Reason code group master data. Reason groups\
\ represent e.g. various processes.
Language ISO code identification
Localized description of the reason group in the given language
Translation of reason group texts\
\ in a specific language
Reason parameter code
Reason parameter name
Reason parameter value
Reason parameter.
\tThe parameters are\
\ not used in a generalized, cross-process manner. Each process uses its own\
\ parameters.
\tMeaning of the most important parameters in the merchandise\
\ management processes:
The unique identifier of the business unit group.
Import:
\tmasterData_Reason.xml: BusinessUnitGroupID or the\
\ BusinessUnitGroupID for the ExternalBusinessUnitGroupID from Reason.BugHeader\
\ or if not filled, then from ReasonMasterData.BugHeader. If not filled,\
\ then the reason is globally valid.
Long description of the reason
Reason short text
Code of the group to which the reason belongs
Description of the assigned reason group; for information\
\ purposes
Not imported, loaded from ReasonCodeGroupSO.reasonCodeGroupDescription
Defines the order within a group for display in the graphical\
\ user interface
List of reason parameters
Translation identifier
List of translations
Additional field for custom development
Additional field for custom development
Additional field for custom development
Additional field for custom development
Additional field for custom development
A unique retailer defined reason code for an action that\
\ is taken (or not taken) at a workstation / device.
Reasons are used for sale and merchandise management\
\ processes. They are used to designate different goods movements. Reasons may\
\ contain a number of parameters. Each parameter has a defined name with a certain\
\ meaning for the respective process.
\tReasons are grouped by processes.\
\ Each reason is identified based on a combination of code + group.
\t\
Each group has a fixed code. The reasons belonging to this group are used in\
\ the respective process.
Import from masterData_Reason.xml.
Language ISO code identification
Reason description in the given language.
Reason short text in the given language
Translation of reason texts in a specific\
\ language
ID of the merchandise hierarchy group which the sales restriction\
\ is assigned to
Import:
\tmasterData_BusinessUnit.xml:\
\ BusinessUnit.MerchandiseHierarchyGroupDetail.MerchandiseHierarchyGroupID.
Reference to the merchandise\
\ hierarchy group which the sales restriction is assigned to
Sales restriction identifier
Generated,\
\ not imported.
A unique system assigned identifier for a group of business\
\ units.
The value of the sales restriction - its content depends\
\ on the SalesRestrictionTypeCode, e.g.
* Age =>\ \ minimum customer age
* Sales prohibition period => time group\ \ identifier
* Limit => quantity limit
Import:
\tmasterData_Item.xml: Item.UOMItem.SalesRestriction.SalesRestrictionValue
List of merchandise hierarchy groups which the sales restriction\
\ is assigned to
Import:
\tmasterData_BusinessUnit.xml:\
\ BusinessUnit.MerchandiseHierarchyGroupDetail.MerchandiseHierarchyGroupID.
List of UOM items which the sales restriction is assigned\
\ to
Import:
\tmasterData_Item.xml: Item identification.
The text of the question that the customer is to be asked\
\ when validating a restriction.
Import:
\tmasterData_Item.xml:\
\ Item.UOMItem.SalesRestriction.QuestionText
Type code of the question.
Import:
\t\
masterData_Item.xml: Item.UOMItem.SalesRestriction.QuestionTypeCode
Translation identifier - used for the unique identification\
\ of translations in the common translation table.
Generated,\
\ not imported.
List of translations
Import:
\tmasterData_Item.xml:\
\ Item.UOMItem.SalesRestriction.TranslationList
Sales restriction type code, e.g.
\ \ * AGE, CAGE => Age (customer age is to be checked)
* TIME\ \ => Sales prohibition period (sale is prohibited during specified time)
* LIMT => Limit (maximally this quantity of the item may be sold)
* WGHT => Weight (the weight is to be checked)
* RISK\ \ => Risk (the sale of that item is to be double-checked)
Import:
\tmasterData_Item.xml: Item.UOMItem.SalesRestriction.SalesRestrictionTypeCode
\tmasterData_BusinessUnit.xml: 'RISK' for BusinessUnit.MerchandiseHierarchyGroupDetail.RiskSaleResctriction
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Specific items can be sold under defined conditions\
\ only, e.g. alcohol drinks from 18 years. Sales restrictions determine these\
\ conditions.
Import:
\tmasterData_Item.xml: Item.UOMItem.SalesRestrictionList
\tmasterData_BusinessUnit.xml: BusinessUnit.MerchandiseHierarchyGroupDetail.RiskSaleResctriction.
Language ISO code identification
Import:
\tmasterData_Item.xml: Item.UOMItem.SalesRestriction.TranslationList.Language.@ID
Localized question text in the given language.
Import:
\tmasterData_Item.xml: Item.UOMItem.SalesRestriction.TranslationList.Language.TranslatedQuestionText
Translation of sales restriction\
\ texts in one language
ID of the item which the sales restriction is assigned to
Import:
\tmasterData_Item.xml: Item.ItemID
Unit of measure of the item which the sales restriction is\
\ assigned to
Import:
\tmasterData_Item.xml: Item.UOMItem.UOMCode
Reference to the item which the\
\ sales restriction is assigned to
Source unit of measure code
Destination unit of measure code
The factor that converts the source UOM to the destination\
\ UOM
Determines whether conversion is done by multiplying (true)\
\ or dividing (false)
Conversion of one measure unit into another one.
Not used. Not filled in the data editor.
Identification of the unit of measure
Import:
\tdc_import_UnitOfMeasure: UnitOfMeasure.UOMCode
Localized code of the unit of measure. This code is displayed\
\ in the GUI and can be used also in exports. Example: The unit of measure\
\ with the code 'PCE' has the localized code 'ST'.
Indicates what this unit of measure entity type instance\
\ measures. Examples include weight or mass, length, cube (length x width\
\ x depth), volume, discrete items (each), etc.
Import:
\tdc_import_UnitOfMeasure: UnitOfMeasure.UOMTypeCode
Indicates whether this unit of measure is part of the English\
\ or metric system of measurements.
Name assigned to this unit of measure.
Description assigned to this unit of measure.
List of conversions from this unit of measure into other\
\ units of measure
Not used. Not filled in the data maintenance.
Allowed count of decimal places. The quantities are displayed\
\ with this decimal places count in the GUI and reports. When registering\
\ an item in this unit, there can be registered maximally this count of\
\ decimal places.
The corresponding ISO code for this unit of measure
Not imported.
Translation identifier - used for the unique identification\
\ of translations in the common translation table.
Generated,\
\ not imported.
List of translations of unit of measure texts
Import:
\tdc_import_UnitOfMeasure: UnitOfMeasure.UomTranslationList
Additional field for custom development
Additional field for custom development
Additional field for custom development
Additional field for custom development
Additional field for custom development
Units in which a value is being expressed, or manner in\
\ which a measurement has been taken.
\tUnit of measure codes are referred\
\ from the item. The codes have to be initialized before they are used on the\
\ item.
Import from dc_import_UnitOfMeasure.
Language ISO code identification
Localized code of unit of measure in the given language
Name of the unit of measure in the given language
Description of the unit of measure in the given language
Translation of UOM texts in one language
The unique ID of the operator (Note: Not the login name.\
\ The login name can be store specific.)
Worker ID. This attribute can be used as the connection between\
\ the operator and the worker object.
Salutation
First name
Last name
ISO language ID. The GUI in the portal, on the hand-held\
\ and on the POS is displayed in this language after user login
Flag for left handed. The flag can control the GUI of the\
\ peripheral device.
Email address
Birth year
Birth month
Birth day
Role assignments in specific retail stores
Login data for periphery classes in specific retail stores
Origin of the import
Internal identifier of the import file
ISO country code
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
The data of an operator (person) who can work\
\ in many retail stores. The operator can obtain different login data and different\
\ roles in different retail stores.
Import from Operator.xml.
Retail store ID of the role assignment
Import:
\tOperator.xml: from Operator.BusinessUnitAssignment.BusinessUnitIdentification:\
\ BusinessUnitID or the corresponding retail store ID for the ExternalBusinessUnitID
ID of the assigned role in the store
Import:
\tOperator.xml: Operator.BusinessUnitAssignment.BusinessUnitAssignmentContent.RoleID
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Assignment of the operator to a role in\
\ a specific retail store
Retail store ID of the periphery access assignment
Import:
\tOperator.xml: from Operator.BusinessUnitAssignment.BusinessUnitIdentification:\
\ BusinessUnitID or the corresponding retail store ID for the ExternalBusinessUnitID
Identification of the periphery class. Possible values: 'Mobile',\
\ 'Web', 'POS', 'SCALE', 'RVM', 'ESL' etc.
\tThis attribute allows\
\ to define different login data for different peripheral systems.
Import:
\tOperator.xml: Operator.BusinessUnitAssignment.BusinessUnitAssignmentContent.PeripheralSystemTypeLogin.PeripheralSystemType
Login name. The login name for the target systems POS, Scale\
\ and Mobile can be numeric only.
Import:
\tOperator.xml:\
\ Operator.BusinessUnitAssignment.BusinessUnitAssignmentContent.PeripheralSystemTypeLogin.LoginName
Password. The password for the target systems POS, Scale\
\ and Mobile can be numeric only.
Import:
\tOperator.xml:\
\ Operator.BusinessUnitAssignment.BusinessUnitAssignmentContent.PeripheralSystemTypeLogin.Password
Timestamp (date and time), when the password was created.
Count of failed log in attempts. This value is reset after\
\ a successfully log in.
\tFAT POS will save these attributes locally.\
\ They will be never known on the central.
Timestamp of last successfully log in
\tFAT POS will\
\ save these attributes locally. They will be never known on the central.
Determines, if the access is blocked.
\tFAT POS will\
\ save these attributes locally. They will be never known on the central.
Initial password flag
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Additional field for custom development.
Login data of one specific periphery class\
\ in the specific retail store