HRMS · People
Employees
Open a worker for their work relationships, right to work, compliance, talent profile, goals, reviews and offboarding. A rehire is a new relationship and the same person, which is what keeps continuous service right.
/api/hrms/employeesPublished as /api/v1/employeesOverview
| Package | HRMS |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold HRMS › Employees on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | hr.employees · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
19 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/employeesList employees
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_no": "EMP-000001",
"user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"worker_type": "text",
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"manager_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"hire_date": "2026-10-30",
"termination_date": "2026-10-30",
"pay_type": "salary",
"base_pay": "1250.00",
"currency": "USD"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/employees?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/employees/{id}Read one employees
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_no": "EMP-000001",
"user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"worker_type": "text",
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"manager_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"hire_date": "2026-10-30",
"termination_date": "2026-10-30",
"pay_type": "salary",
"base_pay": "1250.00",
"currency": "USD"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/employees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/employeesCreate a employees
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
employee_no | text | Yes | Employee number — Left blank, the platform allocates the next one from the number range. |
user_id | uuid | No | Signs in as — The user this person signs in with. Approvals that wait for them as their HRMS approver become theirs to decide once this is set. |
first_name | text | Yes | First name |
last_name | text | Yes | Last name |
email | text | No | Email — Their work email. One that already belongs to another current employee is refused. |
worker_type | text | No | Worker type |
position_id | uuid | No | Position |
manager_id | uuid | No | Manager — Who they report to. Leave empty for somebody at the top of the organisation chart. |
hire_date | date | Yes | Hire date |
pay_type | text | No | Pay type Allowed: salary hourly |
base_pay | numeric | No | Base pay (annual salary or hourly rate) |
currency | text | No | Pay currency — Leave empty for the company’s own currency. |
work_state | text | No | Work region — The state or region they work in. |
status | text | No | Status |
person_id | uuid | No | Same person as (rehire) — Hiring back somebody who left? Pick the person they were, so their history and service stay on one person. Leave empty for somebody new. |
pay_frequency | text | No | Paid — How often a payslip is due. A monthly salary is the annual base pay over twelve. |
work_country | text | No | Work country — Chooses how they are paid and taxed. Leave empty for the company’s own country. |
work_location_id | uuid | No | Work location — Where they work. Their punches are read in its time zone when a punch names no place. |
pay_group_id | uuid | No | Pay group — An active pay group of the country they work in. A change dated for later is a personnel action. |
resident_state | text | No | State of residence — Empty means the work state. A different state brings in reciprocity or the resident-state credit. |
work_locality | text | No | Work locality — The city, PSD or district they work in, for local tax. |
resident_locality | text | No | Home locality — Where they live. More than one (a school district as well) goes on Local Tax Assignments. |
holiday_calendar_id | uuid | No | Holiday calendar — The holidays their leave days, FMLA, attendance and holiday pay count. Empty (or the company default): their location’s, business unit’s or state’s calendar where there is one, else the default. |
uan | text | No | India statutory: UAN — The EPF Universal Account Number, twelve digits. |
basic_wage | numeric | No | Statutory pay: basic wage (monthly) — India: EPF is worked out on basic + DA; left empty, half the monthly gross is used. Saudi Arabia: GOSI is worked out on basic + housing; left empty, the monthly gross is used. |
dearness_allowance | numeric | No | India statutory: dearness allowance (monthly) |
hra | numeric | No | India statutory: house rent allowance (monthly) |
special_allowance | numeric | No | India statutory: special allowance (monthly) |
pt_state_code | text | No | India statutory: professional tax state — The state whose professional tax and labour welfare fund apply. Allowed: 01 Jammu and Kashmir 02 Himachal Pradesh 03 Punjab 04 Chandigarh 05 Uttarakhand 06 Haryana 07 Delhi 08 Rajasthan 09 Uttar Pradesh 10 Bihar 11 Sikkim 12 Arunachal Pradesh |
is_pf_applicable | boolean | No | India statutory: EPF applies |
is_esi_applicable | boolean | No | India statutory: ESI applies |
tax_regime | text | No | India statutory: income tax regime — New unless the employee has opted for the old regime this year. Allowed: new old |
housing_allowance | numeric | No | Saudi payroll: housing allowance (monthly) |
transport_allowance | numeric | No | Saudi payroll: transport allowance (monthly) — Counts toward the last wage an end-of-service award is worked out on. |
gosi_number | text | No | Saudi payroll: GOSI number |
gosi_category | text | No | Saudi payroll: GOSI category — Empty: read from the person’s nationality. Allowed: Saudi national Non-Saudi |
gosi_registered_on | date | No | Saudi payroll: first registered with GOSI — On or after 3 July 2024, a Saudi is on the new Social Insurance Law’s annuity rates. |
iqama_number | text | No | Saudi payroll: iqama or national ID — The ID the WPS salary file names the employee by: ten digits, beginning 1 for a Saudi national or 2 for an Iqama. Kept sealed (encrypted); only the last four are shown. Left empty on Edit, the one on file stays. |
overtime_rule_id | uuid | No | Overtime rule — Empty: their pay group’s rule, or the rules decide by where they work. Chosen: this rule governs them. |
Sample body
{
"employee_no": "EMP-000001",
"first_name": "Example",
"last_name": "Example",
"hire_date": "2026-10-30",
"user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"email": "someone@example.com",
"worker_type": "text",
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_no": "EMP-000001",
"user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"worker_type": "text",
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"manager_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"hire_date": "2026-10-30",
"termination_date": "2026-10-30",
"pay_type": "salary",
"base_pay": "1250.00",
"currency": "USD"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/employees" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employee_no":"EMP-000001","first_name":"Example","last_name":"Example","hire_date":"2026-10-30","user_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","email":"someone@example.com","worker_type":"text","position_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/hrms/employees/{id}Change a employees
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
employee_no | text | Yes | Employee number — Left blank, the platform allocates the next one from the number range. |
user_id | uuid | No | Signs in as — The user this person signs in with. Approvals that wait for them as their HRMS approver become theirs to decide once this is set. |
first_name | text | Yes | First name |
last_name | text | Yes | Last name |
email | text | No | Email — Their work email. One that already belongs to another current employee is refused. |
worker_type | text | No | Worker type |
position_id | uuid | No | Position |
manager_id | uuid | No | Manager — Who they report to. Leave empty for somebody at the top of the organisation chart. |
hire_date | date | Yes | Hire date |
pay_type | text | No | Pay type Allowed: salary hourly |
base_pay | numeric | No | Base pay (annual salary or hourly rate) |
currency | text | No | Pay currency — Leave empty for the company’s own currency. |
work_state | text | No | Work region — The state or region they work in. |
status | text | No | Status |
person_id | uuid | No | Same person as (rehire) — Hiring back somebody who left? Pick the person they were, so their history and service stay on one person. Leave empty for somebody new. |
pay_frequency | text | No | Paid — How often a payslip is due. A monthly salary is the annual base pay over twelve. |
work_country | text | No | Work country — Chooses how they are paid and taxed. Leave empty for the company’s own country. |
work_location_id | uuid | No | Work location — Where they work. Their punches are read in its time zone when a punch names no place. |
pay_group_id | uuid | No | Pay group — An active pay group of the country they work in. A change dated for later is a personnel action. |
resident_state | text | No | State of residence — Empty means the work state. A different state brings in reciprocity or the resident-state credit. |
work_locality | text | No | Work locality — The city, PSD or district they work in, for local tax. |
resident_locality | text | No | Home locality — Where they live. More than one (a school district as well) goes on Local Tax Assignments. |
holiday_calendar_id | uuid | No | Holiday calendar — The holidays their leave days, FMLA, attendance and holiday pay count. Empty (or the company default): their location’s, business unit’s or state’s calendar where there is one, else the default. |
uan | text | No | India statutory: UAN — The EPF Universal Account Number, twelve digits. |
basic_wage | numeric | No | Statutory pay: basic wage (monthly) — India: EPF is worked out on basic + DA; left empty, half the monthly gross is used. Saudi Arabia: GOSI is worked out on basic + housing; left empty, the monthly gross is used. |
dearness_allowance | numeric | No | India statutory: dearness allowance (monthly) |
hra | numeric | No | India statutory: house rent allowance (monthly) |
special_allowance | numeric | No | India statutory: special allowance (monthly) |
pt_state_code | text | No | India statutory: professional tax state — The state whose professional tax and labour welfare fund apply. Allowed: 01 Jammu and Kashmir 02 Himachal Pradesh 03 Punjab 04 Chandigarh 05 Uttarakhand 06 Haryana 07 Delhi 08 Rajasthan 09 Uttar Pradesh 10 Bihar 11 Sikkim 12 Arunachal Pradesh |
is_pf_applicable | boolean | No | India statutory: EPF applies |
is_esi_applicable | boolean | No | India statutory: ESI applies |
tax_regime | text | No | India statutory: income tax regime — New unless the employee has opted for the old regime this year. Allowed: new old |
housing_allowance | numeric | No | Saudi payroll: housing allowance (monthly) |
transport_allowance | numeric | No | Saudi payroll: transport allowance (monthly) — Counts toward the last wage an end-of-service award is worked out on. |
gosi_number | text | No | Saudi payroll: GOSI number |
gosi_category | text | No | Saudi payroll: GOSI category — Empty: read from the person’s nationality. Allowed: Saudi national Non-Saudi |
gosi_registered_on | date | No | Saudi payroll: first registered with GOSI — On or after 3 July 2024, a Saudi is on the new Social Insurance Law’s annuity rates. |
iqama_number | text | No | Saudi payroll: iqama or national ID — The ID the WPS salary file names the employee by: ten digits, beginning 1 for a Saudi national or 2 for an Iqama. Kept sealed (encrypted); only the last four are shown. Left empty on Edit, the one on file stays. |
overtime_rule_id | uuid | No | Overtime rule — Empty: their pay group’s rule, or the rules decide by where they work. Chosen: this rule governs them. |
Sample body
{
"employee_no": "EMP-000001",
"first_name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_no": "EMP-000001",
"user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"worker_type": "text",
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"manager_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"hire_date": "2026-10-30",
"termination_date": "2026-10-30",
"pay_type": "salary",
"base_pay": "1250.00",
"currency": "USD"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/employees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employee_no":"EMP-000001","first_name":"Example"}'DELETE/api/hrms/employees/{id}Delete a employees
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/hrms/employees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/employees/{id}/wps-accountWps account
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
iban, bankCode*, accountName, reasonResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/employees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/wps-account" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"iban":"value","bankCode":"value","accountName":"value","reason":"value"}'PUT/api/hrms/employees/{id}/home-addressHome address
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
address_line1, reasonResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/employees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/home-address" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"address_line1":"value","reason":"value"}'POST/api/hrms/employees/{id}/home-addressHome address
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
address_line1, reasonResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/employees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/home-address" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"address_line1":"value","reason":"value"}'GET/api/hrms/employees/{id}/ssnSsn
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/employees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/ssn" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/employees/{id}/ssnSsn
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
ssnResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/employees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/ssn" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"ssn":"value"}'GET/api/hrms/employees/{id}/clearanceClearance
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/employees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/clearance" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/employees/{id}/worker-profileWorker profile
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/employees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/worker-profile" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/employees/{id}/offboardOffboard
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/employees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/offboard" \
-H "Authorization: Bearer $TOKEN"PATCH/api/hrms/employees/{id}Patch employees
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
currencyResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PATCH "https://demo.tranxact.ai/api/hrms/employees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"currency":"value"}'POST/api/hrms/employees/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/employees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'POST/api/hrms/employees/{id}/terminateTerminate
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
effectiveDate*, reason, separationTypeResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/employees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/terminate" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"effectiveDate":"value","reason":"value","separationType":"value"}'POST/api/hrms/employees/{id}/plan-separationPlan separation
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
effectiveDate*, reason, separationTypeResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/employees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/plan-separation" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"effectiveDate":"value","reason":"value","separationType":"value"}'POST/api/hrms/employees/{id}/change-statusChange status
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
status, effectiveDate, reasonResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/employees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/change-status" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"status":"value","effectiveDate":"value","reason":"value"}'POST/api/hrms/employees/{id}/cancel-scheduled-changeCancel scheduled change
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
actionId, reasonResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/employees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel-scheduled-change" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"actionId":"value","reason":"value"}'Data model
Every field of a employees, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
employee_no | text | read, write | Employee number — Left blank, the platform allocates the next one from the number range. |
user_id | uuid | read, write | Signs in as — The user this person signs in with. Approvals that wait for them as their HRMS approver become theirs to decide once this is set. |
first_name | text | read, write | First name |
last_name | text | read, write | Last name |
email | text | read, write | Email — Their work email. One that already belongs to another current employee is refused. |
worker_type | text | read, write | Worker type |
position_id | uuid | read, write | Position |
manager_id | uuid | read, write | Manager — Who they report to. Leave empty for somebody at the top of the organisation chart. |
hire_date | date | read, write | Hire date |
termination_date | date | read only | Termination date |
pay_type | text | read, write | Pay type Allowed: salary hourly |
base_pay | numeric | read, write | Base pay (annual salary or hourly rate) |
currency | text | read, write | Pay currency — Leave empty for the company’s own currency. |
work_state | text | read, write | Work region — The state or region they work in. |
status | text | read, write | Status |
org_unit_id | uuid | read only | Org unit id |
person_id | uuid | read, write | Same person as (rehire) — Hiring back somebody who left? Pick the person they were, so their history and service stay on one person. Leave empty for somebody new. |
employment_type | text | read only | Employment type |
is_primary | boolean | read only | Is primary |
fte | numeric | read only | Fte |
standard_hours_week | numeric | read only | Standard hours week |
pay_frequency | text | read, write | Paid — How often a payslip is due. A monthly salary is the annual base pay over twelve. |
original_hire_date | date | read only | Original hire date |
seniority_date | date | read only | Seniority date |
probation_end_date | date | read only | Probation end date |
contract_end_date | date | read only | Contract end date |
notice_days | integer | read only | Notice days |
work_country | text | read, write | Work country — Chooses how they are paid and taxed. Leave empty for the company’s own country. |
work_location_id | uuid | read, write | Work location — Where they work. Their punches are read in its time zone when a punch names no place. |
work_email | text | read only | Work email |
work_phone | text | read only | Work phone |
exempt | boolean | read only | Exempt |
union_code | text | read only | Union code |
termination_reason | text | read only | Termination reason |
termination_type | text | read only | Termination type |
eligible_for_rehire | boolean | read only | Eligible for rehire |
last_working_day | date | read only | Last working day |
grade_id | uuid | read only | Grade id |
agency_name | text | read only | Agency name |
agency_rate | numeric | read only | Agency rate |
purchase_order_id | uuid | read only | Purchase order id |
pay_group_id | uuid | read, write | Pay group — An active pay group of the country they work in. A change dated for later is a personnel action. |
resident_state | text | read, write | State of residence — Empty means the work state. A different state brings in reciprocity or the resident-state credit. |
work_locality | text | read, write | Work locality — The city, PSD or district they work in, for local tax. |
resident_locality | text | read, write | Home locality — Where they live. More than one (a school district as well) goes on Local Tax Assignments. |
holiday_calendar_id | uuid | read, write | Holiday calendar — The holidays their leave days, FMLA, attendance and holiday pay count. Empty (or the company default): their location’s, business unit’s or state’s calendar where there is one, else the default. |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
pan | text | read only | Pan |
aadhaar_last4 | text | read only | Aadhaar last4 |
uan | text | read, write | India statutory: UAN — The EPF Universal Account Number, twelve digits. |
pf_number | text | read only | Pf number |
esi_number | text | read only | Esi number |
basic_wage | numeric | read, write | Statutory pay: basic wage (monthly) — India: EPF is worked out on basic + DA; left empty, half the monthly gross is used. Saudi Arabia: GOSI is worked out on basic + housing; left empty, the monthly gross is used. |
dearness_allowance | numeric | read, write | India statutory: dearness allowance (monthly) |
hra | numeric | read, write | India statutory: house rent allowance (monthly) |
special_allowance | numeric | read, write | India statutory: special allowance (monthly) |
pt_state_code | text | read, write | India statutory: professional tax state — The state whose professional tax and labour welfare fund apply. Allowed: 01 Jammu and Kashmir 02 Himachal Pradesh 03 Punjab 04 Chandigarh 05 Uttarakhand 06 Haryana 07 Delhi 08 Rajasthan 09 Uttar Pradesh 10 Bihar 11 Sikkim 12 Arunachal Pradesh |
is_pf_applicable | boolean | read, write | India statutory: EPF applies |
is_esi_applicable | boolean | read, write | India statutory: ESI applies |
tax_regime | text | read, write | India statutory: income tax regime — New unless the employee has opted for the old regime this year. Allowed: new old |
ifsc | text | read only | Ifsc |
housing_allowance | numeric | read, write | Saudi payroll: housing allowance (monthly) |
transport_allowance | numeric | read, write | Saudi payroll: transport allowance (monthly) — Counts toward the last wage an end-of-service award is worked out on. |
gosi_number | text | read, write | Saudi payroll: GOSI number |
gosi_category | text | read, write | Saudi payroll: GOSI category — Empty: read from the person’s nationality. Allowed: Saudi national Non-Saudi |
gosi_registered_on | date | read, write | Saudi payroll: first registered with GOSI — On or after 3 July 2024, a Saudi is on the new Social Insurance Law’s annuity rates. |
iqama_number | text | read, write | Saudi payroll: iqama or national ID — The ID the WPS salary file names the employee by: ten digits, beginning 1 for a Saudi national or 2 for an Iqama. Kept sealed (encrypted); only the last four are shown. Left empty on Edit, the one on file stays. |
merged_into_id | uuid | read only | Merged into id |
overtime_rule_id | uuid | read, write | Overtime rule — Empty: their pay group’s rule, or the rules decide by where they work. Chosen: this rule governs them. |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold HRMS › Employees for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.