Get Supplier Accounts for a Business
curl --request GET \
--url https://api.voltview.co.uk/v1/suppliers/businesses/{businessId}/accounts \
--header 'x-api-key: <api-key>'import requests
url = "https://api.voltview.co.uk/v1/suppliers/businesses/{businessId}/accounts"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.voltview.co.uk/v1/suppliers/businesses/{businessId}/accounts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voltview.co.uk/v1/suppliers/businesses/{businessId}/accounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.voltview.co.uk/v1/suppliers/businesses/{businessId}/accounts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.voltview.co.uk/v1/suppliers/businesses/{businessId}/accounts")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voltview.co.uk/v1/suppliers/businesses/{businessId}/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"projectId": "<string>",
"referenceId": "<string>",
"expiryDate": "<string>",
"status": "<string>",
"supplier": "<string>",
"sites": [
{
"id": "<string>",
"accountId": "<string>",
"referenceId": "<string>",
"invoices": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>",
"mpanMprn": "<string>",
"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",
"readToDate": "2023-12-25",
"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
}
],
"contracts": [
{
"supplierAccountNumber": "<string>",
"supplierName": "<string>",
"supplierAddress": "<string>",
"supplierCode": "<string>",
"customerName": "<string>",
"billingAddress": "<string>",
"contractNumber": "<string>",
"contractStartDate": "2023-12-25",
"contractEndDate": "2023-12-25",
"cclRate": 123,
"isFixedContract": true,
"isMarketRates": true,
"isMicroBusiness": true,
"paymentMethod": "<string>",
"contractTermMonths": 123,
"supplyPoints": [
{
"mpanMprn": "<string>",
"meterSerialNumber": "<string>",
"siteName": "<string>",
"siteAddress": "<string>",
"tariffName": "<string>",
"isNonContractedRate": true,
"standingCharge": 123,
"standingChargeType": "<string>",
"unitRate": 123,
"dayUnitRate": 123,
"nightUnitRate": 123,
"estimatedAnnualConsumption": 123,
"previous12MonthsConsumption": 123,
"maximumImportCapacity": 123,
"capacityRate": 123,
"directDebitDiscount": 123,
"brokerName": "<string>",
"brokerUplift": 123,
"vatRate": 123
}
]
}
],
"creditNotes": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
],
"debitNotes": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
],
"certificates": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
],
"others": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
],
"loas": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
]
}
]
}
]{
"type": "error",
"error": {
"type": "invalid_request_error",
"message": "Invalid request"
}
}Supplier Integration
Get Supplier Accounts for a Business
Get all supplier accounts associated with a business. Alternative path using businessId.
GET
/
v1
/
suppliers
/
businesses
/
{businessId}
/
accounts
Get Supplier Accounts for a Business
curl --request GET \
--url https://api.voltview.co.uk/v1/suppliers/businesses/{businessId}/accounts \
--header 'x-api-key: <api-key>'import requests
url = "https://api.voltview.co.uk/v1/suppliers/businesses/{businessId}/accounts"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.voltview.co.uk/v1/suppliers/businesses/{businessId}/accounts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voltview.co.uk/v1/suppliers/businesses/{businessId}/accounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.voltview.co.uk/v1/suppliers/businesses/{businessId}/accounts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.voltview.co.uk/v1/suppliers/businesses/{businessId}/accounts")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voltview.co.uk/v1/suppliers/businesses/{businessId}/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"projectId": "<string>",
"referenceId": "<string>",
"expiryDate": "<string>",
"status": "<string>",
"supplier": "<string>",
"sites": [
{
"id": "<string>",
"accountId": "<string>",
"referenceId": "<string>",
"invoices": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>",
"mpanMprn": "<string>",
"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",
"readToDate": "2023-12-25",
"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
}
],
"contracts": [
{
"supplierAccountNumber": "<string>",
"supplierName": "<string>",
"supplierAddress": "<string>",
"supplierCode": "<string>",
"customerName": "<string>",
"billingAddress": "<string>",
"contractNumber": "<string>",
"contractStartDate": "2023-12-25",
"contractEndDate": "2023-12-25",
"cclRate": 123,
"isFixedContract": true,
"isMarketRates": true,
"isMicroBusiness": true,
"paymentMethod": "<string>",
"contractTermMonths": 123,
"supplyPoints": [
{
"mpanMprn": "<string>",
"meterSerialNumber": "<string>",
"siteName": "<string>",
"siteAddress": "<string>",
"tariffName": "<string>",
"isNonContractedRate": true,
"standingCharge": 123,
"standingChargeType": "<string>",
"unitRate": 123,
"dayUnitRate": 123,
"nightUnitRate": 123,
"estimatedAnnualConsumption": 123,
"previous12MonthsConsumption": 123,
"maximumImportCapacity": 123,
"capacityRate": 123,
"directDebitDiscount": 123,
"brokerName": "<string>",
"brokerUplift": 123,
"vatRate": 123
}
]
}
],
"creditNotes": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
],
"debitNotes": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
],
"certificates": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
],
"others": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
],
"loas": [
{
"id": "<string>",
"filePath": "<string>",
"extension": "<string>"
}
]
}
]
}
]{
"type": "error",
"error": {
"type": "invalid_request_error",
"message": "Invalid request"
}
}Authorizations
VoltView API key
Path Parameters
Business ID
Response
Accounts retrieved successfully
⌘I