HRMS · Pay Processing
Payroll Readiness
Each pay group’s period now due, how far its cycle has got, and what is still open before it can be run.
/api/hrms/payroll-readinessPublished as /api/v1/payroll-readinessDownload specification (OpenAPI 3.1) Screen: Payroll Readiness
Overview
| 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 Readiness 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_readiness · kept per company (and organisational unit where it has one) |
| Record | Read only; key pay_group_id |
| Rules | The 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/payroll-readinessList payroll readiness
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": [
{
"pay_group_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"pay_group_code": "PAY-000001",
"pay_group_name": "Example",
"pay_frequency": "text",
"calculation_mode": "text",
"country": "US",
"pay_period_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"period_no": 10,
"period_start": "2026-10-30",
"period_end": "2026-10-30",
"pay_date": "2026-10-30",
"cutoff_date": "2026-10-30",
"days_to_pay": 10,
"employees": 10
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/payroll-readiness?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/payroll-readiness/{pay_group_id}Read one payroll readiness
Path parameters
| Name | Type | Description |
|---|---|---|
pay_group_id | string (uuid) | The record's pay_group_id, as a list returns it. |
Response 200
{
"pay_group_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"pay_group_code": "PAY-000001",
"pay_group_name": "Example",
"pay_frequency": "text",
"calculation_mode": "text",
"country": "US",
"pay_period_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"period_no": 10,
"period_start": "2026-10-30",
"period_end": "2026-10-30",
"pay_date": "2026-10-30",
"cutoff_date": "2026-10-30",
"days_to_pay": 10,
"employees": 10
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/payroll-readiness/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/payroll-readinessPost payroll readiness
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-readiness" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/payroll-readiness/{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-readiness/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-readiness/{id}Put payroll readiness
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-readiness/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/hrms/payroll-readiness/{id}Delete payroll readiness
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-readiness/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a payroll readiness, 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 |
|---|---|---|---|
org_id | uuid | read only | Org id |
pay_group_id | uuid | read only | Pay group id |
pay_group_code | text | read only | Pay group code |
pay_group_name | text | read only | Pay group name |
pay_frequency | text | read only | Pay frequency |
calculation_mode | text | read only | Calculation mode |
country | text | read only | Country |
pay_period_id | uuid | read only | Pay period id |
period_no | integer | read only | Period no |
period_start | date | read only | Period start |
period_end | date | read only | Period end |
pay_date | date | read only | Pay date |
cutoff_date | date | read only | Cutoff date |
days_to_pay | integer | read only | Days to pay |
employees | integer | read only | Employees |
cycle_status | text | read only | Cycle status |
periods_not_closed | integer | read only | Periods not closed |
unapproved_time_entries | integer | read only | Unapproved time entries |
unapproved_hours | numeric | read only | Unapproved hours |
missing_timecards | integer | read only | Missing timecards |
retro_pending | integer | read only | Retro pending |
retro_pending_amount | numeric | read only | Retro pending amount |
off_cycle_runs | integer | read only | Off cycle runs |
pay_rate_changes | integer | read only | Pay rate changes |
deduction_changes | integer | read only | Deduction changes |
tax_setup_gaps | integer | read only | Tax setup gaps |
direct_deposit_gaps | integer | read only | Direct deposit gaps |
corrections_this_year | integer | read only | Corrections this year |
runs_waiting | integer | read only | Runs waiting |
last_run_at | timestamp with time zone | read only | Last run at |
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 Readiness 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.