Get Sites Associated with an Account
curl --request GET \
--url https://api.voltview.co.uk/v1/suppliers/accounts/{id}/sites \
--header 'x-api-key: <api-key>'[
{
"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>"
}
]
}
]Supplier Integration
Get Sites Associated with an Account
Fetch all utility sites linked to the specified account.
GET
/
v1
/
suppliers
/
accounts
/
{id}
/
sites
Get Sites Associated with an Account
curl --request GET \
--url https://api.voltview.co.uk/v1/suppliers/accounts/{id}/sites \
--header 'x-api-key: <api-key>'[
{
"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>"
}
]
}
]Authorizations
VoltView API key
Path Parameters
Account ID
Response
Sites retrieved successfully
Site identifier
Account identifier
Reference identifier
List of invoices for the site
Show child attributes
Show child attributes
List of contracts for the site
Show child attributes
Show child attributes
List of credit notes for the site
Show child attributes
Show child attributes
List of debit notes for the site
Show child attributes
Show child attributes
List of certificates for the site
Show child attributes
Show child attributes
List of other documents for the site
Show child attributes
Show child attributes
List of loas for the site
Show child attributes
Show child attributes
⌘I