Get employee daily totals
post
/bi/v1/{orgIdentifier}/getEmployeeDailyTotals
Get the Employee 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 : empDailyTotals
Type:
objectThe response body contains information about the employee daily totals for the specified 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 Employee Daily Totals by Revenue Centers
Nested Schema : revenueCenters
Type:
arrayAn array of Employee Daily Totals by Revenue Centers
Show Source
-
Array of:
object empDailyTotalsByRVC
The response body contains employee daily totals of a revenue center for the specified location.
Nested Schema : empDailyTotalsByRVC
Type:
objectThe response body contains employee daily totals of a revenue center for the specified location.
Show Source
-
employees:
array employees
An array of daily totals of employees for a revenue center. This attribute will not be returned in the response if value is null
-
rvcNum:
integer
Title:
Revenue Center NumberMaximum Length:16Revenue Center number. This attribute will not be returned in the response if employees is null
Nested Schema : employees
Type:
arrayAn array of daily totals of employees for a revenue center. This attribute will not be returned in the response if value is null
Show Source
-
Array of:
object empDailyTotal
The response body contains daily totals of an employee for a revenue center for the specified location.
Nested Schema : empDailyTotal
Type:
objectThe response body contains daily totals of an employee for a revenue center for the specified location.
Show Source
-
carryoverCnt:
integer
Title:
Carry Over CountMaximum Length:16Number of items that were carried over by the employee. 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 by the employee. 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 by the employee. This attribute will not be returned in the response if value is 0 or null -
chkClsdTtl:
number
Title:
Check Closed TotalTotal of checks that were were closed in by the employee. This attribute will not be returned in the response if value is 0 or null -
chkCnt:
integer
Title:
Check CountMaximum Length:16Count of checks served by the employee. This attribute will not be returned in the response if value is 0 or null -
chkOpnCnt:
integer
Title:
Check Open CountMaximum Length:16Number of checks that were were rung in by the employee which remain in open state. This attribute will not be returned in the response if value is 0 or null -
chkOpnTtl:
number
Title:
Check Open TotalTotal of checks that were were rung in by the employee which remain in open state. This attribute will not be returned in the response if value is 0 or null -
chkXferInTtl:
number
Title:
Check Transfer In TotalTotal of checks that were transferred in by the employee. 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 by the employee. 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 by the employee. 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 by the employee. 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 by the employee. This attribute will not be returned in the response if value is 0 or null -
chrgRcptsTtl:
number
Title:
Charged Receipts TotalTotal of receipts charged by the employee. This attribute will not be returned in the response if value is 0 or null -
chrgTipsTtl:
number
Title:
Charged Tips TotalTotal of tips charged by the employee. This attribute will not be returned in the response if value is 0 or null -
credTtl:
number
Title:
Credit TotalTax Credit Total by the employee. This attribute will not be returned in the response if value is 0 or null -
dineTimeInMins:
number
Title:
Dine Time in minutesMaximum Length:16Dining time in minutes served by the employee. This attribute will not be returned in the response if value is 0 or null -
empNum:
integer
Title:
Employee NumberMaximum Length:16Employee Number -
errCorCnt:
integer
Title:
Error Correct CountMaximum Length:16Number of items which were error corrected by the employee. 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 by the employee. This attribute will not be returned in the response if value is 0 or null -
grossRcptsTtl:
number
Title:
Gross Receipt TotalTotal of gross receipts made by the employee. This attribute will not be returned in the response if value is 0 or null -
gstCnt:
integer
Title:
Guest CountMaximum Length:16Count of guests served by the employee. This attribute will not be returned in the response if value is 0 or null -
indirTipsPdTtl:
number
Title:
Indirect Tips Paid TotalTotal of indirect tips paid to the employee. This attribute will not be returned in the response if value is 0 or null -
itmDscTtl:
number
Title:
Item Discount TotalItem discount Total by the employee. This attribute will not be returned in the response if value is 0 or null -
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 TotalNet Sales Total by the employee -
nonRevSvcTtl:
number
Title:
Non Revenue Service Charge TotalNon-revenue service charge, and non-revenue menu item total. This attribute will not be returned in the response if value is 0 or null -
noSalesCnt:
integer
Title:
No Sale Transaction CountMaximum Length:16Number of no sale transactions by the employee. This attribute will not be returned in the response if value is 0 or null -
rndTtl:
number
Title:
Round TotalCurrency Rounding Total by the employee. This attribute will not be returned in the response if value is 0 or null -
rtnCnt:
integer
Title:
Return CountMaximum Length:16Return Count by the employee. This attribute will not be returned in the response if value is 0 or null -
rtnTtl:
number
Title:
Return TotalReturn Total by the employee. This attribute will not be returned in the response if value is 0 or null -
subDscTtl:
number
Title:
Sub Discount TotalSub total Discount Total by the employee. This attribute will not be returned in the response if value is 0 or null -
svcTtl:
number
Title:
Service Charge TotalService Charge Total by the employee. This attribute will not be returned in the response if value is 0 or null -
taxTtl:
number
Title:
Tax TotalTotal of taxes attributed to the employee. This attribute will not be returned in the response if value is 0 or null -
tblTurnCnt:
integer
Title:
Table Turn CountMaximum Length:16Table turn count by the employee. This attribute will not be returned in the response if value is 0 or null -
tipsDclrdTtl:
number
Title:
Tips Declared TotalTotal of tips declared by the employee. This attribute will not be returned in the response if value is 0 or null -
tipsPdTtl:
number
Title:
Tips Paid TotalTotal of tips paid to the employee. This attribute will not be returned in the response if value is 0 or null -
tipsSvcTtl:
number
Title:
Service Charge Tips TotalTotal of service charge tips by the employee. This attribute will not be returned in the response if value is 0 or null -
tipTtl:
number
Title:
Tip TotalTotal of tips for the employee. 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 by the employee. 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 by the employee. This attribute will not be returned in the response if value is 0 or null -
vdCnt:
integer
Title:
Void CountMaximum Length:16Number of items voided by the employee. This attribute will not be returned in the response if value is 0 or null -
vdTtl:
number
Title:
Void TotalTotal of items voided by the employee. 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 by employees 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/getEmployeeDailyTotals
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,
"employees" [{
"empNum": 12345,
"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,
"tblTurnCnt":123,
"dineTimeInMins": 34,
"chkCnt": 123,
"gstCnt": 123,
"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,
"chkOpnCnt": 123,
"chkClsdTtl": 1234.56,
"chkClsdCnt": 123,
"chkXfrInTtl": 1234.56,
"chkXferInCnt": 123,
"chkXferOutTtl": 1234.56,
"chkXferOutCnt": 123,
"chkXferTtl": 1234.56,
"chkClsdCnt": 123,
"noSlsCnt": 123,
"grossRcptsTtl": 1234.56,
"chrgRcptsTtl": 1234.56,
"chrgTipsTtl": 1234.56,
"indirTipsPdTtl": 1234.56,
"tipsDclrdTtl": 1234.56,
"tipsPdTtl":1234.56,
"tipTtl": 1234.56,
"taxTtl": 1234.56,
"tipsSvcTtl": 1234.56
}]
}]
}