Get Reason Codes
post
/config/sim/v2/setup/getReasonCodes
Gets all Reason Codes
Request
Supported Media Types
- application/json
- multipart/form-data
The input body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, descriptorTypeNum -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order. Allowed fields are hierUnitId, objectNum, descriptorTypeNum and text.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria. Allowed fields are hierUnitId, objectNum, descriptorTypeNum and text.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
A collection of Reason Codes
Root Schema : schema
Type:
Show Source
object-
count:
integer
Number of records returned on this page.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Reason Codes records.
-
limit:
integer
The maximum number of records returned on a pageExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of records in the data setExample:
100
Nested Schema : items
Type:
arrayReason Codes records.
Show Source
-
Array of:
object ReasonCode
Reason Code
Nested Schema : ReasonCode
Type:
objectReason Code
Show Source
-
descriptorTypeNum:
integer
Descriptor type number of the reason code.
Descriptor Type Name Descriptor Type Num Max Count Payment 30 32 Loan 28 32 Pickup 27 32 Service total 29 32 Void/Return/Waste 48 64 Cash Management Adjust Starting Amount: 38 Adjust Count: 39 Adjust Paid-in: 40 Adjust Paid-out: 41 Transfer: 42 Adjust Cash Deposit: 43 Over/Short: 44 Adjust Bank Deposit Reference: 45 No Sale Reason: 49 Example:30 -
hierUnitId:
integer
Unique reference of the hierarchy unit where the reason code is configured.Example:
7 -
objectNum:
integer
Object Number of the Reason Code.Example:
2 -
options:
integer
A string value of 0s & 1s of length 16 indicating the use of Reasons for Voids/Returns and Waste.Example:
1100000000000000 -
optionsExt:
object optionsExt
An object containing the descriptive options list associated with the Void/Return/Waste reasons.
-
text:
object text
Name of the Reason Code.
Nested Schema : optionsExt
Type:
objectAn object containing the descriptive options list associated with the Void/Return/Waste reasons.
Show Source
-
useVoidReturn:
boolean
Flag indicating the use of reason code for voids and return menu items.Example:
false -
useWaste:
boolean
Flag indicating the use of reason code for Waste menu items.Example:
false
Nested Schema : text
Type:
objectMaximum Length:
128Name of the Reason Code.
Example:
{
"1":"Inventory purchase",
"2":"Inventory purchase",
"3":"Inventory purchase"
}