TRANXACT.AI Help

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.

Type REST10 operationsBase path /api/hrms/benefit-carriersPublished as /api/v1/benefit-carriers

Download specification (OpenAPI 3.1) Screen: Carriers & Recordkeepers

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 › 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.
Tablehr.benefit_carriers · 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-carriersList carriers & recordkeepers

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

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

FieldTypeRequiredDescription
codetextYesCode
nametextYesName — A plan whose carrier is this name (Benefit Plans) is this carrier’s, or link plans with "Plans covered".
carrier_kindtextNoKind
Allowed: insurance retirement
file_formattextNoFile it takes
Allowed: ANSI X12 834 enrollment (005010X220A1) Contribution and loan file (CSV, after payroll) Eligibility file (CSV)
isa_sender_qualtextNoISA sender qualifier
isa_sender_idtextNoISA sender id
isa_receiver_qualtextNoISA receiver qualifier
isa_receiver_idtextNoISA receiver id
gs_sender_idtextNoGs sender id
gs_receiver_idtextNoGs receiver id
usage_indicatortextNoTest or production — T until the carrier has accepted a test file.
Allowed: T P
sponsor_nametextNoPlan sponsor (N1 P5)
sponsor_tax_idtextNoSponsor EIN
insurer_nametextNoInsurer (N1 IN)
insurer_tax_idtextNoInsurer tax id
master_policy_notextNoMaster policy / group number
line_codesjsonbNoInsurance 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.
layoutjsonbNoColumns (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 ...
delimitertextNoDelimiter — , or | or tab
include_headerbooleanNoHeader row
date_formattextNoDates
Allowed: YYYY-MM-DD MM/DD/YYYY YYYYMMDD
plan_numbertextNoRecordkeeper plan number
deduction_mapjsonbNoDeduction 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_postbooleanNoBuild the file when a payroll run is posted
delivery_methodtextNoDelivered by
Allowed: Download and upload to the carrier portal HTTPS to the carrier’s endpoint SFTP
endpoint_urltextNoEndpoint (https://)
sftp_hosttextNoSFTP host
sftp_portintegerNoSFTP port
sftp_usertextNoSFTP user
sftp_pathtextNoSFTP folder
file_name_patterntextNoFile name — {carrier}_{kind}_{date}_{no} by default; {run} is the payroll run.
contact_emailtextNoCarrier contact
notestextNoNotes
is_activebooleanNoActive
sftp_host_key_sha256textNoPinned 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

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 — A plan whose carrier is this name (Benefit Plans) is this carrier’s, or link plans with "Plans covered".
carrier_kindtextNoKind
Allowed: insurance retirement
file_formattextNoFile it takes
Allowed: ANSI X12 834 enrollment (005010X220A1) Contribution and loan file (CSV, after payroll) Eligibility file (CSV)
isa_sender_qualtextNoISA sender qualifier
isa_sender_idtextNoISA sender id
isa_receiver_qualtextNoISA receiver qualifier
isa_receiver_idtextNoISA receiver id
gs_sender_idtextNoGs sender id
gs_receiver_idtextNoGs receiver id
usage_indicatortextNoTest or production — T until the carrier has accepted a test file.
Allowed: T P
sponsor_nametextNoPlan sponsor (N1 P5)
sponsor_tax_idtextNoSponsor EIN
insurer_nametextNoInsurer (N1 IN)
insurer_tax_idtextNoInsurer tax id
master_policy_notextNoMaster policy / group number
line_codesjsonbNoInsurance 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.
layoutjsonbNoColumns (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 ...
delimitertextNoDelimiter — , or | or tab
include_headerbooleanNoHeader row
date_formattextNoDates
Allowed: YYYY-MM-DD MM/DD/YYYY YYYYMMDD
plan_numbertextNoRecordkeeper plan number
deduction_mapjsonbNoDeduction 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_postbooleanNoBuild the file when a payroll run is posted
delivery_methodtextNoDelivered by
Allowed: Download and upload to the carrier portal HTTPS to the carrier’s endpoint SFTP
endpoint_urltextNoEndpoint (https://)
sftp_hosttextNoSFTP host
sftp_portintegerNoSFTP port
sftp_usertextNoSFTP user
sftp_pathtextNoSFTP folder
file_name_patterntextNoFile name — {carrier}_{kind}_{date}_{no} by default; {run} is the payroll run.
contact_emailtextNoCarrier contact
notestextNoNotes
is_activebooleanNoActive
sftp_host_key_sha256textNoPinned 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

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

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

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):

planCodes, plans

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

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):

secret

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

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):

pin, expect

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
codetextread, writeCode
nametextread, writeName — A plan whose carrier is this name (Benefit Plans) is this carrier’s, or link plans with "Plans covered".
carrier_kindtextread, writeKind
Allowed: insurance retirement
file_formattextread, writeFile it takes
Allowed: ANSI X12 834 enrollment (005010X220A1) Contribution and loan file (CSV, after payroll) Eligibility file (CSV)
isa_sender_qualtextread, writeISA sender qualifier
isa_sender_idtextread, writeISA sender id
isa_receiver_qualtextread, writeISA receiver qualifier
isa_receiver_idtextread, writeISA receiver id
gs_sender_idtextread, writeGs sender id
gs_receiver_idtextread, writeGs receiver id
usage_indicatortextread, writeTest or production — T until the carrier has accepted a test file.
Allowed: T P
isa_control_lastintegerread onlyIsa control last
sponsor_nametextread, writePlan sponsor (N1 P5)
sponsor_tax_idtextread, writeSponsor EIN
insurer_nametextread, writeInsurer (N1 IN)
insurer_tax_idtextread, writeInsurer tax id
master_policy_notextread, writeMaster policy / group number
line_codesjsonbread, writeInsurance 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.
layoutjsonbread, writeColumns (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 ...
delimitertextread, writeDelimiter — , or | or tab
include_headerbooleanread, writeHeader row
date_formattextread, writeDates
Allowed: YYYY-MM-DD MM/DD/YYYY YYYYMMDD
plan_numbertextread, writeRecordkeeper plan number
deduction_mapjsonbread, writeDeduction 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_postbooleanread, writeBuild the file when a payroll run is posted
delivery_methodtextread, writeDelivered by
Allowed: Download and upload to the carrier portal HTTPS to the carrier’s endpoint SFTP
endpoint_urltextread, writeEndpoint (https://)
sftp_hosttextread, writeSFTP host
sftp_portintegerread, writeSFTP port
sftp_usertextread, writeSFTP user
sftp_pathtextread, writeSFTP folder
credential_sealedtextread onlyCredential sealed
file_name_patterntextread, writeFile name — {carrier}_{kind}_{date}_{no} by default; {run} is the payroll run.
contact_emailtextread, writeCarrier contact
notestextread, writeNotes
is_activebooleanread, writeActive
org_unit_iduuidread onlyOrg unit id
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
sftp_host_key_sha256textread, writePinned 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_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

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 › Carriers & Recordkeepers 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.