Get operations daily totals
post
/bi/v1/{orgIdentifier}/getOperationsDailyTotals
Get the Operations Daily Totals for a specified location and business date.
Request
Path Parameters
-
orgIdentifier: 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(optional):
string
Title:
Application NameMaximum Length:128The name of the application which is accessing the API.First Available Version: 20.1.10
-
busDt:
string(date)
Title:
Business DateThe business date associated with the cash management detail -
include(optional):
string
Title:
IncludeMaximum Length:2000List of objects to include in response -
locRef:
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
searchCriteria(optional):
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 : opDailyTotals
Type:
objectThe response body contains information about the operations daily totals for the specified business date and location.
Show Source
-
busDt:
string(date)
Title:
Business DateBusiness Date -
locRef:
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
revenueCenters:
array revenueCenters
An array of operations daily totals by RVC
Nested Schema : revenueCenters
Type:
arrayAn array of operations daily totals by RVC
Show Source
-
Array of:
object opDailyTotalsByRVC
The response body contains operations daily totals of a revenue center for the specified location and business date.
Nested Schema : opDailyTotalsByRVC
Type:
objectThe response body contains operations daily totals of a revenue center for the specified location and business date.
Show Source
-
carryoverCnt:
integer
Title:
Carry Over CountMaximum Length:16Number of items that were carried over for the day. This attribute will not be returned in the response if value is 0 or null -
carryoverTtl:
number
Title:
Carry Over TotalTotal of items that were carried over for the day. This attribute will not be returned in the response if value is 0 or null -
chkClsdCnt:
integer
Title:
Check Closed CountMaximum Length:16Number of checks that were were closed in the day -
chkClsdTtl:
number
Title:
Check Closed TotalTotal of checks that were were closed in the day -
chkCnt:
integer
Title:
Check CountMaximum Length:16Total number of checks for the day. -
chkOpnCnt:
integer
Title:
Check Open CountMaximum Length:16Number of checks that were were rung in the day which remain in open state -
chkOpnTtl:
number
Title:
Check Open TotalTotal of checks that were were rung in the day which remain in open state -
chkXferInTtl:
number
Title:
Check Transfer In TotalTotal of checks that were transferred in for the day. This attribute will not be returned in the response if value is 0 or null -
chkXfrInCnt:
integer
Title:
Check Transfer In CountMaximum Length:16Number of checks that were transferred in for the day. This attribute will not be returned in the response if value is 0 or null -
chkXfrOutCnt:
integer
Title:
Check Transfer Out CountMaximum Length:16Number of checks that were transferred out for the day. This attribute will not be returned in the response if value is 0 or null -
chkXfrOutTtl:
number
Title:
Check Transfer Out TotalTotal of checks that were transferred out for the day. This attribute will not be returned in the response if value is 0 or null -
chngInGrndTtl:
number
Title:
Change in Grand TotalChange in Grand Total for the day. This attribute will not be returned in the response if value is 0 or null -
credTtl:
number
Title:
Credit TotalTotal of tax credits for the day. This attribute will not be returned in the response if value is 0 or null -
dineTimeInMins:
number
Title:
Dine Time in minutesMaximum Length:16Total dining time for the day in minutes. This attribute will not be returned in the response if value is 0 or null -
drvThruTimeInMins:
number
Title:
Drive through Time in minutesMaximum Length:16Total drive through time for the day in minutes. This attribute will not be returned in the response if value is 0 or null -
errCorCnt:
integer
Title:
Error Correct CountMaximum Length:16Number of items which were error corrected for the day. This attribute will not be returned in the response if value is 0 or null -
errCorTtl:
number
Title:
Error Correct TotalTotal of items which were error corrected for the day. This attribute will not be returned in the response if value is 0 or null -
gstCnt:
integer
Title:
Guest CountMaximum Length:16Total number of guests for the day. This attribute will not be returned in the response if value is 0 or null -
itmDscTtl:
number
Title:
Item Discount TotalTotal of item discounts for the day -
mngrVdCnt:
integer
Title:
Manager Void CountMaximum Length:16Number of items which were voided by the manager of the employee. This attribute will not be returned in the response if value is 0 or null -
mngrVdTtl:
number
Title:
Manager Void TotalTotal items which were voided by the manager of the employee. This attribute will not be returned in the response if value is 0 or null -
netSlsTtl:
number
Title:
Net Sales TotalTotal of net sales for the day -
nonRevSvcTtl:
number
Title:
Non Revenue Service Charge TotalNon-revenue service charge, and non-revenue menu item total such as gift cards sales. This attribute will not be returned in the response if value is 0 or null -
nonTxblSlsTtl:
number
Title:
Non Taxable Sales TotalTotal of non taxable sales for the day -
noSalesCnt:
integer
Title:
No Sale Transaction CountMaximum Length:16Number of no sale transactions for the day. This attribute will not be returned in the response if value is 0 or null -
overShortTtl:
number
Title:
Over Short TotalOver Short Total. This attribute will not be returned in the response if value is 0 or null -
parkCarCnt:
integer
Title:
Parked Car CountMaximum Length:16Total number of cars parked for the day. This attribute will not be returned in the response if value is 0 or null -
prepCostTtl:
number
Title:
Prepartion Cost totalTotal of preparation cost for the day. This attribute will not be returned in the response if value is 0 or null -
rndTtl:
number
Title:
Round TotalTotal of currency roundings for the day. This attribute will not be returned in the response if value is 0 or null -
rtnCnt:
integer
Title:
Return CountMaximum Length:16Total number of items returned in the day. This attribute will not be returned in the response if value is 0 or null -
rtnTtl:
number
Title:
Return TotalTotal value of returned items for the day. This attribute will not be returned in the response if value is 0 or null -
rvcNum:
integer
Title:
Revenue Center NumberMaximum Length:16Revenue Center number. This will not be returned if there are no totals for the associated revenue center -
slsFcst:
number
Title:
Sales ForecastTotal of forecasted sales for the day. This attribute will not be returned in the response if value is 0 or null -
subDscTtl:
number
Title:
Sub Discount TotalTotal of sub total discounts for the day -
svcTtl:
number
Title:
Service Charge TotalTotal of service charges for the day -
taxCollTtl:
number
Title:
Tax Collected TotalTotal of tax collected for the day -
taxExmptSlsTtl:
number
Title:
Tax Exempt Sales TotalTotal of tax exempted sales for the day -
tblTurnCnt:
integer
Title:
Table Turn CountMaximum Length:16Total number of tables turns for the day. This attribute will not be returned in the response if value is 0 or null -
transCnclCnt:
integer
Title:
Transaction Cancel CountMaximum Length:16Number of transactions that were cancelled for the day. This attribute will not be returned in the response if value is 0 or null -
transCnclTtl:
number
Title:
Transaction Cancel TotalTotal of transactions that were cancelled for the day. This attribute will not be returned in the response if value is 0 or null -
trnChkCnt:
integer
Title:
Training Check CountMaximum Length:16Number of checks that were used for training for the day. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.10
-
trnChkTtl:
number
Title:
Training Check TotalTotal of checks that were used for training for the day. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.10
-
txblSlsTtl:
number
Title:
Taxable Sales TotalTotal of taxable sales for the day -
vdCnt:
integer
Title:
Void CountMaximum Length:16Number of items voided for the day. This attribute will not be returned in the response if value is 0 or null -
vdTtl:
number
Title:
Void TotalTotal of items voided for the day. This attribute will not be returned in the response if value is 0 or null -
waitPtyCnt:
integer
Title:
Waiting Party CountMaximum Length:16Total number of waiting parties for the day. This attribute will not be returned in the response if value is 0 or null -
waitTimeInMins:
number
Title:
Wait time in miuntesMaximum Length:16Total wait time for the day in minutes. 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(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
Examples
The following example shows how to view all the operational 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/getOperationsDailyTotals
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": 123,
"netSlsTtl": 1234.56,
"itmDscTtl": 1234.56,
"subDscTtl": 1234.56,
"svcTtl": 1234.56,
"nonRevSvcTtl": 1234.56,
"rtrnCnt": 123,
"rtrnTtl": 1234.56,
"credTtl": 1234.56,
"rndTtl": 123.45,
"chngInGrndTtl": 1234.56,
"nonTxblSlsTtl": 1234.56,
"txblSlsTtl": 1234.56,
"taxExmptSlsTtl": 1234.56,
"taxCollTtl": 1234.56,
"slsFcst": 1234.56,
"prepCostTtl": 1234.56,
"numTbl": 10,
"tblTurnCnt": 101,
"chkCnt": 123,
"waitPtyCnt": 123,
"waitTimeInMins": 12
"gstCnt": 123,
"dineTimeInMins": 34,
"parkCarCnt": 123,
"drvThruTimeInMins": 12,
"vdTtl": 1234.56,
"vdCnt": 123,
"errCorTtl": 1234.56,
"errCorCnt": 123,
"mngrVdTtl": 1234.56,
"mngrVdCnt": 123,
"transCnclTtl": 123.45,
"transCnclCnt": 123,
"carryoverTtl": 123.45,
"carryoverCnt": 123,
"chkOpnTtl": 1234.56,
"chkOpenCount": 123,
"chkXferInTtl": 1234.56,
"chkXferInCnt": 123,
"chkXferOutTtl": 1234.56,
"chkXferOutCnt": 123,
"chkClsdTtl": 1234.56,
"chkClsdCnt": 123,
"overShortTtl": 1234.56,
"noSlsCnt": 123
"trnChkTtl": 134.56,
"trnChkCnt": 12
}]
}