Unlocks the specified pay run.

Request

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

Path parameters

Parameter name Value Description Additional
businessId string Required
payRunId string Required

Request body

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

{
    "comments": "string",
    "payRunId": "int32"
}

Properties

Name Type
comments string
payRunId int32

Response

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

Status code Description Resource
200 OK

OK