Skip to content

Utility bill ​

Utility bills are uploaded through the documents endpoint which details file types and size limitations.

Extracted data ​

These are the extracted fields of an Utility bill

Customer information ​

Extracted information on the customer of the utility bill

FieldDescription
Full NameFull name found on the utility bill
First nameFirst name of the customer
Middle nameMiddle name(s) of the customer, if any
Last nameLast name of the customer. First, middle and last name are not returned when the customer is a business
Account numberAccount number found on the utility bill
Address1House Number
Address2House Name
Address3Flat, unit, or apartment identifier if applicable
Address4Street name or road
Address5Smaller locality or village if applicable
Address6City or Town name
Address7County or region name
PostcodePost code
CountryISO 2 letter country code

Provider information ​

Extracted information on the utility provider

  • Provider name
  • Provider address
  • Provider contact number
  • Provider VAT registration number

Bill information ​

  • Bill number
  • Issue date
  • Due date
  • Period start date
  • Period end date
  • Total amount due
  • Payment method
  • Usage details including the usage type, amount used and total usage cost

Other account financial information ​

  • Previous account balance
  • Last payment date
  • Last payment amount
  • Payment reference

Example extraction ​

An example extraction followed by the utility bill image it was extracted from.

json
{
    "fullName": "ANOTHER PLC",
    "fullAddress": "10, Example Street, Anytown, Countyshire, AB12 3CD, GB",
    "address1": "10",
    "address2": "",
    "address3": "",
    "address4": "Example Street",
    "address5": "",
    "address6": "Anytown",
    "address7": "Countyshire",
    "postcode": "AB12 3CD",
    "country": "GB",
    "periodStartDate": "2014-02-27T00:00:00",
    "periodEndDate": "2014-03-27T00:00:00",
    "accountNumber": "600485895",
    "providerName": "British Gas",
    "providerAddress": "Head Office, Another Plc, 10 Example Street, Anytown, Countyshire AB12 3CD",
    "providerContactNumber": "0330 100 005",
    "providerVATRegNumber": "000 0000 00",
    "billDate": "2014-02-27",
    "billDueDate": "2014-03-27",
    "billNumber": "00000000/0",
    "previousBalance": "0",
    "currentCharges": "61.91",
    "vat": "2.95",
    "standingCharges": "35.45",
    "discounts": "0",
    "totalAmountDue": "61.91",
    "usageDetails": [
        {
            "usageType": "Electricity",
            "unitsUsed": "0",
            "unitRate": "0",
            "unitOfMeasurement": "",
            "standingCharge": "35.45",
            "vat": "2.95",
            "totalUsageCost": "23.51"
        }
    ],
    "lastPaymentDate": "2014-02-20",
    "lastPaymentAmount": "61.14",
    "paymentMethod": "Cheque",
    "paymentReference": "600485895"
}
Example utility bill