ERPNext plugin

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

Install

npm install corsair @corsair-dev/erpnext better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/erpnext better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/erpnext better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/erpnext better-sqlite3
bun add --dev @types/better-sqlite3

Add the plugin

corsair.ts

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 for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

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.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' })

erpnext()

More: API Key

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.

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

Example API calls

Search customers

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

Add a customer comment

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

Query synced data

Synced entities support tenant.erpnext.db.<entity>.search() and .list(): documents. See Database for filters and operators.

What’s next

API reference

Every erpnext.api.* operation with input and output types.

Database

Synced entities, search filters, and operators.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

Overview

Plugins