Oracle NetSuite Connector

Oracle NetSuite is a unified business management suite, encompassing ERP/Financials, CRM and ecommerce. This component allows creating, reading, updating, deleting, and listing records in NetSuite, as well as executing SuiteQL queries.

API Documentation

This component was built using the following API References currently utilizing REST API v1:

Connections

NetSuite OAuth Auth Code

NetSuite OAuth 2.0 Connection

To connect to NetSuite using OAuth 2.0 Authorization Code flow, create an OAuth 2.0 application in NetSuite with authorization code grant enabled.

Refer to NetSuite's OAuth 2.0 documentation for additional details.

OAuth 2.0 Auth Code Flow Expiration

Tokens retrieved using NetSuite's OAuth 2.0 Auth Code flow expire after 7 days and cannot be refreshed. This requires users to re-authenticate every 7 days, which is not a good user experience. We recommend using the OAuth 2.0 Client Credentials flow instead.

Prerequisites

NetSuite administrator access
SuiteTalk enabled in the NetSuite account

Setup Steps

Enable SuiteTalk:
- Navigate to Setup > Company > Enable Features
- Under the Suite Cloud tab, ensure REST WEB SERVICES and OAUTH 2.0 are both checked
Create an OAuth 2.0 Application:
- Navigate to Setup > Integration > Manage Integrations > New
- Enter a name and description for the integration
- Under Token-based Authentication, un-check TOKEN-BASED AUTHENTICATION and TBA: AUTHORIZATION FLOW
- Under OAuth 2.0, ensure the following are checked:
  - AUTHORIZATION CODE GRANT
  - REST WEB SERVICES
- Under SCOPE, enable REST WEB SERVICES
- Set the REDIRECT URI to: https://oauth2.integrations.acme.com/callback
- After saving, copy the CONSUMER KEY and CONSUMER SECRET
Configure OAuth 2.0 Roles:
- Ensure that users who will authenticate via OAuth have been assigned a proper role with appropriate permissions

Configure the Connection

Enter the Consumer Key (Client ID) and Consumer Secret (Client Secret) from the NetSuite integration
Token URL: Enter the NetSuite account's token URL in the format: https://[ACCOUNT_ID].suitetalk.api.netsuite.com/services/rest/auth/oauth2/v1/token
- Replace [ACCOUNT_ID] with the NetSuite account ID (found in Setup > Company > Company Information)
- Example: https://1234567.suitetalk.api.netsuite.com/services/rest/auth/oauth2/v1/token

Verify Connection

Save the connection to authenticate with NetSuite. Users will be redirected to NetSuite to authorize access.

Token Re-authentication Required

Tokens expire after 7 days and cannot be refreshed. Users will need to re-authenticate every 7 days by opening the connection configuration and re-authorizing.

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

Input	Comments	Default
Token URL	The OAuth 2.0 Token URL for NetSuite. Replace <ACCOUNT_ID> with your NetSuite account ID, which can be found in your browser's URL bar when you log in: https://<ACCOUNT_ID>.app.netsuite.com/	https://<ACCOUNT_ID>.suitetalk.api.netsuite.com/services/rest/auth/oauth2/v1/token
Consumer Key (Client ID)	The consumer key generated when you create your OAuth 2.0 application in NetSuite. Navigate to Setup > Company > Enable Features > SuiteCloud > Manage Authentication to create an application.
Consumer Secret (Client Secret)	The consumer secret generated when you create your OAuth 2.0 application in NetSuite. Navigate to Setup > Company > Enable Features > SuiteCloud > Manage Authentication to create an application.

NetSuite OAuth Client Credentials

NetSuite OAuth 2.0 Client Credentials Connection

To connect to NetSuite using OAuth 2.0 Client Credentials, configure an OAuth 2.0 application with the Client Credentials (M2M) grant in NetSuite.

This authentication method is recommended for server-to-server integrations and provides a better user experience than the Authorization Code flow, as credentials do not expire and require no user re-authentication.

Refer to NetSuite's OAuth Client Credentials documentation for additional details.

Prerequisites

NetSuite administrator access
SuiteTalk enabled in the NetSuite account
OpenSSL installed on the local machine (for certificate generation)

Setup Steps

Enable SuiteTalk:
- Navigate to Setup > Company > Enable Features
- Under the Suite Cloud tab, ensure both REST WEB SERVICES and OAUTH 2.0 are checked
Create an OAuth 2.0 Application with JWT Option:
- Navigate to Setup > Integration > Manage Integrations > New
- Enter a name and description for the integration
- Under Token-based Authentication, un-check TOKEN-BASED AUTHENTICATION and TBA: AUTHORIZATION FLOW
- Under OAuth 2.0, ensure the following are checked:
  - REST WEB SERVICES
  - CLIENT CREDENTIALS (MACHINE TO MACHINE) GRANT
