HRMS · Time & Attendance
Time Entries
Read and maintain time entries records (hr.time_entries).
/api/hrms/time-entriesPublished as /api/v1/time-entriesOverview
| 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 › Time Entries 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_entries · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; 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-entriesList time entries
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",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_date": "2026-10-30",
"hours": "1250.00",
"entry_type": "regular",
"project_ref": "text",
"status": "submitted",
"approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"profit_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"timesheet_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"shift_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"start_time": "text",
"end_time": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/time-entries?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/time-entries/{id}Read one time entries
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",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_date": "2026-10-30",
"hours": "1250.00",
"entry_type": "regular",
"project_ref": "text",
"status": "submitted",
"approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"profit_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"timesheet_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"shift_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"start_time": "text",
"end_time": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/time-entries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/time-entriesCreate a time entries
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
employee_id | uuid | Yes | Employee |
work_date | date | Yes | Work date |
hours | numeric | Yes | Hours |
entry_type | text | No | Type — Overtime pays 1.5×, holiday 2× in payroll. Allowed: regular overtime oncall holiday |
project_ref | text | No | Project ref |
status | text | No | Status Allowed: submitted approved rejected |
cost_center_id | uuid | No | Cost center |
fund_id | uuid | No | Fund |
grant_id | uuid | No | Grant — Empty: the position’s grant. A grant brings its own fund. |
program_id | uuid | No | Program |
location_id | uuid | No | Property / site |
department | text | No | Department — Empty: the position’s department. |
Sample body
{
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_date": "2026-10-30",
"hours": "1250.00",
"entry_type": "regular",
"project_ref": "text",
"status": "submitted",
"cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_date": "2026-10-30",
"hours": "1250.00",
"entry_type": "regular",
"project_ref": "text",
"status": "submitted",
"approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"profit_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"timesheet_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"shift_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"start_time": "text",
"end_time": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/time-entries" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","work_date":"2026-10-30","hours":"1250.00","entry_type":"regular","project_ref":"text","status":"submitted","cost_center_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/hrms/time-entries/{id}Change a time entries
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
employee_id | uuid | Yes | Employee |
work_date | date | Yes | Work date |
hours | numeric | Yes | Hours |
entry_type | text | No | Type — Overtime pays 1.5×, holiday 2× in payroll. Allowed: regular overtime oncall holiday |
project_ref | text | No | Project ref |
status | text | No | Status Allowed: submitted approved rejected |
cost_center_id | uuid | No | Cost center |
fund_id | uuid | No | Fund |
grant_id | uuid | No | Grant — Empty: the position’s grant. A grant brings its own fund. |
program_id | uuid | No | Program |
location_id | uuid | No | Property / site |
department | text | No | Department — Empty: the position’s department. |
Sample body
{
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_date": "2026-10-30"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_date": "2026-10-30",
"hours": "1250.00",
"entry_type": "regular",
"project_ref": "text",
"status": "submitted",
"approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"profit_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"timesheet_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"shift_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"start_time": "text",
"end_time": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/time-entries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","work_date":"2026-10-30"}'DELETE/api/hrms/time-entries/{id}Delete a time entries
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/hrms/time-entries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/time-entries/{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-entries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a time entries, 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 |
employee_id | uuid | read, write | Employee |
work_date | date | read, write | Work date |
hours | numeric | read, write | Hours |
entry_type | text | read, write | Type — Overtime pays 1.5×, holiday 2× in payroll. Allowed: regular overtime oncall holiday |
project_ref | text | read, write | Project ref |
status | text | read, write | Status Allowed: submitted approved rejected |
approved_by | uuid | read only | Approved by |
cost_center_id | uuid | read, write | Cost center |
profit_center_id | uuid | read only | Profit center id |
org_id | uuid | read only | Org id |
timesheet_id | uuid | read only | Timesheet id |
shift_id | uuid | read only | Shift id |
start_time | time without time zone | read only | Start time |
end_time | time without time zone | read only | End time |
break_minutes | integer | read only | Break minutes |
premium_type | text | read only | Premium type |
regular_hours | numeric | read only | Regular hours |
overtime_hours | numeric | read only | Overtime hours |
double_hours | numeric | read only | Double hours |
evaluation_basis | text | read only | Evaluation basis |
work_order_id | uuid | read only | Work order id |
notes | text | read only | Notes |
approved_at | timestamp with time zone | read only | Approved at |
org_unit_id | uuid | read only | Org unit id |
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_at | timestamp with time zone | read only | Created at |
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, write | Fund |
grant_id | uuid | read, write | Grant — Empty: the position’s grant. A grant brings its own fund. |
program_id | uuid | read, write | Program |
location_id | uuid | read, write | Property / site |
department | text | read, write | Department — Empty: the position’s department. |
source | text | read only | Source |
raw_start_time | time without time zone | read only | Raw start time |
raw_end_time | time without time zone | read only | Raw end time |
raw_hours | numeric | read only | Raw hours |
rounding_basis | text | read only | Rounding basis |
premium_earning_code | text | read only | Premium earning code |
premium_hours | numeric | read only | Premium hours |
premium_multiplier | numeric | read only | Premium multiplier |
premium_amount | numeric | read only | Premium amount |
premium_basis | text | read only | Premium basis |
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 › Time Entries 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.