HRMS · Reachable by link
Work Relationships
The layer between a person and their assignments. A rehire is a new relationship and the same person — which is what keeps continuous service right.
/api/hrms/work-relationshipsPublished as /api/v1/work-relationshipsDownload specification (OpenAPI 3.1) Screen: Work Relationships
Overview
| 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 › Work Relationships 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.work_relationships · 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
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/work-relationshipsList work relationships
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",
"person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"relationship_no": "REL-000001",
"legal_employer_org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"worker_type": "employee",
"is_primary": true,
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"original_hire_date": "2026-10-30",
"continuous_service_date": "2026-10-30",
"service_break_days": 10,
"employment_basis": "permanent",
"contract_end_date": "2026-10-30"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/work-relationships?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/work-relationships/{id}Read one work relationships
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",
"person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"relationship_no": "REL-000001",
"legal_employer_org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"worker_type": "employee",
"is_primary": true,
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"original_hire_date": "2026-10-30",
"continuous_service_date": "2026-10-30",
"service_break_days": 10,
"employment_basis": "permanent",
"contract_end_date": "2026-10-30"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/work-relationships/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/work-relationshipsCreate a work relationships
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
person_id | uuid | Yes | Person |
employee_id | uuid | No | Employee record |
legal_employer_org_unit_id | uuid | No | Legal employer — Not the same as the department: a worker sits in one unit and is employed by another, routinely. |
worker_type | text | No | Worker type Allowed: employee contractor agency intern consultant volunteer apprentice pensioner |
is_primary | boolean | No | Primary relationship |
start_date | date | Yes | Start date |
end_date | date | No | End date |
original_hire_date | date | No | Original hire date — Leave empty and it is derived from the first relationship this person ever had. |
continuous_service_date | date | No | Continuous service from |
service_break_days | integer | No | Service break (days) |
employment_basis | text | No | Basis Allowed: permanent fixed_term casual zero_hours seasonal probationary |
contract_end_date | date | No | Contract ends |
probation_end_date | date | No | Probation ends |
notice_period_days | integer | No | Notice from the employee (days) |
notice_period_days_employer | integer | No | Notice from the employer (days) |
status | text | No | Status Allowed: pending active suspended on_leave notice ended |
termination_reason | text | No | Termination reason |
termination_type | text | No | Termination type |
is_rehire_eligible | boolean | No | Is rehire eligible |
effective_from | date | No | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | No | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
Sample body
{
"person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"start_date": "2026-10-30",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"legal_employer_org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"worker_type": "employee",
"is_primary": true
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"relationship_no": "REL-000001",
"legal_employer_org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"worker_type": "employee",
"is_primary": true,
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"original_hire_date": "2026-10-30",
"continuous_service_date": "2026-10-30",
"service_break_days": 10,
"employment_basis": "permanent",
"contract_end_date": "2026-10-30"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/work-relationships" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"person_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","start_date":"2026-10-30","employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","legal_employer_org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","worker_type":"employee","is_primary":true}'PUT/api/hrms/work-relationships/{id}Change a work relationships
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 |
|---|---|---|---|
person_id | uuid | Yes | Person |
employee_id | uuid | No | Employee record |
legal_employer_org_unit_id | uuid | No | Legal employer — Not the same as the department: a worker sits in one unit and is employed by another, routinely. |
worker_type | text | No | Worker type Allowed: employee contractor agency intern consultant volunteer apprentice pensioner |
is_primary | boolean | No | Primary relationship |
start_date | date | Yes | Start date |
end_date | date | No | End date |
original_hire_date | date | No | Original hire date — Leave empty and it is derived from the first relationship this person ever had. |
continuous_service_date | date | No | Continuous service from |
service_break_days | integer | No | Service break (days) |
employment_basis | text | No | Basis Allowed: permanent fixed_term casual zero_hours seasonal probationary |
contract_end_date | date | No | Contract ends |
probation_end_date | date | No | Probation ends |
notice_period_days | integer | No | Notice from the employee (days) |
notice_period_days_employer | integer | No | Notice from the employer (days) |
status | text | No | Status Allowed: pending active suspended on_leave notice ended |
termination_reason | text | No | Termination reason |
termination_type | text | No | Termination type |
is_rehire_eligible | boolean | No | Is rehire eligible |
effective_from | date | No | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | No | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
Sample body
{
"person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"start_date": "2026-10-30"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"relationship_no": "REL-000001",
"legal_employer_org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"worker_type": "employee",
"is_primary": true,
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"original_hire_date": "2026-10-30",
"continuous_service_date": "2026-10-30",
"service_break_days": 10,
"employment_basis": "permanent",
"contract_end_date": "2026-10-30"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/work-relationships/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"person_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","start_date":"2026-10-30"}'DELETE/api/hrms/work-relationships/{id}Delete a work relationships
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/work-relationships/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"PATCH/api/hrms/work-relationships/{id}Patch work relationships
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 PATCH "https://demo.tranxact.ai/api/hrms/work-relationships/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/work-relationships/{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/work-relationships/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a work relationships, 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 |
person_id | uuid | read, write | Person |
employee_id | uuid | read, write | Employee record |
relationship_no | text | read only | Relationship no |
legal_employer_org_unit_id | uuid | read, write | Legal employer — Not the same as the department: a worker sits in one unit and is employed by another, routinely. |
worker_type | text | read, write | Worker type Allowed: employee contractor agency intern consultant volunteer apprentice pensioner |
is_primary | boolean | read, write | Primary relationship |
start_date | date | read, write | Start date |
end_date | date | read, write | End date |
original_hire_date | date | read, write | Original hire date — Leave empty and it is derived from the first relationship this person ever had. |
continuous_service_date | date | read, write | Continuous service from |
service_break_days | integer | read, write | Service break (days) |
employment_basis | text | read, write | Basis Allowed: permanent fixed_term casual zero_hours seasonal probationary |
contract_end_date | date | read, write | Contract ends |
probation_end_date | date | read, write | Probation ends |
notice_period_days | integer | read, write | Notice from the employee (days) |
notice_period_days_employer | integer | read, write | Notice from the employer (days) |
status | text | read, write | Status Allowed: pending active suspended on_leave notice ended |
termination_reason | text | read, write | Termination reason |
termination_type | text | read, write | Termination type |
is_rehire_eligible | boolean | read, write | Is rehire eligible |
created_at | timestamp with time zone | read only | Created at |
effective_from | date | read, write | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | read, write | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
org_unit_id | uuid | read only | Org unit id |
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_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 › Work Relationships 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.