TRANXACT.AI Help

HRMS · Carriers & ACA

ACA Forms (1095-C / 1094-C)

Form 1095-C lines 14, 15 and 16 for every month, the 1094-C transmittal, printing, AIR-shaped XML and corrections.

Type REST9 operationsBase path /api/hrms/aca-forms

Download specification (OpenAPI 3.1) Screen: ACA Forms (1095-C / 1094-C)

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 Forms (1095-C / 1094-C) 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.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/hrms/aca-formsRead aca forms (1095-c / 1094-c)

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/aca-forms" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/aca-forms/generateGenerate

Request body

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

year

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-forms/generate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"year":"value"}'
POST/api/hrms/aca-forms/finalizeFinalize

Request body

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

year

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-forms/finalize" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"year":"value"}'
GET/api/hrms/aca-forms/transmittal/{id}/pdfTransmittal pdf

Path parameters

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

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/aca-forms/transmittal/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/pdf" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/aca-forms/transmittal/{id}/correctTransmittal correct

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/aca-forms/transmittal/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/correct" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/aca-forms/xmlXml

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/aca-forms/xml" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/aca-forms/{id}/pdfPdf

Path parameters

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

Response

200 with the data as JSON.

Sample request

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

Request body

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

employeeId, employee_id, employee, employeeNo, employee_no, year, taxYear, tax_year

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-forms/correct" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employeeId":"value","employee_id":"value","employee":"value","employeeNo":"value","employee_no":"value","year":"value"}'
POST/api/hrms/aca-forms/{id}/correctCorrect

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/aca-forms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/correct" \
  -H "Authorization: Bearer $TOKEN"

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 Forms (1095-C / 1094-C) 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.