PayRunTotals

Used to represent totals for a PayRun or PayRunEntry.
If a value is 0 then it will not be included.

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
grossForTax
The amount of the Gross that is subject to PAYE
number double 0.0
employerNi number double 0.0
employeeNi number double 0.0
tax 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
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
smp
Statutory Maternity Pay
number double 0.0
spp
Statutory Paternity Pay
number double 0.0
sap
Statutory Adoption Pay
number double 0.0
shpp
Statutory Shared Parental Pay
number double 0.0
spbp
Statutory Parental Bereavement Pay
number double 0.0
studentLoanRecovered number double 0.0
postgradLoanRecovered number double 0.0
pensionablePay
The amount of the Gross that is pensionable
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 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
totalCost number double 0.0
{
  "basicPay": 0.0,
  "gross": 0.0,
  "grossForNi": 0.0,
  "grossForTax": 0.0,
  "employerNi": 0.0,
  "employeeNi": 0.0,
  "tax": 0.0,
  "netPay": 0.0,
  "adjustments": 0.0,
  "takeHomePay": 0.0,
  "nonTaxOrNICPmt": 0.0,
  "itemsSubjectToClass1NIC": 0.0,
  "dednsFromNetPay": 0.0,
  "smp": 0.0,
  "spp": 0.0,
  "sap": 0.0,
  "shpp": 0.0,
  "spbp": 0.0,
  "studentLoanRecovered": 0.0,
  "postgradLoanRecovered": 0.0,
  "pensionablePay": 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,
  "pbik": 0.0,
  "mapsMiles": 0,
  "totalCost": 0.0
}
Contained in Models
PayRun
PayRunEntry
Payslip
Consumed by Operations

- none -

Returned by Operations

- none -