HRMS · Time & Attendance
Punch Corrections
A missed or wrong punch put right, with the reason, decided by somebody other than whoever asked and never by the employee themselves. Those an employee asks for wait in their manager’s Team Approvals too.
/api/hrms/punch-correctionsPublished as /api/v1/punch-correctionsDownload specification (OpenAPI 3.1) Screen: Punch Corrections
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 › Punch Corrections 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.punch_correction_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
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/punch-correctionsList punch corrections
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"correction_no": "COR-000001",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_no": "EMP-000001",
"employee_name": "Example",
"manager_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"action": "text",
"punch_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"punch_type": "text",
"status_code": "STA-000001",
"corrected_at": "2026-10-30T09:00:00Z",
"original_at": "2026-10-30T09:00:00Z",
"reason": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/punch-corrections?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/punch-corrections/{id}Read one punch corrections
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"correction_no": "COR-000001",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_no": "EMP-000001",
"employee_name": "Example",
"manager_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"action": "text",
"punch_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"punch_type": "text",
"status_code": "STA-000001",
"corrected_at": "2026-10-30T09:00:00Z",
"original_at": "2026-10-30T09:00:00Z",
"reason": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/punch-corrections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/punch-correctionsPost punch corrections
Request body
The keys this action reads (* = required; "one of" lists the only values):
employeeId, employee_idResponse
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/punch-corrections" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employeeId":"value","employee_id":"value"}'POST/api/hrms/punch-corrections/{id}/decideDecide
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):
decision, comment, note, 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/punch-corrections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/decide" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"decision":"value","comment":"value","note":"value","reason":"value"}'POST/api/hrms/punch-corrections/{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/punch-corrections/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/punch-corrections/{id}Put punch corrections
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/punch-corrections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/hrms/punch-corrections/{id}Delete punch corrections
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/punch-corrections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a punch corrections, 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 |
org_unit_id | uuid | read only | Org unit id |
correction_no | text | read only | Correction no |
employee_id | uuid | read only | Employee id |
employee_no | text | read only | Employee no |
employee_name | text | read only | Employee name |
manager_id | uuid | read only | Manager id |
action | text | read only | Action |
punch_id | uuid | read only | Punch id |
punch_type | text | read only | Punch type |
status_code | text | read only | Status code |
corrected_at | timestamp with time zone | read only | Corrected at |
original_at | timestamp with time zone | read only | Original at |
reason | text | read only | Reason |
status | text | read only | Status |
requested_by | uuid | read only | Requested by |
requested_by_name | text | read only | Requested by name |
requested_at | timestamp with time zone | read only | Requested at |
decided_by | uuid | read only | Decided by |
decided_by_name | text | read only | Decided by name |
decided_at | timestamp with time zone | read only | Decided at |
decision_note | text | read only | Decision note |
applied_punch_id | uuid | read only | Applied punch id |
created_at | timestamp with time zone | read only | Created 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 › Punch Corrections 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.