Finalises the specified pay run. A pay run can only be finalised if there are no calculations in progress.

Request

POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/payrun/{payRunId}/finalise

Path parameters

Parameter name Value Description Additional
businessId string Required
payRunId string Required

Request body

The request body takes a complete PayRunFinaliseRequest resource, containing the following writable properties:

{
    "datePaid": "date-time",
    "payRunId": "int32"
}

Properties

Name Type
datePaid date-time
payRunId int32

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK