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

# Paylocity

> How to set up the Paylocity connector, plus the actions and events that are available.

![Paylocity](https://stackone-logos.com/api/paylocity/filled/svg)

v2.1.2[See changelog](https://docs.stackone.com/connectors/paylocity/changelog.md)

[49 actions](#actions) · [5 events](#events) · 1 auth method

HRIS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/paylocity/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> The steps in this guide require Admin privileges in your Paylocity account.

Optionally, configure receiving Events for Paylocity into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/paylocity/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/paylocity/guides/link-account/oauth-2-0-client-credentials.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

CompanyLevelInformation

EmployeeDemographic

PaySetup

Scheduling

WebLinkAPI

No scopes found

49 actions

ActionDescriptionRequired scopes

List Employees`paylocity_list_employees`

Retrieve a paginated list of employees with optional demographic, position, status, and pay rate data.

`EmployeeDemographic`

Get Employee`paylocity_get_employee`

Retrieve detailed information for a single employee by their ID.

`EmployeeDemographic`

Get Employee With Benefits`paylocity_get_employee_with_benefits`

Retrieve detailed employee information including benefit setup data via WebLink v2 API.

`WebLinkAPI`

Add New Employee`paylocity_create_employee`

Create a new employee record in Paylocity with personal info, tax settings, pay rates, and more.

`WebLinkAPI`

Update Employee`paylocity_update_employee`

Update existing employee data including personal info, address, tax settings, and direct deposit.

`WebLinkAPI`

Get Company Information`paylocity_get_company_info`

Retrieve company details including name, address, EIN, and configuration settings.

`CompanyLevelInformation`

Get Custom Fields`paylocity_get_custom_fields`

Retrieve all custom field definitions for a specific category.

`WebLinkAPI`

Get All Local Taxes`paylocity_get_local_taxes`

Retrieve all local tax information for an employee.

`WebLinkAPI`

Get Local Taxes By Tax Code`paylocity_get_tax_codes`

Retrieve local tax information for an employee by specific tax code.

`WebLinkAPI`

Add Local Tax`paylocity_create_local_tax`

Add a new local tax record for an employee. Requires a valid taxCode configured in your Paylocity company setup.

`WebLinkAPI`

Add/Update Non-Primary State Tax`paylocity_upsert_non_primary_state_tax`

Add or update non-primary state tax information for an employee.

`WebLinkAPI`

Add/Update Primary State Tax`paylocity_upsert_primary_state_tax`

Add or update primary state tax information for an employee.

`WebLinkAPI`

Get Tax Codes`paylocity_get_company_tax_codes`

Retrieve a list of tax codes for a company.

`CompanyLevelInformation`

Add/Update Emergency Contacts`paylocity_upsert_emergency_contacts`

Add or update emergency contact information for an employee.

`WebLinkAPI`

Get Job Codes`paylocity_list_job_codes`

Get a list of job codes for a company.

`CompanyLevelInformation`

Get Job Code`paylocity_get_job_code`

Get a single job code by its code identifier.

`CompanyLevelInformation`

Create Job Code`paylocity_create_job_code`

Create a new job code for a company.

`CompanyLevelInformation`

Update Job Code`paylocity_update_job_code`

Update an existing job code for a company.

`CompanyLevelInformation`

Delete Job Code`paylocity_delete_job_code`

Delete a job code from a company.

`CompanyLevelInformation`

Get All Direct Deposit`paylocity_get_direct_deposit`

Retrieve main and additional direct deposit accounts for an employee.

`WebLinkAPI`

Get Pay Grades`paylocity_get_pay_grades`

Retrieve a list of pay grades configured for the company.

`CompanyLevelInformation`

Get Rate Codes`paylocity_get_rate_codes`

Retrieve a list of rate codes configured for the company.

`CompanyLevelInformation`

Get Pay Frequency Codes`paylocity_get_pay_frequency_codes`

Retrieve a list of pay frequency codes configured for the company.

`CompanyLevelInformation`

List Work Locations`paylocity_list_work_location_codes`

Get all work locations for a company

`CompanyLevelInformation`

List Deductions`paylocity_list_deductions`

Retrieve all deductions for a specific employee.

`PaySetup`

Create Deduction`paylocity_create_deduction`

Create a new deduction for an employee in Paylocity.

`PaySetup`

Update Deduction`paylocity_update_deduction`

Update an employee deduction by resourceId.

`PaySetup`

Delete Deduction`paylocity_delete_deduction`

Delete an employee deduction by code and resourceId.

`PaySetup`

List Employee Deductions By Code`paylocity_list_employee_deductions_by_code`

List employee deductions filtered by deduction code.

`PaySetup`

Get Employee Deduction By ResourceId`paylocity_get_employee_deduction_by_resourceId`

Get a specific employee deduction occurrence by deduction code and resourceId.

`PaySetup`

Get Deduction Codes`paylocity_get_deduction_codes`

Retrieve a list of deduction codes for a company.

`CompanyLevelInformation`

Get Pay Statement Details`paylocity_get_pay_details`

Retrieve employee pay statement details for a specified year.

`WebLinkAPI`

Get Pay Statement Summary`paylocity_get_pay_summary`

Retrieve employee pay statement summary for a specified year.

`WebLinkAPI`

Update Benefit Setup`paylocity_update_benefit_setup`

Add or update an employee's benefit setup in Paylocity.

`WebLinkAPI`

Get Cost Centers`paylocity_get_cost_centers`

Retrieve cost center codes and levels for a company.

`CompanyLevelInformation`

List Pay Statement Details By Year And Check Date`paylocity_list_pay_details_by_year_and_checkdate`

List employee pay statement details for a specified year and check date. checkDate must be in MM-DD-YYYY format (e.g., 0...

`WebLinkAPI`

Get Open Shifts`paylocity_get_open_shifts`

Get a list of open shifts not assigned to any employee.

`Scheduling`

Get Company Shifts`paylocity_get_company_shifts`

Get a list of all shifts for a company.

`Scheduling`

Get Employee Shifts`paylocity_get_employee_shifts`

Get shifts assigned to a specific employee.

`Scheduling`

Get Position Codes`paylocity_get_position_codes`

Get a list of position codes for a company.

`CompanyLevelInformation`

Get Workers Compensation Codes`paylocity_get_workers_compensation_codes`

Retrieve a list of workers compensation codes for a company.

`CompanyLevelInformation`

List Employee Earnings`paylocity_list_employee_earnings`

Retrieve all active earnings for a specific employee.

`PaySetup`

List Employee Earnings By Code`paylocity_list_employee_earnings_by_code`

List employee earnings filtered by earning code.

`PaySetup`

Get Employee Earning By ResourceId`paylocity_get_employee_earning_by_resourceId`

Get details for a specific earning code occurrence by resourceId.

`PaySetup`

Create Employee Earning`paylocity_create_employee_earning`

Create a new earning on an employee record.

`PaySetup`

Update Employee Earning By ResourceId`paylocity_update_employee_earning_by_resourceId`

Update details for a specific earning code occurrence by resourceId.

`PaySetup`

Delete Employee Earning By ResourceId`paylocity_delete_employee_earning_by_resourceId`

Delete a specific earning code occurrence by resourceId.

`PaySetup`

Get Earning Codes`paylocity_get_earning_codes`

Retrieve a list of earning codes for a company.

`CompanyLevelInformation`

Get Sensitive Data`paylocity_get_sensitive_data`

Get employee sensitive data information.

`WebLinkAPI`

## Events

Tags

Select all
|
Clear

Employees

Payroll

Time Off

Webhooks

No tags found

5 events

EventDescriptionTags

New Hire Webhook`paylocity_webhook_new_hire`

Emitted by Paylocity when a new employee is hired. The payload contains demographic, employment, and contact fields incl...

EmployeesWebhooks

Termination Webhook`paylocity_webhook_termination`

Emitted by Paylocity when an employee is terminated. The payload includes companyId, employeeId, employee name, cost cen...

EmployeesWebhooks

Employee Changed Webhook`paylocity_webhook_employee_changed`

Emitted by Paylocity when an employee record is updated. The payload contains only companyId and employeeId. Call the Pa...

EmployeesWebhooks

Payroll Processed Webhook`paylocity_webhook_payroll_processed`

Emitted by Paylocity when a payroll run is finalised. The payload includes companyId, processId, checkDate, runId, proce...

PayrollWebhooks

Time Off Approval Webhook`paylocity_webhook_time_off_approval`

Emitted by Paylocity when a supervisor or manager approves a time-off request. The payload includes employee identifiers...

Time OffWebhooks


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