Skip to main content

Acumatica Source Connector

The Acumatica source connector in DataSync lets you retrieve data from one or more Acumatica tenants (companies) for synchronization or consolidation into your destination. In Acumatica, tenants represent individual companies, and you must have at least one tenant to proceed.

For optimal results, it's recommended to create two source connections per tenant: a refresh connection, which uses date tracking for incremental loads based on the LastModifiedDate field, and a no refresh connection, used for tables without a tracking field, typically smaller reference tables. Prebuilt Acumatica Source Connections Template is available for quick configuration of required connections.

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

Verify details in Acumatica

Before creating source connections in DataSync, ensure your Acumatica environment is correctly configured. This includes verifying the tenants registered in your instance and confirming the time zone, which must match the time zone specified in DataSync to avoid synchronization issues.

Review tenants

  1. Log in to Acumatica.
  2. From the main menu, select System Management. If not visible, click More Items to show additional options.
  3. Under System Maintenance, select Tenants.
    The list of tenants appears, allowing you to confirm how many are currently registered in your Acumatica instance.

Confirm time zone

  1. From the main menu, click the profile icon on the upper-right corner.
  2. Click My profile from the dropdown list.
  3. In General Info, note the time zone. This must match the time zone in DataSync.

Create the Client ID and Client Secret (OAuth)

  1. In Acumatica, select Integration. If not visible, click More Items to show additional options.
  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 from the dropdown list.
  6. Click Save. The Client ID is generated automatically.
  7. Select the Secrets tab and click Add Shared Secret.
  8. Enter a description.
  9. In Value, make sure to copy the secret and store it securely. You will not be able to view it again after saving.
  10. Click Ok when done.

Add the Callback URL in Acumatica (OAuth)

  1. In Acumatics, select Integration. If not visible, click More Items to show additional options.
  2. Under Preferences, select Connected Applications.
  3. In Client ID, Select the connected application you created earlier.
  4. Select the Redirect URIs tab.
  5. Click the + icon to add a row.
  6. In DataSync, copy the full Callback URL from the connection panel.
  7. Paste the URL into the new row in Acumatica.
  8. Click Save.

Create a source connection in DataSync

  1. Log in to DataSync.
  2. From the welcome screen, select Connections.
  3. Next to Source Connections, click New.
  4. Select Acumatica.
  5. In the Connection Properties panel, select an authentication mode: Basic or OAuth2.
  6. Enter the required connection properties.
  7. (Optional) In the Additional Connection Properties panel, select Add property and enter the parameters for each property.
  8. In the Advanced Settings panel, configure the settings, including the Tracking Type and other values according to your requirements.
  9. Click Save.

Connection properties

ParameterDescription
DescriptionUnique name for the connection.
Example: Acumatica Refresh
URLAcumatica instance URL. Keep %20 for spaces as shown in your browser.
Example: https://company.acumatica.com/ODataV4/InstanceName
Authentication ModeAuthentication method used by the connector: Basic or OAuth2.
UsernameAcumatica username with required API permissions (Basic authentication only).
PasswordPassword for the specified username (Basic authentication only).
Callback URLRedirect URL automatically generated by DataSync. Must be added to the Connected App in Acumatica (OAuth2 only).
Client IDIdentifier assigned when registering the connected application (OAuth2 only). Example: 9986313F-C5E6-161F-ED75-346CBBCB948F@Company
Client SecretSecret assigned for the connected application (OAuth2 only). Example: ZIRz91x0ZSn_bunidUlZsB
Authorization URLURL used to obtain the authorization code. Add identity/connect/authorize to your base Acumatica URL (OAuth2 only). 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 (OAuth2 only). Example: https://company.acumatica.com/ODataV4/identity/connect/token
ScopePermissions requested from Acumatica (OAuth2 only). Default: openid, api, offline_access.
Convert all dates and times to GMTConversion of OData DateTime values to GMT.
Use client-side pagingPaging capability for large datasets.
Page SizeMaximum results to return per page when client-side paging is enabled. Larger values return more rows per page but may cause timeouts.
TimeoutTime in seconds to wait for connection opening and query execution before timeout.
Data formatFormat for retrieved data: ATOM or JSON.
Verbosity
  • 1 – Log queries, row counts, execution start/end, errors.
  • 2 – Includes level 1 plus cache queries, HTTP headers.
  • 3 – Includes level 2 plus request/response bodies.
  • 4 – Includes level 3 plus transport-level communication.
  • 5 – Includes level 4 plus all interface commands.
Enable PoolingConnection pooling option for performance.
Pool idle timeoutMaximum idle time for connections before returning them to the pool, in seconds.
Max Pool SizeMaximum number of connections allowed in the pool.
Pool wait timeMaximum wait time for connection allocation before error is thrown, in seconds.

Additional connection properties

Additional connection string properties not specified in the Connection Properties panel. For each property added, you can choose Visible or Encrypted. Selecting Encrypted hides the value from the interface and stores it encrypted in the back end, such as when defining passwords.

ParameterDescription
PropertyConnection string property that defines the action or behavior. Example: ReadOnly
ValueValue for the property. Example: True
TypeVisibility of the property: Visible or Encrypted.

Advanced settings

Advanced settings control how the Acumatica connector tracks changes, handles regional and time configuration, and processes data batches during extraction. These options allow fine‑tuning for performance and accuracy, and should be configured according to your system environment and operational requirements.

SettingDescription
Tracking TypeMethod for tracking changes: None or Date.
RegionRegion setting for the connector, if required by your setup.
Time ZoneTime zone matching the Acumatica application server. This must be identical to the profile time zone in Acumatica to avoid data mismatches.
Time OffsetRefresh offset in seconds to compensate for timing issues in record selection. Minimum value is 0; maximum is 3600 seconds.
Batch SizeQuantity of records processed in each batch during extraction. Larger batch sizes increase memory usage but can improve performance up to a point. The default value is 2000 and the maximum should not exceed 10000 records. Adjust according to your network speed and disk performance; in most cases the default (2000) works best.

Example

Acumatica Source Connection
note

For Acumatica, you must import and publish the SEI customization project in Acumatica. See Upload Project into Acumatica for more details.