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'
{
  "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
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from /v1/requestToken endpoint

Body

multipart/form-data
​
file
file
required

Invoice file (PDF, JPEG, or PNG)

Response

200
application/json
Invoice parsed successfully
​
invoiceId
string
required

Unique invoice identifier generated by the system

​
invoiceNumber
string
required

Invoice reference number

​
totalAmount
number
required

Total invoice amount including VAT in £

​
confidence
number
required

Confidence score of the extraction (0-100)

​
supplierName
string

Name of the energy supplier

​
supplierAccountNumber
string

Account number with the supplier

​
supplyType
enum<string>

Type of utility supply

Available options:
electricity,
gas,
water,
unknown
​
customerName
string

Name of the customer on the invoice

​
mpanMprn
string

MPAN (13 digits) for electricity or MPRN (6-11 digits) for gas

​
invoiceDate
string

Date invoice was issued (YYYY-MM-DD)

​
dueDate
string

Payment due date (YYYY-MM-DD)

​
chargeStartDate
string

Start of billing period (YYYY-MM-DD)

​
chargeEndDate
string

End of billing period (YYYY-MM-DD)

​
meterSerialNumber
string

Meter serial number

​
siteAddress
string

Site address where meter is located

​
paymentMethod
string

Method of payment for this invoice

​
standingCharge
number

Standing charge amount in pence per day

​
standingChargeType
string

Type of standing charge

​
cclRate
number

Climate Change Levy rate in p/kWh

​
vatRate
number

VAT rate in percentage

​
readFromDate
string

Start meter reading date (YYYY-MM-DD)

​
readFromType
enum<string>

Type of start reading

Available options:
actual,
estimated,
customer,
smart
​
readToDate
string

End meter reading date (YYYY-MM-DD)

​
readToType
enum<string>

Type of end reading

Available options:
actual,
estimated,
customer,
smart
​
consumption
number

Total consumption in kWh (null if day/night rates apply)

​
dayConsumption
number

Day/peak consumption in kWh

​
nightConsumption
number

Night/off-peak consumption in kWh

​
unitRate
number

Single rate tariff in p/kWh (null if day/night rates apply)

​
dayUnitRate
number

Day/peak unit rate in p/kWh

​
nightUnitRate
number

Night/off-peak unit rate in p/kWh

​
correctionFactor
number

Gas correction factor

​
calorificValue
number

Gas calorific value

​
totalUnitCharge
number

Total charge for units consumed in £

​
totalStandingCharge
number

Total standing charge amount in £

​
capacityCharge
number

Total capacity charge in £ (for electricity only)

​
amountDueNetOfVat
number

Total amount due before VAT in £

​
vat
number

VAT amount in £