> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/paylocity.md).

# Paylocity

Connect to Paylocity to read and manage HR and payroll data.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Paylocity | Credentials    |

#### Paylocity

Connect to the Paylocity Web Link API to read and manage HR and payroll data.

**Set up in Paylocity**

1. Prepare the Paylocity account or service that the workflow will access. Grant access to the required resources and operations.
2. **Client ID:** The client ID Paylocity issued for your registered API application.
3. **Client Secret:** The client secret Paylocity issued for your registered API application.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Paylocity**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required                 | What to enter                                                                                                                                                   |
| ------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Client ID     | Yes                      | The client ID Paylocity issued for your registered API application. [Provider instructions](https://developer.paylocity.com/integrations/docs/getting-started). |
| Client Secret | Yes                      | The client secret Paylocity issued for your registered API application.                                                                                         |
| Company ID    | Yes                      | Your Paylocity company identifier (PCTYID) that scopes every request.                                                                                           |
| Sandbox       | Optional / as applicable | Use the Paylocity sandbox environment instead of production.                                                                                                    |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Paylocity** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### List Employees

List all employees for the connected Paylocity company.

**Inputs**

| Field       | Type    | Required | Description                                                                              |
| ----------- | ------- | -------- | ---------------------------------------------------------------------------------------- |
| Max Results | integer | No       | Maximum number of employees to return. Leave blank to return every employee. Minimum: 1. |

**Outputs**

| Field     | Type          | Description                                     |
| --------- | ------------- | ----------------------------------------------- |
| Employees | object\_array | All employee records for the connected company. |
| Count     | integer       | Number of employees returned.                   |

#### Get Employee

Fetch a single Paylocity employee by ID.

**Inputs**

| Field       | Type   | Required | Description                         |
| ----------- | ------ | -------- | ----------------------------------- |
| Employee ID | string | Yes      | The Paylocity employee ID to fetch. |

**Outputs**

| Field    | Type   | Description                                |
| -------- | ------ | ------------------------------------------ |
| Employee | object | The employee record returned by Paylocity. |

#### Get Full Employee Profile

Fetch a single employee together with their earnings, deductions, and direct deposit, merged into one profile.

**Inputs**

| Field       | Type   | Required | Description                                            |
| ----------- | ------ | -------- | ------------------------------------------------------ |
| Employee ID | string | Yes      | The Paylocity employee ID to build a full profile for. |

**Outputs**

| Field   | Type   | Description                                                                     |
| ------- | ------ | ------------------------------------------------------------------------------- |
| Profile | object | The employee record merged with their earnings, deductions, and direct deposit. |

#### Get Deductions

Fetch all deductions for a Paylocity employee by ID.

**Inputs**

| Field       | Type   | Required | Description                                          |
| ----------- | ------ | -------- | ---------------------------------------------------- |
| Employee ID | string | Yes      | The Paylocity employee ID whose deductions to fetch. |

**Outputs**

| Field      | Type          | Description                             |
| ---------- | ------------- | --------------------------------------- |
| Deductions | object\_array | All deduction records for the employee. |
| Count      | integer       | Number of deductions returned.          |

#### Get Earnings

Fetch the earnings for a Paylocity employee.

**Inputs**

| Field       | Type   | Required | Description                                        |
| ----------- | ------ | -------- | -------------------------------------------------- |
| Employee ID | string | Yes      | The Paylocity employee ID whose earnings to fetch. |

**Outputs**

| Field    | Type          | Description                         |
| -------- | ------------- | ----------------------------------- |
| Earnings | object\_array | Earning records for the employee.   |
| Count    | integer       | Number of earning records returned. |

#### Get Direct Deposit

Fetch a Paylocity employee's direct deposit accounts by employee ID.

**Inputs**

| Field       | Type   | Required | Description                                                       |
| ----------- | ------ | -------- | ----------------------------------------------------------------- |
| Employee ID | string | Yes      | The Paylocity employee ID whose direct deposit accounts to fetch. |

**Outputs**

| Field    | Type          | Description                                                   |
| -------- | ------------- | ------------------------------------------------------------- |
| Accounts | object\_array | The employee's direct deposit accounts returned by Paylocity. |
| Count    | integer       | Number of direct deposit accounts returned.                   |

#### Get Pay Statement

Fetch a Paylocity employee's pay statement summary for a year.

**Inputs**

| Field       | Type   | Required | Description                                                 |
| ----------- | ------ | -------- | ----------------------------------------------------------- |
| Employee ID | string | Yes      | The Paylocity employee ID whose pay statement to fetch.     |
| Year        | string | Yes      | The calendar year of the pay statement summary (e.g. 2024). |

**Outputs**

| Field      | Type          | Description                                              |
| ---------- | ------------- | -------------------------------------------------------- |
| Statements | object\_array | The pay statement summary records returned by Paylocity. |
| Count      | integer       | Number of pay statement records returned.                |

#### Get Company Lookups

Fetch company lookup codes (e.g. deduction codes, cost centers) from Paylocity.

**Inputs**

| Field         | Type   | Required | Description                                                           |
| ------------- | ------ | -------- | --------------------------------------------------------------------- |
| Code Resource | string | Yes      | The lookup resource to fetch, e.g. "deductioncodes" or "costcenters". |

**Outputs**

| Field | Type          | Description                                    |
| ----- | ------------- | ---------------------------------------------- |
| Codes | object\_array | The lookup code records returned by Paylocity. |
| Count | integer       | Number of lookup codes returned.               |

#### Add or Update Deduction

Add or update a deduction for a Paylocity employee.

**Inputs**

| Field          | Type   | Required | Description                                                   |
| -------------- | ------ | -------- | ------------------------------------------------------------- |
| Employee ID    | string | Yes      | The Paylocity employee ID to add or update the deduction for. |
| Deduction Code | string | Yes      | The Paylocity deduction code to apply.                        |
| Amount         | string | Yes      | The deduction amount.                                         |
| Start Date     | string | Yes      | The date the deduction starts, formatted as YYYY-MM-DD.       |

**Outputs**

| Field  | Type   | Description                                           |
| ------ | ------ | ----------------------------------------------------- |
| Result | object | The response returned by Paylocity for the deduction. |

#### Add or Update Earning

Add or update an earning for a Paylocity employee.

**Inputs**

| Field        | Type   | Required | Description                                                 |
| ------------ | ------ | -------- | ----------------------------------------------------------- |
| Employee ID  | string | Yes      | The Paylocity employee ID to add or update the earning for. |
| Earning Code | string | Yes      | The earning code to add or update.                          |
| Amount       | string | Yes      | The earning rate or amount.                                 |
| Start Date   | string | Yes      | The date the earning takes effect (YYYY-MM-DD).             |

**Outputs**

| Field  | Type   | Description                             |
| ------ | ------ | --------------------------------------- |
| Result | object | The raw response returned by Paylocity. |

#### Create Employee

Create a new employee for the connected Paylocity company.

**Inputs**

| Field           | Type   | Required | Description                                                   |
| --------------- | ------ | -------- | ------------------------------------------------------------- |
| First Name      | string | Yes      | The new employee's first name.                                |
| Last Name       | string | Yes      | The new employee's last name.                                 |
| Hire Date       | string | Yes      | The employee's hire date in YYYY-MM-DD format.                |
| Pay Type        | string | No       | The employee's pay type (e.g. Hourly or Salary). Default: .   |
| Department Code | string | No       | The department code to assign the new employee to. Default: . |

**Outputs**

| Field  | Type   | Description                                                  |
| ------ | ------ | ------------------------------------------------------------ |
| Result | object | The response returned by Paylocity for the created employee. |

#### Update Employee

Update fields on a Paylocity employee by ID.

**Inputs**

| Field           | Type   | Required | Description                                      |
| --------------- | ------ | -------- | ------------------------------------------------ |
| Employee ID     | string | Yes      | The Paylocity employee ID to update.             |
| First Name      | string | No       | New first name for the employee. Default: .      |
| Last Name       | string | No       | New last name for the employee. Default: .       |
| Department Code | string | No       | New department code for the employee. Default: . |
| Email           | string | No       | New email address for the employee. Default: .   |

**Outputs**

| Field  | Type   | Description                                        |
| ------ | ------ | -------------------------------------------------- |
| Result | object | The response returned by Paylocity for the update. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/paylocity.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
