Finalises the specified pay run. A pay run can only be finalised if there are no calculations in progress.
POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/payrun/{payRunId}/finalise
Parameter name | Value | Description | Additional |
---|---|---|---|
payRunId | int32 | Required | |
businessId | string | Required |
The request body takes a complete FinalisePayRunOptions resource, containing the following writable properties:
{
"datePaid": "date-time",
"exportJournals": "boolean",
"lodgeFinalPayRun": "boolean",
"lodgePayRun": "boolean",
"lodgePayRunInTestMode": "boolean",
"payRunId": "int32",
"publishPaySlips": "string",
"publishPaySlipsDateTime": "date-time",
"relodgeHmrcLateSubmissionReason": "string",
"relodgeSelectedEmployeesOnly": "boolean",
"submitToPensionSync": "boolean",
"suppressNotifications": "boolean"
}
Name | Type | Description |
---|---|---|
datePaid | date-time |
Nullable |
exportJournals | boolean | Boolean |
lodgeFinalPayRun | boolean | Boolean |
lodgePayRun | boolean | Boolean |
lodgePayRunInTestMode | boolean | Boolean |
payRunId | int32 | Int32 |
publishPaySlips | string |
PublishPaySlipsPreference
Possible values are:
|
publishPaySlipsDateTime | date-time |
Nullable |
relodgeHmrcLateSubmissionReason | string |
Nullable Possible values are:
|
relodgeSelectedEmployeesOnly | boolean | Boolean |
submitToPensionSync | boolean | Boolean |
suppressNotifications | boolean | Boolean |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
PayRunFinaliseResult |
Powered by DapperDox