This article is intended for HelloTeam users with ADMIN Access Level
To enable an integration with Paylocity, you’ll need to get access to your Client ID and Client Secret, which requires reaching out to Paylocity directly!
Note: There may be a cost associated with the API setup + gathering of credentials from Paylocity.
Overview
Paylocity needs to know what fields to provision these credentials with as far as data that can be accessed, so your end users will need to complete the Paylocity Web Services - Access Request form. The Authorized Contact has the approval to speak with Paylocity regarding a specific account, and can therefore fill out the access request form.
Step 1: Fill out the Paylocity Web Services - Access Request Form
Within the form, the Client Contact Information should contain the information on the end-user's company (for example, the HR personnel from the end-customer).
The Vendor / Third Party Contact Information should contain the information for the customer using Merge / the company you are connecting to. Under "Briefly describe use case", you can describe how you are using Merge to connect to the Third Party.
You can ignore the "Webhook Push Notifications" section; however, you will want to request access to the following endpoints:
If you do not need Pay Statements, Deductions, & Earnings fill out the following:
If you do need Pay Statements, Deductions, & Earnings fill out the following:
Note: Get Employee is a required permission to authenticate the linking flow, but only endpoints needed for your integration should be selected. For example, if you don’t need Pay Statements, Deductions, or Earnings, remove those from the permissions.
Step 2: Send your completed form to webservices@paylocity.com.
The email body should contain the following:
Subject: Requesting Client ID and Client Secret
Hi Paylocity team, can we get access to a Client ID and Client Secret for API access? (https://www.paylocity.com/our-products/integrations/api-library/) We have attached the form specifying relevant permissions. |
Step 3: Be sure to share your Client ID & Secret with your HelloTeam representative so that they can complete your authentication.
Paylocity will provide you with your Client ID and Client Secret, which you will need to share with your HelloTeam representative.
For further information, you can find full details on Paylocity's website here.
Step 4: Share your Company ID with your HelloTeam representative so that they can complete your authentication.
Your Company ID is on the upper left hand corner of your Paylocity portal.