TRANXACT.AI Help

HRMS · Benefits

Benefit Enrollments

Read and maintain benefit enrollments records (hr.benefit_enrollments).

Type REST6 operationsBase path /api/hrms/benefit-enrollmentsPublished as /api/v1/benefit-enrollments

Download specification (OpenAPI 3.1) Screen: Benefit Enrollments

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 › Benefit Enrollments 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.benefit_enrollments · 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

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

GET/api/hrms/benefit-enrollmentsList benefit enrollments

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_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "coverage_tier": "employee",
      "effective_date": "2026-10-30",
      "end_date": "2026-10-30",
      "status": "draft",
      "plan_year_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "tier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "employee_cost": "1250.00",
      "employer_cost": "1250.00",
      "coverage_amount": "1250.00",
      "annual_election": "1250.00",
      "elected_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "coverage_tier": "employee",
  "effective_date": "2026-10-30",
  "end_date": "2026-10-30",
  "status": "draft",
  "plan_year_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_cost": "1250.00",
  "employer_cost": "1250.00",
  "coverage_amount": "1250.00",
  "annual_election": "1250.00",
  "elected_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/benefit-enrollments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/benefit-enrollmentsCreate a benefit enrollments

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
employee_iduuidYesEmployee
plan_iduuidYesPlan
coverage_tiertextNoCoverage (plan without tiers)
Allowed: employee employee_spouse employee_children family
effective_datedateYesEffective
end_datedateNoEnd date
statustextNoStatus
tier_iduuidNoCoverage tier — The tiers the chosen plan prices.

Sample body

{
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "effective_date": "2026-10-30",
  "coverage_tier": "employee",
  "end_date": "2026-10-30",
  "status": "draft",
  "tier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "coverage_tier": "employee",
  "effective_date": "2026-10-30",
  "end_date": "2026-10-30",
  "status": "draft",
  "plan_year_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_cost": "1250.00",
  "employer_cost": "1250.00",
  "coverage_amount": "1250.00",
  "annual_election": "1250.00",
  "elected_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/benefit-enrollments" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","plan_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","effective_date":"2026-10-30","coverage_tier":"employee","end_date":"2026-10-30","status":"draft","tier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/hrms/benefit-enrollments/{id}Change a benefit enrollments

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_iduuidYesEmployee
plan_iduuidYesPlan
coverage_tiertextNoCoverage (plan without tiers)
Allowed: employee employee_spouse employee_children family
effective_datedateYesEffective
end_datedateNoEnd date
statustextNoStatus
tier_iduuidNoCoverage tier — The tiers the chosen plan prices.

Sample body

{
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "coverage_tier": "employee",
  "effective_date": "2026-10-30",
  "end_date": "2026-10-30",
  "status": "draft",
  "plan_year_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_cost": "1250.00",
  "employer_cost": "1250.00",
  "coverage_amount": "1250.00",
  "annual_election": "1250.00",
  "elected_at": "2026-10-30T09:00:00Z"
}

Sample request

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

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/benefit-enrollments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/benefit-enrollments/{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/benefit-enrollments/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 benefit enrollments, 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
employee_iduuidread, writeEmployee
plan_iduuidread, writePlan
coverage_tiertextread, writeCoverage (plan without tiers)
Allowed: employee employee_spouse employee_children family
effective_datedateread, writeEffective
end_datedateread, writeEnd date
statustextread, writeStatus
org_iduuidread onlyOrg id
plan_year_iduuidread onlyPlan year id
tier_iduuidread, writeCoverage tier — The tiers the chosen plan prices.
employee_costnumericread onlyEmployee cost
employer_costnumericread onlyEmployer cost
coverage_amountnumericread onlyCoverage amount
annual_electionnumericread onlyAnnual election
elected_attimestamp with time zoneread onlyElected at
elected_byuuidread onlyElected by
reasontextread onlyReason
life_event_iduuidread onlyLife event id
waivedbooleanread onlyWaived
waiver_reasontextread onlyWaiver reason
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_attimestamp with time zoneread onlyCreated at
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 › Benefit Enrollments 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.