Skip to main content
GET
/
v1
/
sites
/
invoices
Invoices for all sites
curl --request GET \
  --url https://api.voltview.co.uk/v1/sites/invoices \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "siteId": "<string>",
    "invoiceNumber": "<string>",
    "amount": 123,
    "utility": "ELECTRICITY",
    "issueDate": "2023-12-25",
    "dueDate": "2023-12-25",
    "startDate": "2023-12-25",
    "endDate": "2023-12-25",
    "status": "PAID",
    "pdfUrl": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

JWT token obtained from /v1/requestToken endpoint

Response

Invoice information retrieved successfully

​
id
string
required

Invoice identifier

​
siteId
string
required

Site identifier

​
invoiceNumber
string
required

Invoice number

​
amount
number
required

Invoice amount in GBP

​
utility
enum<string>

Utility type

Available options:
ELECTRICITY,
GAS,
WATER
​
issueDate
string<date>

Issue date

​
dueDate
string<date>

Due date

​
startDate
string<date>

Service period start date

​
endDate
string<date>

Service period end date

​
status
enum<string>

Invoice status

Available options:
PAID,
PENDING,
OVERDUE
​
pdfUrl
string<uri>

URL to download invoice PDF