Unlock Pay Run

Unlocks the specified pay run.

Request

POST https://api.nzpayroll.co.nz/api/v2/business/{businessId}/payrun/{payRunId}/unlock

Path parameters

Parameter name Value Description Additional
payRunId int32 Required
businessId string Required

Request body

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

{
    "comments": "string"
}

Properties

Name Type Description
comments string String

Response

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

Status code Description Resource
200 OK

OK