Documentation Index

Fetch the complete documentation index at: https://docs.restaurant365.com/llms.txt

Use this file to discover all available pages before exploring further.

Sales Analytics

  • Updated on Jun 18, 2026
  • Published on Jun 17, 2026
  • 4 minute(s) read
Prev Next
Get
/public/v1/labor/sales-analytics

Retrieves published forecast sales

Security
HTTP
Type Bearer

Put ONLY your JWT Bearer token on textbox below!

Query parameters
locationId
string (uuid) Required

Identifier of the location to get forecast data

startDate
string (date) Required

Start date to get forecast data

endDate
string (date) Required

End date to get forecast data

Responses
200

Published forecast sales

Expand All
object
locationId
string (uuid)

Unique identifier of the location.

locationName
string | null

Display name of the location.

DailyData
Array of object (R365.Netcore.Public.Contracts.Forecast.Models.DateIntervals) | null

Forecast data grouped by date for the requested period.

object
date
string (date-time)

Forecast date.

name
string | null

Optional display name for the date grouping.

Intervals
Array of object (R365.Netcore.Public.Contracts.Forecast.Models.Interval) | null

Forecast intervals within the date.

object
startDateTime
string (date-time)

Start date and time of the interval.

publishedAt
string (date-time) | null

Date and time the forecast was published. Null when the forecast has not been published yet.

publishedByName
string | null

Username of the user who published the forecast.

ForecastedNetSales
number (double)

Forecasted net sales amount for the interval (precision 10,2).

ForecastedGrossSales
number (double)

Forecasted gross sales amount for the interval (precision 10,2).

ForecastedEntree
number (double)

Forecasted entree count for the interval (precision 10,2).

ForecastedLabor
number (double)

Forecasted labor cost for the interval (precision 5,2).

ActualNetSales
number (double)

Actual net sales amount recorded for the interval (precision 5,2).

ActualGrossSales
number (double)

Actual gross sales amount recorded for the interval (precision 5,2).

ActualEntreeCount
integer (int32)

Actual entree count recorded for the interval.

ActualLabor
number (double)

Actual labor cost recorded for the interval (precision 5,2).

ActualLaborOTHours
number (double)

Actual overtime hours recorded for the interval (precision 5,2).

ActualLaborDollars
number (double)

Actual labor dollars recorded for the interval (precision 5,2).

OptimalLaborVariance
number (double)

Difference between optimal and actual labor (OptimalLabor - ActualLabor, precision 5,2).

OptimalLabor
number (double)

Optimal labor cost for the interval (precision 5,2).

JobDetails
Array of object (R365.Netcore.Public.Contracts.Forecast.Models.JobDetail) | null

Per-job breakdown of forecasted and actual labor within the interval.

object
jobId
string (uuid)

Job identifier.

jobName
string | null

Job name.

LaborForecast
number (double)

Forecasted labor cost for the job within the interval (precision 5,2).

ActualLabor
number (double)

Actual labor cost recorded for the job within the interval (precision 5,2).

ActualLaborOTHours
number (double)

Actual overtime hours recorded for the job within the interval (precision 5,2).

ActualLaborDollars
number (double)

Actual labor dollars recorded for the job within the interval (precision 5,2).

Expand All
object
locationId
string (uuid)

Unique identifier of the location.

locationName
string | null

Display name of the location.

DailyData
Array of object (R365.Netcore.Public.Contracts.Forecast.Models.DateIntervals) | null

Forecast data grouped by date for the requested period.

object
date
string (date-time)

Forecast date.

name
string | null

Optional display name for the date grouping.

Intervals
Array of object (R365.Netcore.Public.Contracts.Forecast.Models.Interval) | null

Forecast intervals within the date.

object
startDateTime
string (date-time)

Start date and time of the interval.

publishedAt
string (date-time) | null

Date and time the forecast was published. Null when the forecast has not been published yet.

publishedByName
string | null

Username of the user who published the forecast.

ForecastedNetSales
number (double)

Forecasted net sales amount for the interval (precision 10,2).

ForecastedGrossSales
number (double)

Forecasted gross sales amount for the interval (precision 10,2).

