Skip to main content
POST
Create Wage Type

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Headers

X-Acting-User
string | null

The person acting through the access credential, recorded as created_by of what the request writes. Audit only: access is checked on the credential.

Required string length: 1 - 255

Path Parameters

organization_id
string
required

Body

application/json

Creating an organization's wage type with its own core and treatment, and optionally a computation. Each satellite starts on [valid_from, 9999-12-31); the type starts as DRAFT and resolves in payrolls once approved.

core
GBWageTypeCore · object
required

What the wage type is called and which block of the payslip it belongs to.

treatment
GBWageTypeTreatment · object
required

The statutory treatment of amounts paid under the code.

valid_from
string<date>
required

The first day every satellite's data is valid at

wage_type_code
string
required

Business key, unique within the organization; not in the UK- namespace

computation
WageTypeComputationSpec · object | null

How the amount paid under the code is computed: a wagekit spec, the codes it reads, and how its result is rounded.

external_ref
string

The integrator's own key, unique within the parent and never changed. A path may name the hub as ext:{external_ref}.

Required string length: 1 - 255
Pattern: ^[A-Za-z0-9._~-]+$

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.

country_code
enum<string>
required

Enum for CountryAlpha2 codes

Available options:
IE,
GB,
AE,
US
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

external_ref
string | null
required
id
string
required
organization_id
string | null
required

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

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
wage_type_code
string
required

Business key, unique within its owner

computation
WageTypeComputationSatellite · object | null
core
GBWageTypeCoreSatellite · object | null
lifecycle
WageTypeLifecycleSatellite · object | null
treatment
GBWageTypeTreatmentSatellite · object | null