Update Employments
/unified/hris/employments/{id}
Path Parameters
The ID of the resource.
23423523Query Parameters
Refer Specifying query parameters in Truto APIs
The company to use, referencing companies.id. Optional: when omitted the account's company is looked up automatically. The request fails if the account can see more than one company and none is given.
1 supported
Flat alternative to company.id.
1 supported
The employee (employees.id, the Omni user id) whose job record to change. Required: Omni HR only exposes this per employee (the user id is part of the path). Exactly one employee: employee_id=, employee[id]=, [eq] or [in] with one id, or a one-element array. Several different ids, any other operator or a non-integer id is refused with a 400 (Omni HR has no multi-employee endpoint).
1 supported1 required
The unique identifier for employees
Flat alternative to employee.id (same forms).
1 supported
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount). When the upstream body exceeds 1 MiB,datais replaced by{ truto_truncated: true, truto_max_bytes, truto_excerpt }.debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
Excludes the remote_data attribute from the response.
Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barRequest Body
Refer Writing data using Unified APIs
Moves the record's effective date (Omni effective_date). Only the calendar date is sent; it must start with YYYY-MM-DD. An error after the update may mean the change was saved: Omni HR applies it first, then the record is read back, and that read can fail (for example when rate-limited). Check with employments get; repeating the same update is safe.
2 supported
The employment type. Omni's employment types are organisation-defined labels; the one option whose label means this value (DRAFT_NOTES §Enums, e.g. Full-time -> full_time) is sent. No single matching option is refused with a 400 before anything is written to Omni HR.
full_timepart_timecontractinternshiptemporarytraineevolunteerper_diemfull_timepart_timecontractinternshiptemporarytraineevolunteerper_diemfull_timepart_timecontractinternshiptemporarytraineevolunteerper_diem+ 12 more
2 supported
full_timepart_timecontractinternshiptemporarytraineevolunteerper_diemfull_timepart_timecontractinternshiptemporarytraineevolunteerper_diemThe termination date
1 supported
The name of an existing Omni position (job_roles.name), matched exactly (case-insensitive). A title that matches no position, or more than one, is refused with a 400 before anything is written to Omni HR; create the position first with job_roles create.
1 supported
Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.
Response Body
The unique identifier for employments
2 supported
This represents the date when the employments was created
Represents the effective date of the employment
2 supported
Employee associated with this employment
2 supported
The unique identifier for employees
The name of the employee
This represents the employment type
full_timepart_timecontractinternshiptemporarytraineevolunteerper_diem
2 supported
Represents the end date of the employment
1 supported
Represents why the employment ended
1 supported
This represents the flsa status
Job title of the employee
1 supported
This represents the pay currency
This represents the pay frequency
This represents the pay period
This represents the pay rate
Raw data returned from the remote API call.
This represents the date when the employments was updated
truto unified hris employments '<resource_id>' \
-m update \
-a '<integrated_account_id>' \
-b '{
"effective_date": "your_effective_date",
"end_date": "your_end_date",
"employment_type": "full_time",
"job_title": "your_job_title",
"remote_data": {}
}' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.update(
'hris',
'employments',
'<resource_id>',
{
"effective_date": "your_effective_date",
"end_date": "your_end_date",
"employment_type": "full_time",
"job_title": "your_job_title",
"remote_data": {}
},
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
result = await truto_api.unified_api.update(
"hris",
"employments",
"<resource_id>",
{
"effective_date": "your_effective_date",
"end_date": "your_end_date",
"employment_type": "full_time",
"job_title": "your_job_title",
"remote_data": {}
},
{"integrated_account_id": "<integrated_account_id>"}
)
print(result)
asyncio.run(main())curl -X PATCH 'https://api.truto.one/unified/hris/employments/{id}?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json' \
-d '{
"effective_date": "your_effective_date",
"end_date": "your_end_date",
"employment_type": "full_time",
"job_title": "your_job_title",
"remote_data": {}
}'const integratedAccountId = '<integrated_account_id>';
const body = {
"effective_date": "your_effective_date",
"end_date": "your_end_date",
"employment_type": "full_time",
"job_title": "your_job_title",
"remote_data": {}
};
const response = await fetch(`https://api.truto.one/unified/hris/employments/{id}?integrated_account_id=${integratedAccountId}`, {
method: 'PATCH',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
body: JSON.stringify(body),
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/hris/employments/{id}"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
payload = {
"effective_date": "your_effective_date",
"end_date": "your_end_date",
"employment_type": "full_time",
"job_title": "your_job_title",
"remote_data": {}
}
response = requests.patch(url, headers=headers, params=params, json=payload)
print(response.json())