v1

latestOpenAPI 3.1.02026-07-1274177461.2 KB

Employees

Employments

Update Employee Employment

patch/unified/hris/employees/{id}/employments/{subResourceId}

Path parameters

idstring required

subResourceIdstring required

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

unified_custom_fieldsobject nullable

Custom Unified Fields configured in your StackOne project

job_titlestring nullable

The job title of the employee

pay_ratestring nullable

The amount of compensation for the employee

pay_currencystring nullable

The currency used for pay

effective_datestring date-time nullable

The effective date of the employment contract

end_datestring date-time nullable

The end date of employment

payroll_codestring nullable

The payroll code of the employee

passthroughobject nullable

Value to pass through to the provider

Example request

{
  "unified_custom_fields": {
    "my_project_custom_field_1": "REF-1236",
    "my_project_custom_field_2": "some other value"
  },
  "job_title": "Software Engineer",
  "pay_rate": "40.00",
  "pay_currency": "USD",
  "effective_date": "2021-01-01T01:01:01.000Z",
  "end_date": "2021-01-01T01:01:01.000Z",
  "grade": {
    "id": "1687-3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "name": "1687-4",
    "description": "Mid-level employee demonstrating proficiency and autonomy."
  },
  "type": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "label": "Permanent"
  },
  "contract_type": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "label": "Full-Time"
  },
  "work_time": {
    "duration": "P0Y0M0DT8H0M0S",
    "period": {
      "value": "month"
    }
  },
  "payroll_code": "PC1",
  "passthrough": {
    "other_known_names": "John Doe"
  }
}

Response

The employee employment was updated successfully.

statusCodenumber required

messagestring required

timestampstring date-time required

Example response

{
  "statusCode": 200,
  "message": "Record updated successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z"
}