Guides

Name / Description	Type / Format	Example
`basicPay` The amount to be paid to this Employee as a result of the PayOptions that have been set	`number` double	`0.0`
`gross` Gross pay	`number` double	`0.0`
`grossForNi` The amount of the Gross that is subject to NI	`number` double	`0.0`
`grossForNiNonRti` The amount of the Gross that is subject to NI but excluded from RTI	`number` double	`0.0`
`grossNotSubjectToEmployersNi` The amount of the Gross that is not subject to Employers NI. This is the same as GrossForNI where the employees NI Table has an Er contribution	`number` double	`0.0`
`grossNotSubjectToEmployersNiNonRti` The amount of the Gross that is not subject to Employers NI. This is the same as GrossForNI where the employees NI Table has an Er contribution This is the amount that is excluded from RTI	`number` double	`0.0`
`grossForTax` The amount of the Gross that is subject to PAYE	`number` double	`0.0`
`employerNi`	`number` double	`0.0`
`employerNiNonRti` Employer NI excluded from RTI	`number` double	`0.0`
`employeeNi`	`number` double	`0.0`
`employeeNiNonRti` Employee NI excluded from RTI	`number` double	`0.0`
`employerNiOffPayroll` The amount included in EmployerNi that is in relation to Off-Payroll Workers	`number` double	`0.0`
`realTimeClass1ANi`	`number` double	`0.0`
`realTimeClass1ANiNonRti` Real Time Class 1A NI excluded from RTI	`number` double	`0.0`
`tax`	`number` double	`0.0`
`taxNonRti` Tax excluded from RTI	`number` double	`0.0`
`netPay` The Net Pay for this Employee	`number` double	`0.0`
`adjustments` The value of adjustments made to the Net Pay (Non taxable/NIable additions/deductions)	`number` double	`0.0`
`notionalPay` The value of adjustments that are of type notional.	`number` double	`0.0`
`additions` The value of all additions. This minus Deductions should equal TakeHomePay	`number` double	`0.0`
`deductions` The value of all deductions. Additions minus This value should equal TakeHomePay	`number` double	`0.0`
`takeHomePay` The amount this Employee takes home	`number` double	`0.0`
`nonTaxOrNICPmt` The value of any payments being made to this Employee that aren't being subjected to PAYE or NI	`number` double	`0.0`
`itemsSubjectToClass1NIC` Items subject to Class 1 NIC but not taxed under PAYE regulations excluding pension contributions	`number` double	`0.0`
`dednsFromNetPay` The value of any deductions being made to the Net Pay for this Employee	`number` double	`0.0`
`tcp_Tcls` Value of payments marked as Trivial Commutation Payment (A - TCLS)	`number` double	`0.0`
`tcp_Pp` Value of payments marked as Trivial Commutation Payment (B - Personal Pension)	`number` double	`0.0`
`tcp_Op` Value of payments marked as Trivial Commutation Payment (C - Occupational Pension)	`number` double	`0.0`
`flexiDd_Death` Value of payments marked as flexibly accessing death benefit (taxable)	`number` double	`0.0`
`flexiDd_Death_NonTax` Value of payments marked as flexibly accessing death benefit (non taxable)	`number` double	`0.0`
`flexiDd_Pension` Value of payments marked as flexibly accessing pension (taxable)	`number` double	`0.0`
`flexiDd_Pension_NonTax` Value of payments marked as flexibly accessing pension (non taxable)	`number` double	`0.0`
`flexiDd_SeriousIllHealth` Value of payments marked as flexibly accessing serious ill health lump sum (taxable)	`number` double	`0.0`
`flexiDd_SeriousIllHealth_NonTax` Value of payments marked as flexibly accessing serious ill health lump sum (non taxable)	`number` double	`0.0`
`smp` Statutory Maternity Pay	`number` double	`0.0`
`smpNonRti` Statutory Maternity Pay excluded from RTI	`number` double	`0.0`
`spp` Statutory Paternity Pay	`number` double	`0.0`
`sppNonRti` Statutory Paternity Pay excluded from RTI	`number` double	`0.0`
`sap` Statutory Adoption Pay	`number` double	`0.0`
`sapNonRti` Statutory Adoption Pay excluded from RTI	`number` double	`0.0`
`shpp` Statutory Shared Parental Pay	`number` double	`0.0`
`shppNonRti` Statutory Shared Parental Pay excluded from RTI	`number` double	`0.0`
`spbp` Statutory Parental Bereavement Pay	`number` double	`0.0`
`spbpNonRti` Statutory Parental Bereavement Pay excluded from RTI	`number` double	`0.0`
`ssp` Statutory Sick Pay	`number` double	`0.0`
`sspNonRti` Statutory Sick Pay excluded from RTI	`number` double	`0.0`
`studentLoanRecovered`	`number` double	`0.0`
`studentLoanRecoveredNonRti` Student Loan recovered excluded from RTI	`number` double	`0.0`
`postgradLoanRecovered`	`number` double	`0.0`
`postgradLoanRecoveredNonRti` Postgrad Loan recovered excluded from RTI	`number` double	`0.0`
`pensionableEarnings` The amount of the Gross that is subject to Pension Deductions. If the Pension Scheme uses Qualifying Earnings (upper and lower limits) then this value is before those are applied	`number` double	`0.0`
`pensionablePay` The amount of the Gross that pension calculations are based on after taking into account Upper and Lower Limits for the WorkerGroup.	`number` double	`0.0`
`nonTierablePay` The value of any pay that shouldn't count towards determining a pension tier.	`number` double	`0.0`
`employeePensionContribution` The value of the Pension Contribution being made by this Employee, excluding any Additional Voluntary Contributions	`number` double	`0.0`
`employeePensionContributionAvc` The value of the Pension Contribution being made by this Employee as an Additional Voluntary Contribution	`number` double	`0.0`
`employerPensionContribution` The value of the Pension Contribution being made by the Employer for this Employee	`number` double	`0.0`
`empeePenContribnsNotPaid` Value of employee pension contributions that are not paid under 'net pay arrangements', including any AVC	`number` double	`0.0`
`empeePenContribnsPaid` Value of employee pension contributions paid under 'net pay arrangements', including any AVC	`number` double	`0.0`
`attachmentOrderDeductions` Value of deductions made due to AttachmentOrders	`number` double	`0.0`
`cisDeduction` Value of any CIS Deduction made	`number` double	`0.0`
`cisVat` Value of any VAT paid to CIS Subcontractor	`number` double	`0.0`
`cisUmbrellaFee` Value of any pre-tax fee charged to the CIS Subcontractor for processing the payment	`number` double	`0.0`
`cisUmbrellaFeePostTax` Value of any post-tax fee charged to the CIS Subcontractor for processing the payment	`number` double	`0.0`
`pbik` Value of any Payrolled Benefits In Kind	`number` double	`0.0`
`mapsMiles` The number of miles paid for Mileage Allowance Payments	`integer` int32	`0`
`foreignTaxAmount` The amount paid for Foreign Tax Credits in this period	`number` double	`0.0`
`foreignTaxAmountReclaimed` The amount of Foreign Tax Credits that you actually reclaimed	`number` double	`0.0`
`umbrellaFee` Value of any Umbrella fee charged for processing the payment	`number` double	`0.0`
`appLevyDeduction` Value of any Apprenticeship Levy fee deducted for processing the umbrella payment	`number` double	`0.0`
`paymentAfterLeaving` Payment After Leaving	`number` double	`0.0`
`taxOnPaymentAfterLeaving` Tax On Payment After Leaving	`number` double	`0.0`
`nilPaid` The number of employees with NilPaid on the PayRun	`integer` int32	`0`
`leavers` The number of Leavers on ths PayRun	`integer` int32	`0`
`starters` The number of Starters on this PayRun	`integer` int32	`0`
`p45Gross` The value P45 Gross which is held on the Employees Opening Balance	`number` double	`0.0`
`p45Tax` The value of P45 Tax which is held on the Employees Opening Balance	`number` double	`0.0`
`totalCost`	`number` double	`0.0`
`recoverableAmounts`	`RecoverableAmounts`	`{RecoverableAmounts}`

