v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Companies
Jobs

Get Workers Comp Codes

Returns a list of available workers compensation codes that can be assigned to companies and jobs and their details.

get/v1/work-comp

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

A list of workers compensation codes.

idinteger

The identifier for the worker's comp code.

wcCodestring

The worker's comp code.

wcDescriptionstring

Description for the worker's comp code.

wcStatestring

The state/province the worker's comp code is for.

wcCountrystring

The country the worker's comp code is for.

employerIdinteger

The identifier for the employer the worker's comp code is for.

officeIdsinteger[]

The identifiers for the offices the worker's comp code is for.

Example response

[
  {
    "id": 12345,
    "wcCode": "4136",
    "wcDescription": "Clerical Office Employees",
    "wcState": "CA",
    "wcCountry": "US",
    "employerId": 12345
  }
]