Skip to main content

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:

  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's configuration.
InputNotesExample
Client ID

Provide the Client Id you received from the Paylocity Developer Console.

Client Secret

Provide the Client Secret you received from the Paylocity Developer Console.

Environment

The environment to use for the Paylocity apis

ScopesWebLinkAPI
Token URL

Select the environment to fetch the token from.

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's configuration.
InputNotesExample
Client ID

Provide the Client Id you received from the Paylocity Developer Console.

Client Secret

Provide the Client Secret you received from the Paylocity Developer Console.

Environment

The environment to use for the Paylocity apis

Scopesall
Token URL

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

InputNotesExample
Code Resource

Type of Company Code.

costcenter1
Company ID

The id of the company to retrieve.

kjU72LCJexvrqL7G4TMHHN
Connection

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

Actions​

Create Employee​

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

InputNotesExample
Company ID

The id of the company to retrieve.

kjU72LCJexvrqL7G4TMHHN
Connection
Employee

The employee to create or update.

First Name

The first name of the employee.

John
Last Name

The last name of the employee.

Doe

Create Pay Entry​

Create a new Pay Entry Import | key: createPayEntry

InputNotesExample
Company ID

The id of the company to retrieve.

kjU72LCJexvrqL7G4TMHHN
Connection
File

The file to upload.

My File Contents
File Name

The name of the file to upload.

an_example_name
Pay Entry Input

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

InputNotesExample
Company ID

The id of the company to retrieve.

kjU72LCJexvrqL7G4TMHHN
Connection
Earning Code

The earning code of the employee.

12345
Earnings Input

The earnings to create or update.

Employee ID

The id of the employee to retrieve.

kjU72LCJexvrqL7G4TMHHN
Start Date

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

InputNotesExample
Company ID

The id of the company to retrieve.

kjU72LCJexvrqL7G4TMHHN
Connection
Earning Code

The earning code of the employee.

12345
Employee ID

The id of the employee to retrieve.

kjU72LCJexvrqL7G4TMHHN
Start Date

The start date of the employee.

2021-01-01

Download Document​

Download a document by ID | key: downloadDocument

InputNotesExample
Company ID

The id of the company to retrieve.

kjU72LCJexvrqL7G4TMHHN
Connection
Document ID

The id of the document to download.

kjU72LCJexvrqL7G4TMHHN

Get Company Documents​

Retrieve Company Documents by Company ID | key: getCompanyDocuments

InputNotesExample
Company ID

The id of the company to retrieve.

kjU72LCJexvrqL7G4TMHHN
Connection
Include Total Count

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

Defines the maximum number of items to be returned in the response.

10
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

InputNotesExample
Company ID

The id of the company to retrieve.

kjU72LCJexvrqL7G4TMHHN
Connection

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

InputNotesExample
Company ID

The id of the company to retrieve.

kjU72LCJexvrqL7G4TMHHN
Connection
Earning Code

The earning code of the employee.

12345
Employee ID

The id of the employee to retrieve.

kjU72LCJexvrqL7G4TMHHN
Start Date

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

InputNotesExample
Company ID

The id of the company to retrieve.

kjU72LCJexvrqL7G4TMHHN
Connection
Employee ID

The id of the employee to retrieve.

kjU72LCJexvrqL7G4TMHHN

Get Employee Documents​

Retrieve Employee Documents by Company ID | key: getEmployeeDocuments

InputNotesExample
Company ID

The id of the company to retrieve.

kjU72LCJexvrqL7G4TMHHN
Connection
Include Total Count

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

Defines the maximum number of items to be returned in the response.

10
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

InputNotesExample
Code

A value sent with the 'ACTION NEEDED: Web Link API Credentials Expiring Soon.' email notification.

123456
Connection

Get Pay Entry​

Retrieve a Pay Entry Import | key: getPayEntry

InputNotesExample
Company ID

The id of the company to retrieve.

kjU72LCJexvrqL7G4TMHHN
Connection
Time Import File Tracking ID

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

InputNotesExample
Code Resource

Type of Company Code.

costcenter1
Company ID

The id of the company to retrieve.

kjU72LCJexvrqL7G4TMHHN
Connection

List Custom Fields​

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

InputNotesExample
Category

Custom Fields Category

example_field
Company ID

The id of the company to retrieve.

kjU72LCJexvrqL7G4TMHHN
Connection

List Earnings​

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

InputNotesExample
Company ID

The id of the company to retrieve.

kjU72LCJexvrqL7G4TMHHN
Connection
Employee ID

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

InputNotesExample
Company ID

The id of the company to retrieve.

kjU72LCJexvrqL7G4TMHHN
Connection
Include Total Count

Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.

false
Page Number

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

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

InputNotesExample
Connection
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
Debug Request

Enabling this flag will log out the current request.

false
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

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

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
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

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Update Employee​

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

InputNotesExample
Company ID

The id of the company to retrieve.

kjU72LCJexvrqL7G4TMHHN
Connection
Employee ID

The id of the employee to retrieve.

kjU72LCJexvrqL7G4TMHHN
Employee

The employee to create or update.

First Name

The first name of the employee.

John
Last Name

The last name of the employee.

Doe

Update Pay Entry​

Update an Pay Entry Import | key: updatePayEntry

InputNotesExample
Company ID

The id of the company to retrieve.

kjU72LCJexvrqL7G4TMHHN
Connection
File

The file to upload.

My File Contents
File Name

The name of the file to upload.

an_example_name
Pay Entry Input

The pay entry fields to create or update

Time Import File Tracking ID

The tracking id of the time import file to retrieve.

12345