Skip to main content

Acumatica Installation Instructions

Step-by-step guide to connecting Acumatica to iPaaS.com, including creating OAuth or ROPC credentials, configuring the subscription settings, authorizing the access token, and verifying the installation.

This article walks you through connecting your Acumatica instance to iPaaS.com. You will create authentication credentials in Acumatica, install and configure the Acumatica subscription in iPaaS.com, authorize the connection, and verify that data can move in both directions.

The integration communicates with Acumatica over its Contract-Based REST API using OAuth 2.0, and every request also carries your Acumatica company context. Two authentication flows are supported, described below.

Before You Begin

Before installing the integration, you need to create and copy several authentication values from Acumatica. Have administrative access to your Acumatica instance available, because creating a connected application and a shared secret requires it.

You will collect the following from Acumatica during the steps below:

  • The API Url of your Acumatica instance.

  • The Client Id generated by the connected application.

  • The Client Secret (the shared secret value) created for the connected application.

  • For the password flow only, the Username and Password of the Acumatica user the integration will act as.

For background on the Acumatica side of this setup, see the Connected Applications and OAuth 2.0 topics in the Acumatica Contract-Based REST API documentation at help.acumatica.com (accessed 2026-06-26).

Choosing an Authentication Method

Two methods can be used to configure authentication between Acumatica and iPaaS.com:

  • OAuth flow (Authorization Code): The recommended and more secure method. You authorize the connection once through your browser, and iPaaS.com stores a refresh token that is used to renew access automatically.

  • ROPC flow (Resource Owner Password Credentials): This method requires saving the Acumatica Username and Password in your subscription settings, which may be visible to other users in your iPaaS.com company. Because the credentials are stored, you must update the subscription in iPaaS.com whenever the Acumatica user password changes.

The OAuth flow is recommended due to its enhanced security. The main difference between the two is the Grant Type you set in the subscription (and the matching flow type you select on the Acumatica connected application): authorization_code for OAuth, password for ROPC.

Create the Acumatica Connected Application

  1. From the Acumatica portal, search for Connected Applications and create a new application. Set the flow type to Authorization Code for the OAuth flow, or to Resource Owner Password Credentials (ROPC) if you intend to use the password flow.

    Creating a connected application in Acumatica with the Authorization Code flow type

  2. Set Mode to Sliding Expiration. Configuring the application with absolute expiration is not recommended; otherwise the application will require reconfiguration and reauthorization after it expires.

  3. On the Secrets tab, click Add Shared Secret.

  4. Copy the secret Value and keep it in a safe place. You will enter it as the Client Secret when configuring the subscription.

  5. Save the connected application record. Saving generates the Client Id. Copy and keep this value in a safe place for later use.

  6. Record the following values to use when configuring the subscription:

    • API Url: the address of your Acumatica instance.

    • Client Id: generated on the connected application after saving, shown above the application name.

    • Client Secret: the shared secret value you copied in the previous step.

Install the Integration and Configure the Subscription

  1. In iPaaS.com, go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.

    Searching the certified integration marketplace in iPaaS.com

  2. Click the Acumatica integration title.

    Selecting the Acumatica integration tile

  3. On the Subscription Detail page, click Subscribe.

  4. Enter a Name for the subscription and select a Version. The name can be any relevant, unique value within the company where the subscription is created.

    • Format: [Product Name] - [Environment/Purpose]

    • Example: Acumatica - Release

  5. Select Create Default Mappings (recommended).

    Note: If you would rather build all mappings from scratch yourself, leave this box unchecked.

  6. Configure the subscription settings. The settings below are presented as Required and Optional preset settings, followed by advanced settings. Enter the values you collected from Acumatica and the values appropriate for your iPaaS.com environment.

