Get reason codes
post
/bi/v1/{orgIdentifier}/getReasonCodeDimensions
Gets the reason codes 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 : reasonCodeDimensions
Type:
objectThe response body contains information about the reason code dimensions for the specified locatio
Show Source
-
locRef(required):
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
reasonCodes(required):
array Reason Codes
Title:
Reason CodesAn array of reason code dimensions
Nested Schema : Reason Codes
Type:
arrayTitle:
Reason CodesAn array of reason code dimensions
Show Source
-
Array of:
object reasonCode
The response body contains information about the reason code for the specified location.
Nested Schema : reasonCode
Type:
objectThe response body contains information about the reason code for the specified location.
Show Source
-
mstrName:
string
Title:
Master NameMaximum Length:99The master reason code name -
mstrNum:
integer
Title:
Master NumberMaximum Length:16Reason code master number. A unique identifier of th reason code master, but not the reason code master object number. -
mstrPosRef:
integer
Title:
Reason code master item object numberMaximum Length:16Reason code master item object number as defined in Simphony EMC. This attribute is optional and is not returned by default, regardless of whether it is null or not.First available version 20.3
-
name(required):
string
Title:
NameMaximum Length:99Reason code name -
num(required):
integer
Title:
Reason Code NumberMaximum Length:16Reason code number. A unique identifier of the reason code, but not the reason code object number as defined in Simphony EMC. -
posRef(required):
integer
Title:
Reason code object numberMaximum Length:16Reason code object number as defined in Simphony EMC. Different types of reason codes can share the same object number.First available version 20.3
-
type(required):
integer
Title:
The type of reason codeMaximum Length:16The type of reason code.
Possible values include:
27 = Pickup Reason
28 = Loan Reason
38 = Cash Management - Adjust Starting Amount Reason
39 = Cash Management - Adjust Count Reason
40 = Cash Management - Paid-In Reason
41 = Cash Management - Paid-Out Reason
42 = Cash Management - Transfer Reason
43 = Cash Management - Adjust Cash Deposit Reason
44 = Cash Management - Over/Short Reason
45 = Cash Management - Adjust Bank Deposit Reference Reason
48 = Void or Return or Waste Reason
49 = No Sale Reason
50 = Transaction Cancel ReasonFirst available version 20.3
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 get the reason code 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/getReasonCodeDimensions
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",
"reasonCodes":[{
"mstrPosRef": 123,
"mstrNum": 152,
"mstrName": "Manager Adjust",
"name": "Manager Adjust",
"num": 152,
"posRef": 123,
"type": 27
}]
}