HRIS
- Overview
- Use Cases
Common Guides
API Reference
- Companies
- Custom Field Definitions
- Employees
- GETList Employees
- POSTCreates an employee
- GETGet Employee
- PATCHUpdates an employee
- POSTInvite Employee
- Time Off
- Documents
- Work Eligibility
- Time Off Balances
- Employments
- Skills
- Time Off Policies
- Tasks
- GET
- Documents
- Employments
- Locations
- Time Off
- Time Entries
- Benefits
- Groups
- Jobs
- Time Off Policies
Employments
Create Employee Employment
POST
/
unified
/
hris
/
employees
/
{id}
/
employments
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",
"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
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Headers
The account identifier
Path Parameters
Body
application/json
Response
201
application/json
The employee employment was created successfully.
The response is of type object
.
Was this page helpful?
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",
"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"
}
}
Assistant
Responses are generated using AI and may contain mistakes.