API Documentation
Authentication
User
Sites
- GETList all sites
- POSTCreate a new site
- POSTAddress lookup
- GETPeak demand for all sites
- GETAnnual consumption and emissions for all sites
- GETAnnual spend and savings for all sites
- GETTariffs for all sites
- GETInvoices for all sites
- GETReports for all sites
- GETEnergy cost data for all sites
- GETEnergy intensity for all sites
- GETStatistics for all sites
- GETEnergy recommendations
Meters
Emissions
Specific Site
- GETAnnual consumption and emissions for a specific site
- GETAnnual spend and savings for a specific site
- GETPeak demand for a specific site
- GETTariffs for a specific site
- GETReports for a specific site
- GETStatistics for a specific site
- GETEnergy intensity for a specific site
- GETEnergy cost data for a specific site
Energy Consumption
Supplier Integration
- GETList available suppliers
- GETGet all accounts
- POSTCreate an Account
- GETGet sites and meters for a business
- GETGet Account Details
- PUTUpdate Account Details
- DELDelete an Account
- PUTUpload Document to Account
- GETGet Sites Associated with an Account
- GETGet Supplier Accounts for a Business
- GETGet Accounts Associated with a Business
- GETGet Signed Document URL
- POSTRequest utility integration
LOA Management
curl --request PUT \
--url https://api.voltview.co.uk/v1/suppliers/accounts/{id}/documents/upload \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file' \
--form 'documentId=<string>' \
--form 'documentType=<string>'[
{
"id": "<string>",
"accountId": "<string>",
"referenceId": "<string>",
"invoices": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>",
"mpanMprn": "<string>",
"supplyType": "electricity",
"supplierName": "<string>",
"supplierAccountNumber": "<string>",
"customerName": "<string>",
"invoiceNumber": "<string>",
"invoiceDate": "2023-12-25",
"dueDate": "2023-12-25",
"chargeStartDate": "2023-12-25",
"chargeEndDate": "2023-12-25",
"meterSerialNumber": "<string>",
"siteAddress": "<string>",
"paymentMethod": "<string>",
"standingCharge": 123,
"standingChargeType": "<string>",
"cclRate": 123,
"vatRate": 123,
"readFromDate": "2023-12-25",
"readFromType": "actual",
"readToDate": "2023-12-25",
"readToType": "actual",
"consumption": 123,
"dayConsumption": 123,
"nightConsumption": 123,
"unitRate": 123,
"dayUnitRate": 123,
"nightUnitRate": 123,
"correctionFactor": 123,
"calorificValue": 123,
"totalUnitCharge": 123,
"totalStandingCharge": 123,
"capacityCharge": 123,
"amountDueNetOfVat": 123,
"vat": 123,
"totalAmount": 123,
"status": "pending",
"validationStatus": "pending"
}
],
"contracts": [
{
"id": "<string>",
"filePath": "<string>",
"supplierName": "<string>",
"supplierAddress": "<string>",
"supplierCode": "<string>",
"supplierAccountNumber": "<string>",
"customerName": "<string>",
"contractNumber": "<string>",
"contractStartDate": "2023-12-25",
"contractEndDate": "2023-12-25",
"isFixedContract": true,
"isMarketRates": true,
"isMicroBusiness": true,
"paymentMethod": "<string>",
"contractTermMonths": 123,
"cclRate": 123,
"vatRate": 123,
"supplyPoints": [
{
"mpanMprn": "<string>",
"supplyType": "electricity",
"meterSerialNumber": "<string>",
"siteName": "<string>",
"siteAddress": "<string>",
"tariffName": "<string>",
"isNonContractedRate": true,
"standingCharge": 123,
"standingChargeType": "<string>",
"unitRate": 123,
"dayUnitRate": 123,
"nightUnitRate": 123,
"estimatedAnnualConsumption": 123,
"previous12MonthsConsumption": 123,
"maximumImportCapacity": 123,
"capacityRate": 123,
"directDebitDiscount": 123,
"brokerName": "<string>",
"brokerUplift": 123
}
]
}
],
"creditNotes": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
],
"debitNotes": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
],
"certificates": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
],
"others": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
],
"loas": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
]
}
]Upload Document to Account
Upload a document to a specific account for processing and storage.
curl --request PUT \
--url https://api.voltview.co.uk/v1/suppliers/accounts/{id}/documents/upload \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file' \
--form 'documentId=<string>' \
--form 'documentType=<string>'[
{
"id": "<string>",
"accountId": "<string>",
"referenceId": "<string>",
"invoices": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>",
"mpanMprn": "<string>",
"supplyType": "electricity",
"supplierName": "<string>",
"supplierAccountNumber": "<string>",
"customerName": "<string>",
"invoiceNumber": "<string>",
"invoiceDate": "2023-12-25",
"dueDate": "2023-12-25",
"chargeStartDate": "2023-12-25",
"chargeEndDate": "2023-12-25",
"meterSerialNumber": "<string>",
"siteAddress": "<string>",
"paymentMethod": "<string>",
"standingCharge": 123,
"standingChargeType": "<string>",
"cclRate": 123,
"vatRate": 123,
"readFromDate": "2023-12-25",
"readFromType": "actual",
"readToDate": "2023-12-25",
"readToType": "actual",
"consumption": 123,
"dayConsumption": 123,
"nightConsumption": 123,
"unitRate": 123,
"dayUnitRate": 123,
"nightUnitRate": 123,
"correctionFactor": 123,
"calorificValue": 123,
"totalUnitCharge": 123,
"totalStandingCharge": 123,
"capacityCharge": 123,
"amountDueNetOfVat": 123,
"vat": 123,
"totalAmount": 123,
"status": "pending",
"validationStatus": "pending"
}
],
"contracts": [
{
"id": "<string>",
"filePath": "<string>",
"supplierName": "<string>",
"supplierAddress": "<string>",
"supplierCode": "<string>",
"supplierAccountNumber": "<string>",
"customerName": "<string>",
"contractNumber": "<string>",
"contractStartDate": "2023-12-25",
"contractEndDate": "2023-12-25",
"isFixedContract": true,
"isMarketRates": true,
"isMicroBusiness": true,
"paymentMethod": "<string>",
"contractTermMonths": 123,
"cclRate": 123,
"vatRate": 123,
"supplyPoints": [
{
"mpanMprn": "<string>",
"supplyType": "electricity",
"meterSerialNumber": "<string>",
"siteName": "<string>",
"siteAddress": "<string>",
"tariffName": "<string>",
"isNonContractedRate": true,
"standingCharge": 123,
"standingChargeType": "<string>",
"unitRate": 123,
"dayUnitRate": 123,
"nightUnitRate": 123,
"estimatedAnnualConsumption": 123,
"previous12MonthsConsumption": 123,
"maximumImportCapacity": 123,
"capacityRate": 123,
"directDebitDiscount": 123,
"brokerName": "<string>",
"brokerUplift": 123
}
]
}
],
"creditNotes": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
],
"debitNotes": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
],
"certificates": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
],
"others": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
],
"loas": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
]
}
]Authorizations
JWT token obtained from /v1/requestToken endpoint
Path Parameters
Account ID
Body
Response
Document uploaded successfully and sites retrieved
Site identifier
Account identifier
Reference identifier
List of invoices for the site
Show child attributes
Show child attributes
Unique invoice identifier
Path to stored invoice file
File extension of the invoice document
MPAN (13 digits) for electricity or MPRN (6-11 digits) for gas
Type of utility supply
electricity, gas Name of the energy supplier
Account number with the supplier
Name of the customer on the invoice
Invoice reference number
Date invoice was issued (YYYY-MM-DD)
Payment due date (YYYY-MM-DD)
Start of billing period (YYYY-MM-DD)
End of billing period (YYYY-MM-DD)
Meter serial number
Site address where meter is located
Method of payment for this invoice
Standing charge amount in pence per day (p/day). Always normalised to p/day regardless of how it appears on the invoice.
Type of standing charge. Standardised to 'p/day'.
Climate Change Levy rate in pence per kWh (p/kWh). Converted from £/kWh if necessary (e.g., 0.00775 £/kWh becomes 0.775 p/kWh).
VAT rate as a percentage (e.g., 20 for 20%, not 0.2). Always a number between 0 and 100.
Start meter reading date (YYYY-MM-DD)
Type of start reading
actual, estimated, customer, smart End meter reading date (YYYY-MM-DD)
Type of end reading
actual, estimated, customer, smart Total consumption in kWh (null if day/night rates apply)
Day/peak consumption in kWh
Night/off-peak consumption in kWh
Single rate tariff in pence per kWh (p/kWh). Always a number (null if day/night rates apply).
Day/peak unit rate in pence per kWh (p/kWh). Always a number.
Night/off-peak unit rate in pence per kWh (p/kWh). Always a number.
Gas correction factor
Gas calorific value
Total charge for units consumed in £
Total standing charge amount in £
Total capacity charge in £ (for electricity only)
Total amount due before VAT in £
VAT amount in £
Total invoice amount including VAT in £
Current payment status of the invoice
pending, paid, overdue, disputed Status of invoice validation process
pending, validated, issues_detected List of contracts for the site
Show child attributes
Show child attributes
Unique contract identifier
Path to stored contract file
Name of the energy supplier
Supplier's full address
Supplier's identifier code
Account number with the supplier
Name of the customer on the contract
Official contract reference number
Contract start date (YYYY-MM-DD)
Contract end date (YYYY-MM-DD)
Whether the contract has fixed rates
Whether rates follow wholesale market prices
Whether the customer is classified as a micro business
The agreed payment method
Duration of the contract in months
Climate Change Levy rate in pence per kWh (p/kWh). Converted from £/kWh if necessary (e.g., 0.00775 £/kWh becomes 0.775 p/kWh).
VAT rate as a percentage (e.g., 20 for 20%, not 0.2). Always a number between 0 and 100.
Details of individual meters covered by this contract, each with their specific terms and rates
Show child attributes
Show child attributes
MPAN (13 digits) for electricity or MPRN (6-11 digits) for gas
Type of utility supply
electricity, gas Meter serial number
Name or identifier of the site
Full address of the supply point
Full name of the tariff
True if rates are out of contract or deemed rates
Standing charge amount in pence per day (p/day). Always normalised to p/day regardless of how it appears on the contract.
Type of standing charge. Standardised to 'p/day'.
Single rate tariff in pence per kWh (p/kWh). Always a number (null if day/night rates apply).
Day/peak unit rate in pence per kWh (p/kWh). Always a number.
Night/off-peak unit rate in pence per kWh (p/kWh). Always a number.
Estimated annual consumption in kWh
Previous 12 months consumption in kWh
Maximum import capacity in kVA (for electricity only)
Capacity charge rate in pence per kVA per day (p/kVA/day). Always a number (electricity only).
Percentage discount if applicable
Name of the broker if contract was arranged through one
Broker's uplift in p/kWh if specified