Retrieves published forecast sales Maximum date range is 14 days; a wider range returns 400. Note: despite the name, most interval fields are labor metrics and the whole jobDetails array is per-job labor.
Security
The requesting user must have the following permission to retrieve sales analytics:
- Sales & Cash → Forecasts → Weekly Forecasting → View Weekly Forecasting
Identifies the R365 tenant the request applies to. Required on every request.
Identifier of the location to get forecast data
Start date to get forecast data
End date to get forecast data
Published forecast sales
Unique identifier of the location.
Display name of the location.
Forecast data grouped by date for the requested period.
Forecast date.
Forecast intervals within the date.
Start date and time of the interval.
Date and time the forecast was published. Null when the forecast has not been published yet.
Username of the user who published the forecast.
Forecasted net sales amount for the interval (precision 10,2).
Forecasted gross sales amount for the interval (precision 10,2).
Forecasted entree count for the interval (precision 10,2).
Forecasted labor cost for the interval (precision 5,2).
Actual net sales amount recorded for the interval (precision 5,2).
Actual gross sales amount recorded for the interval (precision 5,2).
Actual entree count recorded for the interval.
Actual labor cost recorded for the interval (precision 5,2).
Actual overtime hours recorded for the interval (precision 5,2).
Actual labor dollars recorded for the interval (precision 5,2).
Difference between optimal and actual labor (OptimalLabor - ActualLabor, precision 5,2).
Optimal labor cost for the interval (precision 5,2).
Per-job breakdown of forecasted and actual labor within the interval.
Job identifier.
Job name.
Forecasted labor cost for the job within the interval (precision 5,2).
Actual labor cost recorded for the job within the interval (precision 5,2).
Actual overtime hours recorded for the job within the interval (precision 5,2).
Actual labor dollars recorded for the job within the interval (precision 5,2).
Unique identifier of the location.
Display name of the location.
Forecast data grouped by date for the requested period.
Forecast date.
Forecast intervals within the date.
Start date and time of the interval.
Date and time the forecast was published. Null when the forecast has not been published yet.
Username of the user who published the forecast.
Forecasted net sales amount for the interval (precision 10,2).
Forecasted gross sales amount for the interval (precision 10,2).
Forecasted entree count for the interval (precision 10,2).
Forecasted labor cost for the interval (precision 5,2).
Actual net sales amount recorded for the interval (precision 5,2).
Actual gross sales amount recorded for the interval (precision 5,2).
Actual entree count recorded for the interval.
Actual labor cost recorded for the interval (precision 5,2).
Actual overtime hours recorded for the interval (precision 5,2).
Actual labor dollars recorded for the interval (precision 5,2).
Difference between optimal and actual labor (OptimalLabor - ActualLabor, precision 5,2).
Optimal labor cost for the interval (precision 5,2).
Per-job breakdown of forecasted and actual labor within the interval.
Job identifier.
Job name.
Forecasted labor cost for the job within the interval (precision 5,2).
Actual labor cost recorded for the job within the interval (precision 5,2).
Actual overtime hours recorded for the job within the interval (precision 5,2).
Actual labor dollars recorded for the job within the interval (precision 5,2).
Unique identifier of the location.
Display name of the location.
Forecast data grouped by date for the requested period.
Forecast date.
Forecast intervals within the date.
Start date and time of the interval.
Date and time the forecast was published. Null when the forecast has not been published yet.
Username of the user who published the forecast.
Forecasted net sales amount for the interval (precision 10,2).
Forecasted gross sales amount for the interval (precision 10,2).
Forecasted entree count for the interval (precision 10,2).
Forecasted labor cost for the interval (precision 5,2).
Actual net sales amount recorded for the interval (precision 5,2).
Actual gross sales amount recorded for the interval (precision 5,2).
Actual entree count recorded for the interval.
Actual labor cost recorded for the interval (precision 5,2).
Actual overtime hours recorded for the interval (precision 5,2).
Actual labor dollars recorded for the interval (precision 5,2).
Difference between optimal and actual labor (OptimalLabor - ActualLabor, precision 5,2).
Optimal labor cost for the interval (precision 5,2).
Per-job breakdown of forecasted and actual labor within the interval.
Job identifier.
Job name.
Forecasted labor cost for the job within the interval (precision 5,2).
Actual labor cost recorded for the job within the interval (precision 5,2).
Actual overtime hours recorded for the job within the interval (precision 5,2).
Actual labor dollars recorded for the job within the interval (precision 5,2).
Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.
Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.
Forbidden — the caller lacks the permission required for this operation.
Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.
Conflict — the request conflicts with the current state of the resource and cannot be applied.
Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.
Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.
Internal Server Error — an unexpected error occurred while processing the request.