Importing standard and contracted hours for employees
To change standard hours in bulk for multiple employees, you may want to set up your proposed hours and then import them to save time on data entry.
This page is about the specifics of importing standard hours. For general information, see Importing Data .
Using the importers
To import standard and contracted hours, you need to use two importers. It’s important that they are imported in order.
First, you import the Employee Standard Hours Headers. This updates your employee records with supporting information like when their standard hours take effect and whether they are are added to the roster. It also controls contrcted hours.
Second, you import Employee Standard Hours Days, which sets the actual days and times for the standard hours.
Import tips
Always use the standard hours importers in order: headers before days. A commencement date must exist before the days can be imported.
Select Download full template from the employee importer to make sure you have the latest template.
Be careful! Both header and days imports will overwrite your current data, and there is no way to remove standard hours from employees using an import, it can only be done manually.
Incorrect values in the Contracted Hours field can result in leave not calculating correctly, as the leave engine won’t generate hours of leave past their contracted hours in a given shift cycle.
Importer field information
Employee standard hours headers
Column name | Type | Valid Values | Purpose / Usage notes |
|---|---|---|---|
employeeId | INTEGER or STRING | Employee ID Value from Employees list or | Required Identify which employee to upload against. |
commencedAt | DATE | ISO formatted date: | Required When the standard hours take effect. |
concludedAt | DATE | ISO formatted date: | Optional When the standard hours stop applying. |
rosterable | BOOLEAN | Boolean | Required Controls: “Add these standard hours to the roster” |
locked | BOOLEAN | Boolean | Required Controls: “Lock the roster to these standard hours” |
contractedHours | DECIMAL | Decimal, must be positive. | Optional The number of hours an employee is contracted for across the entire standard hours period* |
* The contracted hours number covers the entire standard hours pattern, not just a single week.
For example, for an employee contracted for 38 hours per week, with a standard hours pattern covering two weeks, enter a contracted hours figure of 76 (two times 38).
Employee Standard Hours Days
Column name | Type | Valid Values | Purpose / Usage notes |
|---|---|---|---|
employeeId | INTEGER or STRING | Employee ID Value from Employees list or | Required Identify which employee to upload against. |
commencedAt | DATE | ISO formatted date: | Required Which Standard Hours Header is this day record part of. |
week | INTEGER | 1,2,3,4 | Required. The week of the entry, starting from the commencement week* |
day | INTEGER | 0,1,2,3,4,5,6 | Required The day of the entry, starting from the first day of the week* |
locationId | INTEGER or STRING | LocationID value (Database value) or the exact string of the location name from the locations list. | Required Controls: “Lock the roster to these standard hours” |
positionId | INTEGER or STRING | PositionD value (Database value) or the exact string of the position name from the positions list. | Required The number of hours an employee is contracted for across the entire standard hours period. |
shiftStartTime | STRING | hh:mm Valid: 08:00 | Required Start time of shift |
shiftEndTime | STRING | hh:mm Valid: 08:00 | Required End time of shift If before the Start time, indicates that the shift finishes on the following day. |
breakStartTime | STRING | hh:mm Valid: 08:00 | Optional Start time of break. leave blank for no break. |
breakEndTime | STRING | hh:mm Valid: 08:00 | Optional Start time of break. leave blank for no break. |
* For the first day of a standard hours pattern (the commencement date) enter week 1, day 0. From there, the days cycle from zero to six, and the weeks count up from one to four.
For example, for a work pattern starting on Monday, the 1st of October, week 1, day 2 is Wednesday, the 3rd of October is and week 4, day 5 is Saturday, the 26th of October.