Paylocity Component

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:

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.
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.

Input	Default	Notes
Client ID string / Required clientId		Provide the Client Id you received from the Paylocity Developer Console.
Client Secret password / Required clientSecret		Provide the Client Secret you received from the Paylocity Developer Console.
Environment string / Required environment		The environment to use for the Paylocity apis
Scopes string / Required Hidden Field scopes	WebLinkAPI
Token URL string / Required tokenUrl		Select the environment to fetch the token from.

Pay Entry OAuth 2.0

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.
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.

Input	Default	Notes
Client ID string / Required clientId		Provide the Client Id you received from the Paylocity Developer Console.
Client Secret password / Required clientSecret		Provide the Client Secret you received from the Paylocity Developer Console.
Environment string / Required environment		The environment to use for the Paylocity apis
Scopes string / Required Hidden Field scopes	all
Token URL string / Required tokenUrl		Select the environment to fetch the token from.

Data Sources

List Company Codes

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

Input	Notes	Example
Code Resource string / Required codeResource	Type of Company Code.	costcenter1
Company ID string / Required companyId	The id of the company to retrieve.	kjU72LCJexvrqL7G4TMHHN
Connection connection / Required connectionInput

Example Payload for List Company Codes

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

Actions

Create Employee

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

Input	Notes	Example
Company ID string / Required companyId	The id of the company to retrieve.	kjU72LCJexvrqL7G4TMHHN
Connection connection / Required connectionInput
Employee code employeeInput	The employee to create or update.
First Name string firstName	The first name of the employee.	John
Last Name string lastName	The last name of the employee.	Doe

Create Pay Entry

Create a new Pay Entry Import | key: createPayEntry

Input	Notes	Example
Company ID string / Required companyId	The id of the company to retrieve.	kjU72LCJexvrqL7G4TMHHN
Connection connection / Required connectionInput
File data / Required file	The file to upload.	My File Contents
File Name string / Required fileName	The name of the file to upload.	an_example_name
Pay Entry Input code payEntryInput	The pay entry fields to create or update

Create/Update Earning

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

Input	Notes	Example
Company ID string / Required companyId	The id of the company to retrieve.	kjU72LCJexvrqL7G4TMHHN
Connection connection / Required connectionInput
Earning Code string / Required earningCode	The earning code of the employee.	12345
Earnings Input code earningsInput	The earnings to create or update.
Employee ID string / Required employeeId	The id of the employee to retrieve.	kjU72LCJexvrqL7G4TMHHN
Start Date string / Required startDate	The start date of the employee.	2021-01-01

Delete Earnings by Earning Code and Start Date

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

Input	Notes	Example
Company ID string / Required companyId	The id of the company to retrieve.	kjU72LCJexvrqL7G4TMHHN
Connection connection / Required connectionInput
Earning Code string / Required earningCode	The earning code of the employee.	12345
Employee ID string / Required employeeId	The id of the employee to retrieve.	kjU72LCJexvrqL7G4TMHHN
Start Date string / Required startDate	The start date of the employee.	2021-01-01

Download Document

Download a document by ID | key: downloadDocument

Input	Notes	Example
Company ID string / Required companyId	The id of the company to retrieve.	kjU72LCJexvrqL7G4TMHHN
Connection connection / Required connectionInput
Document ID string / Required documentId	The id of the document to download.	kjU72LCJexvrqL7G4TMHHN

Get Company Documents

Retrieve Company Documents by Company ID | key: getCompanyDocuments

Input	Default	Notes	Example
Company ID string / Required companyId		The id of the company to retrieve.	kjU72LCJexvrqL7G4TMHHN
Connection connection / Required connectionInput
Include Total Count boolean includeTotalCount	false	Requests that the response include the Pcty-Total-Count header containing the total number of objects that match the request. This may be useful if requesting a small [limit].	false
Limit string limit		Defines the maximum number of items to be returned in the response.	10
Offset string offset		Defines the start location to return. Ex. offset=100 means starting at item 100, return the next [limit] items.	10

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

Input	Notes	Example
Company ID string / Required companyId	The id of the company to retrieve.	kjU72LCJexvrqL7G4TMHHN
Connection connection / Required connectionInput

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

Input	Notes	Example
Company ID string / Required companyId	The id of the company to retrieve.	kjU72LCJexvrqL7G4TMHHN
Connection connection / Required connectionInput
Earning Code string / Required earningCode	The earning code of the employee.	12345
Employee ID string / Required employeeId	The id of the employee to retrieve.	kjU72LCJexvrqL7G4TMHHN
Start Date string / Required startDate	The start date of the employee.	2021-01-01

Get Employee

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

Input	Notes	Example
Company ID string / Required companyId	The id of the company to retrieve.	kjU72LCJexvrqL7G4TMHHN
Connection connection / Required connectionInput
Employee ID string / Required employeeId	The id of the employee to retrieve.	kjU72LCJexvrqL7G4TMHHN

Get Employee Documents

Retrieve Employee Documents by Company ID | key: getEmployeeDocuments

