TRANXACT.AI Help

HRMS · People

Personnel Actions

Promotions, transfers and pay changes, each approved by somebody other than whoever asked and applied to the employee on the day it takes effect — with the history of what changed from what.

Type REST12 operationsBase path /api/hrms/personnel-actionsPublished as /api/v1/personnel-actions

Download specification (OpenAPI 3.1) Screen: Personnel Actions

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 › Personnel Actions 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.personnel_actions · 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/personnel-actionsList personnel actions

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",
      "action_type": "promotion",
      "effective_date": "2026-10-30",
      "reason": "text",
      "detail": {},
      "approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "created_at": "2026-10-30T09:00:00Z",
      "action_no": "ACT-000001",
      "status": "draft",
      "requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "requested_at": "2026-10-30T09:00:00Z",
      "approved_at": "2026-10-30T09:00:00Z",
      "rejected_reason": "text"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "action_type": "promotion",
  "effective_date": "2026-10-30",
  "reason": "text",
  "detail": {},
  "approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "action_no": "ACT-000001",
  "status": "draft",
  "requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requested_at": "2026-10-30T09:00:00Z",
  "approved_at": "2026-10-30T09:00:00Z",
  "rejected_reason": "text"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
employee_iduuidYesEmployee
action_typetextYesType
Allowed: promotion demotion transfer pay_change reorganisation data_correction
effective_datedateYesTakes effect on
reasontextNoReason
detailjsonbNoDetail
to_position_iduuidNoNew position
to_manager_iduuidNoNew manager — A current employee other than the person this action is for.
to_org_unit_iduuidNoNew organizational unit
to_base_paynumericNoNew base pay
to_pay_typetextNoNew pay type
Allowed: salary hourly
to_work_statetextNoNew work region
to_pay_group_iduuidNoNew pay group — An active pay group of the country they work in; they are paid in it from the date it takes effect.

Sample body

{
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "action_type": "promotion",
  "effective_date": "2026-10-30",
  "reason": "text",
  "detail": {},
  "to_position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_manager_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "action_type": "promotion",
  "effective_date": "2026-10-30",
  "reason": "text",
  "detail": {},
  "approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "action_no": "ACT-000001",
  "status": "draft",
  "requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requested_at": "2026-10-30T09:00:00Z",
  "approved_at": "2026-10-30T09:00:00Z",
  "rejected_reason": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/personnel-actions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","action_type":"promotion","effective_date":"2026-10-30","reason":"text","detail":{},"to_position_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","to_manager_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/hrms/personnel-actions/{id}Change a personnel actions

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
action_typetextYesType
Allowed: promotion demotion transfer pay_change reorganisation data_correction
effective_datedateYesTakes effect on
reasontextNoReason
detailjsonbNoDetail
to_position_iduuidNoNew position
to_manager_iduuidNoNew manager — A current employee other than the person this action is for.
to_org_unit_iduuidNoNew organizational unit
to_base_paynumericNoNew base pay
to_pay_typetextNoNew pay type
Allowed: salary hourly
to_work_statetextNoNew work region
to_pay_group_iduuidNoNew pay group — An active pay group of the country they work in; they are paid in it from the date it takes effect.

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "action_type": "promotion",
  "effective_date": "2026-10-30",
  "reason": "text",
  "detail": {},
  "approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "action_no": "ACT-000001",
  "status": "draft",
  "requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requested_at": "2026-10-30T09:00:00Z",
  "approved_at": "2026-10-30T09:00:00Z",
  "rejected_reason": "text"
}

Sample request

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

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/personnel-actions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/personnel-actions/{id}/approvalsApprovals

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/personnel-actions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approvals" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/personnel-actions/{id}/submitSubmit

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/personnel-actions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/submit" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/personnel-actions/{id}/approveApprove

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/personnel-actions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/personnel-actions/{id}/rejectReject

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/personnel-actions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reject" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/personnel-actions/{id}/make-effectiveMake effective

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/personnel-actions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/make-effective" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/personnel-actions/{id}/cancelCancel

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/personnel-actions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/personnel-actions/{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/personnel-actions/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 personnel actions, 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
employee_iduuidread, writeEmployee
action_typetextread, writeType
Allowed: promotion demotion transfer pay_change reorganisation data_correction
effective_datedateread, writeTakes effect on
reasontextread, writeReason
detailjsonbread, writeDetail
approved_byuuidread onlyApproved by
created_attimestamp with time zoneread onlyCreated at
org_iduuidread onlyOrg id
action_notextread onlyAction no
statustextread onlyStatus
requested_byuuidread onlyRequested by
requested_attimestamp with time zoneread onlyRequested at
approved_attimestamp with time zoneread onlyApproved at
rejected_reasontextread onlyRejected reason
proposedjsonbread onlyProposed
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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
to_position_iduuidread, writeNew position
to_manager_iduuidread, writeNew manager — A current employee other than the person this action is for.
to_org_unit_iduuidread, writeNew organizational unit
to_base_paynumericread, writeNew base pay
to_pay_typetextread, writeNew pay type
Allowed: salary hourly
to_work_statetextread, writeNew work region
applied_attimestamp with time zoneread onlyApplied at
applied_changejsonbread onlyApplied change
from_valuesjsonbread onlyFrom values
rejected_byuuidread onlyRejected by
rejected_attimestamp with time zoneread onlyRejected at
cancelled_byuuidread onlyCancelled by
cancelled_attimestamp with time zoneread onlyCancelled at
type_override_reasontextread onlyType override reason
type_override_byuuidread onlyType override by
type_override_attimestamp with time zoneread onlyType override at
to_pay_group_iduuidread, writeNew pay group — An active pay group of the country they work in; they are paid in it from the date it takes effect.

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 › Personnel Actions 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.