TRANXACT.AI Help

HRMS · Pay Setup

Pay Formulas

An earning or deduction code worked out by a formula over the pay variables (hours, rate, base_pay, gross, years_of_service ...). Test it, activate it from a date, and change it only by adding a new version: payslips already paid keep the version they used. Set the code's "Worked out as" to Formula to use it.

Type REST12 operationsBase path /api/hrms/pay-formulasPublished as /api/v1/pay-formulas

Download specification (OpenAPI 3.1) Screen: Pay Formulas

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 › Pay Formulas 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.pay_formulas · 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

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

GET/api/hrms/pay-formulasList pay formulas

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",
      "element_kind": "An earning code",
      "code": "COD-000001",
      "version": 10,
      "formula": "text",
      "effective_from": "2026-10-30",
      "effective_to": "2026-10-30",
      "status": "draft",
      "description": "text",
      "tested_ok": true,
      "last_test": {},
      "activated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "activated_at": "2026-10-30T09:00:00Z",
      "created_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "element_kind": "An earning code",
  "code": "COD-000001",
  "version": 10,
  "formula": "text",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30",
  "status": "draft",
  "description": "text",
  "tested_ok": true,
  "last_test": {},
  "activated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "activated_at": "2026-10-30T09:00:00Z",
  "created_at": "2026-10-30T09:00:00Z"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
element_kindtextYesFor
Allowed: An earning code A deduction code
codetextYesCode — The earning or deduction code this formula works out.
formulatextYesFormula — e.g. round(base_pay / periods_per_year * 0.05, 2), or if(years_of_service >= 5, 150, 100).
effective_fromdateNoEffective from
effective_todateNoEffective to
descriptiontextNoWhat it does

Sample body

{
  "element_kind": "An earning code",
  "code": "COD-000001",
  "formula": "text",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30",
  "description": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "element_kind": "An earning code",
  "code": "COD-000001",
  "version": 10,
  "formula": "text",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30",
  "status": "draft",
  "description": "text",
  "tested_ok": true,
  "last_test": {},
  "activated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "activated_at": "2026-10-30T09:00:00Z",
  "created_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/pay-formulas" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"element_kind":"An earning code","code":"COD-000001","formula":"text","effective_from":"2026-10-30","effective_to":"2026-10-30","description":"text"}'
PUT/api/hrms/pay-formulas/{id}Change a pay formula

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
element_kindtextYesFor
Allowed: An earning code A deduction code
codetextYesCode — The earning or deduction code this formula works out.
formulatextYesFormula — e.g. round(base_pay / periods_per_year * 0.05, 2), or if(years_of_service >= 5, 150, 100).
effective_fromdateNoEffective from
effective_todateNoEffective to
descriptiontextNoWhat it does

Sample body

{
  "element_kind": "An earning code",
  "code": "COD-000001"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "element_kind": "An earning code",
  "code": "COD-000001",
  "version": 10,
  "formula": "text",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30",
  "status": "draft",
  "description": "text",
  "tested_ok": true,
  "last_test": {},
  "activated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "activated_at": "2026-10-30T09:00:00Z",
  "created_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/hrms/pay-formulas/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"element_kind":"An earning code","code":"COD-000001"}'
DELETE/api/hrms/pay-formulas/{id}Delete a pay formula

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

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/pay-formulas/variables" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/pay-formulas/testTest

Request body

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

kind, formula, employeeId, periodEnd

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/pay-formulas/test" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"kind":"value","formula":"value","employeeId":"value","periodEnd":"value"}'
POST/api/hrms/pay-formulas/{id}/testTest

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

employeeId, periodEnd

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/pay-formulas/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/test" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employeeId":"value","periodEnd":"value"}'
POST/api/hrms/pay-formulas/{id}/activateActivate

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

effectiveFrom

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/pay-formulas/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/activate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"effectiveFrom":"value"}'
POST/api/hrms/pay-formulas/{id}/new-versionNew version

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

effectiveFrom

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/pay-formulas/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/new-version" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"effectiveFrom":"value"}'
POST/api/hrms/pay-formulas/{id}/retireRetire

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/pay-formulas/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/retire" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/pay-formulas/{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/pay-formulas/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a pay formula, 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
element_kindtextread, writeFor
Allowed: An earning code A deduction code
codetextread, writeCode — The earning or deduction code this formula works out.
versionintegerread onlyVersion
formulatextread, writeFormula — e.g. round(base_pay / periods_per_year * 0.05, 2), or if(years_of_service >= 5, 150, 100).
effective_fromdateread, writeEffective from
effective_todateread, writeEffective to
statustextread onlyStatus
descriptiontextread, writeWhat it does
tested_okbooleanread onlyTested ok
last_testjsonbread onlyLast test
activated_byuuidread onlyActivated by
activated_attimestamp with time zoneread onlyActivated at
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 › Pay Formulas 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.