POST
/
v1
/
billValidation
/
parseInvoice
Parse invoice
curl --request POST \
  --url https://api.voltview.co.uk/v1/billValidation/parseInvoice \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form filePath=@example-file
{
  "success": true,
  "data": {
    "filePath": "<string>",
    "supplierAccountNumber": "<string>",
    "supplierName": "<string>",
    "customerName": "<string>",
    "invoiceNumber": "<string>",
    "invoiceDate": "2023-12-25",
    "dueDate": "2023-12-25",
    "chargeStartDate": "2023-12-25",
    "chargeEndDate": "2023-12-25",
    "paymentMethod": "<string>",
    "cclRate": 123,
    "vatRate": 123,
    "amountDueNetOfVat": 123,
    "vat": 123,
    "totalAmount": 123,
    "previousAmountDue": 123,
    "confidence": 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"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from /v1/requestToken endpoint

Body

multipart/form-data

Response

200
application/json

Invoice successfully parsed

The response is of type object.