GET
Get Catalog Wage Type

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

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

The wage type with every satellite as it reads on one date. A satellite with no slice on an explicit date is null.

id
string
required
external_ref
string | null
required
created_at
string<date-time>
required
read-only
created_by
string
required
read-only

Who created the hub: 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.

deleted_at
string<date-time> | null
required

When the hub was closed

organization_id
string | null
required

The owning organization; null for the country catalog's own types

country_code
enum<string>
required

Enum for CountryAlpha2 codes

Available options:
IE,
GB,
AE,
US
wage_type_code
string
required

Business key, unique within its owner

system_usage
enum<string> | null
required

On catalog types: how an organization may use it, e.g. as an input, or not submit it at all because the engine calculates it

Available options:
DERIVABLE,
CALCULATED_ONLY,
NON_DERIVABLE,
TERMINATION
core
GBWageTypeCoreSatellite · object | null
treatment
GBWageTypeTreatmentSatellite · object | null
lifecycle
WageTypeLifecycleSatellite · object | null
computation
WageTypeComputationSatellite · object | null