PaySchedule

Name / Description Type / Format Example
name
A descriptive name for this PaySchedule
string "string"
ordinal
Indicates whether this is first, second, third (etc) PaySchedule for this PayPeriod.
integer int32 0
taxYear string "Year2017" "Year2018" "Year2019" "Year2020"
payPeriod string "Monthly" "FourWeekly" "Fortnightly" "Weekly" "Daily" "Custom"
firstPeriodEndDate
The last day of the first pay period
string date "2020-07-09"
firstPaymentDate
The first payment date
string date "2020-07-09"
paymentDateType string "SameDate" "LastDay" "LastWeekday" "LastXxxday"
periodLengths
Only applicable for PayPeriod of Custom. Defines the length of each period
integer[]
hasOpenPayRunPeriod
Will be true if the employer currently has an open PayRun for this PayPeriod
boolean true
lastPeriodEndDate
The end date of the most recent PayRun on this schedule
string date "2020-07-09"
lastPeriodNumber
The period number of the most recent PayRun on this schedule
integer int32 0
employeeCount
The number of employees paid with this PaySchedule
integer int32 0
isRequired
Whether or not this PaySchedule is required for the employer, ie: they have employees to be paid on this PaySchedule
boolean true
isConfigured
Whether or not this PaySchedule has been configured and is ready for use
boolean true
isYearCompleted
Returns true if all PayRuns for this PaySchedule in the TaxYear have been completed
boolean true
yearEndTasks
A list of actions that need to be completed for this PaySchedule before this TaxYear can be finalised
string[]
payRuns
Details of PayRuns for this PaySchedule
Item[] {Item}
currentPayRun Item {Item}
nextPayRun
This model is right at the very heart of the software.
There is a PayRun for each period in which people are paid.
PayRun {PayRun}
{
  "name": "string",
  "ordinal": 0,
  "taxYear": "Year2017",
  "payPeriod": "Monthly",
  "firstPeriodEndDate": "2020-07-09",
  "firstPaymentDate": "2020-07-09",
  "paymentDateType": "SameDate",
  "periodLengths": [
    0
  ],
  "hasOpenPayRunPeriod": true,
  "lastPeriodEndDate": "2020-07-09",
  "lastPeriodNumber": 0,
  "employeeCount": 0,
  "isRequired": true,
  "isConfigured": true,
  "isYearCompleted": true,
  "yearEndTasks": [
    "string"
  ],
  "payRuns": [
    {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    }
  ],
  "currentPayRun": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "nextPayRun": {
    "taxYear": "Year2017",
    "taxMonth": 0,
    "payPeriod": "Monthly",
    "ordinal": 0,
    "period": 0,
    "startDate": "2020-07-09",
    "endDate": "2020-07-09",
    "paymentDate": "2020-07-09",
    "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-09T23:59:14",
    "autoPilotCloseDate": "2020-07-09",
    "entries": [
      {
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      }
    ]
  }
}
Contained in Models

- none -

Consumed by Operations
Update PaySchedule
Returned by Operations
Get PaySchedule
Update PaySchedule
Getting Started The Ordinal property
Completing a Payrun Set a Schedule
Completing a Payrun Start the PayRun