Provides integration with Acumatica ERP's OpenAPI endpoints for record, action, and file operations, with entities such as customers, inventory items, and sales orders.
0.0.0.16 - Initial release.
0.0.0.18 - Fixed error message handling.
0.0.0.24 - Split methods by operation type and improved token-authentication fallback messaging.
0.0.0.25 - Improved OAuth handling for instance-specific Acumatica URLs and normalized cached schema content from metadata queries.
0.0.0.26 - Fixed API queries for instance-specific Acumatica URLs and refreshed tokens before following authentication redirects to HTML pages.
0.0.2.1 - Updated authentication recovery and metadata normalization for Acumatica Connections and templates.
Use this Connection to store the Acumatica OpenAPI endpoint and OAuth settings used by all methods.
| Property |
Type |
Description |
Open API URL |
String |
Absolute URL to the Acumatica Swagger or OpenAPI document for the target endpoint version. |
Schema |
String |
Cached OpenAPI schema content populated by Acquire Metadata. |
Client ID |
String |
OAuth client identifier that includes the tenant name in the format client@tenant. |
Client Secret |
Masked |
OAuth client secret issued by the Acumatica Connected Application. |
Username |
String |
Username used for password-grant authentication when token refresh is unavailable or fails. |
Password |
Masked |
Password used for password-grant authentication. |
Scope |
String |
OAuth scopes requested for token operations. Defaults to api offline_access. |
Access Token |
Masked |
Current OAuth access token used for API calls. |
Refresh Token |
Masked |
Refresh token used to renew the access token. |
Token Path |
String |
Relative path to the OAuth token endpoint. Defaults to /identity/connect/token. |
Timeout (seconds) |
Integer |
Request timeout applied to API and metadata calls. |
- Publish or identify the Acumatica REST endpoint that you want to use, then copy its Swagger or OpenAPI URL. The URL typically uses the format
https://{instance}/entity/{endpoint}/{version}/swagger.json.
- Create or reuse an Acumatica Connected Application that can request the
api and offline_access scopes, then record the Client ID and Client Secret.
- Configure an API user that can access the selected endpoint. If refresh-token authentication is unavailable or fails, the Node falls back to password-grant authentication, so the
Username and Password must be valid for that user.
- Configure the Flowgear
Connection, then run Acquire Metadata to download the schema and generate operation templates.
- If the
Open API URL includes an Acumatica instance path before /entity/, Flowgear uses that same instance path when resolving API calls and the default token endpoint.
- If your Acumatica identity server uses a different token endpoint, update
Token Path.
Acquire Metadata stores normalized schema content so template generation can use the downloaded OpenAPI document consistently.
The Node exposes separate Methods for create, retrieve, update, delete, action, and file operations, so template selection stays aligned with the Acumatica endpoint you want to call.
Creates records using POST operations that are not classified as action or file operations.
| Parameter |
Type |
Description |
Connection |
Connection |
Acumatica connection profile. |
OperationId |
String |
Template-selected OpenAPI operation ID. |
Options |
Object |
Route and query parameters for the selected operation. |
Items |
Array |
Optional request body payload streamed into the operation. |
| Return |
Type |
Description |
Response |
Array |
Response items streamed as JSON objects. Primitive responses are wrapped in value. |
Retrieves records using GET operations.
| Parameter |
Type |
Description |
Connection |
Connection |
Acumatica connection profile. |
OperationId |
String |
Template-selected OpenAPI operation ID. |
Options |
Object |
Route and query parameters for the selected operation. |
| Return |
Type |
Description |
Response |
Array |
Response items streamed as JSON objects. Primitive responses are wrapped in value. |
Updates records using PUT or PATCH operations.
| Parameter |
Type |
Description |
Connection |
Connection |
Acumatica connection profile. |
OperationId |
String |
Template-selected OpenAPI operation ID. |
Options |
Object |
Route and query parameters for the selected operation. |
Items |
Array |
Optional request body payload streamed into the operation. |
| Return |
Type |
Description |
Response |
Array |
Response items streamed as JSON objects. Primitive responses are wrapped in value. |
Deletes records using DELETE operations.
| Parameter |
Type |
Description |
Connection |
Connection |
Acumatica connection profile. |
OperationId |
String |
Template-selected OpenAPI operation ID. |
Options |
Object |
Route and query parameters for the selected operation. |
| Return |
Type |
Description |
Response |
Array |
Response items streamed as JSON objects. Primitive responses are wrapped in value. |
Executes Acumatica action operations for the selected endpoint.
| Parameter |
Type |
Description |
Connection |
Connection |
Acumatica connection profile. |
OperationId |
String |
Template-selected OpenAPI operation ID. |
Options |
Object |
Route and query parameters for the selected operation. |
Items |
Array |
Optional request body payload streamed into the operation. |
| Return |
Type |
Description |
Response |
Array |
Response items streamed as JSON objects. Primitive responses are wrapped in value. |
Executes file-oriented Acumatica operations.
| Parameter |
Type |
Description |
Connection |
Connection |
Acumatica connection profile. |
OperationId |
String |
Template-selected OpenAPI operation ID. |
Options |
Object |
Route and query parameters for the selected operation. |
Items |
Array |
Optional request body payload streamed into the operation. |
| Return |
Type |
Description |
Response |
Array |
Response items streamed as JSON objects. Primitive responses are wrapped in value. |
- If refresh-token authentication fails and valid
Username and Password values are configured, the Node falls back to password-grant authentication.
- Only OpenAPI operations that define an
operationId are available in templates.
- Responses that are simple values instead of objects are wrapped in a
value property to keep downstream shapes consistent.