TRANXACT.AI Help

HRMS · Services and actions

Benefits

The benefits service of HRMS: 3 operation(s).

Type REST3 operationsBase path /api/hrms/benefits

Download specification (OpenAPI 3.1)

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

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

GET/api/hrms/benefits/eligibility/{employeeId}Eligibility

Path parameters

NameTypeDescription
employeeIdstring (uuid)The record's employeeId, as a list returns it.

Response

200 with the data as JSON.

Sample request

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

Request body

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

employeeId*, planId, tierId*, effectiveDate, dependantIds, annualElection, lifeEventId, waive, waiverReason

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/benefits/elect" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employeeId":"value","planId":"value","tierId":"value","effectiveDate":"value","dependantIds":"value","annualElection":"value"}'
POST/api/hrms/benefits/life-eventLife event

Request body

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

employeeId*, eventType, eventDate, windowDays, notes; eventType one of marriage|divorce|birth|adoption|death|spouse_job_change|dependant_ages_off|relocation|status_change|loss_of_other_cover|gain_of_other_cover

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/benefits/life-event" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employeeId":"value","eventType":"value","eventDate":"value","windowDays":"value","notes;":"value"}'

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