TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/hrms/time-policiesPublished as /api/v1/time-policies

Download specification (OpenAPI 3.1) Screen: Time Policies

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 › 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.
Tablehr.time_policies · 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

6 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/hrms/time-policiesList time policies

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

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

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
descriptiontextNoDescription
pay_group_iduuidNoPay group — Everybody in this pay group (an hourly group under its own agreement, for one).
overtime_rule_iduuidNoOvertime rule — Or: the people this overtime rule is chosen for, on their record or their pay group.
location_iduuidNoLocation — Or: punches made at this location. Only its position setting is read, and it can only make it stricter.
is_defaultbooleanNoCompany default — Governs everybody no other policy does. Names no pay group, rule or location.
punch_policytextNoWorked time comes from
Allowed: manual_allowed — hours may be typed, or punched punch_required — clock punches only (corrections approved by a manager)
geolocationtextNoPosition 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_minutesintegerNoRound to (minutes) — Empty: no rounding. 6 is a tenth of an hour, 15 a quarter. Breaks are never rounded.
round_methodtextNoRounding — Nearest is neutral over time and the default.
Allowed: nearest up down
round_grace_start_minutesintegerNoGrace 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_minutesintegerNoGrace at the end (minutes)
holiday_premium_earning_codetextNoHoliday premium earning code — Hours worked on a holiday of the person’s calendar earn this, on top of their pay.
holiday_premium_multipliernumericNoPremium: × the hourly rate — For a rate-times-hours code. 0.5 adds half again; 1.5 adds one and a half.
holiday_premium_flat_amountnumericNoPremium: flat amount for the day — Or this, for a flat-amount code. Not both.
is_activebooleanNoActive

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

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
descriptiontextNoDescription
pay_group_iduuidNoPay group — Everybody in this pay group (an hourly group under its own agreement, for one).
overtime_rule_iduuidNoOvertime rule — Or: the people this overtime rule is chosen for, on their record or their pay group.
location_iduuidNoLocation — Or: punches made at this location. Only its position setting is read, and it can only make it stricter.
is_defaultbooleanNoCompany default — Governs everybody no other policy does. Names no pay group, rule or location.
punch_policytextNoWorked time comes from
Allowed: manual_allowed — hours may be typed, or punched punch_required — clock punches only (corrections approved by a manager)
geolocationtextNoPosition 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_minutesintegerNoRound to (minutes) — Empty: no rounding. 6 is a tenth of an hour, 15 a quarter. Breaks are never rounded.
round_methodtextNoRounding — Nearest is neutral over time and the default.
Allowed: nearest up down
round_grace_start_minutesintegerNoGrace 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_minutesintegerNoGrace at the end (minutes)
holiday_premium_earning_codetextNoHoliday premium earning code — Hours worked on a holiday of the person’s calendar earn this, on top of their pay.
holiday_premium_multipliernumericNoPremium: × the hourly rate — For a rate-times-hours code. 0.5 adds half again; 1.5 adds one and a half.
holiday_premium_flat_amountnumericNoPremium: flat amount for the day — Or this, for a flat-amount code. Not both.
is_activebooleanNoActive

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

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/time-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/time-policies/{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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
codetextread, writeCode
nametextread, writeName
descriptiontextread, writeDescription
pay_group_iduuidread, writePay group — Everybody in this pay group (an hourly group under its own agreement, for one).
overtime_rule_iduuidread, writeOvertime rule — Or: the people this overtime rule is chosen for, on their record or their pay group.
location_iduuidread, writeLocation — Or: punches made at this location. Only its position setting is read, and it can only make it stricter.
is_defaultbooleanread, writeCompany default — Governs everybody no other policy does. Names no pay group, rule or location.
punch_policytextread, writeWorked time comes from
Allowed: manual_allowed — hours may be typed, or punched punch_required — clock punches only (corrections approved by a manager)
geolocationtextread, writePosition 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_minutesintegerread, writeRound to (minutes) — Empty: no rounding. 6 is a tenth of an hour, 15 a quarter. Breaks are never rounded.
round_methodtextread, writeRounding — Nearest is neutral over time and the default.
Allowed: nearest up down
round_grace_start_minutesintegerread, writeGrace 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_minutesintegerread, writeGrace at the end (minutes)
holiday_premium_earning_codetextread, writeHoliday premium earning code — Hours worked on a holiday of the person’s calendar earn this, on top of their pay.
holiday_premium_multipliernumericread, writePremium: × the hourly rate — For a rate-times-hours code. 0.5 adds half again; 1.5 adds one and a half.
holiday_premium_flat_amountnumericread, writePremium: flat amount for the day — Or this, for a flat-amount code. Not both.
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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

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 › Time Policies 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.