TRANXACT.AI Help

HRMS · Benefits

Dependents

Read and maintain dependants records (hr.dependants).

Type REST7 operationsBase path /api/hrms/dependantsPublished as /api/v1/dependants

Download specification (OpenAPI 3.1) Screen: Dependents

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 › Dependents 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.dependants · 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/dependantsList dependents

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",
      "first_name": "Example",
      "last_name": "Example",
      "relationship": "spouse",
      "date_of_birth": "2026-10-30",
      "gender": "text",
      "national_id_last4": "text",
      "is_student": true,
      "is_disabled": true,
      "ages_off_on": "2026-10-30",
      "verified_at": "2026-10-30T09:00:00Z",
      "is_active": true,
      "created_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/hrms/dependants?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/dependants/{id}Read one dependants

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",
  "first_name": "Example",
  "last_name": "Example",
  "relationship": "spouse",
  "date_of_birth": "2026-10-30",
  "gender": "text",
  "national_id_last4": "text",
  "is_student": true,
  "is_disabled": true,
  "ages_off_on": "2026-10-30",
  "verified_at": "2026-10-30T09:00:00Z",
  "is_active": true,
  "created_at": "2026-10-30T09:00:00Z"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/hrms/dependants/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/dependantsCreate a dependants

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
person_iduuidYesPerson
first_nametextYesFirst name
last_nametextYesLast name
relationshiptextYesRelationship
Allowed: spouse domestic_partner child stepchild adopted_child foster_child disabled_adult_child other
date_of_birthdateNoDate of birth
gendertextNoGender
is_studentbooleanNoFull-time student
is_disabledbooleanNoDisabled
ages_off_ondateNoAges off cover on
is_activebooleanNoIs active

Sample body

{
  "person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "first_name": "Example",
  "last_name": "Example",
  "relationship": "spouse",
  "date_of_birth": "2026-10-30",
  "gender": "text",
  "is_student": true,
  "is_disabled": true
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "first_name": "Example",
  "last_name": "Example",
  "relationship": "spouse",
  "date_of_birth": "2026-10-30",
  "gender": "text",
  "national_id_last4": "text",
  "is_student": true,
  "is_disabled": true,
  "ages_off_on": "2026-10-30",
  "verified_at": "2026-10-30T09:00:00Z",
  "is_active": true,
  "created_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/dependants" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"person_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","first_name":"Example","last_name":"Example","relationship":"spouse","date_of_birth":"2026-10-30","gender":"text","is_student":true,"is_disabled":true}'
PUT/api/hrms/dependants/{id}Change a dependants

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
first_nametextYesFirst name
last_nametextYesLast name
relationshiptextYesRelationship
Allowed: spouse domestic_partner child stepchild adopted_child foster_child disabled_adult_child other
date_of_birthdateNoDate of birth
gendertextNoGender
is_studentbooleanNoFull-time student
is_disabledbooleanNoDisabled
ages_off_ondateNoAges off cover on
is_activebooleanNoIs active

Sample body

{
  "person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "first_name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "first_name": "Example",
  "last_name": "Example",
  "relationship": "spouse",
  "date_of_birth": "2026-10-30",
  "gender": "text",
  "national_id_last4": "text",
  "is_student": true,
  "is_disabled": true,
  "ages_off_on": "2026-10-30",
  "verified_at": "2026-10-30T09:00:00Z",
  "is_active": true,
  "created_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/hrms/dependants/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"person_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","first_name":"Example"}'
DELETE/api/hrms/dependants/{id}Delete a dependants

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

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; status one of verified|rejected|pending

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/dependants/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/verify" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status;":"value"}'

Data model

Every field of a dependants, 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
first_nametextread, writeFirst name
last_nametextread, writeLast name
relationshiptextread, writeRelationship
Allowed: spouse domestic_partner child stepchild adopted_child foster_child disabled_adult_child other
date_of_birthdateread, writeDate of birth
gendertextread, writeGender
national_id_last4textread onlyNational id last4
is_studentbooleanread, writeFull-time student
is_disabledbooleanread, writeDisabled
ages_off_ondateread, writeAges off cover on
verified_attimestamp with time zoneread onlyVerified at
is_activebooleanread, writeIs active
created_attimestamp with time zoneread onlyCreated at
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
national_id_cipherbytearead onlyNational id cipher
verification_statustextread onlyVerification status

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 › Dependents 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.