NetSuite

The NetSuite connector lets you perform insert, delete, update, and read operations on NetSuite data.

Before you begin

Before using the NetSuite connector, do the following tasks:

In your Google Cloud project:
- Ensure that network connectivity is set up. For information about network patterns, see Network connectivity.
- Grant the roles/connectors.admin IAM role to the user configuring the connector.
- Grant the following IAM roles to the service account that you want to use for the connector:
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  A service account is a special type of Google account intended to represent a non-human user that needs to authenticate and be authorized to access data in Google APIs. If you don't have a service account, you must create a service account. For more information, see Creating a service account.
- Enable the following services:
  - secretmanager.googleapis.com (Secret Manager API)
  - connectors.googleapis.com (Connectors API)
  To understand how to enable services, see Enabling services.
If these services or permissions have not been enabled for your project previously, you are prompted to enable them when configuring the connector.

Configure the connector

Configuring the connector requires you to create a connection to your data source (backend system). A connection is specific to a data source. It means that if you have many data sources, you must create a separate connection for each data source. To create a connection, do the following steps:

In the Cloud console, go to the Integration Connectors > Connections page and then select or create a Google Cloud project.
Go to the Connections page
Click + Create new to open the Create Connection page.
In the Location section, choose the location for the connection.
1. Region: Select a location from the drop-down list.
  Supported regions for connectors include:
  For the list of all the supported regions, see Locations.
2. Click Next.
In the Connection Details section, complete the following:
1. Connector: Select Netsuite from the drop down list of available Connectors.
2. Connector version: Select the Connector version from the drop down list of available versions.
3. In the Connection Name field, enter a name for the Connection instance.
  Connection names must meet the following criteria:
  - Connection names can use letters, numbers, or hyphens.
  - Letters must be lower-case.
  - Connection names must begin with a letter and end with a letter or number.
  - Connection names cannot exceed 49 characters.
4. Optionally, enter a Description for the connection instance.
5. Optionally, enable Cloud logging, and then select a log level. By default, the log level is set to Error.
6. Service Account: Select a service account that has the required roles.
7. Optionally, configure the Connection node settings:
  - Minimum number of nodes: Enter the minimum number of connection nodes.
  - Maximum number of nodes: Enter the maximum number of connection nodes.
  A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.
8. Account Id: The company account your username is associated with on NetSuite.
9. Aggregate Column Mode: Indicating how aggregate columns should be treated.
10. Application Id: As of version 2020.1, requests to NetSuite require an application ID.
11. Custom Field Permissions: A comma separated list of custom field permissions. Gives more control than IncludeCustomFieldColumns .
12. Include Child Tables: A boolean indicating if child tables should be displayed.
13. Include Custom Field Columns: A boolean indicating if you would like to include custom field columns.
14. Include Custom List Tables: A boolean indicating if you would like to use tables based on custom lists.
15. Include Custom Record Tables: A boolean indicating if you would like to use tables based on custom record types.
16. Include Reference Columns: A comma separated list representing the columns to include when retrieving data from a field representing a record reference.
17. Maximum Concurrent Sessions: The maximum number of concurrent sessions available for use in the connection.
18. Net Suite Date Format: The preferred date format set in NetSuite UI.
19. Net Suite Long Date Format: The preferred long date format set in NetSuite UI.
20. Netsuite Metadata Folder: A path to a directory to download metadata files from NetSuite. Set this for best performance.
21. Report Doubles As Decimal: Indicates if doubles should be reported as decimal.
22. Request Memorized Transactions: A boolean indicating if you would like to request memorized transactions when retrieving transactions from NetSuite.
23. Role Id: The RoleId is the InternalId of the role that will be used to log in to NetSuite. Leave empty to use the user's default role.
24. Schema: The type of schema to use. You can select any of the following values:
  - SuiteTalk - For SOAP based connectivity.
  - SuiteSQL - For REST based connectivity.
25. Use Async Services: A boolean indicating if you would like to use asynchronous services when inserting, updating, and deleting.
26. Use Internal Names For Customizations: A boolean indicating if you would like to use internal names for customizations.
27. Use Upserts: A boolean indicating if you would like to perform an upsert when an insert operation is used.
28. User Timezone Offset: Your user timezone offset as defined in your NetSuite preferences under Home --> Preferences --> Time Zone. Ex: EST.
29. Row Scan Depth: The number of rows to scan when dynamically determining columns for the table.
30. Use proxy: Select this checkbox to configure a proxy server for the connection and configure the following values:
31. Optionally, click + Add label to add a label to the Connection in the form of a key/value pair.
32. Click Next.
In the Destinations section, enter details of the remote host (backend system) you want to connect to.
1. Destination Type: You can specify the destination details either as a host address or a service attachment. Select any of the following destination types:
  - Host address: If you want to specify the hostname or IP address of the destination.
  - Service attachment: If you want to specify the private endpoint for your internal IP addresses. The service attachment, lets you hide your internal IP addresses from the external network. You can create a service attachment in Google Cloud, by using the Private Service Connect feature. For information on configuring a Private Service Connect, see Publish managed services.
  Based on your selection of destination type, enter the host address or the service attachment name.
  
  To enter additional destinations, click +Add destination.
