> ## 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.

# ERPNext plugin

> Open-source ERP integration for documents, DocTypes, workflows, stock, selling, buying, and accounting over the Frappe REST API.

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

Authenticate with a Frappe token pair: `Authorization: token <api_key>:<api_secret>`, created per user under Settings > My Settings > API Access. Every ERPNext deployment is its own site, so a token only works on the site that issued it. When credentials are configured explicitly, set the matching `baseUrl` beside them. When credentials come from a connected account, that account must also store its matching `base_url`; requests do not fall back to the plugin option. The site URL must be an https URL (for example `https://yourcompany.frappe.cloud`); without one, Corsair raises AuthMissingError so the account can be connected with it.

Submitting, cancelling and workflow transitions cannot be undone, and stock entries made by `erp.makeStockEntry` are submitted unless `do_not_submit` is set, so those operations are `destructive`. So is `desk.addComment`: users @mentioned in a comment get an email.

This plugin implements the requested 51 operations over the generic Frappe REST surface. Inbound webhooks are not included.

**What you get:**

* 51 typed API operations
* 1 synced entity (`documents`) for fast `.search()` / `.list()`

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/erpnext better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/erpnext better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/erpnext better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/erpnext better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

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

export const corsair = createCorsair({
	plugins: [
		erpnext(),
	],
	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] API Key (Recommended)
>
> Store the ERPNext API key before the first call: `pnpm corsair setup --plugin=erpnext --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> A connected account needs three fields: `api_key`, `api_secret` and the site's `base_url`. Store them together, for example `pnpm corsair setup --plugin=erpnext --tenant=acme api_key=<your-key> api_secret=<your-secret> base_url=https://yourcompany.frappe.cloud`, and call `erpnext()` with no options. `baseUrl` applies only to credentials passed in code, for that same site: `erpnext({ apiKey: process.env.ERPNEXT_API_KEY, apiSecret: process.env.ERPNEXT_API_SECRET, baseUrl: 'https://yourcompany.frappe.cloud' })`.
>
> ```ts theme={null}
> erpnext()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**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: 'erpnext',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**Search customers**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.erpnext.api.desk.searchGlobal({ doctype: 'Customer', txt: 'Acme', page_length: 10 });
```

**Add a customer comment**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.erpnext.api.desk.addComment({
	body: {
		reference_doctype: 'Customer',
		reference_name: 'CUST-0001',
		content: 'Follow-up scheduled for Friday.',
		comment_email: 'agent@example.com',
		comment_by: 'Corsair Agent',
	},
});
```

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

## Query synced data

Synced entities support `tenant.erpnext.db.<entity>.search()` and `.list()`: `documents`.

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

## What's next

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

> [card] [Database](https://docs.corsair.dev/plugins/erpnext/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.