HUhubstaff
overtime_policies

Create overtime policy

Changed on

Creates a new overtime policy for the given organization and assigns the given members.

threshold is the number of hours worked per period (week for weekly, day for daily) before tracked time is considered overtime. pay_rate_multiplier is applied to the member's pay rate after the threshold is reached.

At least one member (user_ids) is required, and every assigned member must have a pay rate set. daily policies require the flexible overtime feature.

A member can only belong to one policy of a given type at a time. If any member in user_ids is already assigned to another active policy of the same type, the request fails unless override is true, in which case those members are moved into this policy.

Notifications are enabled by default but go to no one unless notification_role_ids is provided.

The policy becomes effective at the start of the organization's next week (for weekly policies) or the next day (for daily policies). Pass starts_on to schedule a later start aligned to that boundary.

Only organization Owners and Managers may use this endpoint.

post/v2/organizations/{organization_id}/overtime_policies

Request

Path parameters

organization_idinteger required

Request body

namestring required

Policy name (2-50 characters)

policy_type'daily' | 'weekly'

How the threshold is evaluated

thresholdnumber float required

Hours worked per period before overtime applies

pay_rate_multipliernumber float required

Pay rate multiplier after the threshold

user_idsinteger[] required

User IDs to assign to the policy

auto_add_new_usersboolean

Automatically add new members to this policy

notification_enabledboolean

Whether overtime notifications are sent

notification_role_idsstring[]

Roles notified about overtime

starts_onstring date

Scheduled start date (period-aligned)

overrideboolean

Move members already on another active policy of the same type into this one. Without it, the request fails if any assigned member is already on such a policy.

Response

An overtime policy

Changes