TRANXACT.AI Help

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.

Type REST11 operationsBase path /api/hrms/timesheetsPublished as /api/v1/timesheets

Download specification (OpenAPI 3.1) Screen: Timesheets

Overview

PackageHRMS
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablehr.timesheet_status · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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, periodEnd

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" \
  -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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, notes

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/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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
idstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
timesheet_notextread onlyTimesheet no
employee_iduuidread onlyEmployee id
employee_notextread onlyEmployee no
employee_nametextread onlyEmployee name
period_startdateread onlyPeriod start
period_enddateread onlyPeriod end
statustextread onlyStatus
total_hoursnumericread onlyTotal hours
regular_hoursnumericread onlyRegular hours
overtime_hoursnumericread onlyOvertime hours
double_hoursnumericread onlyDouble hours
leave_hoursnumericread onlyLeave hours
holiday_hoursnumericread onlyHoliday hours
overtime_ruletextread onlyOvertime rule
overtime_rule_nametextread onlyOvertime rule name
evaluated_attimestamp with time zoneread onlyEvaluated at
submitted_attimestamp with time zoneread onlySubmitted at
approved_attimestamp with time zoneread onlyApproved at
approved_by_nametextread onlyApproved by name
entriesintegerread onlyEntries
standingtextread onlyStanding

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold HRMS › Timesheets for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.