TRANXACT.AI Help

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.

Type REST8 operationsBase path /api/hrms/overtime-rulesPublished as /api/v1/overtime-rules

Download specification (OpenAPI 3.1) Screen: Overtime Rules

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 › 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.
Tablehr.overtime_rules · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

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

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

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
jurisdictiontextNoJurisdiction — Empty for the whole country, or a region code.
applies_totextNoApplies to
Allowed: all non_exempt hourly union
union_codetextNoUnion code
daily_thresholdnumericNoOvertime after, per day
daily_double_thresholdnumericNoDouble time after, per day
weekly_thresholdnumericNoOvertime after, per week
seventh_day_rulebooleanNoSeventh consecutive day is premium
seventh_day_double_afternumericNoDouble after, on the seventh day
overtime_multipliernumericNoOvertime multiplier
double_multipliernumericNoDouble multiplier
paid_leave_countsbooleanNoPaid leave counts toward the threshold — The law usually says it does not. Some agreements say it does.
week_starts_onintegerNoWeek starts on
priorityintegerNoOrder — Lower wins.
is_activebooleanNoActive
countrytextNoCountry — The country whose employees it governs. Empty: every country (an agreement of the company’s own).
premium_basistextNoPremium paid on
Allowed: regular_rate — the regular rate of pay basic_wage — the basic wage (Saudi Labour Law art. 107)
public_employer_appliesbooleanNoApplies 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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
jurisdictiontextNoJurisdiction — Empty for the whole country, or a region code.
applies_totextNoApplies to
Allowed: all non_exempt hourly union
union_codetextNoUnion code
daily_thresholdnumericNoOvertime after, per day
daily_double_thresholdnumericNoDouble time after, per day
weekly_thresholdnumericNoOvertime after, per week
seventh_day_rulebooleanNoSeventh consecutive day is premium
seventh_day_double_afternumericNoDouble after, on the seventh day
overtime_multipliernumericNoOvertime multiplier
double_multipliernumericNoDouble multiplier
paid_leave_countsbooleanNoPaid leave counts toward the threshold — The law usually says it does not. Some agreements say it does.
week_starts_onintegerNoWeek starts on
priorityintegerNoOrder — Lower wins.
is_activebooleanNoActive
countrytextNoCountry — The country whose employees it governs. Empty: every country (an agreement of the company’s own).
premium_basistextNoPremium paid on
Allowed: regular_rate — the regular rate of pay basic_wage — the basic wage (Saudi Labour Law art. 107)
public_employer_appliesbooleanNoApplies 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

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

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
codetextread, writeCode
nametextread, writeName
jurisdictiontextread, writeJurisdiction — Empty for the whole country, or a region code.
applies_totextread, writeApplies to
Allowed: all non_exempt hourly union
union_codetextread, writeUnion code
daily_thresholdnumericread, writeOvertime after, per day
daily_double_thresholdnumericread, writeDouble time after, per day
weekly_thresholdnumericread, writeOvertime after, per week
seventh_day_rulebooleanread, writeSeventh consecutive day is premium
seventh_day_double_afternumericread, writeDouble after, on the seventh day
overtime_multipliernumericread, writeOvertime multiplier
double_multipliernumericread, writeDouble multiplier
paid_leave_countsbooleanread, writePaid leave counts toward the threshold — The law usually says it does not. Some agreements say it does.
week_starts_onintegerread, writeWeek starts on
priorityintegerread, writeOrder — Lower wins.
is_activebooleanread, writeActive
org_unit_iduuidread onlyOrg unit id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
countrytextread, writeCountry — The country whose employees it governs. Empty: every country (an agreement of the company’s own).
premium_basistextread, writePremium paid on
Allowed: regular_rate — the regular rate of pay basic_wage — the basic wage (Saudi Labour Law art. 107)
public_employer_appliesbooleanread, writeApplies 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

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 › Overtime Rules 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.