Cancellation - 010401

Line Item Cancellation - 01040100502

VoidLineItemConfig

Note:
extends ProcessConfig
Parameter Name Migration Data Type, Range Description Default
selectLineItemBefore SELECT_POSITION_BEFORE Boolean It specifies whether the line item which should be voided is selected before or after the function call. true
continuousVoidMode Boolean It defines whether the void registration mode is finished after voiding one line item or if multiple items can be voided. true
allowCancellationOfLastLineItem ALLOW_LAST_POS_STORNO Boolean It specifies whether the last line item of the receipt can be voided. true
authorizeCancellationOfLastLineItem AUTHORIZE_LAST_POS_STORNO Boolean It controls whether authorization is required to void the last remaining line item of the receipt. false
authorizeCancellationOfFirstLineItem AUTHORIZE_FIRST_POS_STORNO Boolean It controls whether authorization is required to void the first line item of the receipt. false
maxAmount MAX_AMOUNT Double It defines the maximum amount which is allowed for the line item.
maxTotalAmount MAX_TOTAL_AMOUNT Double It defines the maximum amount which is allowed per receipt.
maxLineItemCount MAX_POSITION_COUNT Integer It defines the maximum number of line item cancellations per receipt.
offlineAllowedForGiftCert OFFLINE_ALLOWED_FOR_GIFT_CERT Boolean It specifies whether it is allowed to cancel gift certificate line items if the Stored Value Server cannot be reached. true
maxPositionCountAuthorizationConfig AuthorizationConfig Authorization configuration if the maximum line item count is exceeded.
maxTotalAmountAuthorizationConfig AuthorizationConfig Authorization configuration if the maximum total amount per receipt is exceeded.
maxAmountAuthorizationConfig AuthorizationConfig Authorization configuration if the maximum line item amount is exceeded.
lastPositionAuthorizationConfig AuthorizationConfig Authorization configuration if the last remaining line item is voided.
firstPositionAuthorizationConfig AuthorizationConfig Authorization configuration if the first line item is voided.
confirmVoidingMessageDialogConfig MessageDialogConfig Dialog configuration for the voiding confirmation dialog.
voidLineItemPositionOperationConfig PositionOperationConfig

Cancel Transaction - 01040100503

Server Parameters

Table 1. CouponingServiceConfigs
Parameter Name Migration Data Type, Range Description Default
companyCode String It defines the company code. GK
Table 2. CancelTransactionConfig
Parameter Name Migration Data Type, Range Description Default
reasonCodeRequired REASON_REQUIRED Boolean It specifies whether a reason is requested. true
reasonCodeGroupCode String It defines the code of the reason code group to select the reason from. SD
reasonCode REASON String It defines the predefined reason code.
maxAmount MAX_AMOUNT Double It defines the maximum receipt amount without authorization. 500.0
allowCancelForGiftCertificateLineItems ALLOW_CANCEL_FOR_GIFT_CERT_POSITION Boolean It specifies whether it is allowed to void gift certificate line items. true
maxAmountAuthorizationConfig AuthorizationConfig It defines the authorization for the max amount check.
displayCouponsConfigId String Configuration for the Display Coupons process:

DisplayCouponsConfig
Note:
extends ProcessConfig
Table 3. TerminalPaymentOperationConfigs
Parameter Name Migration Data Type, Range Description Default
saleClosedEventsNotificationStyle saleClosedEventsNotificationStyle
  • NEVER
  • TERMINAL_PAYMENT
  • ALWAYS
 It defines how the terminal-specific command for closing the EFT transaction is triggered:
  • NEVER - Do not send a command.
  • TERMINAL_PAYMENT - The command is only sent when an EFT payment has been performed.
  • ALWAYS - The command is always sent.
 NEVER

Tender Line Item Cancellation - 01040100504

Functional Parameters

Table 4. VoidTenderLineItemConfig
Parameter Name Migration Data Type, Range Description Default
confirmVoiding ASK_SURENESS Boolean It specifies whether a confirmation prompt is displayed. true
confirmVoidingDialogConfig MessageDialogConfig
allowGiftCertVoiding Boolean It specifies whether it is allowed to void gift certificates. true
allowGiftCertVoidingOffline OFFLINE_ALLOWED_FOR_GIFT_CERT Boolean It specifies whether tender line items of the type "gift certificate" can be voided in offline situations. false
askForCrsAuthorization ASK_FOR_CRS_AUTHORIZATION Boolean It controls whether authorization is required in the case of error cancelations on the cash recycler (true, false). true
Note:
extends ProcessConfig

