Before Your Begin
Before installing the integration, you need to create and copy some authentication values from Acumatica.
Acumatica Authentication Guide
Two methods can be used to configure your authentication:
OAuth Flow: This is the recommended and more secure method.
ROPC Flow (Resource Owner Password Credentials Flow): This method requires saving the username and password in your settings, which may be visible to other users in your company.
The OAuth flow is recommended due to its enhanced security. To use it, search for Connected Applications in the portal and create a new application using the Authorization Code flow type.
OAuth Flow
Search for Connected Applications from the Acumatica portal and create a new Application using the Authorization Code flow type.
Set Mode to Sliding Expiration. It is not recommended to configure the application with absolute expiration; otherwise, reconfiguration and reauthorization will be required after expiration.
To use Password Flow authentication, select the Resource Owner Password Credentials (ROPC) from the Flow drop-down.
This method will require iPaaS to have the subscription updated whenever the Acumatica user password is changed.In the Secrets tab, click Add Shared Secret.
Copy the Value and keep it in a safe place. You will use it when configuring the integration.
When you save the Connected Application Record, the Client ID is generated. Copy and keep this in a safe place for later use.
Record the following settings to use in configuring the subscription:
API URL: The current Acumatica instance
Client Id copied from the Connected Applications screen, above the Client Name.
Client Secret copied from Shared Secret created in Step 3.
After saving the Acumatica subscription, transfers may now be performed without additional authentication.
Installation Instructions for Integration Setup
Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the Acumatica Integration title.
On the Subscription Detail page, click the Subscribe button.
Enter the Name of the subscription and select a version from the Versions drop-down. It can be set to any relevant and unique subscription name within the company where this subscription is created. The version is unique to each Acumatica instance.
Format: [Product Name] - [Environment/Purpose]
Example: Acumatica – Release
Select Create Default Mappings (recommended).
NOTE: If you don’t want to create default mappings and want to create all mappings from scratch by yourself, then uncheck this box.Provide the API URL endpoint for your Acumatica instance.
Environment URLs
Test/Sandbox: https://[test-site].acumatica.com/
Production: N/A
Enter the Username and Password. These are the same username and password as used by your Acumatica instance.
Enter the Client ID, copied from the Acumatica Connected Application with Flow of Resource Owner Password Credential.
Enter the Client Secret, copied from new Secret Key added to Acumatica Connected Application with Flow of Authorization Code
Enter the Scope, for OAuth Flow, this is
api offline_access.Enter the Grant Type, for OAuth Flow, this is
api offline_access.Enter the Acumatica Version. use 22.200.001.
Enter the Redirect URL, which is different depending on the iPaaS environment.
For the staging environment, enter:
https://stagingportal.ipaas.com/customer/subscription-mgmt/subscriptions/authorization/appFor the production environment, enter:
https://portal.ipaas.com/customer/subscription-mgmt/subscriptions/authorization/app
Set the Transaction Tracking Number Poll Search Days. This setting determines how far back the system looks for shipment data during its initial scan. If you don't provide a number, the system will default to 4 days. For example, if you set the value to 100, the system will retrieve shipment records from the last 100 days. This feature helps ensure you don't miss any historical transactions, which is helpful during the initial setup or after a system outage.
Enter the Time Zone Offset. This is a required setting for a subscription preset because it ensures shipment records are retrieved based on your local business time, not the system's UTC time. This ensures you receive tracking updates aligned with your region's working hours.
Set Sales Order Duplicate Checking to True or False. Setting this preset to True in your subscription settings enables the system to check for duplicate sales orders using the iPaaS transaction number before they are transferred. If you don't set this value, no duplicate validation will be performed. This gives you the flexibility to turn this feature on or off based on your specific business needs.
Enter the API Throttle Limit. This setting prevents any single integration or user from overwhelming the system with too many requests. It protects system performance by controlling the number of API requests that can run simultaneously, ensuring fair usage.
Recommended Values
Initial Setup: 5
Ongoing Operations: 500
High Volume: 500
Enter the API Throttle Seconds. This defines the time window during which the API Throttle Limit is measured. If an integration makes too many requests within this time window, additional requests are rejected until the window resets.
Default Value: 60 seconds
Range: 60 seconds
Enter the number of Concurrent Connections. This specifies the maximum number of simultaneous API connections that (Undefined variable: Integrations.placeholder) can process for a user or integration. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Enter the number of Concurrent Batch Executions. This specifies the maximum number of simultaneous batch executions that can be processed by an integration at any given time. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Click Apply to save the settings.
OAuth Flow Initialization
With the Subscription Settings saved, you must initiate the OAuth Flow and generate an access token for communicating with the Acumatica API.
Go to the Acumatica Subscription that was created
Click the Authentication icon found in the toolbar
A new browser window will open, requesting permission for the application.
Click Yes, Allow.
After the confirmation page appears, click Allow, then close the page.
Refresh the subscription page in (Undefined variable: General.CompanyName).
The access token values should now be present if successful:If an error occurs, verify that the provided settings meet the requirements described above.
NOTE: Acumatica OAuth 2.0 access token expired after some time and are deleted from subscription persistent data. The Refresh Token is supposed to regenerate the access token. |
Post-Installation Verification
After completing the installation, perform these tests to verify the installation:
Data Sync Test:
Initiate a sample data pull. (To iPaaS.com)
Initiate a sample data push. (From iPaaS.com)
Functionality Test:
Run an end-to-end business process.
Validate key features like field mappings, workflow triggers, and logging.
Review integration logs in iPaaS.com.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or to search our documentation.
Documentation: Search our documentation at the top of this article
Support Portal: Click the Help and Support button at the lower-right of this window.
Contact Information: Contact iPaaS.com





