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'
{
  "customerType": "domestic",
  "supplierAccountNumber": "<string>",
  "supplierName": "<string>",
  "supplierAddress": "<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

​
customerType
enum<string> | null

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

Available options:
domestic,
non_domestic
​
supplierAccountNumber
string | null

Supplier account number

​
supplierName
string | null

Name of the supplier

​
supplierAddress
string | null

Supplier's full address

​
supplierCode
string | null

Supplier code

​
customerName
string | null

Name of the customer

​
billingAddress
string | null

Address where bills are sent (customer's address)

​
contractNumber
string | null

Contract number

​
contractStartDate
string<date> | null

Contract start date (YYYY-MM-DD)

​
contractEndDate
string<date> | null

Contract end date (YYYY-MM-DD)

​
cclRate
number | null

Climate Change Levy (CCL) rate

​
isFixedContract
boolean | null

Whether this is a fixed-rate contract

​
isMarketRates
boolean | null

Whether this contract uses market rates

​
isMicroBusiness
boolean | null

Whether the customer is classified as a micro business

​
paymentMethod
string | null

Payment method

​
contractTermMonths
number | null

Contract term in months

​
supplyPoints
object[] | null

Array of supply points in the contract