---
schema_version: "1"
id: 9aac1216c5bce343d75b042a3ae15c648c511abf3c18131f2a8db6450c57d955
title: NetSuite REST Connector 1.0
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/netsuite-rest-connector/latest/index.md
canonical_url: https://docs.mulesoft.com/netsuite-rest-connector/latest/
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 5f52ef79c868d5b7e07cac51ae9fa8b7897937a2538dd680c89f6370b4d93cbc
description: MuleSoft Documentation Site
release: "1.0"
latest: true
---
---
product: NetSuite REST Connector
version: 1.0
is-latest-version: true
---

# NetSuite REST Connector 1.0

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for NetSuite REST (NetSuite REST Connector) enables Mule applications to connect
to the NetSuite REST Record Web Services API and the SuiteQL query service. Use it to create, read,
update, delete, upsert, and query NetSuite records, run SuiteQL statements, submit batch and
asynchronous jobs, discover record metadata, and listen for record changes. The connector
authenticates with OAuth 2.0 client credentials using a JWT bearer assertion, so no interactive user
login is required, which makes it well suited to unattended, server-to-server integrations.

For information about compatibility and fixed issues, see the NetSuite REST Connector release notes.

## Before You Begin

To use this connector, you must be familiar with:

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements and global elements in a Mule flow

- How to create a Mule app using Anypoint Code Builder or Anypoint Studio

- NetSuite records, record types, and the NetSuite REST Record Web Services API

Before creating an app, you must have:

- Apache Maven

- Anypoint Platform

- Anypoint Code Builder or Anypoint Studio

- A NetSuite account with the SuiteTalk REST Web Services and Token-Based Authentication (OAuth 2.0)
  features enabled

- A NetSuite integration record configured for OAuth 2.0 client credentials, along with a client ID,
  a certificate registered for JWT signing (certificate ID), and the matching PEM-encoded private
  key

## Connection Types

NetSuite REST Connector supports one connection type.

- **OAuth 2.0 Client Credentials (JWT Bearer)**

  Authenticates to NetSuite by presenting a JWT bearer assertion signed with a private key that is
  registered against a certificate in NetSuite. NetSuite exchanges the assertion for a short-lived
  access token, which the connector caches and refreshes automatically. Because the flow is
  machine-to-machine, no interactive user consent is required.

## Key Features

NetSuite REST Connector simplifies NetSuite integration into Mule applications with:

- Record CRUD Operations

  Create, read, update, and delete records of any standard or custom record type. Partial updates
  use merge-patch semantics, so only the fields you send are changed.

- Upsert by External ID

  Create or update a record keyed on your own external ID to help avoid duplicate records in
  idempotent integrations.

- SuiteQL Queries

  Run SQL-like SuiteQL statements with automatic pagination to read data across records and joins.

- Batch and Asynchronous Jobs

  Submit batch create, update, upsert, delete, and read requests of up to 100 records. Batch
  operations run asynchronously and return a job ID that you poll for per-record results.

- Forms and Transforms

  Retrieve prefilled create and edit forms to preview NetSuite server-side defaulting and
  calculations, and transform one record type into another (for example, sales order to invoice)
  before you commit.

- Metadata Discovery

  Retrieve record-type metadata schemas, the record-types catalog, and field select-option values
  for validation, mapping, and documentation.

- Change-Tracking Sources

  Listen for newly created, modified, or deleted records with polling sources that maintain a
  watermark and support at-least-once delivery in a cluster.

- Governance Awareness

  Retrieve account and integration concurrency limits, and apply a configurable backoff strategy for
  HTTP 429 and 503 responses.

## Use Cases

NetSuite REST Connector supports a wide range of data integration and automation scenarios.

<table><colgroup><col> <col></colgroup><thead><tr><th>Role</th><th>Goal</th></tr></thead><tbody><tr><td><p>Integration Developer</p></td><td><p>Synchronize customers, sales orders, and invoices between NetSuite and external systems.</p></td></tr><tr><td><p>Data Engineer</p></td><td><p>Extract large datasets with SuiteQL for reporting, analytics, or a data warehouse.</p></td></tr><tr><td><p>Operations Team</p></td><td><p>Bulk-load or update records in batches while tracking per-record success and failure.</p></td></tr><tr><td><p>Finance Team</p></td><td><p>Transform sales orders into invoices and preview totals and taxes before posting.</p></td></tr></tbody></table>

## Authentication

NetSuite REST Connector supports OAuth 2.0 client credentials with a JWT bearer assertion. You
register a certificate against a NetSuite integration record and sign the JWT assertion with the
matching private key. Supported JWT signing algorithms are ES256, ES384, ES512 (recommended), PS256,
PS384, and PS512. Provide the private key through a secure property so that it is never committed in
plain text.

## Limitations

NetSuite REST Connector has these limitations:

- Batch operations (**Add List**, **Update List**, **Upsert List**, **Delete List**, and **Get
  List**) accept a maximum of 100 records per request.

- SuiteQL returns a maximum of 100,000 rows per query, which is a NetSuite hard cap.

- Upsert operations require the record type to have an external ID field.

- Get Governance Limits requires administrator-level permissions.

- The connector accesses data through the NetSuite REST Record Web Services API and SuiteQL;
  features not exposed by those services aren’t available.

## Next Step

After you complete the prerequisites, you are ready to create an app and configure the connector
using [Anypoint Studio](https://docs.mulesoft.com/netsuite-rest-connector/latest/netsuite-rest-connector-studio) or
[Anypoint Code Builder](https://docs.mulesoft.com/netsuite-rest-connector/latest/netsuite-rest-connector-config-acb).

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [NetSuite REST Connector Reference](https://docs.mulesoft.com/netsuite-rest-connector/latest/netsuite-rest-connector-reference)

- [Salesforce Help](https://help.salesforce.com)
