Now that you have set your PaySchedules you are ready to start your first PayRun .
Get your list of PaySchedules
or if you know what PayPeriod you want to process
get just the PaySchedule for that period
.
Any PaySchedule where isRequired is true and
hasOpenPayRunPeriod is false
is ready to have a PayRun started.
isRequired property is true and hasOpenPayRunPeriod is false, so we know we are ready to start a pay run{
"taxYear": "Year2018",
"payPeriod": "Monthly",
"firstPeriodEndDate": "2018-04-30",
"firstPaymentDate": "2018-05-01",
"hasOpenPayRunPeriod": false,
"employeeCount": 1,
"isRequired": true,
"isConfigured": true,
"isYearCompleted": false,
"yearEndTasks": [
"Complete outstanding Monthly Pay Runs"
],
"nextPayRun": {
"taxYear": "Year2018",
"payPeriod": "Monthly",
"period": 1,
"startDate": "2018-03-30",
"endDate": "2018-04-30",
"paymentDate": "2018-05-01",
"employeeCount": 0,
"isClosed": false
}
}
There's a fair amount of information included in the PaySchedule .
The nextPayRun and employeeCount properties give you useful information about the PayRun you are about to start.
But you don't have to do anything with this information.
All that's required to start the PayRun is a a simple POST to the relevant URL containing the year and PayPeriod in the path.