TaxYearConfig

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 number double 0.0
lowerEarningsLimit number double 0.0
upperEarningsLimit number double 0.0
primaryThreshold number double 0.0
secondaryThreshold number double 0.0
upperAccrualPoint number double 0.0
upperSecondaryThreshold number double 0.0
apprenticeUpperSecondaryThreshold number double 0.0
plan1StudentLoanThreshold number double 0.0
plan1StudentLoanRate number double 0.0
plan2StudentLoanThreshold number double 0.0
plan2StudentLoanRate number double 0.0
postGradLoanThreshold number double 0.0
postGradLoanRate number double 0.0
deaProtectedEarnings number double 0.0
pensionLowerThreshold number double 0.0
pensionAutomaticEnrolment number double 0.0
pensionUpperThreshold number double 0.0
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}
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": 0.0,
  "lowerEarningsLimit": 0.0,
  "upperEarningsLimit": 0.0,
  "primaryThreshold": 0.0,
  "secondaryThreshold": 0.0,
  "upperAccrualPoint": 0.0,
  "upperSecondaryThreshold": 0.0,
  "apprenticeUpperSecondaryThreshold": 0.0,
  "plan1StudentLoanThreshold": 0.0,
  "plan1StudentLoanRate": 0.0,
  "plan2StudentLoanThreshold": 0.0,
  "plan2StudentLoanRate": 0.0,
  "postGradLoanThreshold": 0.0,
  "postGradLoanRate": 0.0,
  "deaProtectedEarnings": 0.0,
  "pensionLowerThreshold": 0.0,
  "pensionAutomaticEnrolment": 0.0,
  "pensionUpperThreshold": 0.0,
  "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
    }
  ],
  "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
  },
  "loanCharge": {
    "threshhold": 0.0,
    "officialInterestRate": 0.0
  },
  "carCharge": {
    "dieselSurcharge": 0.0,
    "maxCharge": 0.0,
    "fuelCharge": 0.0,
    "newCarRateReductionDate": "2020-07-10",
    "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",
    "employerPaymentSummaryNamespace": "string",
    "niNoVerificationRequestNameSpace": "string",
    "cisVerificationRequestNameSpace": "string",
    "cis300NameSpace": "string",
    "expensesAndBenefitsNameSpace": "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
    }
  ]
}
Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Get Configuration