JSON Example

{
  "basicPay": 0.0,
  "gross": 0.0,
  "grossForNi": 0.0,
  "grossForNiNonRti": 0.0,
  "grossNotSubjectToEmployersNi": 0.0,
  "grossNotSubjectToEmployersNiNonRti": 0.0,
  "grossForTax": 0.0,
  "employerNi": 0.0,
  "employerNiNonRti": 0.0,
  "employeeNi": 0.0,
  "employeeNiNonRti": 0.0,
  "employerNiOffPayroll": 0.0,
  "realTimeClass1ANi": 0.0,
  "realTimeClass1ANiNonRti": 0.0,
  "tax": 0.0,
  "taxNonRti": 0.0,
  "netPay": 0.0,
  "adjustments": 0.0,
  "notionalPay": 0.0,
  "additions": 0.0,
  "deductions": 0.0,
  "takeHomePay": 0.0,
  "nonTaxOrNICPmt": 0.0,
  "itemsSubjectToClass1NIC": 0.0,
  "dednsFromNetPay": 0.0,
  "tcp_Tcls": 0.0,
  "tcp_Pp": 0.0,
  "tcp_Op": 0.0,
  "flexiDd_Death": 0.0,
  "flexiDd_Death_NonTax": 0.0,
  "flexiDd_Pension": 0.0,
  "flexiDd_Pension_NonTax": 0.0,
  "flexiDd_SeriousIllHealth": 0.0,
  "flexiDd_SeriousIllHealth_NonTax": 0.0,
  "smp": 0.0,
  "smpNonRti": 0.0,
  "spp": 0.0,
  "sppNonRti": 0.0,
  "sap": 0.0,
  "sapNonRti": 0.0,
  "shpp": 0.0,
  "shppNonRti": 0.0,
  "spbp": 0.0,
  "spbpNonRti": 0.0,
  "ssp": 0.0,
  "sspNonRti": 0.0,
  "studentLoanRecovered": 0.0,
  "studentLoanRecoveredNonRti": 0.0,
  "postgradLoanRecovered": 0.0,
  "postgradLoanRecoveredNonRti": 0.0,
  "pensionableEarnings": 0.0,
  "pensionablePay": 0.0,
  "nonTierablePay": 0.0,
  "employeePensionContribution": 0.0,
  "employeePensionContributionAvc": 0.0,
  "employerPensionContribution": 0.0,
  "empeePenContribnsNotPaid": 0.0,
  "empeePenContribnsPaid": 0.0,
  "attachmentOrderDeductions": 0.0,
  "cisDeduction": 0.0,
  "cisVat": 0.0,
  "cisUmbrellaFee": 0.0,
  "cisUmbrellaFeePostTax": 0.0,
  "pbik": 0.0,
  "mapsMiles": 0,
  "foreignTaxAmount": 0.0,
  "foreignTaxAmountReclaimed": 0.0,
  "umbrellaFee": 0.0,
  "appLevyDeduction": 0.0,
  "paymentAfterLeaving": 0.0,
  "taxOnPaymentAfterLeaving": 0.0,
  "nilPaid": 0,
  "leavers": 0,
  "starters": 0,
  "p45Gross": 0.0,
  "p45Tax": 0.0,
  "totalCost": 0.0,
  "recoverableAmounts": {
    "taxMonth": 0,
    "smpRecovered": 0.0,
    "sppRecovered": 0.0,
    "sapRecovered": 0.0,
    "shPPRecovered": 0.0,
    "spbpRecovered": 0.0,
    "nicCompensationOnSMP": 0.0,
    "nicCompensationOnSPP": 0.0,
    "nicCompensationOnSAP": 0.0,
    "nicCompensationOnShPP": 0.0,
    "nicCompensationOnSPBP": 0.0,
    "cisDeductionsSuffered": 0.0,
    "total": 0.0
  }
}

References

Contained in Models
PayRun
PayRunEntry
Payslip

Consumed by Operations

- none -

Returned by Operations

- none -