Pay Run Job Instruction
The Pay Run Job Instruction is used to enqueue a payroll calculation for a particular pay schedule.
PayRunJobInstruction [Schema]
Name | Type | Required | Description |
---|---|---|---|
HoldingDate | xsd:dateTime | no | Optional date, used to defer execution of the job until a future point in time. |
PaymentDate | xsd:date | yes | The date you intend to pay employees, also used to determine the tax reporting period. |
StartDate | xsd:date | yes | The pay period start date. |
EndDate | xsd:date | yes | The pay period end date. |
PaySchedule | Link | yes | The link to the pay schedule resource that should be used for the pay run. |
IsSupplementary | xsd:boolean | no | Flag to indicate if the pay run should be treated as supplementary. Default is false. |
Employees | Link (list of) |
no | Optional distinct list of employees to include in the pay run. Note the employees must be from the associated pay schedule. |
Example
<?xml version="1.0"?>
<PayRunJobInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<HoldingDate>2021-01-26T00:00:00+00:00</HoldingDate>
<PaymentDate>2021-01-26</PaymentDate>
<StartDate>2021-01-26</StartDate>
<EndDate>2021-01-26</EndDate>
<PaySchedule title="string" href="string" rel="string" />
<IsSupplementary>true</IsSupplementary>
<Employees />
</PayRunJobInstruction>
{
"PayRunJobInstruction": {
"HoldingDate": "2021-01-26T00:00:00+00:00",
"PaymentDate": "2021-01-26",
"StartDate": "2021-01-26",
"EndDate": "2021-01-26",
"PaySchedule": {
"@title": "string",
"@href": "string",
"@rel": "string"
},
"IsSupplementary": "true",
"Employees": { "Employee": [] }
}
}