Get details
post
/bi/v1/{orgIdentifier}/getCashManagementDetails
Get all the Cash Management details 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 : cmDetailsResponse
Type:
objectThe response body contains information about the cash management details for the specified location.
Show Source
-
busDt(required):
string(date)
Title:
Business DateThe business date associated with the cash management detail -
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 Revenue Centers
Title:
Revenue CentersAn array containing the cash management details for each revenue center
Nested Schema : Revenue Centers
Type:
arrayTitle:
Revenue CentersAn array containing the cash management details for each revenue center
Show Source
-
Array of:
object cmDetailsByRVC
The response body contains cash management details information about a revenue center for the specified location.
Nested Schema : cmDetailsByRVC
Type:
objectThe response body contains cash management details information about a revenue center for the specified location.
Show Source
-
cmDetails(required):
array Cash Management Details
Title:
Cash Management DetailsAn array of cash management details for a revenue center. This attribute will not be returned in the response if value is null -
rvcNum(required):
integer
Title:
Revenue Center numberMaximum Length:10Revenue Center number. This attribute will not be returned in the response if cmDetails is null
Nested Schema : Cash Management Details
Type:
arrayTitle:
Cash Management DetailsAn array of cash management details for a revenue center. This attribute will not be returned in the response if value is null
Show Source
-
Array of:
object cmDetail
The response body contains cash management detail about a revenue center for the specified location.
Nested Schema : cmDetail
Type:
objectThe response body contains cash management detail about a revenue center for the specified location.
Show Source
-
actBusDate(required):
string(date)
Title:
The actual business dateThe actual business date of the cash management transaction. This attribute will not be returned in the response if value is nullFirst available version 20.1.16
-
balanceAmt(required):
number
Title:
Balance amountBalance amount. This attribute will not be returned in the response if value is 0 or nullFirst available version 20.1.15
-
cmItemNum(required):
integer
Title:
Cash Management Item NumberMaximum Length:16Number of the cash management item -
depAmt(required):
number
Title:
Deposit AmountAmount deposited in the receptacle. This attribute will not be returned in the response if value is 0 or null -
guestCheckId(required):
integer
Title:
Guest Check IdMaximum Length:16Unique identifier of the guest check. This attribute will not be returned in the response if value is null -
notes(required):
string
Title:
NotesMaximum Length:16Notes associated with the transaction. This attribute will not be returned in the response if value is null -
othrAmt(required):
number
Title:
Other AmountOther amount. This attribute will not be returned in the response if value is 0 or null -
overShortAmt(required):
number
Title:
Overshort AmountAmount overshort in the receptacle. This attribute will not be returned in the response if value is 0 or null -
receptacleName(required):
string
Title:
Receptacle NameMaximum Length:99Name of the tender receptacle -
receptacleNum(required):
integer
Title:
Receptacle NumberMaximum Length:16Number of the tender receptacle -
receptacleType(required):
integer
Title:
Receptacle TypeMaximum Length:16Type of tender receptacle. The following are the different receptacle types that could be returned:
0 = Till
1 = Safe
2 = Deposit
3 = None
4 = PC
5 = Server Bank
6 = Petty Cash
7 = Change Order -
refInfo(required):
string
Title:
Reference InformationMaximum Length:99Reference Information associated with the transaction. This attribute will not be returned in the response if value is null -
rsnCodeNum(required):
integer
Title:
Reason Code NumberMaximum Length:16Unique identifier of the reason code associated with the trasaction. This attribute will not be returned in the response if value is null -
sessionNum(required):
integer
Title:
The cash management session POS reference numberThe cash management session POS reference number. This attribute will not be returned in the response if value is 0 or nullFirst available version 20.1.16
-
startAmt(required):
number
Title:
Start AmountAmount in the receptacle at start of the day -
targetReceptacleNum(required):
integer
Title:
The target receptacle POS reference numberThe target receptacle POS reference number. This attribute will not be returned in the response if value is 0 or nullFirst available version 20.1.16
-
targetSessionNum(required):
integer
Title:
The target session POS reference numberThe target session POS reference number. This attribute will not be returned in the response if value is 0 or nullFirst available version 20.1.16
-
tmedNum(required):
integer
Title:
Tender Media NumberMaximum Length:16The number associated with this tender/media. This attribute will not be returned in the response if value is null -
transAmt(required):
number
Title:
Transaction AmountAmount transacted with the receptacle -
transEmpNum(required):
integer
Title:
Transaction Employee NumberMaximum Length:16Unique number of the employee who has made the transaction -
transLcl(required):
string(date-time)
Title:
Transaction Time in location's timezoneTime of the transaction in location's timezone.First Available Version: 20.1.9.6
-
transType(required):
integer
Title:
Transaction TypeMaximum Length:16Type of transaction.The following are the different transaction types that could be returned:
0 = Open
1 = Reopen
2 = Assign Employee
3 = Unassign Employee
4 = Cash Drawer Assign
5 = Cash Drawer Unassign
6 = Close
7 = Transfer
8 = Paid-In
9 = Paid-Out
10 = Cash Pull
11 = Count
12 = Adjust Count
13 = Deposit
14 = Adjust Starting Amount
15 = Pos Transaction
16 = Reconcile
17 = Adjust Cash Management Total
18 = Deposit Detail
19 = Deposit Transfer
20 = Configuration
21 = Till Count Transfer
22 = Verify Count
23 = Transfer Opened Till Cash Pull Into Deposit
24 = Change Order Request
25 = Adjust Cash Deposit Amount
26 = Funds In
27 = Funds Out
28 = Adjust Count Sheet
29 = Saved Count
30 = Cash Pull Notification
31 = Cash Pull Notification ByPass
32 = Count Threshhold Notification
33 = Adjust Deposit Reference
34 = Save Change Order
35 = Cancel Change Order
36 = Reconcile Change Order
37 = Submit Change Order
38 = Consolidate Server Bank
39 = No Sale
40 = Receptacle Starting Amount -
transUTC(required):
string(date-time)
Title:
Transaction Time in UTCTime of the transaction in UTC format -
wsNum(required):
integer
Title:
Workstation NumberMaximum Length:16Unique identifier of the workstation number. This attribute will not be returned in the response if value is null
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
objectException 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:
objectException 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:
objectException 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:
objectException 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:
objectException 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 Cash Management details for a specified location and 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/getCashManagementDetails
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-10-20",
"revenueCenters":[{
"rvcNum": 1372,
"cmDetails":[{
"cmItemNum": 1372,
"receptacleType": 1,
"receptacleName": "Safe",
"receptacleNum": 123,
"startAmt": 123.45,
"transAmt": 123.45,
"overShortAmt": 123.45,
"depAmt": 1234.56
"transUTC": "2020-10-20T15:59:59",
"transLcl": "2020-10-20T11:59:59",
"transEmpNum":1234,
"refInfo": "Manually Entered Text",
"transType": 1,
"rsnCodeNum": 123,
"wsNum": 123,
"notes": "Notes",
"othrAmt": 123.45,
"guestCheckId": 345667,
"tmedNum": 1234,
"balanceAmt": 55.55,
"actBusDate": "2020-10-20",
"sessionNum": 12345,
"targetReceptacleNum": 12345,
"targetSessionNum": 12345
}]
}]
}