POST api/chargegroup

The purpose of this method is to create a new Charge Group

Error Messages
  • 409/Conflict - Destination must have a value - Specify a Destination

Request Information

URI Parameters

None.

Body Parameters

ChargeGroup
NameDescriptionTypeAdditional information
Destination The Charge Group destination string

String length: inclusive between 0 and 50
Summary Allows the user to select that Destination to be included on a Summary Rate Report showing key destinations boolean

None.
DontReport Indiates whether the charge group is excluded from the Rate Sheet Reports boolean

None.
Hide Indicates whether calls on his charged group are to excluded from customer reports boolean

None.
UseAccess An additional charge for using the Charge Group boolean

None.
TextMessage Indicates that the Charge Group is suitable for SMS messages boolean

None.
Continent The continent of the Charge Group string

None.
AlternativeDescription Additional information or alternative description string

String length: inclusive between 0 and 100
Mobile Indicates whether the Charge Group is Mobile Charge Group boolean

None.
CategoryId The Charge Category ID integer

None.
ParentId The ID of the parent Service Charge integer

None.
FlagIcon Which flag icon to use string

None.
UST_Id Identify the same charge group in any system, regardless of the name or id in the customers system. globally unique identifier

None.

Request Formats

application/json, text/json

Sample: 
{
  "Destination": "sample string 1",
  "Summary": true,
  "DontReport": true,
  "Hide": true,
  "UseAccess": true,
  "TextMessage": true,
  "Continent": "sample string 4",
  "AlternativeDescription": "sample string 5",
  "Mobile": true,
  "CategoryId": 1,
  "ParentId": 1,
  "FlagIcon": "sample string 7",
  "UST_Id": "c7c106c1-bb14-4aa8-9e7f-02d8a787cc3a"
}

application/xml, text/xml

Sample: 
<ChargeGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models.Config">
  <AlternativeDescription>sample string 5</AlternativeDescription>
  <CategoryId>1</CategoryId>
  <Continent>sample string 4</Continent>
  <Destination>sample string 1</Destination>
  <DontReport>true</DontReport>
  <FlagIcon>sample string 7</FlagIcon>
  <Hide>true</Hide>
  <Mobile>true</Mobile>
  <ParentId>1</ParentId>
  <Summary>true</Summary>
  <TextMessage>true</TextMessage>
  <UST_Id>c7c106c1-bb14-4aa8-9e7f-02d8a787cc3a</UST_Id>
  <UseAccess>true</UseAccess>
</ChargeGroup>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ChargeGroupPostResponse
NameDescriptionTypeAdditional information
Id integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1
}

application/xml, text/xml

Sample: 
<ChargeGroupPostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models.Config">
  <Id>1</Id>
</ChargeGroupPostResponse>