MES Stateless API

GetByFilter(String,String,Boolean,Boolean,Boolean) Method

Save PDF

GetByFilter(String,String,Boolean,Boolean,Boolean) Method

Save PDF

Last UpdatedNov 06, 2025
2 minute read

The GetByFilter() method retrieves all of the sales order line item records from the SO_Line table of the specified sales order.

A sales order is uniquely identified by the combination of the customer ID and purchase order ID.

The condition of the sales order state can be used to filter the sales order. For this overload of the method, the sales order can be filtered based on the sales order states.

Syntax

'Declaration
 
Public Overloads Shared Function GetByFilter( _
   ByVal custId As String, _
   ByVal poId As String, _
   ByVal openOrders As Boolean, _
   ByVal partialOrders As Boolean, _
   ByVal completeOrders As Boolean _
) As DataSet

'Usage
 
Dim custId As String
Dim poId As String
Dim openOrders As Boolean
Dim partialOrders As Boolean
Dim completeOrders As Boolean
Dim value As DataSet
 
value = SoLine.GetByFilter(custId, poId, openOrders, partialOrders, completeOrders)

public static DataSet GetByFilter( 
   string custId,
   string poId,
   bool openOrders,
   bool partialOrders,
   bool completeOrders
)

Parameters

custId: Required. Holds the customer ID.
poId: Required. Holds the ID of the customer's purchase order.
openOrders: Required. Holds the flag that indicates whether the sales order must be in the open state. A sales order is open when no item quantities have been recorded as shipped.
partialOrders: Required. Holds the flag that indicates whether the sales order must be in the partially completed state. A sales order is partial when some item quantities but not all required quantities of all items in the sales order have been recorded as shipped.
completeOrders: Required. Holds the flag that indicates whether the sales order must be in the completed state. A sales order is complete when all required quantities of all items in the sales order have been recorded as shipped.

Return Value

Returns a DataSet that contains records for all the sales order line items of the specified sales order.

In addition, the returned records are only for customers (that is, for those records in the Cust table for which the customer flag is true, regardless of the vendor flag setting)

The returned records include columns from the SO_Line and Item tables. If no matching sales order line items are found or if no matching sales order states are found for any customers, an empty DataSet is returned.

The columns of the returned DataSet are described below.

Column Names	Description
so_line_no	An integer that is the line number in the sales order, from the SO_Line table.
item_id	A string that is the ID of the item being ordered, from the SO_Line table.
item_desc	A string that is the description of the item being ordered, from the Item table.

MES Stateless API