GET
/
v1
/
suppliers
/
businesses
/
{businessId}
/
accounts
curl --request GET \
  --url https://api.voltview.co.uk/v1/suppliers/businesses/{businessId}/accounts \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "projectId": "<string>",
    "businessId": "<string>",
    "expiryDate": "<string>",
    "status": "<string>",
    "supplier": "<string>",
    "sites": [
      {
        "id": "<string>",
        "accountId": "<string>",
        "referenceId": "<string>",
        "invoices": [
          {
            "id": "<string>",
            "filePath": "<string>",
            "supplierName": "<string>",
            "supplierCode": "<string>",
            "supplierAccountNumber": "<string>",
            "customerName": "<string>",
            "contractNumber": "<string>",
            "contractStartDate": "2023-12-25",
            "contractEndDate": "2023-12-25",
            "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
              }
            ]
          }
        ],
        "contracts": [
          {
            "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"
          }
        ]
      }
    ]
  }
]

Authorizations

Authorization
string
header
required

JWT token obtained from /v1/requestToken endpoint

Path Parameters

businessId
string
required

Business ID

Response

200
application/json

Accounts retrieved successfully

The response is of type object[].