HRMS · Pay Processing
Pay Files
Each payroll run’s net-pay file for the bank, every version kept with its checksum and control totals. Made from Payroll Runs > Create pay file.
/api/hrms/pay-filesPublished as /api/v1/pay-filesOverview
| 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 › Pay Files 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.pay_file_board · 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
12 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/pay-filesList pay files
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",
"payroll_run_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",
"run_status": "draft",
"paid_at": "2026-10-30T09:00:00Z",
"version": 10,
"format": "text",
"format_label": "text",
"status": "draft",
"file_name": "Example",
"sha256": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/pay-files?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/pay-files/{id}Read one pay file
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",
"payroll_run_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",
"run_status": "draft",
"paid_at": "2026-10-30T09:00:00Z",
"version": 10,
"format": "text",
"format_label": "text",
"status": "draft",
"file_name": "Example",
"sha256": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/pay-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/pay-files/previewPreview
Request body
The keys this action reads (* = required; "one of" lists the only values):
runId, formatResponse
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-files/preview" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"runId":"value","format":"value"}'POST/api/hrms/pay-files/createCreate
Request body
The keys this action reads (* = required; "one of" lists the only values):
runId, format, effectiveDate; format one of nacha|neft_csv|wps_sif|pain001Response
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-files/create" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"runId":"value","format":"value","effectiveDate;":"value"}'GET/api/hrms/pay-files/{id}/exceptionsExceptions
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/pay-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/exceptions" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/pay-files/{id}/checksChecks
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):
replace, reason, firstCheckNo; checks: [{ employeeId, employeeNo, checkNo, check_number }]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-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/checks" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"replace":"value","reason":"value","firstCheckNo;":"value","employeeNo":"value","checkNo":"value","check_number":"value"}'GET/api/hrms/pay-files/{id}/downloadDownload
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/pay-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/download" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/pay-files/{id}/confirmConfirm
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/pay-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/confirm" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/pay-filesPost pay files
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-files" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/pay-files/{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/pay-files/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/pay-files/{id}Put pay files
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/pay-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/hrms/pay-files/{id}Delete pay files
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/pay-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a pay file, 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 |
payroll_run_id | uuid | read only | Payroll run 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 |
run_status | text | read only | Run status |
paid_at | timestamp with time zone | read only | Paid at |
version | integer | read only | Version |
format | text | read only | Format |
format_label | text | read only | Format label |
status | text | read only | Status |
file_name | text | read only | File name |
sha256 | text | read only | Sha256 |
entry_count | integer | read only | Entry count |
employee_count | integer | read only | Employee count |
total_amount | numeric | read only | Total amount |
currency | text | read only | Currency |
entry_hash | text | read only | Entry hash |
block_count | integer | read only | Block count |
line_count | integer | read only | Line count |
effective_date | date | read only | Effective date |
controls | jsonb | read only | Controls |
exception_count | integer | read only | Exception count |
exceptions | jsonb | read only | Exceptions |
created_at | timestamp with time zone | read only | Created at |
created_by_name | text | read only | Created by name |
confirmed_at | timestamp with time zone | read only | Confirmed at |
confirmed_by_name | text | read only | Confirmed by name |
downloads | integer | read only | Downloads |
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 › Pay Files 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.