Terminates the specified employee.

post

https://example.com/wep/companies/{companyId}/employees/{employeeId}/terminate

Access: System, Admin, and ClientAdmin users only.

The termination payload controls the effective termination date and optional downstream handling such as deduction coverage end date, org-chart removal, and custom termination reason selection.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

int32

required

Identifier of the company that owns the employee.

employeeId

int32

required

Identifier of the employee to terminate.

Body Params

Employee termination payload.

Request payload used to terminate an employee.

terminationDate

date-time | null

required

Effective termination date in yyyy-MM-dd format. Required.
Data type is validated and must be Number

timeOffRuleEndDate

date-time | null

Optional date when time-off rule processing should end for the employee.
Data type is validated and must be Number

netPayEndDate

date-time | null

Optional date when net-pay processing should end for the employee.
Data type is validated and must be Number

terminationReason

int32

enum

Members:

0 - NotSpecified ( Not Specified. )
1 - NewOportunity ( New oportunity. )
2 - PersonalReasons ( Personal reasons. )
3 - ReturningToSchool ( Returning to school. )
101 - Restructure ( Restructure. )
102 - PositionElimination ( Position Elimination. )
103 - Performance ( Performance. )
104 - Conduct ( Conduct. )
200 - Custom ( Custom. )
255 - ClientTermination ( Client Termination. )

customTerminationReasonId

int32 | null

Identifier of the custom termination reason. Required when Worklio.ApiModels.API.Models.Clients.Employee.EmployeeTerminate_v10.TerminationReason is Custom.

deductionCoverageEndDate

int32

enum

Members:

0 - EndOfMonth ( End Of Month. )
1 - TerminationDate ( Termination Date. )
2 - DefaultFromPlan ( Default From Plan. )

Allowed:

removeFromOrgChart

boolean | null

When true, the employee should also be removed from the organization chart.

Headers

api-version

string

required

Defaults to 2.0

The requested API version

x-api-version

string

Defaults to 2.0

The requested API version

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

204

No Content