TRANXACT.AI Help

HRMS · Carriers & ACA

ACA Settings

The measurement method and periods, the affordability safe harbor, and the employer (ALE member) on the 1094-C. Mark which plans are minimum essential coverage and minimum value with "Plan ACA flags".

Type REST8 operationsBase path /api/hrms/aca-settingsPublished as /api/v1/aca-settings

Download specification (OpenAPI 3.1) Screen: ACA Settings

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 › ACA Settings 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.aca_settings · 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

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

GET/api/hrms/aca-settingsList aca settings

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",
      "measurement_method": "Look-back measurement (measurement, administrative, stability periods)",
      "standard_measurement_months": 10,
      "administrative_days": 10,
      "stability_months": 10,
      "initial_measurement_months": 10,
      "ft_hours_month": "1250.00",
      "salaried_hours_week": "1250.00",
      "plan_start_month": 10,
      "affordability_percent": "1250.00",
      "safe_harbor": "Rate of pay (2H)",
      "fpl_amount": "1250.00",
      "waiting_period_days": 10,
      "ale_name": "Example"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/hrms/aca-settings?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/aca-settings/{id}Read one aca settings

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "measurement_method": "Look-back measurement (measurement, administrative, stability periods)",
  "standard_measurement_months": 10,
  "administrative_days": 10,
  "stability_months": 10,
  "initial_measurement_months": 10,
  "ft_hours_month": "1250.00",
  "salaried_hours_week": "1250.00",
  "plan_start_month": 10,
  "affordability_percent": "1250.00",
  "safe_harbor": "Rate of pay (2H)",
  "fpl_amount": "1250.00",
  "waiting_period_days": 10,
  "ale_name": "Example"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/hrms/aca-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/aca-settingsCreate a aca settings

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
measurement_methodtextNoFull-time by
Allowed: Look-back measurement (measurement, administrative, stability periods) Monthly hours (130 a month)
standard_measurement_monthsintegerNoStandard measurement period (months)
administrative_daysintegerNoAdministrative period (days, at most 90)
stability_monthsintegerNoStability period (months)
initial_measurement_monthsintegerNoInitial measurement period, new variable-hour employees (months)
ft_hours_monthnumericNoFull-time hours a month
salaried_hours_weeknumericNoHours credited a salaried week
plan_start_monthintegerNoPlan year starts (month)
affordability_percentnumericNoAffordability percentage — 9.96 for 2026.
safe_harbortextNoAffordability safe harbor
Allowed: Rate of pay (2H) Form W-2 wages (2F) Federal poverty line (2G) None
fpl_amountnumericNoFederal poverty line (single, mainland)
waiting_period_daysintegerNoWaiting period for a new full-time hire (days)
ale_nametextNoEmployer name (1094-C line 1)
ale_eintextNoEmployer EIN
ale_addresstextNoAddress
ale_citytextNoCity
ale_statetextNoState
ale_ziptextNoZIP
contact_nametextNoContact person
contact_phonetextNoContact phone
is_aggregated_groupbooleanNoMember of an aggregated ALE group
transmitter_tcctextNoTransmitter control code (TCC)

Sample body

{
  "measurement_method": "Look-back measurement (measurement, administrative, stability periods)",
  "standard_measurement_months": 10,
  "administrative_days": 10,
  "stability_months": 10
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "measurement_method": "Look-back measurement (measurement, administrative, stability periods)",
  "standard_measurement_months": 10,
  "administrative_days": 10,
  "stability_months": 10,
  "initial_measurement_months": 10,
  "ft_hours_month": "1250.00",
  "salaried_hours_week": "1250.00",
  "plan_start_month": 10,
  "affordability_percent": "1250.00",
  "safe_harbor": "Rate of pay (2H)",
  "fpl_amount": "1250.00",
  "waiting_period_days": 10,
  "ale_name": "Example"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/aca-settings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"measurement_method":"Look-back measurement (measurement, administrative, stability periods)","standard_measurement_months":10,"administrative_days":10,"stability_months":10}'
