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
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
POST
/
v1
/
billValidation
/
validateInvoice
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
application/json
Response
200
application/json
Validation completed
The response is of type object
.
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>"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.