Get reason codes

post

/bi/v1/{orgIdentifier}/getReasonCodeDimensions

Gets the reason codes for a specified location.

Request

Path Parameters
Body ()
The request body defines the details of the API request.
Root Schema : locRequestPayload
Type: object
Request payload with location reference
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: Include
    List of objects to include in response
  • Title: Location Reference
    The location reference, this may be a store number or name depending on the organization
  • Title: Search Criteria
    Search criteria to filter results based on field value
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : reasonCodeDimensions
Type: object
The response body contains information about the reason code dimensions for the specified locatio
Show Source
Nested Schema : Reason Codes
Type: array
Title: Reason Codes
An array of reason code dimensions
Show Source
Nested Schema : reasonCode
Type: object
The response body contains information about the reason code for the specified location.
Show Source
  • Title: Master Name
    Maximum Length: 99
    The master reason code name
  • Title: Master Number
    Maximum Length: 16
    Reason code master number. A unique identifier of th reason code master, but not the reason code master object number.
  • Title: Reason code master item object number
    Maximum Length: 16
    Reason 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

  • Title: Name
    Maximum Length: 99
    Reason code name
  • Title: Reason Code Number
    Maximum Length: 16
    Reason code number. A unique identifier of the reason code, but not the reason code object number as defined in Simphony EMC.
  • Title: Reason code object number
    Maximum Length: 16
    Reason code object number as defined in Simphony EMC. Different types of reason codes can share the same object number.

    First available version 20.3

  • Title: The type of reason code
    Maximum Length: 16
    The 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 Reason

    First available version 20.3

400 Response

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

401 Response

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

403 Response

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

404 Response

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

Default Response

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

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