Commands reference guide

Closes the current batch. This is the same as a blind closeout. No parameters.

Invokes the Closing Amounts dialog. No parameters.

Invokes the Opening Amounts dialog. No parameters.

Performs a blind closeout. No parameters.

Adds a charge without using a charge template (defined in Store Manager under Setup | Inventory/Purchasing | Charges).

The command takes an optional parameter of the charge code and price, separated by a pipe (|): {Charge Code}|{Price}.

If a parameter is not provided, the command invokes the Charge Lookup dialog and prompts for the price.

Example:

Adds charge code and price:

Charge_AddNoTemplateCommand "CH|15.10"

Adds a customer to the transaction. Requires the mandatory parameter {Customer Account Number}.

Example:

Customer_AddCommand "000005"

Clears the current customer from the transaction. No parameters.

Displays a dialog with the current customer's purchase history. No parameters.

Invokes the Customer dialog where you can edit the customer. No parameters.

Adds a customer to the transaction.

The command takes an optional parameter of {Customer Account Number}.

If a parameter is not provided, or the customer account number is not found, the command invokes the Customer Lookup dialog with a list of customers fitting the search criteria.

Example:

Adds a customer with account number “000005” to the transaction:

Customer_LookupCommand "000005"

Invokes the Customer Lookup dialog with the search criteria "Jon":

Customer_LookupCommand "Jon"

Invokes the Create New Customer Wizard dialog where you can create a new customer. No parameters.

Invokes the Account Payment dialog for the selected accounts receivable customer. No parameters.

Invokes the Discount Menu dialog. No parameters.

The following commands apply a discount to all items that are currently in the transaction.

Note: Discounts are not applied to items that are added after an all items command is used.

Removes any discount applied to all items currently in the transaction. No parameters.

Applies a dollar amount discount from the current price to all items currently in the transaction.

The command takes an optional parameter {Discount Amount}. If a parameter is not provided, the command invokes the Discount dialog and prompts for the dollar amount.

Starting with release 3.11.12, the command also takes an optional parameter {Reason Code}. If the {Reason Code} parameter is provided the reason code is applied automatically to the item or transaction. The {Discount Amount} and {Reason Code} must be separated by a pipe (|).

Example:

Apply a discount of $10 dollars to the current price for all items currently in the transaction:

DiscountAllItems_SetAmountFromCurrentPriceCommand "10"

Apply the RC01 reason code:

DiscountAllItems_SetAmountFromCurrentPriceCommand "10|RC01"

Applies a percentage discount from the current price to all items currently in the transaction.

The command takes an optional parameter {Percentage Discount}. If a parameter is not provided, the command invokes the Discount dialog and prompts for the percentage.

Starting with release 3.11.12, the command also takes an optional parameter {Reason Code}. If the {Reason Code} parameter is provided the reason code is applied automatically to the item or transaction. The {Percentage Discount} and {Reason Code} must be separated by a pipe (|).

Example:

Apply a 10% discount to the current price for all items currently in the transaction:

DiscountAllItems_SetPercentFromCurrentPriceCommand "10"

Apply the RC01 reason code:

DiscountAllItems_SetPercentFromCurrentPriceCommand "10|RC01"

Sets the transaction subtotal amount by proportionally discounting the transaction items.

The command takes an optional parameter {Target Subtotal Amount}. If a parameter is not provided, the command invokes the Discount dialog and prompts for the dollar amount.

Starting with release 3.11.12, the command also takes an optional parameter {Reason Code}. If the {Reason Code} parameter is provided the reason code is applied automatically to the item or transaction. The {Target Subtotal Amount} and {Reason Code} must be separated by a pipe (|).

Example:

Set the subtotal amount to $20 by discounting all items proportionally:

DiscountAllItems_SetSubtotalAmountCommand "20"

Apply the RC01 reason code:

DiscountAllItems_SetSubtotalAmountCommand "20|RC01"

Applies Price Level A to all items currently in the transaction. No parameters.

Applies Price Level B to all items currently in the transaction. No parameters.

Applies Price Level C to all items currently in the transaction. No parameters.

Removes the price level from all items currently in the transaction. No parameters.

The following commands apply a discount to the currently selected item.

Applies a dollar amount discount to the current price for the currently selected item.

