TRANXACT.AI Help

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.

Type REST19 operationsBase path /api/hrms/employeesPublished as /api/v1/employees

Download specification (OpenAPI 3.1) Screen: Employees

Overview

PackageHRMS
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablehr.employees · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
employee_notextYesEmployee number — Left blank, the platform allocates the next one from the number range.
user_iduuidNoSigns 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_nametextYesFirst name
last_nametextYesLast name
emailtextNoEmail — Their work email. One that already belongs to another current employee is refused.
worker_typetextNoWorker type
position_iduuidNoPosition
manager_iduuidNoManager — Who they report to. Leave empty for somebody at the top of the organisation chart.
hire_datedateYesHire date
pay_typetextNoPay type
Allowed: salary hourly
base_paynumericNoBase pay (annual salary or hourly rate)
currencytextNoPay currency — Leave empty for the company’s own currency.
work_statetextNoWork region — The state or region they work in.
statustextNoStatus
person_iduuidNoSame 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_frequencytextNoPaid — How often a payslip is due. A monthly salary is the annual base pay over twelve.
work_countrytextNoWork country — Chooses how they are paid and taxed. Leave empty for the company’s own country.
work_location_iduuidNoWork location — Where they work. Their punches are read in its time zone when a punch names no place.
pay_group_iduuidNoPay group — An active pay group of the country they work in. A change dated for later is a personnel action.
resident_statetextNoState of residence — Empty means the work state. A different state brings in reciprocity or the resident-state credit.
work_localitytextNoWork locality — The city, PSD or district they work in, for local tax.
resident_localitytextNoHome locality — Where they live. More than one (a school district as well) goes on Local Tax Assignments.
holiday_calendar_iduuidNoHoliday 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.
uantextNoIndia statutory: UAN — The EPF Universal Account Number, twelve digits.
basic_wagenumericNoStatutory 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_allowancenumericNoIndia statutory: dearness allowance (monthly)
hranumericNoIndia statutory: house rent allowance (monthly)
special_allowancenumericNoIndia statutory: special allowance (monthly)
pt_state_codetextNoIndia 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_applicablebooleanNoIndia statutory: EPF applies
is_esi_applicablebooleanNoIndia statutory: ESI applies
tax_regimetextNoIndia statutory: income tax regime — New unless the employee has opted for the old regime this year.
Allowed: new old
housing_allowancenumericNoSaudi payroll: housing allowance (monthly)
transport_allowancenumericNoSaudi payroll: transport allowance (monthly) — Counts toward the last wage an end-of-service award is worked out on.
gosi_numbertextNoSaudi payroll: GOSI number
gosi_categorytextNoSaudi payroll: GOSI category — Empty: read from the person’s nationality.
Allowed: Saudi national Non-Saudi
gosi_registered_ondateNoSaudi payroll: first registered with GOSI — On or after 3 July 2024, a Saudi is on the new Social Insurance Law’s annuity rates.
iqama_numbertextNoSaudi 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_iduuidNoOvertime 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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
employee_notextYesEmployee number — Left blank, the platform allocates the next one from the number range.
user_iduuidNoSigns 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_nametextYesFirst name
last_nametextYesLast name
emailtextNoEmail — Their work email. One that already belongs to another current employee is refused.
worker_typetextNoWorker type
position_iduuidNoPosition
manager_iduuidNoManager — Who they report to. Leave empty for somebody at the top of the organisation chart.
hire_datedateYesHire date
pay_typetextNoPay type
Allowed: salary hourly
base_paynumericNoBase pay (annual salary or hourly rate)
currencytextNoPay currency — Leave empty for the company’s own currency.
work_statetextNoWork region — The state or region they work in.
statustextNoStatus
person_iduuidNoSame 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_frequencytextNoPaid — How often a payslip is due. A monthly salary is the annual base pay over twelve.
work_countrytextNoWork country — Chooses how they are paid and taxed. Leave empty for the company’s own country.
work_location_iduuidNoWork location — Where they work. Their punches are read in its time zone when a punch names no place.
pay_group_iduuidNoPay group — An active pay group of the country they work in. A change dated for later is a personnel action.
resident_statetextNoState of residence — Empty means the work state. A different state brings in reciprocity or the resident-state credit.
work_localitytextNoWork locality — The city, PSD or district they work in, for local tax.
resident_localitytextNoHome locality — Where they live. More than one (a school district as well) goes on Local Tax Assignments.
holiday_calendar_iduuidNoHoliday 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.
uantextNoIndia statutory: UAN — The EPF Universal Account Number, twelve digits.
basic_wagenumericNoStatutory 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_allowancenumericNoIndia statutory: dearness allowance (monthly)
hranumericNoIndia statutory: house rent allowance (monthly)
special_allowancenumericNoIndia statutory: special allowance (monthly)
pt_state_codetextNoIndia 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_applicablebooleanNoIndia statutory: EPF applies
is_esi_applicablebooleanNoIndia statutory: ESI applies
tax_regimetextNoIndia statutory: income tax regime — New unless the employee has opted for the old regime this year.
Allowed: new old
housing_allowancenumericNoSaudi payroll: housing allowance (monthly)
transport_allowancenumericNoSaudi payroll: transport allowance (monthly) — Counts toward the last wage an end-of-service award is worked out on.
gosi_numbertextNoSaudi payroll: GOSI number
gosi_categorytextNoSaudi payroll: GOSI category — Empty: read from the person’s nationality.
Allowed: Saudi national Non-Saudi
gosi_registered_ondateNoSaudi payroll: first registered with GOSI — On or after 3 July 2024, a Saudi is on the new Social Insurance Law’s annuity rates.
iqama_numbertextNoSaudi 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_iduuidNoOvertime 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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, reason

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/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

