TrakPay & Paylocity Integration Technical Information
We here at TrakPay make use of the following Paylocity endpoints to pull the necessary information we need in order to effectively process your paygo WC reporting service. Please refer to the table below for full details on the data directionality of how we interface with Paylocity.
| Paylocity API Endpoint(s) |
Paylocity Field Name | Partner Field Name From UI |
Direction of Exchange From Payroll Database |
Required for Service? |
|---|---|---|---|---|
| COMPANY INFORMATION | Ein | Fein | PULL | YES |
| Company Name | Named Insured | PULL | OPTIONAL | |
| EMPLOYEE DEMOGRAPHICS | Employee ID | Employee# | PULL | YES |
| First Name | First Name | PULL | YES | |
| Last Name | Last Name | PULL | YES | |
| Work Location State | State/Home State/Work State-Class Code Combo | PULL | YES | |
| Workers Compensation Code | Class Code/Work State-Class Code Combo | PULL | OPTIONAL | |
| SSN (Last 4 digits only) | SSN*** | PULL | YES | |
| Employee Status | Internal Use only not displayed in UI* | PULL | OPTIONAL | |
| Gender | Gender | PULL | OPTIONAL | |
| Pay Group | Internal Use only not displayed in UI** | PULL | OPTIONAL | |
| EARNINGS COMPANY CODES | Code**** | Custom Wage Code | PULL | YES |
| Description | Description | PULL | YES | |
| DEDUCTION COMPANY CODES | Code**** | Custom Wage Code | PULL | YES |
| Description | Description | PULL | YES | |
| PAY STATEMENTS | Check Date | Check Date | PULL | YES |
| Period Begin Date | Begin Date | PULL | YES | |
| Period End Date | End Date | PULL | YES | |
| Gross Pay | Payroll | PULL | YES | |
| Pay Statement Id | Internal Use only not displayed in UI | PULL | YES | |
| Code | Custom Wage Code | PULL | YES | |
| Type | Internal Use only not displayed in UI | PULL | YES | |
| Is Memo | Internal Use only not displayed in UI | PULL | YES | |
| Amount | OT/Overtime/Tips/Other Exempt Wages (depends on client wage code mapping) | PULL | YES | |
| Total Hours | Hours | PULL | YES |
* Employee Status is only used to filter which employees we pull payroll for. Terminated employees will still show up in your Employee list in TrakPay. Don't worry though, as these only get reported to your insurance carrier if they actually have payroll for a pay period.
** Pay group is only used in cases where you need to seperate out employees for billing purposes but the employees share the same company id in Paylocity
*** We only take the last 4 of the SSN. This is used to differentiate employees with the same name.
**** Paylocity provides you with pre-canned Earnings & Deduction codes which are already mapped to the appropriate
payroll filters with TrakPay.
Any custom earnings/deduction codes that you add to Paylocity will be pulled by TrakPay, and as a client, you
will be prompted via email to login to TrakPay and map your custom codes to the appropriate wage type.
Mapping your custom wage codes in TrakPay is easy & intuitive. Some might argue it's even fun! We use these mappings to ensure your payroll is filtered into the appropriate bucket for determining if the payroll should be included or excluded from your WC premium calcuation.
Please click here to download a comprehensive guide on included and excluded
payroll wages.
Please note that we will appropriately modify the payroll data being reported to the insurance carrier to account
for any state exceptions as noted on the 3rd page.
Per our terms and conditions, all clients must ensure any custom earnings/deduction codes are mapped within TrakPay in order to have your paygo WC service to continue processing.
Below is a detailed list of all the Paylocity endpoints we utilize to integrate with Paylocity.
Company Information
GET /apiHub/corehr/v1/companies/{companyId} - We use this to pull basic company information. Specifically:
- FEIN
- Company Name
Company Codes
GET /apiHub/payroll/v1/companies/{companyId}/{codeResource} - We pull your company codes for deductions and earnings. We use these company codes to determine how much of the employees payroll should go into payroll, tips, overtime, or excluded wages.
If we cannot automatically determine which codes need to be excluded from your payroll to calculate your premiums, we will provide in our easy to use interface a way to designate the best matching category that best describes what your company code is used for. We then use this information to calculate your subject payroll and premium accordingly. This information is not shared with Paylocity and is soley used within TrakPay to ensure your payroll reporting is as accurate as possible for your carrier.
Employee Demographics
GET /coreHr/v1/companies/{companyId}/employees - We use this to pull the list of employees we should try and pull payroll for and their details. We pull the following information about employees:
- Employee Id
- First Name
- Last Name
- Last 4 of SSN
- State
- Class Code
- Gender
- Status
GET /coreHr/v1/companies/{companyId}/employees/{employeeId} - We use this to pull information for a specific employee if needed. We pull the following information about employees:
- First Name
- Last Name
- Last 4 of SSN
- Work Location State
- Workers' Class Code
- Gender
- Status
Pay Statements
GET /apiHub/payroll/v1/companies/{companyId}/employees/{employeeId}/payStatements - We use this to pull the
all available pay period (begin date/end date/check date) for the employee. Additionally, we use this
to pull the base wages to use for your payroll as well as any overtime and tips. Additional tips/overtime/excluded wages
are figured out from pulling the pay statement details depending on your company codes. Total hours as well is pulled from this.
If you integrated with Paylocity later, we pull all available pay statements from the effective date of your policy to the current date.
Every day we'll see if a week has passed since your last check date and we'll check for any available check dates between the day after the
last check date to the current date. At any time you can request a specific check date by visiting your Payroll tab in the Client Portal.
IMPORTANT - We will also check the employer taxes to check for any SUI taxes and if we don't find any, we will consider the employee a 1099 employee which you will be
notified of. If you need to report such employees to your carrier, please make sure to enable 1099 reporting.
Further information about Paylocity's API endpoints can be found here.
If you have any questions in regards to what data we receive from Paylocity to process your paygo WC service, please contact [email protected] for further assistance.