The command takes an optional parameter {Discount Amount}. If a parameter is not provided, the command invokes the Discount dialog and prompts for the dollar amount.

Starting with release 3.11.12, the command also takes an optional parameter {Reason Code}. If the {Reason Code} parameter is provided the reason code is applied automatically to the item or transaction. The {Discount Amount} and {Reason Code} must be separated by a pipe (|).

Example:

Apply a discount of $10 dollars to the current price for the currently selected item:

DiscountCurrentItem_SetAmountFromCurrentPriceCommand "10"

Apply the RC01 reason code:

DiscountCurrentItem_SetAmountFromCurrentPriceCommand "10|RC01"

Removes any applied discount from the selected item. No parameters.

Applies a percentage discount to the current price for the currently selected item.

The command takes an optional parameter {Discount Percentage}. If a parameter is not provided, the command invokes the Discount dialog.

Starting with release 3.11.12, the command also takes an optional parameter {Reason Code}. If the {Reason Code} parameter is provided the reason code is applied automatically to the item or transaction. The {Discount Percentage} and {Reason Code} must be separated by a pipe (|).

Example:

Apply a 10% discount to the current price for the currently selected item:

DiscountCurrentItem_SetPercentFromCurrentPriceCommand "10"

Apply the RC01 reason code:

DiscountCurrentItem_SetPercentFromCurrentPriceCommand "10|RC01"

Applies a percentage discount to the retail price for currently selected item.

The commend takes an optional parameter {Discount Percentage}. If a parameter is not provided, the command invokes the Discount dialog.

Starting with release 3.11.12, the command also takes an optional parameter {Reason Code}. If the {Reason Code} parameter is provided the reason code is applied automatically to the item or transaction. The {Discount Percentage} and {Reason Code} must be separated by a pipe (|).

Example:

Apply a 10% discount to the retail price for the currently selected item:

DiscountCurrentItem_SetPercentFromRetailPriceCommand "10"

Apply the RC01 reason code:

DiscountCurrentItem_SetPercentFromRetailPriceCommand "10|RC01"

Sets the profit margin for the currently selected item.

The command takes an optional parameter {Profit Margin Percentage}. If a parameter is not provided, the command invokes the Discount dialog.

Starting with release 3.11.12, the command also takes an optional parameter {Reason Code}. If the {Reason Code} parameter is provided the reason code is applied automatically to the item or transaction. The {Profit Margin Percentage} and {Reason Code} must be separated by a pipe (|).

Example:

Sets a 10% profit margin for the currently selected item:

DiscountCurrentItem_SetProfitMarginCommand "10"

Apply the RC01 reason code:

DiscountCurrentItem_SetProfitMarginCommand "10|RC01"

Applies Price Level A to the currently selected item. No parameters.

Applies Price Level B to the currently selected item. No parameters.

Applies Price Level C to the currently selected item. No parameters.

Removes any Price Level from the currently selected item. No parameters.

Use following commands to apply a discount to all items that are currently in the transaction or will be added later.

Removes the transaction discount. No parameters.

Applies a percentage discount to the minimum price for the transaction.

The command takes an optional parameter {Discount Percentage}. If a parameter is not provided, the command invokes the Discount dialog.

Starting with release 3.11.12, the command also takes an optional parameter {Reason Code}. If the {Reason Code} parameter is provided the reason code is applied automatically to the item or transaction. The {Discount Percentage} and {Reason Code} must be separated by a pipe (|).

Example:

Apply a 10% discount to the minimum price for the transaction:

DiscountTransaction_SetFromMinimumPriceCommand "10"

Apply the RC01 reason code:

DiscountTransaction_SetFromMinimumPriceCommand "10|RC01"

Applies a percentage discount to the retail price for the transaction.

The command takes an optional parameter {Discount Percentage}. If a parameter is not provided, the command invokes the Discount dialog.

Starting with release 3.11.12, the command also takes an optional parameter {Reason Code}. If the {Reason Code} parameter is provided the reason code is applied automatically to the item or transaction. The {Discount Percentage} and {Reason Code} must be separated by a pipe (|).

Example:

Apply a 10% discount to the retail price for the transaction:

DiscountTransaction_SetFromRetailPriceCommand "10"

Apply the RC01 reason code:

DiscountTransaction_SetFromRetailPriceCommand "10|RC01"

