HRMS · Benefits
Benefit Elections
What each person chose, what tier they are on, and what it costs them and the employer each period.
/api/hrms/benefit-electionsPublished as /api/v1/benefit-electionsDownload specification (OpenAPI 3.1) Screen: Benefit Elections
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 Elections 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_elections · kept per company (and organisational unit where it has one) |
| Record | Read only; 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-electionsList benefit elections
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",
"employee_no": "EMP-000001",
"employee_name": "Example",
"plan_code": "PLA-000001",
"plan_name": "Example",
"category": "text",
"carrier": "text",
"tier_code": "TIE-000001",
"tier_name": "Example",
"status": "draft",
"effective_date": "2026-10-30",
"end_date": "2026-10-30",
"waived": true
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/benefit-elections?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/benefit-elections/{id}Read one benefit elections
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",
"employee_no": "EMP-000001",
"employee_name": "Example",
"plan_code": "PLA-000001",
"plan_name": "Example",
"category": "text",
"carrier": "text",
"tier_code": "TIE-000001",
"tier_name": "Example",
"status": "draft",
"effective_date": "2026-10-30",
"end_date": "2026-10-30",
"waived": true
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/benefit-elections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/benefit-electionsPost benefit elections
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 POST "https://demo.tranxact.ai/api/hrms/benefit-elections" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/benefit-elections/{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-elections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/hrms/benefit-elections/{id}Put benefit elections
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 PUT "https://demo.tranxact.ai/api/hrms/benefit-elections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/hrms/benefit-elections/{id}Delete benefit elections
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 DELETE "https://demo.tranxact.ai/api/hrms/benefit-elections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a benefit elections, 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 |
employee_id | uuid | read only | Employee id |
employee_no | text | read only | Employee no |
employee_name | text | read only | Employee name |
plan_code | text | read only | Plan code |
plan_name | text | read only | Plan name |
category | text | read only | Category |
carrier | text | read only | Carrier |
tier_code | text | read only | Tier code |
tier_name | text | read only | Tier name |
status | text | read only | Status |
effective_date | date | read only | Effective date |
end_date | date | read only | End date |
waived | boolean | read only | Waived |
waiver_reason | text | read only | Waiver reason |
employee_cost | numeric | read only | Employee cost |
employer_cost | numeric | read only | Employer cost |
employee_annual | numeric | read only | Employee annual |
employer_annual | numeric | read only | Employer annual |
coverage_amount | numeric | read only | Coverage amount |
annual_election | numeric | read only | Annual election |
dependants | integer | read only | Dependants |
plan_year | text | read only | Plan year |
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 Elections 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.