POST
/
unified
/
hris
/
employees
/
{id}
/
employments
Create Employee Employment
curl --request POST \
  --url https://api.stackone.com/unified/hris/employees/{id}/employments \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '{
  "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_period": "monthly",
  "pay_frequency": "hourly",
  "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."
  },
  "employment_type": "permanent",
  "employment_contract_type": "full_time",
  "type": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "label": "Permanent",
    "type": "permanent"
  },
  "contract_type": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "label": "Full-Time",
    "contract_type": "full_time"
  },
  "work_time": {
    "duration": "P0Y0M0DT8H0M0S",
    "duration_unit": "month"
  },
  "payroll_code": "PC1",
  "job_id": "5290",
  "passthrough": {
    "other_known_names": "John Doe"
  }
}'
{
  "statusCode": 201,
  "message": "Record created successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
x-account-id
string
required

The account identifier

Path Parameters

​
id
string
required

Body

application/json
​
unified_custom_fields
object | null

Custom Unified Fields configured in your StackOne project

Example:
{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}
​
job_title
string | null

The job title of the employee

Example:

"Software Engineer"

​
pay_rate
string | null

The pay rate for the employee

Example:

"40.00"

​
pay_period
object

The pay period

Example:

"monthly"

​
pay_frequency
object

The pay frequency

Example:

"hourly"

​
pay_currency
string | null

The currency used for pay

Example:

"USD"

​
effective_date
string<date-time> | null

The effective date of the employment contract

Example:

"2021-01-01T01:01:01.000Z"

​
end_date
string<date-time> | null

The end date of employment

Example:

"2021-01-01T01:01:01.000Z"

​
grade
object

Represents the employee’s position within the organizational hierarchy.

​
employment_type
object
deprecated

The type of employment (e.g., contractor, permanent)

Example:

"permanent"

​
employment_contract_type
object
deprecated

The employment work schedule type (e.g., full-time, part-time)

Example:

"full_time"

​
type
object

The type of employment

​
contract_type
object

The employment work schedule type

​
work_time
object
​
payroll_code
string | null

The payroll code of the employee

Example:

"PC1"

​
job_id
string | null

The employee job id

Example:

"5290"

​
passthrough
object | null

Value to pass through to the provider

Example:
{ "other_known_names": "John Doe" }

Response

The employee employment was created successfully.

​
statusCode
number
required
Example:

201

​
message
string
required
Example:

"Record created successfully."

​
timestamp
string<date-time>
required
Example:

"2021-01-01T01:01:01.000Z"

​
data
object
required