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
Request body
Root Schema : ServiceChargeGroupGetRequestBodyv2
Type:
objectThe input Body model that needs to be given.
Show Source
-
include:
string
Objects included in responseExample:
locations -
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. 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:
10 -
offset:
integer
Starting resource record indexExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort orderExample:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field valueExample:
where equals(active,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Service Charge Group objects of the organization
Root Schema : ServiceChargeGroupGetResponsev2
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 ServiceChargeGroupResponsev2
Model for ServiceChargeGroup Object
Nested Schema : ServiceChargeGroupResponsev2
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
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html
404 Response
404 Requested resource not found