- Under SCOPE, enable REST WEB SERVICES
- After saving, copy the CONSUMER KEY. It will not be shown again in NetSuite
Generate Certificate and Private Key for JWT:

A private key and certificate are required for JWT-based authentication. Refer to the NetSuite documentation for more information on generating or importing certificates.
- On the local machine, generate a valid certificate using OpenSSL:
```
openssl req -new -x509 -newkey rsa:4096 -keyout private.pem \
  -sigopt rsa_padding_mode:pss -sha256 -sigopt rsa_pss_saltlen:64 \
  -out public.pem -nodes -days 730
```
  This command will:
  - Generate a new RSA 4096-bit key pair with PSS padding
  - Create a self-signed X.509 certificate valid for 730 days (2 years)
  - Output two files in the current directory:
    - private.pem - The private key (keep this secure)
    - public.pem - The public certificate (upload to NetSuite)
  The system will prompt to enter certificate details (country, organization, common name, etc.). Press Enter to skip these prompts, though providing values helps with tracking and identification.

Private Key Security

The private.pem file contains the private key and must be kept secure. Never commit this file to version control, share it publicly, or store it in an unsecured location. Only the application should have access to this file.

Configure OAuth 2.0 Client (M2M) in NetSuite:
- Navigate to Setup > Integration > OAUTH 2.0 CLIENT (M2M) SETUP and select Create New
- Choose the appropriate Entity and Role
- Select the Application created in step 2
- For Certificate, upload the public.pem file generated in step 3
- After saving, NetSuite will generate a Certificate ID (a unique identifier). Copy this value. It is needed to configure the connection. The Certificate ID will be a string similar to zzP3z13fkaZsCcwCbmMpd5GvvPs9DTPIquAI83MnNx4.
Assign Roles:
- Ensure that the entity used in the OAuth 2.0 Client setup has been assigned appropriate roles and permissions

Configure the Connection

When configuring the NetSuite OAuth 2.0 Client Credentials connection, enter the following values:

Certificate ID: From the OAuth 2.0 Client (M2M) setup in step 4
Private Key: The entire contents of the private.pem file from step 3. Copy the full file including the header and footer lines. Format example:
```
-----BEGIN PRIVATE KEY-----
MIIJQwIBADANBgkqhkiG9w0BAQEFAASCCS0wggkpAgEAAoICAQC...
...key content here...
-----END PRIVATE KEY-----
```
Consumer Key (Client ID): From the integration created in step 2
Token URL: The NetSuite account's token URL in the format: https://[ACCOUNT_ID].suitetalk.api.netsuite.com/services/rest/auth/oauth2/v1/token
- Replace [ACCOUNT_ID] with the NetSuite account ID (found in Setup > Company > Company Information)
- Example: https://1234567.suitetalk.api.netsuite.com/services/rest/auth/oauth2/v1/token

Input	Comments	Default
Token URL	The OAuth 2.0 Token URL for NetSuite. Replace <ACCOUNT_ID> with your NetSuite account ID, which can be found in your browser's URL bar when you log in: https://<ACCOUNT_ID>.app.netsuite.com/	https://<ACCOUNT_ID>.suitetalk.api.netsuite.com/services/rest/auth/oauth2/v1/token
Certificate ID (Key ID)	The certificate ID (key ID) from your NetSuite certificate, used for signing the JWT token. Found in Setup > Company > Company Information > Certificates.
Private Key for JWT	The private key (RSA or EC format) used for signing the JWT token. This is the private key corresponding to your NetSuite certificate. Include the full key with BEGIN/END markers.
Consumer Key (Client ID)	The consumer key generated when you create your OAuth 2.0 application in NetSuite. Navigate to Setup > Company > Enable Features > SuiteCloud > Manage Authentication to create an application.

Triggers

New and Updated Records

Retrieves existing and ongoing records for a specified NetSuite record type. Load history once, check for changes on a schedule, or both.

Input	Comments	Default
Show New Records	When true, includes new records in the results.	true
Show Updated Records	When true, includes updated records in the results.	true
Connection	The NetSuite connection to use.
Record Type	Record type to perform the action against.
Look-back Date	The date the initial sync starts from, in YYYY-MM-DD format. Cannot be a future date. Leave empty to start from the first recurrence with no backfill. When set, the initial sync seeds each record modified on or after this date once, ignoring the additional filter.
Additional Filter	Additional WHERE clause conditions to append to the polling query. Do not include 'AND' prefix - it will be added automatically. See Record Collection Filtering for query syntax.

