GetByKey Method (Cust)
- Last UpdatedNov 06, 2025
- 2 minute read
Parameters
- custId
- Required. Holds the customer or vendor ID.
Return Value
Returns a DataSet that contains the DataRow of the specified customer or vendor. If no matching record for the specified customer or vendor 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 or vendor ID. |
|
cust_name |
A string that is the name of the customer or vendor. |
|
address1 |
A string that is the first part of the customer or vendor address. |
|
address2 |
An string that is the second part of the customer or vendor address. |
|
city |
A string that is the city of the customer or vendor address. |
|
state |
A string that is the state of the customer or vendor address. |
|
zip |
A string that is the zip code of the customer or vendor address. |
|
country |
A string that is the country of the customer or vendor address. |
|
phone |
A string that is the phone number of the customer or vendor. |
|
fax |
A string that is the fax number of the customer or vendor. |
|
|
A string that is the email address of the customer or vendor. |
|
customer |
A Boolean flag that indicates whether this is a customer. |
|
vendor |
A Boolean flag that indicates whether this is a vendor. |
|
spare1 to spare4 |
A string that is the content of the spare1 to spare4 user-defined fields. |
|
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. |
Observe the following input parameter rules:
- Required non-DB* parameters: Must pass a value. Cannot be empty or null.
- Optional non-DB* parameters: Either enter a value or pass a null. If passing a null and a default value has been defined, the default value will be used for the parameter.
- Required DB* parameters: Must pass a value. To enter an empty value for the parameter, pass DB*.null (e.g., DBInt.null).
- Optional DB* parameters: To enter no value for the parameter, pass DB*.null (e.g., DBInt.null). To use the default value for the parameter if one has been defined for the object being added, pass a null.