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
- GETEnergy intensity for all sites
- GETStatistics for all sites
- GETEnergy recommendations
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
Consumption
Supplier Integration
Bill Validation
Parse invoice
Uploads and processes a UK energy supplier invoice (PDF or images) to extract invoice details, supply points (MPANs/MPRNs), and associated consumption and charge information.
curl --request POST \
--url https://api.voltview.co.uk/v1/billValidation/parseInvoice \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'file=[
null
]'{
"success": true,
"data": {
"invoiceId": "<string>",
"supplierAccountNumber": "<string>",
"supplierName": "<string>",
"customerName": "<string>",
"invoiceNumber": "<string>",
"invoiceDate": "2023-12-25",
"dueDate": "2023-12-25",
"chargeStartDate": "2023-12-25",
"chargeEndDate": "2023-12-25",
"paymentMethod": "<string>",
"cclRate": 123,
"vatRate": 123,
"amountDueNetOfVat": 123,
"vat": 123,
"totalAmount": 123,
"previousAmountDue": 123,
"confidence": 123,
"supplyPoints": [
{
"mpanMprn": "<string>",
"supplyType": "electricity",
"meterSerialNumber": "<string>",
"siteAddress": "<string>",
"standingCharge": 123,
"standingChargeType": "<string>",
"consumptionkWh": 123,
"consumptionKvarh": 123,
"consumptionKvah": 123,
"dayConsumption": 123,
"nightConsumption": 123,
"unitRate": 123,
"dayUnitRate": 123,
"nightUnitRate": 123,
"correctionFactor": 123,
"calorificValue": 123,
"totalUnitCharge": 123,
"totalStandingCharge": 123,
"capacityCharge": 123,
"currentMeterReading": 123,
"previousMeterReading": 123,
"readFromDate": "2023-12-25",
"readFromType": "actual",
"readToDate": "2023-12-25",
"readToType": "actual"
}
]
}
}Authorizations
JWT token obtained from /v1/requestToken endpoint
Body
Either a single PDF file or one or more image files (JPEG/JPG, PNG) containing the invoice document. Multiple images will be combined into a single PDF.
Response
true
List of supply points in the invoice
For electricity (MPAN), this is the core 13 digits. For gas (MPRN), this is the 6-11 digit number.
Type of utility supply
electricity, gas Serial number of the meter
Full address of the supply location
Standing charge in pence per day
Type of standing charge applied
Active energy consumption in kilowatt-hours (kWh)
Reactive energy consumption in kilovar-hours (kvarh)
Apparent energy consumption in kilovolt-ampere-hours (kVAh)
Day/peak consumption in kWh
Night/off-peak consumption in kWh
Unit rate in p/kWh (for single-rate tariffs)
Day/peak unit rate in p/kWh (for dual-rate tariffs)
Night/off-peak unit rate in p/kWh (for dual-rate tariffs)
Correction factor applied to gas consumption
Calorific value for gas meters
Total charge for consumption in £
Total standing charge in £
Capacity charge in £
Current meter reading in kWh
Previous meter reading in kWh
Date of the previous meter reading (YYYY-MM-DD)
Type of previous meter reading
actual, estimated Date of the current meter reading (YYYY-MM-DD)
Type of current meter reading
actual, estimated Unique identifier for the invoice
Account number with the supplier
Name of the energy supplier
Name of the customer
Invoice reference number
Date of invoice issuance (YYYY-MM-DD)
Payment due date (YYYY-MM-DD)
Start date of the billing period (YYYY-MM-DD)
End date of the billing period (YYYY-MM-DD)
Method of payment specified on the invoice
Climate Change Levy rate in p/kWh
VAT rate percentage
Amount due before VAT in £
VAT amount in £
Total invoice amount in £
Previous balance carried forward in £
Confidence level in the extracted data (0-100)
curl --request POST \
--url https://api.voltview.co.uk/v1/billValidation/parseInvoice \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'file=[
null
]'{
"success": true,
"data": {
"invoiceId": "<string>",
"supplierAccountNumber": "<string>",
"supplierName": "<string>",
"customerName": "<string>",
"invoiceNumber": "<string>",
"invoiceDate": "2023-12-25",
"dueDate": "2023-12-25",
"chargeStartDate": "2023-12-25",
"chargeEndDate": "2023-12-25",
"paymentMethod": "<string>",
"cclRate": 123,
"vatRate": 123,
"amountDueNetOfVat": 123,
"vat": 123,
"totalAmount": 123,
"previousAmountDue": 123,
"confidence": 123,
"supplyPoints": [
{
"mpanMprn": "<string>",
"supplyType": "electricity",
"meterSerialNumber": "<string>",
"siteAddress": "<string>",
"standingCharge": 123,
"standingChargeType": "<string>",
"consumptionkWh": 123,
"consumptionKvarh": 123,
"consumptionKvah": 123,
"dayConsumption": 123,
"nightConsumption": 123,
"unitRate": 123,
"dayUnitRate": 123,
"nightUnitRate": 123,
"correctionFactor": 123,
"calorificValue": 123,
"totalUnitCharge": 123,
"totalStandingCharge": 123,
"capacityCharge": 123,
"currentMeterReading": 123,
"previousMeterReading": 123,
"readFromDate": "2023-12-25",
"readFromType": "actual",
"readToDate": "2023-12-25",
"readToType": "actual"
}
]
}
}