GET api/servicechargetype/{id}
Return details for the specified Service Charge Type.
Error Messages
- 404/Not Found - Service charge type with id x not found - Specified ID not assigned to a Service Charge type
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | ID number of the Service Charge Type | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ServiceChargeTypeView| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | The ID of the Service Charge | integer |
None. |
| Category | The Service Charge Category type | string |
None. |
| FreeMinutesPlanName | The name of the Free Minute Plan assigned to the Service Charge | string |
None. |
| CRMProductId | The CRM Product ID | integer |
None. |
| LastUpdated | date |
None. |
|
| RecurringChargeType | The Service Charge Type | string |
String length: inclusive between 0 and 50 |
| DefaultSalePrice | The default sale price of the Service Charge Type | decimal number |
None. |
| DefaultCost | The default cost of the Service Charge Type. This will be null if the View Default Cost permission is not enabled | decimal number |
None. |
| Rental | Indicates whether the Service Charge Type is a rental | boolean |
None. |
| Nominal | Displays the associated nominal code | string |
String length: inclusive between 0 and 50 |
| Suppress | Indicates whether the customer bill will display the Service Charge if the value is 0 | boolean |
None. |
| DefaultBaseLineCost | The default Baseline cost. This will be null if the View Default Baseline Cost permission is not enabled | decimal number |
None. |
| FrequencyTypeId | The ID that corresponds to the desired frequency to which the Service Charge will be billed. ID 1 = Annual ID 2 = Monthly ID 3 = One off ID 4 = Quarterly | integer |
None. |
| RefundRental | Indicates whether a new charges should have there 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 | Indicates whether the Charge start date is within 120 days of the Service Charge start date | boolean |
None. |
| DaysInAdvance | integer |
None. |
|
| MonthsInAdvance | Indicates the number of monnths in advance the Service Charge will be billed | integer |
None. |
| DefaultDescription | Displays a descriptive name for the Service Charge | string |
String length: inclusive between 0 and 100 |
| TaxCode | Indicates 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 the service starts | boolean |
None. |
| TerminationDays | The amount of days to charge following a termination | integer |
None. |
| WLR | Indicates whether the Service Charge has a WLR charge | boolean |
None. |
| WLRLine | Indicates whether the Service Charge will has a WLR Line Rental charge | boolean |
None. |
| TechFundValue | Indicates the value of the Tech Fund - a fund used to accrue a notional monetary value (pot) within a customer contract | decimal number |
None. |
| Contract | Indicates whether this Service Charge will be part of a contract | boolean |
None. |
| TerminationCharge | The change faced for cancellation of the Service Charge | boolean |
None. |
| ExtraCLIs | Indicates the number of extra CLIs for this Service Charge | integer |
None. |
| FreeMinutesPlan | Indicates the Free minute plan to assign to this Service Charge | integer |
None. |
| Hardware | boolean |
None. |