Input	Default	Notes	Example
Company ID string / Required companyId		The id of the company to retrieve.	kjU72LCJexvrqL7G4TMHHN
Connection connection / Required connectionInput
Include Total Count boolean includeTotalCount	false	Requests that the response include the Pcty-Total-Count header containing the total number of objects that match the request. This may be useful if requesting a small [limit].	false
Limit string limit		Defines the maximum number of items to be returned in the response.	10
Offset string offset		Defines the start location to return. Ex. offset=100 means starting at item 100, return the next [limit] items.	10

Get New Client Secret

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

Input	Notes	Example
Code string / Required code	A value sent with the 'ACTION NEEDED: Web Link API Credentials Expiring Soon.' email notification.	123456
Connection connection / Required connectionInput

Get Pay Entry

Retrieve a Pay Entry Import | key: getPayEntry

Input	Notes	Example
Company ID string / Required companyId	The id of the company to retrieve.	kjU72LCJexvrqL7G4TMHHN
Connection connection / Required connectionInput
Time Import File Tracking ID string timeImportFileTrackingId	The tracking id of the time import file to retrieve.	12345

List Company Codes

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

Input	Notes	Example
Code Resource string / Required codeResource	Type of Company Code.	costcenter1
Company ID string / Required companyId	The id of the company to retrieve.	kjU72LCJexvrqL7G4TMHHN
Connection connection / Required connectionInput

List Custom Fields

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

Input	Notes	Example
Category string / Required category	Custom Fields Category	example_field
Company ID string / Required companyId	The id of the company to retrieve.	kjU72LCJexvrqL7G4TMHHN
Connection connection / Required connectionInput

List Earnings

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

Input	Notes	Example
Company ID string / Required companyId	The id of the company to retrieve.	kjU72LCJexvrqL7G4TMHHN
Connection connection / Required connectionInput
Employee ID string / Required employeeId	The id of the employee to retrieve.	kjU72LCJexvrqL7G4TMHHN

List Employees

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

Input	Default	Notes	Example
Company ID string / Required companyId		The id of the company to retrieve.	kjU72LCJexvrqL7G4TMHHN
Connection connection / Required connectionInput
Include Total Count boolean includetotalcount	false	Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.
Page Number string pagenumber	0	Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0.	0
Page Size string pagesize	25	Number of records per page. Default value is 25. Max value is 5000. Leave blank to fetch all records.	25

Raw Request

Send raw HTTP request to Paylocity | key: rawRequest

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required url		Input the path only (/companies/{companyId}/employees/{employeeId}/additionalRates), The base URL is already included (https://api.paylocity.com/api/v2). For example, to connect to https://api.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/additionalRates, only /companies/{companyId}/employees/{employeeId}/additionalRates is entered in this field.	/companies/{companyId}/employees/{employeeId}/additionalRates
Use Exponential Backoff boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries.

Update Employee

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

Input	Notes	Example
Company ID string / Required companyId	The id of the company to retrieve.	kjU72LCJexvrqL7G4TMHHN
Connection connection / Required connectionInput
Employee ID string / Required employeeId	The id of the employee to retrieve.	kjU72LCJexvrqL7G4TMHHN
Employee code employeeInput	The employee to create or update.
First Name string firstName	The first name of the employee.	John
Last Name string lastName	The last name of the employee.	Doe

Update Pay Entry

Update an Pay Entry Import | key: updatePayEntry

Input	Notes	Example
Company ID string / Required companyId	The id of the company to retrieve.	kjU72LCJexvrqL7G4TMHHN
Connection connection / Required connectionInput
File data / Required file	The file to upload.	My File Contents
File Name string / Required fileName	The name of the file to upload.	an_example_name
Pay Entry Input code payEntryInput	The pay entry fields to create or update
Time Import File Tracking ID string timeImportFileTrackingId	The tracking id of the time import file to retrieve.	12345

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.

Description​

Connections​

Paylocity OAuth 2.0​

Pay Entry OAuth 2.0​

Data Sources​

List Company Codes​

Actions​

Create Employee​

Create Pay Entry​

Create/Update Earning​

Delete Earnings by Earning Code and Start Date​

Download Document​

Get Company Documents​

Get Company Specific Schema​

Get Earnings by Earning Code and Start Date​

Get Employee​

Get Employee Documents​

Get New Client Secret​

Get Pay Entry​

List Company Codes​

List Custom Fields​

List Earnings​

List Employees​

Raw Request​

Update Employee​

Update Pay Entry​

Description

Connections

Paylocity OAuth 2.0

Pay Entry OAuth 2.0

Data Sources

List Company Codes

Actions

Create Employee

Create Pay Entry

Create/Update Earning

Delete Earnings by Earning Code and Start Date

Download Document

Get Company Documents

Get Company Specific Schema

Get Earnings by Earning Code and Start Date

Get Employee

Get Employee Documents

Get New Client Secret

Get Pay Entry

List Company Codes

List Custom Fields

List Earnings

List Employees

Raw Request

Update Employee

Update Pay Entry