GET
Get Core

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required
wage_type_id
string
required

Query Parameters

valid_at
string<date> | null

Valid-time date to read, past or future. Defaults to today, or to the first upcoming edition when nothing is valid yet.

Response

Successful Response

name
string
required

Display name

description
string
required

Description of the wage type

category
enum<string>
required

Wage type category

Available options:
EARNINGS,
DEDUCTIONS,
BENEFITS,
STATUTORY,
PENSION,
CONTRIBUTIONS,
ADJUSTMENTS,
REIMBURSEMENTS
edition
integer
required
read-only
valid_from
string<date>
required
valid_to
string<date>
required
created_at
string<date-time>
required
read-only
created_by
string
required
read-only

Who wrote the edition: the acting user (X-Acting-User, else the access credential), system for our own writes, or <authority>:<notice> for a write on an authority's behalf, e.g. hmrc:P6.