MES Stateless API

GetByKey Method (SoLine)

Save PDF

TABLE OF CONTENTS

GetByKey Method (SoLine)

Save PDF

Last UpdatedNov 06, 2025
3 minute read

The GetByKey() method retrieves the specified sales order line item record from the SO_Line table.

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

Syntax

'Declaration
 
Public Shared Function GetByKey( _
   ByVal custId As String, _
   ByVal poId As String, _
   ByVal soLineNo As Integer _
) As DataSet

'Usage
 
Dim custId As String
Dim poId As String
Dim soLineNo As Integer
Dim value As DataSet
 
value = SoLine.GetByKey(custId, poId, soLineNo)

public static DataSet GetByKey( 
   string custId,
   string poId,
   int soLineNo
)

Parameters

custId: Required. Holds the customer ID.
poId: Required. Holds the ID of the customer's purchase order.
soLineNo: Required. Holds a number that identifies the line item in the sales order.

Return Value

Returns a DataSet that contains the DataRow of the specified sales order line item in the SO_Line table. If no matching record for the specified sales order line is found, an empty DataSet is returned.

The columns of the returned DataSet are described below.

Column Names	Description
cust_id	A string that is the customer ID.
po_id	A string that is the customer's purchase order ID.
so_line_no	An integer that is the line number in the sales order.
item_id	A string that is the ID of the item being ordered.
customer_item_id	A string that is the ID that the customer uses to refer to the item being ordered.
quantity	A double that is the amount of the item being ordered.
uom_id	An integer that is the ID of the unit of measure for the item being ordered.
min_qty	A double that is the minimum quantity that, once shipped, will allow the order to be completed.
max_qty	A double that is the maximum quantity that may be shipped against this line item. A null value indicates no limit.
line_price	A double that is the total price for this line item.
reqd_by_utc	A datetime that is the UTC date when the line item is required.
reqd_by_local	A datetime that is the date when the goods for this line are required in the local time of the entity from which the goods are shipped, specified by the ship_from column in the SO's record, from the SO_Line table. If a ship-from entity is not specified, the default time zone will be used to determine the local time.
spare1	A string that is the content of the user-defined spare1 field.
spare2	A string that is the content of the user-defined spare2 field.
spare3	A string that is the content of the user-defined spare3 field.
spare4	A string that is the content of the user-defined spare4 field.
last_edit_comment	A string that contains comments about why the record was added or updated.
last_edit_by	A string that is the ID of the user who added or last updated this record.
last_edit_at	A datetime that indicates when the record was added or last updated.
mod_id	The current modification ID of the record in the table. This ID is binary number that increments each time the record’s table row is modified. Optionally used for optimistic concurrency control when performing updates or deletes.

MES Stateless API

GetByKey Method (SoLine)

Table of Contents

GetByKey Method (SoLine)

In This Topic

MES Stateless API

GetByKey Method (SoLine)

Syntax

Parameters

Return Value

Remarks

See Also

Reference

In This Topic