Scheduling

The Scheduling API lets you manage employee logged time and schedules. Logged time on POS can be tracked and used for billing and payroll via the API to the Revel Management Console. Timesheets and entries can also be updated in the Revel Management Console via the API if you use a different time tracking application.

You can use the Scheduling API to sync schedules and time worked between Revel and your systems. You may create, update and manage schedules from other application via these APIs as well.

📘

Because this suite uses the Employees API suite, you also need access to the Employees suite of resources in order to track employee information.

TimeSchedule

The TimeSchedule resource is used to create and track shift employees' records within a specific Establishment. A TimeSchedule object represents a shift's information about start and end time, establishment, role, and wage. This resource can also include breaks.

TimeScheduleRule

The TimeScheduleRule resource collects information about the establishment's time scheduling rules. These rules include information about breaks, double time and overtime pay rates, and clock-in and clock-out details.

When used with other endpoints, these rules allows the API to calculate time worked and gross pay accurately.

TimeSheetEntry

The TimeSheetEntry resource creates and tracks an employee's logged time within a specific Establishment. Each TimeSheetEntry object represents an employee’s logged time with clock in and a clock out details. Breaks can be included as well. If break_type is null, the TimeSheetEntry represents only time worked.

[So wait, what does each entry for, say, a day look like if there's a break in between two working sessions? Would we have three objects, one for the first work session, one for the break, and one for the second work session? That's how I'm reading the endpoint, but you're not technically clocked in for the break.]