Get Service Charge Groups
post
/config/sim/v2/sales/getServiceChargeGroups
Gets a list of all the Service Charge Group
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 Service Charge Groups.
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 Service Charge Group 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 : items
Type:
arrayArray of Service Charge Group objects of the organization.
Show Source
-
Array of:
object ServiceChargeGroupv2
Model for ServiceChargeGroup Object
Nested Schema : ServiceChargeGroupv2
Type:
objectModel for ServiceChargeGroup Object
Show Source
-
details:
array details
An array of service charges that are part of the service charge group
-
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
1 -
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
name:
object name
Service Charge Group Name
-
objectNum:
integer
Object number of the Service Charge GroupExample:
1
Nested Schema : details
Type:
arrayAn array of service charges that are part of the service charge group
Show Source
Nested Schema : name
Type:
objectService Charge Group Name
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}Nested Schema : items
Type:
Show Source
object-
sequenceNum:
integer
Sequence number of the service charge group detail in the service charge groupExample:
1 -
svcObjNum:
integer
Object number of the service chargeExample:
1