GET api/invoice/ByPeriod/{BillingPeriodID}
This API method returns a list of invoices filtered by billing period.
Billing period IDs can be found by running a GET on /api/common/BillingPeriods Note that contents of the file is returned as a base 64 encoded byte array
Error Messages
- 500/Internal Server Error - Error getting invoice list
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| BillingPeriodID | Billing period ID | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
List of InvoiceView
InvoiceView| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | Invoice ID number | integer |
None. |
| InvoiceFileName | Name of the invoice file | string |
None. |
| ReportFileName | Name of the invoice report | string |
None. |
| InvoiceNumber | Number of the invoice - created upon dispatch | integer |
None. |
| isApproved | boolean |
None. |
|
| SiteID | Billing Site ID number | integer |
None. |
| SiteName | Name of site the invoice is created against | string |
None. |
| BillingPeriodDate | Billing period date | date |
None. |
| BillingMonth | Billing period month | string |
None. |
| ServiceCharges | Cost of the Service Charges | decimal number |
None. |
| Calls | Cost of the calls | decimal number |
None. |
| Total | Sub total | decimal number |
None. |
| VAT | Value Added Tax | decimal number |
None. |
| TotalIncVAT | Subtotal plus VAT | decimal number |
None. |
| InvoiceDate | Date invoice was dispatched | date |
None. |
| Address | Invoice Address | string |
None. |
| Town | Invoice Town | string |
None. |
| County | Invoice County | string |
None. |
| PostCode | Invoice Postcode | string |
None. |