2. Click Next.
In the Authentication section, enter the authentication details.
1. Select an Authentication type and enter the relevant details.
  The following authentication types are supported by the Netsuite connection:
  - Username and password
  - Token Based Authentication
  - OAuth 2.0 Auth Code Grant
2. Click Next.
Review: Review your connection and authentication details.
Click Create.

Configure authentication

Enter the details based on the authentication you want to use.

Username and password
Username and password authentication. This is valid only for Netsuite version 2020.2 or older.
- Username: Username for connector
- Password: Secret Manager Secret containing the password associated with the connector.

Token Based Authentication
Token Based Authentication for Netsuite. This can be used for both SuiteTalk and SuiteQL schemes.
- OAuth Client Id: the Consumer Key displayed when the application was created.
- OAuth Client Secret: Secret Manager Secret containing the consumer secret displayed when the application was created.
- OAuth Access Token: the Token Id when the access token was created.
- OAuth Access Token Secret: Secret Manager Secret containing the token secret when the access token was created.

OAuth 2.0 - Authorization code

Authorization of connection is done with a web-based user login flow. This is valid only for the SuiteQL scheme.

Client ID: The client ID used for requesting access tokens.
Scopes: A comma-separated list of the required scopes.
Client secret: The client secret used for requesting access tokens.

For the Authorization code authentication type, after creating the connection, you should perform a few additional steps for configuring authentication. For more information, see Additional steps after connection creation.

Note: If you are using Authorization code authentication type and have made any cofiguration changes in your external application, you must re-authorize your HTTP connection. To understand how to re-authorize, see Re-authorization for Authorization code.

Additional steps after connection creation

If you selected OAuth 2.0 - Authorization code for authentication, you must do the following additional steps after creating the connection:

In the Connections page, locate the newly created connection.
Notice that the Status for the new connector will be Authorization required.
Click Authorization required.
This shows the Edit authorization pane.
Copy the Redirect URI value to your external application.
Verify the authorization details.
Click Authorize.
If the authorization is successful, the connection status will be set to Active in the Connections page.

Re-authorization for Authorization code

If you are using Authorization code authentication type and have made any cofiguration changes in your backend NetSuite application, you must re-authorize your NetSuite connection. To re-authorize a connection, perform the following steps:

Click on the required connection in the Connections page.
This opens the connection details page.
Click Edit to edit the connection details.
Verify the OAuth 2.0 - Authorization code details in the Authentication section.
If required, make the necessary changes.
Click Save. This takes you to the connection details page.
Click Edit authorization in the Authentication section. This shows the Authorize pane.
Click Authorize.
If the authorization is successful, the connection status will be set to Active in the Connections page.

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.
However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.
Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
- List
- Get
- Create
- Update
- Delete
Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.
Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

System limitations

The Netsuite connector can process 1 transaction per second, per node, and throttles any transactions beyond this limit. By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.

For information on the limits applicable to Integration Connectors, see Limits.

Note: The number of Integration Connectors nodes will autoscale dynamically based on your usage. However, if you want to reserve capacity for large volumes without waiting for autoscaling, you can adjust the minimum node value for a connection. More nodes are required to process more transactions for a connection. Conversely, fewer nodes are required if a connection processes fewer transactions. To configure the node values, do the following:

If you are a pay-as-you-go customer, configure the minimum and maximum node value in the edit connection page.
If you are a subscription based customer, contact support.

The maximum transactions that a node can handle depends on various factors. So, before adjusting the minimum nodes for better throughput, it is recommended you check if your backend systems are set up optimally to handle the required traffic.

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

When you perform

