Order Information Service Functions and Extensibility Arguments

The Order Information Service supports three functions:

• Assign

• Close

• CloseAllChecks

Each function must contain a set of arguments. The following tables describe the extensibility arguments that you must include for each function. Each argument is required unless otherwise indicated.

Table 55-3 Assign Function Arguments

Argument	Description	Example
ID=	Enter anything here (for example, Assigned, AssignedToRunner, TransferredToRunner). This text is visible when Transaction Services queries the check.	ID=Assigned
(Optional) MultipleChecks=	To include this argument, set the value to true, and the function refers to Assign Multiple Checks. To exclude this argument, set the value to false, and the function refers to Assign Single Check.	MultipleChecks=true
ServiceTotalNumber=	Enter the object number of the Tender/Media record used when performing the operation (such as the tender used for Service Total).	ServiceTotalNumber=51

An example of the arg value for the Assign function is ID=Assigned,MultipleChecks=true,ServiceTotalNumber=51

Table 55-4 Close Function Arguments

Argument	Description	Example
Reason=	Enter anything here. This text is visible when Transaction Services queries the check.	Reason=Delivered
PaymentNumber=	Enter the object number of the Tender/Media record used when performing the operation.	PaymentNumber=3
(Optional) VoidParams=	Use this argument to indicate which items to remove from the check before closing it. For example, to delete all items in family groups 1, 2 and 5, set the value to FG:1:2:5. FG indicates Family Group. (This is the only recognized value type.) Use FG=* to void all items. If you exclude this argument, the function does not allow voids.	VoidParams=FG:10:11:15:16:30:31:32
(Optional) OrderTypeFilter=	Use this filter to close checks for the tender set in the payment argument and by a specific order type. If you exclude this argument, the function includes all order types that can use the payment tender.	OrderTypeFilter=2

An example of the arg value for the Close function is Reason=Delivered,PaymentNumber=3,VoidParams=FG:10:11:15:16:30:31:32,OrderTypeFilter=2

Table 55-5 CloseAllChecks Function Arguments

Argument	Description	Example
Reason=	Enter anything here. This text is visible when Transaction Services queries the check.	Reason=Delivered
PaymentNumber=	Enter the object number of the Tender/Media record used when performing the operation.	PaymentNumber=3
(Optional) OrderTypeFilter=	Use this filter to close checks for the tender set in the payment argument and by a specific order type. If you exclude this argument, the function includes all order types that can use the payment tender.	OrderTypeFilter=2
(Optional) EmployeeFilter=	Use this filter to close checks for the tender set in the payment argument and by a specific employee. For example, a Transaction Services user creates the checks, so including this employee in the argument closes only the Transaction Services checks. If you exclude this argument, the function closes all employees’ checks.	EmployeeFilter=2

An example of the arg value for the CloseAllChecks function is Reason=Delivered,PaymentNumber=3,EmployeeFilter=2