Set UI Unlock enabled

Sets whether a pay run can be unlocked by the UI or not. Only applies to finalized pay runs.

Request

POST https://apisg.yourpayroll.io/api/v2/business/{businessId}/payrun/{payRunId}/setuiunlockstate

Path parameters

Parameter name Value Description Additional
payRunId int32 Required
businessId string Required

Request body

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

{
    "enableUIUnlock": "boolean"
}

Properties

Name Type Description
enableUIUnlock boolean Boolean

Response

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

Status code Description Resource
200 OK

OK