PaySchedule

Schema

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" "Year2021" "Year2022" "Year2023" "Year2024"
payPeriod string "Custom" "Monthly" "FourWeekly" "Fortnightly" "Weekly" "Daily"
firstPeriodEndDate
The last day of the first pay period
 string date "2024-12-22"
firstPaymentDate
The first payment date
 string date "2024-12-22"
paymentDateType string "SameDate" "LastDay" "LastWeekday" "LastXxxday" "SameDateWorkingDay" "SecondXxxday" "ThirdXxxday" "FourthXxxday" "SecondToLastXxxday" "ThirdToLastXxxday"
periodEndDateType string "SameDate" "LastDay" "LastWeekday" "LastXxxday" "SameDateWorkingDay" "SecondXxxday" "ThirdXxxday" "FourthXxxday" "SecondToLastXxxday" "ThirdToLastXxxday"
periodLengths
Only applicable for PayPeriod of Custom. Defines the length of each period
 integer[]
highGrossPay
A gross pay amount considered high for this PaySchedule
 number double 0.0
highNetPay
A net pay amount considered high for this PaySchedule
 number double 0.0
periodEventsConfig
Only applicable if Bureau functionality is enabled. Defines the number of days each event occurs before the Payment Date.
 object {object}
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 "2024-12-22"
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}
publicCreatedDate string date "2024-12-22"

JSON Example 

{
  "name": "string",
  "ordinal": 0,
  "taxYear": "Year2017",
  "payPeriod": "Custom",
  "firstPeriodEndDate": "2024-12-22",
  "firstPaymentDate": "2024-12-22",
  "paymentDateType": "SameDate",
  "periodEndDateType": "SameDate",
  "periodLengths": [
    0
  ],
  "highGrossPay": 0.0,
  "highNetPay": 0.0,
  "periodEventsConfig": {},
  "hasOpenPayRunPeriod": true,
  "lastPeriodEndDate": "2024-12-22",
  "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": "Custom",
    "ordinal": 0,
    "period": 0,
    "startDate": "2024-12-22",
    "endDate": "2024-12-22",
    "paymentDate": "2024-12-22",
    "employeeCount": 0,
    "subContractorCount": 0,
    "nonRtiEmployeeCount": 0,
    "totals": {
      "basicPay": 0.0,
      "gross": 0.0,
      "grossForNi": 0.0,
      "grossForNiNonRti": 0.0,
      "grossNotSubjectToEmployersNi": 0.0,
      "grossNotSubjectToEmployersNiNonRti": 0.0,
      "grossForTax": 0.0,
      "employerNi": 0.0,
      "employerNiNonRti": 0.0,
      "employeeNi": 0.0,
      "employeeNiNonRti": 0.0,
      "employerNiOffPayroll": 0.0,
      "realTimeClass1ANi": 0.0,
      "realTimeClass1ANiNonRti": 0.0,
      "tax": 0.0,
      "taxNonRti": 0.0,
      "netPay": 0.0,
      "adjustments": 0.0,
      "notionalPay": 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,
      "flexiDd_SeriousIllHealth": 0.0,
      "flexiDd_SeriousIllHealth_NonTax": 0.0,
      "smp": 0.0,
      "smpNonRti": 0.0,
      "spp": 0.0,
      "sppNonRti": 0.0,
      "sap": 0.0,
      "sapNonRti": 0.0,
      "shpp": 0.0,
      "shppNonRti": 0.0,
      "spbp": 0.0,
      "spbpNonRti": 0.0,
      "ssp": 0.0,
      "sspNonRti": 0.0,
      "studentLoanRecovered": 0.0,
      "studentLoanRecoveredNonRti": 0.0,
      "postgradLoanRecovered": 0.0,
      "postgradLoanRecoveredNonRti": 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,
      "foreignTaxAmount": 0.0,
      "foreignTaxAmountReclaimed": 0.0,
      "umbrellaFee": 0.0,
      "appLevyDeduction": 0.0,
      "paymentAfterLeaving": 0.0,
      "taxOnPaymentAfterLeaving": 0.0,
      "nilPaid": 0,
      "leavers": 0,
      "starters": 0,
      "p45Gross": 0.0,
      "p45Tax": 0.0,
      "totalCost": 0.0,
      "recoverableAmounts": {
        "taxMonth": 0,
        "smpRecovered": 0.0,
        "sppRecovered": 0.0,
        "sapRecovered": 0.0,
        "shPPRecovered": 0.0,
        "spbpRecovered": 0.0,
        "nicCompensationOnSMP": 0.0,
        "nicCompensationOnSPP": 0.0,
        "nicCompensationOnSAP": 0.0,
        "nicCompensationOnShPP": 0.0,
        "nicCompensationOnSPBP": 0.0,
        "cisDeductionsSuffered": 0.0,
        "total": 0.0
      }
    },
    "payslipScheduledDateTime": "2024-12-22",
    "state": "Opening",
    "isClosed": true,
    "isRolledBack": true,
    "dateClosed": "2024-12-22T03:03:08",
    "autoPilotCloseDate": "2024-12-22",
    "entries": [
      {
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      }
    ]
  },
  "publicCreatedDate": "2024-12-22"
}

References

Contained in Models

- none -

Consumed by Operations
Create a PaySchedule (deprecated)
Update PaySchedule (deprecated)
Create a PaySchedule
Update PaySchedule
Returned by Operations
Get PaySchedule (deprecated)
Update PaySchedule (deprecated)
Get PaySchedule
Update PaySchedule
Getting Started The Ordinal property
Completing a Pay Run Set a Schedule
Completing a Pay Run Start the PayRun