Adding a shift to an employee’s time card records hours worked.
Work period & breaks
A “shift” refers to any part of a whole continuous work period. If an employee works a scheduled work period in two parts, like one part before a lunch break and another part after, these parts could be recorded as two shifts or the break could be recorded as a "break period" within the shift.
We automatically provide a default break type for unpaid breaks. The default segmentConfigCode value for this break type is "DEFAULT_UNPAID". We can configure additional break types for paid or unpaid breaks upon request.
Pay rate
You can set a shift-specific pay rate using the field effectiveHourlyPayRate. This is the regular rate at which the shift should be paid: if the shift's regular rate is $20.00, you should pass { "amount": "20.00", currency: "USD" }. We'll calculate regular hours at $20.00/hr, overtime hours at $30.00/hr, and double-time hours at $40.00/hr, by default. This rate is used to determine the gross earnings for a shift.
If you don't set a shift-specific pay rate, we'll use the hourly pay rate on the worker's profile as a fallback.
You can optionally set a "display pay rate" for each shift as well. This is the rate that we'll display on the worker's pay stub, but is not used to calculate gross earnings for a shift—it's for display only. This field is useful in cases where you need to adjust the effectiveHourlyPayRate based on business policy or regulations. For example, if you need to calculate a weighted-average pay rate, you should set the calculated average rate using effectiveHourlyPayRate (i.e. $21.23) and set the quoted rate for the shift (i.e. $20.00) using displayHourlyPayRate.
Overtime classification
By default, we support the federal FLSA overtime rule and rules for the states that have additional overtime rules. We apply overtime rules based on the work location specified on a worker's profile.
We support custom overtime classification rules, and the rules can be different for each state. Your Everee account manager can help configure custom rules if you need that.
Work location
When workers are staffed at different work locations per shift, it's critical to assign the correct work location for each shift to ensure the correct tax liability is determined for each location where work is performed. Providing a value for the parameter overrideWorkLocationId assigns a shift to a specific work location for tax purposes.
Work Locations API
Work locations must be created before you can assign them to shifts. There are no restrictions on how many work locations you can create. See the Work Locations API for more information about creating work locations.
If no value is provided, the work location assigned to the worker's profile is used by default.
When a work location is assigned to a shift, gross earnings for that shift are subject to all employee– and employer–side taxes in effect for that location on the date of the shift. These taxes are automatically applied to the payment that pays out earnings for this shift (typically in the next payroll batch). If a payment pays out earnings for multiple shifts, each with assigned work locations, all appropriate taxes for the shifts' work locations will be applied to that payment.