Skip to main content
PUT
Create wage type version

Authorizations

Authorization
string
header
required

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

Path Parameters

wage_type_code
string
required

Body

application/json

Request schema for creating a new version of an existing wage type.

name
string
required

Display name

category
enum<string>
required

Wage type category

Available options:
earnings,
deductions,
benefits,
statutory,
pension,
contributions,
adjustments,
reimbursements
description
string
required

Description of the wage type

valid_from
string<date>
required

Date when this version becomes effective

taxable_status
enum<string>
required

Whether taxable under PAYE

Available options:
yes,
no,
conditional
tax_timing
enum<string>
required

When tax is applied

Available options:
on_payment,
on_accrual,
on_event
ni_class
enum<string>
required

National Insurance class

Available options:
class_1,
class_1a,
none,
conditional
p11d_reportable_status
enum<string>
required

P11D reporting requirement

Available options:
yes,
no,
conditional
pension_status
enum<string>
required

Pension inclusion status

Available options:
scheme_defined,
yes,
no
payrolling_eligible_status
enum<string>
required

Can be payrolled

Available options:
yes,
no,
conditional
rti_payment_type
string | null

RTI FPS payment type mapping

ni_employee_applies
boolean
default:true

Whether employee NI applies

ni_employer_treatment
enum<string> | null

Employer NI treatment

Available options:
secondary,
class_1a,
none
is_class_1a_applicable
boolean
default:false

Whether Class 1A NI applies

is_ae_qualifying
boolean
default:false

Counts towards AE qualifying earnings

uses_ae_bands
boolean
default:false

Uses AE earnings bands

is_holiday_pay_included
boolean
default:false

Include in holiday pay calculation

is_salary_sacrifice_allowed
boolean
default:false

Can be salary sacrificed

nmw_treatment
enum<string>
default:excluded

NMW/NLW treatment for this wage type

Available options:
included,
excluded,
reduces,
accommodation_offset
opra_rule
enum<string>
default:n/a

Optional Remuneration Arrangement rule

Available options:
yes,
no,
n/a
uses_official_interest_rate
boolean
default:false

Uses HMRC official interest rate

calculation_variants
string[] | null

Calculation method variants

thresholds
Thresholds · object | null

Applicable thresholds

regularity_window_weeks
integer | null

Regularity detection window in weeks

regularity_threshold_periods
integer | null

Regularity threshold periods

is_gross_up
boolean
default:false

Whether this wage type triggers gross-up calculation

is_notional
boolean
default:false

Non-cash notional earning (RCA/RSU)

deduction_tax_treatment
enum<string>
default:post_tax

How a deduction interacts with the tax/NIC bases

Available options:
post_tax,
payroll_giving
legislative_source
string | null

Legislative reference

Response

Successful Response

Response schema for GB wage type.

id
integer
required

Database ID

wage_type_code
string
required

Business key (e.g., UK-E-003)

name
string
required

Display name

category
enum<string>
required

Wage type category

Available options:
earnings,
deductions,
benefits,
statutory,
pension,
contributions,
adjustments,
reimbursements
description
string
required

Description of the wage type

status
enum<string>
required

Lifecycle status

Available options:
draft,
approved,
deprecated
taxable_status
enum<string>
required

Whether taxable under PAYE

Available options:
yes,
no,
conditional
tax_timing
enum<string>
required

When tax is applied

Available options:
on_payment,
on_accrual,
on_event
rti_payment_type
string | null
required

RTI FPS payment type mapping

ni_class
enum<string>
required

National Insurance class

Available options:
class_1,
class_1a,
none,
conditional
ni_employee_applies
boolean
required

Whether employee NI applies

ni_employer_treatment
enum<string> | null
required

Employer NI treatment

Available options:
secondary,
class_1a,
none
is_class_1a_applicable
boolean
required

Whether Class 1A NI applies

p11d_reportable_status
enum<string>
required

P11D reporting requirement

Available options:
yes,
no,
conditional
pension_status
enum<string>
required

Pension inclusion status

Available options:
scheme_defined,
yes,
no
is_ae_qualifying
boolean
required

Counts towards AE qualifying earnings

uses_ae_bands
boolean
required

Uses AE earnings bands

is_holiday_pay_included
boolean
required

Include in holiday pay calculation

is_salary_sacrifice_allowed
boolean
required

Can be salary sacrificed

nmw_treatment
enum<string>
required

NMW/NLW treatment for this wage type

Available options:
included,
excluded,
reduces,
accommodation_offset
opra_rule
enum<string>
required

Optional Remuneration Arrangement rule

Available options:
yes,
no,
n/a
payrolling_eligible_status
enum<string>
required

Can be payrolled

Available options:
yes,
no,
conditional
uses_official_interest_rate
boolean
required

Uses HMRC official interest rate

valid_from
string<date> | null
valid_to
string<date> | null
calculation_variants
string[] | null

Calculation method variants

thresholds
Thresholds · object | null

Applicable thresholds

regularity_window_weeks
integer | null

Regularity detection window in weeks

regularity_threshold_periods
integer | null

Regularity threshold periods

legislative_source
string | null

Legislative reference

owner
string | null

Responsible owner

reviewer
string | null

Compliance reviewer

last_reviewed_at
string<date> | null

Last review date

is_gross_up
boolean
default:false

Whether this wage type triggers gross-up calculation

is_notional
boolean
default:false

Non-cash notional earning (RCA/RSU)

deduction_tax_treatment
enum<string>
default:post_tax

How a deduction interacts with the tax/NIC bases

Available options:
post_tax,
payroll_giving