V2

Acumatica

Provides integration with Acumatica ERP using the REST API to interact with entities such as customers, inventory items, and sales orders.

Revision History

1.0.0.16 - 2025/12/09 - Initial release.
1.0.0.18 - 2026/01/21 - Fixed error message handling.

Setup Notes

  1. In Acumatica, publish or locate the REST endpoint you want to use (for example, the default endpoint) and copy the Swagger/OpenAPI URL. The format is typically https://{instance}/entity/{endpoint}/{version}/swagger.json.
  2. Create or reuse a Connected Application that supports the password grant, and capture the Client ID (include the tenant suffix) and Client Secret. Ensure the app is allowed to request the api and offline_access scopes.
  3. Provide API credentials for a user permitted to call the endpoint (MFA must be disabled for password flow).
  4. In Flowgear, configure the connection with the OpenAPI URL and OAuth credentials, then click Acquire Metadata to download operations before choosing templates.
  5. If your identity server uses a non-standard token path, update Token Path accordingly; otherwise, the default /identity/connect/token is used.

Connection

Parameter Type Description
Open API URL String Absolute URL to the Acumatica Swagger/OpenAPI document for the target endpoint/version.
Schema String Cached OpenAPI schema content (populated by Acquire Metadata).
Client ID String OAuth client identifier including the tenant name (format: client@tenant).
Client Secret Masked OAuth client secret issued for the Connected Application.
Username String Acumatica user name used for password grant authentication.
Password Masked Password for the specified Acumatica user.
Scope String OAuth scopes to request; defaults to api offline_access.
Access Token Masked Current OAuth access token (managed automatically after connecting).
Refresh Token Masked OAuth refresh token (managed automatically when provided by Acumatica).
Token Path String Relative path to the token endpoint; defaults to /identity/connect/token.
Timeout (seconds) Integer Request timeout applied to API and metadata calls.

Functions

The Acumatica node exposes category-specific operations that map to Acumatica OpenAPI operation identifiers. Each operation uses templates generated from the downloaded OpenAPI schema.

Create

Parameter Type Notes
Connection Connection Connection profile containing the OpenAPI URL and OAuth credentials.
Operation ID String Operation identifier selected from the downloaded templates.
Parameters Dictionary<string, object> Route/query parameters for the chosen operation (auto populated by templates).
Body IAsyncEnumerable Optional request payload streamed into the operation.
Return Type Notes
Response IAsyncEnumerable Streamed API response. Arrays are emitted item-by-item; primitive values are wrapped in a value property.

Retrieve

Parameter Type Notes
Connection Connection Connection profile containing the OpenAPI URL and OAuth credentials.
Operation ID String Operation identifier selected from the downloaded templates.
Parameters Dictionary<string, object> Route/query parameters for the chosen operation (auto populated by templates).
Return Type Notes
Response IAsyncEnumerable Streamed API response. Arrays are emitted item-by-item; primitive values are wrapped in a value property.

Update

Parameter Type Notes
Connection Connection Connection profile containing the OpenAPI URL and OAuth credentials.
Operation ID String Operation identifier selected from the downloaded templates.
Parameters Dictionary<string, object> Route/query parameters for the chosen operation (auto populated by templates).
Body IAsyncEnumerable Optional request payload streamed into the operation.
Return Type Notes
Response IAsyncEnumerable Streamed API response. Arrays are emitted item-by-item; primitive values are wrapped in a value property.

Delete

Parameter Type Notes
Connection Connection Connection profile containing the OpenAPI URL and OAuth credentials.
Operation ID String Operation identifier selected from the downloaded templates.
Parameters Dictionary<string, object> Route/query parameters for the chosen operation (auto populated by templates).
Return Type Notes
Response IAsyncEnumerable Streamed API response. Arrays are emitted item-by-item; primitive values are wrapped in a value property.

Action

Parameter Type Notes
Connection Connection Connection profile containing the OpenAPI URL and OAuth credentials.
Operation ID String Operation identifier selected from the downloaded templates.
Parameters Dictionary<string, object> Route/query parameters for the chosen operation (auto populated by templates).
Body IAsyncEnumerable Optional request payload streamed into the operation.
Return Type Notes
Response IAsyncEnumerable Streamed API response. Arrays are emitted item-by-item; primitive values are wrapped in a value property.

File

Parameter Type Notes
Connection Connection Connection profile containing the OpenAPI URL and OAuth credentials.
Operation ID String Operation identifier selected from the downloaded templates.
Parameters Dictionary<string, object> Route/query parameters for the chosen operation (auto populated by templates).
Body IAsyncEnumerable Optional request payload streamed into the operation.
Return Type Notes
Response IAsyncEnumerable Streamed API response. Arrays are emitted item-by-item; primitive values are wrapped in a value property.

Known Issues

  • Only operations that define an operationId in the Acumatica Swagger/OpenAPI document are available in templates.
  • Responses that are simple values (not objects) are wrapped in a value property to keep downstream shapes consistent.