HRMS · Benefits
Benefit Eligibility Rules
Who may be enrolled in a plan, by age, work location, grade, tenure, employment type and dependents, from a date. Every rule that applies to a plan must be met, at enrollment, at a life event, or both.
/api/hrms/benefit-eligibility-rulesPublished as /api/v1/benefit-eligibility-rulesDownload specification (OpenAPI 3.1) Screen: Benefit Eligibility Rules
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 Eligibility Rules 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_eligibility_rules · 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
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/benefit-eligibility-rulesList benefit eligibility rules
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",
"plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"applies_at": "Enrollment and life events",
"min_age": 10,
"max_age": 10,
"countries": [],
"regions": [],
"location_ids": [],
"min_grade_level": "1250.00",
"max_grade_level": "1250.00",
"min_tenure_days": 10,
"employment_types": []
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/benefit-eligibility-rules?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/benefit-eligibility-rules/{id}Read one benefit eligibility rule
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",
"plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"applies_at": "Enrollment and life events",
"min_age": 10,
"max_age": 10,
"countries": [],
"regions": [],
"location_ids": [],
"min_grade_level": "1250.00",
"max_grade_level": "1250.00",
"min_tenure_days": 10,
"employment_types": []
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/benefit-eligibility-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/benefit-eligibility-rulesCreate a benefit eligibility rule
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
plan_id | uuid | No | Plan (empty = every plan) |
code | text | Yes | Code |
name | text | Yes | Name |
applies_at | text | No | Judged at Allowed: Enrollment and life events Enrollment only Life events only |
min_age | integer | No | Minimum age |
max_age | integer | No | Maximum age |
countries | _text | No | Work countries — Codes separated by commas, e.g. US, CA. Empty = any. |
regions | _text | No | Work states / provinces — Separated by commas. Empty = any. |
location_ids | _uuid | No | Location ids |
min_grade_level | numeric | No | Minimum grade level |
max_grade_level | numeric | No | Maximum grade level |
min_tenure_days | integer | No | Days of service needed |
employment_types | _text | No | Employment types — e.g. full_time, part_time. Empty = any. |
min_dependents | integer | No | Minimum dependents |
max_dependents | integer | No | Maximum dependents |
effective_from | date | No | Effective from |
effective_to | date | No | Effective to |
message | text | No | Said to the person refused |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example",
"plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"applies_at": "Enrollment and life events",
"min_age": 10,
"max_age": 10
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"applies_at": "Enrollment and life events",
"min_age": 10,
"max_age": 10,
"countries": [],
"regions": [],
"location_ids": [],
"min_grade_level": "1250.00",
"max_grade_level": "1250.00",
"min_tenure_days": 10,
"employment_types": []
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/benefit-eligibility-rules" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","plan_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","applies_at":"Enrollment and life events","min_age":10,"max_age":10}'PUT/api/hrms/benefit-eligibility-rules/{id}Change a benefit eligibility rule
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 |
|---|---|---|---|
plan_id | uuid | No | Plan (empty = every plan) |
code | text | Yes | Code |
name | text | Yes | Name |
applies_at | text | No | Judged at Allowed: Enrollment and life events Enrollment only Life events only |
min_age | integer | No | Minimum age |
max_age | integer | No | Maximum age |
countries | _text | No | Work countries — Codes separated by commas, e.g. US, CA. Empty = any. |
regions | _text | No | Work states / provinces — Separated by commas. Empty = any. |
location_ids | _uuid | No | Location ids |
min_grade_level | numeric | No | Minimum grade level |
max_grade_level | numeric | No | Maximum grade level |
min_tenure_days | integer | No | Days of service needed |
employment_types | _text | No | Employment types — e.g. full_time, part_time. Empty = any. |
min_dependents | integer | No | Minimum dependents |
max_dependents | integer | No | Maximum dependents |
effective_from | date | No | Effective from |
effective_to | date | No | Effective to |
message | text | No | Said to the person refused |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"applies_at": "Enrollment and life events",
"min_age": 10,
"max_age": 10,
"countries": [],
"regions": [],
"location_ids": [],
"min_grade_level": "1250.00",
"max_grade_level": "1250.00",
"min_tenure_days": 10,
"employment_types": []
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/benefit-eligibility-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/hrms/benefit-eligibility-rules/{id}Delete a benefit eligibility rule
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-eligibility-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/benefit-eligibility-rules/checkCheck
Request body
The keys this action reads (* = required; "one of" lists the only values):
employeeId, planId, asOf, contextResponse
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-eligibility-rules/check" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employeeId":"value","planId":"value","asOf":"value","context":"value"}'POST/api/hrms/benefit-eligibility-rules/{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-eligibility-rules/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 eligibility rule, 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 |
plan_id | uuid | read, write | Plan (empty = every plan) |
code | text | read, write | Code |
name | text | read, write | Name |
applies_at | text | read, write | Judged at Allowed: Enrollment and life events Enrollment only Life events only |
min_age | integer | read, write | Minimum age |
max_age | integer | read, write | Maximum age |
countries | _text | read, write | Work countries — Codes separated by commas, e.g. US, CA. Empty = any. |
regions | _text | read, write | Work states / provinces — Separated by commas. Empty = any. |
location_ids | _uuid | read, write | Location ids |
min_grade_level | numeric | read, write | Minimum grade level |
max_grade_level | numeric | read, write | Maximum grade level |
min_tenure_days | integer | read, write | Days of service needed |
employment_types | _text | read, write | Employment types — e.g. full_time, part_time. Empty = any. |
min_dependents | integer | read, write | Minimum dependents |
max_dependents | integer | read, write | Maximum dependents |
effective_from | date | read, write | Effective from |
effective_to | date | read, write | Effective to |
message | text | read, write | Said to the person refused |
is_active | boolean | read, write | Active |
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 |
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 |
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 Eligibility Rules 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.