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=@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

Response

200
application/json

Contract successfully parsed

The response is of type object.