Version 24.2.9064

• Add the Acumatica Connector
• Authenticate to Acumatica
  • Basic
  • OAuth
  • OAuthImplicit
  • OAuthPassword
• Complete Your Connection
• More Information

You can use the Acumatica connector from the CData Sync application to capture data from Acumatica and move it to any supported destination. To do so, you need to add the connector, authenticate to the connector, and complete your connection.

Add the Acumatica Connector

To enable Sync to use data from Acumatica, you first must add the connector, as follows:

1. Open the Connections page of the Sync dashboard.

2. Click Add Connection to open the Select Connectors page.

3. Click the Sources tab and locate the Acumatica row.

4. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the Acumatica connector. For more information about installing new connectors, see Connections.

Authenticate to Acumatica

After you add the connector, you need to set the required properties.

• Connection Name - Enter a connection name of your choice.

• URL - Enter the base URL that you use to access your Acumatica account (for example, https://Domain.acumatica.com/entity/).

CData Sync supports authenticating to Acumatica in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

• Basic
• OAuth
• OAuthImplicit
• OAuthPassword

Basic

To connect with your user credentials, set the following properties:

• Auth Scheme: Select Basic.

• User - Enter the username that you use to authenticate to your Acumatica account.

• Password - Enter the password that you use to authenticate to your Acumatica account.

OAuth

To connect with OAuth custom credentials, specify the following properties:

• Auth Scheme – Select OAuth.

• OAuth Client Id - Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.

• OAuth Client Secret - Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.

OAuthImplicit

To connect via implicit OAuth flow, specify the following properties:

• Auth Scheme – Select OAuthImplicit.

• OAuth Client Id - Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.

• OAuth Client Secret - Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.

OAuthPassword

1. For the OAuthPassword scheme, specify these settings:

   • User - Enter the username that you use to authenticate to the Acumatica server.

   • Password - Enter the password that you use to authenticate to the Acumatica server.

   • OAuth Client Id - Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.

   • OAuth Client Secret - Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.

Complete Your Connection

To complete your connection:

1. Specify the following properties:

   • Schema - Select your schema and specify the appropriate settings for the schema type.

     • OData - This schema uses the Acumatica OData API and is used to query Acumatica generic inquiries. Enter the name of your company or tenant in the Company field.

     • REST (default) - This schema (the default) uses the Acumatica REST contract-based API. Specify these settings for REST:

       • Endpoint Version - Enter the version of your Web Services endpoint. The default version is 17.200.001.

       • Endpoint Name (optional) - Enter the name of your Web Services endpoint. The default name is Default.

       To locate the endpoint version and endpoint name for your Acumatica instance:

       1. Log in to Acumatica in a web browser.

       2. Select System Management > Integration > Web Service Endpoints. The Web Service Endpoints contains a list of all available endpoints.

       3. Locate your endpoint in that list and click it. Each endpoint entry contains columns for its endpoint name and version.

2. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)

3. If you authenticate with OAuth, click Connect to Acumatica to connect to your Acumatica account.

4. Click Create & Test to create your connection.

More Information

For more information about interactions between CData Sync and Acumatica, see Acumatica Connector for CData Sync.