Get Sales Itemizers
post
/config/sim/v2/setup/getSalesItemizers
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, name
-
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.Example:
hierUnitId:asc
-
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
A collection of Sales Itemizers.
Root Schema : schema
Type:
Show Source
object
-
count:
integer
Current response record count.Example:
9
-
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true
-
items:
array items
Array of Sales Itemizer objects of the organization.
-
limit:
integer
Server page sizeExample:
10
-
offset:
integer
Starting resource record indexExample:
0
-
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : SalesItemizerv2
Type:
Show Source
object
-
hierUnitId:
integer
Unique reference of the hierarchy unit of the propertyExample:
1
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1
-
name:
object name
A group of string objects representing the name of the Sales Itemizers in configured languages
-
salesItmzrIndex:
integer
Sequence number of the Sales Itemizer. Acceptable values are 1-16, including 1 and 16Example:
1
Nested Schema : name
Type:
object
A group of string objects representing the name of the Sales Itemizers in configured languages
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}