PATCH | PUT /hr_api/v1/employments/:uuid

Updates an existing Employment

Params

Property Required Details Location

uuid

Must be a String

 URL

employee_uuid

Must be a String

 JSON

hire_date

Must be a Date

 JSON

original_hire_date

Must be a Date

 JSON

adjusted_hire_date

Must be a Date

 JSON

termination_date

Must be a Date

 JSON

last_date_worked

Must be a Date

 JSON

last_date_paid

Must be a Date

 JSON

is_on_leave

Must be one of: 0, 1.

'0': Not on leave
'1': On leave
JSON

is_terminated

Must be one of: 0, 1.

'0': Not terminated
'1': Terminated
JSON

termination_is_voluntary

Must be one of: 0, 1.

'0': Not voluntary
'1': Voluntary
JSON

termination_reason_uuid

Obtained from a separate TerminationReason request

Must be a String

 JSON

termination_reason_comments

Must be a String

 JSON

Examples

PUT /hr_api/v1/employments/:uuid
{
  "termination_reason_comments": null
}
200
{
  "message": "Employment updated successfully",
  "employment": {
    "uuid": "d724cd8d-afb2-403f-bea4-cccab7207f5f",
    "hire_date": "2016-01-01T00:00:00.000+00:00",
    "original_hire_date": "2016-01-01T00:00:00.000+00:00",
    "adjusted_hire_date": "2016-01-01T00:00:00.000+00:00",
    "is_on_leave": false,
    "is_terminated": true,
    "termination_is_voluntary": true,
    "termination_reason_comments": "TEST",
    "termination_date": "2016-02-02T00:00:00.000+00:00",
    "last_date_worked": "2016-02-02T00:00:00.000+00:00",
    "last_date_paid": null,
    "employee_id_string": "123456",
    "employee": {
      "uuid": "737c1dd0-4134-4743-849d-8e38d0e11644"
    },
    "keyword_type": "ReasonForLeaving",
    "keyword_id": null,
    "termination_reason": {
      "uuid": "5e4405f6-532c-46be-a72a-8b372803525b"
    },
    "category_code": "reaon_for_leaving",
    "comments": "<p>comment for test reason for leaving</p>",
    "sort": 100,
    "category_status": "active",
    "category_description": "test reason for leaving keyword"
  }
}