Skip to main content
GET
List wage types

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

effective_date
string<date> | null

Filter to versions valid on date

status
enum<string> | null

Filter by status Lifecycle status of wage type.

Available options:
draft,
approved,
deprecated
category
enum<string> | null

Filter by category Category of GB wage type.

Available options:
earnings,
deductions,
benefits,
statutory,
pension,
contributions,
adjustments,
reimbursements
include_deprecated
boolean
default:false

Include deprecated wage types

limit
integer
default:20

Page size

Required range: 1 <= x <= 100
cursor
string | null

Pagination cursor

Response

Successful Response

items
GBWageTypeResponse · object[]
required
pagination
PaginationMeta · object
required