NationalInsuranceCalculationBase

Included as part of the PayRunEntry model to provide details of how the National Insurance Contribution was calculated.
Unless the PayRunEntry.ManualNi property is set to true then these value will all be read-only and are recalculated everytime a payrun is updated.
This calculation could be made up of one or more calculations made on different NI table letters.
Where more than NI table letter affects the calculation, the calculation for each NI table letter will be contain in the Breakdown.

Name / Description Type / Format Example
niCategory
Calculated on NI table letter
string "string"
asDirector
Calculated as a Director
boolean true
earningsUptoIncludingLEL
Earnings up to and including LEL
number double 0.0
earningsAboveLELUptoIncludingPT
Earnings above LEL up to PT
number double 0.0
earningsAbovePTUptoIncludingST
Earnings above PT up to ST
number double 0.0
earningsAbovePTUptoIncludingUEL
Earnings above PT up to UEL
number double 0.0
earningsAboveSTUptoIncludingUEL
Earnings above ST up to UEL
number double 0.0
earningsAboveSTUptoIncludingFUST
Earnings above ST up to FUST
number double 0.0
earningsAboveFUSTUptoIncludingUEL
Earnings above FUST up to UEL
number double 0.0
earningsAboveUEL
Earnings above UEL
number double 0.0
employeeNiGross
Employee National Insurance Gross Value
number double 0.0
employeeNiRebate
Employee National Insurance Rebate Value
number double 0.0
employerNiGross
Employer National Insurance Gross Value
number double 0.0
employerNiRebate
Employer National Insurance Rebate Value
number double 0.0
employeeNi
Net Employee National Insurance
number double 0.0
employerNi
Net Employer National Insurance
number double 0.0
netNi
Net National Insurance (Employer + Employee)
number double 0.0
niablePay
Niable pay value, required for payrun overrides
number double 0.0
{
  "niCategory": "string",
  "asDirector": true,
  "earningsUptoIncludingLEL": 0.0,
  "earningsAboveLELUptoIncludingPT": 0.0,
  "earningsAbovePTUptoIncludingST": 0.0,
  "earningsAbovePTUptoIncludingUEL": 0.0,
  "earningsAboveSTUptoIncludingUEL": 0.0,
  "earningsAboveSTUptoIncludingFUST": 0.0,
  "earningsAboveFUSTUptoIncludingUEL": 0.0,
  "earningsAboveUEL": 0.0,
  "employeeNiGross": 0.0,
  "employeeNiRebate": 0.0,
  "employerNiGross": 0.0,
  "employerNiRebate": 0.0,
  "employeeNi": 0.0,
  "employerNi": 0.0,
  "netNi": 0.0,
  "niablePay": 0.0
}
Contained in Models
NationalInsuranceCalculation
Consumed by Operations

- none -

Returned by Operations

- none -