GET api/site/{id}/invoiceinformation
This method returns the invoice information details for the specified site
Error Messages
- 404/NotFound: Site with id = X not found - Specified ID not assigned to a site
- 404/NotFound: No Billing information found for site with id = x - This happens when data is deleted from the database
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | The unique identifier for the Site being queried. | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
InvoiceInformationView| Name | Description | Type | Additional information |
|---|---|---|---|
| SiteId | The site ID | integer |
None. |
| ReportDeliveryName | How the report will be delivered | string |
None. |
| InvoiceDeliveryName | How the invoice will be delivered | string |
None. |
| ReportProfileName | The report profile that is sent to the customer | string |
None. |
| TaxCodeName | The taxcode used by this invoice | string |
None. |
| BillRunName | The bill run name | string |
None. |
| DataDeliveryName | The delivery method of the CDR and Service Charge export files | string |
None. |
| ReportDelivery | The ID of the Report Delivery method | integer |
None. |
| InvoiceDelivery | The ID of the Invoice Delivery method | integer |
None. |
| MinimumItemisation | The mimumum call price that will appear on the report | decimal number |
None. |
| BillRun | The ID of the Bill Run | integer |
None. |
| ReportProfile | The ID of the report profile | integer |
None. |
| InvoiceText | Any text to add to the invoice | string |
String length: inclusive between 0 and 200 |
| TaxCode | The tax code ID | integer |
None. |
| DataDelivery | The delivery method ID for CDR and Service Charge Export files | integer |
None. |
| DataFileLocation | The location of the CDR and Service Charge Export files | string |
String length: inclusive between 0 and 255 |
| CDRFormat | The format of the CDR export file | string |
String length: inclusive between 0 and 32 |
| ServiceFormat | The format of the Service Charge export file | string |
String length: inclusive between 0 and 32 |
| CreateSingleDataFile | Indicates whether the file is a single data file | boolean |
None. |
| ZipDataFile | Indicates whether the file is zipped | boolean |
None. |
| DataFileIsPasswordEnabled | If the file is zipped, this indicates whether the file is password protected | boolean |
None. |