Actions

Create Record

Create record of specified type.

Input	Comments	Default
Connection	The NetSuite connection to use.
Record Type	Record type to perform the action against.
Payload	Data payload to send in the action request. See REST API Browser for details.	`{ "entityid": "New Customer", "companyname": "My Company", "subsidiary": { "id": "1" } }`

Delete Record

Delete record of the specified type.

Input	Comments	Default
Connection	The NetSuite connection to use.
Record Type	Record type to perform the action against.
Record ID	The internal ID of the record. For external IDs, use the format 'eid:YOUR_EXTERNAL_ID'. See Getting a Record Instance for details.

Get Record

Get record of specified type.

Input	Comments	Default
Connection	The NetSuite connection to use.
Record Type	Record type to perform the action against.
Record ID	The internal ID of the record. For external IDs, use the format 'eid:YOUR_EXTERNAL_ID'. See Getting a Record Instance for details.
Expand Sub-Resources	When true, automatically expands all sublists, sublist lines, and subrecords on this record.	false
Simple Enum Format	When true, returns enumeration values in a format that only shows the internal ID value.	false
Fields to Return	Specific fields and sublists to return in the request. If unspecified, the full record is returned.

List Records

List records of specified type.

Input	Comments	Default
Connection	The NetSuite connection to use.
Record Type	Record type to perform the action against.
Query	Query string to filter records. Use operators like START_WITH, EQUAL, CONTAIN. See Record Collection Filtering for details.
Pagination	Page and page-size controls.
Limit	The maximum number of records to fetch per page. See Record Collection Filtering for details.	1000
Offset	The number of records to skip before starting to fetch results. Used for pagination.

Raw Request

Send raw HTTP request to NetSuite.

Input	Comments	Default
Connection	The NetSuite connection to use.
URL	The request path only, relative to the base URL. The base URL is supplied automatically from the connection and the selected Service Type (https://{accountId}.suitetalk.api.netsuite.com/services/rest/record/v1 or .../query/v1). For example, enter /contact to reach the contact record endpoint.
Method	The HTTP method to use.
Data	The HTTP body payload to send to the URL.
Form Data	The Form Data to be sent as a multipart form upload.
File Data	File Data to be sent as a multipart form upload.
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Header	A list of headers to send with the request.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Timeout	The maximum time that a client will await a response to its request
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false
Service Type	Selects which NetSuite REST service the request targets: the record service for CRUD operations, or the query service for SuiteQL.	record

SuiteQL Query

Execute a SuiteQL query through NetSuite's REST Web Services.

Input	Comments	Default
Connection	The NetSuite connection to use.
SuiteQL Payload	SuiteQL query string to execute. See Executing SuiteQL Queries for details.	SELECT email, COUNT(*) as count FROM transaction GROUP BY email
Pagination	Page and page-size controls.
Limit	The maximum number of records to fetch per page. See Record Collection Filtering for details.	1000
Offset	The number of records to skip before starting to fetch results. Used for pagination.

Update Record

Update record of the specified type.

Input	Comments	Default
Connection	The NetSuite connection to use.
Record Type	Record type to perform the action against.
Record ID	The internal ID of the record. For external IDs, use the format 'eid:YOUR_EXTERNAL_ID'. See Getting a Record Instance for details.
Payload	Data payload to send in the action request. See REST API Browser for details.	`{ "entityid": "New Customer", "companyname": "My Company", "subsidiary": { "id": "1" } }`
Replace	Names of sublists on this record. All specified sublists will be replaced instead of added to.
Replace Selected Fields	When true, deletes all fields, including body fields, specified in the Replace input.	false

API Documentation​

Connections​

NetSuite OAuth Auth Code​

Prerequisites​

Setup Steps​

Configure the Connection​

Verify Connection​

NetSuite OAuth Client Credentials​

Prerequisites​

Setup Steps​

Configure the Connection​

Triggers​

New and Updated Records​

Actions​

Create Record​

Delete Record​

Get Record​

List Records​

Raw Request​

SuiteQL Query​

Update Record​

API Documentation

Connections

NetSuite OAuth Auth Code

Prerequisites

Setup Steps

Configure the Connection

Verify Connection

NetSuite OAuth Client Credentials

Prerequisites

Setup Steps

Configure the Connection

Triggers

New and Updated Records

Actions

Create Record

Delete Record

Get Record

List Records

Raw Request

SuiteQL Query

Update Record