Get Sites Associated with an Account

GET

supplierIntegration

accounts

{id}

sites

curl --request GET \
  --url https://api.voltview.co.uk/v1/supplierIntegration/accounts/{id}/sites \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "<string>",
    "accountId": "<string>",
    "organisationId": "<string>",
    "bgAccountId": "<string>",
    "referenceId": "<string>",
    "fuelType": "<string>",
    "address": "<string>",
    "invoices": [
      {
        "id": "<string>",
        "filePath": "<string>",
        "extension": "<string>",
        "mpanMprn": "<string>",
        "supplyType": "electricity",
        "supplierName": "<string>",
        "supplierAccountNumber": "<string>",
        "customerName": "<string>",
        "invoiceNumber": "<string>",
        "invoiceDate": "2023-12-25",
        "dueDate": "2023-12-25",
        "chargeStartDate": "2023-12-25",
        "chargeEndDate": "2023-12-25",
        "meterSerialNumber": "<string>",
        "siteAddress": "<string>",
        "paymentMethod": "<string>",
        "standingCharge": 123,
        "standingChargeType": "<string>",
        "cclRate": 123,
        "vatRate": 123,
        "readFromDate": "2023-12-25",
        "readFromType": "actual",
        "readToDate": "2023-12-25",
        "readToType": "actual",
        "consumption": 123,
        "dayConsumption": 123,
        "nightConsumption": 123,
        "unitRate": 123,
        "dayUnitRate": 123,
        "nightUnitRate": 123,
        "correctionFactor": 123,
        "calorificValue": 123,
        "totalUnitCharge": 123,
        "totalStandingCharge": 123,
        "capacityCharge": 123,
        "amountDueNetOfVat": 123,
        "vat": 123,
        "totalAmount": 123,
        "status": "pending",
        "validationStatus": "pending"
      }
    ],
    "contracts": [
      {
        "id": "<string>",
        "filePath": "<string>",
        "supplierName": "<string>",
        "supplierCode": "<string>",
        "supplierAccountNumber": "<string>",
        "customerName": "<string>",
        "contractNumber": "<string>",
        "contractStartDate": "2023-12-25",
        "contractEndDate": "2023-12-25",
        "displayName": "<string>",
        "isFixedContract": true,
        "isMarketRates": true,
        "isMicroBusiness": true,
        "paymentMethod": "<string>",
        "contractTermMonths": 123,
        "cclRate": 123,
        "vatRate": 123,
        "supplyPoints": [
          {
            "mpanMprn": "<string>",
            "supplyType": "electricity",
            "meterSerialNumber": "<string>",
            "siteName": "<string>",
            "siteAddress": "<string>",
            "standingCharge": 123,
            "standingChargeType": "<string>",
            "unitRate": 123,
            "dayUnitRate": 123,
            "nightUnitRate": 123,
            "estimatedAnnualConsumption": 123,
            "maximumImportCapacity": 123,
            "capacityRate": 123,
            "directDebitDiscount": 123,
            "brokerName": "<string>",
            "brokerUplift": 123
          }
        ]
      }
    ]
  }
]

Authorizations

Authorization

string

header

required

JWT token obtained from /v1/requestToken endpoint

Path Parameters

string

required

Account ID

Response

200

application/json

Sites retrieved successfully

string

Site identifier

accountId

string

Account identifier

organisationId

string

Organisation identifier

bgAccountId

string

Background account identifier

referenceId

string

Reference identifier

fuelType

string

Type of fuel service

address

string

Site address

invoices

object[]

List of invoices for the site

invoices.id

string

Unique invoice identifier

invoices.filePath

string

Path to stored invoice file

invoices.extension

string

File extension of the invoice document

invoices.mpanMprn

string

MPAN (13 digits) for electricity or MPRN (6-11 digits) for gas

invoices.supplyType

enum<string>

Type of utility supply

Available options:

electricity,

gas

invoices.supplierName

string

Name of the energy supplier

invoices.supplierAccountNumber

string

Account number with the supplier

invoices.customerName

string

Name of the customer on the invoice

invoices.invoiceNumber

string

Invoice reference number

invoices.invoiceDate

string

Date invoice was issued (YYYY-MM-DD)

invoices.dueDate

string

Payment due date (YYYY-MM-DD)

invoices.chargeStartDate

string

Start of billing period (YYYY-MM-DD)

invoices.chargeEndDate

string

End of billing period (YYYY-MM-DD)

invoices.meterSerialNumber

string

Meter serial number

invoices.siteAddress

string

Site address where meter is located

invoices.paymentMethod

string

Method of payment for this invoice

invoices.standingCharge

number

Standing charge amount in pence per day

invoices.standingChargeType

string

Type of standing charge

invoices.cclRate

number

Climate Change Levy rate in p/kWh

invoices.vatRate

number

VAT rate in percentage

invoices.readFromDate

string

Start meter reading date (YYYY-MM-DD)

invoices.readFromType

enum<string>

Type of start reading

Available options:

actual,

estimated,

customer,

smart

invoices.readToDate

string

End meter reading date (YYYY-MM-DD)

invoices.readToType

enum<string>

Type of end reading

Available options:

actual,

estimated,

customer,

smart

invoices.consumption

number

Total consumption in kWh (null if day/night rates apply)

invoices.dayConsumption

number

Day/peak consumption in kWh

invoices.nightConsumption

number

