--- title: "Get Supplier Accounts for a Business" method: GET path: "/v1/suppliers/businesses/{businessId}/accounts" tags: ["Supplier Integration"] --- # Get Supplier Accounts for a Business `GET /v1/suppliers/businesses/{businessId}/accounts` Get all supplier accounts associated with a business. Alternative path using businessId. ## Path parameters - `businessId` string, required ## Response `200` Accounts retrieved successfully - Account[] - `id` string — Account identifier - `projectId` string — Project identifier - `referenceId` string — Business identifier - `expiryDate` string — Account credentials expiry date - `status` string — Account status - `supplier` string — Utility supplier name - `sites` IntegrationSite[] — List of sites associated with this account - `id` string — Site identifier - `accountId` string — Account identifier - `referenceId` string — Reference identifier - `invoices` IntegrationInvoice[] — List of invoices for the site - `id` string — Unique invoice identifier - `filePath` string — Path to stored invoice file - `extension` string — File extension of the invoice document - `mpanMprn` string — MPAN (13 digits) for electricity or MPRN (6-11 digits) for gas - `supplyType` 'electricity' | 'gas' — Type of utility supply - `supplierName` string — Name of the energy supplier - `supplierAccountNumber` string — Account number with the supplier - `customerName` string — Name of the customer on the invoice - `invoiceNumber` string — Invoice reference number - `invoiceDate` string, date — Date invoice was issued (YYYY-MM-DD) - `dueDate` string, date — Payment due date (YYYY-MM-DD) - `chargeStartDate` string, date — Start of billing period (YYYY-MM-DD) - `chargeEndDate` string, date — End of billing period (YYYY-MM-DD) - `meterSerialNumber` string — Meter serial number - `siteAddress` string — Site address where meter is located - `paymentMethod` string — Method of payment for this invoice - `standingCharge` number — Standing charge amount in pence per day (p/day). Always normalised to p/day regardless of how it appears on the invoice. - `standingChargeType` string — Type of standing charge. Standardised to 'p/day'. - `cclRate` number — Climate Change Levy rate in pence per kWh (p/kWh). Converted from £/kWh if necessary (e.g., 0.00775 £/kWh becomes 0.775 p/kWh). - `vatRate` number — VAT rate as a percentage (e.g., 20 for 20%, not 0.2). Always a number between 0 and 100. - `readFromDate` string, date — Start meter reading date (YYYY-MM-DD) - `readFromType` 'actual' | 'estimated' | 'customer' | 'smart' — Type of start reading - `readToDate` string, date — End meter reading date (YYYY-MM-DD) - `readToType` 'actual' | 'estimated' | 'customer' | 'smart' — Type of end reading - `consumption` number — Total consumption in kWh (null if day/night rates apply) - `dayConsumption` number — Day/peak consumption in kWh - `nightConsumption` number — Night/off-peak consumption in kWh - `unitRate` number — Single rate tariff in pence per kWh (p/kWh). Always a number (null if day/night rates apply). - `dayUnitRate` number — Day/peak unit rate in pence per kWh (p/kWh). Always a number. - `nightUnitRate` number — Night/off-peak unit rate in pence per kWh (p/kWh). Always a number. - `correctionFactor` number — Gas correction factor - `calorificValue` number — Gas calorific value - `totalUnitCharge` number — Total charge for units consumed in £ - `totalStandingCharge` number — Total standing charge amount in £ - `capacityCharge` number — Total capacity charge in £ (for electricity only) - `amountDueNetOfVat` number — Total amount due before VAT in £ - `vat` number — VAT amount in £ - `totalAmount` number — Total invoice amount including VAT in £ - `status` 'pending' | 'paid' | 'overdue' | 'disputed' — Current payment status of the invoice - `validationStatus` 'pending' | 'validated' | 'issues_detected' — Status of invoice validation process - `contracts` IntegrationContract[] — List of contracts for the site - `customerType` 'domestic' | 'non_domestic', nullable — Customer classification - residential (domestic) or business (non_domestic) - `supplierAccountNumber` string, nullable — Supplier account number - `supplierName` string, nullable — Name of the supplier - `supplierAddress` string, nullable — Supplier's full address - `supplierCode` string, nullable — Supplier code - `customerName` string, nullable — Name of the customer - `billingAddress` string, nullable — Address where bills are sent (customer's address) - `contractNumber` string, nullable — Contract number - `contractStartDate` string, date, nullable — Contract start date (YYYY-MM-DD) - `contractEndDate` string, date, nullable — Contract end date (YYYY-MM-DD) - `cclRate` number, nullable — Climate Change Levy (CCL) rate - `isFixedContract` boolean, nullable — Whether this is a fixed-rate contract - `isMarketRates` boolean, nullable — Whether this contract uses market rates - `isMicroBusiness` boolean, nullable — Whether the customer is classified as a micro business - `paymentMethod` string, nullable — Payment method - `contractTermMonths` number, nullable — Contract term in months - `supplyPoints` object[], nullable — Array of supply points in the contract - `mpanMprn` string, nullable — MPAN (13 digits for electricity) or MPRN (6-10 digits for gas) - `supplyType` 'electricity' | 'gas', nullable — Type of supply - `meterSerialNumber` string, nullable — Meter serial number - `siteName` string, nullable — Name of the site - `siteAddress` string, nullable — Address of the site - `tariffName` string, nullable — Full name of the tariff - `isNonContractedRate` boolean, nullable — True if rates are out of contract or deemed rates - `standingCharge` number, nullable — Standing charge in pence per day (p/day) - `standingChargeType` string, nullable — Standing charge type - `unitRate` number, nullable — Single unit rate in pence per kWh (p/kWh) - `dayUnitRate` number, nullable — Day unit rate in pence per kWh (p/kWh) - `nightUnitRate` number, nullable — Night unit rate in pence per kWh (p/kWh) - `estimatedAnnualConsumption` number, nullable — Estimated annual consumption in kWh - `previous12MonthsConsumption` number, nullable — Previous 12 months consumption in kWh - `maximumImportCapacity` number, nullable — Maximum import capacity in kVA - `capacityRate` number, nullable — Capacity charge rate in pence per kVA per day (p/kVA/day) - `directDebitDiscount` number, nullable — Direct debit discount percentage - `brokerName` string, nullable — Name of the energy broker - `brokerUplift` number, nullable — Broker uplift in pence per kWh (p/kWh) - `vatRate` number, nullable — VAT rate percentage - `creditNotes` ParsedDocument[] — List of credit notes for the site - `id` string — Document ID - `filePath` string — File path to the document - `extension` string — Document extension - `debitNotes` ParsedDocument[] — List of debit notes for the site - `id` string — Document ID - `filePath` string — File path to the document - `extension` string — Document extension - `certificates` ParsedDocument[] — List of certificates for the site - `id` string — Document ID - `filePath` string — File path to the document - `extension` string — Document extension - `others` ParsedDocument[] — List of other documents for the site - `id` string — Document ID - `filePath` string — File path to the document - `extension` string — Document extension - `loas` ParsedDocument[] — List of loas for the site - `id` string — Document ID - `filePath` string — File path to the document - `extension` string — Document extension ## Other responses - `4XX` — Client error response --- [API](https://skmtc.net/voltview/apis/voltview-api.md) · [All operations](https://skmtc.net/voltview/apis/voltview-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voltview/voltview-api/revisions/d90c739b55df/schema)