Sets the transaction markup from cost.

The command takes an optional parameter{Markup Percentage}. If a parameter is not provided, the command invokes the Discount dialog.

Starting with release 3.11.12, the command also takes an optional parameter {Reason Code}. If the {Reason Code} parameter is provided the reason code is applied automatically to the item or transaction. The {Markup Percentage} and {Reason Code} must be separated by a pipe (|).

Example:

DiscountTransaction_SetMarkupFromCostCommand "10"

Apply the RC01 reason code:

DiscountTransaction_SetMarkupFromCostCommand "10|RC01"

Sets the transaction profit margin.

The command takes an optional parameter {Profit Margin Percentage}. If a parameter is not provided, the command invokes the Discount dialog.

Starting with release 3.11.12, the command also takes an optional parameter {Reason Code}. If the {Reason Code} parameter is provided the reason code is applied automatically to the item or transaction. The {Profit Margin Percentage} and {Reason Code} must be separated by a pipe (|).

Example:

DiscountTransaction_SetProfitMarginCommand "10"

Apply the RC01 reason code:

DiscountTransaction_SetProfitMarginCommand "10|RC01"

Sets the transaction price level to Price Level A. No parameters.

Sets the transaction price level to Price Level B. No parameters.

Sets the transaction price level to Price Level C. No parameters.

Initiates a cash drop and invokes the Drop dialog. No parameters.

Adds an item to a transaction.

The command takes a parameter {Item Lookup Code}.

Example:

Adds an item with the item lookup code 12345678 to the transaction:

Item_AddCommand "12345678"

Adds a comment to the currently selected item.

The command takes an optional parameter {Comment Text}.

If a parameter is not provided, the command invokes the Item Comment dialog.

Example:

Item_AddCommentCommand "My comment on this item"

Clears all items in the transaction. No parameters.

Deletes an item from the transaction.

The command takes a parameter {Item Lookup Code}.

If a parameter is not provided, the command deletes the selected item(s).

Example:

Deletes item 12345678 from the transaction, if found:

Item_DeleteCommand "12345678"

Deletes the currently selected item(s) from the transaction:

Item_DeleteCommand

Duplicates an item in the transaction.

The command takes a parameter {Item Lookup Code}.

If a parameter is not provided, the commnd duplicates the selected item.

Example:

Duplicates item 12345678 in the transaction, if found:

Item_DuplicateCommand "12345678"

Duplicates the currently selected item in the transaction:

Item_DuplicateCommand

Invokes the Item Action dialog for the selected item. No parameters.

Invokes the Item Price Checker dialog in POS.

Note: The Item Price Checker dialog can only be used to check prices for standard items. It cannot be used to check prices for matrix, lot matrix, or assembly items.

The command takes an optional parameter {ON}.

If the parameter is provided, the Item Price Checker dialog will display on net display if net display is enabled for the register. If the parameter is not provided, the dialog will not display on net display.

Example:

Displays the dialog on net display if net display is enabled for the register:

Item_InvokeItemPriceCheckerDialogCommand ON

Invokes the Item Lookup dialog.

The command takes an optional parameter{Search Criteria}, which may be a combination of item lookup code, description etc.

If a parameter is not provided, the command invokes the Item Lookup dialog without any search criteria.

Example:

Invokes the Item Lookup dialog with search criteria "123 My":

Item_LookupCommand "123 My"

Applies the destination tax based on the shipping address. No parameters.

Makes the transaction tax free. No parameters.

Invokes the Select Tax dialog for the currently selected item. No parameters.

Invokes the Select Tax for the transaction. No parameters.

Toggles item tax on/off for the selected item(s). No parameters.

Adds a comment to an order.

The command takes an optional parameter {Comment Text}.

If a parameter is not provided, the commend invokes the Order Comment dialog.

Example:

Order_AddCommentCommand "Order comment"

Invokes the Enter Deposit dialog. No parameters.

Overrides the order deposit with a percentage of the order total.

The command takes a parameter {Deposit Percentage}.

Usage:

Override the order deposit with 10% of order total:

Order_OverrideDepositPercentageCommand "10"

Overrides the order deposit with an amount.

The command takes a parameter {Deposit Amount}.

Example:

Override the order deposit with an amount of $100:

Order_OverrideDepositAmountCommand "100"

