NetSuite API Integration Profile

Configuration

Create OAuth 2.0 Client App in NetSuite

To be able to use REST web services with OAuth 2.0, the Netsuite user must create an application using an integration record. This guide covers steps a user should take to get their Netsuite credentials to be able to use them in the integration.app console.

1. Log in to your NetSuite account using the credentials that have access to Administrator role.
2. Change your role to Administrator.
3. Navigate to Setup > Integration > Manage Integrations > New.
4. Fill in the requried details:
   • Name: Name of the OAuth 2.0 Client
   • State: Enabled
   • OAuth 2.0:
     • Authorization Code Grant: set to true
     • Rest Web Services: Enable this scope by setting its value to true
     • Redirect URI: https://api.integration.app/oauth-callback
5. After entering the details, click Save.
6. Copy the Consumer Key (Client ID) with the Consumer Secret (Client Secret) and save them somewhere safe.

Enable Features and Permissions

The following features and permissions must be enabled in NetSuite account for the OAuth process to work successfully.

SuiteCloud tab:

• Navigate to Setup > Company > Enable features > SuiteCloud tab
• Enable the following features:
  a. Select SuiteScript > Client SuiteScript & Server SuiteScript b. Select SuiteTalk > Rest Web Services c. Select Manage Authentication > OAuth 2.0

Analytics tab:

• Navigate to Setup > Company > Enable features > Analytics tab
• Select SuiteAnalytics Workbook > SuiteAnalytics Workbook

Permissions

Enable permissions for your role:

• Setup > Users/Roles > Manage roles > <Name of your role> > Edit
• Enable the following permissions:
  • Select Permissions > Reports >Add SuiteAnalytics Workbook (Edit)
  • Select Permissions > Setup > Add Custom Fields(View), Custom Record Types(View), Log in using OAuth 2.0 Access Tokens(Full), OAuth 2.0 Authorize Applications Management(Full) and REST Web Services(Full)
  • Verify that your role which has all of the above permissions enabled is set as the default role.

Limitations of NetSuite API

This connector uses Rest Web Services NetSuite API.

Field schemas

• readOnly property: some fields are in fact read-only, but are not marked as such in field schemas provided by NetSuite , for example entityId of various entities. There is no way we know of to get comprehensive information about which fields are in fact read-only without trying to write each field for each collection.
• required fields: NetSuite leaves it up to admin to set up required fields on each object, and it doesn’t expose this information via API, so there is unfortunately no way to programmatically know which fields are required.
• Field types: connector returns the same field types as Netsuite API returns in their JSONSchema for a given object. They may or may not match the real data.
• referenceCollection: there is no programmatic way to get referenceCollection for all the fields that are references (Netsuite doesn’t return this information via API).

Methods

• list operation in NetSuite data collections returns only ids of objects, but not their fields. To get fields, you need to either use findById individually for each record or use a separate operation to get fields of a batch of objects. These fields don’t match the collection schemas, unfortunately.