HRMS · People
Positions
The seats on the organization chart: each one a job, in a department and a location, with the headcount it is budgeted for and the grade it is paid in. People are hired into positions.
/api/hrms/positionsPublished as /api/v1/positionsOverview
| Package | HRMS |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold HRMS › Positions 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. |
| Table | hr.positions · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/positionsList positions
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"title": "Example",
"department": "text",
"cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"headcount_budget": 10,
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"fte_budget": "1250.00",
"status": "draft",
"effective_from": "2026-10-30"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/positions?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/positions/{id}Read one positions
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"title": "Example",
"department": "text",
"cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"headcount_budget": 10,
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"fte_budget": "1250.00",
"status": "draft",
"effective_from": "2026-10-30"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/positions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/positionsCreate a positions
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code — Typed, or left empty where the position range builds it (for example from the job and the authorization number). Without a pattern the code must be typed. |
title | text | Yes | Title |
department | text | Yes | Department — One of the company’s departments. An administrator adds a department under Platform › Configuration Lists › Departments. |
cost_center_id | uuid | No | Cost center |
headcount_budget | integer | No | Headcount budget |
is_active | boolean | No | Is active |
job_id | uuid | No | Job — The job in the job catalogue this position is a seat of. From HRMS › People › Jobs. |
location_id | uuid | No | Location — The site or plant where the position is based. From Supply Chain › Network › Locations. |
effective_from | date | No | Effective from |
grade_id | uuid | No | Grade — The salary grade the seat is paid in. Pay position measures everybody in it against this range. |
fund_id | uuid | No | Fund |
grant_id | uuid | No | Grant — Time worked in this seat is charged to this grant (and its fund) unless the hours say otherwise. |
program_id | uuid | No | Program |
Sample body
{
"code": "COD-000001",
"title": "Example",
"department": "text",
"cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"headcount_budget": 10,
"is_active": true,
"job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"title": "Example",
"department": "text",
"cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"headcount_budget": 10,
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"fte_budget": "1250.00",
"status": "draft",
"effective_from": "2026-10-30"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/positions" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","title":"Example","department":"text","cost_center_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","headcount_budget":10,"is_active":true,"job_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/hrms/positions/{id}Change a positions
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code — Typed, or left empty where the position range builds it (for example from the job and the authorization number). Without a pattern the code must be typed. |
title | text | Yes | Title |
department | text | Yes | Department — One of the company’s departments. An administrator adds a department under Platform › Configuration Lists › Departments. |
cost_center_id | uuid | No | Cost center |
headcount_budget | integer | No | Headcount budget |
is_active | boolean | No | Is active |
job_id | uuid | No | Job — The job in the job catalogue this position is a seat of. From HRMS › People › Jobs. |
location_id | uuid | No | Location — The site or plant where the position is based. From Supply Chain › Network › Locations. |
effective_from | date | No | Effective from |
grade_id | uuid | No | Grade — The salary grade the seat is paid in. Pay position measures everybody in it against this range. |
fund_id | uuid | No | Fund |
grant_id | uuid | No | Grant — Time worked in this seat is charged to this grant (and its fund) unless the hours say otherwise. |
program_id | uuid | No | Program |
Sample body
{
"code": "COD-000001",
"title": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"title": "Example",
"department": "text",
"cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"headcount_budget": 10,
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"fte_budget": "1250.00",
"status": "draft",
"effective_from": "2026-10-30"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/positions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","title":"Example"}'DELETE/api/hrms/positions/{id}Delete a positions
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/positions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"PATCH/api/hrms/positions/{id}Patch positions
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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 PATCH "https://demo.tranxact.ai/api/hrms/positions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/positions/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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/positions/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 positions, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
code | text | read, write | Code — Typed, or left empty where the position range builds it (for example from the job and the authorization number). Without a pattern the code must be typed. |
title | text | read, write | Title |
department | text | read, write | Department — One of the company’s departments. An administrator adds a department under Platform › Configuration Lists › Departments. |
cost_center_id | uuid | read, write | Cost center |
headcount_budget | integer | read, write | Headcount budget |
is_active | boolean | read, write | Is active |
org_unit_id | uuid | read only | Org unit id |
job_id | uuid | read, write | Job — The job in the job catalogue this position is a seat of. From HRMS › People › Jobs. |
parent_position_id | uuid | read only | Parent position id |
location_id | uuid | read, write | Location — The site or plant where the position is based. From Supply Chain › Network › Locations. |
fte_budget | numeric | read only | Fte budget |
status | text | read only | Status |
effective_from | date | read, write | Effective from |
effective_to | date | read only | Effective to |
grade_id | uuid | read, write | Grade — The salary grade the seat is paid in. Pay position measures everybody in it against this range. |
is_shared | boolean | read only | Is shared |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
first_in_force | date | read only | First in force |
fund_id | uuid | read, write | Fund |
grant_id | uuid | read, write | Grant — Time worked in this seat is charged to this grant (and its fund) unless the hours say otherwise. |
program_id | uuid | read, write | Program |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold HRMS › Positions for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.