Night/off-peak consumption in kWh

invoices.unitRate

number

Single rate tariff in p/kWh (null if day/night rates apply)

invoices.dayUnitRate

number

Day/peak unit rate in p/kWh

invoices.nightUnitRate

number

Night/off-peak unit rate in p/kWh

invoices.correctionFactor

number

Gas correction factor

invoices.calorificValue

number

Gas calorific value

invoices.totalUnitCharge

number

Total charge for units consumed in £

invoices.totalStandingCharge

number

Total standing charge amount in £

invoices.capacityCharge

number

Total capacity charge in £ (for electricity only)

invoices.amountDueNetOfVat

number

Total amount due before VAT in £

invoices.vat

number

VAT amount in £

invoices.totalAmount

number

Total invoice amount including VAT in £

invoices.status

enum<string>

Current payment status of the invoice

Available options:

pending,

paid,

overdue,

disputed

invoices.validationStatus

enum<string>

Status of invoice validation process

Available options:

pending,

validated,

issues_detected

contracts

object[]

List of contracts for the site

contracts.id

string

Unique contract identifier

contracts.filePath

string

Path to stored contract file

contracts.supplierName

string

Name of the energy supplier

contracts.supplierCode

string

Supplier's identifier code

contracts.supplierAccountNumber

string

Account number with the supplier

contracts.customerName

string

Name of the customer on the contract

contracts.contractNumber

string

Official contract reference number

contracts.contractStartDate

string

Contract start date (YYYY-MM-DD)

contracts.contractEndDate

string

Contract end date (YYYY-MM-DD)

contracts.displayName

string

User-friendly name for the contract

contracts.isFixedContract

boolean

Whether the contract has fixed rates

contracts.isMarketRates

boolean

Whether rates follow wholesale market prices

contracts.isMicroBusiness

boolean

Whether the customer is classified as a micro business

contracts.paymentMethod

string

The agreed payment method

contracts.contractTermMonths

integer

Duration of the contract in months

contracts.cclRate

number

Climate Change Levy rate in p/kWh

contracts.vatRate

number

VAT rate in percentage

contracts.supplyPoints

object[]

Details of individual meters covered by this contract, each with their specific terms and rates

Delete an Account Get Accounts Associated with a Business

curl --request GET \
  --url https://api.voltview.co.uk/v1/supplierIntegration/accounts/{id}/sites \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "<string>",
    "accountId": "<string>",
    "organisationId": "<string>",
    "bgAccountId": "<string>",
    "referenceId": "<string>",
    "fuelType": "<string>",
    "address": "<string>",
    "invoices": [
      {
        "id": "<string>",
        "filePath": "<string>",
        "extension": "<string>",
        "mpanMprn": "<string>",
        "supplyType": "electricity",
        "supplierName": "<string>",
        "supplierAccountNumber": "<string>",
        "customerName": "<string>",
        "invoiceNumber": "<string>",
        "invoiceDate": "2023-12-25",
        "dueDate": "2023-12-25",
        "chargeStartDate": "2023-12-25",
        "chargeEndDate": "2023-12-25",
        "meterSerialNumber": "<string>",
        "siteAddress": "<string>",
        "paymentMethod": "<string>",
        "standingCharge": 123,
        "standingChargeType": "<string>",
        "cclRate": 123,
        "vatRate": 123,
        "readFromDate": "2023-12-25",
        "readFromType": "actual",
        "readToDate": "2023-12-25",
        "readToType": "actual",
        "consumption": 123,
        "dayConsumption": 123,
        "nightConsumption": 123,
        "unitRate": 123,
        "dayUnitRate": 123,
        "nightUnitRate": 123,
        "correctionFactor": 123,
        "calorificValue": 123,
        "totalUnitCharge": 123,
        "totalStandingCharge": 123,
        "capacityCharge": 123,
        "amountDueNetOfVat": 123,
        "vat": 123,
        "totalAmount": 123,
        "status": "pending",
        "validationStatus": "pending"
      }
    ],
    "contracts": [
      {
        "id": "<string>",
        "filePath": "<string>",
        "supplierName": "<string>",
        "supplierCode": "<string>",
        "supplierAccountNumber": "<string>",
        "customerName": "<string>",
        "contractNumber": "<string>",
        "contractStartDate": "2023-12-25",
        "contractEndDate": "2023-12-25",
        "displayName": "<string>",
        "isFixedContract": true,
        "isMarketRates": true,
        "isMicroBusiness": true,
        "paymentMethod": "<string>",
        "contractTermMonths": 123,
        "cclRate": 123,
        "vatRate": 123,
        "supplyPoints": [
          {
            "mpanMprn": "<string>",
            "supplyType": "electricity",
            "meterSerialNumber": "<string>",
            "siteName": "<string>",
            "siteAddress": "<string>",
            "standingCharge": 123,
            "standingChargeType": "<string>",
            "unitRate": 123,
            "dayUnitRate": 123,
            "nightUnitRate": 123,
            "estimatedAnnualConsumption": 123,
            "maximumImportCapacity": 123,
            "capacityRate": 123,
            "directDebitDiscount": 123,
            "brokerName": "<string>",
            "brokerUplift": 123
          }
        ]
      }
    ]
  }
]

API Documentation

Authentication

User

Sites

Specific Site

Consumption

Supplier Integration

Bill Validation

Get Sites Associated with an Account

Authorizations

Path Parameters

Response