Skip to main content
POST
/
v1
/
billValidation
/
parseContract
curl --request POST \
--url https://api.voltview.co.uk/v1/billValidation/parseContract \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form filePath=@example-file
{
"filePath": "<string>",
"supplierAccountNumber": "<string>",
"supplierName": "<string>",
"supplierCode": "<string>",
"customerName": "<string>",
"contractNumber": "<string>",
"contractStartDate": "2023-12-25",
"contractEndDate": "2023-12-25",
"cclRate": 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"
}
],
"isFixedContract": true,
"isMarketRates": true,
"isMicroBusiness": true,
"paymentMethod": "<string>",
"contractTermMonths": 123
}

Authorizations

Authorization
string
header
required

JWT token obtained from /v1/requestToken endpoint

Body

multipart/form-data
filePath
file
required

Contract file to upload (PDF, JPEG, or PNG format)

Response

Contract successfully parsed

supplyPoints
object[]
required

List of supply points in the contract

filePath
string

Original filename of the uploaded contract

supplierAccountNumber
string

Account number with the supplier

supplierName
string

Name of the energy supplier

supplierCode
string

Supplier code or identifier

customerName
string

Name of the customer

contractNumber
string

Contract reference number

contractStartDate
string<date>

Contract start date (YYYY-MM-DD)

contractEndDate
string<date>

Contract end date (YYYY-MM-DD)

cclRate
number

Climate Change Levy rate in p/kWh

isFixedContract
boolean

Whether the contract has fixed rates

isMarketRates
boolean

Whether the contract has variable market rates

isMicroBusiness
boolean

Whether the customer is classified as a micro-business

paymentMethod
string

Payment method for the contract

contractTermMonths
integer

Duration of the contract in months

I