Skip to main content
GET
/
gb
/
wage-types
List wage types
curl --request GET \
  --url https://dev.intermezzo.ai/gb/wage-types \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": 123,
      "wageTypeCode": "<string>",
      "name": "<string>",
      "category": "earnings",
      "description": "<string>",
      "status": "draft",
      "taxableStatus": "yes",
      "taxTiming": "on_payment",
      "rtiPaymentType": "<string>",
      "niClass": "class_1",
      "niEmployeeApplies": true,
      "niEmployerTreatment": "secondary",
      "isClass1AApplicable": true,
      "p11DReportableStatus": "yes",
      "pensionStatus": "scheme_defined",
      "isAeQualifying": true,
      "usesAeBands": true,
      "isHolidayPayIncluded": true,
      "isSalarySacrificeAllowed": true,
      "isNmwGuardRequired": true,
      "opraRule": "yes",
      "payrollingEligibleStatus": "yes",
      "usesOfficialInterestRate": true,
      "validFrom": "2023-12-25",
      "validTo": "2023-12-25",
      "calculationVariants": [
        "<string>"
      ],
      "thresholds": {},
      "regularityWindowWeeks": 123,
      "regularityThresholdPeriods": 123,
      "legislativeSource": "<string>",
      "owner": "<string>",
      "reviewer": "<string>",
      "lastReviewedAt": "2023-12-25"
    }
  ],
  "pagination": {
    "limit": 123,
    "hasNext": false,
    "hasPrev": false,
    "nextCursor": "<string>",
    "prevCursor": "<string>",
    "total": 0
  }
}

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

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