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
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.
POST
/
v1
/
billValidation
/
parseInvoice
curl --request POST \
--url https://api.voltview.co.uk/v1/billValidation/parseInvoice \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data'
{
"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
multipart/form-data
Response
200
application/json
Invoice successfully parsed
The response is of type object
.
curl --request POST \
--url https://api.voltview.co.uk/v1/billValidation/parseInvoice \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data'
{
"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"
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.