LaborReportingData

The labor reporting data.

• businessDate:
  string <integer>

  The date for the aggregated reporting data. The business day uses the YYYYMMDD format. For example, 20220824.

• employeeChosenName:
  string

  The employee's chosen name. This property only appears when the request for labor data includes the groupBy property with value EMPLOYEE.

• employeeFirstName:
  string

  The employee's first name. This property only appears when the request for labor data includes the groupBy property with value EMPLOYEE.

• employeeGuid:
  string

  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.

• employeeLastName:
  string

  The employee's last name. This property only appears when the request for labor data includes the groupBy property with value EMPLOYEE.

• grossSalesAmount:
  number <double>

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

• grossSalesPerEmployeeHour:
  number <double>

  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.

• jobCode:
  string

  The guest-facing job code. This property only appears when the request for labor data includes the groupBy property with value JOB.

• jobGuid:
  string <UUID>

  The identifier assigned by the Toast platform used to identify a job. This property only appears when the request for labor data includes the groupBy property with value JOB.

• jobTitle:
  string

  The guest-facing job name. This property only appears when the request for labor data includes the groupBy property with value JOB.

• netSalesAmount:
  number <double>

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

• netSalesPerEmployeeHour:
  number <double>

  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.

• overtimeCost:
  number <double>

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

• overtimeHours:
  number <double>

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

• regularCost:
  number <double>

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

• regularHours:
  number <double>

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

• restaurantGuid:
  string <UUID>

  The identifier assigned by the Toast platform used to identify a restaurant location.

• restaurantLocationCode:
  string <string>

  The restaurant's location code.

• restaurantLocationName:
  string <string>

  The restaurant's location name.

• restaurantName:
  string <string>

  The restaurant's name.

• totalCost:
  number <double>

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

• totalCostPerGrossSales:
  number <double>

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

• totalCostPerNetSales:
  number <double>

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

• totalHours:
  number <double>

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

{
  "businessDate": "string",
  "restaurantGuid": "string",
  "restaurantName": "string",
  "restaurantLocationName": "string",
  "restaurantLocationCode": "string",
  "regularHours": 0,
  "overtimeHours": 0,
  "totalHours": 0,
  "regularCost": 0,
  "overtimeCost": 0,
  "totalCost": 0,
  "netSalesAmount": 0,
  "grossSalesAmount": 0,
  "netSalesPerEmployeeHour": 0,
  "grossSalesPerEmployeeHour": 0,
  "totalCostPerNetSales": 0,
  "totalCostPerGrossSales": 0,
  "jobGuid": "string",
  "jobTitle": "string",
  "jobCode": "string",
  "employeeGuid": "string",
  "employeeFirstName": "string",
  "employeeLastName": "string",
  "employeeChosenName": "string"
}