HRMS · Time & Attendance
Time Policies
How time is captured and counted for a pay group, the people an overtime rule governs, or the whole company: clock punches required or hours typed allowed, whether the browser’s position is asked for, rounding, and a premium for working a holiday.
/api/hrms/time-policiesPublished as /api/v1/time-policiesOverview
| 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 Policies 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_policies · 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-policiesList time policies
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",
"code": "COD-000001",
"name": "Example",
"description": "text",
"pay_group_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"overtime_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_default": true,
"punch_policy": "manual_allowed — hours may be typed, or punched",
"geolocation": "off — not asked for, never kept",
"round_interval_minutes": 10,
"round_method": "nearest",
"round_grace_start_minutes": 10
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/time-policies?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/time-policies/{id}Read one time policies
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",
"code": "COD-000001",
"name": "Example",
"description": "text",
"pay_group_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"overtime_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_default": true,
"punch_policy": "manual_allowed — hours may be typed, or punched",
"geolocation": "off — not asked for, never kept",
"round_interval_minutes": 10,
"round_method": "nearest",
"round_grace_start_minutes": 10
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/time-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/time-policiesCreate a time policies
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
description | text | No | Description |
pay_group_id | uuid | No | Pay group — Everybody in this pay group (an hourly group under its own agreement, for one). |
overtime_rule_id | uuid | No | Overtime rule — Or: the people this overtime rule is chosen for, on their record or their pay group. |
location_id | uuid | No | Location — Or: punches made at this location. Only its position setting is read, and it can only make it stricter. |
is_default | boolean | No | Company default — Governs everybody no other policy does. Names no pay group, rule or location. |
punch_policy | text | No | Worked time comes from Allowed: manual_allowed — hours may be typed, or punched punch_required — clock punches only (corrections approved by a manager) |
geolocation | text | No | Position with each punch Allowed: off — not asked for, never kept optional — kept when the browser allows it required — a punch without it is refused |
round_interval_minutes | integer | No | Round to (minutes) — Empty: no rounding. 6 is a tenth of an hour, 15 a quarter. Breaks are never rounded. |
round_method | text | No | Rounding — Nearest is neutral over time and the default. Allowed: nearest up down |
round_grace_start_minutes | integer | No | Grace at the start (minutes) — A clock-in this close to the scheduled start counts as the start. Needs a shift or work schedule. |
round_grace_end_minutes | integer | No | Grace at the end (minutes) |
holiday_premium_earning_code | text | No | Holiday premium earning code — Hours worked on a holiday of the person’s calendar earn this, on top of their pay. |
holiday_premium_multiplier | numeric | No | Premium: × the hourly rate — For a rate-times-hours code. 0.5 adds half again; 1.5 adds one and a half. |
holiday_premium_flat_amount | numeric | No | Premium: flat amount for the day — Or this, for a flat-amount code. Not both. |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example",
"description": "text",
"pay_group_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"overtime_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"pay_group_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"overtime_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_default": true,
"punch_policy": "manual_allowed — hours may be typed, or punched",
"geolocation": "off — not asked for, never kept",
"round_interval_minutes": 10,
"round_method": "nearest",
"round_grace_start_minutes": 10
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/time-policies" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","description":"text","pay_group_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","overtime_rule_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/hrms/time-policies/{id}Change a time policies
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 |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
description | text | No | Description |
pay_group_id | uuid | No | Pay group — Everybody in this pay group (an hourly group under its own agreement, for one). |
overtime_rule_id | uuid | No | Overtime rule — Or: the people this overtime rule is chosen for, on their record or their pay group. |
location_id | uuid | No | Location — Or: punches made at this location. Only its position setting is read, and it can only make it stricter. |
is_default | boolean | No | Company default — Governs everybody no other policy does. Names no pay group, rule or location. |
punch_policy | text | No | Worked time comes from Allowed: manual_allowed — hours may be typed, or punched punch_required — clock punches only (corrections approved by a manager) |
geolocation | text | No | Position with each punch Allowed: off — not asked for, never kept optional — kept when the browser allows it required — a punch without it is refused |
round_interval_minutes | integer | No | Round to (minutes) — Empty: no rounding. 6 is a tenth of an hour, 15 a quarter. Breaks are never rounded. |
round_method | text | No | Rounding — Nearest is neutral over time and the default. Allowed: nearest up down |
round_grace_start_minutes | integer | No | Grace at the start (minutes) — A clock-in this close to the scheduled start counts as the start. Needs a shift or work schedule. |
round_grace_end_minutes | integer | No | Grace at the end (minutes) |
holiday_premium_earning_code | text | No | Holiday premium earning code — Hours worked on a holiday of the person’s calendar earn this, on top of their pay. |
holiday_premium_multiplier | numeric | No | Premium: × the hourly rate — For a rate-times-hours code. 0.5 adds half again; 1.5 adds one and a half. |
holiday_premium_flat_amount | numeric | No | Premium: flat amount for the day — Or this, for a flat-amount code. Not both. |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"pay_group_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"overtime_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_default": true,
"punch_policy": "manual_allowed — hours may be typed, or punched",
"geolocation": "off — not asked for, never kept",
"round_interval_minutes": 10,
"round_method": "nearest",
"round_grace_start_minutes": 10
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/time-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/hrms/time-policies/{id}Delete a time policies
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-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/time-policies/{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-policies/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 policies, 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 |
code | text | read, write | Code |
name | text | read, write | Name |
description | text | read, write | Description |
pay_group_id | uuid | read, write | Pay group — Everybody in this pay group (an hourly group under its own agreement, for one). |
overtime_rule_id | uuid | read, write | Overtime rule — Or: the people this overtime rule is chosen for, on their record or their pay group. |
location_id | uuid | read, write | Location — Or: punches made at this location. Only its position setting is read, and it can only make it stricter. |
is_default | boolean | read, write | Company default — Governs everybody no other policy does. Names no pay group, rule or location. |
punch_policy | text | read, write | Worked time comes from Allowed: manual_allowed — hours may be typed, or punched punch_required — clock punches only (corrections approved by a manager) |
geolocation | text | read, write | Position with each punch Allowed: off — not asked for, never kept optional — kept when the browser allows it required — a punch without it is refused |
round_interval_minutes | integer | read, write | Round to (minutes) — Empty: no rounding. 6 is a tenth of an hour, 15 a quarter. Breaks are never rounded. |
round_method | text | read, write | Rounding — Nearest is neutral over time and the default. Allowed: nearest up down |
round_grace_start_minutes | integer | read, write | Grace at the start (minutes) — A clock-in this close to the scheduled start counts as the start. Needs a shift or work schedule. |
round_grace_end_minutes | integer | read, write | Grace at the end (minutes) |
holiday_premium_earning_code | text | read, write | Holiday premium earning code — Hours worked on a holiday of the person’s calendar earn this, on top of their pay. |
holiday_premium_multiplier | numeric | read, write | Premium: × the hourly rate — For a rate-times-hours code. 0.5 adds half again; 1.5 adds one and a half. |
holiday_premium_flat_amount | numeric | read, write | Premium: flat amount for the day — Or this, for a flat-amount code. Not both. |
is_active | boolean | read, write | Active |
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 |
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 |
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 Policies 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.