Get menu item daily totals
post
/bi/v1/{orgIdentifier}/getMenuItemDailyTotals
Get the Menu Item Daily Totals for a specified location and business date.
Request
Path Parameters
-
orgIdentifier(required): string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : requestPayload
Type:
objectRequest payload
Show Source
-
applicationName:
string
Title:
Application NameMaximum Length:128The name of the application which is accessing the API.First Available Version: 20.1.10
-
busDt(required):
string(date)
Title:
Business DateThe business date associated with the cash management detail -
include:
string
Title:
IncludeMaximum Length:2000List of objects to include in response -
locRef(required):
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
searchCriteria:
string
Title:
Search CriteriaMaximum Length:2000Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : miDailyTotals
Type:
objectThe response body contains information about the daily totals by menu item for the specified location and business date.
Show Source
-
busDt(required):
string(date)
Title:
Business DateBusiness Date -
locRef(required):
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
revenueCenters(required):
array revenueCenters
An array of Menu Item Daily Totals by Revenue Centers
Nested Schema : revenueCenters
Type:
arrayAn array of Menu Item Daily Totals by Revenue Centers
Show Source
-
Array of:
object miDailyTotalsByRVC
The response body contains daily totals by menu item of a revenue center for the specified location and business date.
Nested Schema : miDailyTotalsByRVC
Type:
objectThe response body contains daily totals by menu item of a revenue center for the specified location and business date.
Show Source
- menuItems(required): array menuItems
-
rvcNum(required):
integer
Title:
Revenue Center NumberMaximum Length:10Revenue Center number. This attribute will not be returned in the response if menuItems is null
Nested Schema : miDailyTotal
Type:
objectThe response body contains daily totals by menu item for a revenue center for the specified location and business date.
Show Source
-
dscTtl(required):
number
Title:
Discount TotalItem discount Total of the menu item. This attribute will not be returned in the response if value is 0 or null -
dscVatTtl(required):
number
Title:
Discount VAT TotalMultiple Of:1.0E-6Discount VAT Total of the menu item. This attribute will not be returned in the response if value is 0 or null -
forgivenInclTaxTtl(required):
number
Title:
Total amount of inclusive taxes forgiven.Total amount of inclusive taxes forgiven. Applicable for Australian GST configurations. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.10.1
-
inclTaxTtl(required):
number
Title:
Total amount of inclusive taxesTotal amount of inclusive taxes. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.10.1
-
miNum(required):
integer
Title:
Menu Item NumberMaximum Length:16Menu Item Number -
ocNum:
integer
Title:
Order Channel numberMaximum Length:16Unique identifier of the order channel. This attribute will not be returned in the response if value is 0 or null.First available version 20.1.15
-
otNum(required):
integer
Title:
Order Type NumberMaximum Length:16Unique identfier of the order type. This attribute will not be returned in the response if value is 0 or null -
prcLvlNum(required):
integer
Title:
Price Level NumberMaximum Length:16Unique identifier for the menu item's price level -
prepCost(required):
number
Title:
Prepartion CostTotal Preparation cost associated with the menu item. This attribute will not be returned in the response if value is 0 or null -
rtnCnt(required):
integer
Title:
Return CountMaximum Length:16Total Return Count of the menu item. This attribute will not be returned in the response if value is 0 or null -
slsCnt(required):
integer
Title:
Sales CountMaximum Length:16Total Sales Count of the menu item. -
slsTtl(required):
number
Title:
Sales TotalTotal Sales of the menu item -
vatTtl(required):
number
Title:
VAT TotalMultiple Of:1.0E-6VAT total of the menu item. This attribute will not be returned in the response if value is 0 or null -
vol(required):
number
Title:
VolumeSales volume of the menu item. This attribute will not be returned in the response if value is 0 or null
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
Examples
The following example shows how to view all the menu item daily totals for a specified location & business date by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H "Authorization: Bearer" -H "Content-Type:application/json" -d {"locRef":"1234","busDt":"2020-10-20"} https://baseurl/bi/v1/orgidentifier/getMenuItemDailyTotals
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Date: Tue, 20 Oct 2020 21:24:33 GMT Transfer-Encoding: chunked Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"locRef": "1234",
"busDt: "2020-07-20",
"revenueCenters":[{
"rvcNum": 1372,
"menuItems":[{
"miNum": 12345,
"prcLvlNum": 1,
"ocNum": 2,
"otNum": 12345,
"slsTtl": 1234.56,
"slsCnt": 123,
"rtnCnt": 123,
"dscTtl": 1234.56,
"vol": 1234.56,
"prepCost": 1234.56,
"vatTtl": 1234.567890,
"dscVatTtl": 1234.567890,
"inclTaxTtl": 14.45,
"forgivenInclTaxTtl": 12.34
}]
}]
}