---
title: "Workers Comp Setup"
method: GET
path: "/v3/admin/worker-comp"
tags: ["Workers Comp"]
---

# Workers Comp Setup

`GET /v3/admin/worker-comp`

## Request

- Base URL: `https://api.avionte.com/bo-prod`
- URL: `https://api.avionte.com/bo-prod/v3/admin/worker-comp`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Returns a predefined list of workers compensation codes setup in the system for the Division of the specified branch.

## Query parameters

- `branchGuid` string, uuid
- `branchExternalId` string
- `effectiveDate` string, date-time

## Headers

- `FrontOfficeTenantId` integer, required
- `RequestId` string, uuid, required: The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.
- `RequestOrigin` string, required
- `ExternalIdSource` 'BOLD', required
- `RequestUserExternalId` string

## Response `200`

Successfully retrieved Worker Comp Code setup.

- WcCodeRate[]
  - `configWcCodeId` integer, required: The unique identifier for the Worker Comp Code.
  - `configWcCodeRateGuid` string, uuid, required: The unique identifier for the Worker Comp Code Rate, formatted as a UUID.
  - `workerCompCode` string: A worker's compensation code, without the prefacing two-character state code.
  - `description` string, nullable: A description of the WC code, usually describing the job position or industry applicable to the code.
  - `state` string: The two-character code that often prefaces the WC code itself.
  - `costPercent` number: The cost rate for this WC code as a percentage.
  - `ratePercent` number: The rate for this WC code as a percentage.
  - `wcEePercent` number: The talent tax rate for this WC code, applicable to state-level taxes that have rates per WC code, such as WA LNI.
  - `wcErPercent` number: The employer tax rate for this WC code, applicable to state-level taxes that have rates per WC Code, such as WA LNI.
  - `startDate` string, date-time: The start date for the employer tax rate. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.
  - `endDate` string, date-time: The end date for the employer tax rate. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.

## Other responses

- `402`: Additional subscription required.
- `403`: Access Denied
- `404`: Not found
- `405`: Unsupported method
- `415`: Unsupported format(s) indicated by the Content-Type header
- `429`: Too many requests
- `500`: An unexpected error occurred
- `502`: Service Unavailable
- `504`: Gateway Timeout

---

[API](https://skmtc.dev/avionte/apis/avionte-back-office-v3-api.md) - [All operations](https://skmtc.dev/avionte/apis/avionte-back-office-v3-api/llms.txt) - [OpenAPI document](https://skmtc.dev/avionte/apis/avionte-back-office-v3-api/revisions/13269bc541c9?raw)