PaySchedule

Name / Description Type / Format Example
taxYear
The TaxYear that this PaySchedule is for
string "Year2017" "Year2018" "Year2019" "Year2020"
payPeriod
The PayPeriod (ie, Weekly, Monthly) that this PaySchedule is for
string "Monthly" "FourWeekly" "Fortnightly" "Weekly"
firstPeriodEndDate
The last day of the first pay period
string date-time "2019-11-19T20:44:19"
firstPaymentDate
The first payment date
string date-time "2019-11-19T20:44:19"
paymentDateType
Only for Monthly PayPeriods. Determines how the PaymentDate is calculated for later periods.
string "SameDate" "LastDay" "LastWeekday" "LastXxxday"
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-time "2019-11-19T20:44:19"
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[] ["string"]
payRuns
Details of PayRuns for this PaySchedule
Item[] {Item}
currentPayRun Item {Item}
nextPayRun PayRun {PayRun}
{
  "taxYear": "Year2017",
  "payPeriod": "Monthly",
  "firstPeriodEndDate": "2019-11-19T20:44:19",
  "firstPaymentDate": "2019-11-19T20:44:19",
  "paymentDateType": "SameDate",
  "hasOpenPayRunPeriod": true,
  "lastPeriodEndDate": "2019-11-19T20:44:19",
  "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",
    "period": 0,
    "startDate": "2019-11-19T20:44:19",
    "endDate": "2019-11-19T20:44:19",
    "paymentDate": "2019-11-19T20:44:19",
    "employeeCount": 0,
    "subContractorCount": 0,
    "totals": {
      "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
    },
    "isClosed": true,
    "dateClosed": "2019-11-19T20:44:19",
    "autoPilotCloseDate": "2019-11-19T20:44:19",
    "entries": [
      {
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      }
    ]
  }
}
Contained in Models

- none -

Consumed by Operations
Update PaySchedule
Completing a Payrun Set a Schedule
Completing a Payrun Start the PayRun