Void Receipt - 01040100604

Function Parameters

Table 5. VoidTransactionConfig
Parameter Name Migration Data Type, Range Description Default
reasonRequired REASON_REQUIRED Flag It specifies whether a reason is requested.
reasonCodePredefined String It defines a predefined reason code.
giftCertCancelAllowed ALLOW_CANCEL_ FOR_GIFT_CERT_POSITION Flag It specifies whether it is allowed to void gift certificate line items. true
receiptAgeAllowedInDays ALLOWED_DAYS Integer It defines the maximum age of the receipt (in days) up until which it can be voided. (0=unlimited, 1=today, 2=yesterday, etc.)

0: unlimited; The maximum age is not checked.

1: today; The receipt must have been created on the same day.

 0
infoDialogVoided MessageDialogConfig
warnDialogNotVoidable MessageDialogConfig
confirmDialog MessageDialogConfig
messageCashRefundConfig MessageDialogConfig This message indicates the refund amount in cash.
onlySamePosAllowed ONLY_SAME_POS_ALLOWED Flag It specifies whether voiding receipts of other workstations is allowed. The value "true" means that "Void receipt" is only possible if the receipt was created on the same cash register. false
openDrawer OPEN_DRAWER Flag (NEVER, ALWAYS) It specifies whether the cash drawer should be opened after the transaction was successfully voided.

true: ALWAYS; The drawer always opens.

false: NEVER; The drawer never opens.

 Always
cashDrawerConfig CashDrawerConfig It specifies whether the cash drawer should be opened after the transaction was voided.
findTransactionConfig FindTransactionConfig It defines the sub-process FindTransaction which retrieves the transaction to be voided.
transactionPreview TransactionPreviewContextConfig It defines the configuration for the transaction preview. The config parameters will be passed to the transaction preview component, controller, report and datasource.
Note:
extends ProcessConfig
Table 6. CashDrawerConfig
Parameter Name Data Type, Range Description
deviceName String It defines the device name e.g. action.openDrawer.deviceName=VirtualCashDrawer.
openAction CashDrawerOpenAction [ALWAYS, NEVER, TENDER] It defines the cash drawer open action.
messageKey String It defines the message key for the display message during the cash drawer open state.
deviceNotPresentErrorDialog MessageDialogConfig
deviceOutOfOrderErrorDialog MessageDialogConfig
Note:
extends ProcessConfig
Table 7. FindTransactionConfig
Parameter Name Data Type, Range Description Default
promptReceiptDataConfig PromptReceiptDataConfig It defines the config for the PromptReceiptData dialog.
resultType FindTransactionResultType [TRANSACTION, TRANSACTION_ID] It defines the data object which the parent process needs to get retrieved.

TRANSACTION: Retrieve Transaction

