> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voltview.co.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Sites Associated with an Account

> Fetch all utility sites linked to the specified account.



## OpenAPI

````yaml get /v1/suppliers/accounts/{id}/sites
openapi: 3.0.3
info:
  title: VoltView API
  description: >-
    The VoltView API provides comprehensive energy monitoring and management
    capabilities for multi-site businesses, enabling real-time tracking of
    energy consumption, cost analysis, and environmental impact metrics.


    Our API suite includes:

    - Site Management API - Manage and monitor multiple site locations

    - Energy Consumption API - Access detailed energy usage data

    - Cost Analysis API - Track and analyse energy costs

    - Environmental Metrics API - Monitor carbon emissions and energy efficiency

    - Bill Validation API - Validate and audit utility bills for accuracy

    - Supplier Integration API - Integrate with utility suppliers for automated
    data collection


    ## Getting started guide


    To start using the VoltView API, you need to:


    - Sign up for a VoltView account to receive your API credentials

    - Review our data granularity options (hourly/daily/monthly)

    - Ensure your requests are sent via HTTPS

    - All responses are returned in JSON format


    ## Authentication


    Include your VoltView API key in the `x-api-key` header on every request.


    ### Authentication error response

    If authentication fails, you will receive an HTTP 401 Unauthorised response
    with a detailed error message in the JSON response body.


    ## Data Units

    - Energy Consumption: kWh

    - Power Demand: kW

    - Carbon Emissions: kg CO2e/tonnes CO2e

    - Currency: GBP (£)

    - Time Series: ISO 8601 format

    - Numeric Values: Rounded to 2 decimal places
  version: 1.0.0
  contact:
    email: info@voltview.co.uk
  license:
    name: Proprietary
servers:
  - url: https://api.voltview.co.uk
    description: Production server
security:
  - apiKeyAuth: []
tags:
  - name: Authentication
    description: Endpoints for authentication
  - name: User
    description: User profile management
  - name: Sites
    description: Multi-site management endpoints
  - name: Energy Consumption
    description: Energy consumption data endpoints
  - name: Specific Site
    description: Operations for specific sites
  - name: Meters
    description: Meter lookup and meter readings management
  - name: Emissions
    description: Carbon emissions data endpoints
  - name: LOA Management
    description: >-
      Letter of Authority (LOA) management - create, list, view, and update
      status of LOAs
  - name: Supplier Integration
    description: Utilities integration endpoints
  - name: Billing Insights
    description: Account-level billing insights and bill assurance opportunities
  - name: Bill Validation
    description: Utility bill validation and error detection endpoints
paths:
  /v1/suppliers/accounts/{id}/sites:
    get:
      tags:
        - Supplier Integration
      summary: Get Sites Associated with an Account
      description: Fetch all utility sites linked to the specified account.
      operationId: getAccountSites
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
          description: Account ID
      responses:
        '200':
          description: Sites retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IntegrationSite'
        4XX:
          $ref: '#/components/responses/Error4XX'
