HRMS · Time & Attendance
Clock Punches
Every clock-in, clock-out, break and status, with the server’s time, where it came from and, where asked for, the position. Never edited: a wrong one is put right by a punch correction.
/api/hrms/time-punchesPublished as /api/v1/time-punchesOverview
| 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 › Clock Punches 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.time_punch_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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/time-punchesList clock punches
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",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_no": "EMP-000001",
"employee_name": "Example",
"manager_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"punch_type": "text",
"status_code": "STA-000001",
"punched_at": "2026-10-30T09:00:00Z",
"work_date": "2026-10-30",
"local_time": "text",
"time_zone": "text",
"source": "text",
"ip_address": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/time-punches?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/time-punches/{id}Read one time punches
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",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_no": "EMP-000001",
"employee_name": "Example",
"manager_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"punch_type": "text",
"status_code": "STA-000001",
"punched_at": "2026-10-30T09:00:00Z",
"work_date": "2026-10-30",
"local_time": "text",
"time_zone": "text",
"source": "text",
"ip_address": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/time-punches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/time-punchesPost clock punches
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/time-punches" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/time-punches/{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/time-punches/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/time-punches/{id}Put clock punches
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/time-punches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/hrms/time-punches/{id}Delete clock punches
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/time-punches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a time punches, 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 |
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 |
punch_type | text | read only | Punch type |
status_code | text | read only | Status code |
punched_at | timestamp with time zone | read only | Punched at |
work_date | date | read only | Work date |
local_time | time without time zone | read only | Local time |
time_zone | text | read only | Time zone |
source | text | read only | Source |
ip_address | text | read only | Ip address |
latitude | numeric | read only | Latitude |
longitude | numeric | read only | Longitude |
accuracy_m | numeric | read only | Accuracy m |
geo_status | text | read only | Geo status |
location_id | uuid | read only | Location id |
location_code | text | read only | Location code |
grant_id | uuid | read only | Grant id |
grant_code | text | read only | Grant code |
fund_id | uuid | read only | Fund id |
fund_code | text | read only | Fund code |
program_id | uuid | read only | Program id |
program_code | text | read only | Program code |
cost_center_id | uuid | read only | Cost center id |
cost_center_code | text | read only | Cost center code |
department | text | read only | Department |
is_void | boolean | read only | Is void |
correction_id | uuid | read only | Correction id |
voided_by_correction_id | uuid | read only | Voided by correction id |
time_entry_id | uuid | read only | Time entry id |
notes | text | read only | Notes |
recorded_by | uuid | read only | Recorded by |
recorded_by_name | text | read only | Recorded by name |
created_at | timestamp with time zone | read only | Created at |
recorded_time_zone | text | read only | Recorded time zone |
recorded_local_time | time without time zone | read only | Recorded local time |
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 › Clock Punches 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.