Get control daily totals
post
/bi/v1/{orgIdentifier}/getControlDailyTotals
Get the Control 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 : controlTotalsRequestPayload
Type:
objectRequest payload for Control Daily Totals
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 DateIf present, the API will return the superset of all guest checks where Open Business Date or Closed Business Date match to the supplied date. This parameter cannot be present if clsdBusDt or opnbusDt are present -
clsdBusDt(required):
string(date)
Title:
Business DateIf present, the API will return all guest checks which were closed or reopen closed on the supplied business date. This parameter cannot be present if opnBusDt or busDt are present.First Available Version: 20.1.10
-
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 -
opnBusDt(required):
string(date)
Title:
Business DateIf present, the API will return the guest checks which were opened or reopened on the supplied business date. This parameter cannot be present if clsdBusDt or busDt are present.First Available Version: 20.1.10
-
rvcNum:
integer
Title:
Revenue center numberMaximum Length:10Revenue center number for which the control totals are to be fetched.First Available Version: 20.1.9.7
-
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 : controlDailyTotals
Type:
objectThe response body contains information about the control totals for the specified business date and location.
Show Source
-
busDt(required):
string(date)
Title:
Business DateBusiness Date -
eodStatus(required):
integer
Title:
End of Day StatusEnd of Day status. O = Open, 1 = Closed -
firstTransLcl(required):
string(date-time)
Title:
First Transaction LocalThe date and time of first transaction in this business day in the location's timezone.First Available Version: 20.1.9.6
-
firstTransUTC(required):
string(date-time)
Title:
First Transaction UTCThe UTC date and time of first transaction in this business day -
lastTransLcl(required):
string(date-time)
Title:
Last Transaction LocalThe date and time of last transaction in this business day in the location's timezone.First Available Version: 20.1.9.6
-
lastTransUTC(required):
string(date-time)
Title:
Last Transaction UTCThe UTC date and time of last transaction in this business day -
lastUpdatedLcl(required):
string(date-time)
Title:
Last Updated Date Time LocalThe date and time of the most recent transaction updates or inserts in the cloud in the location's timezone.First Available Version: 20.1.12
-
lastUpdatedUTC(required):
string(date-time)
Title:
Last Updated Date Time UTCThe date and time of the most recent transaction updates or inserts in the cloud as a UTC time.First Available Version: 20.1.12
-
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 Control Totals by RVC
Nested Schema : revenueCenters
Type:
arrayAn array of Control Totals by RVC
Show Source
-
Array of:
object controlTotalsByRVC
The response body contains control totals about a revenue center for the specified location.
Nested Schema : controlTotalsByRVC
Type:
objectThe response body contains control totals about a revenue center for the specified location.
Show Source
-
clsdChkTtl:
number
Title:
Closed Checks TotalThe amount of all closed checks including taxes and service charges. -
numClsdChecks:
integer
Title:
Number of Closed ChecksMaximum Length:16The number of checks closed for the business date -
numNonSlsTrans:
integer
Title:
Number of Non Sale TransactionsMaximum Length:16The number of non-sales transactions that occurred during this business day, including no sales and media transactions. -
numOpnChksAtEOD:
integer
Title:
Number of Open Checks at End of DayMaximum Length:16The number of open checks at end of day -
opnChkTtlAtEOD:
number
Title:
Open Check total at End of DayThe amount of open checks at end of day including taxes, service charges, payments, etc. -
rvcNum(required):
integer
Title:
Revenue Center NumberMaximum Length:10Revenue Center number
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 Control 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","rvcNum":123,"busDt":"2020-10-20"} https://baseurl/bi/v1/orgidentifier/getControlDailyTotals
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": "2019-07-20",
"eodStatus": 1,
"lastUpdatedUTC": "2020-10-20T16:20:45",
"lastUpdatedLcl": "2020-10-20T16:20:45",
"firstTransUTC": "2019-07-20T13:02:00",
"firstTransLcl": "2019-07-20T09:02:00",
"lastTransUTC": "2019-07-20T22:01:26",
"lastTransLcl": "2019-07-20T18:01:26",
"revenueCenters":[{
"rvcNum": 123,
"numClsdChks": 399,
"clsdChkTtl": 14657.34,
"numOpnChksAtEOD": 3,
"opnChkTtlAtEOD": 50.99,
"numNonSlsTrans": 19
}]
}