PUT/api/hrms/aca-settings/{id}Change a aca settings

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
measurement_methodtextNoFull-time by
Allowed: Look-back measurement (measurement, administrative, stability periods) Monthly hours (130 a month)
standard_measurement_monthsintegerNoStandard measurement period (months)
administrative_daysintegerNoAdministrative period (days, at most 90)
stability_monthsintegerNoStability period (months)
initial_measurement_monthsintegerNoInitial measurement period, new variable-hour employees (months)
ft_hours_monthnumericNoFull-time hours a month
salaried_hours_weeknumericNoHours credited a salaried week
plan_start_monthintegerNoPlan year starts (month)
affordability_percentnumericNoAffordability percentage — 9.96 for 2026.
safe_harbortextNoAffordability safe harbor
Allowed: Rate of pay (2H) Form W-2 wages (2F) Federal poverty line (2G) None
fpl_amountnumericNoFederal poverty line (single, mainland)
waiting_period_daysintegerNoWaiting period for a new full-time hire (days)
ale_nametextNoEmployer name (1094-C line 1)
ale_eintextNoEmployer EIN
ale_addresstextNoAddress
ale_citytextNoCity
ale_statetextNoState
ale_ziptextNoZIP
contact_nametextNoContact person
contact_phonetextNoContact phone
is_aggregated_groupbooleanNoMember of an aggregated ALE group
transmitter_tcctextNoTransmitter control code (TCC)

Sample body

{
  "measurement_method": "Look-back measurement (measurement, administrative, stability periods)",
  "standard_measurement_months": 10
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "measurement_method": "Look-back measurement (measurement, administrative, stability periods)",
  "standard_measurement_months": 10,
  "administrative_days": 10,
  "stability_months": 10,
  "initial_measurement_months": 10,
  "ft_hours_month": "1250.00",
  "salaried_hours_week": "1250.00",
  "plan_start_month": 10,
  "affordability_percent": "1250.00",
  "safe_harbor": "Rate of pay (2H)",
  "fpl_amount": "1250.00",
  "waiting_period_days": 10,
  "ale_name": "Example"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/hrms/aca-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"measurement_method":"Look-back measurement (measurement, administrative, stability periods)","standard_measurement_months":10}'
DELETE/api/hrms/aca-settings/{id}Delete a aca settings

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/aca-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/aca-settings/plansPlans

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/aca-settings/plans" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/aca-settings/{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/aca-settings/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/aca-settings/plansPlans

Request body

The keys this action reads (* = required; "one of" lists the only values):

planId, planCode

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/aca-settings/plans" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"planId":"value","planCode":"value"}'

Data model

Every field of a aca settings, 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
measurement_methodtextread, writeFull-time by
Allowed: Look-back measurement (measurement, administrative, stability periods) Monthly hours (130 a month)
standard_measurement_monthsintegerread, writeStandard measurement period (months)
administrative_daysintegerread, writeAdministrative period (days, at most 90)
stability_monthsintegerread, writeStability period (months)
initial_measurement_monthsintegerread, writeInitial measurement period, new variable-hour employees (months)
ft_hours_monthnumericread, writeFull-time hours a month
salaried_hours_weeknumericread, writeHours credited a salaried week
plan_start_monthintegerread, writePlan year starts (month)
affordability_percentnumericread, writeAffordability percentage — 9.96 for 2026.
safe_harbortextread, writeAffordability safe harbor
Allowed: Rate of pay (2H) Form W-2 wages (2F) Federal poverty line (2G) None
fpl_amountnumericread, writeFederal poverty line (single, mainland)
waiting_period_daysintegerread, writeWaiting period for a new full-time hire (days)
ale_nametextread, writeEmployer name (1094-C line 1)
ale_eintextread, writeEmployer EIN
ale_addresstextread, writeAddress
ale_citytextread, writeCity
ale_statetextread, writeState
ale_ziptextread, writeZIP
contact_nametextread, writeContact person
contact_phonetextread, writeContact phone
is_aggregated_groupbooleanread, writeMember of an aggregated ALE group
transmitter_tcctextread, writeTransmitter control code (TCC)
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
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 › ACA Settings 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.