> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sync.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Paylocity

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 [service@paylocity.com](mailto:service@paylocity.com) or [sales@paylocity.com](mailto:sales@paylocity.com).

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:

<ol>
  <li>Open the **Connections** page of the Sync dashboard.</li>
  <li>Click **Add Connection** to open the **Select Connectors** page.</li>
  <li>Click the **Sources** tab and locate
  the **Paylocity** row.</li>

  <li>
    Click the **Configure Connection** icon at the end of that row to open
    the **New Connection** page. This action opens the
    **Add Connection** dialog.

    **Note:** If the **Configure Connection** icon is not
    available, click the **Download Connector** icon to install
    the Paylocity connector.
  </li>

  <li>Enter a name for your connection in the **Add Connection** dialog.</li>
  <li>Click **Add** to open the **Settings** tab for your connector.</li>
</ol>

For more information about installing new connectors, see
[Connections](https://docs.sync.cdata.com/26.4/en/connections/connections.md).

## Authenticate to Paylocity

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

* **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 whether you want to enable the sandbox. By default, the **Enable** checkbox is not selected.
   * **Use Pay Entry API:** Select whether you want to use the Pay Entry API, which enables you to submit payroll information automatically for individual employees. By default, the **Enable** checkbox is not selected. If you do not enable this property, 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](https://cdn.cdata.com/help/KPN/synch/default.htm).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.