> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Create, read, update, and delete NetSuite records, run SuiteQL, and manage OAuth 2.0 tokens.

Use **NetSuite** through Corsair: one client, typed API calls, local DB sync.

**What you get:**

* 84 typed API operations
* 13 synced entities (`customerPayments`, `customers`, `employees`, `invoices`, `itemFulfillments`, `itemReceipts`, and 7 more) for fast `.search()` / `.list()`

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/netsuite
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/netsuite
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/netsuite
```

```bash bun theme={null}
bun add corsair @corsair-dev/netsuite
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { netsuite } from '@corsair-dev/netsuite';

export const corsair = createCorsair({
	plugins: [
		netsuite({
			accountId: 'TSTDRV123',
		}),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] OAuth 2.0 (Recommended)
>
> Open [hub.corsair.dev](https://hub.corsair.dev/dashboard), navigate to your project, and enter the **client ID** and **client secret** from your NetSuite OAuth app.
>
> NetSuite needs your account ID to build account-specific REST and OAuth URLs.
>
> ```ts theme={null}
> netsuite({
> 	accountId: 'TSTDRV123',
> })
> ```
>
> More: [OAuth 2.0](https://docs.corsair.dev/concepts/oauth)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'netsuite',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List customer records**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.netsuite.api.records.listRecords({ recordType: 'customer', limit: 10 });
```

**Create a customer**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.netsuite.api.customers.createCustomer({
	body: {
		entityId: 'ACME',
		companyName: 'Acme Inc.',
		isPerson: false,
		subsidiary: { id: '1' },
	},
});
```

See the full list on the [API](https://docs.corsair.dev/plugins/netsuite/api.md) page.

## Query synced data

Synced entities support `tenant.netsuite.db.<entity>.search()` and `.list()`: `customerPayments`, `customers`, `employees`, `invoices`, `itemFulfillments`, `itemReceipts`, `items`, `journalEntries`, `purchaseOrders`, `salesOrders`, `vendorBills`, `vendorPayments`, `vendors`.

See [Database](https://docs.corsair.dev/plugins/netsuite/database.md) for filters and operators.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/netsuite/api.md)
>
> Every `netsuite.api.*` operation with input and output types.

> [card] [Database](https://docs.corsair.dev/plugins/netsuite/database.md)
>
> Synced entities, search filters, and operators.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.