PUT
Create Treatment Edition

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Headers

If-Match
string | null
If-None-Match
string | null
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
wage_type_id
string
required

Body

application/json
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
valid_from
string<date>
required
valid_to
string<date>
required
deduction_tax_treatment
enum<string>
default:POST_TAX

How a deduction interacts with the tax/NIC bases

Available options:
POST_TAX,
PAYROLL_GIVING
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

is_proratable
boolean
default:false

Prorate on partial-period presence or mid-period rate change

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:NOT_APPLICABLE

Optional Remuneration Arrangement rule

Available options:
YES,
NO,
NOT_APPLICABLE
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)

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

Response

Successful Response

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
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.

deduction_tax_treatment
enum<string>
default:POST_TAX

How a deduction interacts with the tax/NIC bases

Available options:
POST_TAX,
PAYROLL_GIVING
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

is_proratable
boolean
default:false

Prorate on partial-period presence or mid-period rate change

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:NOT_APPLICABLE

Optional Remuneration Arrangement rule

Available options:
YES,
NO,
NOT_APPLICABLE
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)

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