PUT api/servicecharge/{id}
This method updates all details for the specified Service Charge Type
Error Messages
- 404/Not Found - Service Charge with id x not found
- 404/Not Found - The CLI not found for the site provided
- 400/bad Request - Invalid FrequencyTypeId
- 404/Not Found - No frequency types found in aBILLity
- 401/Bad Request - Invalid Charge Id
- 404/Not Found - No ChargeIds found in aBILLity
- 401/Bad Request - Invalid Charge Id
- 404/Not Found - The Last Payment can't be set before the First Payment
- 404/Not Found - Service Charge with id x not found
- 404/Not Found - Contract with id x not found
- 404/Not Found - Contract with id x does not belong to the company this Service Charge allocated to
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | The Service Charge Type ID | integer |
Required |
Body Parameters
ServiceChargeModifyName | Description | Type | Additional information |
---|---|---|---|
Description | A unique description for the Service Charge | string |
String length: inclusive between 0 and 100 |
ContractId | The ID of the contract the Service Charge is on | integer |
None. |
CLI | The CLI on this Service Charge | string |
String length: inclusive between 0 and 17 |
ChargeId | The ID of the Service Charge Type | integer |
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. |
SalesPrice | The sales price of the Service Charge | decimal number |
None. |
CostPrice | The cost of the Service Charge | decimal number |
None. |
BaselineCost | The baseline cost of the Service Charge | decimal number |
None. |
Quantity | The number of times this charge valid i.e a Service charge could be valid for 8 quarterly periods | integer |
None. |
FirstPayment | The date the Service Charge is first billed | date |
None. |
LastPayment | The date that the Service Charge is last billed | date |
None. |
SerialNo | The serial number of the Service Charge | string |
String length: inclusive between 0 and 40 |
Rental | Indicates whether the Service Charge Type is a rental | boolean |
None. |
Import | Indiates whether the Service Charge is imported into the system | boolean |
None. |
Suppress | Indicates whether the customer bill will display the Service Charge if the value is 0 | boolean |
None. |
BillNow | Indicates whether the charge is billed in the current month | boolean |
None. |
Notes | Displays any notes for the Service Charge | string |
None. |
BackDatable | Allows a charge for calls or service in a previous Billing Period (restricted to 90 days) | boolean |
None. |
RefundRental | Allows for a refund of any remaining days for that Service Charge | boolean |
None. |
BillRunId | The ID of the Bill Run. | integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "SkipCLIValidation": true, "Description": "sample string 2", "ContractId": 1, "CLI": "sample string 3", "ChargeId": 1, "FrequencyTypeId": 1, "SalesPrice": 1.0, "CostPrice": 1.0, "BaselineCost": 1.0, "Quantity": 1, "FirstPayment": "2025-04-25T14:13:31.385", "LastPayment": "2025-04-25T14:13:31.385", "SerialNo": "sample string 4", "Rental": true, "Import": true, "Suppress": true, "BillNow": true, "Notes": "sample string 8", "BackDatable": true, "RefundRental": true, "BillRunId": 1 }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.