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 | |
|---|---|---|---|
name
Holiday scheme name
|
string
|
"string"
|
|
averageCalculationWeeks
The number of weeks that the average holiday pay calculation is to be calculated over (Default 52)
|
integer
int32
|
0
|
|
useOnlyPaidWeeks
If to go back further than the stated no of weeks for calculation if there are weeks where the employee has not been paid. (Default- True)
|
boolean
|
true
|
|
ignoreSxp
Option to ignore weeks where SXP payments have been paid. The calculation will then go back like above until the stated number of weeks are included in the calculation. (Default -True).
|
boolean
|
true
|
|
calculationDurationUnit
|
string
|
"Hours"
"Days"
|
|
useNiPay
If use National insurance gross taxable pay. (Default - True).
|
boolean
|
true
|
|
useWorkingPattern
If use the weekly hours or days as per their working pattern as the divisor for the average holiday rate.
|
boolean
|
true
|
|
payCodeSetForPayId
the Paycode set that they want to use for the Values to enable the calculation.
|
string
uuid
|
"string"
|
|
payCodeSetForHoursId
the Paycode set that they want to use for the Hours to enable the calculation.
|
string
uuid
|
"string"
|
|
useFallbackRate
Indicates to use employee base hourly rate where the calculated average hourly rate is less
|
boolean
|
true
|
{
"name": "string",
"averageCalculationWeeks": 0,
"useOnlyPaidWeeks": true,
"ignoreSxp": true,
"calculationDurationUnit": "Hours",
"useNiPay": true,
"useWorkingPattern": true,
"payCodeSetForPayId": "string",
"payCodeSetForHoursId": "string",
"useFallbackRate": true
}- none -
- none -