API Reference

Terminates the specified employee.

post
https://api.worklio.com/wep/companies//employees//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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Identifier of the company that owns the employee.

int32
required

Identifier of the employee to terminate.

Body Params

Employee termination payload.

Employee termination.

date-time | null
required

Termination Date. Data type is validated and must be Number

date-time | null

Time Off Rule End Date. Data type is validated and must be Number

date-time | null

Net Pay End Date. Data type is validated and must be Number

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. )
int32 | null

Id of CustomTerminationReason

int32
enum

Members:

  • 0 - EndOfMonth ( End Of Month. )
  • 1 - TerminationDate ( Termination Date. )
Allowed:
boolean | null

If true, remove employee from org chart.

Headers
string
Defaults to 1.0

The requested API version

string
Defaults to 1.0

The requested API version

string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response
204

No Content

Updated 27 days ago

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 27 days ago