n8n-nodes-acumatica
v0.2.5
Published
n8n community nodes for Acumatica ERP API
Maintainers
Readme
n8n-nodes-acumatica
This is an n8n community node package for Acumatica ERP. It lets you read and write any entity exposed by your Acumatica contract-based REST API endpoint directly from your n8n workflows.
The nodes build their interface from the endpoint's own schema, so the Resource, Operation, Action, and Fields dropdowns automatically reflect every entity and field your endpoint publishes — no per-entity configuration required.
Installation · Nodes · Operations · Credentials · Usage · Compatibility · Resources
Installation
Follow the n8n community nodes installation guide:
- In n8n, go to Settings → Community Nodes.
- Select Install.
- Enter
n8n-nodes-acumaticaand confirm.
After installation the Acumatica nodes appear in the node panel.
Nodes
The package ships three nodes. Pick the one that matches the endpoint your instance exposes (Integration → Web Service Endpoints in Acumatica):
| Node | Endpoint | Use for |
|---|---|---|
| Acumatica API - Endpoint Default 24 200 001 | Default / 24.200.001 | Acumatica 2024 R2 |
| Acumatica API - Endpoint Default 25 200 001 | Default / 25.200.001 | Acumatica 2025 R2 |
| Acumatica API - Custom Endpoint | any | A custom endpoint — you enter its Name and Version (e.g. JMS.CRM / 1.0) |
The two Default nodes carry a built-in schema (instant, works offline). The Custom Endpoint node fetches the schema live from your instance the first time you open it.
Operations
Select a Resource (the Acumatica entity, e.g. SalesOrder, StockItem, Customer), then an
Operation:
| Operation | Description | |---|---| | Get List | Retrieve many records. Toggle Return All to page through everything, or set a Limit. | | Get | Retrieve one record by its ID (GUID) or its key fields. | | Create/Update | Create a record, or update it if it already exists (PUT). Map fields with the Fields mapper. | | Delete | Delete one record by ID or key fields. | | Invoke Action | Run a workflow action (e.g. Confirm Shipment) on a record. Long-running actions are awaited automatically. | | Attach File | Upload a file from an input binary field and attach it to a record. | | Download File | Download an attached file by its ID and output it as binary. |
Filtering and field selection. Get List, Get, and Create/Update expose Query Parameters
($filter, $select, $expand, $custom) using standard Acumatica/OData syntax. Linked and
detail entities (e.g. order lines, attached files) are only returned when you name them in
$expand.
Mapping fields. Top-level fields appear as individual inputs in the Fields mapper. Nested collections (order details, addresses, etc.) are provided as JSON inputs — paste or build the array/object with an expression.
Credentials
Authentication uses OAuth 2.0 (Authorization Code).
1. Register a connected application in Acumatica — go to System → Integration → Connected Applications, add an application with the OAuth 2.0 / Authorization Code flow, add your n8n redirect URI (shown on the credential screen in n8n), and copy the generated Client ID and Client Secret.
2. Create the credential in n8n and fill in:
| Field | Value |
|---|---|
| Acumatica Instance URL | Your instance base URL, e.g. https://yourcompany.acumatica.com (include the instance path if your site runs under one, e.g. .../MyInstance). Must start with https://. |
| Client ID | The client ID including the tenant suffix, e.g. 0FC1AE...@MyTenant. |
| Client Secret | The secret generated for the application. |
The Authorization and Token URLs (/identity/connect/authorize, /identity/connect/token) and
the scope (api offline_access) are derived automatically. Save the credential, then click
Connect / Sign in to complete the OAuth flow.
Usage
Get a filtered list (all pages). Resource SalesOrder, Operation Get List, Return
All on, Query Parameters → $filter = Status eq 'Open', $select = OrderNbr,OrderTotal.
Get one record by key fields. Operation Get, Record ID or Keys = SO/000123 (the key
values in form order, separated by /). If a key value itself contains a /, use the record's
GUID instead.
Create or update. Operation Create/Update, map the fields you want to set. To get nested
lines back in the output, add $expand (e.g. $expand = Details).
Work with attachments. To list and download a record's files:
- Get the record with Query Parameters →
$expand=files. The output includes afilesarray, each entry holding anid,filename, andhref. - Download File with File ID set to one of those
ids. The file is emitted on the Binary Field (defaultdata); chain a Read/Write Files from Disk or similar node to save or forward it.
To upload, use Attach File with the target record's Record ID or Keys, a File Name, and the Binary Field containing the file.
Compatibility
- Requires n8n with community nodes enabled.
- Tested against Acumatica 2024 R2 and 2025 R2 (the two Default endpoints). Other versions and custom endpoints work through the Custom Endpoint node.
Resources
- n8n community nodes documentation
- Acumatica contract-based REST API documentation
- Repository & issues
- Changelog
Development
See DEVELOPING.md for the build, local-n8n, and live-test guide, and CLAUDE.md for architecture details.
npm install # dev tooling only; the package has no runtime dependencies
npm run build # tsc -> dist/, precompile schema caches, copy assets
npm run lint # n8n community-node verification ruleset
npm run dev # tsc --watch