HRMS · Time & Attendance
Timesheets
Hours entered, then evaluated against the rule that governs the person so that what a manager approves is what will be paid.
/api/hrms/timesheetsPublished as /api/v1/timesheetsOverview
| 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 › Timesheets 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.timesheet_status · 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
11 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/timesheetsList timesheets
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",
"timesheet_no": "TIM-000001",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_no": "EMP-000001",
"employee_name": "Example",
"period_start": "2026-10-30",
"period_end": "2026-10-30",
"status": "draft",
"total_hours": "1250.00",
"regular_hours": "1250.00",
"overtime_hours": "1250.00",
"double_hours": "1250.00",
"leave_hours": "1250.00",
"holiday_hours": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/timesheets?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/timesheets/{id}Read one timesheets
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",
"timesheet_no": "TIM-000001",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_no": "EMP-000001",
"employee_name": "Example",
"period_start": "2026-10-30",
"period_end": "2026-10-30",
"status": "draft",
"total_hours": "1250.00",
"regular_hours": "1250.00",
"overtime_hours": "1250.00",
"double_hours": "1250.00",
"leave_hours": "1250.00",
"holiday_hours": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/timesheetsPost timesheets
Request body
The keys this action reads (* = required; "one of" lists the only values):
employeeId*, periodStart, periodEndResponse
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/timesheets" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employeeId":"value","periodStart":"value","periodEnd":"value"}'DELETE/api/hrms/timesheets/{id}Delete timesheets
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/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/timesheets/{id}/entriesEntries
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):
workDate*, hours, entryType, startTime, endTime, breakMinutes, shiftId, notesResponse
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/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/entries" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"workDate":"value","hours":"value","entryType":"value","startTime":"value","endTime":"value","breakMinutes":"value"}'POST/api/hrms/timesheets/{id}/evaluateEvaluate
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/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/evaluate" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/timesheets/{id}/submitSubmit
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/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/submit" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/timesheets/{id}/approveApprove
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/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/timesheets/{id}/rejectReject
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):
reason*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/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reject" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'POST/api/hrms/timesheets/{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/timesheets/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/timesheets/{id}Put timesheets
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/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a timesheets, 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 |
timesheet_no | text | read only | Timesheet no |
employee_id | uuid | read only | Employee id |
employee_no | text | read only | Employee no |
employee_name | text | read only | Employee name |
period_start | date | read only | Period start |
period_end | date | read only | Period end |
status | text | read only | Status |
total_hours | numeric | read only | Total hours |
regular_hours | numeric | read only | Regular hours |
overtime_hours | numeric | read only | Overtime hours |
double_hours | numeric | read only | Double hours |
leave_hours | numeric | read only | Leave hours |
holiday_hours | numeric | read only | Holiday hours |
overtime_rule | text | read only | Overtime rule |
overtime_rule_name | text | read only | Overtime rule name |
evaluated_at | timestamp with time zone | read only | Evaluated at |
submitted_at | timestamp with time zone | read only | Submitted at |
approved_at | timestamp with time zone | read only | Approved at |
approved_by_name | text | read only | Approved by name |
entries | integer | read only | Entries |
standing | text | read only | Standing |
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 › Timesheets 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.