HRMS · Time & Attendance
Overtime Rules
Overtime is a conclusion, not an entry. The rules of the country a person is paid in apply to them, and the most specific wins: an agreement over a regional rule over the national one.
/api/hrms/overtime-rulesPublished as /api/v1/overtime-rulesOverview
| 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 › Overtime Rules 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.overtime_rules · 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
8 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/overtime-rulesList overtime rules
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",
"code": "COD-000001",
"name": "Example",
"jurisdiction": "text",
"applies_to": "all",
"union_code": "UNI-000001",
"daily_threshold": "1250.00",
"daily_double_threshold": "1250.00",
"weekly_threshold": "1250.00",
"seventh_day_rule": true,
"seventh_day_double_after": "1250.00",
"overtime_multiplier": "1250.00",
"double_multiplier": "1250.00",
"paid_leave_counts": true
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/overtime-rules?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/overtime-rules/{id}Read one overtime rules
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",
"code": "COD-000001",
"name": "Example",
"jurisdiction": "text",
"applies_to": "all",
"union_code": "UNI-000001",
"daily_threshold": "1250.00",
"daily_double_threshold": "1250.00",
"weekly_threshold": "1250.00",
"seventh_day_rule": true,
"seventh_day_double_after": "1250.00",
"overtime_multiplier": "1250.00",
"double_multiplier": "1250.00",
"paid_leave_counts": true
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/overtime-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/overtime-rulesCreate a overtime rules
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
jurisdiction | text | No | Jurisdiction — Empty for the whole country, or a region code. |
applies_to | text | No | Applies to Allowed: all non_exempt hourly union |
union_code | text | No | Union code |
daily_threshold | numeric | No | Overtime after, per day |
daily_double_threshold | numeric | No | Double time after, per day |
weekly_threshold | numeric | No | Overtime after, per week |
seventh_day_rule | boolean | No | Seventh consecutive day is premium |
seventh_day_double_after | numeric | No | Double after, on the seventh day |
overtime_multiplier | numeric | No | Overtime multiplier |
double_multiplier | numeric | No | Double multiplier |
paid_leave_counts | boolean | No | Paid leave counts toward the threshold — The law usually says it does not. Some agreements say it does. |
week_starts_on | integer | No | Week starts on |
priority | integer | No | Order — Lower wins. |
is_active | boolean | No | Active |
country | text | No | Country — The country whose employees it governs. Empty: every country (an agreement of the company’s own). |
premium_basis | text | No | Premium paid on Allowed: regular_rate — the regular rate of pay basic_wage — the basic wage (Saudi Labour Law art. 107) |
public_employer_applies | boolean | No | Applies to a public employer — Clear it for a rule a public employer is not under -- California daily overtime, for one. It is passed over when the company is marked a public employer (Public employer, above). |
Sample body
{
"code": "COD-000001",
"name": "Example",
"jurisdiction": "text",
"applies_to": "all",
"union_code": "UNI-000001",
"daily_threshold": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"jurisdiction": "text",
"applies_to": "all",
"union_code": "UNI-000001",
"daily_threshold": "1250.00",
"daily_double_threshold": "1250.00",
"weekly_threshold": "1250.00",
"seventh_day_rule": true,
"seventh_day_double_after": "1250.00",
"overtime_multiplier": "1250.00",
"double_multiplier": "1250.00",
"paid_leave_counts": true
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/overtime-rules" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","jurisdiction":"text","applies_to":"all","union_code":"UNI-000001","daily_threshold":"1250.00"}'PUT/api/hrms/overtime-rules/{id}Change a overtime rules
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 |
jurisdiction | text | No | Jurisdiction — Empty for the whole country, or a region code. |
applies_to | text | No | Applies to Allowed: all non_exempt hourly union |
union_code | text | No | Union code |
daily_threshold | numeric | No | Overtime after, per day |
daily_double_threshold | numeric | No | Double time after, per day |
weekly_threshold | numeric | No | Overtime after, per week |
seventh_day_rule | boolean | No | Seventh consecutive day is premium |
seventh_day_double_after | numeric | No | Double after, on the seventh day |
overtime_multiplier | numeric | No | Overtime multiplier |
double_multiplier | numeric | No | Double multiplier |
paid_leave_counts | boolean | No | Paid leave counts toward the threshold — The law usually says it does not. Some agreements say it does. |
week_starts_on | integer | No | Week starts on |
priority | integer | No | Order — Lower wins. |
is_active | boolean | No | Active |
country | text | No | Country — The country whose employees it governs. Empty: every country (an agreement of the company’s own). |
premium_basis | text | No | Premium paid on Allowed: regular_rate — the regular rate of pay basic_wage — the basic wage (Saudi Labour Law art. 107) |
public_employer_applies | boolean | No | Applies to a public employer — Clear it for a rule a public employer is not under -- California daily overtime, for one. It is passed over when the company is marked a public employer (Public employer, above). |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"jurisdiction": "text",
"applies_to": "all",
"union_code": "UNI-000001",
"daily_threshold": "1250.00",
"daily_double_threshold": "1250.00",
"weekly_threshold": "1250.00",
"seventh_day_rule": true,
"seventh_day_double_after": "1250.00",
"overtime_multiplier": "1250.00",
"double_multiplier": "1250.00",
"paid_leave_counts": true
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/overtime-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/hrms/overtime-rules/{id}Delete a overtime rules
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/overtime-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/overtime-rules/public-employerPublic employer
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/overtime-rules/public-employer" \
-H "Authorization: Bearer $TOKEN"PUT/api/hrms/overtime-rules/public-employerPublic employer
Request body
The keys this action reads (* = required; "one of" lists the only values):
publicEmployer, public_employerResponse
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/overtime-rules/public-employer" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"publicEmployer":"value","public_employer":"value"}'POST/api/hrms/overtime-rules/{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/overtime-rules/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 overtime rules, 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 |
code | text | read, write | Code |
name | text | read, write | Name |
jurisdiction | text | read, write | Jurisdiction — Empty for the whole country, or a region code. |
applies_to | text | read, write | Applies to Allowed: all non_exempt hourly union |
union_code | text | read, write | Union code |
daily_threshold | numeric | read, write | Overtime after, per day |
daily_double_threshold | numeric | read, write | Double time after, per day |
weekly_threshold | numeric | read, write | Overtime after, per week |
seventh_day_rule | boolean | read, write | Seventh consecutive day is premium |
seventh_day_double_after | numeric | read, write | Double after, on the seventh day |
overtime_multiplier | numeric | read, write | Overtime multiplier |
double_multiplier | numeric | read, write | Double multiplier |
paid_leave_counts | boolean | read, write | Paid leave counts toward the threshold — The law usually says it does not. Some agreements say it does. |
week_starts_on | integer | read, write | Week starts on |
priority | integer | read, write | Order — Lower wins. |
is_active | boolean | read, write | Active |
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 |
country | text | read, write | Country — The country whose employees it governs. Empty: every country (an agreement of the company’s own). |
premium_basis | text | read, write | Premium paid on Allowed: regular_rate — the regular rate of pay basic_wage — the basic wage (Saudi Labour Law art. 107) |
public_employer_applies | boolean | read, write | Applies to a public employer — Clear it for a rule a public employer is not under -- California daily overtime, for one. It is passed over when the company is marked a public employer (Public employer, above). |
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 › Overtime Rules 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.