Oracle Netsuite
Availability: Airbyte Cloud: ✅, Airbyte OSS: ✅
Support Level: Community
Latest Version: 0.1.3
Definition Id: 4f2f093d-ce44-4121-8118-9d13b7bfccd0
Support Level: Community
Latest Version: 0.1.3
Definition Id: 4f2f093d-ce44-4121-8118-9d13b7bfccd0
One unified business management suite, encompassing ERP/Financials, CRM and ecommerce for more than 31,000 customers.
This connector implements the SuiteTalk REST Web Services and uses REST API to fetch the customers data.
Prerequisites
- Oracle NetSuite account
- Allowed access to all Account permissions options
Airbyte OSS and Airbyte Cloud
- Realm (Account ID)
- Consumer Key
- Consumer Secret
- Token ID
- Token Secret
Setup guide
Step 1: Create NetSuite account
- Create account on Oracle NetSuite
- Confirm your Email
Step 2: Setup NetSuite account
Step 2.1: Obtain Realm info
- Login into your NetSuite account
- Go to Setup » Company » Company Information
- Copy your Account ID (Realm). It should look like 1234567 for the
Production
env. or 1234567_SB2 - for aSandbox
Step 2.2: Enable features
- Go to Setup » Company » Enable Features
- Click on SuiteCloud tab
- Scroll down to SuiteScript section
- Enable checkbox for
CLIENT SUITESCRIPT
andSERVER SUITESCRIPT
- Scroll down to Manage Authentication section
- Enable checkbox
TOKEN-BASED AUTHENTICATION
- Scroll down to SuiteTalk (Web Services)
- Enable checkbox
REST WEB SERVISES
- Save the changes
Step 2.3: Create Integration (obtain Consumer Key and Consumer Secret)
- Go to Setup » Integration » Manage Integrations » New
- Fill the Name field (we recommend to put
airbyte-rest-integration
for a name) - Make sure the State is
enabled
- Enable checkbox
Token-Based Authentication
in Authentication section - Save changes
- After that, Consumer Key and Consumer Secret will be showed once (copy them to the safe place)
Step 2.4: Setup Role
- Go to Setup » Users/Roles » Manage Roles » New
- Fill the Name field (we recommend to put
airbyte-integration-role
for a name) - Scroll down to Permissions tab
- (REQUIRED) Click on
Transactions
and manuallyadd
all the dropdown entities with eitherfull
orview
access level. - (REQUIRED) Click on
Reports
and manuallyadd
all the dropdown entities with eitherfull
orview
access level. - (REQUIRED) Click on
Lists
and manuallyadd
all the dropdown entities with eitherfull
orview
access level. - (REQUIRED) Click on
Setup
and manuallyadd
all the dropdown entities with eitherfull
orview
access level.
- Make sure you've done all
REQUIRED
steps correctly, to avoid sync issues in the future. - Please edit these params again when you
rename
orcustomise
anyObject
in Netsuite forairbyte-integration-role
to reflect such changes.
Step 2.5: Setup User
- Go to Setup » Users/Roles » Manage Users
- In column
Name
click on the user’s name you want to give access to theairbyte-integration-role
- Then click on Edit button under the user’s name
- Scroll down to Access tab at the bottom
- Select from dropdown list the
airbyte-integration-role
role which you created in step 2.4 - Save changes
Step 2.6: Create Access Token for role
- Go to Setup » Users/Roles » Access Tokens » New
- Select an Application Name
- Under User select the user you assigned the
airbyte-integration-role
in the step 2.4 - Inside Role select the one you gave to the user in the step 2.5
- Under Token Name you can give a descriptive name to the Token you are creating (we recommend to put
airbyte-rest-integration-token
for a name) - Save changes
- After that, Token ID and Token Secret will be showed once (copy them to the safe place)
Step 2.7: Summary
You have copied next parameters
- Realm (Account ID)
- Consumer Key
- Consumer Secret
- Token ID
- Token Secret Also you have properly Configured Account with Correct Permissions and Access Token for User and Role you've created early.
Step 3: Set up the source connector in Airbyte
For Airbyte Cloud:
- Log into your Airbyte Cloud account.
- In the left navigation bar, click Sources. In the top-right corner, click + new source.
- On the source setup page, select NetSuite from the Source type dropdown and enter a name for this connector.
- Add Realm
- Add Consumer Key
- Add Consumer Secret
- Add Token ID
- Add Token Secret
- Click
Set up source
.
For Airbyte OSS:
- Go to local Airbyte page.
- In the left navigation bar, click Sources. In the top-right corner, click + new source.
- On the source setup page, select NetSuite from the Source type dropdown and enter a name for this connector.
- Add Realm
- Add Consumer Key
- Add Consumer Secret
- Add Token ID
- Add Token Secret
- Click
Set up source
Supported sync modes
The NetSuite source connector supports the following sync modes:
- Full Refresh
- Incremental
Supported Streams
- Streams are generated based on
ROLE
andUSER
access to them as well asAccount
settings, make sure you're using the correct role assigned in our caseairbyte-integration-role
or any other customROLE
granted to the Access Token, having the access to the NetSuite objects for data sync, please refer to the Setup guide > Step 2.4 and Setup guide > Step 2.5
Performance considerations
The connector is restricted by Netsuite Concurrency Limit per Integration.
Changelog
Version | Date | Pull Request | Subject |
---|---|---|---|
0.1.3 | 2023-01-20 | 21645 | Minor issues fix, Setup Guide corrections for public docs |
0.1.1 | 2022-09-28 | 17304 | Migrate to per-stream state |
0.1.0 | 2022-09-15 | 16093 | Initial Alpha release |