Version 25.3.9396

• Prerequisites
• Add the Paylocity Connector
• Authenticate to Paylocity
• Complete Your Connection
• More Information

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

Prerequisites

Before you can authenticate to Paylocity using OAuth, you must first obtain API access. To request access, contact [email protected] or [email protected].

Once your request is reviewed and approved, Paylocity provides OAuth credentials and grants you access either to a Sandbox or Production account. This access is required in order to authenticate your API requests.

Paylocity issues the following OAuth credentials:

• client_id—The identifier (Id) that is assigned to your registered OAuth application in the Paylocity Developer Portal. Use this value to set the OAuth client Id.

• secret—The secret that is assigned to your registered OAuth application. Use this value to set the OAuth client secret. Paylocity requires secrets to be rotated every 365 days. You will receive reminder emails ten days and five days prior to expiration.

Add the Paylocity Connector

To enable Sync to use data from Paylocity, 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 Paylocity 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 Paylocity connector. For more information about installing new connectors, see Connections.

Authenticate to Paylocity

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

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

• 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:

   • (Optional) Company Id: Enter your company identifier.

   • (Optional) RSA Public Key: Enter the RSA key that is associated with your Paylocity account.

   • (Optional) Key: Enter the Base64-encoded AES symmetric key that is encrypted with the Paylocity public key.

   • IV: Enter the Base64-encoded AES initialization vector (IV) that is used when content is encrypted.

   • Use Sandbox: Select True if you want to use a sandbox account. The default value is False.

   • Use Pay Entry API: Select True if you want to use the Pay Entry API, which enables you to submit payroll information automatically for individual employees. If you select False (the default value), Sync uses the standard Paylocity API.

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

3. Click Create & Test to create your connection.

More Information

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