TRANXACT.AI Help

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.

Type REST7 operationsBase path /api/hrms/work-relationshipsPublished as /api/v1/work-relationships

Download specification (OpenAPI 3.1) Screen: Work Relationships

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 › 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.
Tablehr.work_relationships · 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

7 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/hrms/work-relationshipsList work relationships

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

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

FieldTypeRequiredDescription
person_iduuidYesPerson
employee_iduuidNoEmployee record
legal_employer_org_unit_iduuidNoLegal employer — Not the same as the department: a worker sits in one unit and is employed by another, routinely.
worker_typetextNoWorker type
Allowed: employee contractor agency intern consultant volunteer apprentice pensioner
is_primarybooleanNoPrimary relationship
start_datedateYesStart date
end_datedateNoEnd date
original_hire_datedateNoOriginal hire date — Leave empty and it is derived from the first relationship this person ever had.
continuous_service_datedateNoContinuous service from
service_break_daysintegerNoService break (days)
employment_basistextNoBasis
Allowed: permanent fixed_term casual zero_hours seasonal probationary
contract_end_datedateNoContract ends
probation_end_datedateNoProbation ends
notice_period_daysintegerNoNotice from the employee (days)
notice_period_days_employerintegerNoNotice from the employer (days)
statustextNoStatus
Allowed: pending active suspended on_leave notice ended
termination_reasontextNoTermination reason
termination_typetextNoTermination type
is_rehire_eligiblebooleanNoIs rehire eligible
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — 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

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
person_iduuidYesPerson
employee_iduuidNoEmployee record
legal_employer_org_unit_iduuidNoLegal employer — Not the same as the department: a worker sits in one unit and is employed by another, routinely.
worker_typetextNoWorker type
Allowed: employee contractor agency intern consultant volunteer apprentice pensioner
is_primarybooleanNoPrimary relationship
start_datedateYesStart date
end_datedateNoEnd date
original_hire_datedateNoOriginal hire date — Leave empty and it is derived from the first relationship this person ever had.
continuous_service_datedateNoContinuous service from
service_break_daysintegerNoService break (days)
employment_basistextNoBasis
Allowed: permanent fixed_term casual zero_hours seasonal probationary
contract_end_datedateNoContract ends
probation_end_datedateNoProbation ends
notice_period_daysintegerNoNotice from the employee (days)
notice_period_days_employerintegerNoNotice from the employer (days)
statustextNoStatus
Allowed: pending active suspended on_leave notice ended
termination_reasontextNoTermination reason
termination_typetextNoTermination type
is_rehire_eligiblebooleanNoIs rehire eligible
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — 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

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/work-relationships/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
PATCH/api/hrms/work-relationships/{id}Patch work relationships

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
person_iduuidread, writePerson
employee_iduuidread, writeEmployee record
relationship_notextread onlyRelationship no
legal_employer_org_unit_iduuidread, writeLegal employer — Not the same as the department: a worker sits in one unit and is employed by another, routinely.
worker_typetextread, writeWorker type
Allowed: employee contractor agency intern consultant volunteer apprentice pensioner
is_primarybooleanread, writePrimary relationship
start_datedateread, writeStart date
end_datedateread, writeEnd date
original_hire_datedateread, writeOriginal hire date — Leave empty and it is derived from the first relationship this person ever had.
continuous_service_datedateread, writeContinuous service from
service_break_daysintegerread, writeService break (days)
employment_basistextread, writeBasis
Allowed: permanent fixed_term casual zero_hours seasonal probationary
contract_end_datedateread, writeContract ends
probation_end_datedateread, writeProbation ends
notice_period_daysintegerread, writeNotice from the employee (days)
notice_period_days_employerintegerread, writeNotice from the employer (days)
statustextread, writeStatus
Allowed: pending active suspended on_leave notice ended
termination_reasontextread, writeTermination reason
termination_typetextread, writeTermination type
is_rehire_eligiblebooleanread, writeIs rehire eligible
created_attimestamp with time zoneread onlyCreated at
effective_fromdateread, writeIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateread, writeUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.
org_unit_iduuidread onlyOrg unit id
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_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 › Work Relationships 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.