Skip to content
POST /unified/hris/employments

Partial response — use the "get" endpoint for the full object.

Query Parameters

Refer Specifying query parameters in Truto APIs

companyobject

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
7shifts
supported
idstring
required
company_idstring

Flat alternative to company.id.

1 supported
7shifts
supported
Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns 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.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). When the upstream body exceeds 1 MiB, data is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }. debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstreamdebug
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_enforce_write_schemaboolean

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.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body

Refer Writing data using Unified APIs

effective_datestring · date-time

Contract start date

2 supported1 required
PayFit
required
7shifts
supported
employeeobject

The employee (employees.id). France only.

References: Employees → id
2 supported2 required
7shifts
required
PayFit
required
idstring

The unique identifier for employees

namestring

The name of the employee

employment_typestring

contract is stored as a 7shifts contractor record, anything else as an employee record.

Possible values:
full_timepart_timecontractinternshiptemporarytraineevolunteerper_diemfull_timepart_timecontractinternship+ 4 more
1 supported
7shifts
supported
full_timepart_timecontractinternshiptemporarytraineevolunteerper_diem
end_datestring · date-time

The termination date

1 supported
7shifts
supported
job_titlestring

Job title of the contract

1 supported1 required
PayFit
required
remote_dataRecord<string, any>

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

idstring
required·

The unique identifier for employments

1 supported
7shifts
supported
created_atstring · date-time

This represents the date when the employments was created

effective_datestring · date-time

Represents the effective date of the employment

1 supported
7shifts
supported
employeeobject

Employee associated with this employment

References: Employees → id
1 supported
7shifts
supported
idstring

The unique identifier for employees

namestring

The name of the employee

employment_typestring

This represents the employment type

Possible values:
full_timepart_timecontractinternshiptemporarytraineevolunteerper_diem
1 supported
7shifts
supported
end_datestring · date-time

Represents the end date of the employment

1 supported
7shifts
supported
end_reasonstring

Represents why the employment ended

flsa_statusstring

This represents the flsa status

job_titlestring

Job title of the employee

pay_currencystring

This represents the pay currency

pay_frequencystring

This represents the pay frequency

pay_groupstring

This represents the pay group

References: PayGroups → id
pay_periodstring

This represents the pay period

pay_ratenumber

This represents the pay rate

remote_dataRecord<string, any>

Raw data returned from the remote API call.

updated_atstring · date-time

This represents the date when the employments was updated

truto unified hris employments \
  -m create \
  -a '<integrated_account_id>' \
  -b '{
  "employee": {},
  "effective_date": "your_effective_date",
  "end_date": "your_end_date",
  "employment_type": "full_time",
  "job_title": "your_job_title",
  "remote_data": {}
}' \
  -o json
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.create(
  'hris',
  'employments',
  {
  "employee": {},
  "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.create(
        "hris",
        "employments",
        {
        "employee": {},
        "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 POST 'https://api.truto.one/unified/hris/employments?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "employee": {},
  "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 = {
  "employee": {},
  "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?integrated_account_id=${integratedAccountId}`, {
  method: 'POST',
  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"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "employee": {},
    "effective_date": "your_effective_date",
    "end_date": "your_end_date",
    "employment_type": "full_time",
    "job_title": "your_job_title",
    "remote_data": {}
}

response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())