HRMS · Carriers & ACA
Carriers & Recordkeepers
Who is sent what: an insurer (Aflac, Prudential ...) its 834 enrollment file, a 401(k) or 457 recordkeeper (Vanguard, Nationwide ...) its contribution file after each payroll, in its own layout, and how it is delivered.
/api/hrms/benefit-carriersPublished as /api/v1/benefit-carriersDownload specification (OpenAPI 3.1) Screen: Carriers & Recordkeepers
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 › Carriers & Recordkeepers 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_carriers · 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-carriersList carriers & recordkeepers
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",
"carrier_kind": "insurance",
"file_format": "ANSI X12 834 enrollment (005010X220A1)",
"isa_sender_qual": "text",
"isa_sender_id": "text",
"isa_receiver_qual": "text",
"isa_receiver_id": "text",
"gs_sender_id": "text",
"gs_receiver_id": "text",
"usage_indicator": "T",
"isa_control_last": 10,
"sponsor_name": "Example"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/benefit-carriers?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/benefit-carriers/{id}Read one benefit carriers
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",
"carrier_kind": "insurance",
"file_format": "ANSI X12 834 enrollment (005010X220A1)",
"isa_sender_qual": "text",
"isa_sender_id": "text",
"isa_receiver_qual": "text",
"isa_receiver_id": "text",
"gs_sender_id": "text",
"gs_receiver_id": "text",
"usage_indicator": "T",
"isa_control_last": 10,
"sponsor_name": "Example"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/benefit-carriers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/benefit-carriersCreate a benefit carriers
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name — A plan whose carrier is this name (Benefit Plans) is this carrier’s, or link plans with "Plans covered". |
carrier_kind | text | No | Kind Allowed: insurance retirement |
file_format | text | No | File it takes Allowed: ANSI X12 834 enrollment (005010X220A1) Contribution and loan file (CSV, after payroll) Eligibility file (CSV) |
isa_sender_qual | text | No | ISA sender qualifier |
isa_sender_id | text | No | ISA sender id |
isa_receiver_qual | text | No | ISA receiver qualifier |
isa_receiver_id | text | No | ISA receiver id |
gs_sender_id | text | No | Gs sender id |
gs_receiver_id | text | No | Gs receiver id |
usage_indicator | text | No | Test or production — T until the carrier has accepted a test file. Allowed: T P |
sponsor_name | text | No | Plan sponsor (N1 P5) |
sponsor_tax_id | text | No | Sponsor EIN |
insurer_name | text | No | Insurer (N1 IN) |
insurer_tax_id | text | No | Insurer tax id |
master_policy_no | text | No | Master policy / group number |
line_codes | jsonb | No | Insurance line codes (JSON) — Over the defaults, by plan category: {"accident":"AK","critical_illness":"AG"}. Defaults: medical HLT, dental DEN, vision VIS, life LIF, disability STD/LTD. |
layout | jsonb | No | Columns (JSON) — Empty: the default layout. Or [{"header":"SSN","field":"ssn"},{"header":"Pre-Tax","field":"deferral_pretax"}, ...]. Fields: ssn, employee_no, last_name, first_name, birth_date, hire_date, termination_date, pay_date, deferral_pretax, deferral_roth, employer_match, loan_repayment, plan_compensation, ytd_compensation, hours, ytd_hours, plan_number ... |
delimiter | text | No | Delimiter — , or | or tab |
include_header | boolean | No | Header row |
date_format | text | No | Dates Allowed: YYYY-MM-DD MM/DD/YYYY YYYYMMDD |
plan_number | text | No | Recordkeeper plan number |
deduction_map | jsonb | No | Deduction codes by source (JSON) — e.g. {"pretax":["401K"],"roth":["ROTH"],"match":["401K-ER"],"loan":["LOAN"]}. Empty: by category (pre-tax retirement, Roth, the match, loan repayment). |
auto_after_post | boolean | No | Build the file when a payroll run is posted |
delivery_method | text | No | Delivered by Allowed: Download and upload to the carrier portal HTTPS to the carrier’s endpoint SFTP |
endpoint_url | text | No | Endpoint (https://) |
sftp_host | text | No | SFTP host |
sftp_port | integer | No | SFTP port |
sftp_user | text | No | SFTP user |
sftp_path | text | No | SFTP folder |
file_name_pattern | text | No | File name — {carrier}_{kind}_{date}_{no} by default; {run} is the payroll run. |
contact_email | text | No | Carrier contact |
notes | text | No | Notes |
is_active | boolean | No | Active |
sftp_host_key_sha256 | text | No | Pinned host key (SHA256) — Use Fetch host key, compare it with what the carrier publishes, then pin it. Nothing is sent until one is pinned. |
Sample body
{
"code": "COD-000001",
"name": "Example",
"carrier_kind": "insurance",
"file_format": "ANSI X12 834 enrollment (005010X220A1)",
"isa_sender_qual": "text",
"isa_sender_id": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"carrier_kind": "insurance",
"file_format": "ANSI X12 834 enrollment (005010X220A1)",
"isa_sender_qual": "text",
"isa_sender_id": "text",
"isa_receiver_qual": "text",
"isa_receiver_id": "text",
"gs_sender_id": "text",
"gs_receiver_id": "text",
"usage_indicator": "T",
"isa_control_last": 10,
"sponsor_name": "Example"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/benefit-carriers" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","carrier_kind":"insurance","file_format":"ANSI X12 834 enrollment (005010X220A1)","isa_sender_qual":"text","isa_sender_id":"text"}'PUT/api/hrms/benefit-carriers/{id}Change a benefit carriers
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 — A plan whose carrier is this name (Benefit Plans) is this carrier’s, or link plans with "Plans covered". |
carrier_kind | text | No | Kind Allowed: insurance retirement |
file_format | text | No | File it takes Allowed: ANSI X12 834 enrollment (005010X220A1) Contribution and loan file (CSV, after payroll) Eligibility file (CSV) |
isa_sender_qual | text | No | ISA sender qualifier |
isa_sender_id | text | No | ISA sender id |
isa_receiver_qual | text | No | ISA receiver qualifier |
isa_receiver_id | text | No | ISA receiver id |
gs_sender_id | text | No | Gs sender id |
gs_receiver_id | text | No | Gs receiver id |
usage_indicator | text | No | Test or production — T until the carrier has accepted a test file. Allowed: T P |
sponsor_name | text | No | Plan sponsor (N1 P5) |
sponsor_tax_id | text | No | Sponsor EIN |
insurer_name | text | No | Insurer (N1 IN) |
insurer_tax_id | text | No | Insurer tax id |
master_policy_no | text | No | Master policy / group number |
line_codes | jsonb | No | Insurance line codes (JSON) — Over the defaults, by plan category: {"accident":"AK","critical_illness":"AG"}. Defaults: medical HLT, dental DEN, vision VIS, life LIF, disability STD/LTD. |
layout | jsonb | No | Columns (JSON) — Empty: the default layout. Or [{"header":"SSN","field":"ssn"},{"header":"Pre-Tax","field":"deferral_pretax"}, ...]. Fields: ssn, employee_no, last_name, first_name, birth_date, hire_date, termination_date, pay_date, deferral_pretax, deferral_roth, employer_match, loan_repayment, plan_compensation, ytd_compensation, hours, ytd_hours, plan_number ... |
delimiter | text | No | Delimiter — , or | or tab |
include_header | boolean | No | Header row |
date_format | text | No | Dates Allowed: YYYY-MM-DD MM/DD/YYYY YYYYMMDD |
plan_number | text | No | Recordkeeper plan number |
deduction_map | jsonb | No | Deduction codes by source (JSON) — e.g. {"pretax":["401K"],"roth":["ROTH"],"match":["401K-ER"],"loan":["LOAN"]}. Empty: by category (pre-tax retirement, Roth, the match, loan repayment). |
auto_after_post | boolean | No | Build the file when a payroll run is posted |
delivery_method | text | No | Delivered by Allowed: Download and upload to the carrier portal HTTPS to the carrier’s endpoint SFTP |
endpoint_url | text | No | Endpoint (https://) |
sftp_host | text | No | SFTP host |
sftp_port | integer | No | SFTP port |
sftp_user | text | No | SFTP user |
sftp_path | text | No | SFTP folder |
file_name_pattern | text | No | File name — {carrier}_{kind}_{date}_{no} by default; {run} is the payroll run. |
contact_email | text | No | Carrier contact |
notes | text | No | Notes |
is_active | boolean | No | Active |
sftp_host_key_sha256 | text | No | Pinned host key (SHA256) — Use Fetch host key, compare it with what the carrier publishes, then pin it. Nothing is sent until one is pinned. |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"carrier_kind": "insurance",
"file_format": "ANSI X12 834 enrollment (005010X220A1)",
"isa_sender_qual": "text",
"isa_sender_id": "text",
"isa_receiver_qual": "text",
"isa_receiver_id": "text",
"gs_sender_id": "text",
"gs_receiver_id": "text",
"usage_indicator": "T",
"isa_control_last": 10,
"sponsor_name": "Example"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/benefit-carriers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/hrms/benefit-carriers/{id}Delete a benefit carriers
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-carriers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/benefit-carriers/fieldsFields
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/benefit-carriers/fields" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/benefit-carriers/{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-carriers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'POST/api/hrms/benefit-carriers/{id}/plansPlans
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):
planCodes, plansResponse
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-carriers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/plans" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"planCodes":"value","plans":"value"}'POST/api/hrms/benefit-carriers/{id}/credentialCredential
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):
secretResponse
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-carriers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/credential" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"secret":"value"}'POST/api/hrms/benefit-carriers/{id}/host-keyHost key
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):
pin, expectResponse
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-carriers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/host-key" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"pin":"value","expect":"value"}'Data model
Every field of a benefit carriers, 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 — A plan whose carrier is this name (Benefit Plans) is this carrier’s, or link plans with "Plans covered". |
carrier_kind | text | read, write | Kind Allowed: insurance retirement |
file_format | text | read, write | File it takes Allowed: ANSI X12 834 enrollment (005010X220A1) Contribution and loan file (CSV, after payroll) Eligibility file (CSV) |
isa_sender_qual | text | read, write | ISA sender qualifier |
isa_sender_id | text | read, write | ISA sender id |
isa_receiver_qual | text | read, write | ISA receiver qualifier |
isa_receiver_id | text | read, write | ISA receiver id |
gs_sender_id | text | read, write | Gs sender id |
gs_receiver_id | text | read, write | Gs receiver id |
usage_indicator | text | read, write | Test or production — T until the carrier has accepted a test file. Allowed: T P |
isa_control_last | integer | read only | Isa control last |
sponsor_name | text | read, write | Plan sponsor (N1 P5) |
sponsor_tax_id | text | read, write | Sponsor EIN |
insurer_name | text | read, write | Insurer (N1 IN) |
insurer_tax_id | text | read, write | Insurer tax id |
master_policy_no | text | read, write | Master policy / group number |
line_codes | jsonb | read, write | Insurance line codes (JSON) — Over the defaults, by plan category: {"accident":"AK","critical_illness":"AG"}. Defaults: medical HLT, dental DEN, vision VIS, life LIF, disability STD/LTD. |
layout | jsonb | read, write | Columns (JSON) — Empty: the default layout. Or [{"header":"SSN","field":"ssn"},{"header":"Pre-Tax","field":"deferral_pretax"}, ...]. Fields: ssn, employee_no, last_name, first_name, birth_date, hire_date, termination_date, pay_date, deferral_pretax, deferral_roth, employer_match, loan_repayment, plan_compensation, ytd_compensation, hours, ytd_hours, plan_number ... |
delimiter | text | read, write | Delimiter — , or | or tab |
include_header | boolean | read, write | Header row |
date_format | text | read, write | Dates Allowed: YYYY-MM-DD MM/DD/YYYY YYYYMMDD |
plan_number | text | read, write | Recordkeeper plan number |
deduction_map | jsonb | read, write | Deduction codes by source (JSON) — e.g. {"pretax":["401K"],"roth":["ROTH"],"match":["401K-ER"],"loan":["LOAN"]}. Empty: by category (pre-tax retirement, Roth, the match, loan repayment). |
auto_after_post | boolean | read, write | Build the file when a payroll run is posted |
delivery_method | text | read, write | Delivered by Allowed: Download and upload to the carrier portal HTTPS to the carrier’s endpoint SFTP |
endpoint_url | text | read, write | Endpoint (https://) |
sftp_host | text | read, write | SFTP host |
sftp_port | integer | read, write | SFTP port |
sftp_user | text | read, write | SFTP user |
sftp_path | text | read, write | SFTP folder |
credential_sealed | text | read only | Credential sealed |
file_name_pattern | text | read, write | File name — {carrier}_{kind}_{date}_{no} by default; {run} is the payroll run. |
contact_email | text | read, write | Carrier contact |
notes | text | read, write | Notes |
is_active | boolean | read, write | Active |
org_unit_id | uuid | read only | Org unit id |
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 |
sftp_host_key_sha256 | text | read, write | Pinned host key (SHA256) — Use Fetch host key, compare it with what the carrier publishes, then pin it. Nothing is sent until one is pinned. |
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 › Carriers & Recordkeepers 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.