NameTypeDescription
idstring (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, reason

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 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

NameTypeDescription
idstring (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, reason

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/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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

ssn

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/ssn" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ssn":"value"}'
GET/api/hrms/employees/{id}/clearanceClearance

Path parameters

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

currency

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 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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
idstring (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, separationType

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/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

NameTypeDescription
idstring (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, separationType

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/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

NameTypeDescription
idstring (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, reason

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/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

NameTypeDescription
idstring (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, reason

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
employee_notextread, writeEmployee number — Left blank, the platform allocates the next one from the number range.
user_iduuidread, writeSigns 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_nametextread, writeFirst name
last_nametextread, writeLast name
emailtextread, writeEmail — Their work email. One that already belongs to another current employee is refused.
worker_typetextread, writeWorker type
position_iduuidread, writePosition
manager_iduuidread, writeManager — Who they report to. Leave empty for somebody at the top of the organisation chart.
hire_datedateread, writeHire date
termination_datedateread onlyTermination date
pay_typetextread, writePay type
Allowed: salary hourly
base_paynumericread, writeBase pay (annual salary or hourly rate)
currencytextread, writePay currency — Leave empty for the company’s own currency.
work_statetextread, writeWork region — The state or region they work in.
statustextread, writeStatus
org_unit_iduuidread onlyOrg unit id
person_iduuidread, writeSame 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_typetextread onlyEmployment type
is_primarybooleanread onlyIs primary
ftenumericread onlyFte
standard_hours_weeknumericread onlyStandard hours week
pay_frequencytextread, writePaid — How often a payslip is due. A monthly salary is the annual base pay over twelve.
original_hire_datedateread onlyOriginal hire date
seniority_datedateread onlySeniority date
probation_end_datedateread onlyProbation end date
contract_end_datedateread onlyContract end date
notice_daysintegerread onlyNotice days
work_countrytextread, writeWork country — Chooses how they are paid and taxed. Leave empty for the company’s own country.
work_location_iduuidread, writeWork location — Where they work. Their punches are read in its time zone when a punch names no place.
work_emailtextread onlyWork email
work_phonetextread onlyWork phone
exemptbooleanread onlyExempt
union_codetextread onlyUnion code
termination_reasontextread onlyTermination reason
termination_typetextread onlyTermination type
eligible_for_rehirebooleanread onlyEligible for rehire
last_working_daydateread onlyLast working day
grade_iduuidread onlyGrade id
agency_nametextread onlyAgency name
agency_ratenumericread onlyAgency rate
purchase_order_iduuidread onlyPurchase order id
pay_group_iduuidread, writePay group — An active pay group of the country they work in. A change dated for later is a personnel action.
resident_statetextread, writeState of residence — Empty means the work state. A different state brings in reciprocity or the resident-state credit.
work_localitytextread, writeWork locality — The city, PSD or district they work in, for local tax.
resident_localitytextread, writeHome locality — Where they live. More than one (a school district as well) goes on Local Tax Assignments.
holiday_calendar_iduuidread, writeHoliday 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_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
pantextread onlyPan
aadhaar_last4textread onlyAadhaar last4
uantextread, writeIndia statutory: UAN — The EPF Universal Account Number, twelve digits.
pf_numbertextread onlyPf number
esi_numbertextread onlyEsi number
basic_wagenumericread, writeStatutory 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_allowancenumericread, writeIndia statutory: dearness allowance (monthly)
hranumericread, writeIndia statutory: house rent allowance (monthly)
special_allowancenumericread, writeIndia statutory: special allowance (monthly)
pt_state_codetextread, writeIndia 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_applicablebooleanread, writeIndia statutory: EPF applies
is_esi_applicablebooleanread, writeIndia statutory: ESI applies
tax_regimetextread, writeIndia statutory: income tax regime — New unless the employee has opted for the old regime this year.
Allowed: new old
ifsctextread onlyIfsc
housing_allowancenumericread, writeSaudi payroll: housing allowance (monthly)
transport_allowancenumericread, writeSaudi payroll: transport allowance (monthly) — Counts toward the last wage an end-of-service award is worked out on.
gosi_numbertextread, writeSaudi payroll: GOSI number
gosi_categorytextread, writeSaudi payroll: GOSI category — Empty: read from the person’s nationality.
Allowed: Saudi national Non-Saudi
gosi_registered_ondateread, writeSaudi payroll: first registered with GOSI — On or after 3 July 2024, a Saudi is on the new Social Insurance Law’s annuity rates.
iqama_numbertextread, writeSaudi 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_iduuidread onlyMerged into id
overtime_rule_iduuidread, writeOvertime rule — Empty: their pay group’s rule, or the rules decide by where they work. Chosen: this rule governs them.

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold HRMS › Employees for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.