HRMS · Benefits
Benefit Enrollments
Read and maintain benefit enrollments records (hr.benefit_enrollments).
/api/hrms/benefit-enrollmentsPublished as /api/v1/benefit-enrollmentsDownload specification (OpenAPI 3.1) Screen: Benefit Enrollments
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 › 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. |
| Table | hr.benefit_enrollments · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/benefit-enrollmentsList benefit enrollments
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",
"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
| Name | Type | Description |
|---|---|---|
id | string (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.
| Field | Type | Required | Description |
|---|---|---|---|
employee_id | uuid | Yes | Employee |
plan_id | uuid | Yes | Plan |
coverage_tier | text | No | Coverage (plan without tiers) Allowed: employee employee_spouse employee_children family |
effective_date | date | Yes | Effective |
end_date | date | No | End date |
status | text | No | Status |
tier_id | uuid | No | Coverage 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
| 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 |
|---|---|---|---|
employee_id | uuid | Yes | Employee |
plan_id | uuid | Yes | Plan |
coverage_tier | text | No | Coverage (plan without tiers) Allowed: employee employee_spouse employee_children family |
effective_date | date | Yes | Effective |
end_date | date | No | End date |
status | text | No | Status |
tier_id | uuid | No | Coverage 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
| 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/benefit-enrollments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/benefit-enrollments/{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/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.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
employee_id | uuid | read, write | Employee |
plan_id | uuid | read, write | Plan |
coverage_tier | text | read, write | Coverage (plan without tiers) Allowed: employee employee_spouse employee_children family |
effective_date | date | read, write | Effective |
end_date | date | read, write | End date |
status | text | read, write | Status |
org_id | uuid | read only | Org id |
plan_year_id | uuid | read only | Plan year id |
tier_id | uuid | read, write | Coverage tier — The tiers the chosen plan prices. |
employee_cost | numeric | read only | Employee cost |
employer_cost | numeric | read only | Employer cost |
coverage_amount | numeric | read only | Coverage amount |
annual_election | numeric | read only | Annual election |
elected_at | timestamp with time zone | read only | Elected at |
elected_by | uuid | read only | Elected by |
reason | text | read only | Reason |
life_event_id | uuid | read only | Life event id |
waived | boolean | read only | Waived |
waiver_reason | text | read only | Waiver reason |
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_at | timestamp with time zone | read only | Created at |
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 › Benefit Enrollments 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.