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:
objectRequest payload with location reference
Show Source
-
applicationName:
string
Title:
Application NameMaximum Length:128The name of the application which is accessing the API.First Available Version: 20.1.10
-
include:
string
Title:
IncludeList of objects to include in response -
locRef(required):
string
Title:
Location ReferenceThe location reference, this may be a store number or name depending on the organization -
searchCriteria:
string
Title:
Search CriteriaSearch criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : cashMgmtItemDimensions
Type:
objectThe 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 ItemsAn array of cash management item dimensions -
locRef(required):
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization
Nested Schema : Cash Management Items
Type:
arrayTitle:
Cash Management ItemsAn 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:
objectThe response body contains information about the cash management item for the specified location.
Show Source
-
catGrpHierName1(required):
string
Title:
Category Group Hierarchy #1 assigned to the master itemMaximum Length:40Category Group Hierarchy #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpHierName2(required):
string
Title:
Category Group Hierarchy #2 assigned to the master itemMaximum Length:40Category Group Hierarchy #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpHierName3(required):
string
Title:
Category Group Hierarchy #3 assigned to the master itemMaximum Length:40Category Group Hierarchy #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpHierName4(required):
string
Title:
Category Group Hierarchy #4 assigned to the master itemMaximum Length:40Category Group Hierarchy #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpName1(required):
string
Title:
Category Group #1 assigned to the master itemMaximum Length:20Category Group #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpName2(required):
string
Title:
Category Group #2 assigned to the master itemMaximum Length:20Category Group #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpName3(required):
string
Title:
Category Group #3 assigned to the master itemMaximum Length:20Category Group #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpName4(required):
string
Title:
Category Group #4 assigned to the master itemMaximum Length:20Category Group #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
mstrName:
string
Title:
Master NameMaximum Length:99The master cash management item name -
mstrNum:
integer
Title:
Master NumberMaximum Length:16The master cash management item number -
name(required):
string
Title:
NameMaximum Length:99cash management item Name -
num(required):
integer
Title:
NumberMaximum Length:16cash management item number -
recordNum(required):
integer
Title:
Record NumberMaximum Length:16The 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:
TypeCash management item Type
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 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",
"catGrpHierName1": "Category Hierarchy 1",
"catGrpName1": "Category Group 1",
"catGrpHierName2": "Category Hierarchy 2",
"catGrpName2": "Category Group 2",
"catGrpHierName3": "Category Hierarchy 3",
"catGrpName3": "Category Group 3",
"catGrpHierName4": "Category Hierarchy 4",
"catGrpName4": "Category Group 4",
"type": 1,
"recordNum": 123
}]
}