MES Stateless API

GetByFilter(String,String,String) Method

Save PDF

GetByFilter(String,String,String) 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 filter is based on the sales order state settings that have been saved for a user to the UI_Config table. Thus, a user ID is required to identify which sales orders to retrieve.

The settings in the Customer Filter window are:

Complete sales orders: All required quantities of all items in the sales order have been recorded as shipped.
Partial sales orders: Some item quantities but not all required quantities of all items in the sales order have been recorded as shipped.
Open sales orders: No item quantities have been recorded as shipped.

One or more of the filter settings, or none, can be selected. If none of the filter settings are selected, then no state filter is applied to the sales order.

Syntax

'Declaration
 
Public Overloads Shared Function GetByFilter( _
   ByVal userId As String, _
   ByVal custId As String, _
   ByVal poId As String _
) As DataSet

'Usage
 
Dim userId As String
Dim custId As String
Dim poId As String
Dim value As DataSet
 
value = SoLine.GetByFilter(userId, custId, poId)

public static DataSet GetByFilter( 
   string userId,
   string custId,
   string poId
)

Parameters

userId: Required. Holds the user ID by which to filter the customer records.
custId: Required. Holds the customer ID.
poId: Required. Holds the ID of the customer's purchase order.

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) and for sales orders whose states match those defined by the customer filter that was saved in the UI_Config table for the specified MES user.

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