HRMS · Pay Processing
Payroll Runs
Read and maintain payroll runs records (hr.payroll_runs).
/api/hrms/payroll-runsPublished as /api/v1/payroll-runsOverview
| 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 › Payroll Runs 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.payroll_runs · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
18 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/payroll-runsList payroll runs
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",
"run_no": "RUN-000001",
"period_start": "2026-10-30",
"period_end": "2026-10-30",
"pay_date": "2026-10-30",
"status": "draft",
"total_gross": "1250.00",
"total_net": "1250.00",
"total_taxes": "1250.00",
"total_deductions": "1250.00",
"journal_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"calculated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"created_at": "2026-10-30T09:00:00Z"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/payroll-runs?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/payroll-runs/{id}Read one payroll runs
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",
"run_no": "RUN-000001",
"period_start": "2026-10-30",
"period_end": "2026-10-30",
"pay_date": "2026-10-30",
"status": "draft",
"total_gross": "1250.00",
"total_net": "1250.00",
"total_taxes": "1250.00",
"total_deductions": "1250.00",
"journal_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"calculated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"approved_by": "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/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/payroll-runs/{id}/linesLines
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/payroll-runsPost payroll runs
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/payroll-runs" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/payroll-runs/{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/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/hrms/payroll-runs/{id}Put payroll runs
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 PUT "https://demo.tranxact.ai/api/hrms/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/hrms/payroll-runs/{id}Delete payroll runs
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 DELETE "https://demo.tranxact.ai/api/hrms/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/payroll-runs/{parentId}/payslipsPayslips
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/payslips" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/payroll-runs/{parentId}/payslipsPayslips
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, 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/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/payslips" \
-H "Authorization: Bearer $TOKEN"PUT/api/hrms/payroll-runs/{parentId}/payslips/{lineId}Payslips
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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 PUT "https://demo.tranxact.ai/api/hrms/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/payslips/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/hrms/payroll-runs/{parentId}/payslips/{lineId}Payslips
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/payslips/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/payroll-runs/calculateCalculate
Request body
The keys this action reads (* = required; "one of" lists the only values):
employeeId, earningCode, amount, hours, reason, periodStart, periodEnd, payDate, payGroupId, payPeriodId, runType, missingTime, force, forceReason, employeeIds, earningsResponse
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/payroll-runs/calculate" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employeeId":"value","earningCode":"value","amount":"value","hours":"value","reason":"value","periodStart":"value"}'GET/api/hrms/payroll-runs/{id}/payslipsPayslips
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/payslips" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/payroll-runs/{id}/approveApprove
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 POST "https://demo.tranxact.ai/api/hrms/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/payroll-runs/{id}/approve-overrideApprove override
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 POST "https://demo.tranxact.ai/api/hrms/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve-override" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/payroll-runs/{id}/send-backSend back
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):
reasonResponse
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/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/send-back" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'POST/api/hrms/payroll-runs/{id}/cancelCancel
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):
reasonResponse
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/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'POST/api/hrms/payroll-runs/{id}/postPost
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 POST "https://demo.tranxact.ai/api/hrms/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a payroll runs, 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 |
run_no | text | read only | Run no |
period_start | date | read only | Period start |
period_end | date | read only | Period end |
pay_date | date | read only | Pay date |
status | text | read only | Status |
total_gross | numeric | read only | Total gross |
total_net | numeric | read only | Total net |
total_taxes | numeric | read only | Total taxes |
total_deductions | numeric | read only | Total deductions |
journal_id | uuid | read only | Journal id |
calculated_by | uuid | read only | Calculated by |
approved_by | uuid | read only | Approved by |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit id |
cost_center_id | uuid | read only | Cost center id |
profit_center_id | uuid | read only | Profit center id |
pay_group_id | uuid | read only | Pay group id |
pay_period_id | uuid | read only | Pay period id |
run_type | text | read only | Run type |
tax_year | integer | read only | Tax year |
quarter | integer | read only | Quarter |
employer_taxes | numeric | read only | Employer taxes |
employer_contributions | numeric | read only | Employer contributions |
employee_count | integer | read only | Employee count |
calculation_mode | text | read only | Calculation mode |
engine_name | text | read only | Engine name |
paid_at | timestamp with time zone | read only | Paid at |
reversal_of | uuid | read only | Reversal of |
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_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
fund_id | uuid | read only | Fund id |
grant_id | uuid | read only | Grant id |
program_id | uuid | read only | Program id |
function_id | uuid | read only | Function id |
derivation_trace | jsonb | read only | Derivation trace |
left_out | jsonb | read only | Left out |
ytd_posted_at | timestamp with time zone | read only | Ytd posted at |
paid_by | uuid | read only | Paid by |
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 › Payroll Runs 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.