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 file=@example-file
{
  "filePath": "<string>",
  "customerType": "domestic",
  "supplierAccountNumber": "<string>",
  "supplierName": "<string>",
  "supplierAddress": "<string>",
  "supplierId": "<string>",
  "supplierCode": "<string>",
  "customerName": "<string>",
  "billingAddress": "<string>",
  "contractNumber": "<string>",
  "contractStartDate": "2023-12-25",
  "contractEndDate": "2023-12-25",
  "cclRate": 123,
  "isFixedContract": true,
  "isMarketRates": true,
  "isMicroBusiness": true,
  "paymentMethod": "<string>",
  "contractTermMonths": 123,
  "supplyPoints": [
    {
      "mpanMprn": "<string>",
      "supplyType": "electricity",
      "meterSerialNumber": "<string>",
      "siteName": "<string>",
      "siteAddress": "<string>",
      "tariffName": "<string>",
      "isNonContractedRate": true,
      "standingCharge": 123,
      "standingChargeType": "<string>",
      "unitRate": 123,
      "dayUnitRate": 123,
      "nightUnitRate": 123,
      "estimatedAnnualConsumption": 123,
      "previous12MonthsConsumption": 123,
      "maximumImportCapacity": 123,
      "capacityRate": 123,
      "directDebitDiscount": 123,
      "brokerName": "<string>",
      "brokerUplift": 123,
      "vatRate": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from /v1/requestToken endpoint

Body

multipart/form-data
​
file
file
required

Contract file(s) to upload (PDF, JPEG, or PNG format). Can upload multiple files (up to 10). Either one PDF or one or more images, but not both types together.

Response

Contract successfully parsed

Extracted contract data. Many fields are optional and depend on what can be extracted from the document. Only 'customerType' and 'supplyPoints' are always present (supplyPoints may be an empty array).

​
customerType
enum<string>
required

Customer classification - residential (domestic) or business (non_domestic)

Available options:
domestic,
non_domestic
​
supplyPoints
object[]
required

Array of supply points in the contract

​
filePath
string

Generated file path for the contract

​
supplierAccountNumber
string

Supplier account number

​
supplierName
string

Name of the supplier

​
supplierAddress
string

Supplier's full address

​
supplierId
string

Internal supplier identifier

​
supplierCode
string

Supplier code

​
customerName
string

Name of the customer

​
billingAddress
string

Address where bills are sent (customer's address)

​
contractNumber
string

Contract number

​
contractStartDate
string<date>

Contract start date in YYYY-MM-DD format

​
contractEndDate
string<date>

Contract end date in YYYY-MM-DD format

​
cclRate
number

Climate Change Levy (CCL) rate in pence per kWh (p/kWh). Converted from £/kWh if necessary (e.g., 0.00775 £/kWh becomes 0.775 p/kWh).

​
isFixedContract
boolean

Whether this is a fixed-rate contract

​
isMarketRates
boolean

Whether this contract uses market rates

​
isMicroBusiness
boolean

Whether the customer is classified as a micro business

​
paymentMethod
string

Payment method (e.g., 'Direct Debit', 'Credit Card')

​
contractTermMonths
number

Contract term in months