timeSurcharge

function timeSurcharge(
   amountPerHour,
   window,
opts?): RuleEntry<"time-cost-surcharge", object & CostRuleOptions>;

Adds a flat surcharge per hour for the portion of a shift that overlaps a time-of-day window.

Parameters

number

required

Flat surcharge per hour in smallest currency unit

required

Time-of-day window

Show properties

required

TimeOfDay

required

TimeOfDay

CostRuleOptionsEntity and time scoping

Returns

RuleEntry<"time-cost-surcharge", object & CostRuleOptions> The window supports overnight spans (e.g., 22:00-06:00). The surcharge is independent of the member’s base rate.

Getting Started

Guides

Schedule Definition

Time Periods

Coverage

Shift Patterns

Rules

Cost Optimization

Solver

Supporting Types

timeSurcharge

Parameters

Returns

​Parameters

​Returns

Parameters

Returns