# Paylocity integration

> Payroll and HR platform. Read and write employee records, pay setup, pay entry, time and labor, benefits, onboarding, and company reference data.

- Authentication: apiKey

## Tools (128)

- **Create Background Check Billing Codes**: Inserts the billing code and its status by companyId for a given client.
- **Create Business Units**: Inserts businessUnits and their associated status by company ID for a given client.
- **Create Company Punch Detail Export**: Start a company-wide punch detail export for a date range. First step of the three-step export.
- **Create Employee Deduction**: Create a new recurring deduction on an employee record. Garnishments cannot be created through this endpoint.
- **Create Employee Earning**: Create a new recurring earning on an employee record.
- **Create Employee Local Tax**: Sends new employee local tax information directly to Paylocity Payroll/HR solution.
- **Create Employee Onboarding Record**: Onboarding API sends employee data into Paylocity Onboarding to help ensure an easy and accurate hiring process for subsequent completion into Paylocity Payroll/HR solution.
- **Create Employee (WebLink)**: Create a new employee directly in Paylocity Payroll/HR. Honors any additional fields the company's New Hire Template requires.
- **Create Job Code**: Create a new job code in a company's Paylocity instance.
- **Create Payroll Batch**: Create a new payroll batch in the Run Payroll feature and import pay entry lines into it.
- **Create Payroll Readiness Snapshot**: Request time snapshot data for the specified employees within the given pay period date range.
- **Create Screening Order Webhook Subscription**: Register the webhook URL for subscribing to new *CandidateScreeningOrder* events. Once registered, the partner’s webhook will receive real-time notifications whenever a new candidate order is placed.
- **Create Staged New Employee**: Create New Employee in Web Link will send partially completed or potentially erroneous new hire record to Web Link, where it can be corrected and completed by company administrator or authorized Paylocity Service Bureau employee.
- **Create Training Content**: Add a single external media item to a client's LMS content library. First step of the two-step content upload.
- **Create Training Content (Batch)**: Creates a bulk upload request for multiple training content items and returns a pre-signed upload URL for a single ZIP payload.
- **Delete Assessment Callback URLs**: Delete the callback URLs set for assessment orders.
- **Delete Assessment Package**: Delete an assessment package from a company by package ID.
- **Delete Background Check Billing Code**: Delete a registered background check billing code, active or inactive, from a company.
- **Delete Business Unit**: Delete a business unit from a company by business unit ID.
- **Delete Employee Deduction**: Delete a single recurring deduction record by deduction code and resource ID.
- **Delete Employee Deduction by Start Date (WebLink)**: Delete Deduction API deletes an incorrect deduction from Paylocity Payroll/HR solution.
- **Delete Employee Earning**: Delete a single recurring earning record by earning code and resource ID.
- **Delete Employee Earning by Code and Start Date (WebLink)**: Delete a single employee earning identified by earning code and start date.
- **Delete Employee Local Tax**: Delete an employee's local tax record by tax code.
- **Delete Job Code**: Delete a single job code and its values from a company's Paylocity instance.
- **Delete Screening Order Webhook Subscription**: Delete the candidate screening order webhook subscription by callback ID.
- **Delete Screening Package**: Delete a background check screening package from a company by package ID.
- **Delete Training Content**: Deletes a media item from a client's LMS library.
- **Get Assessment Callback URLs**: Retrieve the success, error, and job-creation callback URLs configured for assessment orders.
- **Get Business Unit**: Returns a specific businessUnit for the companyId and businessUnitId.
- **Get Company Information**: Retrieve company details including name, address, industry, and Employer Identification Number.
- **Get Company-Specific OpenAPI Schema**: The company-specific Open API endpoint allows the client to GET an Open API document for the Paylocity API that is customized with company-specific resource schemas.
- **Get Employee**: Retrieve a single employee's demographic record, with optional position, status, and pay rate data.
- **Get Employee Bank Account**: Retrieves a single employee's direct deposit banking information.
- **Get Employee (Core HR v2 Early Adoption)**: Retrieve a single employee's demographic record. Early Adoption release of the Core HR employee endpoint.
- **Get Employee Deduction**: Retrieve a single recurring deduction record by deduction code and resource ID, including past and future-dated records.
- **Get Employee Deductions by Code**: Retrieve all recurring deduction records matching a specific deduction code on an employee.
- **Get Employee Deductions by Code (WebLink)**: Get Deduction for Deduction Code returns records for a specific deduction for the selected employee.
- **Get Employee Earning**: Retrieve a single recurring earning record by earning code and resource ID, including past and future-dated records.
- **Get Employee Earning by Code and Start Date (WebLink)**: Get Earnings returns the single earning with the provided earning code and start date for the selected employee.
- **Get Employee Earnings by Code**: Retrieve all recurring earning records matching a specific earning code on an employee.
- **Get Employee Earnings by Code (WebLink)**: Get Earnings returns all earnings with the provided earning code for the selected employee.
- **Get Employee Local Taxes by Code**: Returns all local taxes with the provided tax code for the selected employee.
- **Get Employee Pay Statement**: Retrieves the details of a single pay statement by its ID.
- **Get Employee Pay Statement Details by Year**: Get pay statement details API will return employee pay statement details data currently available in Paylocity Payroll/HR solution for the specified year.
- **Get Employee Pay Statement Details by Year and Check Date**: Get pay statement details API will return employee pay statement detail data currently available in Paylocity Payroll/HR solution for the specified year and check date.
- **Get Employee Pay Statement Summary by Year**: Get pay statement summary API will return employee pay statement summary data currently available in Paylocity Payroll/HR solution for the specified year.
- **Get Employee Pay Statement Summary by Year and Check Date**: Get pay statement summary API will return employee pay statement summary data currently available in Paylocity Payroll/HR solution for the specified year and check date.
- **Get Employee Sensitive Data**: Gets employee sensitive data information directly from Paylocity Payroll/HR solution.
- **Get Employee (WebLink)**: Get Employee API will return employee data currently available in Paylocity Payroll/HR solution.
- **Get Job Code**: Retrieve the details of a single job code by company ID and job code.
- **Get Payroll Batch Status**: Retrieve the current status and details of a previously submitted payroll batch import.
- **Get Payroll Readiness Snapshot Detail**: Retrieve the full per-employee detail rows for a payroll readiness time snapshot.
- **Get Payroll Readiness Snapshot Summary**: Retrieve time snapshot summary data for the specified id.
- **Get Punch Detail Export Data**: Retrieve the punch detail rows produced by a completed company punch detail operation. Final step of the three-step export.
- **Get Punch Detail Export Status**: Check whether a company punch detail operation is in progress, completed, or failed. Second step of the three-step export.
- **Get Screening Order Webhook Subscription**: Returns the webhook for the subscription of a new candidate screening order.
- **Get Training Content**: Retrieve details about a single item in a client's LMS content library by content ID.
- **Get Training Content Batch Upload Status**: Returns the status of a bulk upload operation, including overall progress, success/failure counts, and detailed status for each content item.
- **Import Employee Punches**: Import time punches from an external time system into Paylocity Time and Labor. Maximum 500 punch objects per request.
- **List Assessment Packages**: Retrieve assessment packages configured within Paylocity's platform for a specific companyId.
- **List Background Check Billing Codes**: Returns billing codes for the companyId querying.
- **List Background Check Client Onboardings**: List the companies onboarded to the calling partner, optionally filtered by company ID and status.
- **List Business Units**: Returns all businessUnits for the companyId querying.
- **List Company Codes by Resource**: Get All Company Codes for the selected company and resource.
- **List Company Custom Fields**: Get All Custom Fields for the selected company.
- **List Company Deduction Codes**: Retrieve the full list of deduction codes configured for a company.
- **List Company Earning Codes**: Retrieve the full list of earning codes configured for a company.
- **List Company Pay Frequencies**: Retrieve the pay frequency codes configured for a company.
- **List Company Pay Grades**: Retrieve the full list of pay grades configured for a company.
- **List Company Position Codes**: Retrieve the full list of position codes configured for a company.
- **List Company Rate Codes**: Retrieve the rate codes configured in a company's Paylocity instance.
- **List Company Shifts**: Returns information about the shifts at a company level. The response includes data such as start and end times, tasks associated with the shift, and any recorded overtime.
- **List Company Tax Codes**: Retrieve the full list of tax codes configured for a company.
- **List Company Work Locations**: Retrieve the work locations configured in a company's Paylocity instance.
- **List Cost Centers and Levels**: Retrieve the full list of cost centers and their labor levels for a company.
- **List Employee Bank Accounts**: Retrieves all of the specified employee's direct deposit banking information.
- **List Employee Deductions**: Retrieve all active recurring deductions on an employee record.
- **List Employee Deductions (WebLink)**: Get All Deductions returns all deductions for the selected employee.
- **List Employee Direct Deposits**: Get All Direct Deposit returns main direct deposit and all additional direct deposits for the selected employee.
- **List Employee Earnings**: Retrieve all active recurring earnings on an employee record.
- **List Employee Earnings (WebLink)**: Get All Earnings returns all earnings for the selected employee.
- **List Employee Local Taxes**: Returns all local taxes for the selected employee.
- **List Employee Pay Statements**: Retrieves all pay statements for the specified employee within the given date range.
- **List Employee Punch Details**: Retrieve all punch data for a single employee over a date range.
- **List Employees**: Retrieve employee demographic records in batches of up to 20 per call, with optional position, status, and pay rate data.
- **List Employees (Core HR v2 Early Adoption)**: Retrieve batches of employee demographic records for a company. Early Adoption release of the Core HR employee endpoint.
- **List Employee Shifts**: Returns information about the shifts assigned to a specific employee. The response includes structured data such as shift start and end times, roles, required skills, and location details.
- **List Employees in Pay Period**: Retrieves all employee Ids associated with a specific Pay period.
- **List Employees (WebLink)**: Get All Employees API will return employee data currently available in Paylocity Payroll/HR solution.
- **List Job Codes**: Retrieve the full list of job codes configured for a company.
- **List Open Shifts**: Returns all shifts that are not currently assigned to an employee.
- **List Partner Assessment Orders**: Partners retrieve assessment orders for companies actively onboarded to their API client ID.
- **List Partner Background Check Orders**: Retrieve background check orders across the partner's onboarded companies using flexible filters.
- **List Partner Client Onboardings**: List the companies that have been onboarded to the calling partner through the Paylocity Marketplace workflow.
- **List Pay Schedules**: Retrieves pay schedules for the specified company.
- **List Screening Packages**: Returns the screening packages for the companyId.
- **List Time and Labor Cost Centers**: Retrieve the cost centers and labor levels defined in the Time and Labor module.
- **List Training Content**: Retrieve the items in a client's LMS content library for a company.
- **List Workers Compensation Codes**: Retrieve the full list of workers compensation codes configured for a company.
- **Search Employee Pay Rates**: Performs a pay rates search for the specified company according to the search parameters passed in the request body.
- **Search Employee Statuses**: Search employee statuses for a company using filters passed in the request body.
- **Update Assessment Order**: Updates the Assessment Order status for the given companyId and OrderId.
- **Update Background Check Billing Code Status**: Update the status of an already registered background check billing code for a company.
- **Update Business Unit**: Update the details of an already registered business unit for a company.
- **Update Candidate Screening Order Status**: Updates the Screening Order status for the given companyId and candidateScreeningOrderId.
- **Update Employee Deduction**: Update a single recurring deduction record by resource ID. Garnishments cannot be updated through this endpoint.
- **Update Employee Earning**: Update a single recurring earning record by resource ID.
- **Update Employee Local Tax**: Update Local Tax sends updated local tax code information for the selected employee.
- **Update Employee (WebLink)**: Update Employee API will update existing employee data in WebPay.
- **Update Job Code**: Fully replace an existing job code's configuration. Omitted fields are reset to null or their default.
- **Upsert Assessment Callback URLs**: Configure callback URLs for assessment order notifications for the Partner.
- **Upsert Assessment Order Webhook Subscription**: Create or update the single assessment-order webhook subscription for a company. Orders cannot be submitted without a subscription.
- **Upsert Assessment Package**: Create or replace an assessment package (a named collection of related tests) for a company.
- **Upsert Assessment Packages (Batch)**: Create or replace multiple assessment packages for a company in a single request.
- **Upsert Background Check Onboarding Status**: Upserts the status of the integration with companyId specified in the body.
- **Upsert Cost Center Code**: Create a new cost center or fully replace an existing one at a given cost center level.
- **Upsert Employee Additional Rates**: Sends new or updated employee additional rates information directly to Paylocity Payroll/HR solution.
- **Upsert Employee Benefit Setup**: Sends new or updated employee benefit setup information directly to Paylocity Payroll/HR solution.
- **Upsert Employee Deduction (WebLink)**: Upsert Deduction API sends new or updated employee deduction information directly to Paylocity Payroll/HR solution.
- **Upsert Employee Earning (WebLink)**: Upsert Earning API sends new or updated employee earnings information directly to Paylocity Payroll/HR solution.
- **Upsert Employee Emergency Contacts**: Sends new or updated employee emergency contacts directly to Paylocity Payroll/HR solution.
- **Upsert Employee Non-Primary State Tax**: Sends new or updated employee non-primary state tax information directly to Paylocity Payroll/HR solution.
- **Upsert Employee Primary State Tax**: Sends new or updated employee primary state tax information directly to Paylocity Payroll/HR solution.
- **Upsert Employee Sensitive Data**: Sends new or updated employee sensitive data information directly to Paylocity Payroll/HR solution.
- **Upsert Partner Company Onboarding Status**: Create or update the onboarding status of a company in the partner's Marketplace-initiated onboarding workflow.
- **Upsert Screening Package**: Upserts information about screening packages for the companyId.
- **Upsert Screening Packages (Batch)**: Create or replace multiple background check screening packages for a company in a single request.

## Triggers (2)

- **New Employee in Paylocity**: Triggers when a new employee record appears in the Paylocity company roster. Optionally filter by cost center or job title.
- **Employee Terminated in Paylocity**: Triggers when an employee status type changes to Terminated in Paylocity. Optionally filter by cost center or job title.

Connect Paylocity in General Input: https://www.generalinput.com/apps/paylocity