Terminate Employee in Pay Run

Terminates an employee in the specified pay run.

Request

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

Path parameters

Parameter name Value Description Additional
payRunId int32 Required
businessId string Required

Request body

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

{
    "employeeId": "int32",
    "terminationDate": "date-time",
    "terminationReason": "string"
}

Properties

Name Type Description
employeeId int32 Int32
terminationDate date-time Nullable
terminationReason string String

Response

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

Status code Description Resource
200 OK

OK