TRANSACTION_ID: Retrieve Transaction UUID
Table 8. PromptReceiptDataConfig
Parameter Name Migration Data Type, Range Description Default
processId String It specifies the unique process ID.
dialogTitleKey TranslationKey It specifies the key value for the prompt receipt data dialog title.
forceManualInput Boolean The input dialog will be shown even if all predefined values are filled.
businessUnitIdRequired Flag It specifies whether a business unit ID is returned and whether a business unit ID field is visible in the dialog. false
businessUnitIdEditable Flag It specifies whether the business unit ID field is editable. false
businessUnitIdPredefined IdentityUUID It specifies the predefined business unit ID.
businessUnitIdUseCurrent Flag It specifies whether a current business unit ID should be used if no predefined business unit ID is given. true
businessDayDateRequired DATE_REQUIRED Flag It specifies whether a business day date is returned and whether a business day date field is visible in the dialog. true
businessDayDateEditable DATE_CHANGEABLE Flag It specifies whether the business day date field is editable. true
businessDayDatePredefined DATE Date It specifies whether a predefined value is used for the business day date.
businessDayDateUseCurrent USE_CURRENT_DATE Flag It specifies whether the current business day date should be used if no predefined business day date is given. true
workstationIdRequired POS_REQUIRED Flag It specifies whether a workstation ID is returned and whether a workstation ID field is visible in the dialog. true
workstationIdEditable POS_CHANGEABLE Flag It specifies whether a workstation ID field is editable. true
workstationIdPredefined KASSNR IdentityAlphaNumeric It specifies whether a predefined value is used for the workstation ID.
workstationIdUseCurrent USE_CURRENT_POS Flag It specifies whether a current workstation ID should be used if no predefined workstation ID is given. true
receiptNumberRequired Flag It specifies whether a transaction sequence number is returned and whether a transaction sequence number field is visible in the dialog. true
receiptNumberEditable RECEIPT_NUMBER_ CHANGEABLE Flag It specifies whether a transaction sequence number field is editable. true
receiptNumberPredefined BELEGNR String It specifies whether a predefined transaction sequence number is used.
receiptNumberUseCurrent USE_LAST_RECEIPT_ NUMBER Flag It specifies whether a current transaction sequence number should be used if no predefined transaction number is given. true
useLastNonVoidedReceiptNumber Flag It specifies whether the last non-voided receipt number is used.
Table 9. TransactionPreviewContextConfig
Parameter Name Data Type, Range Description Default
templateName String This parameter defines the name of the report template.
horizontalPositioningType HorizontalPositioningType [

Char as "1",

Pixel as "2"]

 It specifies the unit for the "posX" and "width" values in the report template:
  • Char as "1": The positioning unit depends on character width
  • Pixel as "2": The positioning unit depends on pixel width
 Pixel
verticalLinePadding Integer It specifies additional vertical line padding. This value will be added to the calculated line height, based on the font metrics. If you define any background colors (bgColor) in your report template, you should define an additional vertical line padding.
verticalLineSpacing Integer This value will be subtracted from the height of an entry rectangle, which will cause an additional vertical line spacing between the painted entries.

The value must be smaller or equal to verticalLinePadding. Otherwise, the text will be cut. If you define any background colors (bgColor) in your report template, you can define a vertical line spacing between the lines.
considerScopeTransactions Boolean It sets whether scope transactions should be considered or not.

If true, the active main or scoped transaction will be processed and displayed; otherwise, only the mainTransaction.
showHeader Boolean It specifies whether the header should be displayed or not.
showTotals String[0..*] It specifies whether the total should be displayed or not.
rowSelectionAllowed Boolean It specifies whether row selection is allowed in general.
cellEditAllowed Boolean It specifies whether inline cell editing is allowed in general.
showReturnableQuantity Boolean It specifies whether the returnable quantity for a line item should be displayed or not.
showLastChangedRow Boolean It specifies whether the last changed row should be made visible.
editLastChangedRow Boolean It specifies whether the last changed row should be edited.
showSubtotalRounding Boolean It sets whether the subtotal rounding should be displayed or not.
showChangeRounding Boolean It sets whether the change rounding should be displayed or not.
showLineItems String It specifies whether the line items for the given type codes should be displayed or not.
selectableLineItems String It specifies whether line items for the given type codes are selectable or not.
editableLineItems String It specifies whether line items for the given type codes are editable inline (cell editors) or not.
Table 10. PaymentEndConfig
Parameter Name Data Type, Range Description Default
showRfidWarning Boolean It defines whether a warning should be shown in the event of errors during RFID reconciliation bookings. true
rfidErrorTableConfig TableConfig It defines the link to the table config for the configurable step controller that displays RFID items where voiding failed. TableConfigs.RfidItemTable
Table 11. WebServiceConfig.RfidWebServiceConfig
Parameter Name Data Type, Range Description Default
address String Address to the RFID webservice endpoint http://localhost:8090/PosService
timeout Int Receive timeout config in milliseconds 10000
connectionTimeout Int Connection timeout config in milliseconds 10000
username String Username for basic authentication, if required
password String Password for basic authentication, if required
Table 12. RfidConfig
Parameter Name Data Type, Range Description Default
serviceClassName String Specifies the RFID-specific implementation class of the interface com.gk_software.pos.api.hal.device.rfid.Rfid com.gk_software.pos.plugin.rfid.hal.device.detego.DetegoRfidImpl
webServiceConfigID string ID used to locate the webservice configuration instance to be used for communication with RFID services WebServiceConfig.RfidWebServiceConfig
enableBatchProcessing Boolean If enabled, multiple items in a request will be sent in one batch to the RFID service. Otherwise, each item is sent individually false