GET a List of Workers Compensation Codes by Company ID

get https://dc1demogwext.paylocity.com/apiHub/positionManagement/v1/companies/{companyId}/workerCompensationCodes

Summary Description

The GET Workers Compensation Codes List by Company ID endpoint, retrieves a comprehensive list of Workers Compensation Codes from the Paylocity system with each call. Workers' compensation codes, also known as workers' compensation class codes or class codes, are standardized numeric or alphanumeric identifiers utilized to define and categorize various work kinds or job duties inside the workers' compensation insurance system. Workers' compensation insurance offers compensation to employees who experience work-related injuries or illnesses, and these codes are essential in determining insurance rates and processing claims.
Pagination can be achieved by using the "workerCompensationCodes" parameter and specifying the values of "limit" and "offset" to decide the quantity of records to be retrieved. The utilization of the "limit" option permits the user to restrict the quantity of rows that are retrieved from a query, whereas the "offset" option enables the omission of a designated number of rows preceding the commencement of the result set. The utilization of both the limit and offset parameters in a query allows for the skipping of rows as well as the restriction of the number of rows returned.

Use Cases

Locations are addresses used as work or hiring locations. Each worker should have an assigned work location. The purpose of a work location is to verify workers' taxes. Work locations in HR & Payroll will show in Paylocity's Recruiting platform when creating job postings.
This information will also transfer to external job sites if using Recruiting Enhanced Features. Currently, only one work location can be added to each job listing.

Path Params

companyId

string

required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.
Allowable Values:
9 char max

Query Params

includeTotalCount

boolean

Defaults to true

A boolean value representing whether the API should return the total number of resources available (even though only a subset may be returned). When includeTotalCount=true, then the X-Pcty-Total-Count response header should be added to the response and will specify the total number of records available. APIs that support X-Pcty-Total-Count should include this parameter in their specification.

limit

int32

Defaults to 20

Number of workers compensation codes per page.
Default Value: 20
Maximum Value: 100

offset

int32

Defaults to 0

Pagination offset.

Headers

Authorization

string

Authorization token. Ex. Bearer ...

testMode

boolean

Defaults to false

If true all responses are mocked and generated randomly.

Response

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://dc1demogwext.paylocity.com/apiHub/positionManagement/v1/companies/companyId/workerCompensationCodes?includeTotalCount=true&limit=20&offset=0' \
3
     --header 'accept: application/json' \
4
     --header 'testMode: false'


xxxxxxxxxx
10
 
1
[
2
  {
3
    "clientId": 0,
4
    "code": "string",
5
    "description": "string",
6
    "active": true,
7
    "positionsAssigned": 0,
8
    "additionalProp": {}
9
  }
10
]

200Success