PayRun

This model is right at the very heart of the software.
There is a PayRun for each period in which people are paid.

Name / Description Type / Format Example
taxYear string "Year2017" "Year2018" "Year2019" "Year2020"
taxMonth
The Tax Month that the Payment Date falls in
integer int32 0
payPeriod string "Custom" "Monthly" "FourWeekly" "Fortnightly" "Weekly" "Daily"
ordinal
Indicates whether this uses first, second, third (etc) PaySchedule for this PayPeriod.
integer int32 0
period
The period (ie, Tax Week or Tax Month) that this PayRun is for.
integer int32 0
startDate
The start date of the period this PayRun covers
string date "2020-07-13"
endDate
The end date of the period this PayRun covers
string date "2020-07-13"
paymentDate
The intended date that Employees will be paid, although this can be changed on a per PayRunEntry basis
string date "2020-07-13"
employeeCount
The number of Employees included in this PayRun (including any CIS Subcontractors)
integer int32 0
subContractorCount
The number of CIS Subcontractors included in this PayRun
integer int32 0
totals
Used to represent totals for a PayRun or PayRunEntry.
If a value is 0 then it will not be included.
PayRunTotals {PayRunTotals}
isClosed
Set to True if the PayRun is closed and changes can no longer be made to the PayRunEntries
boolean true
dateClosed string date-time "2020-07-13T23:01:07"
autoPilotCloseDate
If AutoPilot is enabled in the AutomationSettings for the Employer then this property will tell you when the payrun will be automatically closed
string date "2020-07-13"
entries
The PayRunEntries that make up this PayRun.
This is populate automatically when you start a PayRun.
Item[] {Item}
{
  "taxYear": "Year2017",
  "taxMonth": 0,
  "payPeriod": "Custom",
  "ordinal": 0,
  "period": 0,
  "startDate": "2020-07-13",
  "endDate": "2020-07-13",
  "paymentDate": "2020-07-13",
  "employeeCount": 0,
  "subContractorCount": 0,
  "totals": {
    "basicPay": 0.0,
    "gross": 0.0,
    "grossForNi": 0.0,
    "grossForTax": 0.0,
    "employerNi": 0.0,
    "employeeNi": 0.0,
    "realTimeClass1ANi": 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,
    "cisUmbrellaFeePostTax": 0.0,
    "pbik": 0.0,
    "mapsMiles": 0,
    "umbrellaFee": 0.0,
    "appLevyDeduction": 0.0,
    "totalCost": 0.0
  },
  "isClosed": true,
  "dateClosed": "2020-07-13T23:01:07",
  "autoPilotCloseDate": "2020-07-13",
  "entries": [
    {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    }
  ]
}
Contained in Models
HmrcLiability
PaySchedule
Consumed by Operations

- none -

Getting Started The Ordinal property
Completing a Payrun Start the PayRun
Completing a Payrun Review the PayRun
Completing a Payrun Finalise the PayRun
Completing a Payrun Get Accounting Entries