GET api/site/{id}/servicecharge/cli/{cli}
This method returns a list of Service Charges for the specified site and CLI.
Error Messages
- 404/NotFound: Site with id = X not found - Specified ID is not linked to a site
- 401/Unauthorized: CompanySitePermission - user does not have required permissions
- 404/NotFound: CLI = X not found - Specified ID is not assigned to a CLI
- 404/NotFound: CLI = X not found for SiteId = X - Specified CLI ID is not associated with specified Site ID
- 404/NotFound: No Service Charges found for site with id = X - No Service Charges were found on the specified ID. Try another.
- 404/NotFound: No Service Charges found for the given site Id and cli - No service Service Charges found on the specified CLI and Site IDs. Try another.
- 404/NotFound: No Service Charges found
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | The unique identifier for the Site being queried. | integer |
Required |
| cli | The unique identifier for the CLI being queried | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of ServiceChargeView| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | The ID of the Service Charge | integer |
None. |
| SiteId | The Site ID the Service Charge belongs to | integer |
None. |
| LastUpdated | date |
None. |
|
| ServiceChargeType | The type of Service Charge and its default values | ServiceChargeTypeInfo |
None. |
| ActualValues | The Actual value of the Service Charges. These may be different to the Default Charges | ServiceChargeActualValues |
None. |
| 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 | Indicates 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 wtheter the charge is billed in the current month | boolean |
None. |
| Notes | Displays any notes for the Service Charge | string |
None. |
| BackDatable | indicates whether this Service chages is back dateable. i.e A charge is backdatable is charges in June can be billed in August | boolean |
None. |
| RefundRental | indicates whether a user can be refunnded upon early cancellation of the Service Charge | boolean |
None. |
| BillRunId | The ID of the Bill Run. If the Service Charge has no bill run assigned, the site methods can be used to get bill runs at a site-level. | integer |
None. |