1. Business Intelligence API Guide
  2. Tasks
  3. Cash Management

Get details

post

/bi/v1/{orgIdentifier}/getCashManagementDetails

Get all the Cash Management details for a specified location and business date.

Request

Path Parameters
Body ()
The request body defines the details of the API request.
Root Schema : requestPayload
Type: object
Request payload
Show Source
  • Title: Application Name
    Maximum Length: 128
    The name of the application which is accessing the API.

    First Available Version: 20.1.10

  • Title: Business Date
    The business date associated with the cash management detail
  • Title: Include
    Maximum Length: 2000
    List of objects to include in response
  • Title: Location Reference
    Maximum Length: 99
    The location reference, this may be a store number or name depending on the organization
  • Title: Search Criteria
    Maximum Length: 2000
    Search criteria to filter results based on field value
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : cmDetailsResponse
Type: object
The response body contains information about the cash management details for the specified location.
Show Source
  • Title: Business Date
    The business date associated with the cash management detail
  • Title: Location Reference
    Maximum Length: 99
    The location reference, this may be a store number or name depending on the organization
  • Revenue Centers
    Title: Revenue Centers
    An array containing the cash management details for each revenue center
Nested Schema : Revenue Centers
Type: array
Title: Revenue Centers
An array containing the cash management details for each revenue center
Show Source
Nested Schema : cmDetailsByRVC
Type: object
The response body contains cash management details information about a revenue center for the specified location.
Show Source
  • Cash Management Details
    Title: Cash Management Details
    An array of cash management details for a revenue center. This attribute will not be returned in the response if value is null
  • Title: Revenue Center number
    Maximum Length: 16
    Revenue Center number. This attribute will not be returned in the response if cmDetails is null
Nested Schema : Cash Management Details
Type: array
Title: Cash Management Details
An array of cash management details for a revenue center. This attribute will not be returned in the response if value is null
Show Source
Nested Schema : cmDetail
Type: object
The response body contains cash management detail about a revenue center for the specified location.
Show Source
  • Title: Cash Management Item Number
    Maximum Length: 16
    Number of the cash management item
  • Title: Deposit Amount
    Amount deposited in the receptacle. This attribute will not be returned in the response if value is 0 or null
  • Title: Guest Check Id
    Maximum Length: 16
    Unique identifier of the guest check. This attribute will not be returned in the response if value is null
  • Title: Notes
    Maximum Length: 16
    Notes associated with the transaction. This attribute will not be returned in the response if value is null
  • Title: Other Amount
    Other amount. This attribute will not be returned in the response if value is 0 or null
  • Title: Overshort Amount
    Amount overshort in the receptacle. This attribute will not be returned in the response if value is 0 or null
  • Title: Receptacle Name
    Maximum Length: 99
    Name of the tender receptacle
  • Title: Receptacle Number
    Maximum Length: 16
    Number of the tender receptacle
  • Title: Receptacle Type
    Maximum Length: 16
    Type 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
  • Title: Reference Information
    Maximum Length: 99
    Reference Information associated with the transaction. This attribute will not be returned in the response if value is null
  • Title: Reason Code Number
    Maximum Length: 16
    Unique identifier of the reason code associated with the trasaction. This attribute will not be returned in the response if value is null
  • Title: Start Amount
    Amount in the receptacle at start of the day
  • Title: Tender Media Number
    Maximum Length: 16
    The number associated with this tender/media. This attribute will not be returned in the response if value is null
  • Title: Transaction Amount
    Amount transacted with the receptacle
  • Title: Transaction Employee Number
    Maximum Length: 16
    Unique number of the employee who has made the transaction
  • Title: Transaction Time in location's timezone
    Time of the transaction in location's timezone.

    First Available Version: 20.1.9.6

  • Title: Transaction Type
    Maximum Length: 16
    Type 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
  • Title: Transaction Time in UTC
    Time of the transaction in UTC format
  • Title: Workstation Number
    Maximum Length: 16
    Unique identifier of the workstation number. This attribute will not be returned in the response if value is null

400 Response

Bad Request
Body ()
Root Schema : exceptionDetailType
Type: object
Error details
Show Source

401 Response

Unauthorized
Body ()
Root Schema : exceptionDetailType
Type: object
Error details
Show Source

403 Response

Service Unavailable
Body ()
Root Schema : exceptionDetailType
Type: object
Error details
Show Source

404 Response

Resource Not Found
Body ()
Root Schema : exceptionDetailType
Type: object
Error details
Show Source

Default Response

Unexpected Error
Body ()
Root Schema : exceptionDetailType
Type: object
Error details
Show Source
Back to Top

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
    }]
  }]
}
Back to Top