ForecastedEntree
number (double)

Forecasted entree count for the interval (precision 10,2).

ForecastedLabor
number (double)

Forecasted labor cost for the interval (precision 5,2).

ActualNetSales
number (double)

Actual net sales amount recorded for the interval (precision 5,2).

ActualGrossSales
number (double)

Actual gross sales amount recorded for the interval (precision 5,2).

ActualEntreeCount
integer (int32)

Actual entree count recorded for the interval.

ActualLabor
number (double)

Actual labor cost recorded for the interval (precision 5,2).

ActualLaborOTHours
number (double)

Actual overtime hours recorded for the interval (precision 5,2).

ActualLaborDollars
number (double)

Actual labor dollars recorded for the interval (precision 5,2).

OptimalLaborVariance
number (double)

Difference between optimal and actual labor (OptimalLabor - ActualLabor, precision 5,2).

OptimalLabor
number (double)

Optimal labor cost for the interval (precision 5,2).

JobDetails
Array of object (R365.Netcore.Public.Contracts.Forecast.Models.JobDetail) | null

Per-job breakdown of forecasted and actual labor within the interval.

object
jobId
string (uuid)

Job identifier.

jobName
string | null

Job name.

LaborForecast
number (double)

Forecasted labor cost for the job within the interval (precision 5,2).

ActualLabor
number (double)

Actual labor cost recorded for the job within the interval (precision 5,2).

ActualLaborOTHours
number (double)

Actual overtime hours recorded for the job within the interval (precision 5,2).

ActualLaborDollars
number (double)

Actual labor dollars recorded for the job within the interval (precision 5,2).

Expand All
object
locationId
string (uuid)

Unique identifier of the location.

locationName
string | null

Display name of the location.

DailyData
Array of object (R365.Netcore.Public.Contracts.Forecast.Models.DateIntervals) | null

Forecast data grouped by date for the requested period.

object
date
string (date-time)

Forecast date.

name
string | null

Optional display name for the date grouping.

Intervals
Array of object (R365.Netcore.Public.Contracts.Forecast.Models.Interval) | null

Forecast intervals within the date.

object
startDateTime
string (date-time)

Start date and time of the interval.

publishedAt
string (date-time) | null

Date and time the forecast was published. Null when the forecast has not been published yet.

publishedByName
string | null

Username of the user who published the forecast.

ForecastedNetSales
number (double)

Forecasted net sales amount for the interval (precision 10,2).

ForecastedGrossSales
number (double)

Forecasted gross sales amount for the interval (precision 10,2).

ForecastedEntree
number (double)

Forecasted entree count for the interval (precision 10,2).

ForecastedLabor
number (double)

Forecasted labor cost for the interval (precision 5,2).

ActualNetSales
number (double)

Actual net sales amount recorded for the interval (precision 5,2).

ActualGrossSales
number (double)

Actual gross sales amount recorded for the interval (precision 5,2).

ActualEntreeCount
integer (int32)

Actual entree count recorded for the interval.

ActualLabor
number (double)

Actual labor cost recorded for the interval (precision 5,2).

ActualLaborOTHours
number (double)

Actual overtime hours recorded for the interval (precision 5,2).

ActualLaborDollars
number (double)

Actual labor dollars recorded for the interval (precision 5,2).

OptimalLaborVariance
number (double)

Difference between optimal and actual labor (OptimalLabor - ActualLabor, precision 5,2).

OptimalLabor
number (double)

Optimal labor cost for the interval (precision 5,2).

JobDetails
Array of object (R365.Netcore.Public.Contracts.Forecast.Models.JobDetail) | null

Per-job breakdown of forecasted and actual labor within the interval.

object
jobId
string (uuid)

Job identifier.

jobName
string | null

Job name.

LaborForecast
number (double)

Forecasted labor cost for the job within the interval (precision 5,2).

ActualLabor
number (double)

Actual labor cost recorded for the job within the interval (precision 5,2).

ActualLaborOTHours
number (double)

Actual overtime hours recorded for the job within the interval (precision 5,2).

ActualLaborDollars
number (double)

Actual labor dollars recorded for the job within the interval (precision 5,2).