Understanding the labor reporting data

Labor reporting data contains consistent values that appear for each active restaurant and by business date. Optionally, you can choose to aggregate the labor reporting data by either employee or job. For more information, see Aggregating the labor reporting data. For information about retrieving inactive restaurant data, see Viewing inactive restaurant data.

The restaurants included in the labor reporting data can be limited by adding the GUIDs of restaurants to either include only or exclude only. For an example that chooses specific restaurants, see Creating a request for labor reporting data.

The following table specifies the returned set of values in the labor reporting data. The values are listed in the order they appear.

Value name

Definition

restaurantGuid

The unique identifier assigned to the restaurant by the Toast platform.

businessDate

The calendar date of the associated order data, in YYYYMMDD format.

regularHours

The total regular hours logged between clock-in and clock-out for employees with hourly jobs. This does not include overtime hours.

overtimeHours

The total overtime hours logged between clock-in and clock-out for employees with hourly jobs. This only includes overtime hours.

totalHours

The total hours logged between clock-in and clock-out for employees with hourly jobs. This includes regular and overtime hours.

regularCost

The operation costs related to employees with hourly jobs from all regular hours, including all shifts.

overtimeCost

The operation costs related to employees with hourly jobs from all overtime hours, including all shifts.

totalCost

The operation costs related to employees with hourly jobs from all work hours, including all shifts.

netSalesAmount

The total sales, excluding tax, gratuity, tips, discounts, refunds, and deferred amounts. This property is only included when no groupBy value is specified.

grossSalesAmount

The total sales, including discounts and refunds. This property is only included when no groupBy value is specified.

netSalesPerEmployeeHour

The average of the location's total net sales for each hour clocked by an employee. This property is only included when no groupBy value is specified.

grossSalesPerEmployeeHour

The average of the location's total gross sales for each hour clocked by an employee. This property is only included when no groupBy value is specified.

totalCostPerNetSales

The ratio of employee operational costs compared to total net sales, expressed as a percentage.

totalCostPerGrossSales

The ratio of employee operational costs compared to gross sales, expressed as a percentage.

jobGuid

The identifier assigned by the Toast platform used to identify a job. This property is only included when the groupBy property uses the JOB value. If not aggregated by JOB, the value is null.

jobTitle

The job name. This property only appears when the request for labor data includes the groupBy property with value JOB. If not aggregated by JOB, the value is null.

jobCode

A reference identifier for the job. This is an optional field entered when the job is created. For example, it can be used to match Toast platform jobs to jobs configured in external labor management systems. This property only appears when the request for labor data includes the groupBy property with value JOB. If not aggregated by JOB, the value is null.

employeeGuid

The identifier assigned by the Toast platform used to identify an employee. This property only appears when the request for labor data includes the groupBy property with value EMPLOYEE. If not aggregated by EMPLOYEE, the value is null.

employeeFirstName

The employee's first name. This property is populated when the request for labor data includes the groupBy property with value EMPLOYEE. If not aggregated by EMPLOYEE, the value is null.

employeeLastName

The employee's last name. This property is populated when the request for labor data includes the groupBy property with value EMPLOYEE. If not aggregated by EMPLOYEE, the value is null.

employeeChosenName

The employee's chosen name. This property is populated when the request for labor data includes the groupBy property with value EMPLOYEE. If not aggregated by EMPLOYEE, the value is null.

restaurantName

The restaurant’s name.

restaurantLocationName

The restaurant’s location name.

restaurantLocationCode

The restaurant’s location code.