NetSuite Get Record

You can use the NetSuite Get Record activity to retrieve records from the NetSuite system with internal IDs or external IDs.

This activity supports batch operations. You can retrieve multiple records at a time. If you want to retrieve a data collection from the NetSuite system in a batch, you can use the For-Each statement to map the data collection to the elements in the Input fields in the NetSuite Get Record activity. It also supports custom fields, custom records, and custom lists, see Customization for more information.

General

In the General panel, you can specify the parameters that you require. The General tab contains the following fields:

Field Module Property? Description
Name No (Required) Specify a name for the activity in the process definition.
NetSuite Connection Yes (Required) Select a shared connection resource.

Click the icon to select a space connection. If no matching NetSuite connections are found, click Create Shared Resource in the Select NetSuiteConnectionResource Resource Template dialog to create one. See Creating a NetSuite Connection Shared Resource for more details.

Record Category No (Required) Select the top level category of the record type.
Record Subcategory No (Required) Select the subcategory of the record type.
Record No (Required) Select the record type.

Description

In the Description tab, you can enter a short description for the activity.

Input

In the Input tab, you can specify the fields that you require. The Input tab contains the following fields:

Field Data Type Description
baseRef
Note: At least one of the following elements is required. If both of them are given values, the value in the @internalId element is used to retrieve records.
@internalId String The internal IDs of the records you want to retrieve from the NetSuite system.
@externalId String The external IDs of the records you want to retrieve from the NetSuite system.

Output

In the Output tab, you can check the response information. The Output tab contains the following fields:

Output Item Data Type Description
RecordCategory String The top level category of the returned records.
RecordSubCategory String The subcategory of the returned records.
Record String The record type of the returned records.
Results
Result The Result element contains the status and Record elements.
status The status element contains the following elements:
  • @isSuccess (A Boolean value): This element indicates the status of the current operation. If no error occurs when retrieving a record, the status true is returned.
  • statusDetail: This element contains the following sub-elements:
    • @type (A String value): The type of the message returned from the NetSuite system, which includes ERROR, WARN, and INFO.
    • code (A String value): The code of the message returned from the NetSuite system.
    • message (A String value): The message returned from the NetSuite system.
record The record element contains the following elements:
  • @internalId (A String value): The internal ID of the retrieved records.
  • @externalId (A String value): The external ID of the retrieved records.
  • item: The attributes of the record. It varies in record type.
    Note: In the General tab, when you select Transactions from the Record Category list, select Customers from the Record Subcategory list, and select CustomerRefund from the Record list, the values in the depositList element are displayed in the applyList element.

Fault

The Fault tab lists exceptions that are thrown by this activity. For more detailed information, see Error Codes.

Error Schema Element Data Type Description
NetSuitePluginException
msg String The TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite error message.
msgCode String The TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite error code.
NetSuiteServerException
msg String The NetSuite system error message when processing a request from the plug-in.
msgCode String The NetSuite system error code when processing a request from the plug-in.
NetSuiteMSG String The NetSuite server error message when processing a request from the plug-in.