an insert operation in NetSuite, if all the necessary fields and data are not specified, the API to which the entity is aligned rejects the request. This results in an exception. The exception might vary based on the entity used in the insert operation. You must provide the NetSuite line items in the query to successfully insert data. You can specify the line item through the ItemListAggregate field that is available in all parent tables. The following is the format for the ItemListAggregate field: translate="no" dir="ltr" is-upgraded> " <ItemList_Item_InternalId>656</ItemList_Item_InternalId>\n" + " <ItemList_Item_Name>Iphone 15Pro</ItemList_Item_Name>\n" + " <ItemList_Line>1</ItemList_Line>\n" + " <ItemList_Description>Canon PowerShot Camera Test</ItemList_Description>\n" + " <ItemList_Amount>8500.0</ItemList_Amount>\n" + " <ItemList_Quantity>17.0</ItemList_Quantity>\n" + " <ItemList_Price_InternalId>1</ItemList_Price_InternalId>\n" + " <ItemList_Price_Name>List Price</ItemList_Price_Name>\n" + " <ItemList_Rate>500.00</ItemList_Rate>\n" + " <ItemList_Location_InternalId>1</ItemList_Location_InternalId>\n" + " <ItemList_Location_Name>02: NewYork</ItemList_Location_Name>\n" + " <ItemList_TaxCode_InternalId>-7</ItemList_TaxCode_InternalId>\n" + " <ItemList_TaxCode_Name>-Not Taxable-</ItemList_TaxCode_Name>\n" + " <ItemList_ShipGroup>1</ItemList_ShipGroup>\n" + " <ItemList_ItemIsFulfilled>false</ItemList_ItemIsFulfilled>\n" + " <CustomFieldListAggregate>\n" + " <CustomField InternalId=\"4779\" Type=\"platformCore:StringCustomFieldRef\" ScriptId=\"custcol121\">\n" + " <Value>1</Value>\n" + " </CustomField>\n" + " </CustomFieldListAggregate>\n" + " </Row>\n" + " <Row>\n" + " <ItemList_Item_InternalId>656</ItemList_Item_InternalId>\n" + " <ItemList_Item_Name>Iphone 15Pro</ItemList_Item_Name>\n" + " <ItemList_Line>4</ItemList_Line>\n" + " <ItemList_Description>Canon PowerShot Camera Test</ItemList_Description>\n" + " <ItemList_Amount>8500.0</ItemList_Amount>\n" + " <ItemList_Quantity>17.0</ItemList_Quantity>\n" + " <ItemList_Price_InternalId>1</ItemList_Price_InternalId>\n" + " <ItemList_Price_Name>List Price</ItemList_Price_Name>\n" + " <ItemList_Rate>500.00</ItemList_Rate>\n" + " <ItemList_Location_InternalId>2</ItemList_Location_InternalId>\n" + " <ItemList_Location_Name>01: California</ItemList_Location_Name>\n" + " <ItemList_TaxCode_InternalId>-7</ItemList_TaxCode_InternalId>\n" + " <ItemList_TaxCode_Name>-Not Taxable-</ItemList_TaxCode_Name>\n" + " <ItemList_ShipGroup>1</ItemList_ShipGroup>\n" + " <ItemList_ItemIsFulfilled>false</ItemList_ItemIsFulfilled>\n" + " <CustomFieldListAggregate>\n" + " <CustomField InternalId=\"4776\" Type=\"platformCore:StringCustomFieldRef\" ScriptId=\"custcol121\">\n" + " <Value>4</Value>\n" + " </CustomField>\n" + " </CustomFieldListAggregate>\n" + " </Row>\n" +

Example - List all the credit memos

This example lists all the credit memos in the CreditMemo entity.

