Get Treatment
ETag is the edition read: send it as If-Match on the next PUT.
Authorizations
Get token from Auth0 and paste it here
Query Parameters
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
Whether taxable under PAYE
YES, NO, CONDITIONAL When tax is applied
ON_PAYMENT, ON_ACCRUAL, ON_EVENT National Insurance class
CLASS_1, CLASS_1A, NONE, CONDITIONAL P11D reporting requirement
YES, NO, CONDITIONAL Pension inclusion status
SCHEME_DEFINED, YES, NO Can be payrolled
YES, NO, CONDITIONAL 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.
How a deduction interacts with the tax/NIC bases
POST_TAX, PAYROLL_GIVING RTI FPS payment type mapping
Whether employee NI applies
Employer NI treatment
SECONDARY, CLASS_1A, NONE Whether Class 1A NI applies
Counts towards AE qualifying earnings
Uses AE earnings bands
Include in holiday pay calculation
Can be salary sacrificed
Prorate on partial-period presence or mid-period rate change
NMW/NLW treatment for this wage type
INCLUDED, EXCLUDED, REDUCES, ACCOMMODATION_OFFSET Optional Remuneration Arrangement rule
YES, NO, NOT_APPLICABLE Uses HMRC official interest rate
Calculation method variants
Applicable thresholds
Regularity detection window in weeks
Regularity threshold periods
Whether this wage type triggers gross-up calculation
Non-cash notional earning (RCA/RSU)
Legislative reference
Responsible owner
Compliance reviewer
Last review date