Skip to main content

Acumatica Connections and Settings

Connect Acumatica to iPaaS.com using OAuth 2.0, configure your subscription settings, and understand initialization and throttling for the Acumatica integration.

This article describes how to connect an Acumatica instance to iPaaS.com, the subscription settings the integration uses, and how authentication, initialization, and throttling behave. Subscribers or their MiSP complete these steps once per Acumatica subscription before running any data flows.

How to Connect

Prerequisites

Before setting up the Acumatica integration in iPaaS.com, make sure you have the following from your Acumatica instance:

  • API Url: the base URL of your current Acumatica instance, for example https://ipaascom.acumatica.com.

  • OAuth credentials: a Client Id and Client Secret from a Connected Application configured in Acumatica.

  • Scopes: the integration requires api offline_access.

  • Grant Type: the OAuth flow your Connected Application uses. The Authorization Code flow (authorization_code) is recommended; the Resource Owner Password Credentials (ROPC) flow (password) is supported as an alternative.

  • Username and Password (optional): used only when Grant Type is password. With the Authorization Code flow, leave them empty.

  • A dedicated Acumatica user for the integration: Acumatica limits how many API sessions can be open at once, both for each user and across the license. The integration normally uses one API session per subscription, which stays open until its access token expires (about one hour) and is reused when the token is refreshed. When people or other tools sign in through the API as the same user, they use up that user's sessions and the integration's sign-ins can be refused, so give the integration its own Acumatica user. The license-wide limit still has to cover every subscription and any other API tools. See the Acumatica Known Limitations article.

For step-by-step Acumatica setup of the Connected Application, see the Acumatica Installation Instructions article.

Configure Subscription Settings

Open the Acumatica subscription in iPaaS.com from Dashboard / Subscription / Application Marketplace / Subscription Settings and complete the fields below. The settings marked Required must be populated before authentication will succeed. Field names match the labels shown on the Subscription Settings page.

Acumatica Subscription Settings page in iPaaS.com

Field

Description

Required

Example

API Url

The base URL of your Acumatica instance.

Yes

Client Id

The Client ID generated by your Acumatica Connected Application, including its company suffix.

Yes

a1b2c3d4-5678-90ab-cdef-1234567890ab@Company

Client Secret

The shared secret value created on your Acumatica Connected Application.

Yes

sample-client-secret-value

Scopes

The OAuth scopes the integration requests.

Yes

api offline_access

Grant Type

The OAuth grant type the Connected Application uses. This value drives how the integration requests and refreshes tokens. Use the Authorization Code value for the Authorization Code flow or the password value for the ROPC flow.

Yes

authorization_code

Version

The Acumatica Contract-Based REST API version the integration targets.

Yes

22.200.001

Time Zone Offset

The time zone offset applied when the integration polls Acumatica for recently modified records.

Yes

-05:00

Username

The Acumatica instance username for API access. Required only for the ROPC (password) flow.

No

Password

The Acumatica instance password for API access. Required only for the ROPC (password) flow.

No

sample-password-value

Redirect Url

The OAuth redirect URL used by the Authorization Code flow. Required for the Authorization Code flow, and must also be added to the Connected Application's Redirect URIs. This value differs by iPaaS.com environment (see the environment-specific values below the table).

Authorization Code only

Transaction TrackingNumber Poll Search Days

The look-back window, in days, that the integration uses when polling Acumatica for shipment tracking numbers. Increase it to widen the retrieval window or leave it at the integration default.

No

7

Sales Order Duplicate Checking

When enabled, the integration checks for an existing matching sales order before creating a new one, reducing duplicate orders in Acumatica.

No

true

Concurrent Batch Executions

Controls how many records the integration processes per batch when writing or retrieving data. This is the primary throttling control (see Throttling below). Read by the integration at runtime but not declared as a standard preset, so it may not render on the Subscription Settings page in every environment.

No

5

The Redirect Url differs by iPaaS.com environment:

  • Staging: https://stagingportal.ipaas.com/customer/subscription-mgmt/subscriptions/authorization/app

  • Production: https://portal.ipaas.com/customer/subscription-mgmt/subscriptions/authorization/app

Authenticate the Subscription

The integration authenticates to Acumatica using OAuth 2.0. The grant type you select drives the flow: the Authorization Code flow opens a browser sign-in, and the ROPC (password) flow authenticates directly with a username and password. The Acumatica company the integration works in is set by the Connected Application's Client Id, which Acumatica generates in the form <GUID>@<Company>. Create the Connected Application while signed in to the Acumatica company the integration should use.

