Get cash management item
post
/bi/v1/{orgIdentifier}/getCashManagementItemDimensions
Gets the cash management items for a specified location.
Request
Path Parameters
-
orgIdentifier(required): string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : locRequestPayload
Type:
object
Request payload with location reference
Show Source
-
applicationName:
string
Title:
Application Name
Maximum Length:128
The name of the application which is accessing the API.First Available Version: 20.1.10
-
include:
string
Title:
Include
List of objects to include in response -
locRef(required):
string
Title:
Location Reference
The location reference, this may be a store number or name depending on the organization -
searchCriteria:
string
Title:
Search Criteria
Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : cashMgmtItemDimensions
Type:
object
The response body contains information about the cash management item dimensions for the specified location
Show Source
-
cashMgmtItems(required):
array Cash Management Items
Title:
Cash Management Items
An array of cash management item dimensions -
locRef(required):
string
Title:
Location Reference
Maximum Length:99
The location reference, this may be a store number or name depending on the organization
Nested Schema : Cash Management Items
Type:
array
Title:
Cash Management Items
An array of cash management item dimensions
Show Source
-
Array of:
object cashMgmtItem
The response body contains information about the cash management item for the specified location.
Nested Schema : cashMgmtItem
Type:
object
The response body contains information about the cash management item for the specified location.
Show Source
-
mstrName:
string
Title:
Master Name
Maximum Length:99
The master cash management item name -
mstrNum:
integer
Title:
Master Number
Maximum Length:16
The master cash management item number -
name(required):
string
Title:
Name
Maximum Length:99
cash management item Name -
num(required):
integer
Title:
Number
Maximum Length:16
cash management item number -
recordNum(required):
integer
Title:
Record Number
Maximum Length:16
The unique number of the cash management item record. This attribute will not be returned in the response if value is null -
type(required):
integer
Title:
Type
Cash management item Type
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
detail:
string
Title:
Error description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle error code
Oracle error code -
status:
integer
Title:
Status
HTTP response code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
detail:
string
Title:
Error description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle error code
Oracle error code -
status:
integer
Title:
Status
HTTP response code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
detail:
string
Title:
Error description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle error code
Oracle error code -
status:
integer
Title:
Status
HTTP response code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
detail:
string
Title:
Error description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle error code
Oracle error code -
status:
integer
Title:
Status
HTTP response code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
detail:
string
Title:
Error description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle error code
Oracle error code -
status:
integer
Title:
Status
HTTP response code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
Examples
The following example shows how to get the cash management item dimensions for a specified location 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"} https://baseurl/bi/v1/orgidentifier/getCashManagementItemDimensions
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", "cashMgmtItems":[{ "num": 19, "name": "Cash", "mstrNum": 19, "mstrName": "Cash", "type": 1, "recordNum": 123 }] }