API Documentation
Authentication
Sites
- GETList all sites
- 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
- GETEmissions data for all sites
- GETEnergy intensity for all sites
- GETStatistics for all sites
- GETMarginal carbon intensity
- GETEnergy recommendations
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
- GETEmissions data for a specific site
Consumption
Supplier Integration
Bill Validation
Get Accounts Associated with a Business
Fetch all accounts associated with a specific business.
curl --request GET \
--url https://api.voltview.co.uk/v1/supplierIntegration/businesses/{businessId}/accounts \
--header 'Authorization: Bearer <token>'[
{
"id": "<string>",
"projectId": "<string>",
"businessId": "<string>",
"expiryDate": "<string>",
"status": "<string>",
"supplier": "<string>",
"sites": [
{
"id": "<string>",
"accountId": "<string>",
"organisationId": "<string>",
"bgAccountId": "<string>",
"referenceId": "<string>",
"fuelType": "<string>",
"address": "<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>",
"supplierCode": "<string>",
"supplierAccountNumber": "<string>",
"customerName": "<string>",
"contractNumber": "<string>",
"contractStartDate": "2023-12-25",
"contractEndDate": "2023-12-25",
"displayName": "<string>",
"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>",
"standingCharge": 123,
"standingChargeType": "<string>",
"unitRate": 123,
"dayUnitRate": 123,
"nightUnitRate": 123,
"estimatedAnnualConsumption": 123,
"maximumImportCapacity": 123,
"capacityRate": 123,
"directDebitDiscount": 123,
"brokerName": "<string>",
"brokerUplift": 123
}
]
}
]
}
]
}
]Authorizations
JWT token obtained from /v1/requestToken endpoint
Path Parameters
Business ID
Response
Account identifier
Project identifier
Business identifier
Account credentials expiry date
Account status
Utility supplier name
List of sites associated with this account
Site identifier
Account identifier
Organisation identifier
Background account identifier
Reference identifier
Type of fuel service
Site address
List of invoices for the site
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
Type of standing charge
Climate Change Levy rate in p/kWh
VAT rate in percentage
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 p/kWh (null if day/night rates apply)
Day/peak unit rate in p/kWh
Night/off-peak unit rate in p/kWh
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
Unique contract identifier
Path to stored contract file
Name of the energy supplier
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)
User-friendly name for the contract
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 p/kWh
VAT rate in percentage
Details of individual meters covered by this contract, each with their specific terms and rates
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
Standing charge amount in £ per day
Type of standing charge
Single rate tariff in p/kWh (null if day/night rates apply)
Day/peak unit rate in p/kWh
Night/off-peak unit rate in p/kWh
Estimated annual consumption in kWh
Maximum import capacity in kVA (for electricity only)
Capacity charge in p/kVA per day (for electricity only)
Percentage discount if applicable
Name of the broker if contract was arranged through one
Broker's uplift in p/kWh if specified
curl --request GET \
--url https://api.voltview.co.uk/v1/supplierIntegration/businesses/{businessId}/accounts \
--header 'Authorization: Bearer <token>'[
{
"id": "<string>",
"projectId": "<string>",
"businessId": "<string>",
"expiryDate": "<string>",
"status": "<string>",
"supplier": "<string>",
"sites": [
{
"id": "<string>",
"accountId": "<string>",
"organisationId": "<string>",
"bgAccountId": "<string>",
"referenceId": "<string>",
"fuelType": "<string>",
"address": "<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>",
"supplierCode": "<string>",
"supplierAccountNumber": "<string>",
"customerName": "<string>",
"contractNumber": "<string>",
"contractStartDate": "2023-12-25",
"contractEndDate": "2023-12-25",
"displayName": "<string>",
"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>",
"standingCharge": 123,
"standingChargeType": "<string>",
"unitRate": 123,
"dayUnitRate": 123,
"nightUnitRate": 123,
"estimatedAnnualConsumption": 123,
"maximumImportCapacity": 123,
"capacityRate": 123,
"directDebitDiscount": 123,
"brokerName": "<string>",
"brokerUplift": 123
}
]
}
]
}
]
}
]