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" "Year2021"
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 (i.e, 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 "2021-10-23"
endDate
The end date of the period this PayRun covers
string date "2021-10-23"
paymentDate
The intended date that Employees will be paid, although this can be changed on a per PayRunEntry basis
string date "2021-10-23"
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 shown in the JSON.
PayRunTotals {PayRunTotals}
state
The state of the payrun. You would set this value when updating a payrun to finalise or re-open it.
Other states are used with Bureau functionality which isn't currently generally available.
string "Open" "SubmittedForProcessing" "Processing" "AwaitingApproval" "Approved" "Finalised"
isClosed
Set to True if the PayRun is Finalised and changes can no longer be made
boolean true
dateClosed string date-time "2021-10-23T02:05:51"
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 "2021-10-23"
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": "2021-10-23",
  "endDate": "2021-10-23",
  "paymentDate": "2021-10-23",
  "employeeCount": 0,
  "subContractorCount": 0,
  "totals": {
    "basicPay": 0.0,
    "gross": 0.0,
    "grossForNi": 0.0,
    "grossForTax": 0.0,
    "employerNi": 0.0,
    "employeeNi": 0.0,
    "employerNiOffPayroll": 0.0,
    "realTimeClass1ANi": 0.0,
    "tax": 0.0,
    "netPay": 0.0,
    "adjustments": 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,
    "smp": 0.0,
    "spp": 0.0,
    "sap": 0.0,
    "shpp": 0.0,
    "spbp": 0.0,
    "ssp": 0.0,
    "studentLoanRecovered": 0.0,
    "postgradLoanRecovered": 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,
    "umbrellaFee": 0.0,
    "appLevyDeduction": 0.0,
    "paymentAfterLeaving": 0.0,
    "taxOnPaymentAfterLeaving": 0.0,
    "nilPaid": 0,
    "leavers": 0,
    "starters": 0,
    "totalCost": 0.0
  },
  "state": "Open",
  "isClosed": true,
  "dateClosed": "2021-10-23T02:05:51",
  "autoPilotCloseDate": "2021-10-23",
  "entries": [
    {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    }
  ]
}
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