Workers Comp Setup

get

https://api.avionte.com/bo-prod/v3/admin/worker-comp

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

Query Params

branchGuid

uuid

The unique identifier for the Branch record, sometimes known as a Staffing Supplier Site.

branchExternalId

string

The external ID of the Branch entity, used as an alternative to the BranchGuid query parameter. When provided with a valid ExternalIdSource header, it overrides the lookup of the Branch entity record. If a matching record is not found, an ExternalEntityNotFound error is returned. If a match is found, the response includes a BranchGuid header containing the classic entity record ID.

effectiveDate

date-time

A general use datetime value representing a specific point in time, used to compare against a date range. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss format, for example, 2026-12-01 or 2026-12-01T14:30:00.

Headers

FrontOfficeTenantId

integer

required

An integer identifier for the tenant that the request is being made for.

RequestId

uuid

required

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

RequestOrigin

string

required

length between 1 and 100

The string source name (such as application or function name) that indicates the origin of the request.

ExternalIdSource

string

enum

required

The external ID source that determines which external reference source is used to perform an external ID lookup.

Allowed:

RequestUserExternalId

string

The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.

Responses

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

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully retrieved Worker Comp Code setup.

402Additional subscription required.

403Access Denied

404Not found