Suspending - 011601

Retrieve Receipt - 01160100603

Limited Support: MPOS Size M

RetrieveTransactionsConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
retrieveMode RetrieveMode [

SelectionList as "SELECTION_LIST",

SuspendingNumber as "SUSPENDING_NUMBER"

DetailList as "DETAIL_LIST"]

 It defines the method for selecting the receipts to be retrieved.
  • SelectionList: Picklist
  • SuspendingNumber: Suspend number
  • DetailList: List from function Receipt Selection - 01990100617 v5.8
multiSelection Boolean It controls whether multiple selection and retrieval of suspended receipts is possible from a picklist. false
suspendNumber IdentityAlphaNumeric40 It defines the suspend number. It can be used for multiple transactions.
customerIdentificationConfig CustomerIdentificationConfig It defines whether and how the customer is identified.
promptSuspendNumberConfig PromptUserDialogConfig It defines the config for the suspend number prompt dialog.
allowOtherStores Boolean It specifies whether it is allowed to retrieve a receipt from other stores. true
storeId String It defines the Store ID.
overtakeCustomer FromOriginalReceipt Boolean It specifies whether the customer data is transferred from the suspended receipt. true
retrieveSelfScanning TransactionsOnly Boolean It specifies whether the search only considers suspended Self Scanning transactions. false
promotionHandling NewDiscounts

OldDiscounts

 It defines how promotions are handled when retrieving a transaction.
  • NewDiscounts - Promotions will be overtaken from a suspended transaction but can be removed by the Loyalty Engine.
  • OldDiscounts - Promotions will be overtaken from a suspended transaction but cannot be removed by the Loyalty Engine.
 NewDiscounts
displayBuyerTransactions Boolean It defines whether all suspended receipts of the buyer or all suspended receipts of the customer are displayed. true
retrieveOnly Boolean It specifies whether the payment mask is displayed directly after one or more suspended receipts were selected for retrieval. false
consolidateLineItemsRetrieve Boolean The parameter defines whether the consolidation of retrieving transactions should be executed. false
consolidateReturnItems Boolean The parameter controls whether items with SaleReturnLineItem.ActionCode = RI should be consolidated or not.

See Item Consolidation - 01000100014

 false
historyTransactionDayCount Integer It defines the maximum age of transactions in days. If the limit is not needed, the value should be set to "0". 30
rescanRFIDItems Boolean Defines whether RFID tracked items have to be scanned again after retrieving a suspended transaction. false

CustomerIdentificationConfig

Parameter Name Migration Data Type, Range Description Default
customerCardType String It defines the required customer card type. CO
customerIdentificationFunction CustomerRegistration

CustomerSearch

 It defines the customer registration function. CustomerRegistration
customerRequired Boolean It controls whether it is necessary to enter a customer. If a customer is required, only receipts of this customer can be retrieved. false
customerRequiredAudibleAlert Boolean It defines whether an acoustic signal is triggered before the customer identification function is called. false
customerRequiredMessage String It defines the message that is displayed if the customer is missing.
retrieveCustomerId Boolean
customerRegistrationConfigId String It defines the configuration for the customer registration process.
customerSearchConfigId String It defines the configuration for the customer search process.
Parameter Name Data Type, Range Description Default
rescanEnabled Boolean The parameter defines whether rescans should be performed in general or not. false

Suspend Code - 01160100604

SuspendCodeConfig

Parameter Name Data Type, Range Description Default
errorAllowed Boolean The parameter defines the handling of items which are not allowed to be entered:
  • true: The not-allowed items are listed after the retrieve process in the table of skipped items. The other items are retrieved as normal.
  • false: The not-allowed items are not retrieved. A corresponding warning dialog is displayed and the retrieval process is aborted.
 true

dynamicTableConfig

Note:
extends ProcessConfig

For this function, the dynamicTableConfig is available. The visibility of the columns can be configured there.

There is also the option to select multi-selection.

Suspend Receipt - 01160100602

SuspendTransactionConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
questionForSuspending Boolean It controls whether a confirmation prompt is displayed before suspending the receipt. true
manualSuspendingNumber Boolean It controls whether the suspend number is assigned manually (by manual entry/scanning) or automatically. false
prefix String It specifies the barcode prefix of the suspended receipt. 777
suspendNumber IdentityAlphaNumeric40 It defines the number for suspending and can be used for multiple transactions.
allowSuspendingWithPaymentCash Boolean It specifies whether it is possible to suspend a receipt with non-voided cash payments.

This parameter equally applies to payments with and without a cash recycler.

If this is allowed, cash payments will be automatically canceled before the receipt is suspended.

 false
customerIdentificationConfig CustomerIdentificationConfig It defines whether and how the customer is identified.
promptSuspendNumberConfig PromptUserDialogConfig It defines the config for the suspend number prompt dialog.
positionOperationConfig PositionOperationConfig It defines the config for the suspend operation.
displayYesPrintButton Boolean It defines whether the button "Ja - Druck" is visible in the Decision confirm_suspending dialog. false
suspendedLineItemEditable Boolean It defines whether suspended line items will be marked as non-editable. true
preCommissioningMode Boolean It activates the addition of a service fee. false
preCommissioningServiceTaxGroupID Alphanum. It defines the TaxGroupID for the service item, if needed. <empty>
preCommissioningThresholdList String[0..*] It defines a list of thresholds for pre-commissioning. 0;200;1000
preCommissioningTypeCode PS/TP It defines whether a percentage of the total or an absolute value is set as the price for the service item.

Possible values:

  • 'PS' (= price single - for setting a single price, depending on the threshold)
  • 'TP' (= total percent - for setting the price as a percentage of the total)
 PS
preCommissioningValue String[0..*] It defines a list of absolute values (PreCommissioningTypeCode = 'PS') or percentage rates (PreCommissioningTypeCode = 'TP'). 10;25;50
preCommissioningRoundMethod NO_ROUNDING (00),

ROUND_HALF_UP (01),

ROUND_DOWN (02),

ROUND_UP (03),

ROUND_HALF_DOWN (04)

 It defines the rounding rule in the case of PreCommissioningTypeCode = 'TP'. 02
consolidateLineItemsSuspending Boolean The parameter defines whether the consolidation of suspending transactions should be executed. false
printSuspendCode Boolean If defines whether an AZTEC suspend code is printed, which contains basic item information from the transaction for offline retrieval.
Note:
The code will only be printed on an A4 receipt. To do so, A4 printing must be enabled.
 false
consolidateReturnItems Boolean The parameter controls whether items with SaleReturnLineItem.ActionCode = RI should be consolidated or not.

See Item Consolidation - 01000100014

 false

CustomerIdentificationConfig

Parameter Name Data Type, Range Description Default
customerCardType String It defines the required customer card type. CO
customerIdentificationFunction CustomerRegistration

CustomerSearch

CustomerDataEntry

 It defines the customer registration function. CustomerRegistration
customerRequired Boolean It controls whether it is necessary to enter a customer. If a customer is required, only receipts of this customer can be retrieved. false
customerRequiredAudibleAlert Boolean It specifies whether an acoustic signal is triggered before the customer identification function is called. false
customerRequiredMessage String It defines the message that is displayed if the customer is missing.
retrieveCustomerId Boolean
customerRegistrationConfigId String It defines the configuration for the customer registration process.
customerSearchConfigId String It defines the configuration for the customer search process.
customerDataEntryConfigId String It defines the configuration for the CustomerDataEntry process. It is only in use if customerIdentificationFunction is set to CustomerDataEntry.

TerminalPaymentOperationConfigs

Parameter Name Data Type, Range Description Default
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

CustomerSpecificPricesConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
enableCustomerSpecificPrices Boolean The parameter defines whether customer-specific prices should be applied and be displayed in the Item Info. false
dataProviderCustomerSpecificPriceService String The parameter specifies the data provider for retrieving the customer-specific prices:
  • LOCAL: The local customer-specific prices stored in the master data are used.
  • WEBSERVICE: A web service (configured centrally) is used to retrieve the customer-specific prices.
 LOCAL
customerSpecificPriceCardType String The parameter defines the customer card type which should be used for the customer-specific prices. CO