TRANXACT.AI Help

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.

Type REST10 operationsBase path /api/hrms/benefit-plansPublished as /api/v1/benefit-plans

Download specification (OpenAPI 3.1) Screen: Benefit Plans

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 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.
Tablehr.benefit_plans · 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

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

GET/api/hrms/benefit-plansList benefit plans

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",
      "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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
plan_typetextNoType
Allowed: medical dental vision life disability retirement other
employee_cost_per_periodnumericNoEmployee cost a period — For a plan without coverage tiers. A plan with tiers charges the tier chosen.
employer_cost_per_periodnumericNoEmployer cost a period
plan_year_iduuidNoPlan year — Its enrollment window is when employees may choose or change this plan without a life event.
categorytextNoCategory
carriertextNoCarrier
policy_numbertextNoPolicy number
deduction_codetextNoDeduction code — The payroll deduction the employee share is taken under.
is_pretaxbooleanNoIs pretax
allows_dependantsbooleanNoAllows dependants
waiting_period_daysintegerNoWaiting period (days) — Days of service before a new hire may join.
min_hours_weeknumericNoMinimum hours a week
min_ftenumericNoMinimum FTE — Between 0 and 1, e.g. 0.75.
eligible_employment_types_textNoEmployment types — Separated by commas, e.g. full_time, part_time. Empty: every type.
annual_limitnumericNoAnnual limit
is_activebooleanNoActive
tax_treatmenttextNoTax 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_boxtextNoW-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

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
codetextYesCode
nametextYesName
plan_typetextNoType
Allowed: medical dental vision life disability retirement other
employee_cost_per_periodnumericNoEmployee cost a period — For a plan without coverage tiers. A plan with tiers charges the tier chosen.
employer_cost_per_periodnumericNoEmployer cost a period
plan_year_iduuidNoPlan year — Its enrollment window is when employees may choose or change this plan without a life event.
categorytextNoCategory
carriertextNoCarrier
policy_numbertextNoPolicy number
deduction_codetextNoDeduction code — The payroll deduction the employee share is taken under.
is_pretaxbooleanNoIs pretax
allows_dependantsbooleanNoAllows dependants
waiting_period_daysintegerNoWaiting period (days) — Days of service before a new hire may join.
min_hours_weeknumericNoMinimum hours a week
min_ftenumericNoMinimum FTE — Between 0 and 1, e.g. 0.75.
eligible_employment_types_textNoEmployment types — Separated by commas, e.g. full_time, part_time. Empty: every type.
annual_limitnumericNoAnnual limit
is_activebooleanNoActive
tax_treatmenttextNoTax 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_boxtextNoW-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

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-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/benefit-plans/{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-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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
codetextread, writeCode
nametextread, writeName
plan_typetextread, writeType
Allowed: medical dental vision life disability retirement other
employee_cost_per_periodnumericread, writeEmployee cost a period — For a plan without coverage tiers. A plan with tiers charges the tier chosen.
employer_cost_per_periodnumericread, writeEmployer cost a period
org_unit_iduuidread onlyOrg unit id
plan_year_iduuidread, writePlan year — Its enrollment window is when employees may choose or change this plan without a life event.
categorytextread, writeCategory
carriertextread, writeCarrier
policy_numbertextread, writePolicy number
deduction_codetextread, writeDeduction code — The payroll deduction the employee share is taken under.
is_pretaxbooleanread, writeIs pretax
allows_dependantsbooleanread, writeAllows dependants
requires_evidencebooleanread onlyRequires evidence
waiting_period_daysintegerread, writeWaiting period (days) — Days of service before a new hire may join.
min_hours_weeknumericread, writeMinimum hours a week
min_ftenumericread, writeMinimum FTE — Between 0 and 1, e.g. 0.75.
eligible_employment_types_textread, writeEmployment types — Separated by commas, e.g. full_time, part_time. Empty: every type.
annual_limitnumericread, writeAnnual limit
employer_contribution_percentnumericread onlyEmployer contribution percent
is_defaultbooleanread onlyIs default
is_activebooleanread, writeActive
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
tax_treatmenttextread, writeTax 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_boxtextread, writeW-2 box — Only to override: for example 12DD to report stand-alone dental in box 12 DD.
carrier_iduuidread onlyCarrier id
is_mecbooleanread onlyIs mec
is_min_valuebooleanread onlyIs min value
self_insuredbooleanread onlySelf insured

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 Plans 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.