POST api/servicechargetype

This method adds a new Service Charge Type

Note that Rental cannot be true with FrequencyTypeId set to 3 (One-off rental)

Error Messages
  • 400/Bad Request - model.TaxCode - Length must be 10 characters or less
  • 409/Conflict - Invalid Frequency Type - The specified frequency type is not associated with the specified Charge Type
  • 409/Conflict - This Service Charge Type already exists - Specify a new Service Charge Type
  • 409/Conflict - Invalid Free Minutes plan Id - The specified ID is not assigned to a Free Minute Plan
  • 409/Conflict - Invalid Free Minutes plan Id - Invalid Service Type Category Id

Request Information

URI Parameters

None.

Body Parameters

ServiceChargeTypePostRequest
NameDescriptionTypeAdditional information
RecurringChargeType The type of Recurring Charge string

Required

String length: inclusive between 0 and 50
FrequencyTypeId Specify the ID that corresponds to the desired frequency to which the Service Charge will be billed. integer

Required
CategoryId ID of the category integer

None.
LastUpdated The date the Service Chagre Type was date

None.
DefaultSalePrice Specify the default sale price of the Service Charge Type decimal number

None.
DefaultCost Specify the default cost of the Service Charge Type. This can only be set when the View Default Cost permission is enabled decimal number

None.
Rental Specify whether the Service Charge Type is a rental boolean

None.
Nominal Specify the associated nominal code string

String length: inclusive between 0 and 50
Suppress Specify whether the customer bill will display the Service Charge if the value is 0 boolean

None.
DefaultBaseLineCost Specify the default Baseline cost. This can only be set when the Default Baseline Cost Permission is enabled decimal number

None.
RefundRental Specify whether a new charge should have their refund rental flag set boolean

None.
ChargeOutstanding This is used to indicate how new charges created should have there Charge Outstanding rental flag set boolean

None.
BackDatable Specify whether the Charge start date is within 120 days of the Service Charge start date boolean

None.
DaysInAdvance integer

None.
MonthsInAdvance Specify the number of monnths in advance the Service Charge will be billed integer

None.
DefaultDescription Specify a descriptive name for the Service Charge string

String length: inclusive between 0 and 100
TaxCode Specify the Tax to which the Service Charge falls under string

String length: inclusive between 0 and 10
Transfer If you flag a charge as a transfer, this charge will signify when service starts boolean

None.
TerminationDays The amount of days to charge following a termination integer

None.
WLR Specify whether the Service Charge Type will have a WLR charge boolean

None.
WLRLine Specify whether the Service Charge Type will have a WLR Line Rental charge boolean

None.
TechFundValue Specify the value of the Tech Fund - a fund used to accrue a notional monetary value (pot) within a customer contract decimal number

None.
Contract Specify whether this Service Charge will be part of a contract boolean

None.
TerminationCharge Any termination charges to pay if the charge is terminated boolean

None.
ExtraCLIs Specify the number of extra CLIs for this Service Charge integer

None.
FreeMinutesPlan Specify the Free Minute Plan to assign to this Service Charge integer

None.
Hardware Indicates if any hardware is assigned to the Service Charge boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "RecurringChargeType": "sample string 1",
  "FrequencyTypeId": 1,
  "CategoryId": 1,
  "LastUpdated": "2025-04-25T02:03:31.333",
  "DefaultSalePrice": 1.0,
  "DefaultCost": 1.0,
  "Rental": true,
  "Nominal": "sample string 2",
  "Suppress": true,
  "DefaultBaseLineCost": 1.0,
  "RefundRental": true,
  "ChargeOutstanding": true,
  "BackDatable": true,
  "DaysInAdvance": 1,
  "MonthsInAdvance": 1,
  "DefaultDescription": "sample string 3",
  "TaxCode": "sample string 4",
  "Transfer": true,
  "TerminationDays": 1,
  "WLR": true,
  "WLRLine": true,
  "TechFundValue": 1.0,
  "Contract": true,
  "TerminationCharge": true,
  "ExtraCLIs": 1,
  "FreeMinutesPlan": 1,
  "Hardware": true
}

application/xml, text/xml

Sample: 
<ServiceChargeTypePostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.WebAPI.Models.Company">
  <BackDatable>true</BackDatable>
  <ChargeOutstanding>true</ChargeOutstanding>
  <Contract>true</Contract>
  <DaysInAdvance>1</DaysInAdvance>
  <DefaultBaseLineCost>1</DefaultBaseLineCost>
  <DefaultCost>1</DefaultCost>
  <DefaultDescription>sample string 3</DefaultDescription>
  <DefaultSalePrice>1</DefaultSalePrice>
  <ExtraCLIs>1</ExtraCLIs>
  <FreeMinutesPlan>1</FreeMinutesPlan>
  <FrequencyTypeId>1</FrequencyTypeId>
  <Hardware>true</Hardware>
  <MonthsInAdvance>1</MonthsInAdvance>
  <Nominal>sample string 2</Nominal>
  <RecurringChargeType>sample string 1</RecurringChargeType>
  <RefundRental>true</RefundRental>
  <Rental>true</Rental>
  <Suppress>true</Suppress>
  <TaxCode>sample string 4</TaxCode>
  <TechFundValue>1</TechFundValue>
  <TerminationCharge>true</TerminationCharge>
  <TerminationDays>1</TerminationDays>
  <Transfer>true</Transfer>
  <WLR>true</WLR>
  <WLRLine>true</WLRLine>
  <CategoryId>1</CategoryId>
  <LastUpdated>2025-04-25T02:03:31.333</LastUpdated>
</ServiceChargeTypePostRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ServiceChargePostResponse
NameDescriptionTypeAdditional information
Id integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1
}

application/xml, text/xml

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