Rotas

Employees can track their future/planned shifts in Wagestream. In order to do this, additional data would be required from the employer that aligns to the 'Rota' data model.

Rotas will not contribute to an employees earned wage balance. This means once the work has taken place and is approved, an accompanying 'shift' must be sent as described in the Time and Attendance data model.

For ease, this model is identical to Time and Attendance.

Field

Required

Data Type

Description

employee_id

yes

string

Unique ID of the employee

shift_id

yes

string

Unique ID of the rota. Reusing this ID will update the previous rota that used the same ID

worked_on

yes

date

Date the shift will take place in YYYY-MM-DD format

wages

yes

integer

The expected total GROSS wages for the shift, i.e. 90.50 if the total wages for the shift were GBP 90.50

type

no

string

One of “STANDARD” or “OVERTIME”

used for companies that want to allow higher access to overtime earnings

info

no

string

Information about the planned shift

started_at

no

datetime

Timestamp the shift will start, in ISO8601 format

ended_at

no

datetime

Timestamp the shift will end, in ISO8601 format

hours

yes

number

Number of hours that will be worked, can be float or integer, 2 decimal places

rate

no

number

The rate of pay for the shift, decimal to 2 places