POST api/commission/plan/{id}/section

This method adds new section to a commission plan

Notes

Commission section within a commission plan holds information on how to pay the commission.

Multiple sections can be created within a commission plan

Error Messages
  • 401/Unauthorized: Access Denied - User does not have the required permissions
  • 400/BadRequest: Validation Error - An error within the api body

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id Id of the commission plan integer

Required

Body Parameters

CommissionSectionPostRequest
NameDescriptionTypeAdditional information
Name Name of the Commission Plan. Required to be unique within the commission plan. string

Required

String length: inclusive between 0 and 60
PaidOnOption Profit = 0, Saleprice = 1, Minutes = 2, BaseLineProfit = 3, LumpSum = 4. Defaults to 0 if not set. integer

None.
Baseline_VoiceTariff Id of the baseline voice tariff. Only valid if PaidOnOption is set to BaselineProfit. integer

None.
Baseline_MobileTariff Id of the baseline mobile tariff. Only valid if PaidOnOption is set to BaselineProfit. integer

None.
Baseline_DataTariff Id of the baseline ISDN Data tariff. Only valid if PaidOnOption is set to BaselineProfit. integer

None.
Baseline_ServiceTariff Id of the baseline Service Charge tariff. Only valid if PaidOnOption is set to BaselineProfit. integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "Name": "sample string 1",
  "PaidOnOption": 1,
  "Baseline_VoiceTariff": 1,
  "Baseline_MobileTariff": 1,
  "Baseline_DataTariff": 1,
  "Baseline_ServiceTariff": 1
}

application/xml, text/xml

Sample: 
<CommissionSectionPostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models.Config">
  <Baseline_DataTariff>1</Baseline_DataTariff>
  <Baseline_MobileTariff>1</Baseline_MobileTariff>
  <Baseline_ServiceTariff>1</Baseline_ServiceTariff>
  <Baseline_VoiceTariff>1</Baseline_VoiceTariff>
  <Name>sample string 1</Name>
  <PaidOnOption>1</PaidOnOption>
</CommissionSectionPostRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CommissionPlanPostResponse
NameDescriptionTypeAdditional information
id integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "id": 1
}

application/xml, text/xml

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