Required Settings

  • API Url: The address of your Acumatica instance (for example, your test or sandbox site address). This is the base address the integration uses for all requests.

  • Client Id: The Client Id copied from the Acumatica connected application.

  • Client Secret: The shared secret value copied from the Acumatica connected application.

  • Scopes: The OAuth scopes requested. For both flows, this is api offline_access.

  • Grant Type: The OAuth grant type. For the OAuth (Authorization Code) flow, this is authorization_code. For the ROPC (password) flow, this is password.

  • Version: The Acumatica endpoint version your instance supports (for example, 22.200.001). The version is unique to each Acumatica instance.

  • Time Zone Offset: Your local time zone offset. This setting ensures shipment and tracking records are retrieved based on your local business time rather than the system's UTC time, so you receive tracking updates aligned with your region's working hours.

Optional Settings

  • Username: Required only for the ROPC (password) flow. The same username used to sign in to your Acumatica instance.

  • Password: Required only for the ROPC (password) flow. The same password used to sign in to your Acumatica instance. Because this value is stored in the subscription, update it here whenever the Acumatica user password changes.

  • Redirect Url: Used during the OAuth authorization step. This value 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

  • Transaction TrackingNumber Poll Search Days: Determines how far back the integration looks for shipment and tracking data during its initial scan. If left blank, the integration defaults to 4 days. For example, a value of 100 retrieves shipment records from the last 100 days. A larger value helps avoid missing historical transactions during initial setup or after a system outage.

  • Sales Order Duplicate Checking: Set to True or False. When set to True, the integration checks for duplicate sales orders using the iPaaS.com transaction number before they are transferred into Acumatica. If left unset, no duplicate validation is performed.

Advanced Settings

These settings tune request throughput and are optional. Leave them at their defaults unless you have a specific reason to change them.

  • Concurrent Batch Executions: The maximum number of batch executions the integration processes at one time. Requests beyond the limit are queued until an active execution finishes. Subscribers should validate an appropriate value in a staging environment before relying on it in production.

Note: Your subscription view may also expose general platform throughput controls (for example, request-rate and concurrent-connection limits). Leave these at their platform defaults unless directed otherwise by iPaaS.com Support.

  1. Click Apply to save the settings.

Authorize the Connection

How you complete authorization depends on the flow you chose.

OAuth Flow

With the subscription settings saved, initiate the OAuth flow to generate an access token for communicating with Acumatica.

  1. Open the Acumatica subscription you just created.

  2. Click the Authentication icon in the toolbar. A new browser window opens, requesting permission for the application.

    The Authentication icon on the subscription toolbar

  3. Click Yes, Allow.

  4. When the confirmation page appears, click Allow, then close the page.

  5. Refresh the subscription page in iPaaS.com. If authorization succeeded, the access token values are now present.

    Access token values present on the subscription after authorization

  6. If an error occurs, verify that the settings you entered meet the requirements described above, then reauthorize.

Note: Acumatica OAuth 2.0 access tokens expire after a period of time and are removed from the subscription's stored data. The stored Refresh Token is used to regenerate the access token automatically. If the refresh token has expired, click the Authentication icon again to reauthorize.

ROPC (Password) Flow

For the password flow, no browser authorization step is required. After you save the subscription with the Username, Password, Client Id, Client Secret, Scopes, and a Grant Type of password, the integration requests an access token directly using those credentials. Transfers may then be performed without additional authorization.

Post-Installation Verification

After completing the installation, perform these checks to confirm the connection works.

Data sync test:

  1. Initiate a sample data pull (to iPaaS.com).

  2. Initiate a sample data push (from iPaaS.com).

Functionality test:

  1. Run an end-to-end business process.

  2. Validate key behavior such as field mappings, trigger subscriptions, and logging.

  3. Review the integration's activity under Dashboard / Integration Monitoring / Error Logs in iPaaS.com.

Note: A successful save of the subscription does not by itself confirm that Acumatica accepted the credentials. Confirm the connection by running the data sync test above and reviewing the results under Dashboard / Integration Monitoring / Error Logs.

Support and Troubleshooting

Click the Help button on any iPaaS.com page to contact Support or to search the documentation.

  • Documentation: Search the documentation from the search bar at the top of this article.

  • Support Portal: Click the Help and Support button at the lower-right of the window.

  • Contact Information: Contact iPaaS.com.

Related Documents

  • Acumatica Connections and Settings

  • Acumatica API Endpoints

  • Acumatica Errors

Related Articles
Did this answer your question?