TRANXACT.AI Help

HRMS · Services and actions

Engines

The engines service of HRMS: 9 operation(s).

Type REST9 operationsBase path /api/hrms/engines

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 › Engines 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/engines/vendorsVendors

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/engines/vendors" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/enginesRead engines

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/engines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/enginesPost engines

Request body

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

kind, code*, name, vendor, product, environment, base_url, auth_type, config, direction, transport, on_failure

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/engines" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"kind":"value","code":"value","name":"value","vendor":"value","product":"value","environment":"value"}'
PUT/api/hrms/engines/{kind}/{id}Put engines

Path parameters

NameTypeDescription
kindstring (uuid)The record's kind, as a list returns it.
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):

config

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 PUT "https://demo.tranxact.ai/api/hrms/engines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"config":"value"}'
DELETE/api/hrms/engines/{kind}/{id}Delete engines

Path parameters

NameTypeDescription
kindstring (uuid)The record's kind, as a list returns it.
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 DELETE "https://demo.tranxact.ai/api/hrms/engines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/engines/{kind}/{id}/testTest

Path parameters

NameTypeDescription
kindstring (uuid)The record's kind, as a list returns it.
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/engines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/test" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/engines/tax/{id}/calculateTax calculate

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

employerEin, employerCode, employeeId*, gross, periodStart, periodEnd, payDate

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/engines/tax/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/calculate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employerEin":"value","employerCode":"value","employeeId":"value","gross":"value","periodStart":"value","periodEnd":"value"}'
POST/api/hrms/engines/payroll/{id}/sendPayroll send

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

payrollRunId*

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/engines/payroll/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/send" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"payrollRunId":"value"}'
POST/api/hrms/engines/payroll/{id}/resultsPayroll results

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

payrollRunId

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/engines/payroll/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/results" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"payrollRunId":"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 › Engines 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.