Shift definition behaviour

Shift definition behaviour

The shiftDefinition property appears in several collections. Where it comes from — and whether it appears at all — depends on the collection.

Absences, counters, and activity durations

The shiftDefinition property is linked to the record (absence, counter, or activity duration) unless the shift is inherited from the schedule.

Tip

When the shift comes from the schedule, shiftDefinition is not included in the response. It only appears when the shift is explicitly assigned to the record rather than inherited.

This applies to:

Calculated totals

The shift definition in calculated totals is determined by a priority waterfall:

  1. Schedule — the default shift assigned in the day program for that date.
  2. Rules or calculations — if the shift is modified by if…then rules or other calculation logic (e.g. overtime, exceptions), the modified shift takes precedence.

Important

The response does not distinguish where the shift came from. It reflects the final result after applying both levels of the waterfall.

See: Calculated totals reference

Paid presences

The shiftDefinition is optional. It appears when the paid presence is associated with a specific shift. When no shift is assigned, the field is omitted.

Paid presences can return multiple records for the same person and date when the presence is split across shifts.

See: Paid presences reference

Further reading