# @openfn/language-erpnext

> OpenFn ERPNext adaptor

Latest version **1.1.3** (published 2026-09-03) · LGPLv3 license · 0 weekly downloads

## Install

```sh
npm install @openfn/language-erpnext
pnpm add @openfn/language-erpnext
yarn add @openfn/language-erpnext
bun add @openfn/language-erpnext
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2026-09-03 |
| First published | 2025-10-31 |
| Weekly downloads | 0 |
| License | LGPLv3 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 93.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Open Function Group |
| Maintainers | elias-ba, stuartc-openfn, taylordowns2000, mtuchi, jclark-openfn |

## Links

- npm: https://www.npmjs.com/package/@openfn/language-erpnext
- Repository: https://github.com/openfn/adaptors
- Homepage: https://github.com/openfn/adaptors#readme
- Issues: https://github.com/openfn/adaptors/issues
- npm.io page: https://npm.io/package/@openfn/language-erpnext

## Dependencies (2)

- [frappe-js-sdk](https://npm.io/package/frappe-js-sdk.md) ^1.11.0
- [@openfn/language-common](https://npm.io/package/@openfn/language-common.md) 3.3.5

## Recent versions

- 1.1.3 (latest) — 2026-09-03
- 1.1.2 — 2026-06-30
- 1.1.1 — 2026-05-27
- 1.1.0 — 2026-05-21
- 1.0.7 — 2026-05-20
- 1.0.6 — 2026-04-07
- 1.0.5 — 2026-03-30
- 1.0.4 — 2026-02-24
- 1.0.3 — 2026-01-30
- 1.0.2 — 2025-11-28
- 1.0.1 — 2025-11-12
- 1.0.0 — 2025-10-31

## README

# language-erpnext <img src='./assets/square.png' width="30" height="30"/>

An OpenFn **_adaptor_** for building integration jobs for use with the ERPNext API.

## Documentation

View the
[docs site](https://docs.openfn.org/adaptors/packages/erpnext-docs) for
full technical documentation.

### Configuration

View the
[configuration-schema](https://docs.openfn.org/adaptors/packages/erpnext-configuration-schema/)
for required and optional `configuration` properties.

#### Authentication

This adaptor uses **API Key and Secret** authentication. To generate your credentials:

1. Log in to your ERPNext instance
2. Go to your user profile (top right corner)
3. Click on "API Access"
4. Generate a new API Key/Secret pair
5. Use these credentials in your OpenFn configuration:

```json
{
  "baseUrl": "https://mycompany.erpnext.com",
  "apiKey": "your_api_key",
  "apiSecret": "your_api_secret"
}
```

### Example Usage

```js
// Create a new customer
create('Customer', {
  customer_name: 'Acme Corporation',
  customer_type: 'Company'
});
```

```js
// Get a list of sales orders
getList('Sales Order', {
  filters: { status: 'Draft' },
  fields: ['name', 'customer', 'grand_total'],
  limit: 50
});
```

```js
// Update a customer record
update('Customer', 'CUST-00001', {
  mobile_no: '+1234567890'
});
```

```js
// Read a document by ID
read('Item', 'ITEM-001', ['item_name', 'standard_rate']);
```

## Development

Clone the [adaptors monorepo](https://github.com/OpenFn/adaptors). Follow the
"Getting Started" guide inside to get set up.

Run tests using `pnpm run test` or `pnpm run test:watch`

Build the project using `pnpm build`.

To build _only_ the docs run `pnpm build docs`.

---
_Source: https://npm.io/package/@openfn/language-erpnext · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._