Home Nodes Acumatica Cloud ERP

Acumatica Cloud ERP

Provides integration with Acumatica Cloud ERP via OpenAPI definitions. This module supports configuring connections and performing operations defined in the API specification.

Revision History

1.0.0.3 Initial Release

Properties

Connection

Type: Connection Input
The connection properties used to establish a connection with Acumatica Cloud ERP.

  • OpenApiUrl
    Type: String Input
    The URL to the OpenAPI document, typically in the format https://acumatica.tenant.com/tenant/(W(3))/entity/Default/23.200.001/swagger.json .

  • ClientId
    Type: String Input
    The client ID for OAuth authentication.

  • ClientSecret
    Type: Secret Input
    The client secret for OAuth authentication.

  • Username
    Type: String Input
    The username for accessing the Acumatica API.

  • Password
    Type: Secret Input
    The password for accessing the Acumatica API.

  • AccessToken
    Type: Secret Input
    The access token obtained during the authentication process.

  • RefreshToken
    Type: Secret Input
    The refresh token used to renew the access token.

  • ExcludeEmptyQueryParameters
    Type: Boolean Input
    When true, empty query parameters will not be included in the generated request URL.
    Default: true

  • AllowCustomQueryParameters
    Type: Boolean Input
    When true, allows custom query parameters to be included in the request URL.
    Default: true

  • ReturnRestFailureResponses
    Type: Boolean Input
    When true, failure response information will be returned via the Node's output properties. When false, failures generate Node errors.
    Default: true

OperationId

Type: String Input
Identifies the operation to execute, selected from the OpenAPI document.

Description

Type: String Input
Provides a description of the selected operation. Auto-generated from the OpenAPI definition.

Request

Type: Multiline Text Input
Contains the request payload in JSON format. A sample value is populated when a Node Sample is selected.

StatusCode

Type: String Output
Contains the HTTP status code returned from the server (e.g., 200 = Success).

ResponseHeaders

Type: Multiline Text Output
Contains the headers returned from the server in the response.

Response

Type: Multiline Text Output
Contains the response payload in JSON format as received from the API.

Remarks

Setting up a Connection

  1. Provide the OpenAPI document URL in the OpenApiUrl field.
  2. Fill in the required OAuth credentials (ClientId and ClientSecret) and user credentials (Username and Password).
  3. If you already have tokens, provide them in the AccessToken and RefreshToken fields.
  4. Adjust ExcludeEmptyQueryParameters and AllowCustomQueryParameters as needed.
  5. Enable ReturnRestFailureResponses if you want detailed failure responses in the output.
  6. Click Refresh Metadata to load operations defined in the OpenAPI document.
  7. Save and test the connection.

Instruction on how to create the Connected Application required to source the Client Id and Client Secret can be found here.

More information on the Resource Owner Password Credentials Flow

Using Query String Parameters

  • For operations supporting query string parameters, custom properties will be added dynamically. For example, a getCustomer operation with /customers/{customerId} will generate a customerId property.