Parse contract

POST

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=@contract.pdf

{
  "contractId": "<string>",
  "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

file

required

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

Response

200

application/json

Contract successfully parsed

contractId

string

required

Unique identifier for the contract

supplyPoints

object[]

required

List of supply points in the contract

supplyPoints.mpanMprn

string

required

For electricity (MPAN), this is the core 13 digits. For gas (MPRN), this is the 6-11 digit number.

supplyPoints.supplyType

enum<string>

required

Type of utility supply

Available options:

electricity,

gas

supplyPoints.meterSerialNumber

string

Serial number of the meter

supplyPoints.siteAddress

string

Full address of the supply location

supplyPoints.standingCharge

number

Standing charge in pence per day

supplyPoints.standingChargeType

string

Type of standing charge applied

supplyPoints.consumptionkWh

number

Active energy consumption in kilowatt-hours (kWh)

supplyPoints.consumptionKvarh

number

Reactive energy consumption in kilovar-hours (kvarh)

supplyPoints.consumptionKvah

number

Apparent energy consumption in kilovolt-ampere-hours (kVAh)

supplyPoints.dayConsumption

number

Day/peak consumption in kWh

supplyPoints.nightConsumption

number

Night/off-peak consumption in kWh

supplyPoints.unitRate

number

Unit rate in p/kWh (for single-rate tariffs)

supplyPoints.dayUnitRate

number

Day/peak unit rate in p/kWh (for dual-rate tariffs)

supplyPoints.nightUnitRate

number

Night/off-peak unit rate in p/kWh (for dual-rate tariffs)

supplyPoints.correctionFactor

number

Correction factor applied to gas consumption

supplyPoints.calorificValue

number

Calorific value for gas meters

supplyPoints.totalUnitCharge

number

Total charge for consumption in £

supplyPoints.totalStandingCharge

number

Total standing charge in £

supplyPoints.capacityCharge

number

Capacity charge in £

supplyPoints.currentMeterReading

number

Current meter reading in kWh

supplyPoints.previousMeterReading

number

Previous meter reading in kWh

supplyPoints.readFromDate

string

Date of the previous meter reading (YYYY-MM-DD)

supplyPoints.readFromType

enum<string>

Type of previous meter reading

Available options:

actual,

estimated

supplyPoints.readToDate

string

Date of the current meter reading (YYYY-MM-DD)

supplyPoints.readToType

enum<string>

Type of current meter reading

Available options:

actual,

estimated

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

Contract start date (YYYY-MM-DD)

contractEndDate

string

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

Parse invoice Validate invoice

curl --request POST \
  --url https://api.voltview.co.uk/v1/billValidation/parseContract \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file=@contract.pdf

{
  "contractId": "<string>",
  "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
}

API Documentation

Authentication

User

Sites

Emissions

Specific Site

Consumption

Supplier Integration

Bill Validation

Authorizations

Body

Response