In the Configure connector task dialog, click Entities.
Select CreditMemo from the Entity list.
Select the List operation, and then click Done.
Optionally, in Task Input section of the Connectors task, you can filter your result set by specifying a filter clause. Specify the filter clause value always within the single quotes (').

Example - Create a credit memo

This example creates a credit memo record in the CreditMemo entity.

In the Configure connector task dialog, click Entities.
Select CreditMemo from the Entity list.
Select the Create operation, and then click Done.

In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.

{
          "ItemListAggregate": " + "<ItemList>\n" +
                 "  <Row>\n" +
                 "    <ItemList_Item_InternalId>6</ItemList_Item_InternalId>\n" +
                 "    <ItemList_Line>2</ItemList_Line>\n" +
                 "    <ItemList_Amount>8800.0</ItemList_Amount>\n" +
                 "  </Row>\n" +
                 "  <Row>\n" +
                 "    <ItemList_Item_InternalId>6</ItemList_Item_InternalId>\n" +
                 "    <ItemList_Line>3</ItemList_Line>\n" +
                 "    <ItemList_Amount>9900.0</ItemList_Amount>\n" +
                 "  </Row>\n" +
                 "</ItemList>" + ",
          "Entity_InternalId": "11",
          "Email": "cloudysanfrancisco@gmail.com"
      }

If the integration is successful, the CreditMemo task's connectorOutputPayload response parameter has a value similar to the following:

{
    "InternalId": "106"
  }

Example - Create a customer record

This example creates a record in the Customer entity.

In the Configure connector task dialog, click Entities.
Select Customer from the Entity list.
Select the Create operation, and then click Done.
In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:
```
{
"CompanyName": "Test1",
"Email": "test3@gmail.com"
}
```
If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:
```
[{
"InternalId": "4767"
}]
```

Example - Update a sales order

This example updates a record in the SalesOrder entity.

In the Configure connector task dialog, click Entities.
Select SalesOrder from the Entity list.
Select the Update operation, and then click Done.
In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:
```
{
"Email": "test2@gmail.com",
"Entity_InternalId": "1709",
"Item_InternalId": "945"
 }
```
Click entityId, and then enter 1086949 in the Default Value field.
If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:
```
[{
"InternalId": "1086949"
}]
```

Use terraform to create connections

You can use the Terraform resource to create a new connection.

To learn how to apply or remove a Terraform configuration, see Basic Terraform commands.

To view a sample terraform template for connection creation, see sample template.

When creating this connection by using Terraform, you must set the following variables in your Terraform configuration file:

Parameter name	Data type	Required	Description
account_id	STRING	True	The company account your username is associated with on NetSuite.
aggregate_column_mode	STRING	False	Indicating how aggregate columns should be treated.
application_id	STRING	False	As of version 2020.1, requests to NetSuite require an application ID.
custom_field_permissions	STRING	False	A comma separated list of custom field permissions. Gives more control than IncludeCustomFieldColumns .
include_child_tables	BOOLEAN	False	A boolean indicating if child tables should be displayed.
include_custom_field_columns	BOOLEAN	False	A boolean indicating if you would like to include custom field columns.
include_custom_list_tables	BOOLEAN	False	A boolean indicating if you would like to use tables based on custom lists.
include_custom_record_tables	BOOLEAN	False	A boolean indicating if you would like to use tables based on custom record types.
include_reference_columns	STRING	False	A comma separated list representing the columns to include when retrieving data from a field representing a record reference.
maximum_concurrent_sessions	INTEGER	False	The maximum number of concurrent sessions available for use in the connection.
net_suite_date_format	STRING	False	The preferred date format set in NetSuite UI.
net_suite_long_date_format	STRING	False	The preferred long date format set in NetSuite UI.
netsuite_metadata_folder	STRING	False	A path to a directory to download metadata files from NetSuite. Set this for best performance.
report_doubles_as_decimal	BOOLEAN	False	Indicates if doubles should be reported as decimal.
request_memorized_transactions	BOOLEAN	False	A boolean indicating if you would like to request memorized transactions when retrieving transactions from NetSuite.
role_id	STRING	False	The RoleId is the InternalId of the role that will be used to log in to NetSuite. Leave empty to use the user's default role.
schema	STRING	True	The type of schema to use.
use_async_services	BOOLEAN	False	A boolean indicating if you would like to use asynchronous services when inserting, updating, and deleting.
use_internal_names_for_customizations	BOOLEAN	False	A boolean indicating if you would like to use internal names for customizations.
use_upserts	BOOLEAN	False	A boolean indicating if you would like to perform an upsert when an insert operation is used.
user_timezone_offset	STRING	False	Your user timezone offset as defined in your NetSuite preferences under Home --> Preferences --> Time Zone. Ex: EST.
row_scan_depth	STRING	False	The number of rows to scan when dynamically determining columns for the table.
verbosity	STRING	False	Verbosity level for connection, varies from 1-5. Higher verbosity level will log all the communication details (request,response & ssl certificates).
proxy_enabled	BOOLEAN	False	Select this checkbox to configure a proxy server for the connection.
proxy_auth_scheme	ENUM	False	The authentication type to use to authenticate to the ProxyServer proxy. Supported values are: BASIC, DIGEST, NONE
proxy_user	STRING	False	A user name to be used to authenticate to the ProxyServer proxy.
proxy_password	SECRET	False	A password to be used to authenticate to the ProxyServer proxy.
proxy_ssltype	ENUM	False	The SSL type to use when connecting to the ProxyServer proxy. Supported values are: AUTO, ALWAYS, NEVER, TUNNEL

Use the NetSuite connection in an integration

After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.

To understand how to create and use the Connectors task in Apigee Integration, see Connectors task.
To understand how to create and use the Connectors task in Application Integration, see Connectors task.

Get help from the Google Cloud community

You can post your questions and discuss this connector in the Google Cloud community at Cloud Forums.

What's next

Understand how to suspend and resume a connection.
Understand how to monitor connector usage.
Understand how to view connector logs.