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
Validate invoice
Validate a previously parsed invoice against meter readings, tariff data, and site information to identify discrepancies in consumption, rates, charges, and billing details
curl --request POST \
--url https://api.voltview.co.uk/v1/billValidation/validateInvoice \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"invoiceId": "<string>"
}'{
"documentId": "<string>",
"status": "passed",
"extractedData": {
"invoiceId": "<string>",
"supplierName": "<string>",
"supplierAccountNumber": "<string>",
"supplyType": "electricity",
"invoiceNumber": "<string>",
"customerName": "<string>",
"mpanMprn": "<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,
"confidence": 123
},
"errors": [
{
"type": "consumptionMismatch",
"description": "<string>",
"expected": "<string>",
"actual": "<string>"
}
]
}Authorizations
JWT token obtained from /v1/requestToken endpoint
Body
Unique invoice identifier returned from the parseInvoice endpoint
Response
Unique identifier for the validated document in the system
Validation status
passed, failed, pending Unique invoice identifier generated by the system
Invoice reference number
Total invoice amount including VAT in £
Confidence score of the extraction (0-100)
Name of the energy supplier
Account number with the supplier
Type of utility supply
electricity, gas, water, unknown Name of the customer on the invoice
MPAN (13 digits) for electricity or MPRN (6-11 digits) for gas
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 £
Type of validation error detected
consumptionMismatch, rateMismatch, standingChargeError, dayRateMismatch, nightRateMismatch, capacityChargeError, vatError, cclError, dateMismatch, other Error description
Expected value
Actual value
curl --request POST \
--url https://api.voltview.co.uk/v1/billValidation/validateInvoice \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"invoiceId": "<string>"
}'{
"documentId": "<string>",
"status": "passed",
"extractedData": {
"invoiceId": "<string>",
"supplierName": "<string>",
"supplierAccountNumber": "<string>",
"supplyType": "electricity",
"invoiceNumber": "<string>",
"customerName": "<string>",
"mpanMprn": "<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,
"confidence": 123
},
"errors": [
{
"type": "consumptionMismatch",
"description": "<string>",
"expected": "<string>",
"actual": "<string>"
}
]
}