Skip to main content
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 file=@example-file
{
  "success": true,
  "data": {
    "filePath": "<string>",
    "documentType": "invoice",
    "isStatement": true,
    "supplierName": "<string>",
    "supplierCode": "<string>",
    "customerName": "<string>",
    "billingAddress": "<string>",
    "items": [
      {
        "itemType": "invoice",
        "invoiceNumber": "<string>",
        "invoiceDate": "2023-12-25",
        "dueDate": "2023-12-25",
        "netAmount": 123,
        "vatAmount": 123,
        "totalAmount": 123,
        "supplyPoints": [
          {
            "mpanMprn": "<string>",
            "supplyType": "electricity",
            "siteAddress": "<string>",
            "consumption": {
              "total": 123,
              "unit": "<string>",
              "day": 123,
              "night": 123,
              "reactive": 123,
              "apparent": 123
            },
            "charges": [
              {
                "category": "energy",
                "description": "<string>",
                "quantity": 123,
                "unit": "<string>",
                "rate": 123,
                "rateUnit": "<string>",
                "vatRate": 123,
                "netAmount": 123
              }
            ],
            "meterReadings": [
              {
                "date": "2023-12-25",
                "type": "actual",
                "reading": "<string>",
                "register": "<string>",
                "consumption": 123,
                "unit": "<string>"
              }
            ]
          }
        ]
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from /v1/requestToken endpoint

Body

multipart/form-data
​
file
file
required

Invoice file(s) to upload (PDF, JPEG, or PNG format). Can upload multiple files.

Response

Invoice successfully parsed

​
success
boolean
Example:

true

​
data
object

Extracted invoice data. Many fields are optional and depend on what can be extracted from the document. Only 'documentType', 'isStatement', and 'items' are always present.