Invokes the Order Due Date dialog. No parameters.

Invokes the Recall Work Order dialog where you can select a work order. No parameters.

Invokes the Recall Quote dialog where you can select a quote. No parameters.

Invokes the Recall Back Order dialog where you can select a back order. No parameters.

Invokes the Recall Layaway dialog where you can select a layaway. No parameters.

Applies a reason code to the currently selected item.

The command takes a parameter {Reason Code}.

Example:

Apply the RMI01 reason code to the selected item:

ReasonCode_SetReasonCodeForCurrentItemCommand "RMI01"

Applies a reason code to an item, using the transaction item key and the reason code.

Example:

Apply the RC01 reason code to an item with the item key "2":

ReasonCode_SetReasonCodeForItemCommand "2|RC01"

Applies a reason code to the transaction.

The command takes a parameter {Reason Code}.

Example:

Apply the RMI01 reason code to the transaction:

ReasonCode_SetReasonCodeForTransactionCommand "RMI01"

Prints the X report. No parameters.

Prints the Z report. No parameters.

Prints the ZZ report. No parameters.

Reprints the last receipt. No parameters.

Reprints the last receipt as a gift receipt. The receipt template must be configured to contain a gift receipt section. No parameters.

Initiates the process of reprinting the last receipt using a different template. No parameters.

Clears custom message from a receipt session variable.

The command takes a parameter {Session Variable Number.}

Example:

Clears session variable1:

ReceiptMessage_RemoveCustomMessageCommand "1"

Applies a sales representative to the currently selected item.

The command takes an optional parameter {Sales Representative Number}.

If a parameter is not provided, or the number is not found, the command Invokes the Sales Rep Lookup dialog where you can select a sales representative.

Example:

Apply the sales representative “001” to the currently selected item:

SalesRep_SetForCurrentItemCommand "001"

Applies a sales representative to the transaction.

The command takes an optional parameter {Sales Representative Number}.

If a parameter is not provided, or the number is not found, the command Invokes the Sales Rep Lookup dialog where you can select a sales representative.

Example:

Apply the sales representative “002” to the transaction:

SalesRep_SetForTransactionCommand "002"

Removes the assigned sales representative from the currently selected item. No parameters.

Initiates the tendering process.

Tenders a specific tender type (by tender code) with a specified amount.

The command takes two parameters {Tender Code} and {Decimal Amount} separated by a pipe (|).

Example:

Tender a transaction using tender type CSH with an amount $10.25;

Tender_FixedAmountCommand "CSH|10.25"

Starting with release 3.11.20, this command executes the Loyalty program, if applicable, so customers can earn or redeem points on the transaction. The command also opens the Tender Dialog because, at the time the command is executed, the amount of the Loyalty discount is not known.

Cancels the transaction and controls whether the application is closed or not.

The command takes the optional parameters {True} or {False} or blank.

Example:

Cancel the transaction and close the application:

Transaction_CancelTransactionCommand "True"

Or:

Transaction_CancelTransactionCommand

Cancel the transaction and do not close the application:

Transaction_CancelTransactionCommand "False"

Changes the transaction to a layaway. No parameters.

Changes the transaction to quote. No parameters.

Changes the transaction to work order. No parameters.

Adds a comment to the transaction .

The command takes an optional parameter {Comment Text}.

If a parameter is not provided, the command invokes the Transaction Comment dialog.

Example:

Transaction_AddCommentCommand "Comment text"

Changes the transaction to return transaction. No parameters.

Changes the transaction from return to sale. No parameters.

Puts the current transaction on hold. No parameters.

Invokes the Tender dialog and initiates the tendering process. No parameters. Similar to Tender_BeginCommand.

Toggles net display on/off. Net display must be enabled in Store Manager.

The command takes the parameters {ON} or {OFF}.

If a parameter is not provided, the command toggles the net display on/off.

Example:

Turn on net display:

Transaction_NetDisplayCommand "ON"

Turn off net display:

Transaction_NetDisplayCommand "OFF"

Toggle net display on/off:

Transaction_NetDisplayCommand

Performs a no sale transaction. No parameters.

Initiates the recall for return process. No parameters.

Initiates the recall for void process. No parameters.

Recalls a transaction from hold. No parameters.

Toggles the transaction return mode on/ff. No parameters.