components:
  schemas:
    IntegrationSite:
      type: object
      properties:
        id:
          type: string
          description: Site identifier
        accountId:
          type: string
          description: Account identifier
        referenceId:
          type: string
          description: Reference identifier
        invoices:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationInvoice'
          description: List of invoices for the site
        contracts:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationContract'
          description: List of contracts for the site
        creditNotes:
          type: array
          items:
            $ref: '#/components/schemas/ParsedDocument'
          description: List of credit notes for the site
        debitNotes:
          type: array
          items:
            $ref: '#/components/schemas/ParsedDocument'
          description: List of debit notes for the site
        certificates:
          type: array
          items:
            $ref: '#/components/schemas/ParsedDocument'
          description: List of certificates for the site
        others:
          type: array
          items:
            $ref: '#/components/schemas/ParsedDocument'
          description: List of other documents for the site
        loas:
          type: array
          items:
            $ref: '#/components/schemas/ParsedDocument'
          description: List of loas for the site
    IntegrationInvoice:
      type: object
      properties:
        id:
          type: string
          description: Unique invoice identifier
        filePath:
          type: string
          description: Path to stored invoice file
        extension:
          type: string
          description: File extension of the invoice document
        mpanMprn:
          type: string
          description: MPAN (13 digits) for electricity or MPRN (6-11 digits) for gas
        supplyType:
          type: string
          enum:
            - electricity
            - gas
          description: Type of utility supply
        supplierName:
          type: string
          description: Name of the energy supplier
        supplierAccountNumber:
          type: string
          description: Account number with the supplier
        customerName:
          type: string
          description: Name of the customer on the invoice
        invoiceNumber:
          type: string
          description: Invoice reference number
        invoiceDate:
          type: string
          format: date
          description: Date invoice was issued (YYYY-MM-DD)
        dueDate:
          type: string
          format: date
          description: Payment due date (YYYY-MM-DD)
        chargeStartDate:
          type: string
          format: date
          description: Start of billing period (YYYY-MM-DD)
        chargeEndDate:
          type: string
          format: date
          description: End of billing period (YYYY-MM-DD)
        meterSerialNumber:
          type: string
          description: Meter serial number
        siteAddress:
          type: string
          description: Site address where meter is located
        paymentMethod:
          type: string
          description: Method of payment for this invoice
        standingCharge:
          type: number
          description: >-
            Standing charge amount in pence per day (p/day). Always normalised
            to p/day regardless of how it appears on the invoice.
        standingChargeType:
          type: string
          description: Type of standing charge. Standardised to 'p/day'.
        cclRate:
          type: number
          description: >-
            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:
          type: number
          description: >-
            VAT rate as a percentage (e.g., 20 for 20%, not 0.2). Always a
            number between 0 and 100.
        readFromDate:
          type: string
          format: date
          description: Start meter reading date (YYYY-MM-DD)
        readFromType:
          type: string
          enum:
            - actual
            - estimated
            - customer
            - smart
          description: Type of start reading
        readToDate:
          type: string
          format: date
          description: End meter reading date (YYYY-MM-DD)
        readToType:
          type: string
          enum:
            - actual
            - estimated
            - customer
            - smart
          description: Type of end reading
        consumption:
          type: number
          description: Total consumption in kWh (null if day/night rates apply)
        dayConsumption:
          type: number
          description: Day/peak consumption in kWh
        nightConsumption:
          type: number
          description: Night/off-peak consumption in kWh
        unitRate:
          type: number
          description: >-
            Single rate tariff in pence per kWh (p/kWh). Always a number (null
            if day/night rates apply).
        dayUnitRate:
          type: number
          description: Day/peak unit rate in pence per kWh (p/kWh). Always a number.
        nightUnitRate:
          type: number
          description: Night/off-peak unit rate in pence per kWh (p/kWh). Always a number.
        correctionFactor:
          type: number
          description: Gas correction factor
        calorificValue:
          type: number
          description: Gas calorific value
        totalUnitCharge:
          type: number
          description: Total charge for units consumed in £
        totalStandingCharge:
          type: number
          description: Total standing charge amount in £
        capacityCharge:
          type: number
          description: Total capacity charge in £ (for electricity only)
        amountDueNetOfVat:
          type: number
          description: Total amount due before VAT in £
        vat:
          type: number
          description: VAT amount in £
        totalAmount:
          type: number
          description: Total invoice amount including VAT in £
        status:
          type: string
          enum:
            - pending
            - paid
            - overdue
            - disputed
          description: Current payment status of the invoice
        validationStatus:
          type: string
          enum:
            - pending
            - validated
            - issues_detected
          description: Status of invoice validation process
    IntegrationContract:
      type: object
      properties:
        customerType:
          type: string
          enum:
            - domestic
            - non_domestic
          nullable: true
          description: >-
            Customer classification - residential (domestic) or business
            (non_domestic)
        supplierAccountNumber:
          type: string
          nullable: true
          description: Supplier account number
        supplierName:
          type: string
          nullable: true
          description: Name of the supplier
        supplierAddress:
          type: string
          nullable: true
          description: Supplier's full address
        supplierCode:
          type: string
          nullable: true
          description: Supplier code
        customerName:
          type: string
          nullable: true
          description: Name of the customer
        billingAddress:
          type: string
          nullable: true
          description: Address where bills are sent (customer's address)
        contractNumber:
          type: string
          nullable: true
          description: Contract number
        contractStartDate:
          type: string
          format: date
          nullable: true
          description: Contract start date (YYYY-MM-DD)
        contractEndDate:
          type: string
          format: date
          nullable: true
          description: Contract end date (YYYY-MM-DD)
        cclRate:
          type: number
          nullable: true
          description: Climate Change Levy (CCL) rate
        isFixedContract:
          type: boolean
          nullable: true
          description: Whether this is a fixed-rate contract
        isMarketRates:
          type: boolean
          nullable: true
          description: Whether this contract uses market rates
        isMicroBusiness:
          type: boolean
          nullable: true
          description: Whether the customer is classified as a micro business
        paymentMethod:
          type: string
          nullable: true
          description: Payment method
        contractTermMonths:
          type: number
          nullable: true
          description: Contract term in months
        supplyPoints:
          type: array
          nullable: true
          description: Array of supply points in the contract
          items:
            type: object
            properties:
              mpanMprn:
                type: string
                nullable: true
                description: MPAN (13 digits for electricity) or MPRN (6-10 digits for gas)
              supplyType:
                type: string
                enum:
                  - electricity
                  - gas
                nullable: true
                description: Type of supply
              meterSerialNumber:
                type: string
                nullable: true
                description: Meter serial number
              siteName:
                type: string
                nullable: true
                description: Name of the site
              siteAddress:
                type: string
                nullable: true
                description: Address of the site
              tariffName:
                type: string
                nullable: true
                description: Full name of the tariff
              isNonContractedRate:
                type: boolean
                nullable: true
                description: True if rates are out of contract or deemed rates
              standingCharge:
                type: number
                nullable: true
                description: Standing charge in pence per day (p/day)
              standingChargeType:
                type: string
                nullable: true
                description: Standing charge type
              unitRate:
                type: number
                nullable: true
                description: Single unit rate in pence per kWh (p/kWh)
              dayUnitRate:
                type: number
                nullable: true
                description: Day unit rate in pence per kWh (p/kWh)
              nightUnitRate:
                type: number
                nullable: true
                description: Night unit rate in pence per kWh (p/kWh)
              estimatedAnnualConsumption:
                type: number
                nullable: true
                description: Estimated annual consumption in kWh
              previous12MonthsConsumption:
                type: number
                nullable: true
                description: Previous 12 months consumption in kWh
              maximumImportCapacity:
                type: number
                nullable: true
                description: Maximum import capacity in kVA
              capacityRate:
                type: number
                nullable: true
                description: Capacity charge rate in pence per kVA per day (p/kVA/day)
              directDebitDiscount:
                type: number
                nullable: true
                description: Direct debit discount percentage
              brokerName:
                type: string
                nullable: true
                description: Name of the energy broker
              brokerUplift:
                type: number
                nullable: true
                description: Broker uplift in pence per kWh (p/kWh)
              vatRate:
                type: number
                nullable: true
                description: VAT rate percentage
    ParsedDocument:
      type: object
      properties:
        id:
          type: string
          description: Document ID
        filePath:
          type: string
          description: File path to the document
        extension:
          type: string
          description: Document extension
  responses:
    Error4XX:
      description: Client error response
      content:
        application/json:
          schema:
            type: object
            properties:
              type:
                type: string
                enum:
                  - error
              error:
                type: object
                properties:
                  type:
                    type: string
                    enum:
                      - invalid_request_error
                  message:
                    type: string
                    default: Invalid request
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: VoltView API key

````