HRMS · Benefits
Benefit Plans
What is offered, who carries it, and what a period of it costs the employee and the employer. Every election is against one of these.
/api/hrms/benefit-plansPublished as /api/v1/benefit-plansOverview
| 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 Plans 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_plans · 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
10 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/benefit-plansList benefit plans
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",
"code": "COD-000001",
"name": "Example",
"plan_type": "medical",
"employee_cost_per_period": "1250.00",
"employer_cost_per_period": "1250.00",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_year_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"category": "text",
"carrier": "text",
"policy_number": "POL-000001",
"deduction_code": "DED-000001",
"is_pretax": true,
"allows_dependants": true
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/benefit-plans?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/benefit-plans/{id}Read one benefit plans
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",
"code": "COD-000001",
"name": "Example",
"plan_type": "medical",
"employee_cost_per_period": "1250.00",
"employer_cost_per_period": "1250.00",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_year_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"category": "text",
"carrier": "text",
"policy_number": "POL-000001",
"deduction_code": "DED-000001",
"is_pretax": true,
"allows_dependants": true
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/benefit-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/benefit-plansCreate a benefit plans
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
plan_type | text | No | Type Allowed: medical dental vision life disability retirement other |
employee_cost_per_period | numeric | No | Employee cost a period — For a plan without coverage tiers. A plan with tiers charges the tier chosen. |
employer_cost_per_period | numeric | No | Employer cost a period |
plan_year_id | uuid | No | Plan year — Its enrollment window is when employees may choose or change this plan without a life event. |
category | text | No | Category |
carrier | text | No | Carrier |
policy_number | text | No | Policy number |
deduction_code | text | No | Deduction code — The payroll deduction the employee share is taken under. |
is_pretax | boolean | No | Is pretax |
allows_dependants | boolean | No | Allows dependants |
waiting_period_days | integer | No | Waiting period (days) — Days of service before a new hire may join. |
min_hours_week | numeric | No | Minimum hours a week |
min_fte | numeric | No | Minimum FTE — Between 0 and 1, e.g. 0.75. |
eligible_employment_types | _text | No | Employment types — Separated by commas, e.g. full_time, part_time. Empty: every type. |
annual_limit | numeric | No | Annual limit |
is_active | boolean | No | Active |
tax_treatment | text | No | Tax treatment — Left empty, it follows the plan category and the deduction code. Allowed: Pre-tax, Section 125 (medical, dental, vision, health FSA) Pre-tax HSA (W-2 box 12 W) Pre-tax dependent care FSA (W-2 box 10) Pre-tax transit and parking (Section 132) Pre-tax 401(k) (box 12 D; FICA still due) Pre-tax 403(b) (box 12 E) Pre-tax 457(b) (box 12 G) Roth 401(k), after tax (box 12 AA) Roth 403(b), after tax (box 12 BB) Roth 457(b), after tax (box 12 EE) After tax (supplemental life, accident) Group-term life (cover over $50,000 imputed, box 12 C) |
w2_box | text | No | W-2 box — Only to override: for example 12DD to report stand-alone dental in box 12 DD. |
Sample body
{
"code": "COD-000001",
"name": "Example",
"plan_type": "medical",
"employee_cost_per_period": "1250.00",
"employer_cost_per_period": "1250.00",
"plan_year_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"plan_type": "medical",
"employee_cost_per_period": "1250.00",
"employer_cost_per_period": "1250.00",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_year_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"category": "text",
"carrier": "text",
"policy_number": "POL-000001",
"deduction_code": "DED-000001",
"is_pretax": true,
"allows_dependants": true
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/benefit-plans" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","plan_type":"medical","employee_cost_per_period":"1250.00","employer_cost_per_period":"1250.00","plan_year_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/hrms/benefit-plans/{id}Change a benefit plans
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 |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
plan_type | text | No | Type Allowed: medical dental vision life disability retirement other |
employee_cost_per_period | numeric | No | Employee cost a period — For a plan without coverage tiers. A plan with tiers charges the tier chosen. |
employer_cost_per_period | numeric | No | Employer cost a period |
plan_year_id | uuid | No | Plan year — Its enrollment window is when employees may choose or change this plan without a life event. |
category | text | No | Category |
carrier | text | No | Carrier |
policy_number | text | No | Policy number |
deduction_code | text | No | Deduction code — The payroll deduction the employee share is taken under. |
is_pretax | boolean | No | Is pretax |
allows_dependants | boolean | No | Allows dependants |
waiting_period_days | integer | No | Waiting period (days) — Days of service before a new hire may join. |
min_hours_week | numeric | No | Minimum hours a week |
min_fte | numeric | No | Minimum FTE — Between 0 and 1, e.g. 0.75. |
eligible_employment_types | _text | No | Employment types — Separated by commas, e.g. full_time, part_time. Empty: every type. |
annual_limit | numeric | No | Annual limit |
is_active | boolean | No | Active |
tax_treatment | text | No | Tax treatment — Left empty, it follows the plan category and the deduction code. Allowed: Pre-tax, Section 125 (medical, dental, vision, health FSA) Pre-tax HSA (W-2 box 12 W) Pre-tax dependent care FSA (W-2 box 10) Pre-tax transit and parking (Section 132) Pre-tax 401(k) (box 12 D; FICA still due) Pre-tax 403(b) (box 12 E) Pre-tax 457(b) (box 12 G) Roth 401(k), after tax (box 12 AA) Roth 403(b), after tax (box 12 BB) Roth 457(b), after tax (box 12 EE) After tax (supplemental life, accident) Group-term life (cover over $50,000 imputed, box 12 C) |
w2_box | text | No | W-2 box — Only to override: for example 12DD to report stand-alone dental in box 12 DD. |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"plan_type": "medical",
"employee_cost_per_period": "1250.00",
"employer_cost_per_period": "1250.00",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_year_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"category": "text",
"carrier": "text",
"policy_number": "POL-000001",
"deduction_code": "DED-000001",
"is_pretax": true,
"allows_dependants": true
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/benefit-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/hrms/benefit-plans/{id}Delete a benefit plans
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-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/benefit-plans/{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-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/hrms/benefit-plans/{parentId}/tiersTiers
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/benefit-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tiers" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/benefit-plans/{parentId}/tiersTiers
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, 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 POST "https://demo.tranxact.ai/api/hrms/benefit-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tiers" \
-H "Authorization: Bearer $TOKEN"PUT/api/hrms/benefit-plans/{parentId}/tiers/{lineId}Tiers
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tiers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/hrms/benefit-plans/{parentId}/tiers/{lineId}Tiers
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tiers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a benefit plans, 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 |
code | text | read, write | Code |
name | text | read, write | Name |
plan_type | text | read, write | Type Allowed: medical dental vision life disability retirement other |
employee_cost_per_period | numeric | read, write | Employee cost a period — For a plan without coverage tiers. A plan with tiers charges the tier chosen. |
employer_cost_per_period | numeric | read, write | Employer cost a period |
org_unit_id | uuid | read only | Org unit id |
plan_year_id | uuid | read, write | Plan year — Its enrollment window is when employees may choose or change this plan without a life event. |
category | text | read, write | Category |
carrier | text | read, write | Carrier |
policy_number | text | read, write | Policy number |
deduction_code | text | read, write | Deduction code — The payroll deduction the employee share is taken under. |
is_pretax | boolean | read, write | Is pretax |
allows_dependants | boolean | read, write | Allows dependants |
requires_evidence | boolean | read only | Requires evidence |
waiting_period_days | integer | read, write | Waiting period (days) — Days of service before a new hire may join. |
min_hours_week | numeric | read, write | Minimum hours a week |
min_fte | numeric | read, write | Minimum FTE — Between 0 and 1, e.g. 0.75. |
eligible_employment_types | _text | read, write | Employment types — Separated by commas, e.g. full_time, part_time. Empty: every type. |
annual_limit | numeric | read, write | Annual limit |
employer_contribution_percent | numeric | read only | Employer contribution percent |
is_default | boolean | read only | Is default |
is_active | boolean | read, write | Active |
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 |
tax_treatment | text | read, write | Tax treatment — Left empty, it follows the plan category and the deduction code. Allowed: Pre-tax, Section 125 (medical, dental, vision, health FSA) Pre-tax HSA (W-2 box 12 W) Pre-tax dependent care FSA (W-2 box 10) Pre-tax transit and parking (Section 132) Pre-tax 401(k) (box 12 D; FICA still due) Pre-tax 403(b) (box 12 E) Pre-tax 457(b) (box 12 G) Roth 401(k), after tax (box 12 AA) Roth 403(b), after tax (box 12 BB) Roth 457(b), after tax (box 12 EE) After tax (supplemental life, accident) Group-term life (cover over $50,000 imputed, box 12 C) |
w2_box | text | read, write | W-2 box — Only to override: for example 12DD to report stand-alone dental in box 12 DD. |
carrier_id | uuid | read only | Carrier id |
is_mec | boolean | read only | Is mec |
is_min_value | boolean | read only | Is min value |
self_insured | boolean | read only | Self insured |
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 Plans 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.