Skip to main content

Acumatica Source Connector

The Acumatica source connector in DataSync lets DataSync retrieve data from one or more Acumatica tenants and load it into your data warehouse. In Acumatica, tenants represent individual companies. You need at least one tenant configured before setting up the connection.

Before creating source connections in DataSync, make sure your Acumatica environment is correctly configured. The time zone in Acumatica must match the time zone you specify in DataSync, otherwise synchronization issues can occur. DataSync supports two authentication modes: Basic and OAuth 2.0. For OAuth 2.0, you also need to register a connected application in Acumatica to generate the credentials required for the connection. It helps to keep both Acumatica and DataSync open side by side while you work through the steps.

Creating two source connections per tenant is the recommended setup: a refresh connection that uses date tracking for incremental loads based on the LastModifiedDate field, and a no refresh connection for tables without a tracking field, typically smaller reference tables. If you are setting up Acumatica for the first time, the Acumatica installation guide walks you through creating both connections as part of the full setup.

note

You need to import and publish the Nectari customization project in Acumatica before setting up the connection.

After creating all required source connections, configure your destination connection to finalize the setup.

Step 1: Configure Acumatica​

Review tenants​

  1. Log in to Acumatica.
  2. From the main menu, select System Management. If not visible, click More Items.
  3. Under System Maintenance, select Tenants to see all tenants registered in your instance.

Confirm the time zone​

  1. Select the profile icon in the upper-right corner.
  2. Click My profile.
  3. In General Info, note the time zone.

Create the Client ID and Client Secret​

The following steps apply to OAuth 2.0 setups only. If you are using Basic authentication, skip to Step 2.

  1. In Acumatica, select Integration. If not visible, click More Items.
  2. Under Preferences, select Connected Applications.
  3. Click the + icon to add a new record.
  4. In Client Name, enter OAuth or another unique name.
  5. In Flow, select Authorization Code.
  6. Click Save. The Client ID is generated automatically.
  7. Select the Secrets tab and click Add Shared Secret.
  8. Enter a description.
  9. Copy the value in Value and store it securely.
  10. Click Ok.

Step 2: Create the source connection in DataSync​

Set up the connection​

  1. Log in to DataSync.
  2. From the welcome screen, select Connections.
  3. Next to Source Connections, click New.
  4. Select Acumatica.
  5. Enter all required connection properties.
  6. Copy the full Callback URL from the connection panel.

Add the callback URL in Acumatica​

  1. In Acumatics, select Integration. If not visible, click More Items.
  2. Under Preferences, select Connected Applications.
  3. In Client ID, Select the connected application you created.
  4. Select the Redirect URIs tab.
  5. Click the + icon to add a row.
  6. Paste the URL into the new row.
  7. Click Save.

Authenticate and authorize​

  1. Enter all required connection properties.
  2. (Optional) In the Additional Connection Properties panel, click Add property and enter any extra parameters you need.
  3. Configure the advanced settings to match your environment, including Tracking Type.
  4. Click Save.

Connection properties​

important

OAuth 2.0 is the recommended authentication mode, since Acumatica is moving away from basic authentication.

OAuth 2.0 Authentication Mode​

PropertyWhat to enter
DescriptionUnique name for the connection. Example: Acumatica OAuth Refresh.
URLAddress of your Acumatica instance, such as
http://your-server/Acumatica20XXRX/t/tenantname/api/odata/gi.
Replace your-server with the server that hosts Acumatica, Acumatica20XXRX with your instance name, and tenantname with your tenant name. Keep %20 for spaces, as shown in your browser.
Authentication ModeOAuth2.
Callback URLRedirect URL automatically generated by DataSync. Must be added to the Connected App in Acumatica.
Client IDIdentifier assigned when registering the connected application. Example: 9986313F-C5E6-161F-ED75-346CBBCB948F@Company.
Client SecretSecret assigned for the connected application. Example: ZIRz91x0ZSn_bunidUlZsB.
Authorization URLURL used to obtain the authorization code. Add identity/connect/authorize to your base Acumatica URL. Example: https://company.acumatica.com/ODataV4/identity/connect/authorize.
Access Token URLURL used to exchange the authorization code for an access token. Add identity/connect/token to your base Acumatica URL. Example: https://company.acumatica.com/ODataV4/identity/connect/token.
ScopePermissions requested from Acumatica. Default: openid, api, offline_access.
Convert all dates and times to GMTConverts all DateTime values to GMT. Recommended when your Acumatica environment runs in a different time zone and you need consistent timestamps across your data.
Use client-side pagingEnables client-side paging for large datasets. When enabled, data is retrieved in pages rather than all at once.
Page SizeMaximum number of results returned per page when client-side paging is enabled. Larger values return more rows per page but may increase timeout risk.
TimeoutTime in seconds to wait before a connection attempt or query execution times out.
Data formatFormat for retrieved data: ATOM or JSON.
VerbosityControls how much detail the connector writes to the log. Each level includes everything from the level below it, plus additional detail.

  • 1 logs queries, row counts, execution start and end times, and errors.
  • 2 adds cache queries and HTTP headers.
  • 3 adds request and response bodies.
  • 4 adds transport-level communication.
  • 5 adds all interface commands.
Acumatica OAuth authentication source connection in DataSync

Additional connection properties​

Use this panel to enter connection string properties not available in the Connection Properties panel. For sensitive values such as passwords, set the type to Encrypted. The value is hidden in the interface and stored encrypted in the back end.

PropertyWhat to enter
PropertyConnection string property that defines the action or behavior. Example: ReadOnly.
ValueValue for the property. Example: True.
TypeVisibility settings: Visible or Encrypted.

Advanced settings​

These settings control how the connector tracks data changes, handles time and regional configuration, and processes records during extraction. Configure them to match your Acumatica environment so that results stay accurate and consistent.

SettingWhat to select
Tracking TypeMethod for tracking data changes: None or Date.
RegionRegion setting for the connector, if required by your setup.
Time ZoneTime zone matching your Acumatica environment.
Time OffsetRefresh offset in seconds to compensate for timing issues in record selection. Minimum 0, maximum 3600.
Batch SizeNumber of records processed per batch during extraction. Larger batches can improve performance but use more memory. Default is 2000, maximum is 10000. Adjust based on your network speed and disk performance. The default works well in most cases.