Layaway - 014001

Not Supported: MPOS Size M MPOS Size S ONEX Stationary POS

Creation of Layaway - 01400100256

LayawayConfig

Parameter Name Data Type, Range Description Default
prefix String The parameter specifies the barcode prefix of the down payment receipt. 002

CreateLayawayConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
allowedItemNrEanList String [0 ..*] 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.
allowedMhgList String [0 ..*] 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.
positionOperationConfig positionOperationConfig
Payment Rates
initialDownPayment Double The parameter defines the initial down payment amount in %. 20.00
initialFixAmount Double The parameter defines the initial down payment amount as a fixed amount in the main currency. 0.00
Payment Plan Settings
layawayValidDays Integer The parameter defines the validation time of the layaway in days to calculate the final payment date based on the current date.

Example: Today's date = 13.02.2018, layawayValidDays = 28, final payment date = 13.03.2018

 28
layawayValidDate Date The parameter defines the validation date of the layaway independent from the creation date of the layaway.

If this parameter <> null, the value of the parameter layawayValidDays is not used.

Format: YYYY-MM-DD, e.g.: 2019-09-27

Example:

  • Today's date = 01.10.2019, layawayValidDate = 31.10.2019, final payment date = 31.10.2019
  • Today's date = 03.10.2019, layawayValidDate = 31.10.2019, final payment date = 31.10.2019
paymentDays Integer The parameter defines how often a payment should be made, e.g. every 7 days or every 14 days

Example: Today's date = 13.02.2018, paymentDays=7, payment dates = 20.02.2018, 27.02.2018, 06.03.2018, 13.03.2018

 7
toleranceTime Integer The parameter defines how many days the final payment rate can be paid later than expected to calculate the latest final payment date. If 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

 3
deletingTime Integer 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 the expired layaway) can be performed.

Example: final expiration date = 01.03.2018, deletingTime = 200, deleting date = 17.09.2018

 200
Fees
serviceFeePercent Double The parameter defines the service fee in %. 10
serviceFeeAmount Double The parameter defines the amount of the service fee. 0
cancellationFeePercent Double The parameter defines the cancellation fee in % which is calculated if the layaway is voided. 5
cancellationFeeAmount Double The parameter defines the amount of the cancellation fee which is calculated if the layaway is voided. 0
penaltyFeePercent Double The parameter defines the percentage from the total layaway amount which is calculated if the calculated payment date (defined by the parameter layawayValidDays) + the tolerance time (defined by the parameter toleranceTime) has expired. 5
penaltyFeeAmount Double The parameter defines the fixed amount which is calculated if the calculated payment date (defined by the parameter layawayValidDays) + the tolerance time (defined by the parameter toleranceTime) has expired. 0
feeTaxGroupId String The parameter defines the tax group of several fees.

CustomerIdentificationConfig

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

CustomerSearch

 It defines the customer entry 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 entry process.
customerSearchConfigId String It defines the configuration for the customer search.

Down Payment Layaway - 01400100226

LayawayConfig

Parameter Name Data Type, Range Description Default
prefix String The parameter specifies the barcode prefix of the down payment receipt. 002

DownpaymentLayawayConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
minAmountFix Double The parameter defines the minimum down payment amount. 10
minAmountPercent Double The parameter defines the minimum down payment in percent. 10
createDownpayment Boolean The parameter defines if a negative or a positive down payment line item is created. There are the following values:
  • true: A down payment with a positive line item is created.
  • false: A refund with a negative line item is created.
 true
amount Double The parameter defines the amount of the Layaway Down Payment.
maximumRefundAmountPercent Double The parameter defines the maximum amount of money the customer is allowed to receive when a down payment is refunded. The value is expressed as a percentage of the already paid down payment amount. 30.0

Extend Layaway Expiration Date - 01400100006

ExtendExpirationDateLayawayConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
expirationMaxDays Integer The parameter defines the maximum number of days allowed for extension of the layaway. 7

Final Payment Layaway - 01400100230

LayawayConfig

Parameter Name Data Type, Range Description Default
prefix String The parameter specifies the barcode prefix of the down payment receipt. 002

FinalPaymentLayawayConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
promotionHandling String [BEST_PRICE, INITIAL_PRICE, FINAL_PRICE] The parameter controls the promotion behavior for the final payment of the layaway. Possible values are:
  • BEST_PRICE: The layaway price should be the best price between the one calculated at the time of the creation and the one calculated at the time of the final payment.
  • INITIAL_PRICE: The layaway price should be the price calculated at the time of creation.
  • FINAL_PRICE: The layaway price should be the price calculated at the time of the final payment.
 BEST_PRICE

Retrieve Layaway - 01400100257

RetrieveLayawayConfig

Note:
extends ProcessConfig

Retrieve Money From Expired Layaway - 01400100003

LayawayConfig

Parameter Name Data Type, Range Description Default
prefix String The parameter specifies the barcode prefix of the down payment receipt. 002

RetrieveMoneyLayawayConfig

Note:
extends ProcessConfig

Validation Process Layaway - 01400100005

ValidationLayawayConfig

Note:
extends ProcessConfig

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

PromptReceiptDataConfig

Parameter Name Data Type, Range Description Default
dialogTitleKey TranslationKey It specifies the key value for the prompt receipt data dialog title.
businessUnitIdRequired Flag It specifies whether a business unit ID is returned and whether a business unit ID field is visible in the dialog. true
businessUnitIdEditable Flag It specifies whether the business unit ID field is editable. true
businessUnitIdPredefined IdentityUUID It specifies the predefined business unit ID. If scanned from barcode
businessUnitIdUseCurrent Flag It specifies whether a current business unit ID should be used if no predefined business unit ID is given. true
businessDayDateRequired Flag It specifies whether a business day date is returned and whether a business day date field is visible in the dialog. true
businessDayDateEditable Flag It specifies whether the business day date field is editable. true
businessDayDatePredefined Date It specifies whether a predefined value is used for the business day date. If scanned from barcode
businessDayDateUseCurrent Flag It specifies whether the current business day date should be used if no predefined business day date is given. false
workstationIdRequired Flag It specifies whether a workstation ID is returned and whether a workstation ID field is visible in the dialog. true
workstationIdEditable Flag It specifies whether a workstation ID field is editable. true
workstationIdPredefined IdentityAlphaNumeric It specifies whether a predefined value is used for the workstation ID. If scanned from barcode
workstationIdUseCurrent Flag It specifies whether a current workstation ID should be used if no predefined workstation ID is given. false
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 Flag It specifies whether a transaction sequence number field is editable. true
receiptNumberPredefined String It specifies whether a predefined transaction sequence number is used. If scanned from barcode
receiptNumberUseCurrent Flag It specifies whether a current transaction sequence number should be used if no predefined transaction sequence number is given. false

Void Layaway - 01400100004

LayawayConfig

Parameter Name Data Type, Range Description Default
prefix String The parameter specifies the barcode prefix of the down payment receipt. 002

VoidLayawayConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
takeoverCompleteLayaway Boolean The parameter defines whether the Layaway is completely voided or whether it is possible to select individual line items for voiding. false