TRANXACT.AI Help

HRMS · Pay Processing

Retroactive Pay

Money owed for periods already paid, from a change dated backwards.

Type REST6 operationsBase path /api/hrms/retro-adjustmentsPublished as /api/v1/retro-adjustments

Download specification (OpenAPI 3.1) Screen: Retroactive Pay

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 › Retroactive Pay 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.retro_adjustments · 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

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

GET/api/hrms/retro-adjustmentsList retroactive pay

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",
      "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "reason": "text",
      "earning_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "affected_from": "2026-10-30",
      "affected_to": "2026-10-30",
      "old_rate": "1250.00",
      "new_rate": "1250.00",
      "periods_affected": 10,
      "amount": "1250.00",
      "source_action_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "status": "draft",
      "payroll_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "created_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "reason": "text",
  "earning_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "affected_from": "2026-10-30",
  "affected_to": "2026-10-30",
  "old_rate": "1250.00",
  "new_rate": "1250.00",
  "periods_affected": 10,
  "amount": "1250.00",
  "source_action_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "status": "draft",
  "payroll_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "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/retro-adjustments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/retro-adjustmentsCreate a retro adjustments

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
employee_iduuidYesEmployee id
reasontextYesReason
earning_code_iduuidNoEarning code id
affected_fromdateYesAffected from
affected_todateYesAffected to
old_ratenumericNoOld rate
new_ratenumericNoNew rate
periods_affectedintegerNoPeriods affected
amountnumericYesAmount
statustextNoStatus
payroll_run_iduuidNoPayroll run id

Sample body

{
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "reason": "text",
  "affected_from": "2026-10-30",
  "affected_to": "2026-10-30",
  "amount": "1250.00",
  "earning_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "old_rate": "1250.00",
  "new_rate": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "reason": "text",
  "earning_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "affected_from": "2026-10-30",
  "affected_to": "2026-10-30",
  "old_rate": "1250.00",
  "new_rate": "1250.00",
  "periods_affected": 10,
  "amount": "1250.00",
  "source_action_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "status": "draft",
  "payroll_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/retro-adjustments" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","reason":"text","affected_from":"2026-10-30","affected_to":"2026-10-30","amount":"1250.00","earning_code_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","old_rate":"1250.00","new_rate":"1250.00"}'
PUT/api/hrms/retro-adjustments/{id}Change a retro adjustments

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
employee_iduuidYesEmployee id
reasontextYesReason
earning_code_iduuidNoEarning code id
affected_fromdateYesAffected from
affected_todateYesAffected to
old_ratenumericNoOld rate
new_ratenumericNoNew rate
periods_affectedintegerNoPeriods affected
amountnumericYesAmount
statustextNoStatus
payroll_run_iduuidNoPayroll run id

Sample body

{
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "reason": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "reason": "text",
  "earning_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "affected_from": "2026-10-30",
  "affected_to": "2026-10-30",
  "old_rate": "1250.00",
  "new_rate": "1250.00",
  "periods_affected": 10,
  "amount": "1250.00",
  "source_action_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "status": "draft",
  "payroll_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/hrms/retro-adjustments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","reason":"text"}'
DELETE/api/hrms/retro-adjustments/{id}Delete a retro adjustments

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/retro-adjustments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/retro-adjustments/{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/retro-adjustments/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 retro adjustments, 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
employee_iduuidread, writeEmployee id
reasontextread, writeReason
earning_code_iduuidread, writeEarning code id
affected_fromdateread, writeAffected from
affected_todateread, writeAffected to
old_ratenumericread, writeOld rate
new_ratenumericread, writeNew rate
periods_affectedintegerread, writePeriods affected
amountnumericread, writeAmount
source_action_iduuidread onlySource action id
statustextread, writeStatus
payroll_run_iduuidread, writePayroll run id
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
org_unit_iduuidread onlyOrg unit id
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
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
modetextread onlyMode
detailjsonbread onlyDetail

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 › Retroactive Pay 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.