Important: Saving your settings stores the values; it does not test them against Acumatica. Each time the integration connects to Acumatica, for example at the start of a transfer, it first confirms the connection with a lightweight read. If Acumatica refuses it, the transfer fails with an error in Dashboard / Integration Monitoring / Error Logs that begins Connection validation failed and states the reason. After authenticating, run a small Manual Sync to confirm the connection works end to end.

Authorization Code flow

  1. In Acumatica, search for Connected Applications and create a new application using the Authorization Code flow type.

    Acumatica Connected Application — Authorization Code flow
    • Ensure no absolute expiration is configured for the application.

    • Add a shared secret and copy its value — this becomes your Client Secret. Acumatica displays the secret only once, when you create it.

    • On the Redirect URIs tab, add the iPaaS.com Redirect Url for your environment (listed above), exactly as shown. Acumatica compares it with the authorization request character for character, so a missing or different value makes authentication fail.

    • The Client Id is generated after you save the Connected Application.

      Acumatica Connected Application — generated Client ID and secret
  2. In the iPaaS.com Acumatica subscription, enter your API Url, Client Id, Client Secret, Scopes (api offline_access), Grant Type (authorization_code), Version, and the same environment-appropriate Redirect Url you added to the Connected Application. Leave Username and Password empty.

  3. Open the Acumatica subscription and click the Authenticate icon.

    Authenticate icon on the Acumatica subscription
    • A browser window opens. Sign in to Acumatica and click Allow.

      Acumatica OAuth consent — Allow access
    • On success, refresh the iPaaS.com subscription to load the access token.

      Subscription showing a valid access token after authentication
    • If an error appears, recheck the settings against the requirements above and re-authenticate.

      Authentication error prompting a settings recheck

Troubleshooting authentication

If the browser window shows the Acumatica message "Sorry, there was an error : unauthorized_client" instead of the sign-in page, Acumatica did not accept the Connected Application for this sign-in. In the Connected Applications form, confirm that:

  • Flow is set to Authorization Code.

  • Active is selected.

  • The Redirect URIs tab contains the iPaaS.com Redirect Url for your environment, exactly as entered in the subscription.

  • The Client Id in the subscription is this application's Client Id, including its @<Company> suffix.

Then click the Authenticate icon again.

If the subscription has already been authenticated and Acumatica is later restarted, the integration reconnects on its next transfer; you do not need to re-authenticate.

ROPC (password) flow — optional

  1. In Acumatica, search for Connected Applications and create a new application using the Resource Owner Password Credentials (ROPC) flow type.

    Acumatica Connected Application — ROPC flow
    • Ensure no absolute expiration is configured.

    • Add a shared secret and copy its value — this becomes your Client Secret.

    • The Client Id is generated after you save the record.

  2. In the iPaaS.com Acumatica subscription, enter the following:

    • API Url: your current Acumatica instance URL.

    • Username: the username for API access.

    • Password: the password for API access.

    • Client Id and Client Secret — copied from the ROPC Connected Application.

    • Scopes: api offline_access.

    • Grant Type: password. The integration signs in with Username and Password only when Grant Type is password.

    • Version: the Acumatica Contract-Based REST API version, for example 22.200.001.

Initialization Support

Initialization lets the integration pull existing records from Acumatica in bulk so they are staged in iPaaS.com without waiting for individual syncs.

  • Warehouse records support bulk initialization and can be transferred from Acumatica to iPaaS.com in bulk.

Other Acumatica data types in this integration — including Customer, Stock Item, Sales Order, Tax, and Tracking Number — do not support bulk initialization. Those records move through Manual Sync and scheduled polling (for data retrieved from Acumatica) or through Outbound Data Flow trigger subscriptions and Manual Sync (for data written to Acumatica).

Throttling

Throttling prevents the integration from overwhelming Acumatica's API with too many simultaneous calls, preserving system performance during heavy data transfers.

  • Concurrent Batch Executions controls how many records the integration processes per batch. Lowering this value reduces the load placed on your Acumatica instance per cycle; raising it increases throughput at the cost of higher concurrent demand.

  • Transaction TrackingNumber Poll Search Days bounds how far back the integration searches when retrieving recently changed tracking numbers, which limits the volume returned by each scheduled poll.

These throttling values are typically pre-populated by the integration settings. For more detail on editing subscription configuration, see Subscription Configuration – Edit.

Related Documents

Did this answer your question?