The configuation that our engine uses to perform calculations for the related TaxYear.
It is used internally when our engine performs any calculations or the Year End routine.
You do not need to do anything with this model, it's provided purely for informational purposes.
| Name / Description | Type / Format | Example | |
|---|---|---|---|
taxYear
The TaxYear for which this configuration applies
|
integer
int32
|
0
|
|
isPreview
Indicates that this is a preview of the given years configuration and it shouldn't yet be used for live processing of payroll data.
|
boolean
|
true
|
|
defaultTaxCode
|
string
|
"string"
|
|
class1ANicsRate
|
DecimalTaxYearConfigPrimitiveValue
|
{DecimalTaxYearConfigPrimitiveValue}
|
|
lowerEarningsLimit
|
PeriodValue
|
{PeriodValue}
|
|
upperEarningsLimit
|
PeriodValue
|
{PeriodValue}
|
|
primaryThreshold
|
PeriodValue
|
{PeriodValue}
|
|
secondaryThreshold
|
PeriodValue
|
{PeriodValue}
|
|
upperAccrualPoint
|
PeriodValue
|
{PeriodValue}
|
|
upperSecondaryThreshold
|
PeriodValue
|
{PeriodValue}
|
|
apprenticeUpperSecondaryThreshold
|
PeriodValue
|
{PeriodValue}
|
|
freeportsUpperSecondaryThreshold
|
PeriodValue
|
{PeriodValue}
|
|
veteransUpperSecondaryThreshold
|
PeriodValue
|
{PeriodValue}
|
|
directorsProratePrimaryThreshold
|
PeriodValue
|
{PeriodValue}
|
|
plan1StudentLoanThreshold
|
number
double
|
0.0
|
|
plan1StudentLoanRate
|
number
double
|
0.0
|
|
plan2StudentLoanThreshold
|
number
double
|
0.0
|
|
plan2StudentLoanRate
|
number
double
|
0.0
|
|
plan4StudentLoanThreshold
|
number
double
|
0.0
|
|
plan4StudentLoanRate
|
number
double
|
0.0
|
|
postGradLoanThreshold
|
number
double
|
0.0
|
|
postGradLoanRate
|
number
double
|
0.0
|
|
deaProtectedEarnings
|
number
double
|
0.0
|
|
pensionLowerThreshold
|
PeriodValue
|
{PeriodValue}
|
|
pensionAutomaticEnrolment
|
PeriodValue
|
{PeriodValue}
|
|
pensionUpperThreshold
|
PeriodValue
|
{PeriodValue}
|
|
pensionAeEmployerContribution
|
number
double
|
0.0
|
|
pensionAeEmployeeContribution
|
number
double
|
0.0
|
|
employmentAllowancePreviousYear
|
number
double
|
0.0
|
|
employmentAllowance
|
number
double
|
0.0
|
|
fixedCodes
|
FixedCode[]
|
{FixedCode}
|
|
scottishFixedCodes
|
FixedCode[]
|
{FixedCode}
|
|
welshFixedCodes
|
FixedCode[]
|
{FixedCode}
|
|
niRates
|
NationalInsuranceCode[]
|
{NationalInsuranceCode}
|
|
directorsNiRates
|
NationalInsuranceCode[]
|
{NationalInsuranceCode}
|
|
brackets
|
TaxBracket[]
|
{TaxBracket}
|
|
scottishBrackets
|
TaxBracket[]
|
{TaxBracket}
|
|
welshBrackets
|
TaxBracket[]
|
{TaxBracket}
|
|
taxCodeChanges
|
TaxCodeChange[]
|
{TaxCodeChange}
|
|
minimumWage
|
NationalMinimumWage[]
|
{NationalMinimumWage}
|
|
statutoryPay
Part of the TaxYearConfig that our engine uses to calculate Statutory Pay.
It is used internally when our engine performs calculations. You do not need to do anything with this model, it's provided purely for informational purposes. |
StatutoryPay
|
{StatutoryPay}
|
|
loanCharge
Part of the TaxYearConfig that our engine uses to calculate charges for a Loan.
It is used internally when our engine performs calculations. You do not need to do anything with this model, it's provided purely for informational purposes. |
LoanCharge
|
{LoanCharge}
|
|
carCharge
Part of the TaxYearConfig that our engine uses to calculate charges for a Company Car.
It is used internally when our engine performs calculations. You do not need to do anything with this model, it's provided purely for informational purposes. |
CarCharge
|
{CarCharge}
|
|
govTalk
Part of the TaxYearConfig that our engine uses submit documents to the HMRC Gateway.
It is used internally when our engine communicates with HMRC. You do not need to do anything with this model, it's provided purely for informational purposes. |
GovTalk
|
{GovTalk}
|
|
mileageAllowancePaymentsRates
|
MileageAllowancePaymentsRate[]
|
{MileageAllowancePaymentsRate}
|
|
tieredPensions
|
TieredPension[]
|
{TieredPension}
|
{
"taxYear": 0,
"isPreview": true,
"defaultTaxCode": "string",
"class1ANicsRate": {
"value": 0.0,
"effectiveFrom": "2024-11-21",
"midYearChanges": [
{
"value": 0.0,
"effectiveFrom": "2024-11-21",
"midYearChanges": [
{
"value": 0.0,
"effectiveFrom": "2024-11-21",
"midYearChanges": "error too many levels"
}
]
}
]
},
"lowerEarningsLimit": {
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": "error too many levels"
}
]
}
]
},
"upperEarningsLimit": {
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": "error too many levels"
}
]
}
]
},
"primaryThreshold": {
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": "error too many levels"
}
]
}
]
},
"secondaryThreshold": {
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": "error too many levels"
}
]
}
]
},
"upperAccrualPoint": {
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": "error too many levels"
}
]
}
]
},
"upperSecondaryThreshold": {
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": "error too many levels"
}
]
}
]
},
"apprenticeUpperSecondaryThreshold": {
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": "error too many levels"
}
]
}
]
},
"freeportsUpperSecondaryThreshold": {
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": "error too many levels"
}
]
}
]
},
"veteransUpperSecondaryThreshold": {
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": "error too many levels"
}
]
}
]
},
"directorsProratePrimaryThreshold": {
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": "error too many levels"
}
]
}
]
},
"plan1StudentLoanThreshold": 0.0,
"plan1StudentLoanRate": 0.0,
"plan2StudentLoanThreshold": 0.0,
"plan2StudentLoanRate": 0.0,
"plan4StudentLoanThreshold": 0.0,
"plan4StudentLoanRate": 0.0,
"postGradLoanThreshold": 0.0,
"postGradLoanRate": 0.0,
"deaProtectedEarnings": 0.0,
"pensionLowerThreshold": {
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": "error too many levels"
}
]
}
]
},
"pensionAutomaticEnrolment": {
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": "error too many levels"
}
]
}
]
},
"pensionUpperThreshold": {
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": [
{
"effectiveFrom": "2024-11-21",
"annualValue": 0.0,
"periodValues": {},
"midYearChanges": "error too many levels"
}
]
}
]
},
"pensionAeEmployerContribution": 0.0,
"pensionAeEmployeeContribution": 0.0,
"employmentAllowancePreviousYear": 0.0,
"employmentAllowance": 0.0,
"fixedCodes": [
{
"code": "string",
"rate": 0.0
}
],
"scottishFixedCodes": [
{
"code": "string",
"rate": 0.0
}
],
"welshFixedCodes": [
{
"code": "string",
"rate": 0.0
}
],
"niRates": [
{
"code": "string",
"description": "string",
"eeB": 0.0,
"eeC": 0.0,
"eeD": 0.0,
"eeE": 0.0,
"eeF": 0.0,
"erB": 0.0,
"erC": 0.0,
"erD": 0.0,
"erE": 0.0,
"erF": 0.0,
"effectiveFrom": "2024-11-21",
"midYearChanges": [
{
"code": "string",
"description": "string",
"eeB": 0.0,
"eeC": 0.0,
"eeD": 0.0,
"eeE": 0.0,
"eeF": 0.0,
"erB": 0.0,
"erC": 0.0,
"erD": 0.0,
"erE": 0.0,
"erF": 0.0,
"effectiveFrom": "2024-11-21",
"midYearChanges": [
{
"code": "string",
"description": "string",
"eeB": 0.0,
"eeC": 0.0,
"eeD": 0.0,
"eeE": 0.0,
"eeF": 0.0,
"erB": 0.0,
"erC": 0.0,
"erD": 0.0,
"erE": 0.0,
"erF": 0.0,
"effectiveFrom": "2024-11-21",
"midYearChanges": "error too many levels"
}
]
}
]
}
],
"directorsNiRates": [
{
"code": "string",
"description": "string",
"eeB": 0.0,
"eeC": 0.0,
"eeD": 0.0,
"eeE": 0.0,
"eeF": 0.0,
"erB": 0.0,
"erC": 0.0,
"erD": 0.0,
"erE": 0.0,
"erF": 0.0,
"effectiveFrom": "2024-11-21",
"midYearChanges": [
{
"code": "string",
"description": "string",
"eeB": 0.0,
"eeC": 0.0,
"eeD": 0.0,
"eeE": 0.0,
"eeF": 0.0,
"erB": 0.0,
"erC": 0.0,
"erD": 0.0,
"erE": 0.0,
"erF": 0.0,
"effectiveFrom": "2024-11-21",
"midYearChanges": [
{
"code": "string",
"description": "string",
"eeB": 0.0,
"eeC": 0.0,
"eeD": 0.0,
"eeE": 0.0,
"eeF": 0.0,
"erB": 0.0,
"erC": 0.0,
"erD": 0.0,
"erE": 0.0,
"erF": 0.0,
"effectiveFrom": "2024-11-21",
"midYearChanges": "error too many levels"
}
]
}
]
}
],
"brackets": [
{
"from": 0.0,
"to": 0.0,
"multiplier": 0.0
}
],
"scottishBrackets": [
{
"from": 0.0,
"to": 0.0,
"multiplier": 0.0
}
],
"welshBrackets": [
{
"from": 0.0,
"to": 0.0,
"multiplier": 0.0
}
],
"taxCodeChanges": [
{
"suffix": "string",
"increment": 0
}
],
"minimumWage": [
{
"apprentice": true,
"maxAge": 0,
"hourlyAmount": 0.0
}
],
"statutoryPay": {
"weeklyParentalLeaveAmount": 0.0,
"weeklySickPayAmount": 0.0,
"aweEligibilityThreshold": 0.0
},
"loanCharge": {
"threshhold": 0.0,
"officialInterestRate": 0.0
},
"carCharge": {
"dieselSurcharge": 0.0,
"maxCharge": 0.0,
"minCharge": 0.0,
"fuelCharge": 0.0,
"newCarRateReductionDate": "2024-11-21",
"newCarRateReductionAmount": 0.0,
"co2Table": [
{
"rangeStart": 0,
"rangeStop": 0,
"rate": 0.0
}
],
"engineSizeTable": [
{
"rangeStart": 0,
"rangeStop": 0,
"rate": 0.0
}
],
"zeroEmissionsTable": [
{
"rangeStart": 0,
"rangeStop": 0,
"rate": 0.0
}
]
},
"govTalk": {
"fullPaymentSubmissionNamespace": "string",
"fullPaymentSubmissionNamespaceVersion": "string",
"employerPaymentSummaryNamespace": "string",
"employerPaymentSummaryNamespaceVersion": "string",
"niNoVerificationRequestNameSpace": "string",
"cisVerificationRequestNameSpace": "string",
"cis300NameSpace": "string",
"expensesAndBenefitsNameSpace": "string",
"expensesAndBenefitsNameSpaceVersion": "string"
},
"mileageAllowancePaymentsRates": [
{
"vehicleType": "Car",
"rate": 0.0,
"threshold": 0,
"aboveThresholdRate": 0.0
}
],
"tieredPensions": [
{
"type": "UserDefined",
"rates": [
{
"name": "string",
"description": "string",
"rangeStart": 0.0,
"rate": 0.0
}
],
"employerContribRate": 0.0
}
]
}- none -
- none -