Skip to main content

Paylocity Component

Paylocity

Paylocity provides a comprehensive product suite and delivers a unified platform for the areas of benefits, core HR, payroll, talent, and workforce management. Use the Paylocity component to connect your workforce management, payroll, and other HR tasks with a variety of applications.

Component key: paylocity

Description​

Paylocity provides a comprehensive product suite and delivers a unified platform for the areas of benefits, core HR, payroll, talent, and workforce management. Use the Paylocity component to connect your workforce management, payroll, and other HR tasks with a variety of applications.

Connections​

Paylocity OAuth 2.0​

To Set up OAuth 2.0:

  1. Must have access to the Paylocity Web Service. The Paylocity Client ID and Client Secrets are provided by submitting an Access Request form for Paylocity Web Services. To request access use the following guide.
    1. the Access Request form will also determine the external HTTPS URL for webhooks. See the Webhooks section for further details.
  2. Upon approval, your administrator will be provided with the API credentials via email by Paylocity. Input these credentials into the connection configuration of your Prismatic integration.

Pay Entry OAuth 2.0​

  1. Must have access to the Paylocity Web Service. The Paylocity Client ID and Client Secrets are provided by submitting an Access Request form for Paylocity Web Services. To request access use the following guide.
    1. the Access Request form will also determine the external HTTPS URL for webhooks. See the Webhooks section for further details.
  2. Upon approval, your administrator will be provided with the API credentials via email by Paylocity. Input these credentials into the connection configuration of your Prismatic integration.

Data Sources​

List Company Codes​

Get All Company Codes for the selected company and resource. | key: listCompanyCodes | type: picklist

Data Source Payload​

{
  "result": [
    {
      "label": "Resolvit USA - RTSS",
      "key": "01"
    }
  ]
}

Actions​

Create Employee​

New Employee API sends new employee data directly to Web Pay. | key: createEmployee

Create Pay Entry​

Create a new Pay Entry Import | key: createPayEntry

Create/Update Earning​

Create/Update Earning API sends new or updated employee earnings information directly to Web Pay. | key: createUpdateEarning

Delete Earnings by Earning Code and Start Date​

Delete Earning by Earning Code and Start Date | key: deleteEarningsByEarningCodeAndStartDate

Download Document​

Download a document by ID | key: downloadDocument

Get Company Documents​

Retrieve Company Documents by Company ID | key: getCompanyDocuments

Get Company Specific 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. | key: getCompanySpecificSchema

Get Earnings by Earning Code and Start Date​

Get Earnings returns the single earning with the provided earning code and start date for the selected employee. | key: getEarningsByEarningCodeAndStartDate

Get Employee​

Get Employee API will return employee data currently available in Web Pay. | key: getEmployee

Get Employee Documents​

Retrieve Employee Documents by Company ID | key: getEmployeeDocuments

Get New Client Secret​

Obtain new client secret for Paylocity-issued client id. | key: getNewClientSecret

Get Pay Entry​

Retrieve a Pay Entry Import | key: getPayEntry

List Company Codes​

Get All Company Codes for the selected company and resource. | key: listCompanyCodes

List Custom Fields​

Get All Custom Fields for the selected company | key: listCustomFields

List Earnings​

Get All Earnings returns all earnings for the selected employee. | key: listEarnings

List Employees​

Get All Employees API will return employee data currently available in Web Pay. | key: listEmployees

Raw Request​

Send raw HTTP request to Paylocity | key: rawRequest

Update Employee​

Update Employee API will update existing employee data in WebPay. | key: updateEmployee

Update Pay Entry​

Update an Pay Entry Import | key: updatePayEntry