# mulesoft NetSuite Connector - Full Documentation
---
product: NetSuite Connector
version: 11.10
---
# NetSuite Connector 11.10
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Anypoint Connector for NetSuite (NetSuite Connector) synchronizes data and automates business
processes between NetSuite and third-party applications, either on-premises or in the cloud.
NetSuite provides cloud-based business management software that helps companies manage core business
processes, ERP financials, CRM, e-commerce, inventory, and more.
NetSuite Connector provides the following features:
- SOAP-based integration
NetSuite Connector 11.0 and later does not support REST-based operations.
- Generation of NetSuite business objects
- Different authentication levels
- Error-handling support
For compatibility information and fixed issues, see the
[NetSuite Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/netsuite-connector-release-notes-mule-4).
## Before You Begin
To use this connector, you must be familiar with:
- The NetSuite API
- Anypoint connectors
- Mule runtime engine (Mule)
- Elements and global elements in a Mule flow
- Creating a Mule app using Anypoint Studio or Anypoint Code Builder
Before creating an app, you must have:
- Credentials to access NetSuite Web Services
- Anypoint Studio version 7.3.3 or later
## Common Use Cases for the Connector
- Quote-to-Cash
Improve cash flow, remove manual order entries, and minimize order errors by leveraging realtime
integrations to connect and synchronize data about your customer’s intent to buy from your CRM
application, such as Salesforce, into its realization of revenue in NetSuite ERP.
- Invoice-to-Reconciliation
Automate your Accounts Receivable (A/R) process by automatically applying bank payments against
invoices in NetSuite for real-time A/R processing. Streamline accounts payable by automating
payment file transfers between NetSuite and your banks.
- Hire-to-Retire
Build a single view of your employees with realtime synchronization of employee information
between Netsuite and your Human Capital Management (HCM) services, such as Workday, Oracle HCM,
PeopleSoft, and so on. Automatically trigger employee onboarding processes such as ordering
computer equipment, uniforms, system access setup, and so on, while reversing the process upon
retirement.
## Authentication types
NetSuite connections use token-based authentication, which uses either a consumer key and token ID
or secret pairs to authenticate.
For information about configuring this authentication type, see
[Using Anypoint Studio to Configure NetSuite Connector](https://docs.mulesoft.com/netsuite-connector/11.10/netsuite-studio-configure).
## Using Exchange Templates and Examples
[Anypoint Exchange](https://www.mulesoft.com/exchange/) provides the following templates that you
can use as starting points for your apps:
- [Retrieve a List of Customers from NetSuite](https://www.mulesoft.com/exchange/org.mule.examples/get-customer-list-from-netsuite/)
- [Salesforce and NetSuite Opportunity Aggrgation](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2nets-opportunity-aggregation/)
## Next Step
After you complete the prerequisites, you are ready to create your own app and configure the
connector using [Anypoint Studio](https://docs.mulesoft.com/netsuite-connector/11.10/netsuite-studio-configure).
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange)
- [Salesforce Help](https://help.salesforce.com)
---
product: NetSuite Connector
version: 11.10
---
# NetSuite Connector 11.10 Examples
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
The following examples show how to perform searches in Anypoint Connector for NetSuite (NetSuite
Connector):
- [Account Basic Search Filtering by an Integer Field](#account-basic-search)
Obtain the Account records with internal IDs that are less than the value of the `internalId`
query parameter.
- [Employee Basic Search Filtering by the Boolean and String Fields](#employee-basic-search)
Obtain the inactive Employee records that have last names beginning with a specified letter.
- [Customer Advanced Search Filtering by the Date and Array Fields](#customer-advanced-search)
Obtain the customer records that were created after 2015 and that are in the LEAD stage.
The following example shows how to add a file in NetSuite Connector:
- [Add a File](#add-file)
Add a file using the **Add** operation.
The following example shows how to use custom fields and records in NetSuite Connector:
- [Add a Custom Record](#add-custom-record)
Add a custom record with custom fields.
- [Get a Custom Record](#get-custom-record)
Get a custom record with custom fields.
- [Delete a Custom Record](#delete-custom-record)
Delete a custom record with custom fields.
## Account Basic Search Filtering by an Integer Field
This example shows how to use the NetSuite Connector `Search` operation to obtain the Account
records with internal IDs that are less than the value provided.
This example requires that at least one basic account meets the search condition in the NetSuite
instance.
The following screenshot shows the Studio app flow for this example:

Figure 1. Account basic search app flow in Studio
Creating this example involves creating a new Mule project and configuring `HTTP Listener`, the
NetSuite Connector `Search` operation, one `For Each` component, and two `Transform Message`
components.
### Configure HTTP Listener
Configure HTTP Listener to initiate a Mule flow when a call is made to the `/account` path on
localhost port 8081:
1. Create a new Mule project in Studio.
2. In Studio, click **HTTP** and drag the **Listener** operation to the canvas.
3. Change the display name of the **Listener** operation to `/account`.
4. On the Listener properties window, click **+** next to the **Connector configuration** field to
add a global element.
5. Accept the defaults.
6. On the Listener properties window, set the **Path** field value to `/account`.
### Add the first Transform Message Component
This **Transform Message** component contains the search criteria for the flow:
1. From the **Mule Palette** view, drag a **Transform Message** component to the right of
**Listener**.
2. Change the name of the **Transform Message** component to `Search Criteria`.
3. Click the **Transform Message** component.
The **Output** column displays the metadata of the **AccountSearchBasic** object. You can build
up the criteria from there, or copy the criteria shown below.
Setting the **searchValue** field to `attributes.queryParams["internalId"]` directs the
connector to use the value through the query parameter.
The DataWeave code should look like this:
```dataweave
%dw 2.0
output application/xml
ns ns0 urn:messages_2020_2.platform.webservices.netsuite.com
ns ns01 urn:common_2020_2.platform.webservices.netsuite.com
ns ns02 urn:core_2020_2.platform.webservices.netsuite.com
ns xsi http://www.w3.org/2001/XMLSchema-instance
---
{
ns0#search: {
ns0#searchRecord @("xmlns:ns01": ns01, xsi#"type": "ns01:AccountSearchBasic"): {
ns01#internalIdNumber @(operator: "lessThan"): {
ns02#searchValue: attributes.queryParams["internalId"]
}
}
}
}
```
### Add the NetSuite Connector Search Operation
1. From the **Mule Palette** view, select **NetSuite** and drag the **Search** operation to the
right of **Search Criteria**.
2. Change the display name of the **Search** operation to `Search Account`.
3. Select an existing global element or create a new one for the **Search** operation.
4. On the Search properties window:
- In the **Key** field, select `AccountSearchBasic`.
- Set the **Page Size** field value to an integer value between `10` and `1000`.
### Add the For Each Component
From the **Mule Palette** view, select **Core** and drag the **For Each** component to the right of
**Search Account**.
### Add the Second Transform Message Component
This **Transform Message** component converts the response to JSON format:
1. From the **Mule Palette** view, drag a **Transform Message** component inside the **For Each**
component.
2. Change the name of the **Transform Message** component to `Response to JSON`.
3. Click the **Transform Message** component and set the output to `application/json`.
```dataweave
%dw 2.0
output application/json
ns ns0 urn:core_2020_2.platform.webservices.netsuite.com
---
payload.ns0#record
```
4. Drag and drop a **Logger** component from the **Mule Palette** view to the right of **Response
to JSON**. Leave the message as `#[payload]`
### Run the App
To run the app:
1. Start the Mule app.
2. Call `http://localhost:8081/account?internalId=5` to retrieve the `Account` records with
internal IDs that are less than 5.
3. You will only be able to see the output from the Mule App console.
### XML for Account Basic Search Flow
Paste this code into a new Mule app in Studio to quickly load the flow for the Account basic search
example. If needed, change the values to reflect your environment.
```xml
```
## Employee Basic Search Filtering by the Boolean and String Fields
This example shows how to use the `Search` operation to obtain the inactive `Employee` records that
have last names beginning with a specified letter.
This example requires that at least one employee record in the NetSuite instance meets the search
conditions.
The following screenshot shows the Studio app flow for the Employee basic search example:

Figure 2. Employee basic search app flow in Studio
Creating this example involves creating a new Mule project and configuring `HTTP Listener`, the
NetSuite Connector `Search` operation, one `For Each` component, and two `Transform Message`
components.
### Configure HTTP Listener
Configure HTTP Listener to initiate a Mule flow when a call is made to the `/employee` path on
localhost port 8081:
1. In Studio, click **HTTP** and drag the **Listener** operation to the canvas.
2. Change the display name of the **Listener** operation to `/employee`.
3. Either select an existing global element or create a new one for **HTTP Listener** and keep the
defaults.
4. On the Listener properties window, set the **Path** field value to `/employee`.
### Add the First Transform Message Component
This **Transform Message** component contains the search criteria for the flow:
1. From the **Mule Palette** view, drag the **Transform Message** component to the right of
**Listener**.
2. Change the name of the **Transform Message** component to `Search Criteria`.
3. Click the **Transform Message** component.
The **Output** column displays the metadata of the **AccountSearchBasic** object. You can build
up the criteria from there, or copy the criteria below.
The value `attributes.queryParams["isInactive"]` directs the connector to search for inactive
employee accounts, and the value `attributes.queryParams["lastName"]` directs the connector to
search employee which last names start with the value provided.
The DataWeave code should look like this:
```dataweave
%dw 2.0
output application/xml
ns ns0 urn:messages_2020_2.platform.webservices.netsuite.com
ns ns01 urn:common_2020_2.platform.webservices.netsuite.com
ns ns02 urn:core_2020_2.platform.webservices.netsuite.com
ns xsi http://www.w3.org/2001/XMLSchema-instance
---
{
ns0#search: {
ns0#searchRecord @("xmlns:ns01": ns01, xsi#"type": "ns01:EmployeeSearchBasic"): {
ns01#lastName @(operator: "startsWith"): {
ns02#searchValue: attributes.queryParams["lastName"]
},
ns01#isInactive: {
ns02#searchValue: attributes.queryParams["isInactive"]
}
}
}
}
```
### Add the NetSuite Connector Search Operation
1. From the **Mule Palette** view, select **NetSuite** and drag the **Search** operation to the
right of **Search Criteria**.
2. Change the display name of the **Search** operation to `Search Employee`.
3. Select an existing global element or create a new one for the **Search** operation.
4. On the Search properties window:
- In the **Key** field, select `EmployeeSearchBasic`.
- Set the **Page Size** field value to an integer value between `10` and `1000`.
### Add the For Each Component
From the **Mule Palette** view, select **Core** and drag the **For Each** component to the right of
**Search Employee**.
### Add the Second Transform Message Component
This **Transform Message** component converts the response to JSON format:
1. From the **Mule Palette** view, drag a **Transform Message** component inside the **For Each**
component.
2. Change the name of the **Transform Message** component to `Response to JSON`.
3. Click the **Transform Message** component and set the output to `application/json`.
```dataweave
%dw 2.0
output application/json
ns ns0 urn:core_2020_2.platform.webservices.netsuite.com
---
payload.ns0#record
```
4. Finally, drag and drop a **Logger** component from the **Mule Palette** view, to the right of
**Response to JSON**. the message should be `#[payload]`
### Run the App
1. Start the Mule app.
2. Call `http://localhost:8081/employee?isInactive=true&lastName=C` to retrieve the inactive
`Employee` records that have last names beginning with `C`.
3. You will **ONLY** be able to see the output from the Mule App console.
### XML for Employee Basic Search Flow
Paste this code into a new Mule app in Studio to quickly load the flow for the Employee basic search
example. If needed, change the values to reflect your environment.
```xml
```
## Customer Advanced Search Filtering by Stage field and Date Created field
This example shows how to use the `Search` operation to obtain the customer records that were
created after 2015 and that are in the `LEAD` stage.
This examples requires that at least one customer record meets the search conditions in the NetSuite
instance.
The following screenshot shows the Studio app flow for this example:

Figure 3. Customer advanced search app flow in Studio
Creating this example involves creating a new Mule project and configuring `HTTP Listener`, the
NetSuite `Search` operation, two `Transform Message` components, and a `For-Each` component.
### Configure HTTP Listener
Configure HTTP Listener to initiate a Mule flow when a call is made to the `/customer` path on
localhost port 8081:
1. In Studio, click **HTTP** and drag the **Listener** operation to the canvas.
2. Change the display name of the **Listener** operation to `/customer`.
3. Select an existing global element or create a new one for the **Listener** operation.
4. On the Listener properties window, set the **path** field value to `/customer`.
### Add the First Transform Message Component
This **Transform Message** component specifies the search criteria for the flow:
1. From the **Mule Palette** view, drag the **Transform Message** component to the right of
**Listener**.
2. Change the name of the **Transform Message** component to `Search Criteria`.
3. Click the **Transform Message** component.
The **Output** column displays the metadata of the **CustomerSearchAdvanced** object. You can
build up the criteria from there, or copy the criteria below.
Setting the **searchValue** of `stage` to `attributes.queryParams["stage"]` directs the
connector to use the value of the `stage` query parameter.
The DataWeave code should look like this:
```dataweave
%dw 2.0
output application/xml
ns ns0 urn:messages_2020_2.platform.webservices.netsuite.com
ns ns01 urn:common_2020_2.platform.webservices.netsuite.com
ns ns02 urn:core_2020_2.platform.webservices.netsuite.com
ns ns03 urn:relationships_2020_2.lists.webservices.netsuite.com
ns xsi http://www.w3.org/2001/XMLSchema-instance
---
{
ns0#search: {
ns0#searchRecord @("xmlns:ns03": ns03, xsi#"type": "ns03:CustomerSearchAdvanced"): {
ns03#criteria: {
ns03#basic: {
ns01#stage @(operator: "anyOf"): {
ns02#searchValue: [attributes.queryParams["stage"]]
},
ns01#dateCreated @(operator: "after"): {
ns02#searchValue: "2015-01-01T00:00:00.000-08:00"
}
}
}
}
}
}
```
### Add the NetSuite Connector Search Operation
1. From the **Mule Palette** view, select **NetSuite** and drag the **Search** operation to the
right of **Search Criteria**.
2. Change the display name of the **Search** operation to `Search Customer Advanced`.
3. Select an existing global element or create a new one for the **Search** operation.
4. On the Search properties window:
- In the **Key** field, select `CustomerSearchAdvanced`.
- Set the **Page Size** field value to an integer value between `10` and `1000`.
- Click on **Search Preferences** and select `false` on `Return search columns`
### Add a For-Each Component
A `For-Each` component processes each record on the list returned by the `Search` operation
individually so that the records can be displayed on the console.
1. From the **Mule Palette** view, drag a **For-Each** component to the right of **Search**.
2. Drag a **Transform Message** component inside the **For Each** box, rename the component to
`Response to JSON`, and replace the DataWeave code with this code:
```dataweave
%dw 2.0
output application/json
ns ns0 urn:core_2020_2.platform.webservices.netsuite.com
---
payload.ns0#record
```
3. Drag a **Logger** component from the **Mule Palette** view to the right of **Transform**, inside
the **For Each** box.
4. On the Logger properties window, set the **Message** field value to `#[payload]`.
### Run the App
1. Start the Mule app.
2. Call `http://localhost:8081/customer?stage=LEAD`.
3. You will **ONLY** be able to see the output from the Mule App console.
### XML for the Customer Advanced Search Flow
Paste this code into a new Mule app in Studio to quickly load the flow for the Customer Advanced
Search example. If needed, change the values to reflect your environment.
```xml
```
## Add a File
This example shows how to use the **Add** operation to add a file using NetSuite Connector.
The following screenshot shows the Studio app flow for this example:

Creating this example involves creating a new Mule project and configuring a **Listener** component,
**Transform Message** component, **Add** operation, and **Logger** component.
### Configure HTTP Listener
Configure HTTP Listener to initiate a Mule flow when a call is made to the `/upload` path:
1. Create a new Mule project in Studio.
2. In Studio, click **HTTP** and drag the **Listener** component to the canvas.
3. In the **Listener** properties window, click **+** next to the **Connector configuration** field
to add a global element.
4. Accept the defaults.
5. In the **Listener** properties window, set the **Path** field value to `/upload`.
### Add the Transform Message Component
Add the **Transform Message** component to convert the values from the HTTP input to XML format so
they can be used as input for the **Add** operation:
1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to
the right of **Listener**.
2. In the properties window, overlay the brackets in the **Output** section with this DataWeave
code:
```dataweave
%dw 2.0
output application/xml
ns ns0 urn:messages_2020_2.platform.webservices.netsuite.com
ns ns01 urn:filecabinet_2020_2.documents.webservices.netsuite.com
ns xsi http://www.w3.org/2001/XMLSchema-instance
ns ns02 urn:core_2020_2.platform.webservices.netsuite.com
---
{
ns0#add: {
ns0#record @("xmlns:ns01": ns01, xsi#"type": "ns01:File"): {
ns01#name: "test.csv",
ns01#content: "Here is the content of file",
ns01#folder @(internalId: 826997 , xsi#"type": "ns01:RecordRef"): {
ns02#name: null
}
}
}
}
```
### Add the Add Operation
Add the **Add** operation to add a file using the values passed by the **Transform Message**
component:
1. From the **Mule Palette** view, select **NetSuite** and drag the **Add** operation to the right
of **Transform Message**.
2. In the properties window, click **+** next to the **Connector configuration** field to add a
global element.
3. Configure the global element depending on the connection, for example:
| Field | Value |
|---|
Consumer key | ${netsuite.consumerKey}
|
Consumer secret | ${netsuite.consumerSecret}
|
Token ID | ${netsuite.tokenId}
|
Token secret | ${netsuite.tokenSecret}
|
Account Id | ${netsuite.account}
|
Signature algorithm | HMAC_SHA256
|
Wsdl version | V2020_2
|
SOAP Port | services/NetSuitePort_2020_2
|
The following image shows an example of the **Add** configuration of the global element:

4. In the properties window, configure the following fields:
| Field | Value |
|---|
Display Name | Name for the connector operation. |
Connector configuration | Global configuration you just created. |
Type | file
|
Message | vars.fileRecord
|
The following image shows an example of the **Add** configuration in the properties window:

### Add the Logger Component
Add the **Logger** component to display the response in the Mule console:
1. From the **Mule Palette** view, select **Core** and drag a **Logger** component to the right of
**Add**.
2. In the properties window, configure the following fields:
| Field | Value |
|---|
Display Name | Name for the logger, such as Logger. |
Message | The file was added
|
Level | INFO (Default) |
The following image shows an example of the **Logger** configuration in the properties window:

### Run the App
To run the app:
1. Start the Mule app.
2. Call `http://localhost:8081/upload` to add the file.
### XML for the Add File Flow
Paste this code into a new Mule app in Studio to quickly load the flow for the Add File example. If
needed, change the values to reflect your environment.
```xml
```
## Custom Records and Fields
The following example shows how to add, get, and delete custom records with custom fields using
DataWeave. Use DataSense, which imports metadata from NetSuite Connector, to simplify application
design.
The following screenshot shows the Studio app flow for this example:

Creating this example involves adding the **Add** operation, **Set Variable** component, **Get**
operation, and **Delete** operation.
### Add a Custom Record
Add a custom record with custom fields using the **Add** operation.
Include the following attributes to add a custom record:
- **separators**
Specifies a separator character. The separator in the following example is `__`.
- **recordType**
References the custom record type. The recordType in the following example is `customRecordType`.
- **scriptId**
References the script ID of the record. The scriptId in the following example is
`customrecord_2663_bank_details`.
- **internalId**
References the internal ID of the record. The internalId in the following example is `374`.
- **XSI type**
Specify the XSI type as **CustomRecordRef** to add a custom record.
The following DataWeave script adds a custom record with custom fields:
%dw 2.0 output application/xml ns ns0 urn:messages\_2020\_2.platform.webservices.netsuite.com ns
ns01 urn:customization\_2020\_2.setup.webservices.netsuite.com ns ns02
urn:core\_2020\_2.platform.webservices.netsuite.com ns xsi http://www.w3.org/2001/XMLSchema-instance
---
{ ns0#add: { ns0#record @("xmlns:ns01": ns01, xsi#"type": "ns01:CustomRecord"): {
ns01#customFieldList: { StringCustomFieldRef\_\_custrecord\_2663\_legal\_name\_\_3878: { ns02#value:
"test" }, LongCustomFieldRef\_\_custrecord\_2663\_eft\_file\_cabinet\_id\_\_3874: { ns02#value: 1234
}, BooleanCustomFieldRef\_\_custrecord\_2663\_dd\_batch\_\_3864: { ns02#value: true } } } } }
The customFieldList contains the customFields for the entity you use.
The example above shows `StringCustomFieldRef__custrecord_2663_legal_name__3878`,
`BooleanCustomFieldRef__custrecord_2663_dd_batch__3864` and
`LongCustomFieldRef__custrecord_2663_eft_file_cabinet_id__3874`. The field names consist of a
**scriptId**, **internalId**, and **CustomRecordRef** type.
`StringCustomFieldRef__custrecord_2663_legal_name__3878` has a specified value `ns02#value: "test"`,
`LongCustomFieldRef__custrecord_2663_eft_file_cabinet_id__3874` has a specified value
`ns02#value: 1234`, and `BooleanCustomFieldRef__custrecord_2663_dd_batch__3864` has a specified
value `ns02#value: true`.
### Get Custom Record
Get a custom record with custom fields using the **Get** operation.
Include the following attributes to get a custom record:
- **typeId**
References the custom record type Id. The typeId in the following example is `374`.
- **internalId**
References the internalId of the record. The internalId in the following example is
`vars.responseInternalId`.
- **XSI type**
Specify the XSI type as **CustomRecordRef** to retrieve a custom record.
The following DataWeave script gets a custom record with custom fields:
%dw 2.0 output application/xml ns ns0 urn:messages\_2020\_2.platform.webservices.netsuite.com ns
ns01 urn:core\_2020\_2.platform.webservices.netsuite.com ns xsi http://www.w3.org/2001/XMLSchema-instance
---
{ ns0#get: { ns01#baseRef @(internalId: vars.responseInternalId , "typeId": "374", xsi#"type":
"ns01:CustomRecordRef"): null } }
### Delete Custom Record
Delete a custom record with custom fields using the **Delete** operation.
Include the following attributes to delete a custom record:
- **typeId**
References the custom record type Id. The typeId in the following example is `374`.
- **internalId**
References the internalId of the record. The internalId in the following example is
`vars.responseInternalId`.
- **XSI type**
Specify the XSI type as **CustomRecordRef** to delete a custom record.
The following DataWeave script deletes a custom record with custom fields:
%dw 2.0 output application/xml ns ns0 urn:messages\_2020\_2.platform.webservices.netsuite.com ns
ns01 urn:core\_2020\_2.platform.webservices.netsuite.com ns xsi http://www.w3.org/2001/XMLSchema-instance
---
{ ns0#delete: { ns01#baseRef @(internalId: vars.responseInternalId , "typeId": "374", xsi#"type":
"ns01:CustomRecordRef"): null } }
### XML for Custom Records
Paste this code into a new Mule app in Studio to quickly load the flow for the custom records
example. If needed, change the values to reflect your environment.
```xml
```
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Salesforce Help](https://help.salesforce.com)
---
product: NetSuite Connector
version: 11.10
---
# NetSuite Connector 11.10 Reference
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Anypoint Connector for NetSuite synchronizes data and automates business processes between NetSuite
and third party applications, either on-premises or in the cloud. The connector makes use of the
SuiteTalk WSDL to provide SOAP based integration to generate NetSuite business objects, make use of
different authentication levels, and support error handling.
Release Notes:
[NetSuite Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/netsuite-connector-release-notes-mule-4)
## Configurations
---
### Config
#### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Name | String | The name for this configuration. Connectors reference the configuration with this name. | | x |
Connection | | The connection types to provide to this configuration. | | x |
Name | | The identifier of this element used to reference it in other components | | x |
Expiration Policy | | Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate. | | |
Show warnings as errors | | When this preference is enabled, warning messages generated by NetSuite are treated as errors that cause an exception, resulting in rejection of the request. | false | |
Disable mandatory custom field validation | | This preference affects the handling of custom fields that are configured in the UI to be mandatory: If you set this field to true, the fields are not treated as required during SOAP web services requests. If you set this field to false, the fields are required.
| false | |
Disable system notes for custom fields | | System notes are system-generated records that track changes to a record, including changes to specific field values. This preference lets you disable the creation of system notes for changes to custom fields. Depending on your integration, using this preference can increase performance. | false | |
Ignore read-only fields | | This preference affects the way the system behaves when you mistakenly submit a value for a read-only field. If you set this preference to true, the system ignores these mistakes. | false | |
Run server SuiteScript and trigger workflows | | Controls SuiteScript and trigger workflows per request: If you do not include this preference in a request, the company preference set on the Web Services Preferences page is used. If you include this preference in the request, the connector overrides the company preference set in the UI.
| false | |
Send runServerSuiteScript tag in Preferences header | | Sends the runServerSuiteScript tag in the Preferences header. | false | |
Customizations Separator | | Separator used to generate the keys required to provided better support for custom fields and records. If the script ID of the customization that defines a custom field or record contains the separator default character, set up a new ID and regenerate the metadata. | __ | |
Omit the internal Id in the name of the custom field | | Omits the internal ID from the custom field name: If you set this field to true, the custom field name is CUSTOMFIELDTYPE__SCRIPTID. If you set this field to false, the custom field name is CUSTOMFIELDTYPE__SCRIPTID__INTERNALID.
| | |
#### Connection Types
The connection types to provide to this configuration.
##### Token-Based Authentication
###### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Maximum Connections | | The maximum number of connections that can be active to execute the HTTP requests. The default value, -1, does not limit the number of connections to the server. | -1 | |
Read Timeout | | Specifies the amount of time that the client waits for a response before it times out. Use 0 to specify that the client should wait indefinitely. | 60000 | |
Read Timeout Unit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS
| The time unit for Read Timeout. | MILLISECONDS | |
Connection Timeout | | Specifies the amount of time that the client attempts to establish a connection before it times out. Use 0 to specify that the client continue to attempt to open a connection indefinitely. | 60000 | |
Connection Timeout Unit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS
| The time unit for Connection Timeout. | MILLISECONDS | |
Base Netsuite Address | | The base address to use to connect to NetSuite. The default value is the main NetSuite site. This is used to automatically obtain the endpoint for the service based on the credentials configured, and will need no change. | https://webservices.netsuite.com
| |
Concurrency Management Strategy | | Strategy to use when encountering the TOO_MANY_REQUESTS error. | | |
Wsdl version | | Version of WSDL that the connector uses to communicate with NetSuite: If you do not select a value, the connector works with SuiteTalk version 2020_2 and existing namespaces in the Mule app must not be modified. If you select a WSDL version, remove the SuiteTalk version from all namespaces in the Mule app. The following example shows an original DataWeave script with the SuiteTalk version and a new DataWeave script with the SuiteTalk version removed. #%dw 2.0
output application/java
ns ns0 urn:messages_2020_2.platform.webservices.netsuite.com
ns ns01 urn:core_2020_2.platform.webservices.netsuite.com
---
payload.ns0#changePasswordResponse.ns0#sessionResponse.ns01#status.ns01#statusDetail.ns01#code #%dw 2.0
output application/java
ns ns0 urn:messages.platform.webservices.netsuite.com
ns ns01 urn:core.platform.webservices.netsuite.com
---
payload.ns0#changePasswordResponse.ns0#sessionResponse.ns01#status.ns01#statusDetail.ns01#code
| | |
SOAP Port | | The SOAP Port path to use to connect to NetSuite, this is relative to the base address. The default value corresponds to the port obtained from the WSDL used in the version of the connector. | | x |
TLS configuration | | Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the keystore in the tls:context child element of the listener-config. | | |
Host | | The hostname of the HTTP proxy, for example, localhost. This field requires the port to be set. | | |
Port | | The port number of the HTTP proxy, for example, 3128. The port number must be specified if the hostname is also specified. | | |
Username | | The username to supply to the HTTP proxy on every request to NetSuite. This field is optional because a user might want to pass through an unauthenticated HTTP proxy. | | |
Password | | The password to supply to the HTTP proxy on every request to NetSuite. This field is optional because a user might want to pass through an unauthenticated HTTP proxy. | | |
Non proxied hosts | | A list of comma-separated hosts against which the proxy should not be used | | |
Consumer Key | | The consumer key value for the enabled token-based authentication integration record | | x |
Consumer Secret | | The consumer secret value for the token-based authentication integration record | | x |
Token ID | | The token ID representing the unique combination of a user and integration generated within the NetSuite environment | | x |
Token Secret | | The respective token secret for the user/integration pair | | x |
Account Id | | NetSuite SuiteTalk WebService account ID. | | x |
Signature Algorithm | | The algorithm used to compute the SHA hash signature | HMAC_SHA256 | |
Reconnection | | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. | | |
## Supported Operations
- [Add](#Add)
- [Add List](#AddList)
- [Async Add List](#AsyncAddList)
- [Async Delete List](#AsyncDeleteList)
- [Async Get List](#AsyncGetList)
- [Async Initialize List](#AsyncInitializeList)
- [Async Search](#AsyncSearch)
- [Async Update List](#AsyncUpdateList)
- [Async Upsert List](#AsyncUpsertList)
- [Attach](#Attach)
- [Change Email](#ChangeEmail)
- [Change Password](#ChangePassword)
- [Check Async Status](#CheckAsyncStatus)
- [Delete](#Delete)
- [Delete List](#DeleteList)
- [Detach](#Detach)
- [Get](#Get)
- [Get Account Governance Info](#GetAccountGovernanceInfo)
- [Get All](#GetAll)
- [Get Async Result](#GetAsyncResult)
- [Get Budget Exchange Rate](#GetBudgetExchangeRate)
- [Get Currency Rate](#GetCurrencyRate)
- [Get Customization Id](#GetCustomizationId)
- [Get Data Center Urls](#GetDataCenterUrls)
- [Get Deleted](#GetDeleted)
- [Get Integration Governance Info](#GetIntegrationGovernanceInfo)
- [Get Item Availability](#GetItemAvailability)
- [Get List](#GetList)
- [Get Posting Transaction Summary](#GetPostingTransactionSummary)
- [Get Saved Search](#GetSavedSearch)
- [Get Select Value](#GetSelectValue)
- [Get Server Time](#GetServerTime)
- [Initialize](#Initialize)
- [Initialize List](#InitializeList)
- [Search](#Search)
- [Update](#Update)
- [Update Invitee Status](#UpdateInviteeStatus)
- [Update Invitee Status List](#UpdateInviteeStatusList)
- [Update List](#UpdateList)
- [Upsert](#Upsert)
- [Upsert List](#UpsertList)
## Associated Sources
- [On Deleted Object](#DeletedObjectListener)
- [On Modified Object](#ModifiedObjectListener)
- [On New Object](#NewObjectListener)
## Operations
## Add
``
Creates a new record.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The message to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configures how Mule processes streams. Repeatable streams are the default behavior. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Add List
``
Creates one or more new records.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The add list request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configures how Mule processes streams. Repeatable streams are the default behavior. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Add List
``
An asynchronous request equivalent to Add List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, NetSuite returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The Async Add List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configures how Mule processes streams. Repeatable streams are the default behavior. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Delete List
``
An asynchronous request equivalent to the Delete List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The Async Delete List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configures how Mule processes streams. Repeatable streams are the default behavior. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Get List
``
An asynchronous request equivalent to the Get List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The Async Get List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Initialize List
``
An asynchronous request equivalent to the Initialize List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The Async Initialize List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Search
``
An asynchronous request equivalent to the Search operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Key | | The type of search that renders the output metadata. | | |
Message | | The Async Search request to complete. | #[payload] | |
Body Fields Only | | Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to false, all fields associated with the record are returned. | true | |
Return Search Columns | | If true, only search columns are returned in your search. | true | |
Page Size | | Maximum amount of results per page. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Update List
``
An asynchronous request equivalent to the Update List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The Async Update List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Upsert List
``
An asynchronous request equivalent to the Upsert List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The Async Upsert List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Attach
``
Defines a relationship between two records.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The attach request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Change Email
``
Changes the email address for the account.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
New Email | | Your new email address. | | x |
Current Credentials | | Your current credentials. | | x |
Just This Account | | Whether to change this account only. | true | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INSUFFICIENT\_PERMISSION
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Change Password
``
Changes the password for the account.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
New Password | | The new password. | | x |
Current Password | | Your current credentials. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INSUFFICIENT\_PERMISSION
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Check Async Status
``
Checks whether a particular asynchronous job finished processing.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Job Id | | The ID of the job. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Delete
``
Delete one or more record instances. Not all records can be deleted. For more information, see the
NetSuite documentation.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The delete request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Ref Type | | Defines the ComplexType of the record. | | |
Type | | Defines the Type of the record. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Delete List
``
Deletes one or more records. Not all records can be deleted. For more information, see the NetSuite
documentation.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The delete list request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Ref Type | | Defines the ComplexType of the record. | | |
Type | | Defines the Type of the record. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Detach
``
Deletes a relationship between two records.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The detach request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get
``
Retrieves a record by providing the unique ID that identifies the record.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Ref Type | | Defines the ComplexType of the record. | | |
Type | | Defines the Type of the record. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Get Account Governance Info
``
Get the account concurrency limit and the unallocated concurrency limit.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get All
``
Retrieves a list of all records of the specified type.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | | | |
Message | | The get All request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get Async Result
``
Returns the result of the specified job if it finished processing.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Job Id | | The ID of the job. | | x |
Page Index | | The page number of the asynchronous result. | 1 | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get Budget Exchange Rate
``
Gets and filters all data related to the Budget Exchange Rates table. This table maintains exchange
rates between the root-parent and child subsidiaries for use in the budgeting process.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The Get Budget Exchange Rate request, which contains a budgetExchangeRateFilter. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get Currency Rate
``
Gets the exchange rate between two currencies based on the specified certain date.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | Accepts the argument CurrencyRateFilter, which specifies what to return in the results. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INSUFFICIENT\_PERMISSION
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get Customization Id
``
Returns the IDs of available customizations for a given customization type.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | Customization type | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get Data Center Urls
``
Obtains the NetSuite data center URL for the account.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Account Id | | The account ID. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get Deleted
``
Returns a list of deleted records for the given record type and date range.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Filter | | Filters the results | #[payload] | |
Limit | | The maximum amount of results to return from this call | -1 | |
Page Size | | Maximum amount of results per page. | 10 | |
Output Mime Type | | The MIME type of the payload that this operation outputs. | | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:SESSION\_TIMED\_OUT
## Get Integration Governance Info
``
Get the concurrency limit for the integration (integrationConcurrencyLimit) and the limit type
(limitType), which can be:
- \_integrationSpecific, when a limit has been allocated.
- \_internal, when it is an internal application. In this case the limit is not displayed.
- \_accountLimit, when no specific limit has been allocated to the integration.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get Item Availability
``
Returns the availability for a given item record reference. If the Multi-Location Inventory feature
is enabled, connector returns results for all locations.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The GetItem Availability Request type, which contains an itemAvailabilityFilter | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get List
``
Retrieves a list of one or more records by providing the unique ids that identify those records.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The get list request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Ref Type | | Defines the ComplexType of the record. | | |
Type | | Defines the Type of the record. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get Posting Transaction Summary
``
Retrieves a summary of the data posted to the general ledger in an account. You can use the
available filters and fields to generate reports that are similar to what you see when you run
financial reports such as a Trial Balance, Balance Sheet, or an Income Statement.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Fields | | Fields for the operation body | | |
Filters | | Filters for the operation body | | |
Operation Id | | Operation ID | | |
Output Mime Type | | The MIME type of the payload that this operation outputs. | | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:SESSION\_TIMED\_OUT
## Get Saved Search
``
Retrieves a list of existing saved search IDs on a per-record-type basis.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Search Type | | The targeted search type. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get Select Value
``
Returns valid select options for a particular RecordRef, CustomRecordRef, or enumerated static
field.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Field Description | | The get select value request to complete. | #[payload] | |
Page Size | | | 10 | |
Output Mime Type | | The MIME type of the payload that this operation outputs. | | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
### For Configurations
- [Config](#Config)
## Get Server Time
``
Returns the NetSuite server time in GMT, regardless of a user’s time zone.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Initialize
``
Pre-populates fields on transaction line items with values from a related record.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The initialize request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Initialize List
``
Pre-populates fields on transaction line items with values from related records.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The initialize list request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Search
``
Executes a search on a specific record type based on a set of criteria. This processor has been
enhanced with a paging mechanism. Searches can be Basic, Advanced, or Join searches. See
SearchRecord for all the available searches.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Key | | The type of search to render the output metadata. | | |
Message | | The search request to complete. | #[payload] | |
Page Size | | Maximum amount of results per page. | 10 | |
Limit | | Limits the amount of results produced. Limit <=0 means no limit | -1 | |
Body Fields Only | | Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to false, all fields associated with the record are returned. | true | |
Return Search Columns | | Defaults to true, meaning that only search columns are returned in your search. | true | |
Output Mime Type | | The MIME type of the payload that this operation outputs. | | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:SESSION\_TIMED\_OUT
## Update
``
Updates an existing record.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The update record request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Update Invitee Status
``
Sets a new invitation status for a given event.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The update invitee status request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Update Invitee Status List
``
Sets multiple new invitation statuses for a given event.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The update invitee status list request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Update List
``
Updates one or more instances of a record type. If there are multiple records, they can either be of
the same record type or different record types.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The update list request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Upsert
``
Adds a new instance or updates a record instance in NetSuite. This operation is similar to both the
Add and Update operations, but you can run Upsert without first determining whether a record exists
in NetSuite.
Identify a record by its external ID and its record type. If a record of the specified type with a
matching external ID exists in the system, it is updated. If it does not exist, a new record is
created. Because the external ID is mandatory for this operation, Upsert is supported only for
records that support the external ID field. This operation prohibits the passing of internal ID
values.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The Upsert request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Upsert List
``
Adds or updates one or more instances of a record type in NetSuite. This operation is similar to
both the Add List and Update List operations, but you can run Upsert List without first determining
whether the record types exist in NetSuite.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The Upsert List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Sources
## On Deleted Object
``
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Start Date Time | | Specify a local date. If this field is empty, this operation retrieves the selected objects from the time when the Mule app started. | | |
Page Size | | Maximum amount of results per page. | 10 | |
Body Fields Only | | Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to false, all fields associated with the record are returned. | true | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Scheduling Strategy | | Configures the scheduler that triggers the polling | | x |
Redelivery Policy | | Defines a policy for processing the redelivery of the same message | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | String |
Attributes Type | |
### For Configurations
- [Config](#Config)
## On Modified Object
``
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Start Date Time | | Specify a local date. If this field is empty, this operation retrieves the selected objects from the time the Mule app started. | | |
Page Size | | Maximum amount of results per page. | 10 | |
Body Fields Only | | Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to false, all fields associated with the record are returned. | true | |
Object Type | | The type of record that will be retrieved when modified. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Scheduling Strategy | | Configures the scheduler that triggers the polling | | x |
Redelivery Policy | | Defines a policy for processing the redelivery of the same message | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | String |
Attributes Type | |
### For Configurations
- [Config](#Config)
## On New Object
``
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Start Date Time | | Specify a local date. If this field is empty, this operation will retrieve the selected objects from the time the Mule app was started. | | |
Page Size | | Maximum amount of results per page. | 10 | |
Body Fields Only | | Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to false, all fields associated with the record are returned. | true | |
Object Type | | The type of record that will be retrieved when modified. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Scheduling Strategy | | Configures the scheduler that triggers the polling | | x |
Redelivery Policy | | Defines a policy for processing the redelivery of the same message | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | String |
Attributes Type | |
### For Configurations
- [Config](#Config)
## Types
### Tls
| Field | Type | Description | Default Value | Required |
|---|
Enabled Protocols | | A comma-separated list of protocols enabled for this context. | | |
Enabled Cipher Suites | | A comma-separated list of cipher suites enabled for this context. | | |
Trust Store | | | | |
Key Store | | | | |
Revocation Check | | | | |
### Trust Store
| Field | Type | Description | Default Value | Required |
|---|
Path | | The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store. | | |
Password | | The password used to protect the trust store. | | |
Type | | | | |
Algorithm | | The algorithm used by the trust store. | | |
Insecure | | If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk. | | |
### Key Store
| Field | Type | Description | Default Value | Required |
|---|
Path | | The location (which will be resolved relative to the current classpath and file system, if possible) of the key store. | | |
Type | | | | |
Alias | | When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. | | |
Key Password | | The password used to protect the private key. | | |
Password | | The password used to protect the key store. | | |
Algorithm | | The algorithm used by the key store. | | |
### Standard Revocation Check
| Field | Type | Description | Default Value | Required |
|---|
Only End Entities | | Only verify the last element of the certificate chain. | | |
Prefer Crls | | Try CRL instead of OCSP first. | | |
No Fallback | | Do not use the secondary checking method (the one not selected before). | | |
Soft Fail | | Avoid verification failure when the revocation server can not be reached or is busy. | | |
### Custom Ocsp Responder
| Field | Type | Description | Default Value | Required |
|---|
Url | | The URL of the OCSP responder. | | |
Cert Alias | | Alias of the signing certificate for the OCSP response (must be in the trust store), if present. | | |
### Crl File
| Field | Type | Description | Default Value | Required |
|---|
Path | | The path to the CRL file. | | |
### Reconnection
| Field | Type | Description | Default Value | Required |
|---|
Fails Deployment | | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. | | |
Reconnection Strategy | | The reconnection strategy to use. | | |
### Reconnect
| Field | Type | Description | Default Value | Required |
|---|
Frequency | | How often in milliseconds to reconnect | | |
Blocking | | If false, the reconnection strategy will run in a separate, non-blocking thread | | |
Count | | How many reconnection attempts to make. | | |
### Reconnect Forever
| Field | Type | Description | Default Value | Required |
|---|
Frequency | | How often in milliseconds to reconnect | | |
Blocking | | If false, the reconnection strategy will run in a separate, non-blocking thread | | |
### Expiration Policy
| Field | Type | Description | Default Value | Required |
|---|
Max Idle Time | | A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration | | |
Time Unit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS
| A time unit that qualifies the maxIdleTime attribute | | |
### Netsuite Soap Attributes
| Field | Type | Description | Default Value | Required |
|---|
Soap Headers | | | | |
Transport Additional Data | | | | |
Transport Headers | | | | |
### Redelivery Policy
| Field | Type | Description | Default Value | Required |
|---|
Max Redelivery Count | | The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message | | |
Message Digest Algorithm | | The secure hashing algorithm to use. If not set, the default is SHA-256. | | |
Message Identifier | | Defines which strategy is used to identify the messages. | | |
Object Store | | The object store where the redelivery counter for each message is stored. | | |
### Redelivery Policy Message Identifier
| Field | Type | Description | Default Value | Required |
|---|
Use Secure Hash | | Whether to use a secure hash algorithm to identify a redelivered message. | | |
Id Expression | | Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false. | | |
### Repeatable In Memory Stream
| Field | Type | Description | Default Value | Required |
|---|
Initial Buffer Size | | The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. | | |
Buffer Size Increment | | This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. | | |
Max Buffer Size | | The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. | | |
Buffer Unit | | The unit in which all these attributes are expressed | | |
### Repeatable File Store Stream
File store repeatable streams require buffering, and there are different buffering strategies. Mule
keeps a portion of contents in memory. If the stream contents are larger than the configured buffer
size, Mule backs up the buffer’s content to disk and then clears the memory.
| Field | Type | Description | Default Value | Required |
|---|
In Memory Size | | Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered. | | |
Buffer Unit | | The unit in which maxInMemorySize is expressed | | |
### Repeatable In Memory Iterable
| Field | Type | Description | Default Value | Required |
|---|
Initial Buffer Size | | The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances. | | |
Buffer Size Increment | | This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances. | | |
Max Buffer Size | | The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. | | |
### Repeatable File Store Iterable
| Field | Type | Description | Default Value | Required |
|---|
In Memory Objects | | The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered. | | |
Buffer Unit | | The unit in which maxInMemorySize is expressed | | |
### Randomized Exponential Backoff
| Field | Type | Description | Default Value | Required |
|---|
Max Retries | | Maximum number of retries. | | |
Max Waiting Time Between Retries | | Maximum waiting time between retries, in milliseconds. | | |
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Salesforce Help](https://help.salesforce.com)
---
product: NetSuite Connector
version: 11.10
---
# NetSuite Connector 11.10 Troubleshooting
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
You might encounter the following issues when working with the Anypoint Connector for NetSuite
(NetSuite Connector):
- [A connectivity test fails during application startup.](#connectivity-test-failure)
- [The connector does not log requests and responses.](#logging-request-responses)
- [The connector returns a permissions error when fetching metadata.](#permissions-error)
- [The connector is unable to search for certain types of objects.](#search-entities)
- [The **On Modified Object** source triggers new objects.](#on-modified-object-triggers-new-objects)
## Connectivity Test Failure During Application Startup
If a connectivity test fails during application startup and you see the following statement in the
stack trace, configure a reconnection strategy for the connector:
```xml
Caused by: java.lang.InterruptedException
at java.util.concurrent.locks.AbstractQueuedSynchronizer.doAcquireSharedInterruptibly(AbstractQueuedSynchronizer.java:998) ~[?:1.8.0_221]
```
To configure a reconnection strategy for the connector in Anypoint Studio (Studio), add these lines
to the **Configure XML** tab in the connector properties window:
```xml
```
For example, the configuration XML for the connector might look like this after you add the
reconnection strategy:
```xml
```
In Studio, you can also use the **Advanced** tab in the connector properties window to configure a
reconnection strategy. To do so, complete the following fields:
| Field | Value |
|---|
Reconnection strategy | Standard
|
Frequency (ms) | 5
|
Reconnection Attempts | 2
|
## No Logging of Log Requests and Responses
To log requests and responses when using the connector, add this XML statement to the `Log4j`
configuration file:
```xml
```
## Permissions Error When Fetching Metadata
To avoid receiving a permissions error when fetching metadata, enable the
`Control SuiteScript and Workflow Triggers in Web Services Request` option in NetSuite for the role
used in the connector configuration.
## Inability to Search for Certain Types of Objects
There is a limitation in NetSuite’s SuiteTalk API, that prevents you from searching for certain
types of objects, such as Sales Order objects. Because of this limitation, you can’t use the
NetSuite Connector `Search` operation to locate these objects.
To perform a search for Sales Order objects and other unsupported objects, you can create a saved
search and call it from the connector.
## On Modified Object Triggers New Objects
The **On Modified Object** source also triggers new objects. NetSuite populates the
`lastModifiedDate` field when an object is created. When the **On Modified Objects** source polls
objects based on `lastModifiedDate`, the **On Modified Object** source retrieves all new objects
too, because all new objects have the `lastModifiedDate` field populated.
## See Also
- [Salesforce Help](https://help.salesforce.com)
- [Known Issues](https://help.salesforce.com/s/issues)
---
product: NetSuite Connector
version: 11.10
---
# NetSuite Connector 11.10 XML and Maven Support
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio:
If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML
editor or from a text editor, you can access the connector from your app by adding reference
statements to both your XML Mule flow and the Apache Maven `pom.xml` file.
If you add the connector in Studio, Studio automatically populates the XML code with the connector’s
namespace and schema location and it also adds a dependency to the `pom.xml` file.
## Add a Namespace for the Connector
Paste the following code inside the `mule` tag of the header of your configuration XML:
```xml
http://www.mulesoft.org/schema/mule/netsuite
http://www.mulesoft.org/schema/mule/netsuite/current/mule-netsuite.xsd
```
This example shows how the namespace statements are placed in the `` XML block:
```xml
```
## Add a POM File Dependency
The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to
this connector:
```xml
com.mulesoft.connectors
mule-netsuite-connector
x.x.x
mule-plugin
```
Replace `x.x.x` with the version that corresponds to the connector you are using.
To obtain the most up-to-date `pom.xml` file information:
1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).
2. In Exchange, click **Login** and supply your Anypoint Platform username and password.
3. In Exchange, search for `netsuite`.
4. Select the connector.
5. Click **Dependency Snippets** near the upper right of the screen.
## Next Step
After completing your namespace and `pom.xml` file, you can try the
[NetSuite examples](https://docs.mulesoft.com/netsuite-connector/11.10/netsuite-examples).
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Salesforce Help](https://help.salesforce.com)
---
product: NetSuite Connector
version: 11.11
---
# NetSuite Connector 11.11
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Anypoint Connector for NetSuite (NetSuite Connector) synchronizes data and automates business
processes between NetSuite and third-party applications, either on-premises or in the cloud.
NetSuite provides cloud-based business management software that helps companies manage core business
processes, ERP financials, CRM, e-commerce, inventory, and more.
NetSuite Connector provides the following features:
- SOAP-based integration
NetSuite Connector 11.0 and later does not support REST-based operations.
- Generation of NetSuite business objects
- Different authentication levels
- Error-handling support
For compatibility information and fixed issues, see the
[NetSuite Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/netsuite-connector-release-notes-mule-4).
## Before You Begin
To use this connector, you must be familiar with:
- The NetSuite API
- Anypoint connectors
- Mule runtime engine (Mule)
- Elements and global elements in a Mule flow
- Creating a Mule app using Anypoint Studio or Anypoint Code Builder
Before creating an app, you must have:
- Credentials to access NetSuite Web Services
- Anypoint Studio version 7.3.3 or later
## Common Use Cases for the Connector
- Quote-to-Cash
Improve cash flow, remove manual order entries, and minimize order errors by leveraging realtime
integrations to connect and synchronize data about your customer’s intent to buy from your CRM
application, such as Salesforce, into its realization of revenue in NetSuite ERP.
- Invoice-to-Reconciliation
Automate your Accounts Receivable (A/R) process by automatically applying bank payments against
invoices in NetSuite for real-time A/R processing. Streamline accounts payable by automating
payment file transfers between NetSuite and your banks.
- Hire-to-Retire
Build a single view of your employees with realtime synchronization of employee information
between Netsuite and your Human Capital Management (HCM) services, such as Workday, Oracle HCM,
PeopleSoft, and so on. Automatically trigger employee onboarding processes such as ordering
computer equipment, uniforms, system access setup, and so on, while reversing the process upon
retirement.
## Authentication types
NetSuite connections use token-based authentication, which uses either a consumer key and token ID
or secret pairs to authenticate.
For information about configuring this authentication type, see
[Using Anypoint Studio to Configure NetSuite Connector](https://docs.mulesoft.com/netsuite-connector/11.11/netsuite-studio-configure).
## Using Exchange Templates and Examples
[Anypoint Exchange](https://www.mulesoft.com/exchange/) provides the following templates that you
can use as starting points for your apps:
- [Retrieve a List of Customers from NetSuite](https://www.mulesoft.com/exchange/org.mule.examples/get-customer-list-from-netsuite/)
- [Salesforce and NetSuite Opportunity Aggrgation](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2nets-opportunity-aggregation/)
## Next Step
After you complete the prerequisites, you are ready to create your own app and configure the
connector using [Anypoint Studio](https://docs.mulesoft.com/netsuite-connector/11.11/netsuite-studio-configure).
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange)
- [Salesforce Help](https://help.salesforce.com)
---
product: NetSuite Connector
version: 11.11
---
# NetSuite Connector 11.11 Examples
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
The following examples show how to perform searches in Anypoint Connector for NetSuite (NetSuite
Connector):
- [Account Basic Search Filtering by an Integer Field](#account-basic-search)
Obtain the Account records with internal IDs that are less than the value of the `internalId`
query parameter.
- [Employee Basic Search Filtering by the Boolean and String Fields](#employee-basic-search)
Obtain the inactive Employee records that have last names beginning with a specified letter.
- [Customer Advanced Search Filtering by the Date and Array Fields](#customer-advanced-search)
Obtain the customer records that were created after 2015 and that are in the LEAD stage.
The following example shows how to add a file in NetSuite Connector:
- [Add a File](#add-file)
Add a file using the **Add** operation.
The following example shows how to use custom fields and records in NetSuite Connector:
- [Add a Custom Record](#add-custom-record)
Add a custom record with custom fields.
- [Get a Custom Record](#get-custom-record)
Get a custom record with custom fields.
- [Delete a Custom Record](#delete-custom-record)
Delete a custom record with custom fields.
## Account Basic Search Filtering by an Integer Field
This example shows how to use the NetSuite Connector `Search` operation to obtain the Account
records with internal IDs that are less than the value provided.
This example requires that at least one basic account meets the search condition in the NetSuite
instance.
The following screenshot shows the Studio app flow for this example:

Figure 1. Account basic search app flow in Studio
Creating this example involves creating a new Mule project and configuring `HTTP Listener`, the
NetSuite Connector `Search` operation, one `For Each` component, and two `Transform Message`
components.
### Configure HTTP Listener
Configure HTTP Listener to initiate a Mule flow when a call is made to the `/account` path on
localhost port 8081:
1. Create a new Mule project in Studio.
2. In Studio, click **HTTP** and drag the **Listener** operation to the canvas.
3. Change the display name of the **Listener** operation to `/account`.
4. On the Listener properties window, click **+** next to the **Connector configuration** field to
add a global element.
5. Accept the defaults.
6. On the Listener properties window, set the **Path** field value to `/account`.
### Add the first Transform Message Component
This **Transform Message** component contains the search criteria for the flow:
1. From the **Mule Palette** view, drag a **Transform Message** component to the right of
**Listener**.
2. Change the name of the **Transform Message** component to `Search Criteria`.
3. Click the **Transform Message** component.
The **Output** column displays the metadata of the **AccountSearchBasic** object. You can build
up the criteria from there, or copy the criteria shown below.
Setting the **searchValue** field to `attributes.queryParams["internalId"]` directs the
connector to use the value through the query parameter.
The DataWeave code should look like this:
```dataweave
%dw 2.0
output application/xml
ns ns0 urn:messages_2020_2.platform.webservices.netsuite.com
ns ns01 urn:common_2020_2.platform.webservices.netsuite.com
ns ns02 urn:core_2020_2.platform.webservices.netsuite.com
ns xsi http://www.w3.org/2001/XMLSchema-instance
---
{
ns0#search: {
ns0#searchRecord @("xmlns:ns01": ns01, xsi#"type": "ns01:AccountSearchBasic"): {
ns01#internalIdNumber @(operator: "lessThan"): {
ns02#searchValue: attributes.queryParams["internalId"]
}
}
}
}
```
### Add the NetSuite Connector Search Operation
1. From the **Mule Palette** view, select **NetSuite** and drag the **Search** operation to the
right of **Search Criteria**.
2. Change the display name of the **Search** operation to `Search Account`.
3. Select an existing global element or create a new one for the **Search** operation.
4. On the Search properties window:
- In the **Key** field, select `AccountSearchBasic`.
- Set the **Page Size** field value to an integer value between `10` and `1000`.
### Add the For Each Component
From the **Mule Palette** view, select **Core** and drag the **For Each** component to the right of
**Search Account**.
### Add the Second Transform Message Component
This **Transform Message** component converts the response to JSON format:
1. From the **Mule Palette** view, drag a **Transform Message** component inside the **For Each**
component.
2. Change the name of the **Transform Message** component to `Response to JSON`.
3. Click the **Transform Message** component and set the output to `application/json`.
```dataweave
%dw 2.0
output application/json
ns ns0 urn:core_2020_2.platform.webservices.netsuite.com
---
payload.ns0#record
```
4. Drag and drop a **Logger** component from the **Mule Palette** view to the right of **Response
to JSON**. Leave the message as `#[payload]`
### Run the App
To run the app:
1. Start the Mule app.
2. Call `http://localhost:8081/account?internalId=5` to retrieve the `Account` records with
internal IDs that are less than 5.
3. You will only be able to see the output from the Mule App console.
### XML for Account Basic Search Flow
Paste this code into a new Mule app in Studio to quickly load the flow for the Account basic search
example. If needed, change the values to reflect your environment.
```xml
```
## Employee Basic Search Filtering by the Boolean and String Fields
This example shows how to use the `Search` operation to obtain the inactive `Employee` records that
have last names beginning with a specified letter.
This example requires that at least one employee record in the NetSuite instance meets the search
conditions.
The following screenshot shows the Studio app flow for the Employee basic search example:

Figure 2. Employee basic search app flow in Studio
Creating this example involves creating a new Mule project and configuring `HTTP Listener`, the
NetSuite Connector `Search` operation, one `For Each` component, and two `Transform Message`
components.
### Configure HTTP Listener
Configure HTTP Listener to initiate a Mule flow when a call is made to the `/employee` path on
localhost port 8081:
1. In Studio, click **HTTP** and drag the **Listener** operation to the canvas.
2. Change the display name of the **Listener** operation to `/employee`.
3. Either select an existing global element or create a new one for **HTTP Listener** and keep the
defaults.
4. On the Listener properties window, set the **Path** field value to `/employee`.
### Add the First Transform Message Component
This **Transform Message** component contains the search criteria for the flow:
1. From the **Mule Palette** view, drag the **Transform Message** component to the right of
**Listener**.
2. Change the name of the **Transform Message** component to `Search Criteria`.
3. Click the **Transform Message** component.
The **Output** column displays the metadata of the **AccountSearchBasic** object. You can build
up the criteria from there, or copy the criteria below.
The value `attributes.queryParams["isInactive"]` directs the connector to search for inactive
employee accounts, and the value `attributes.queryParams["lastName"]` directs the connector to
search employee which last names start with the value provided.
The DataWeave code should look like this:
```dataweave
%dw 2.0
output application/xml
ns ns0 urn:messages_2020_2.platform.webservices.netsuite.com
ns ns01 urn:common_2020_2.platform.webservices.netsuite.com
ns ns02 urn:core_2020_2.platform.webservices.netsuite.com
ns xsi http://www.w3.org/2001/XMLSchema-instance
---
{
ns0#search: {
ns0#searchRecord @("xmlns:ns01": ns01, xsi#"type": "ns01:EmployeeSearchBasic"): {
ns01#lastName @(operator: "startsWith"): {
ns02#searchValue: attributes.queryParams["lastName"]
},
ns01#isInactive: {
ns02#searchValue: attributes.queryParams["isInactive"]
}
}
}
}
```
### Add the NetSuite Connector Search Operation
1. From the **Mule Palette** view, select **NetSuite** and drag the **Search** operation to the
right of **Search Criteria**.
2. Change the display name of the **Search** operation to `Search Employee`.
3. Select an existing global element or create a new one for the **Search** operation.
4. On the Search properties window:
- In the **Key** field, select `EmployeeSearchBasic`.
- Set the **Page Size** field value to an integer value between `10` and `1000`.
### Add the For Each Component
From the **Mule Palette** view, select **Core** and drag the **For Each** component to the right of
**Search Employee**.
### Add the Second Transform Message Component
This **Transform Message** component converts the response to JSON format:
1. From the **Mule Palette** view, drag a **Transform Message** component inside the **For Each**
component.
2. Change the name of the **Transform Message** component to `Response to JSON`.
3. Click the **Transform Message** component and set the output to `application/json`.
```dataweave
%dw 2.0
output application/json
ns ns0 urn:core_2020_2.platform.webservices.netsuite.com
---
payload.ns0#record
```
4. Finally, drag and drop a **Logger** component from the **Mule Palette** view, to the right of
**Response to JSON**. the message should be `#[payload]`
### Run the App
1. Start the Mule app.
2. Call `http://localhost:8081/employee?isInactive=true&lastName=C` to retrieve the inactive
`Employee` records that have last names beginning with `C`.
3. You will **ONLY** be able to see the output from the Mule App console.
### XML for Employee Basic Search Flow
Paste this code into a new Mule app in Studio to quickly load the flow for the Employee basic search
example. If needed, change the values to reflect your environment.
```xml
```
## Customer Advanced Search Filtering by Stage field and Date Created field
This example shows how to use the `Search` operation to obtain the customer records that were
created after 2015 and that are in the `LEAD` stage.
This examples requires that at least one customer record meets the search conditions in the NetSuite
instance.
The following screenshot shows the Studio app flow for this example:

Figure 3. Customer advanced search app flow in Studio
Creating this example involves creating a new Mule project and configuring `HTTP Listener`, the
NetSuite `Search` operation, two `Transform Message` components, and a `For-Each` component.
### Configure HTTP Listener
Configure HTTP Listener to initiate a Mule flow when a call is made to the `/customer` path on
localhost port 8081:
1. In Studio, click **HTTP** and drag the **Listener** operation to the canvas.
2. Change the display name of the **Listener** operation to `/customer`.
3. Select an existing global element or create a new one for the **Listener** operation.
4. On the Listener properties window, set the **path** field value to `/customer`.
### Add the First Transform Message Component
This **Transform Message** component specifies the search criteria for the flow:
1. From the **Mule Palette** view, drag the **Transform Message** component to the right of
**Listener**.
2. Change the name of the **Transform Message** component to `Search Criteria`.
3. Click the **Transform Message** component.
The **Output** column displays the metadata of the **CustomerSearchAdvanced** object. You can
build up the criteria from there, or copy the criteria below.
Setting the **searchValue** of `stage` to `attributes.queryParams["stage"]` directs the
connector to use the value of the `stage` query parameter.
The DataWeave code should look like this:
```dataweave
%dw 2.0
output application/xml
ns ns0 urn:messages_2020_2.platform.webservices.netsuite.com
ns ns01 urn:common_2020_2.platform.webservices.netsuite.com
ns ns02 urn:core_2020_2.platform.webservices.netsuite.com
ns ns03 urn:relationships_2020_2.lists.webservices.netsuite.com
ns xsi http://www.w3.org/2001/XMLSchema-instance
---
{
ns0#search: {
ns0#searchRecord @("xmlns:ns03": ns03, xsi#"type": "ns03:CustomerSearchAdvanced"): {
ns03#criteria: {
ns03#basic: {
ns01#stage @(operator: "anyOf"): {
ns02#searchValue: [attributes.queryParams["stage"]]
},
ns01#dateCreated @(operator: "after"): {
ns02#searchValue: "2015-01-01T00:00:00.000-08:00"
}
}
}
}
}
}
```
### Add the NetSuite Connector Search Operation
1. From the **Mule Palette** view, select **NetSuite** and drag the **Search** operation to the
right of **Search Criteria**.
2. Change the display name of the **Search** operation to `Search Customer Advanced`.
3. Select an existing global element or create a new one for the **Search** operation.
4. On the Search properties window:
- In the **Key** field, select `CustomerSearchAdvanced`.
- Set the **Page Size** field value to an integer value between `10` and `1000`.
- Click on **Search Preferences** and select `false` on `Return search columns`
### Add a For-Each Component
A `For-Each` component processes each record on the list returned by the `Search` operation
individually so that the records can be displayed on the console.
1. From the **Mule Palette** view, drag a **For-Each** component to the right of **Search**.
2. Drag a **Transform Message** component inside the **For Each** box, rename the component to
`Response to JSON`, and replace the DataWeave code with this code:
```dataweave
%dw 2.0
output application/json
ns ns0 urn:core_2020_2.platform.webservices.netsuite.com
---
payload.ns0#record
```
3. Drag a **Logger** component from the **Mule Palette** view to the right of **Transform**, inside
the **For Each** box.
4. On the Logger properties window, set the **Message** field value to `#[payload]`.
### Run the App
1. Start the Mule app.
2. Call `http://localhost:8081/customer?stage=LEAD`.
3. You will **ONLY** be able to see the output from the Mule App console.
### XML for the Customer Advanced Search Flow
Paste this code into a new Mule app in Studio to quickly load the flow for the Customer Advanced
Search example. If needed, change the values to reflect your environment.
```xml
```
## Add a File
This example shows how to use the **Add** operation to add a file using NetSuite Connector.
The following screenshot shows the Studio app flow for this example:

Creating this example involves creating a new Mule project and configuring a **Listener** component,
**Transform Message** component, **Add** operation, and **Logger** component.
### Configure HTTP Listener
Configure HTTP Listener to initiate a Mule flow when a call is made to the `/upload` path:
1. Create a new Mule project in Studio.
2. In Studio, click **HTTP** and drag the **Listener** component to the canvas.
3. In the **Listener** properties window, click **+** next to the **Connector configuration** field
to add a global element.
4. Accept the defaults.
5. In the **Listener** properties window, set the **Path** field value to `/upload`.
### Add the Transform Message Component
Add the **Transform Message** component to convert the values from the HTTP input to XML format so
they can be used as input for the **Add** operation:
1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to
the right of **Listener**.
2. In the properties window, overlay the brackets in the **Output** section with this DataWeave
code:
```dataweave
%dw 2.0
output application/xml
ns ns0 urn:messages_2020_2.platform.webservices.netsuite.com
ns ns01 urn:filecabinet_2020_2.documents.webservices.netsuite.com
ns xsi http://www.w3.org/2001/XMLSchema-instance
ns ns02 urn:core_2020_2.platform.webservices.netsuite.com
---
{
ns0#add: {
ns0#record @("xmlns:ns01": ns01, xsi#"type": "ns01:File"): {
ns01#name: "test.csv",
ns01#content: "Here is the content of file",
ns01#folder @(internalId: 826997 , xsi#"type": "ns01:RecordRef"): {
ns02#name: null
}
}
}
}
```
### Add the Add Operation
Add the **Add** operation to add a file using the values passed by the **Transform Message**
component:
1. From the **Mule Palette** view, select **NetSuite** and drag the **Add** operation to the right
of **Transform Message**.
2. In the properties window, click **+** next to the **Connector configuration** field to add a
global element.
3. Configure the global element depending on the connection, for example:
| Field | Value |
|---|
Consumer key | ${netsuite.consumerKey}
|
Consumer secret | ${netsuite.consumerSecret}
|
Token ID | ${netsuite.tokenId}
|
Token secret | ${netsuite.tokenSecret}
|
Account Id | ${netsuite.account}
|
Signature algorithm | HMAC_SHA256
|
Wsdl version | V2020_2
|
SOAP Port | services/NetSuitePort_2020_2
|
The following image shows an example of the **Add** configuration of the global element:

4. In the properties window, configure the following fields:
| Field | Value |
|---|
Display Name | Name for the connector operation. |
Connector configuration | Global configuration you just created. |
Type | file
|
Message | vars.fileRecord
|
The following image shows an example of the **Add** configuration in the properties window:

### Add the Logger Component
Add the **Logger** component to display the response in the Mule console:
1. From the **Mule Palette** view, select **Core** and drag a **Logger** component to the right of
**Add**.
2. In the properties window, configure the following fields:
| Field | Value |
|---|
Display Name | Name for the logger, such as Logger. |
Message | The file was added
|
Level | INFO (Default) |
The following image shows an example of the **Logger** configuration in the properties window:

### Run the App
To run the app:
1. Start the Mule app.
2. Call `http://localhost:8081/upload` to add the file.
### XML for the Add File Flow
Paste this code into a new Mule app in Studio to quickly load the flow for the Add File example. If
needed, change the values to reflect your environment.
```xml
```
## Custom Records and Fields
The following example shows how to add, get, and delete custom records with custom fields using
DataWeave. Use DataSense, which imports metadata from NetSuite Connector, to simplify application
design.
The following screenshot shows the Studio app flow for this example:

Creating this example involves adding the **Add** operation, **Set Variable** component, **Get**
operation, and **Delete** operation.
### Add a Custom Record
Add a custom record with custom fields using the **Add** operation.
Include the following attributes to add a custom record:
- **separators**
Specifies a separator character. The separator in the following example is `__`.
- **recordType**
References the custom record type. The recordType in the following example is `customRecordType`.
- **scriptId**
References the script ID of the record. The scriptId in the following example is
`customrecord_2663_bank_details`.
- **internalId**
References the internal ID of the record. The internalId in the following example is `374`.
- **XSI type**
Specify the XSI type as **CustomRecordRef** to add a custom record.
The following DataWeave script adds a custom record with custom fields:
%dw 2.0 output application/xml ns ns0 urn:messages\_2020\_2.platform.webservices.netsuite.com ns
ns01 urn:customization\_2020\_2.setup.webservices.netsuite.com ns ns02
urn:core\_2020\_2.platform.webservices.netsuite.com ns xsi http://www.w3.org/2001/XMLSchema-instance
---
{ ns0#add: { ns0#record @("xmlns:ns01": ns01, xsi#"type": "ns01:CustomRecord"): {
ns01#customFieldList: { StringCustomFieldRef\_\_custrecord\_2663\_legal\_name\_\_3878: { ns02#value:
"test" }, LongCustomFieldRef\_\_custrecord\_2663\_eft\_file\_cabinet\_id\_\_3874: { ns02#value: 1234
}, BooleanCustomFieldRef\_\_custrecord\_2663\_dd\_batch\_\_3864: { ns02#value: true } } } } }
The customFieldList contains the customFields for the entity you use.
The example above shows `StringCustomFieldRef__custrecord_2663_legal_name__3878`,
`BooleanCustomFieldRef__custrecord_2663_dd_batch__3864` and
`LongCustomFieldRef__custrecord_2663_eft_file_cabinet_id__3874`. The field names consist of a
**scriptId**, **internalId**, and **CustomRecordRef** type.
`StringCustomFieldRef__custrecord_2663_legal_name__3878` has a specified value `ns02#value: "test"`,
`LongCustomFieldRef__custrecord_2663_eft_file_cabinet_id__3874` has a specified value
`ns02#value: 1234`, and `BooleanCustomFieldRef__custrecord_2663_dd_batch__3864` has a specified
value `ns02#value: true`.
### Get Custom Record
Get a custom record with custom fields using the **Get** operation.
Include the following attributes to get a custom record:
- **typeId**
References the custom record type Id. The typeId in the following example is `374`.
- **internalId**
References the internalId of the record. The internalId in the following example is
`vars.responseInternalId`.
- **XSI type**
Specify the XSI type as **CustomRecordRef** to retrieve a custom record.
The following DataWeave script gets a custom record with custom fields:
%dw 2.0 output application/xml ns ns0 urn:messages\_2020\_2.platform.webservices.netsuite.com ns
ns01 urn:core\_2020\_2.platform.webservices.netsuite.com ns xsi http://www.w3.org/2001/XMLSchema-instance
---
{ ns0#get: { ns01#baseRef @(internalId: vars.responseInternalId , "typeId": "374", xsi#"type":
"ns01:CustomRecordRef"): null } }
### Delete Custom Record
Delete a custom record with custom fields using the **Delete** operation.
Include the following attributes to delete a custom record:
- **typeId**
References the custom record type Id. The typeId in the following example is `374`.
- **internalId**
References the internalId of the record. The internalId in the following example is
`vars.responseInternalId`.
- **XSI type**
Specify the XSI type as **CustomRecordRef** to delete a custom record.
The following DataWeave script deletes a custom record with custom fields:
%dw 2.0 output application/xml ns ns0 urn:messages\_2020\_2.platform.webservices.netsuite.com ns
ns01 urn:core\_2020\_2.platform.webservices.netsuite.com ns xsi http://www.w3.org/2001/XMLSchema-instance
---
{ ns0#delete: { ns01#baseRef @(internalId: vars.responseInternalId , "typeId": "374", xsi#"type":
"ns01:CustomRecordRef"): null } }
### XML for Custom Records
Paste this code into a new Mule app in Studio to quickly load the flow for the custom records
example. If needed, change the values to reflect your environment.
```xml
```
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Salesforce Help](https://help.salesforce.com)
---
product: NetSuite Connector
version: 11.11
---
# NetSuite Connector 11.11 Reference
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Anypoint Connector for NetSuite synchronizes data and automates business processes between NetSuite
and third party applications, either on-premises or in the cloud. The connector makes use of the
SuiteTalk WSDL to provide SOAP based integration to generate NetSuite business objects, make use of
different authentication levels, and support error handling.
Release Notes:
[NetSuite Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/netsuite-connector-release-notes-mule-4)
## Configurations
---
### Config
#### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Name | String | The name for this configuration. Connectors reference the configuration with this name. | | x |
Connection | | The connection types to provide to this configuration. | | x |
Name | | The identifier of this element used to reference it in other components | | x |
Expiration Policy | | Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate. | | |
Show warnings as errors | | When this preference is enabled, warning messages generated by NetSuite are treated as errors that cause an exception, resulting in rejection of the request. | false | |
Disable mandatory custom field validation | | This preference affects the handling of custom fields that are configured in the UI to be mandatory: If you set this field to true, the fields are not treated as required during SOAP web services requests. If you set this field to false, the fields are required.
| false | |
Disable system notes for custom fields | | System notes are system-generated records that track changes to a record, including changes to specific field values. This preference lets you disable the creation of system notes for changes to custom fields. Depending on your integration, using this preference can increase performance. | false | |
Ignore read-only fields | | This preference affects the way the system behaves when you mistakenly submit a value for a read-only field. If you set this preference to true, the system ignores these mistakes. | false | |
Run server SuiteScript and trigger workflows | | Controls SuiteScript and trigger workflows per request: If you do not include this preference in a request, the company preference set on the Web Services Preferences page is used. If you include this preference in the request, the connector overrides the company preference set in the UI.
| false | |
Send runServerSuiteScript tag in Preferences header | | Sends the runServerSuiteScript tag in the Preferences header. | false | |
Customizations Separator | | Separator used to generate the keys required to provided better support for custom fields and records. If the script ID of the customization that defines a custom field or record contains the separator default character, set up a new ID and regenerate the metadata. | __ | |
Omit the internal Id in the name of the custom field | | Omits the internal ID from the custom field name: If you set this field to true, the custom field name is CUSTOMFIELDTYPE__SCRIPTID. If you set this field to false, the custom field name is CUSTOMFIELDTYPE__SCRIPTID__INTERNALID.
| | |
#### Connection Types
The connection types to provide to this configuration.
##### Token-Based Authentication
###### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Maximum Connections | | The maximum number of connections that can be active to execute the HTTP requests. The default value, -1, does not limit the number of connections to the server. | -1 | |
Read Timeout | | Specifies the amount of time that the client waits for a response before it times out. Use 0 to specify that the client should wait indefinitely. | 60000 | |
Read Timeout Unit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS
| The time unit for Read Timeout. | MILLISECONDS | |
Connection Timeout | | Specifies the amount of time that the client attempts to establish a connection before it times out. Use 0 to specify that the client continue to attempt to open a connection indefinitely. | 60000 | |
Connection Timeout Unit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS
| The time unit for Connection Timeout. | MILLISECONDS | |
Base Netsuite Address | | The base address to use to connect to NetSuite. The default value is the main NetSuite site. This is used to automatically obtain the endpoint for the service based on the credentials configured, and will need no change. | https://webservices.netsuite.com
| |
Concurrency Management Strategy | | Strategy to use when encountering the TOO_MANY_REQUESTS error. | | |
Wsdl version | V2020_2 V2021_1 V2023_1 V2025_2
| Version of WSDL that the connector uses to communicate with NetSuite: If you do not select a value, the connector works with SuiteTalk version 2020_2 and existing namespaces in the Mule app must not be modified. If you select a WSDL version, remove the SuiteTalk version from all namespaces in the Mule app. The following example shows an original DataWeave script with the SuiteTalk version and a new DataWeave script with the SuiteTalk version removed. #%dw 2.0
output application/java
ns ns0 urn:messages_2020_2.platform.webservices.netsuite.com
ns ns01 urn:core_2020_2.platform.webservices.netsuite.com
---
payload.ns0#changePasswordResponse.ns0#sessionResponse.ns01#status.ns01#statusDetail.ns01#code #%dw 2.0
output application/java
ns ns0 urn:messages.platform.webservices.netsuite.com
ns ns01 urn:core.platform.webservices.netsuite.com
---
payload.ns0#changePasswordResponse.ns0#sessionResponse.ns01#status.ns01#statusDetail.ns01#code
| | |
SOAP Port | | The SOAP Port path to use to connect to NetSuite, this is relative to the base address. The default value corresponds to the port obtained from the WSDL used in the version of the connector. | | x |
TLS configuration | | Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the keystore in the tls:context child element of the listener-config. | | |
Host | | The hostname of the HTTP proxy, for example, localhost. This field requires the port to be set. | | |
Port | | The port number of the HTTP proxy, for example, 3128. The port number must be specified if the hostname is also specified. | | |
Username | | The username to supply to the HTTP proxy on every request to NetSuite. This field is optional because a user might want to pass through an unauthenticated HTTP proxy. | | |
Password | | The password to supply to the HTTP proxy on every request to NetSuite. This field is optional because a user might want to pass through an unauthenticated HTTP proxy. | | |
Non proxied hosts | | A list of comma-separated hosts against which the proxy should not be used | | |
Consumer Key | | The consumer key value for the enabled token-based authentication integration record | | x |
Consumer Secret | | The consumer secret value for the token-based authentication integration record | | x |
Token ID | | The token ID representing the unique combination of a user and integration generated within the NetSuite environment | | x |
Token Secret | | The respective token secret for the user/integration pair | | x |
Account Id | | NetSuite SuiteTalk WebService account ID. | | x |
Signature Algorithm | | The algorithm used to compute the SHA hash signature | HMAC_SHA256 | |
Reconnection | | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. | | |
## Supported Operations
- [Add](#Add)
- [Add List](#AddList)
- [Async Add List](#AsyncAddList)
- [Async Delete List](#AsyncDeleteList)
- [Async Get List](#AsyncGetList)
- [Async Initialize List](#AsyncInitializeList)
- [Async Search](#AsyncSearch)
- [Async Update List](#AsyncUpdateList)
- [Async Upsert List](#AsyncUpsertList)
- [Attach](#Attach)
- [Change Email](#ChangeEmail)
- [Change Password](#ChangePassword)
- [Check Async Status](#CheckAsyncStatus)
- [Delete](#Delete)
- [Delete List](#DeleteList)
- [Detach](#Detach)
- [Get](#Get)
- [Get Account Governance Info](#GetAccountGovernanceInfo)
- [Get All](#GetAll)
- [Get Async Result](#GetAsyncResult)
- [Get Budget Exchange Rate](#GetBudgetExchangeRate)
- [Get Currency Rate](#GetCurrencyRate)
- [Get Customization Id](#GetCustomizationId)
- [Get Data Center Urls](#GetDataCenterUrls)
- [Get Deleted](#GetDeleted)
- [Get Integration Governance Info](#GetIntegrationGovernanceInfo)
- [Get Item Availability](#GetItemAvailability)
- [Get List](#GetList)
- [Get Posting Transaction Summary](#GetPostingTransactionSummary)
- [Get Saved Search](#GetSavedSearch)
- [Get Select Value](#GetSelectValue)
- [Get Server Time](#GetServerTime)
- [Initialize](#Initialize)
- [Initialize List](#InitializeList)
- [Search](#Search)
- [Update](#Update)
- [Update Invitee Status](#UpdateInviteeStatus)
- [Update Invitee Status List](#UpdateInviteeStatusList)
- [Update List](#UpdateList)
- [Upsert](#Upsert)
- [Upsert List](#UpsertList)
## Associated Sources
- [On Deleted Object](#DeletedObjectListener)
- [On Modified Object](#ModifiedObjectListener)
- [On New Object](#NewObjectListener)
## Operations
## Add
``
Creates a new record.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The message to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configures how Mule processes streams. Repeatable streams are the default behavior. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Add List
``
Creates one or more new records.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The add list request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configures how Mule processes streams. Repeatable streams are the default behavior. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Add List
``
An asynchronous request equivalent to Add List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, NetSuite returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The Async Add List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configures how Mule processes streams. Repeatable streams are the default behavior. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Delete List
``
An asynchronous request equivalent to the Delete List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The Async Delete List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configures how Mule processes streams. Repeatable streams are the default behavior. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Get List
``
An asynchronous request equivalent to the Get List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The Async Get List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Initialize List
``
An asynchronous request equivalent to the Initialize List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The Async Initialize List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Search
``
An asynchronous request equivalent to the Search operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Key | | The type of search that renders the output metadata. | | |
Message | | The Async Search request to complete. | #[payload] | |
Body Fields Only | | Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to false, all fields associated with the record are returned. | true | |
Return Search Columns | | If true, only search columns are returned in your search. | true | |
Page Size | | Maximum amount of results per page. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Update List
``
An asynchronous request equivalent to the Update List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The Async Update List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Upsert List
``
An asynchronous request equivalent to the Upsert List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The Async Upsert List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Attach
``
Defines a relationship between two records.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Attach Ref Type | | The attach reference type. | | |
Message | | The attach request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Change Email
``
Changes the email address for the account.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
New Email | | Your new email address. | | x |
Current Credentials | | Your current credentials. | | x |
Just This Account | | Whether to change this account only. | true | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INSUFFICIENT\_PERMISSION
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Change Password
``
Changes the password for the account.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
New Password | | The new password. | | x |
Current Password | | Your current credentials. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INSUFFICIENT\_PERMISSION
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Check Async Status
``
Checks whether a particular asynchronous job finished processing.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Job Id | | The ID of the job. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Delete
``
Delete one or more record instances. Not all records can be deleted. For more information, see the
NetSuite documentation.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The delete request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Ref Type | | Defines the ComplexType of the record. | | |
Type | | Defines the Type of the record. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Delete List
``
Deletes one or more records. Not all records can be deleted. For more information, see the NetSuite
documentation.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The delete list request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Ref Type | | Defines the ComplexType of the record. | | |
Type | | Defines the Type of the record. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Detach
``
Deletes a relationship between two records.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The detach request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get
``
Retrieves a record by providing the unique ID that identifies the record.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Ref Type | | Defines the ComplexType of the record. | | |
Type | | Defines the Type of the record. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Get Account Governance Info
``
Get the account concurrency limit and the unallocated concurrency limit.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get All
``
Retrieves a list of all records of the specified type.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | | | |
Message | | The get All request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get Async Result
``
Returns the result of the specified job if it finished processing.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Job Id | | The ID of the job. | | x |
Page Index | | The page number of the asynchronous result. | 1 | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get Budget Exchange Rate
``
Gets and filters all data related to the Budget Exchange Rates table. This table maintains exchange
rates between the root-parent and child subsidiaries for use in the budgeting process.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The Get Budget Exchange Rate request, which contains a budgetExchangeRateFilter. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get Currency Rate
``
Gets the exchange rate between two currencies based on the specified certain date.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | Accepts the argument CurrencyRateFilter, which specifies what to return in the results. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INSUFFICIENT\_PERMISSION
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get Customization Id
``
Returns the IDs of available customizations for a given customization type.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | Customization type | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get Data Center Urls
``
Obtains the NetSuite data center URL for the account.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Account Id | | The account ID. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get Deleted
``
Returns a list of deleted records for the given record type and date range.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Filter | | Filters the results | #[payload] | |
Limit | | The maximum amount of results to return from this call | -1 | |
Page Size | | Maximum amount of results per page. | 10 | |
Output Mime Type | | The MIME type of the payload that this operation outputs. | | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:SESSION\_TIMED\_OUT
## Get Integration Governance Info
``
Get the concurrency limit for the integration (integrationConcurrencyLimit) and the limit type
(limitType), which can be:
- \_integrationSpecific, when a limit has been allocated.
- \_internal, when it is an internal application. In this case the limit is not displayed.
- \_accountLimit, when no specific limit has been allocated to the integration.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get Item Availability
``
Returns the availability for a given item record reference. If the Multi-Location Inventory feature
is enabled, connector returns results for all locations.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The GetItem Availability Request type, which contains an itemAvailabilityFilter | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get List
``
Retrieves a list of one or more records by providing the unique ids that identify those records.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The get list request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Ref Type | | Defines the ComplexType of the record. | | |
Type | | Defines the Type of the record. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get Posting Transaction Summary
``
Retrieves a summary of the data posted to the general ledger in an account. You can use the
available filters and fields to generate reports that are similar to what you see when you run
financial reports such as a Trial Balance, Balance Sheet, or an Income Statement.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Fields | | Fields for the operation body | | |
Filters | | Filters for the operation body | | |
Operation Id | | Operation ID | | |
Output Mime Type | | The MIME type of the payload that this operation outputs. | | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:SESSION\_TIMED\_OUT
## Get Saved Search
``
Retrieves a list of existing saved search IDs on a per-record-type basis.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Search Type | | The targeted search type. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get Select Value
``
Returns valid select options for a particular RecordRef, CustomRecordRef, or enumerated static
field.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Field Description | | The get select value request to complete. | #[payload] | |
Page Size | | | 10 | |
Output Mime Type | | The MIME type of the payload that this operation outputs. | | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
### For Configurations
- [Config](#Config)
## Get Server Time
``
Returns the NetSuite server time in GMT, regardless of a user’s time zone.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Initialize
``
Pre-populates fields on transaction line items with values from a related record.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The initialize request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Initialize List
``
Pre-populates fields on transaction line items with values from related records.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The initialize list request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Search
``
Executes a search on a specific record type based on a set of criteria. This processor has been
enhanced with a paging mechanism. Searches can be Basic, Advanced, or Join searches. See
SearchRecord for all the available searches.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Key | | The type of search to render the output metadata. | | |
Message | | The search request to complete. | #[payload] | |
Page Size | | Maximum amount of results per page. | 10 | |
Limit | | Limits the amount of results produced. Limit <=0 means no limit | -1 | |
Body Fields Only | | Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to false, all fields associated with the record are returned. | true | |
Return Search Columns | | Defaults to true, meaning that only search columns are returned in your search. | true | |
Output Mime Type | | The MIME type of the payload that this operation outputs. | | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:SESSION\_TIMED\_OUT
## Update
``
Updates an existing record.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The update record request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Update Invitee Status
``
Sets a new invitation status for a given event.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The update invitee status request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Update Invitee Status List
``
Sets multiple new invitation statuses for a given event.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The update invitee status list request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Update List
``
Updates one or more instances of a record type. If there are multiple records, they can either be of
the same record type or different record types.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The update list request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Upsert
``
Adds a new instance or updates a record instance in NetSuite. This operation is similar to both the
Add and Update operations, but you can run Upsert without first determining whether a record exists
in NetSuite.
Identify a record by its external ID and its record type. If a record of the specified type with a
matching external ID exists in the system, it is updated. If it does not exist, a new record is
created. Because the external ID is mandatory for this operation, Upsert is supported only for
records that support the external ID field. This operation prohibits the passing of internal ID
values.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The Upsert request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Upsert List
``
Adds or updates one or more instances of a record type in NetSuite. This operation is similar to
both the Add List and Update List operations, but you can run Upsert List without first determining
whether the record types exist in NetSuite.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The Upsert List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Sources
## On Deleted Object
``
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Start Date Time | | Specify a local date. If this field is empty, this operation retrieves the selected objects from the time when the Mule app started. | | |
Page Size | | Maximum amount of results per page. | 10 | |
Body Fields Only | | Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to false, all fields associated with the record are returned. | true | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Scheduling Strategy | | Configures the scheduler that triggers the polling | | x |
Redelivery Policy | | Defines a policy for processing the redelivery of the same message | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | String |
Attributes Type | |
### For Configurations
- [Config](#Config)
## On Modified Object
``
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Start Date Time | | Specify a local date. If this field is empty, this operation retrieves the selected objects from the time the Mule app started. | | |
Page Size | | Maximum amount of results per page. | 10 | |
Body Fields Only | | Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to false, all fields associated with the record are returned. | true | |
Object Type | | The type of record that will be retrieved when modified. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Scheduling Strategy | | Configures the scheduler that triggers the polling | | x |
Redelivery Policy | | Defines a policy for processing the redelivery of the same message | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | String |
Attributes Type | |
### For Configurations
- [Config](#Config)
## On New Object
``
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Start Date Time | | Specify a local date. If this field is empty, this operation will retrieve the selected objects from the time the Mule app was started. | | |
Page Size | | Maximum amount of results per page. | 10 | |
Body Fields Only | | Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to false, all fields associated with the record are returned. | true | |
Object Type | | The type of record that will be retrieved when modified. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Scheduling Strategy | | Configures the scheduler that triggers the polling | | x |
Redelivery Policy | | Defines a policy for processing the redelivery of the same message | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | String |
Attributes Type | |
### For Configurations
- [Config](#Config)
## Types
### Tls
| Field | Type | Description | Default Value | Required |
|---|
Enabled Protocols | | A comma-separated list of protocols enabled for this context. | | |
Enabled Cipher Suites | | A comma-separated list of cipher suites enabled for this context. | | |
Trust Store | | | | |
Key Store | | | | |
Revocation Check | | | | |
### Trust Store
| Field | Type | Description | Default Value | Required |
|---|
Path | | The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store. | | |
Password | | The password used to protect the trust store. | | |
Type | | | | |
Algorithm | | The algorithm used by the trust store. | | |
Insecure | | If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk. | | |
### Key Store
| Field | Type | Description | Default Value | Required |
|---|
Path | | The location (which will be resolved relative to the current classpath and file system, if possible) of the key store. | | |
Type | | | | |
Alias | | When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. | | |
Key Password | | The password used to protect the private key. | | |
Password | | The password used to protect the key store. | | |
Algorithm | | The algorithm used by the key store. | | |
### Standard Revocation Check
| Field | Type | Description | Default Value | Required |
|---|
Only End Entities | | Only verify the last element of the certificate chain. | | |
Prefer Crls | | Try CRL instead of OCSP first. | | |
No Fallback | | Do not use the secondary checking method (the one not selected before). | | |
Soft Fail | | Avoid verification failure when the revocation server can not be reached or is busy. | | |
### Custom Ocsp Responder
| Field | Type | Description | Default Value | Required |
|---|
Url | | The URL of the OCSP responder. | | |
Cert Alias | | Alias of the signing certificate for the OCSP response (must be in the trust store), if present. | | |
### Crl File
| Field | Type | Description | Default Value | Required |
|---|
Path | | The path to the CRL file. | | |
### Reconnection
| Field | Type | Description | Default Value | Required |
|---|
Fails Deployment | | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. | | |
Reconnection Strategy | | The reconnection strategy to use. | | |
### Reconnect
| Field | Type | Description | Default Value | Required |
|---|
Frequency | | How often in milliseconds to reconnect | | |
Blocking | | If false, the reconnection strategy will run in a separate, non-blocking thread | | |
Count | | How many reconnection attempts to make. | | |
### Reconnect Forever
| Field | Type | Description | Default Value | Required |
|---|
Frequency | | How often in milliseconds to reconnect | | |
Blocking | | If false, the reconnection strategy will run in a separate, non-blocking thread | | |
### Expiration Policy
| Field | Type | Description | Default Value | Required |
|---|
Max Idle Time | | A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration | | |
Time Unit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS
| A time unit that qualifies the maxIdleTime attribute | | |
### Netsuite Soap Attributes
| Field | Type | Description | Default Value | Required |
|---|
Soap Headers | | | | |
Transport Additional Data | | | | |
Transport Headers | | | | |
### Redelivery Policy
| Field | Type | Description | Default Value | Required |
|---|
Max Redelivery Count | | The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message | | |
Message Digest Algorithm | | The secure hashing algorithm to use. If not set, the default is SHA-256. | | |
Message Identifier | | Defines which strategy is used to identify the messages. | | |
Object Store | | The object store where the redelivery counter for each message is stored. | | |
### Redelivery Policy Message Identifier
| Field | Type | Description | Default Value | Required |
|---|
Use Secure Hash | | Whether to use a secure hash algorithm to identify a redelivered message. | | |
Id Expression | | Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false. | | |
### Repeatable In Memory Stream
| Field | Type | Description | Default Value | Required |
|---|
Initial Buffer Size | | The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. | | |
Buffer Size Increment | | This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. | | |
Max Buffer Size | | The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. | | |
Buffer Unit | | The unit in which all these attributes are expressed | | |
### Repeatable File Store Stream
File store repeatable streams require buffering, and there are different buffering strategies. Mule
keeps a portion of contents in memory. If the stream contents are larger than the configured buffer
size, Mule backs up the buffer’s content to disk and then clears the memory.
| Field | Type | Description | Default Value | Required |
|---|
In Memory Size | | Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered. | | |
Buffer Unit | | The unit in which maxInMemorySize is expressed | | |
### Repeatable In Memory Iterable
| Field | Type | Description | Default Value | Required |
|---|
Initial Buffer Size | | The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances. | | |
Buffer Size Increment | | This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances. | | |
Max Buffer Size | | The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. | | |
### Repeatable File Store Iterable
| Field | Type | Description | Default Value | Required |
|---|
In Memory Objects | | The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered. | | |
Buffer Unit | | The unit in which maxInMemorySize is expressed | | |
### Randomized Exponential Backoff
| Field | Type | Description | Default Value | Required |
|---|
Max Retries | | Maximum number of retries. | | |
Max Waiting Time Between Retries | | Maximum waiting time between retries, in milliseconds. | | |
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Salesforce Help](https://help.salesforce.com)
---
product: NetSuite Connector
version: 11.11
---
# NetSuite Connector 11.11 Troubleshooting
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
You might encounter the following issues when working with the Anypoint Connector for NetSuite
(NetSuite Connector):
- [A connectivity test fails during application startup.](#connectivity-test-failure)
- [The connector does not log requests and responses.](#logging-request-responses)
- [The connector returns a permissions error when fetching metadata.](#permissions-error)
- [The connector is unable to search for certain types of objects.](#search-entities)
- [The **On Modified Object** source triggers new objects.](#on-modified-object-triggers-new-objects)
## Connectivity Test Failure During Application Startup
If a connectivity test fails during application startup and you see the following statement in the
stack trace, configure a reconnection strategy for the connector:
```xml
Caused by: java.lang.InterruptedException
at java.util.concurrent.locks.AbstractQueuedSynchronizer.doAcquireSharedInterruptibly(AbstractQueuedSynchronizer.java:998) ~[?:1.8.0_221]
```
To configure a reconnection strategy for the connector in Anypoint Studio (Studio), add these lines
to the **Configure XML** tab in the connector properties window:
```xml
```
For example, the configuration XML for the connector might look like this after you add the
reconnection strategy:
```xml
```
In Studio, you can also use the **Advanced** tab in the connector properties window to configure a
reconnection strategy. To do so, complete the following fields:
| Field | Value |
|---|
Reconnection strategy | Standard
|
Frequency (ms) | 5
|
Reconnection Attempts | 2
|
## No Logging of Log Requests and Responses
To log requests and responses when using the connector, add this XML statement to the `Log4j`
configuration file:
```xml
```
## Permissions Error When Fetching Metadata
To avoid receiving a permissions error when fetching metadata, enable the
`Control SuiteScript and Workflow Triggers in Web Services Request` option in NetSuite for the role
used in the connector configuration.
## Inability to Search for Certain Types of Objects
There is a limitation in NetSuite’s SuiteTalk API, that prevents you from searching for certain
types of objects, such as Sales Order objects. Because of this limitation, you can’t use the
NetSuite Connector `Search` operation to locate these objects.
To perform a search for Sales Order objects and other unsupported objects, you can create a saved
search and call it from the connector.
## On Modified Object Triggers New Objects
The **On Modified Object** source also triggers new objects. NetSuite populates the
`lastModifiedDate` field when an object is created. When the **On Modified Objects** source polls
objects based on `lastModifiedDate`, the **On Modified Object** source retrieves all new objects
too, because all new objects have the `lastModifiedDate` field populated.
## See Also
- [Salesforce Help](https://help.salesforce.com)
- [Known Issues](https://help.salesforce.com/s/issues)
---
product: NetSuite Connector
version: 11.11
---
# NetSuite Connector 11.11 XML and Maven Support
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio:
If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML
editor or from a text editor, you can access the connector from your app by adding reference
statements to both your XML Mule flow and the Apache Maven `pom.xml` file.
If you add the connector in Studio, Studio automatically populates the XML code with the connector’s
namespace and schema location and it also adds a dependency to the `pom.xml` file.
## Add a Namespace for the Connector
Paste the following code inside the `mule` tag of the header of your configuration XML:
```xml
http://www.mulesoft.org/schema/mule/netsuite
http://www.mulesoft.org/schema/mule/netsuite/current/mule-netsuite.xsd
```
This example shows how the namespace statements are placed in the `` XML block:
```xml
```
## Add a POM File Dependency
The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to
this connector:
```xml
com.mulesoft.connectors
mule-netsuite-connector
x.x.x
mule-plugin
```
Replace `x.x.x` with the version that corresponds to the connector you are using.
To obtain the most up-to-date `pom.xml` file information:
1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).
2. In Exchange, click **Login** and supply your Anypoint Platform username and password.
3. In Exchange, search for `netsuite`.
4. Select the connector.
5. Click **Dependency Snippets** near the upper right of the screen.
## Next Step
After completing your namespace and `pom.xml` file, you can try the
[NetSuite examples](https://docs.mulesoft.com/netsuite-connector/11.11/netsuite-examples).
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Salesforce Help](https://help.salesforce.com)
---
product: NetSuite Connector
version: 12.0
is-latest-version: true
---
# NetSuite Connector 12.0
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Anypoint Connector for NetSuite (NetSuite Connector) synchronizes data and automates business
processes between NetSuite and third-party applications, either on-premises or in the cloud.
NetSuite provides cloud-based business management software that helps companies manage core business
processes, ERP financials, CRM, e-commerce, inventory, and more.
NetSuite Connector provides the following features:
- SOAP-based integration
NetSuite Connector 11.0 and later does not support REST-based operations.
- Generation of NetSuite business objects
- Different authentication levels
- Error-handling support
For compatibility information and fixed issues, see the
[NetSuite Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/netsuite-connector-release-notes-mule-4).
## Before You Begin
To use this connector, you must be familiar with:
- The NetSuite API
- Anypoint connectors
- Mule runtime engine (Mule)
- Elements and global elements in a Mule flow
- Creating a Mule app using Anypoint Studio or Anypoint Code Builder
Before creating an app, you must have:
- Credentials to access NetSuite Web Services
- Anypoint Studio version 7.21 or later
## Common Use Cases for the Connector
- Quote-to-Cash
Improve cash flow, remove manual order entries, and minimize order errors by leveraging realtime
integrations to connect and synchronize data about your customer’s intent to buy from your CRM
application, such as Salesforce, into its realization of revenue in NetSuite ERP.
- Invoice-to-Reconciliation
Automate your Accounts Receivable (A/R) process by automatically applying bank payments against
invoices in NetSuite for real-time A/R processing. Streamline accounts payable by automating
payment file transfers between NetSuite and your banks.
- Hire-to-Retire
Build a single view of your employees with realtime synchronization of employee information
between Netsuite and your Human Capital Management (HCM) services, such as Workday, Oracle HCM,
PeopleSoft, and so on. Automatically trigger employee onboarding processes such as ordering
computer equipment, uniforms, system access setup, and so on, while reversing the process upon
retirement.
## Authentication types
NetSuite connections use token-based authentication, which uses either a consumer key and token ID
or secret pairs to authenticate.
For information about configuring this authentication type, see
[Using Anypoint Studio to Configure NetSuite Connector](https://docs.mulesoft.com/netsuite-connector/latest/netsuite-studio-configure).
## Using Exchange Templates and Examples
[Anypoint Exchange](https://www.mulesoft.com/exchange/) provides the following templates that you
can use as starting points for your apps:
- [Retrieve a List of Customers from NetSuite](https://www.mulesoft.com/exchange/org.mule.examples/get-customer-list-from-netsuite/)
- [Salesforce and NetSuite Opportunity Aggrgation](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2nets-opportunity-aggregation/)
## Next Step
After you complete the prerequisites, you are ready to create your own app and configure the
connector using [Anypoint Studio](https://docs.mulesoft.com/netsuite-connector/latest/netsuite-studio-configure).
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange)
- [Salesforce Help](https://help.salesforce.com)
---
product: NetSuite Connector
version: 12.0
is-latest-version: true
---
# NetSuite Connector 12.0 Examples
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
The following examples show how to perform searches in Anypoint Connector for NetSuite (NetSuite
Connector):
- [Account Basic Search Filtering by an Integer Field](#account-basic-search)
Obtain the Account records with internal IDs that are less than the value of the `internalId`
query parameter.
- [Employee Basic Search Filtering by the Boolean and String Fields](#employee-basic-search)
Obtain the inactive Employee records that have last names beginning with a specified letter.
- [Customer Advanced Search Filtering by the Date and Array Fields](#customer-advanced-search)
Obtain the customer records that were created after 2015 and that are in the LEAD stage.
The following example shows how to add a file in NetSuite Connector:
- [Add a File](#add-file)
Add a file using the **Add** operation.
The following example shows how to use custom fields and records in NetSuite Connector:
- [Add a Custom Record](#add-custom-record)
Add a custom record with custom fields.
- [Get a Custom Record](#get-custom-record)
Get a custom record with custom fields.
- [Delete a Custom Record](#delete-custom-record)
Delete a custom record with custom fields.
## Account Basic Search Filtering by an Integer Field
This example shows how to use the NetSuite Connector `Search` operation to obtain the Account
records with internal IDs that are less than the value provided.
This example requires that at least one basic account meets the search condition in the NetSuite
instance.
The following screenshot shows the Studio app flow for this example:

Figure 1. Account basic search app flow in Studio
Creating this example involves creating a new Mule project and configuring `HTTP Listener`, the
NetSuite Connector `Search` operation, one `For Each` component, and two `Transform Message`
components.
### Configure HTTP Listener
Configure HTTP Listener to initiate a Mule flow when a call is made to the `/account` path on
localhost port 8081:
1. Create a new Mule project in Studio.
2. In Studio, click **HTTP** and drag the **Listener** operation to the canvas.
3. Change the display name of the **Listener** operation to `/account`.
4. On the Listener properties window, click **+** next to the **Connector configuration** field to
add a global element.
5. Accept the defaults.
6. On the Listener properties window, set the **Path** field value to `/account`.
### Add the first Transform Message Component
This **Transform Message** component contains the search criteria for the flow:
1. From the **Mule Palette** view, drag a **Transform Message** component to the right of
**Listener**.
2. Change the name of the **Transform Message** component to `Search Criteria`.
3. Click the **Transform Message** component.
The **Output** column displays the metadata of the **AccountSearchBasic** object. You can build
up the criteria from there, or copy the criteria shown below.
Setting the **searchValue** field to `attributes.queryParams["internalId"]` directs the
connector to use the value through the query parameter.
The DataWeave code should look like this:
```dataweave
%dw 2.0
output application/xml
ns ns0 urn:messages_2020_2.platform.webservices.netsuite.com
ns ns01 urn:common_2020_2.platform.webservices.netsuite.com
ns ns02 urn:core_2020_2.platform.webservices.netsuite.com
ns xsi http://www.w3.org/2001/XMLSchema-instance
---
{
ns0#search: {
ns0#searchRecord @("xmlns:ns01": ns01, xsi#"type": "ns01:AccountSearchBasic"): {
ns01#internalIdNumber @(operator: "lessThan"): {
ns02#searchValue: attributes.queryParams["internalId"]
}
}
}
}
```
### Add the NetSuite Connector Search Operation
1. From the **Mule Palette** view, select **NetSuite** and drag the **Search** operation to the
right of **Search Criteria**.
2. Change the display name of the **Search** operation to `Search Account`.
3. Select an existing global element or create a new one for the **Search** operation.
4. On the Search properties window:
- In the **Key** field, select `AccountSearchBasic`.
- Set the **Page Size** field value to an integer value between `10` and `1000`.
### Add the For Each Component
From the **Mule Palette** view, select **Core** and drag the **For Each** component to the right of
**Search Account**.
### Add the Second Transform Message Component
This **Transform Message** component converts the response to JSON format:
1. From the **Mule Palette** view, drag a **Transform Message** component inside the **For Each**
component.
2. Change the name of the **Transform Message** component to `Response to JSON`.
3. Click the **Transform Message** component and set the output to `application/json`.
```dataweave
%dw 2.0
output application/json
ns ns0 urn:core_2020_2.platform.webservices.netsuite.com
---
payload.ns0#record
```
4. Drag and drop a **Logger** component from the **Mule Palette** view to the right of **Response
to JSON**. Leave the message as `#[payload]`
### Run the App
To run the app:
1. Start the Mule app.
2. Call `http://localhost:8081/account?internalId=5` to retrieve the `Account` records with
internal IDs that are less than 5.
3. You will only be able to see the output from the Mule App console.
### XML for Account Basic Search Flow
Paste this code into a new Mule app in Studio to quickly load the flow for the Account basic search
example. If needed, change the values to reflect your environment.
```xml
```
## Employee Basic Search Filtering by the Boolean and String Fields
This example shows how to use the `Search` operation to obtain the inactive `Employee` records that
have last names beginning with a specified letter.
This example requires that at least one employee record in the NetSuite instance meets the search
conditions.
The following screenshot shows the Studio app flow for the Employee basic search example:

Figure 2. Employee basic search app flow in Studio
Creating this example involves creating a new Mule project and configuring `HTTP Listener`, the
NetSuite Connector `Search` operation, one `For Each` component, and two `Transform Message`
components.
### Configure HTTP Listener
Configure HTTP Listener to initiate a Mule flow when a call is made to the `/employee` path on
localhost port 8081:
1. In Studio, click **HTTP** and drag the **Listener** operation to the canvas.
2. Change the display name of the **Listener** operation to `/employee`.
3. Either select an existing global element or create a new one for **HTTP Listener** and keep the
defaults.
4. On the Listener properties window, set the **Path** field value to `/employee`.
### Add the First Transform Message Component
This **Transform Message** component contains the search criteria for the flow:
1. From the **Mule Palette** view, drag the **Transform Message** component to the right of
**Listener**.
2. Change the name of the **Transform Message** component to `Search Criteria`.
3. Click the **Transform Message** component.
The **Output** column displays the metadata of the **AccountSearchBasic** object. You can build
up the criteria from there, or copy the criteria below.
The value `attributes.queryParams["isInactive"]` directs the connector to search for inactive
employee accounts, and the value `attributes.queryParams["lastName"]` directs the connector to
search employee which last names start with the value provided.
The DataWeave code should look like this:
```dataweave
%dw 2.0
output application/xml
ns ns0 urn:messages_2020_2.platform.webservices.netsuite.com
ns ns01 urn:common_2020_2.platform.webservices.netsuite.com
ns ns02 urn:core_2020_2.platform.webservices.netsuite.com
ns xsi http://www.w3.org/2001/XMLSchema-instance
---
{
ns0#search: {
ns0#searchRecord @("xmlns:ns01": ns01, xsi#"type": "ns01:EmployeeSearchBasic"): {
ns01#lastName @(operator: "startsWith"): {
ns02#searchValue: attributes.queryParams["lastName"]
},
ns01#isInactive: {
ns02#searchValue: attributes.queryParams["isInactive"]
}
}
}
}
```
### Add the NetSuite Connector Search Operation
1. From the **Mule Palette** view, select **NetSuite** and drag the **Search** operation to the
right of **Search Criteria**.
2. Change the display name of the **Search** operation to `Search Employee`.
3. Select an existing global element or create a new one for the **Search** operation.
4. On the Search properties window:
- In the **Key** field, select `EmployeeSearchBasic`.
- Set the **Page Size** field value to an integer value between `10` and `1000`.
### Add the For Each Component
From the **Mule Palette** view, select **Core** and drag the **For Each** component to the right of
**Search Employee**.
### Add the Second Transform Message Component
This **Transform Message** component converts the response to JSON format:
1. From the **Mule Palette** view, drag a **Transform Message** component inside the **For Each**
component.
2. Change the name of the **Transform Message** component to `Response to JSON`.
3. Click the **Transform Message** component and set the output to `application/json`.
```dataweave
%dw 2.0
output application/json
ns ns0 urn:core_2020_2.platform.webservices.netsuite.com
---
payload.ns0#record
```
4. Finally, drag and drop a **Logger** component from the **Mule Palette** view, to the right of
**Response to JSON**. the message should be `#[payload]`
### Run the App
1. Start the Mule app.
2. Call `http://localhost:8081/employee?isInactive=true&lastName=C` to retrieve the inactive
`Employee` records that have last names beginning with `C`.
3. You will **ONLY** be able to see the output from the Mule App console.
### XML for Employee Basic Search Flow
Paste this code into a new Mule app in Studio to quickly load the flow for the Employee basic search
example. If needed, change the values to reflect your environment.
```xml
```
## Customer Advanced Search Filtering by Stage field and Date Created field
This example shows how to use the `Search` operation to obtain the customer records that were
created after 2015 and that are in the `LEAD` stage.
This examples requires that at least one customer record meets the search conditions in the NetSuite
instance.
The following screenshot shows the Studio app flow for this example:

Figure 3. Customer advanced search app flow in Studio
Creating this example involves creating a new Mule project and configuring `HTTP Listener`, the
NetSuite `Search` operation, two `Transform Message` components, and a `For-Each` component.
### Configure HTTP Listener
Configure HTTP Listener to initiate a Mule flow when a call is made to the `/customer` path on
localhost port 8081:
1. In Studio, click **HTTP** and drag the **Listener** operation to the canvas.
2. Change the display name of the **Listener** operation to `/customer`.
3. Select an existing global element or create a new one for the **Listener** operation.
4. On the Listener properties window, set the **path** field value to `/customer`.
### Add the First Transform Message Component
This **Transform Message** component specifies the search criteria for the flow:
1. From the **Mule Palette** view, drag the **Transform Message** component to the right of
**Listener**.
2. Change the name of the **Transform Message** component to `Search Criteria`.
3. Click the **Transform Message** component.
The **Output** column displays the metadata of the **CustomerSearchAdvanced** object. You can
build up the criteria from there, or copy the criteria below.
Setting the **searchValue** of `stage` to `attributes.queryParams["stage"]` directs the
connector to use the value of the `stage` query parameter.
The DataWeave code should look like this:
```dataweave
%dw 2.0
output application/xml
ns ns0 urn:messages_2020_2.platform.webservices.netsuite.com
ns ns01 urn:common_2020_2.platform.webservices.netsuite.com
ns ns02 urn:core_2020_2.platform.webservices.netsuite.com
ns ns03 urn:relationships_2020_2.lists.webservices.netsuite.com
ns xsi http://www.w3.org/2001/XMLSchema-instance
---
{
ns0#search: {
ns0#searchRecord @("xmlns:ns03": ns03, xsi#"type": "ns03:CustomerSearchAdvanced"): {
ns03#criteria: {
ns03#basic: {
ns01#stage @(operator: "anyOf"): {
ns02#searchValue: [attributes.queryParams["stage"]]
},
ns01#dateCreated @(operator: "after"): {
ns02#searchValue: "2015-01-01T00:00:00.000-08:00"
}
}
}
}
}
}
```
### Add the NetSuite Connector Search Operation
1. From the **Mule Palette** view, select **NetSuite** and drag the **Search** operation to the
right of **Search Criteria**.
2. Change the display name of the **Search** operation to `Search Customer Advanced`.
3. Select an existing global element or create a new one for the **Search** operation.
4. On the Search properties window:
- In the **Key** field, select `CustomerSearchAdvanced`.
- Set the **Page Size** field value to an integer value between `10` and `1000`.
- Click on **Search Preferences** and select `false` on `Return search columns`
### Add a For-Each Component
A `For-Each` component processes each record on the list returned by the `Search` operation
individually so that the records can be displayed on the console.
1. From the **Mule Palette** view, drag a **For-Each** component to the right of **Search**.
2. Drag a **Transform Message** component inside the **For Each** box, rename the component to
`Response to JSON`, and replace the DataWeave code with this code:
```dataweave
%dw 2.0
output application/json
ns ns0 urn:core_2020_2.platform.webservices.netsuite.com
---
payload.ns0#record
```
3. Drag a **Logger** component from the **Mule Palette** view to the right of **Transform**, inside
the **For Each** box.
4. On the Logger properties window, set the **Message** field value to `#[payload]`.
### Run the App
1. Start the Mule app.
2. Call `http://localhost:8081/customer?stage=LEAD`.
3. You will **ONLY** be able to see the output from the Mule App console.
### XML for the Customer Advanced Search Flow
Paste this code into a new Mule app in Studio to quickly load the flow for the Customer Advanced
Search example. If needed, change the values to reflect your environment.
```xml
```
## Add a File
This example shows how to use the **Add** operation to add a file using NetSuite Connector.
The following screenshot shows the Studio app flow for this example:

Creating this example involves creating a new Mule project and configuring a **Listener** component,
**Transform Message** component, **Add** operation, and **Logger** component.
### Configure HTTP Listener
Configure HTTP Listener to initiate a Mule flow when a call is made to the `/upload` path:
1. Create a new Mule project in Studio.
2. In Studio, click **HTTP** and drag the **Listener** component to the canvas.
3. In the **Listener** properties window, click **+** next to the **Connector configuration** field
to add a global element.
4. Accept the defaults.
5. In the **Listener** properties window, set the **Path** field value to `/upload`.
### Add the Transform Message Component
Add the **Transform Message** component to convert the values from the HTTP input to XML format so
they can be used as input for the **Add** operation:
1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to
the right of **Listener**.
2. In the properties window, overlay the brackets in the **Output** section with this DataWeave
code:
```dataweave
%dw 2.0
output application/xml
ns ns0 urn:messages_2020_2.platform.webservices.netsuite.com
ns ns01 urn:filecabinet_2020_2.documents.webservices.netsuite.com
ns xsi http://www.w3.org/2001/XMLSchema-instance
ns ns02 urn:core_2020_2.platform.webservices.netsuite.com
---
{
ns0#add: {
ns0#record @("xmlns:ns01": ns01, xsi#"type": "ns01:File"): {
ns01#name: "test.csv",
ns01#content: "Here is the content of file",
ns01#folder @(internalId: 826997 , xsi#"type": "ns01:RecordRef"): {
ns02#name: null
}
}
}
}
```
### Add the Add Operation
Add the **Add** operation to add a file using the values passed by the **Transform Message**
component:
1. From the **Mule Palette** view, select **NetSuite** and drag the **Add** operation to the right
of **Transform Message**.
2. In the properties window, click **+** next to the **Connector configuration** field to add a
global element.
3. Configure the global element depending on the connection, for example:
| Field | Value |
|---|
Consumer key | ${netsuite.consumerKey}
|
Consumer secret | ${netsuite.consumerSecret}
|
Token ID | ${netsuite.tokenId}
|
Token secret | ${netsuite.tokenSecret}
|
Account Id | ${netsuite.account}
|
Signature algorithm | HMAC_SHA256
|
Wsdl version | V2020_2
|
SOAP Port | services/NetSuitePort_2020_2
|
The following image shows an example of the **Add** configuration of the global element:

4. In the properties window, configure the following fields:
| Field | Value |
|---|
Display Name | Name for the connector operation. |
Connector configuration | Global configuration you just created. |
Type | file
|
Message | vars.fileRecord
|
The following image shows an example of the **Add** configuration in the properties window:

### Add the Logger Component
Add the **Logger** component to display the response in the Mule console:
1. From the **Mule Palette** view, select **Core** and drag a **Logger** component to the right of
**Add**.
2. In the properties window, configure the following fields:
| Field | Value |
|---|
Display Name | Name for the logger, such as Logger. |
Message | The file was added
|
Level | INFO (Default) |
The following image shows an example of the **Logger** configuration in the properties window:

### Run the App
To run the app:
1. Start the Mule app.
2. Call `http://localhost:8081/upload` to add the file.
### XML for the Add File Flow
Paste this code into a new Mule app in Studio to quickly load the flow for the Add File example. If
needed, change the values to reflect your environment.
```xml
```
## Custom Records and Fields
The following example shows how to add, get, and delete custom records with custom fields using
DataWeave. Use DataSense, which imports metadata from NetSuite Connector, to simplify application
design.
The following screenshot shows the Studio app flow for this example:

Creating this example involves adding the **Add** operation, **Set Variable** component, **Get**
operation, and **Delete** operation.
### Add a Custom Record
Add a custom record with custom fields using the **Add** operation.
Include the following attributes to add a custom record:
- **separators**
Specifies a separator character. The separator in the following example is `__`.
- **recordType**
References the custom record type. The recordType in the following example is `customRecordType`.
- **scriptId**
References the script ID of the record. The scriptId in the following example is
`customrecord_2663_bank_details`.
- **internalId**
References the internal ID of the record. The internalId in the following example is `374`.
- **XSI type**
Specify the XSI type as **CustomRecordRef** to add a custom record.
The following DataWeave script adds a custom record with custom fields:
%dw 2.0 output application/xml ns ns0 urn:messages\_2020\_2.platform.webservices.netsuite.com ns
ns01 urn:customization\_2020\_2.setup.webservices.netsuite.com ns ns02
urn:core\_2020\_2.platform.webservices.netsuite.com ns xsi http://www.w3.org/2001/XMLSchema-instance
---
{ ns0#add: { ns0#record @("xmlns:ns01": ns01, xsi#"type": "ns01:CustomRecord"): {
ns01#customFieldList: { StringCustomFieldRef\_\_custrecord\_2663\_legal\_name\_\_3878: { ns02#value:
"test" }, LongCustomFieldRef\_\_custrecord\_2663\_eft\_file\_cabinet\_id\_\_3874: { ns02#value: 1234
}, BooleanCustomFieldRef\_\_custrecord\_2663\_dd\_batch\_\_3864: { ns02#value: true } } } } }
The customFieldList contains the customFields for the entity you use.
The example above shows `StringCustomFieldRef__custrecord_2663_legal_name__3878`,
`BooleanCustomFieldRef__custrecord_2663_dd_batch__3864` and
`LongCustomFieldRef__custrecord_2663_eft_file_cabinet_id__3874`. The field names consist of a
**scriptId**, **internalId**, and **CustomRecordRef** type.
`StringCustomFieldRef__custrecord_2663_legal_name__3878` has a specified value `ns02#value: "test"`,
`LongCustomFieldRef__custrecord_2663_eft_file_cabinet_id__3874` has a specified value
`ns02#value: 1234`, and `BooleanCustomFieldRef__custrecord_2663_dd_batch__3864` has a specified
value `ns02#value: true`.
### Get Custom Record
Get a custom record with custom fields using the **Get** operation.
Include the following attributes to get a custom record:
- **typeId**
References the custom record type Id. The typeId in the following example is `374`.
- **internalId**
References the internalId of the record. The internalId in the following example is
`vars.responseInternalId`.
- **XSI type**
Specify the XSI type as **CustomRecordRef** to retrieve a custom record.
The following DataWeave script gets a custom record with custom fields:
%dw 2.0 output application/xml ns ns0 urn:messages\_2020\_2.platform.webservices.netsuite.com ns
ns01 urn:core\_2020\_2.platform.webservices.netsuite.com ns xsi http://www.w3.org/2001/XMLSchema-instance
---
{ ns0#get: { ns01#baseRef @(internalId: vars.responseInternalId , "typeId": "374", xsi#"type":
"ns01:CustomRecordRef"): null } }
### Delete Custom Record
Delete a custom record with custom fields using the **Delete** operation.
Include the following attributes to delete a custom record:
- **typeId**
References the custom record type Id. The typeId in the following example is `374`.
- **internalId**
References the internalId of the record. The internalId in the following example is
`vars.responseInternalId`.
- **XSI type**
Specify the XSI type as **CustomRecordRef** to delete a custom record.
The following DataWeave script deletes a custom record with custom fields:
%dw 2.0 output application/xml ns ns0 urn:messages\_2020\_2.platform.webservices.netsuite.com ns
ns01 urn:core\_2020\_2.platform.webservices.netsuite.com ns xsi http://www.w3.org/2001/XMLSchema-instance
---
{ ns0#delete: { ns01#baseRef @(internalId: vars.responseInternalId , "typeId": "374", xsi#"type":
"ns01:CustomRecordRef"): null } }
### XML for Custom Records
Paste this code into a new Mule app in Studio to quickly load the flow for the custom records
example. If needed, change the values to reflect your environment.
```xml
```
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Salesforce Help](https://help.salesforce.com)
---
product: NetSuite Connector
version: 12.0
is-latest-version: true
---
# NetSuite Connector 12.0 Reference
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Anypoint Connector for NetSuite synchronizes data and automates business processes between NetSuite
and third party applications, either on-premises or in the cloud. The connector makes use of the
SuiteTalk WSDL to provide SOAP based integration to generate NetSuite business objects, make use of
different authentication levels, and support error handling.
Release Notes:
[NetSuite Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/netsuite-connector-release-notes-mule-4)
## Configurations
---
### Config
#### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Name | String | The name for this configuration. Connectors reference the configuration with this name. | | x |
Connection | | The connection types to provide to this configuration. | | x |
Name | | The identifier of this element used to reference it in other components | | x |
Expiration Policy | | Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate. | | |
Show warnings as errors | | When this preference is enabled, warning messages generated by NetSuite are treated as errors that cause an exception, resulting in rejection of the request. | false | |
Disable mandatory custom field validation | | This preference affects the handling of custom fields that are configured in the UI to be mandatory: If you set this field to true, the fields are not treated as required during SOAP web services requests. If you set this field to false, the fields are required.
| false | |
Disable system notes for custom fields | | System notes are system-generated records that track changes to a record, including changes to specific field values. This preference lets you disable the creation of system notes for changes to custom fields. Depending on your integration, using this preference can increase performance. | false | |
Ignore read-only fields | | This preference affects the way the system behaves when you mistakenly submit a value for a read-only field. If you set this preference to true, the system ignores these mistakes. | false | |
Run server SuiteScript and trigger workflows | | Controls SuiteScript and trigger workflows per request: If you do not include this preference in a request, the company preference set on the Web Services Preferences page is used. If you include this preference in the request, the connector overrides the company preference set in the UI.
| false | |
Send runServerSuiteScript tag in Preferences header | | Sends the runServerSuiteScript tag in the Preferences header. | false | |
Customizations Separator | | Separator used to generate the keys required to provided better support for custom fields and records. If the script ID of the customization that defines a custom field or record contains the separator default character, set up a new ID and regenerate the metadata. | __ | |
#### Connection Types
The connection types to provide to this configuration.
##### Token-Based Authentication
###### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Maximum Connections | | The maximum number of connections that can be active to execute the HTTP requests. The default value, -1, does not limit the number of connections to the server. | -1 | |
Read Timeout | | Specifies the amount of time that the client waits for a response before it times out. Use 0 to specify that the client should wait indefinitely. | 60000 | |
Read Timeout Unit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS
| The time unit for Read Timeout. | MILLISECONDS | |
Connection Timeout | | Specifies the amount of time that the client attempts to establish a connection before it times out. Use 0 to specify that the client continue to attempt to open a connection indefinitely. | 60000 | |
Connection Timeout Unit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS
| The time unit for Connection Timeout. | MILLISECONDS | |
Base Netsuite Address | | The base address to use to connect to NetSuite. The default value is the main NetSuite site. This is used to automatically obtain the endpoint for the service based on the credentials configured, and will need no change. | https://webservices.netsuite.com
| |
Concurrency Management Strategy | | Strategy to use when encountering the TOO_MANY_REQUESTS error. | | |
Wsdl version | V2020_2 V2021_1 V2023_1 V2025_2
| Version of WSDL that the connector uses to communicate with NetSuite: If you do not select a value, the connector works with SuiteTalk version 2020_2 and existing namespaces in the Mule app must not be modified. If you select a WSDL version, remove the SuiteTalk version from all namespaces in the Mule app. The following example shows an original DataWeave script with the SuiteTalk version and a new DataWeave script with the SuiteTalk version removed. #%dw 2.0
output application/java
ns ns0 urn:messages_2020_2.platform.webservices.netsuite.com
ns ns01 urn:core_2020_2.platform.webservices.netsuite.com
---
payload.ns0#changePasswordResponse.ns0#sessionResponse.ns01#status.ns01#statusDetail.ns01#code #%dw 2.0
output application/java
ns ns0 urn:messages.platform.webservices.netsuite.com
ns ns01 urn:core.platform.webservices.netsuite.com
---
payload.ns0#changePasswordResponse.ns0#sessionResponse.ns01#status.ns01#statusDetail.ns01#code
| | |
SOAP Port | | The SOAP Port path to use to connect to NetSuite, this is relative to the base address. The default value corresponds to the port obtained from the WSDL used in the version of the connector. | | x |
TLS configuration | | Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the keystore in the tls:context child element of the listener-config. | | |
Host | | The hostname of the HTTP proxy, for example, localhost. This field requires the port to be set. | | |
Port | | The port number of the HTTP proxy, for example, 3128. The port number must be specified if the hostname is also specified. | | |
Username | | The username to supply to the HTTP proxy on every request to NetSuite. This field is optional because a user might want to pass through an unauthenticated HTTP proxy. | | |
Password | | The password to supply to the HTTP proxy on every request to NetSuite. This field is optional because a user might want to pass through an unauthenticated HTTP proxy. | | |
Non proxied hosts | | A list of comma-separated hosts against which the proxy should not be used | | |
Consumer Key | | The consumer key value for the enabled token-based authentication integration record | | x |
Consumer Secret | | The consumer secret value for the token-based authentication integration record | | x |
Token ID | | The token ID representing the unique combination of a user and integration generated within the NetSuite environment | | x |
Token Secret | | The respective token secret for the user/integration pair | | x |
Account Id | | NetSuite SuiteTalk WebService account ID. | | x |
Signature Algorithm | | The algorithm used to compute the SHA hash signature | HMAC_SHA256 | |
Reconnection | | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. | | |
## Supported Operations
- [Add](#Add)
- [Add List](#AddList)
- [Async Add List](#AsyncAddList)
- [Async Delete List](#AsyncDeleteList)
- [Async Get List](#AsyncGetList)
- [Async Initialize List](#AsyncInitializeList)
- [Async Search](#AsyncSearch)
- [Async Update List](#AsyncUpdateList)
- [Async Upsert List](#AsyncUpsertList)
- [Attach](#Attach)
- [Change Email](#ChangeEmail)
- [Change Password](#ChangePassword)
- [Check Async Status](#CheckAsyncStatus)
- [Delete](#Delete)
- [Delete List](#DeleteList)
- [Detach](#Detach)
- [Get](#Get)
- [Get Account Governance Info](#GetAccountGovernanceInfo)
- [Get All](#GetAll)
- [Get Async Result](#GetAsyncResult)
- [Get Budget Exchange Rate](#GetBudgetExchangeRate)
- [Get Currency Rate](#GetCurrencyRate)
- [Get Customization Id](#GetCustomizationId)
- [Get Data Center Urls](#GetDataCenterUrls)
- [Get Deleted](#GetDeleted)
- [Get Integration Governance Info](#GetIntegrationGovernanceInfo)
- [Get Item Availability](#GetItemAvailability)
- [Get List](#GetList)
- [Get Posting Transaction Summary](#GetPostingTransactionSummary)
- [Get Saved Search](#GetSavedSearch)
- [Get Select Value](#GetSelectValue)
- [Get Server Time](#GetServerTime)
- [Initialize](#Initialize)
- [Initialize List](#InitializeList)
- [Search](#Search)
- [Update](#Update)
- [Update Invitee Status](#UpdateInviteeStatus)
- [Update Invitee Status List](#UpdateInviteeStatusList)
- [Update List](#UpdateList)
- [Upsert](#Upsert)
- [Upsert List](#UpsertList)
## Associated Sources
- [On Deleted Object](#DeletedObjectListener)
- [On Modified Object](#ModifiedObjectListener)
- [On New Object](#NewObjectListener)
## Operations
## Add
``
Creates a new record.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The message to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configures how Mule processes streams. Repeatable streams are the default behavior. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Add List
``
Creates one or more new records.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The add list request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configures how Mule processes streams. Repeatable streams are the default behavior. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Add List
``
An asynchronous request equivalent to Add List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, NetSuite returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The Async Add List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configures how Mule processes streams. Repeatable streams are the default behavior. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Delete List
``
An asynchronous request equivalent to the Delete List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The Async Delete List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configures how Mule processes streams. Repeatable streams are the default behavior. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Get List
``
An asynchronous request equivalent to the Get List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The Async Get List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Initialize List
``
An asynchronous request equivalent to the Initialize List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The Async Initialize List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Search
``
An asynchronous request equivalent to the Search operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Key | | The type of search that renders the output metadata. | | |
Message | | The Async Search request to complete. | #[payload] | |
Body Fields Only | | Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to false, all fields associated with the record are returned. | true | |
Return Search Columns | | If true, only search columns are returned in your search. | true | |
Page Size | | Maximum amount of results per page. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Update List
``
An asynchronous request equivalent to the Update List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The Async Update List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Async Upsert List
``
An asynchronous request equivalent to the Upsert List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which
places it in a processing queue and handles it asynchronously with other requests. All available
jobs for each polling period are processed contiguously, with no waiting period for an available
job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client
application can check the status and result of the request by referencing the job ID.
> [!NOTE] Asynchronous request job IDs are valid for 30 days.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The Async Upsert List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Attach
``
Defines a relationship between two records.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Attach Ref Type | | The attach reference type. | | |
Message | | The attach request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Change Email
``
Changes the email address for the account.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
New Email | | Your new email address. | | x |
Current Credentials | | Your current credentials. | | x |
Just This Account | | Whether to change this account only. | true | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INSUFFICIENT\_PERMISSION
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Change Password
``
Changes the password for the account.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
New Password | | The new password. | | x |
Current Password | | Your current credentials. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INSUFFICIENT\_PERMISSION
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Check Async Status
``
Checks whether a particular asynchronous job finished processing.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Job Id | | The ID of the job. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Delete
``
Delete one or more record instances. Not all records can be deleted. For more information, see the
NetSuite documentation.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The delete request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Ref Type | | Defines the ComplexType of the record. | | |
Type | | Defines the Type of the record. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Delete List
``
Deletes one or more records. Not all records can be deleted. For more information, see the NetSuite
documentation.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The delete list request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Ref Type | | Defines the ComplexType of the record. | | |
Type | | Defines the Type of the record. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Detach
``
Deletes a relationship between two records.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Detach Ref Type | | Defines the ComplexType of the record for the detach request. | | |
Message | | The detach request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get
``
Retrieves a record by providing the unique ID that identifies the record.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Ref Type | | Defines the ComplexType of the record. | | |
Type | | Defines the Type of the record. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Get Account Governance Info
``
Get the account concurrency limit and the unallocated concurrency limit.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get All
``
Retrieves a list of all records of the specified type.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | | | |
Message | | The get All request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get Async Result
``
Returns the result of the specified job if it finished processing.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Job Id | | The ID of the job. | | x |
Page Index | | The page number of the asynchronous result. | 1 | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:ASYNC\_FAULT
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get Budget Exchange Rate
``
Gets and filters all data related to the Budget Exchange Rates table. This table maintains exchange
rates between the root-parent and child subsidiaries for use in the budgeting process.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The Get Budget Exchange Rate request, which contains a budgetExchangeRateFilter. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get Currency Rate
``
Gets the exchange rate between two currencies based on the specified certain date.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | Accepts the argument CurrencyRateFilter, which specifies what to return in the results. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INSUFFICIENT\_PERMISSION
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get Customization Id
``
Returns the IDs of available customizations for a given customization type.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | Customization type | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get Data Center Urls
``
Obtains the NetSuite data center URL for the account.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Account Id | | The account ID. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get Deleted
``
Returns a list of deleted records for the given record type and date range.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Filter | | Filters the results | #[payload] | |
Limit | | The maximum amount of results to return from this call | -1 | |
Page Size | | Maximum amount of results per page. | 10 | |
Output Mime Type | | The MIME type of the payload that this operation outputs. | | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get Integration Governance Info
``
Get the concurrency limit for the integration (integrationConcurrencyLimit) and the limit type
(limitType), which can be:
- \_integrationSpecific, when a limit has been allocated.
- \_internal, when it is an internal application. In this case the limit is not displayed.
- \_accountLimit, when no specific limit has been allocated to the integration.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get Item Availability
``
Returns the availability for a given item record reference. If the Multi-Location Inventory feature
is enabled, connector returns results for all locations.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The GetItem Availability Request type, which contains an itemAvailabilityFilter | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get List
``
Retrieves a list of one or more records by providing the unique ids that identify those records.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The get list request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Ref Type | | Defines the ComplexType of the record. | | |
Type | | Defines the Type of the record. | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get Posting Transaction Summary
``
Retrieves a summary of the data posted to the general ledger in an account. You can use the
available filters and fields to generate reports that are similar to what you see when you run
financial reports such as a Trial Balance, Balance Sheet, or an Income Statement.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Fields | | Fields for the operation body | | |
Filters | | Filters for the operation body | | |
Operation Id | | Operation ID | | |
Output Mime Type | | The MIME type of the payload that this operation outputs. | | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Get Saved Search
``
Retrieves a list of existing saved search IDs on a per-record-type basis.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Search Type | | The targeted search type. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get Select Value
``
Returns valid select options for a particular RecordRef, CustomRecordRef, or enumerated static
field.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Field Description | | The get select value request to complete. | #[payload] | |
Page Size | | | 10 | |
Output Mime Type | | The MIME type of the payload that this operation outputs. | | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:RETRY\_EXHAUSTED
## Get Server Time
``
Returns the NetSuite server time in GMT, regardless of a user’s time zone.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Initialize
``
Pre-populates fields on transaction line items with values from a related record.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The initialize request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Initialize List
``
Pre-populates fields on transaction line items with values from related records.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The initialize list request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Search
``
Executes a search on a specific record type based on a set of criteria. This processor has been
enhanced with a paging mechanism. Searches can be Basic, Advanced, or Join searches. See
SearchRecord for all the available searches.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Key | | The type of search to render the output metadata. | | |
Message | | The search request to complete. | #[payload] | |
Page Size | | Maximum amount of results per page. | 10 | |
Limit | | Limits the amount of results produced. Limit <=0 means no limit | -1 | |
Body Fields Only | | Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to false, all fields associated with the record are returned. | true | |
Return Search Columns | | Defaults to true, meaning that only search columns are returned in your search. | true | |
Output Mime Type | | The MIME type of the payload that this operation outputs. | | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Update
``
Updates an existing record.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The update record request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Update Invitee Status
``
Sets a new invitation status for a given event.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The update invitee status request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Update Invitee Status List
``
Sets multiple new invitation statuses for a given event.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Message | | The update invitee status list request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Update List
``
Updates one or more instances of a record type. If there are multiple records, they can either be of
the same record type or different record types.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The update list request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Upsert
``
Adds a new instance or updates a record instance in NetSuite. This operation is similar to both the
Add and Update operations, but you can run Upsert without first determining whether a record exists
in NetSuite.
Identify a record by its external ID and its record type. If a record of the specified type with a
matching external ID exists in the system, it is updated. If it does not exist, a new record is
created. Because the external ID is mandatory for this operation, Upsert is supported only for
records that support the external ID field. This operation prohibits the passing of internal ID
values.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The Upsert request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
- NETSUITE:USER\_ERROR
## Upsert List
``
Adds or updates one or more instances of a record type in NetSuite. This operation is similar to
both the Add List and Update List operations, but you can run Upsert List without first determining
whether the record types exist in NetSuite.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Type | | The record type for the operation. | | |
Message | | The Upsert List request to complete. | #[payload] | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Streaming Strategy | | Configure if repeatable streams should be used and their behavior | | |
Target Variable | | The name of a variable to store the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload] | |
Error Mappings | | Set of error mappings for this operation. | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Config](#Config)
### Throws
- NETSUITE:CONNECTIVITY
- NETSUITE:INVALID\_VERSION
- NETSUITE:MAX\_RCRDS\_EXCEEDED
- NETSUITE:NETSUITE\_ERROR
- NETSUITE:NETSUITE\_SOAP\_FAULT
- NETSUITE:RETRY\_EXHAUSTED
- NETSUITE:SESSION\_TIMED\_OUT
## Sources
## On Deleted Object
``
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Start Date Time | | Specify a local date. If this field is empty, this operation retrieves the selected objects from the time when the Mule app started. | | |
Page Size | | Maximum amount of results per page. | 10 | |
Body Fields Only | | Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to false, all fields associated with the record are returned. | true | |
Config Ref | | The name of the configuration to use to execute this component | | x |
Scheduling Strategy | | Configures the scheduler that triggers the polling | | x |
Redelivery Policy | | Defines a policy for processing the redelivery of the same message | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | String |
Attributes Type | |
### For Configurations
- [Config](#Config)
## On Modified Object
``
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Start Date Time | | Specify a local date. If this field is empty, this operation retrieves the selected objects from the time the Mule app started. | | |
Page Size | | Maximum amount of results per page. | 10 | |
Body Fields Only | | Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to false, all fields associated with the record are returned. | true | |
Object Type | | The type of record that will be retrieved when modified. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Scheduling Strategy | | Configures the scheduler that triggers the polling | | x |
Redelivery Policy | | Defines a policy for processing the redelivery of the same message | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | String |
Attributes Type | |
### For Configurations
- [Config](#Config)
## On New Object
``
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Start Date Time | | Specify a local date. If this field is empty, this operation will retrieve the selected objects from the time the Mule app was started. | | |
Page Size | | Maximum amount of results per page. | 10 | |
Body Fields Only | | Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to false, all fields associated with the record are returned. | true | |
Object Type | | The type of record that will be retrieved when modified. | | x |
Config Ref | | The name of the configuration to use to execute this component | | x |
Scheduling Strategy | | Configures the scheduler that triggers the polling | | x |
Redelivery Policy | | Defines a policy for processing the redelivery of the same message | | |
Reconnection Strategy | | A retry strategy in case of connectivity errors | | |
### Output
Type | String |
Attributes Type | |
### For Configurations
- [Config](#Config)
## Types
### Tls
| Field | Type | Description | Default Value | Required |
|---|
Enabled Protocols | | A comma-separated list of protocols enabled for this context. | | |
Enabled Cipher Suites | | A comma-separated list of cipher suites enabled for this context. | | |
Trust Store | | | | |
Key Store | | | | |
Revocation Check | | | | |
### Trust Store
| Field | Type | Description | Default Value | Required |
|---|
Path | | The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store. | | |
Password | | The password used to protect the trust store. | | |
Type | | | | |
Algorithm | | The algorithm used by the trust store. | | |
Insecure | | If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk. | | |
### Key Store
| Field | Type | Description | Default Value | Required |
|---|
Path | | The location (which will be resolved relative to the current classpath and file system, if possible) of the key store. | | |
Type | | | | |
Alias | | When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. | | |
Key Password | | The password used to protect the private key. | | |
Password | | The password used to protect the key store. | | |
Algorithm | | The algorithm used by the key store. | | |
### Standard Revocation Check
| Field | Type | Description | Default Value | Required |
|---|
Only End Entities | | Only verify the last element of the certificate chain. | | |
Prefer Crls | | Try CRL instead of OCSP first. | | |
No Fallback | | Do not use the secondary checking method (the one not selected before). | | |
Soft Fail | | Avoid verification failure when the revocation server can not be reached or is busy. | | |
### Custom Ocsp Responder
| Field | Type | Description | Default Value | Required |
|---|
Url | | The URL of the OCSP responder. | | |
Cert Alias | | Alias of the signing certificate for the OCSP response (must be in the trust store), if present. | | |
### Crl File
| Field | Type | Description | Default Value | Required |
|---|
Path | | The path to the CRL file. | | |
### Reconnection
| Field | Type | Description | Default Value | Required |
|---|
Fails Deployment | | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. | | |
Reconnection Strategy | | The reconnection strategy to use. | | |
### Reconnect
| Field | Type | Description | Default Value | Required |
|---|
Frequency | | How often in milliseconds to reconnect | | |
Blocking | | If false, the reconnection strategy will run in a separate, non-blocking thread | | |
Count | | How many reconnection attempts to make. | | |
### Reconnect Forever
| Field | Type | Description | Default Value | Required |
|---|
Frequency | | How often in milliseconds to reconnect | | |
Blocking | | If false, the reconnection strategy will run in a separate, non-blocking thread | | |
### Expiration Policy
| Field | Type | Description | Default Value | Required |
|---|
Max Idle Time | | A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration | | |
Time Unit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS
| A time unit that qualifies the maxIdleTime attribute | | |
### Netsuite Soap Attributes
| Field | Type | Description | Default Value | Required |
|---|
Soap Headers | | | | |
Transport Additional Data | | | | |
Transport Headers | | | | |
### Redelivery Policy
| Field | Type | Description | Default Value | Required |
|---|
Max Redelivery Count | | The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message | | |
Message Digest Algorithm | | The secure hashing algorithm to use. If not set, the default is SHA-256. | | |
Message Identifier | | Defines which strategy is used to identify the messages. | | |
Object Store | | The object store where the redelivery counter for each message is stored. | | |
### Redelivery Policy Message Identifier
| Field | Type | Description | Default Value | Required |
|---|
Use Secure Hash | | Whether to use a secure hash algorithm to identify a redelivered message. | | |
Id Expression | | Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false. | | |
### Repeatable In Memory Stream
| Field | Type | Description | Default Value | Required |
|---|
Initial Buffer Size | | The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. | | |
Buffer Size Increment | | This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. | | |
Max Buffer Size | | The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. | | |
Buffer Unit | | The unit in which all these attributes are expressed | | |
### Repeatable File Store Stream
File store repeatable streams require buffering, and there are different buffering strategies. Mule
keeps a portion of contents in memory. If the stream contents are larger than the configured buffer
size, Mule backs up the buffer’s content to disk and then clears the memory.
| Field | Type | Description | Default Value | Required |
|---|
In Memory Size | | Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered. | | |
Buffer Unit | | The unit in which maxInMemorySize is expressed | | |
### Error Mapping
| Field | Type | Description | Default Value | Required |
|---|
Source | ANY REDELIVERY_EXHAUSTED TRANSFORMATION EXPRESSION SECURITY CLIENT_SECURITY SERVER_SECURITY ROUTING CONNECTIVITY RETRY_EXHAUSTED TIMEOUT
| | | |
Target | | | | |
### Repeatable In Memory Iterable
| Field | Type | Description | Default Value | Required |
|---|
Initial Buffer Size | | The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances. | | |
Buffer Size Increment | | This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances. | | |
Max Buffer Size | | The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. | | |
### Repeatable File Store Iterable
| Field | Type | Description | Default Value | Required |
|---|
In Memory Objects | | The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered. | | |
Buffer Unit | | The unit in which maxInMemorySize is expressed | | |
### Randomized Exponential Backoff
| Field | Type | Description | Default Value | Required |
|---|
Max Retries | | Maximum number of retries. | | |
Max Waiting Time Between Retries | | Maximum waiting time between retries, in milliseconds. | | |
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Salesforce Help](https://help.salesforce.com)
---
product: NetSuite Connector
version: 12.0
is-latest-version: true
---
# NetSuite Connector 12.0 Troubleshooting
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
You might encounter the following issues when working with the Anypoint Connector for NetSuite
(NetSuite Connector):
- [A connectivity test fails during application startup.](#connectivity-test-failure)
- [The connector does not log requests and responses.](#logging-request-responses)
- [The connector returns a permissions error when fetching metadata.](#permissions-error)
- [The connector is unable to search for certain types of objects.](#search-entities)
- [The **On Modified Object** source triggers new objects.](#on-modified-object-triggers-new-objects)
## Connectivity Test Failure During Application Startup
If a connectivity test fails during application startup and you see the following statement in the
stack trace, configure a reconnection strategy for the connector:
```xml
Caused by: java.lang.InterruptedException
at java.util.concurrent.locks.AbstractQueuedSynchronizer.doAcquireSharedInterruptibly(AbstractQueuedSynchronizer.java:998) ~[?:1.8.0_221]
```
To configure a reconnection strategy for the connector in Anypoint Studio (Studio), add these lines
to the **Configure XML** tab in the connector properties window:
```xml
```
For example, the configuration XML for the connector might look like this after you add the
reconnection strategy:
```xml
```
In Studio, you can also use the **Advanced** tab in the connector properties window to configure a
reconnection strategy. To do so, complete the following fields:
| Field | Value |
|---|
Reconnection strategy | Standard
|
Frequency (ms) | 5
|
Reconnection Attempts | 2
|
## No Logging of Log Requests and Responses
To log requests and responses when using the connector, add this XML statement to the `Log4j`
configuration file:
```xml
```
## Permissions Error When Fetching Metadata
To avoid receiving a permissions error when fetching metadata, enable the
`Control SuiteScript and Workflow Triggers in Web Services Request` option in NetSuite for the role
used in the connector configuration.
## Inability to Search for Certain Types of Objects
There is a limitation in NetSuite’s SuiteTalk API, that prevents you from searching for certain
types of objects, such as Sales Order objects. Because of this limitation, you can’t use the
NetSuite Connector `Search` operation to locate these objects.
To perform a search for Sales Order objects and other unsupported objects, you can create a saved
search and call it from the connector.
## On Modified Object Triggers New Objects
The **On Modified Object** source also triggers new objects. NetSuite populates the
`lastModifiedDate` field when an object is created. When the **On Modified Objects** source polls
objects based on `lastModifiedDate`, the **On Modified Object** source retrieves all new objects
too, because all new objects have the `lastModifiedDate` field populated.
## See Also
- [Salesforce Help](https://help.salesforce.com)
- [Known Issues](https://help.salesforce.com/s/issues)
---
product: NetSuite Connector
version: 12.0
is-latest-version: true
---
# NetSuite Connector 12.0 XML and Maven Support
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio:
If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML
editor or from a text editor, you can access the connector from your app by adding reference
statements to both your XML Mule flow and the Apache Maven `pom.xml` file.
If you add the connector in Studio, Studio automatically populates the XML code with the connector’s
namespace and schema location and it also adds a dependency to the `pom.xml` file.
## Add a Namespace for the Connector
Paste the following code inside the `mule` tag of the header of your configuration XML:
```xml
http://www.mulesoft.org/schema/mule/netsuite
http://www.mulesoft.org/schema/mule/netsuite/current/mule-netsuite.xsd
```
This example shows how the namespace statements are placed in the `` XML block:
```xml
```
## Add a POM File Dependency
The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to
this connector:
```xml
com.mulesoft.connectors
mule-netsuite-connector
x.x.x
mule-plugin
```
Replace `x.x.x` with the version that corresponds to the connector you are using.
To obtain the most up-to-date `pom.xml` file information:
1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).
2. In Exchange, click **Login** and supply your Anypoint Platform username and password.
3. In Exchange, search for `netsuite`.
4. Select the connector.
5. Click **Dependency Snippets** near the upper right of the screen.
## Next Step
After completing your namespace and `pom.xml` file, you can try the
[NetSuite examples](https://docs.mulesoft.com/netsuite-connector/latest/netsuite-examples).
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Salesforce Help](https://help.salesforce.com)
---
product: NetSuite Connector
version: 12.0
is-latest-version: true
---
# Upgrading and Migrating NetSuite Connector to Version 12.x
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Upgrade Anypoint Connector for NetSuite (NetSuite Connector) to version 12.x.
## Supported Upgrade Paths
| From Version | To Version |
|---|
11.x | 12.x |
## Changes in This Release
- NetSuite Connector is now compatible only with Java 17.
- The connector no longer supports the **Omit the internal Id in the name of the custom field**
field because its functionality is now the default behavior of the connector.
- These libraries are upgraded to address reported security vulnerabilities:
- The `springframework` library is upgraded to version 6.2.
- The `jakarta.activation-api` library is upgraded to version 2.1.4.
- The `wiremock.server.dependency` library is upgraded to version 3.0.1.
- The PowerMock library is replaced by Mockito version 5.2.0.
- The `commons-io` library is added at version 2.16.1.
- The `disruptor` library is added at version 4.0.0.
## Requirements
Ensure your system meets the following compatibility requirements before you perform the upgrade:
| Application/Service | Version |
|---|
Mule | 4.9.0 and later |
Java | 17 |
## Upgrade Prerequisites
Before you perform the upgrade, create a backup of your files, data, and configuration in case you
need to restore to the previous version.
## Upgrade Steps
Follow these steps to perform the upgrade to version 12.x:
1. In Anypoint Studio, create a Mule project.
2. In the **Mule Palette** view, click **Search in Exchange**.
3. In **Add Dependencies to Project**, enter `netsuite` in the search field.
4. In **Available modules**, select **NetSuite** and click **Add**.
5. Click **Finish**.
6. Verify that the `mule-netsuite-connector` dependency version is 12.x in the `pom.xml` file in
the Mule project.
Studio upgrades the connector automatically.
## Post-Upgrade Steps
After you install the latest version of the connector:
- Remove any `omitInternalIdFromCustomFields` attribute from the NetSuite global configuration in
your flow XML or Studio settings.
- Update any DataWeave scripts or configuration that references custom field names in the
`TYPE_SCRIPTID_INTERNALID` format to use the new `TYPE__SCRIPTID` format.
- Confirm that each Mule application using this connector runs on Mule 4.9.0 or later with Java 17.
- Ensure your connector configuration uses **Token-Based Authentication**.
- Verify that error handling still works as expected. See
[Troubleshooting NetSuite Connector](https://docs.mulesoft.com/netsuite-connector/latest/netsuite-troubleshooting) if you encounter new validation or
connectivity errors.
## Verify the Upgrade
After you install the latest version of the connector, follow these steps to verify the upgrade:
1. In Studio, verify that there are no errors in the **Problems** or **Console** views.
2. Verify that there are no problems in the project `pom.xml` file.
3. Test the connection to verify that the operations work.
## Revert the Upgrade
If it is necessary to revert to the previous version of NetSuite Connector, change the
`mule-netsuite-connector` dependency version in the project’s `pom.xml` file to the previous
version.
You must update the project’s `pom.xml` file in Anypoint Studio.
## See Also
- [NetSuite Connector Reference](https://docs.mulesoft.com/netsuite-connector/latest/netsuite-reference)
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Salesforce Help](https://help.salesforce.com)
---
product: NetSuite Connector
version: 11.10
---
# Upgrading and Migrating to NetSuite Connector 11.x
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Upgrade NetSuite Connector to version 11.x to use the new features.
## Supported Upgrade Paths
## Changes in This Release
In NetSuite Connector 10.x, the connector resolved metadata by receiving Java objects as input, and
converting those objects internally to XML, so that NetSuite could understand it. In NetSuite
Connector 11.x, XML metadata is resolved directly without the need for conversion.
Because of this modification, the input and output metadata for connector operations has changed and
is now equivalent to the request and response bodies of the corresponding SOAP API operations. You
can use DataSense explorer in Studio to drag and drop the metadata fields, which generates their
corresponding namespaces and tags automatically.
Version 11.x also eliminates the REST-based operations.
## Changes to Sources
Removed the **Page Size** field for the sources **On Deleted Object**, **On Modified Object**, and
**On New Object**. Each source now returns one record in the output metadata.
> [!NOTE] In NetSuite Connector 11.10, the **On Deleted Object** source supports page size.
## Changes to Operations
### Advanced Operations
Changes to advanced operations include the following:
| Operation | Changes |
|---|
Change Email | Returns a NetsuiteSoapAttributes object in the output metadata |
Change Password | Returns a NetsuiteSoapAttributes object in the output metadata |
Get Account Governance Info | Returns a GetAccountGovernanceInfoResult object in the output metadata |
Get Data Center URLs | Returns a NetsuiteSoapAttributes object in the output metadata. |
Get Integration Governance Info | Returns a GetIntegrationGovernanceInfoResult object in the output metadata |
Get Server Time | Returns a NetsuiteSoapAttributes object in the output metadata |
### Async Operations
Each operation now returns a NetsuiteSoapAttributes object in the output metadata. Other changes to
the async operations include the following:
| Operation | Changes |
|---|
Async Add List | Removed the Record Type and Records fields. You now specify the associated values in the Message field of the input metadata. |
Async Delete List | Removed the Deleted Base Ref Types field. You now specify the associated values in the Message field of the input metadata. |
Async Delete List Records | Removed this operation. For equivalent functionality, use the Async Delete List operation and specify the recordRef or baseRefType in the Message field of the input metadata. |
Async Get List | Removed the Retrieved Base Ref Types field. You now specify the associated values in the Message field of the input metadata. |
Async Get List Records | Removed this operation. For equivalent functionality, use the Get List operation and specify FILE as the record type in the Message field of the input metadata. |
Async Initialize List | Removed the Initialize Records field. You now specify the associated values in the Message field of the input metadata. |
Async Search | Removed the Search Record and Criteria fields. You now specify the associated values in the Message field of the input metadata. |
Async Update List | Renamed Record Type to Type. Removed Records attributes. You now specify the associated values in the Message field of the input metadata. |
Async Upsert List | Renamed Record Type to Type. Removed Records attributes. You now specify the associated values in the Message field of the input metadata. |
Check Async Status | No changes. |
Get Async Result | No changes. |
### Invitee Operations
Each invitee operation now returns a NetsuiteSoapAttributes object in the output metadata. Other
changes to the invitee operations include the following:
| Operation | Changes |
|---|
Update Invitee Status | Removed the Event ID and Status fields. You now specify these values in the Message field of the input metadata. |
Update Invitee Status List | Removed the Record Type and Invitee Statuses fields. You now specify these values in the Message field of the input metadata. |
### Item Operations
Each item operation now returns a NetSuiteSoapAttributes object in the XML metadata. Other changes
to the invitee operations include the following:
| Operation | Changes |
|---|
Get Budget Exchange Rates | New operation that returns a list of budget exchange rates for a specified period. |
Get Customization Id | New operation that returns the IDs of available customizations for a given customization type. |
Get Currency Rate | Removed the Rate Filter field. You now specify this value in the Message field of the input metadata. |
Get Item Availability | Removed the Record and If Modified Since fields. You now specify these values in the Message field of the input metadata. |
Get Posting Transaction Summary | Removed the Fields, Filters, and Page Index fields. You now specify these values in the Message field of the input metadata. Returns a postingTransactionSummaryList object in the payload of the output metadata.
|
### Record Operations
Changes to record operations include the following:
| Operation | Changes |
|---|
Add File | Removed this operation. For equivalent functionality, use the Add operation and specify FILE as the record type in the Message field of the input metadata. |
Add List | |
Add Record | |
Add Record Objects | Removed this operation. For equivalent functionality, use the Add List operation. |
Attach Record | Renamed to Attach. Removed the Source, Destination, and Contact fields. You now specify the associated values in the Message field of the input metatada. Returns a NetsuiteSoapAttributes object in the output metadata with an attached object as the payload..
|
Delete | |
Delete List | |
Delete Record | Removed this operation. For equivalent functionality, use the Delete operation. |
Delete Records List | Removed this operation. For equivalent functionality, use the Delete List operation. |
Detach Record | |
Get | Removed the Base Ref field. You now specify the associated values in the Message field of the input metadata. Returns the requested record in the payload of the output metadata. The playload fields differ based on the specified record type.
|
Get Custom Record | Removed this operation. For equivalent functionality, use the Get operation. |
Get Deleted Records | Removed the Record Type, Page Index, and Deleted Date fields. You now specify the associated values in the Message field of the input metatada. Returns a NetsuiteSoapAttributes object in the output metadata.
|
Get List | |
Get Record | Removed this operation. For equivalent functionality, use the Get operation. |
Get Records | Returns a NetsuiteSoapAttributes object in the output metadata |
Get Select Value | Returns a getSelectValueResponse object in the payload of the output metadata. |
Get Saved Search | |
Initialize | |
Initialize List | |
Search | Removed the Key and Search Record fields. You now specify the associated values in the Message field of the input metatada. Returns a recordList or searchRowList object in the payload of the output metadata, depending on whether records or rows are searched.
|
Update List | |
Update Record | |
Update Records List | Removed this operation. For equivalent functionality, use the Update List operation. |
Upsert List | |
Upsert Record a | Renamed the operation to Upsert and removed the Attributes field. You now specify the associated values in the Message field of the input metatada. Returns a NetsuiteSoapAttributes object in the output metadata.
|
## Upgrade Steps
If you are upgrading from an earlier version of the connector, you can click the `Updates Available`
pop-up Message in the bottom right corner of Anypoint Studio and follow the prompts.
You can also follow these steps to perform the upgrade:
1. In Anypoint Studio, create a Mule project.
2. In **Mule Palette**, click **Search in Exchange**.
3. In **Add Dependencies to Project**, enter `netsuite` in the search field.
4. In **Available modules**, select **NetSuite** and click **Add**.
Studio upgrades the connector automatically.
5. Click **Finish**.
6. In the `pom.xml` file for the Mule project, verify that the NetSuite Connector dependency
version is `11.0.0`.
## Post Upgrade Tasks
- Ensure that your configurations use either **Request Based** or **Token** authentication.
- Verify that your error handling is updated to work with the minor changes in error codes in this
version of the connector.
- Refer to [Changed Operations](#changed_operations) and [Changed Sources](#changed-sources) for
updated operations and sources.
If your integration uses any of the affected operations and sources, make the necessary changes to
comply with the new interfaces.
- Because the package of the exposed classes was changed to
`com.mulesoft.connector.netsuite.extension.api`, you must update all DataWeave mappings that
create objects for operation inputs.
You must also update mappings that transform object outputs.
## Verify the Upgrade
After you install the latest version of the connector, verify the upgrade:
1. In Studio, verify that there are no errors in the **Problems** or **Console** views.
2. Verify that there are no problems in the project `pom.xml` file.
3. Test the connection to verify that the operations work.
## Revert the Upgrade
If you must revert to your previous version of NetSuite Connector, change the
`mule-netsuite-connector` dependency version `10.0.0` in the project’s `pom.xml` to the previous
version. Additionally, revert any changes made in the operations to their previous state.
## See Also
[Salesforce Help](https://help.salesforce.com)
---
product: NetSuite Connector
version: 11.11
---
# Upgrading and Migrating to NetSuite Connector 11.x
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Upgrade NetSuite Connector to version 11.x to use the new features.
## Supported Upgrade Paths
## Changes in This Release
In NetSuite Connector 10.x, the connector resolved metadata by receiving Java objects as input, and
converting those objects internally to XML, so that NetSuite could understand it. In NetSuite
Connector 11.x, XML metadata is resolved directly without the need for conversion.
Because of this modification, the input and output metadata for connector operations has changed and
is now equivalent to the request and response bodies of the corresponding SOAP API operations. You
can use DataSense explorer in Studio to drag and drop the metadata fields, which generates their
corresponding namespaces and tags automatically.
Version 11.x also eliminates the REST-based operations.
## Changes to Sources
Removed the **Page Size** field for the sources **On Deleted Object**, **On Modified Object**, and
**On New Object**. Each source now returns one record in the output metadata.
> [!NOTE] In NetSuite Connector 11.10, the **On Deleted Object** source supports page size.
## Changes to Operations
### Advanced Operations
Changes to advanced operations include the following:
| Operation | Changes |
|---|
Change Email | Returns a NetsuiteSoapAttributes object in the output metadata |
Change Password | Returns a NetsuiteSoapAttributes object in the output metadata |
Get Account Governance Info | Returns a GetAccountGovernanceInfoResult object in the output metadata |
Get Data Center URLs | Returns a NetsuiteSoapAttributes object in the output metadata. |
Get Integration Governance Info | Returns a GetIntegrationGovernanceInfoResult object in the output metadata |
Get Server Time | Returns a NetsuiteSoapAttributes object in the output metadata |
### Async Operations
Each operation now returns a NetsuiteSoapAttributes object in the output metadata. Other changes to
the async operations include the following:
| Operation | Changes |
|---|
Async Add List | Removed the Record Type and Records fields. You now specify the associated values in the Message field of the input metadata. |
Async Delete List | Removed the Deleted Base Ref Types field. You now specify the associated values in the Message field of the input metadata. |
Async Delete List Records | Removed this operation. For equivalent functionality, use the Async Delete List operation and specify the recordRef or baseRefType in the Message field of the input metadata. |
Async Get List | Removed the Retrieved Base Ref Types field. You now specify the associated values in the Message field of the input metadata. |
Async Get List Records | Removed this operation. For equivalent functionality, use the Get List operation and specify FILE as the record type in the Message field of the input metadata. |
Async Initialize List | Removed the Initialize Records field. You now specify the associated values in the Message field of the input metadata. |
Async Search | Removed the Search Record and Criteria fields. You now specify the associated values in the Message field of the input metadata. |
Async Update List | Renamed Record Type to Type. Removed Records attributes. You now specify the associated values in the Message field of the input metadata. |
Async Upsert List | Renamed Record Type to Type. Removed Records attributes. You now specify the associated values in the Message field of the input metadata. |
Check Async Status | No changes. |
Get Async Result | No changes. |
### Invitee Operations
Each invitee operation now returns a NetsuiteSoapAttributes object in the output metadata. Other
changes to the invitee operations include the following:
| Operation | Changes |
|---|
Update Invitee Status | Removed the Event ID and Status fields. You now specify these values in the Message field of the input metadata. |
Update Invitee Status List | Removed the Record Type and Invitee Statuses fields. You now specify these values in the Message field of the input metadata. |
### Item Operations
Each item operation now returns a NetSuiteSoapAttributes object in the XML metadata. Other changes
to the invitee operations include the following:
| Operation | Changes |
|---|
Get Budget Exchange Rates | New operation that returns a list of budget exchange rates for a specified period. |
Get Customization Id | New operation that returns the IDs of available customizations for a given customization type. |
Get Currency Rate | Removed the Rate Filter field. You now specify this value in the Message field of the input metadata. |
Get Item Availability | Removed the Record and If Modified Since fields. You now specify these values in the Message field of the input metadata. |
Get Posting Transaction Summary | Removed the Fields, Filters, and Page Index fields. You now specify these values in the Message field of the input metadata. Returns a postingTransactionSummaryList object in the payload of the output metadata.
|
### Record Operations
Changes to record operations include the following:
| Operation | Changes |
|---|
Add File | Removed this operation. For equivalent functionality, use the Add operation and specify FILE as the record type in the Message field of the input metadata. |
Add List | |
Add Record | |
Add Record Objects | Removed this operation. For equivalent functionality, use the Add List operation. |
Attach Record | Renamed to Attach. Removed the Source, Destination, and Contact fields. You now specify the associated values in the Message field of the input metatada. Returns a NetsuiteSoapAttributes object in the output metadata with an attached object as the payload..
|
Delete | |
Delete List | |
Delete Record | Removed this operation. For equivalent functionality, use the Delete operation. |
Delete Records List | Removed this operation. For equivalent functionality, use the Delete List operation. |
Detach Record | |
Get | Removed the Base Ref field. You now specify the associated values in the Message field of the input metadata. Returns the requested record in the payload of the output metadata. The playload fields differ based on the specified record type.
|
Get Custom Record | Removed this operation. For equivalent functionality, use the Get operation. |
Get Deleted Records | Removed the Record Type, Page Index, and Deleted Date fields. You now specify the associated values in the Message field of the input metatada. Returns a NetsuiteSoapAttributes object in the output metadata.
|
Get List | |
Get Record | Removed this operation. For equivalent functionality, use the Get operation. |
Get Records | Returns a NetsuiteSoapAttributes object in the output metadata |
Get Select Value | Returns a getSelectValueResponse object in the payload of the output metadata. |
Get Saved Search | |
Initialize | |
Initialize List | |
Search | Removed the Key and Search Record fields. You now specify the associated values in the Message field of the input metatada. Returns a recordList or searchRowList object in the payload of the output metadata, depending on whether records or rows are searched.
|
Update List | |
Update Record | |
Update Records List | Removed this operation. For equivalent functionality, use the Update List operation. |
Upsert List | |
Upsert Record a | Renamed the operation to Upsert and removed the Attributes field. You now specify the associated values in the Message field of the input metatada. Returns a NetsuiteSoapAttributes object in the output metadata.
|
## Upgrade Steps
If you are upgrading from an earlier version of the connector, you can click the `Updates Available`
pop-up Message in the bottom right corner of Anypoint Studio and follow the prompts.
You can also follow these steps to perform the upgrade:
1. In Anypoint Studio, create a Mule project.
2. In **Mule Palette**, click **Search in Exchange**.
3. In **Add Dependencies to Project**, enter `netsuite` in the search field.
4. In **Available modules**, select **NetSuite** and click **Add**.
Studio upgrades the connector automatically.
5. Click **Finish**.
6. In the `pom.xml` file for the Mule project, verify that the NetSuite Connector dependency
version is `11.0.0`.
## Post Upgrade Tasks
- Ensure that your configurations use either **Request Based** or **Token** authentication.
- Verify that your error handling is updated to work with the minor changes in error codes in this
version of the connector.
- Refer to [Changed Operations](#changed_operations) and [Changed Sources](#changed-sources) for
updated operations and sources.
If your integration uses any of the affected operations and sources, make the necessary changes to
comply with the new interfaces.
- Because the package of the exposed classes was changed to
`com.mulesoft.connector.netsuite.extension.api`, you must update all DataWeave mappings that
create objects for operation inputs.
You must also update mappings that transform object outputs.
## Verify the Upgrade
After you install the latest version of the connector, verify the upgrade:
1. In Studio, verify that there are no errors in the **Problems** or **Console** views.
2. Verify that there are no problems in the project `pom.xml` file.
3. Test the connection to verify that the operations work.
## Revert the Upgrade
If you must revert to your previous version of NetSuite Connector, change the
`mule-netsuite-connector` dependency version `10.0.0` in the project’s `pom.xml` to the previous
version. Additionally, revert any changes made in the operations to their previous state.
## See Also
[Salesforce Help](https://help.salesforce.com)
---
product: NetSuite Connector
version: 11.10
---
# Using Anypoint Studio to Configure NetSuite Connector 11.10
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and
configuration files.
To add and configure a connector in Studio:
1. [Create a Mule project](#create-mule-project).
2. [Add the connector to your Mule project](#add-connector-to-project).
3. [Configure a source for the connector’s flow](#configure-input-source).
4. [Add a connector operation to the flow](#add-connector-operation).
5. [Configure a global element for the connector](#configure-global-element).
When you run the connector, you can view the app log to check for problems, as described in
[View the App Log](#view-app-log).
If you are new to configuring connectors in Studio, see
[Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio).
If, after reading this topic, you need additional information about the connector fields, see the
[NetSuite Reference](https://docs.mulesoft.com/netsuite-connector/11.10/netsuite-reference).
## Create a Mule Project
In Studio, create a new Mule project in which to add and configure the connector:
1. In Studio, select **File > New > Mule Project**.
2. Enter a name for your Mule project and click **Finish**.
## Add the Connector to Your Mule Project
Add NetSuite Connector to your Mule project to automatically populate the XML code with the
connector’s namespace and schema location and add the required dependencies to the project’s
`pom.xml` file:
1. In the **Mule Palette** view, click **(X) Search in Exchange**.
2. In **Add Modules to Project**, type `netsuite` in the search field.
3. Click **NetSuite Connector** in **Available modules**.
4. Click **Add**.
5. Click **Finish**.
Adding a connector to a Mule project in Studio does not make that connector available to other
projects in your Studio workspace.
## Configure a Source
A source initiates a flow when a specified condition is met. You can configure one of these sources
to use with NetSuite Connector:
- **HTTP Listener**, which initiates a flow each time it receives a request on the configured host
and port
- **Scheduler**, which initiates a flow when a time-based condition is met
For example, to configure **HTTP Listener**, follow these steps:
1. In the **Mule Palette** view, select **HTTP > Listener**.
2. Drag **Listener** to the Studio canvas.
3. On the **Listener** configuration screen, optionally change the value of the **Display Name**
field.
4. Specify a value for the **Path** field.
5. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
element that can be used by all instances of `HTTP Listener` in the app.
6. On the **General** tab, specify connection information.
7. On the **TLS** tab, optionally specify TLS information.
8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection
strategy.
9. Click **Test Connection** to confirm that Mule can connect with the specific server.
10. Click **OK**.
## Add a Connector Operation to the Flow
When you add a connector operation to your flow, you immediately define a specific operation for
that connector to perform.
To add an operation for NetSuite Connector, follow these steps:
1. In the **Mule Palette** view, select **NetSuite** and then select the desired operation.
2. Drag the operation onto the Studio canvas to the right of the source.
## Configure a Global Element for the Connector
When you configure a connector, it’s best to configure a global element that all instances of that
connector in the app can use. Configuring a global element requires you to provide the
authentication credentials the connector uses to access the target NetSuite system. NetSuite
Connector supports token-based authentication.
To configure the global element for NetSuite Connector, follow these steps:
1. Select the name of the connector in the Studio canvas.
2. In the configuration screen for the operation, click the plus sign (**+**) next to the
**Connector configuration** field to access the global element configuration fields.
3. On the **General** tab, configure [Token Authentication](#token-authentication), which
authenticates by using either a consumer key and token ID or secret pairs for authentication
To configure NetSuite authentication, you must have the account ID for SuiteTalk NetSuite Web
Services, which you can find within the NetSuite sandbox UI under **Setup > Integration > Web
Service Preferences**.
4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection
strategy.
5. Click **Test Connection** to confirm that Mule can connect with the specified server.
6. Click **OK**.
### Token-Based Authentication
With token-based authentication, you authenticate by using either a consumer key and token ID or by
using secret pairs, which are established within the NetSuite environment.
The following screenshot shows an example of configuring token-based authentication:

Enter the following information on the **General** tab of the global element configuration screen to
configure token-based authentication:
| Parameter | Description |
|---|
Consumer Key | Consumer key value for the token-based authentication-enabled integration record to use |
Consumer Secret | Consumer secret value for the token-based authentication-enabled integration record to use |
Token ID | Token ID that represents the unique combination of a user and an integration record that is generated within the NetSuite environment |
Token Secret | Respective token secret for the user and an integration record pair |
Account | Account ID for SuiteTalk NetSuite Web Services |
Signature algorithm | Type of hash-based message authentication code (HMAC) signature algorithm |
## View the App Log
To check for problems, you can view the app log as follows:
- If you’re running the app from Anypoint Platform, the output is visible in the Anypoint Studio
console window.
- If you’re running the app using Mule from the command line, the app log is visible in your OS
console.
Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the
app log in the default location `MULE_HOME/logs/.log`.
## Next Steps
After configuring Studio, see the [Examples](https://docs.mulesoft.com/netsuite-connector/11.10/netsuite-examples) topic for more configuration ideas.
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)
- [NetSuite Connector Reference](https://docs.mulesoft.com/netsuite-connector/11.10/netsuite-reference)
- [Salesforce Help](https://help.salesforce.com)
---
product: NetSuite Connector
version: 11.11
---
# Using Anypoint Studio to Configure NetSuite Connector 11.11
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and
configuration files.
To add and configure a connector in Studio:
1. [Create a Mule project](#create-mule-project).
2. [Add the connector to your Mule project](#add-connector-to-project).
3. [Configure a source for the connector’s flow](#configure-input-source).
4. [Add a connector operation to the flow](#add-connector-operation).
5. [Configure a global element for the connector](#configure-global-element).
When you run the connector, you can view the app log to check for problems, as described in
[View the App Log](#view-app-log).
If you are new to configuring connectors in Studio, see
[Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio).
If, after reading this topic, you need additional information about the connector fields, see the
[NetSuite Reference](https://docs.mulesoft.com/netsuite-connector/11.11/netsuite-reference).
## Create a Mule Project
In Studio, create a new Mule project in which to add and configure the connector:
1. In Studio, select **File > New > Mule Project**.
2. Enter a name for your Mule project and click **Finish**.
## Add the Connector to Your Mule Project
Add NetSuite Connector to your Mule project to automatically populate the XML code with the
connector’s namespace and schema location and add the required dependencies to the project’s
`pom.xml` file:
1. In the **Mule Palette** view, click **(X) Search in Exchange**.
2. In **Add Modules to Project**, type `netsuite` in the search field.
3. Click **NetSuite Connector** in **Available modules**.
4. Click **Add**.
5. Click **Finish**.
Adding a connector to a Mule project in Studio does not make that connector available to other
projects in your Studio workspace.
## Configure a Source
A source initiates a flow when a specified condition is met. You can configure one of these sources
to use with NetSuite Connector:
- **HTTP Listener**, which initiates a flow each time it receives a request on the configured host
and port
- **Scheduler**, which initiates a flow when a time-based condition is met
For example, to configure **HTTP Listener**, follow these steps:
1. In the **Mule Palette** view, select **HTTP > Listener**.
2. Drag **Listener** to the Studio canvas.
3. On the **Listener** configuration screen, optionally change the value of the **Display Name**
field.
4. Specify a value for the **Path** field.
5. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
element that can be used by all instances of `HTTP Listener` in the app.
6. On the **General** tab, specify connection information.
7. On the **TLS** tab, optionally specify TLS information.
8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection
strategy.
9. Click **Test Connection** to confirm that Mule can connect with the specific server.
10. Click **OK**.
## Add a Connector Operation to the Flow
When you add a connector operation to your flow, you immediately define a specific operation for
that connector to perform.
To add an operation for NetSuite Connector, follow these steps:
1. In the **Mule Palette** view, select **NetSuite** and then select the desired operation.
2. Drag the operation onto the Studio canvas to the right of the source.
## Configure a Global Element for the Connector
When you configure a connector, it’s best to configure a global element that all instances of that
connector in the app can use. Configuring a global element requires you to provide the
authentication credentials the connector uses to access the target NetSuite system. NetSuite
Connector supports token-based authentication.
To configure the global element for NetSuite Connector, follow these steps:
1. Select the name of the connector in the Studio canvas.
2. In the configuration screen for the operation, click the plus sign (**+**) next to the
**Connector configuration** field to access the global element configuration fields.
3. On the **General** tab, configure [Token Authentication](#token-authentication), which
authenticates by using either a consumer key and token ID or secret pairs for authentication
To configure NetSuite authentication, you must have the account ID for SuiteTalk NetSuite Web
Services, which you can find within the NetSuite sandbox UI under **Setup > Integration > Web
Service Preferences**.
4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection
strategy.
5. Click **Test Connection** to confirm that Mule can connect with the specified server.
6. Click **OK**.
### Token-Based Authentication
With token-based authentication, you authenticate by using either a consumer key and token ID or by
using secret pairs, which are established within the NetSuite environment.
The following screenshot shows an example of configuring token-based authentication:

Enter the following information on the **General** tab of the global element configuration screen to
configure token-based authentication:
| Parameter | Description |
|---|
Consumer Key | Consumer key value for the token-based authentication-enabled integration record to use |
Consumer Secret | Consumer secret value for the token-based authentication-enabled integration record to use |
Token ID | Token ID that represents the unique combination of a user and an integration record that is generated within the NetSuite environment |
Token Secret | Respective token secret for the user and an integration record pair |
Account | Account ID for SuiteTalk NetSuite Web Services |
Signature algorithm | Type of hash-based message authentication code (HMAC) signature algorithm |
## View the App Log
To check for problems, you can view the app log as follows:
- If you’re running the app from Anypoint Platform, the output is visible in the Anypoint Studio
console window.
- If you’re running the app using Mule from the command line, the app log is visible in your OS
console.
Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the
app log in the default location `MULE_HOME/logs/.log`.
## Next Steps
After configuring Studio, see the [Examples](https://docs.mulesoft.com/netsuite-connector/11.11/netsuite-examples) topic for more configuration ideas.
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)
- [NetSuite Connector Reference](https://docs.mulesoft.com/netsuite-connector/11.11/netsuite-reference)
- [Salesforce Help](https://help.salesforce.com)
---
product: NetSuite Connector
version: 12.0
is-latest-version: true
---
# Using Anypoint Studio to Configure NetSuite Connector 12.0
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and
configuration files.
To add and configure a connector in Studio:
1. [Create a Mule project](#create-mule-project).
2. [Add the connector to your Mule project](#add-connector-to-project).
3. [Configure a source for the connector’s flow](#configure-input-source).
4. [Add a connector operation to the flow](#add-connector-operation).
5. [Configure a global element for the connector](#configure-global-element).
When you run the connector, you can view the app log to check for problems, as described in
[View the App Log](#view-app-log).
If you are new to configuring connectors in Studio, see
[Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio).
If, after reading this topic, you need additional information about the connector fields, see the
[NetSuite Reference](https://docs.mulesoft.com/netsuite-connector/latest/netsuite-reference).
## Create a Mule Project
In Studio, create a new Mule project in which to add and configure the connector:
1. In Studio, select **File > New > Mule Project**.
2. Enter a name for your Mule project and click **Finish**.
## Add the Connector to Your Mule Project
Add NetSuite Connector to your Mule project to automatically populate the XML code with the
connector’s namespace and schema location and add the required dependencies to the project’s
`pom.xml` file:
1. In the **Mule Palette** view, click **(X) Search in Exchange**.
2. In **Add Modules to Project**, type `netsuite` in the search field.
3. Click **NetSuite Connector** in **Available modules**.
4. Click **Add**.
5. Click **Finish**.
Adding a connector to a Mule project in Studio does not make that connector available to other
projects in your Studio workspace.
## Configure a Source
A source initiates a flow when a specified condition is met. You can configure one of these sources
to use with NetSuite Connector:
- **HTTP Listener**, which initiates a flow each time it receives a request on the configured host
and port
- **Scheduler**, which initiates a flow when a time-based condition is met
For example, to configure **HTTP Listener**, follow these steps:
1. In the **Mule Palette** view, select **HTTP > Listener**.
2. Drag **Listener** to the Studio canvas.
3. On the **Listener** configuration screen, optionally change the value of the **Display Name**
field.
4. Specify a value for the **Path** field.
5. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
element that can be used by all instances of `HTTP Listener` in the app.
6. On the **General** tab, specify connection information.
7. On the **TLS** tab, optionally specify TLS information.
8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection
strategy.
9. Click **Test Connection** to confirm that Mule can connect with the specific server.
10. Click **OK**.
## Add a Connector Operation to the Flow
When you add a connector operation to your flow, you immediately define a specific operation for
that connector to perform.
To add an operation for NetSuite Connector, follow these steps:
1. In the **Mule Palette** view, select **NetSuite** and then select the desired operation.
2. Drag the operation onto the Studio canvas to the right of the source.
## Configure a Global Element for the Connector
When you configure a connector, it’s best to configure a global element that all instances of that
connector in the app can use. Configuring a global element requires you to provide the
authentication credentials the connector uses to access the target NetSuite system. NetSuite
Connector supports token-based authentication.
To configure the global element for NetSuite Connector, follow these steps:
1. Select the name of the connector in the Studio canvas.
2. In the configuration screen for the operation, click the plus sign (**+**) next to the
**Connector configuration** field to access the global element configuration fields.
3. On the **General** tab, configure [Token Authentication](#token-authentication), which
authenticates by using either a consumer key and token ID or secret pairs for authentication
To configure NetSuite authentication, you must have the account ID for SuiteTalk NetSuite Web
Services, which you can find within the NetSuite sandbox UI under **Setup > Integration > Web
Service Preferences**.
4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection
strategy.
5. Click **Test Connection** to confirm that Mule can connect with the specified server.
6. Click **OK**.
### Token-Based Authentication
With token-based authentication, you authenticate by using either a consumer key and token ID or by
using secret pairs, which are established within the NetSuite environment.
The following screenshot shows an example of configuring token-based authentication:

Enter the following information on the **General** tab of the global element configuration screen to
configure token-based authentication:
| Parameter | Description |
|---|
Consumer Key | Consumer key value for the token-based authentication-enabled integration record to use |
Consumer Secret | Consumer secret value for the token-based authentication-enabled integration record to use |
Token ID | Token ID that represents the unique combination of a user and an integration record that is generated within the NetSuite environment |
Token Secret | Respective token secret for the user and an integration record pair |
Account | Account ID for SuiteTalk NetSuite Web Services |
Signature algorithm | Type of hash-based message authentication code (HMAC) signature algorithm |
## View the App Log
To check for problems, you can view the app log as follows:
- If you’re running the app from Anypoint Platform, the output is visible in the Anypoint Studio
console window.
- If you’re running the app using Mule from the command line, the app log is visible in your OS
console.
Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the
app log in the default location `MULE_HOME/logs/.log`.
## Next Steps
After configuring Studio, see the [Examples](https://docs.mulesoft.com/netsuite-connector/latest/netsuite-examples) topic for more configuration ideas.
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)
- [NetSuite Connector Reference](https://docs.mulesoft.com/netsuite-connector/latest/netsuite-reference)
- [Salesforce Help](https://help.salesforce.com)