Skip to main content
DELETE
Remove a former employee from an open pay run

Authorizations

X-Auth-Token
string
header
required

Access token obtained from OAuth2 client credentials flow

X-Org-Id
string
header
required

Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically).

Path Parameters

payrollConfigId
string
required

The ID of the payroll configuration

year
integer
required

The year in format yyyy

Example:

2026

period
string
required

The period in format mm

Example:

"1"

employeeId
string
required

The former employee to remove

Response

The former employee was removed, or was not on the pay run

message
object
content
object
validationIssues
object[]
messageToken
string