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

# Get Energy Accounts

> List all accounts available for data sharing. This will be used to support account
selection during the authorisation.

_Note: This API has been deprecated. New integrations should implement the [Auth - Customer Accounts](/api-reference/cdr/auth-customer-accounts) API instead._




## OpenAPI

````yaml /openapi/cdr.yml get /v1/energy/customer/{customerId}/accounts
openapi: 3.0.3
info:
  description: Fiskil Data Holder as a Service (DHaaS) endpoints for the Energy sector
  title: Fiskil Data APIs
  version: 1.5.0
servers:
  - url: https://api.provider.fiskil.com
security:
  - bearerAuth: []
paths:
  /v1/energy/customer/{customerId}/accounts:
    get:
      tags:
        - Energy
        - Accounts
      summary: Get Energy Accounts
      description: >
        List all accounts available for data sharing. This will be used to
        support account

        selection during the authorisation.


        _Note: This API has been deprecated. New integrations should implement
        the [Auth - Customer
        Accounts](/api-reference/cdr/auth-customer-accounts) API instead._
      operationId: listAccounts
      parameters:
        - $ref: '#/components/parameters/customerId'
        - $ref: '#/components/parameters/open-status'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/page-size'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnergyAccountListResponseV2'
          description: >-
            Accounts belonging to the authenticated user they can use for data
            sharing
        '404':
          $ref: '#/components/responses/responseErrorCustomerIdNotFound'
      deprecated: true
components:
  parameters:
    customerId:
      description: >-
        Unique ID of a customer. This ID must not change for the lifecycle of
        the customer
      explode: false
      in: path
      name: customerId
      required: true
      schema:
        type: string
      style: simple
    open-status:
      description: >-
        Used to filter results according to open/closed status. Values can be
        OPEN, CLOSED or ALL. If absent then ALL is assumed
      explode: true
      in: query
      name: open-status
      required: false
      schema:
        default: ALL
        enum:
          - ALL
          - CLOSED
          - OPEN
        type: string
      style: form
    page:
      description: Page of results to request (standard pagination)
      explode: true
      in: query
      name: page
      required: false
      schema:
        type: integer
      style: form
      x-cds-type: PositiveInteger
    page-size:
      description: Page size to request.  Default is 25 (standard pagination)
      explode: true
      in: query
      name: page-size
      required: false
      schema:
        type: integer
      style: form
      x-cds-type: PositiveInteger
  schemas:
    EnergyAccountListResponseV2:
      description: A list of energy accounts
      example:
        data:
          accounts:
            - accountId: 019a08ff-90b2-71b3-9704-2f5dc6647e49
              accountNumber: '0123456789'
              displayName: Resi Single Rate
              openStatus: OPEN
              creationDate: '2025-01-01T00:00:00.000Z'
              complexAccountType: INDIVIDUAL
              users:
                - id: 1f81a6ec-4600-44e9-8a0c-bb831cef0407
                  email: hello@example.com
                  isAccountHolder: true
                - id: 019a0900-aa2f-77e3-b05d-11265be60e25
                  email: secondary-user@example.com
                  isAccountHolder: false
              plans:
                - nickname: Resi Single Rate
                  servicePointIds:
                    - '4123456789'
                  planOverview:
                    displayName: Resi Single Rate
                    startDate: '2025-01-01T00:00:00.000Z'
                  planDetail:
                    fuelType: ELECTRICITY
                    isContingentPlan: false
                    meteringCharges:
                      - displayName: standard metering charge
                        description: Basic fee for metering
                        minimumValue: '0.20'
                        period: P3M
                    electricityContract:
                      additionalFeeInformation: A fee applies for missed payments
                      pricingModel: SINGLE_RATE
                      timeZone: LOCAL
                      isFixed: true
                      variation: >-
                        We may vary the rates for your electricity consumption
                        with 30 days notice
                      paymentOption:
                        - PAPER_BILL
                        - CREDIT_CARD
                        - DIRECT_DEBIT
                        - BPAY
                      intrinsicGreenPower:
                        greenPercentage: 0.7
                      controlledLoad:
                        - displayName: Basic Controlled Load Appliance
                          rateBlockUType: singleRate
                          startDate: '2025-01-01T00:00:00.000Z'
                          singleRate:
                            displayName: Single Appliance
                            description: Controlled load rate for a single appliance
                            dailySupplyCharge: '0.75'
                            rates:
                              - unitPrice: '0.332'
                                measureUnit: KWH
                      incentives:
                        - displayName: Cashbacks
                          description: Sign up bonus
                          category: ACCOUNT_CREDIT
                          eligibility: >-
                            If you sign up before 2025-02-01 you will get $100
                            cash back as credit on your bill
                      discounts:
                        - displayName: Pay on time
                          description: Pay on time to get 1% off your bill
                          type: CONDITIONAL
                          category: PAY_ON_TIME
                          endDate: string
                          methodUType: percentOfBill
                          percentOfBill:
                            rate: 0.1
                      eligibility:
                        - type: NEW_CUSTOMER
                          information: >-
                            You must not have been a customer within the last 24
                            monthsr
                          description: >-
                            Only new customers are eligible for cashback
                            incentives
                      fees:
                        - type: LATE_PAYMENT
                          term: PERCENT_OF_BILL
                          rate: 0.05
                          description: >-
                            A 0.05% fee applies if your bill is not paid on
                            time.
                      solarFeedInTariff:
                        - displayName: Single rate Solar FiT
                          description: Single Rate Solar feed-in tariff
                          startDate: '2025-01-01T00:00:00.000Z'
                          scheme: PREMIUM
                          payerType: RETAILERT
                          tariffUType: singleTariff
                          singleTariff:
                            rates:
                              - unitPrice: '0.054'
                                measureUnit: KWH
                      tariffPeriod:
                        - type: RETAIL_SERVICE
                          displayName: Single Rate
                          startDate: '2025-01-01T00:00:00.000Z'
                          dailySupplyCharges: '0.64'
                          timeZone: LOCAL
                          rateBlockUType: singleRate
                          singleRate:
                            displayName: string
                            description: string
                            generalUnitPrice: string
                            rates:
                              - unitPrice: '0.342'
                                measureUnit: KWH
                  authorisedContacts:
                    - firstName: Peter
                      lastName: Sherman
                      prefix: Dr
        meta:
          totalRecords: 1
          totalPages: 1
        links:
          first: page=1&page-size=25&oldest-date=2023-04-24
          last: page=4&page-size=25&oldest-date=2023-04-24
          next: page=3&page-size=25&oldest-date=2023-04-24
          prev: page=1&page-size=25&oldest-date=2023-04-24
      properties:
        data:
          $ref: '#/components/schemas/EnergyAccountListResponseV2_data'
        links:
          $ref: '#/components/schemas/LinksPaginated'
        meta:
          $ref: '#/components/schemas/MetaPaginated'
      required:
        - data
        - links
        - meta
      type: object
    EnergyAccountListResponseV2_data:
      properties:
        accounts:
          description: Array of accounts
          items:
            allOf:
              - $ref: '#/components/schemas/EnergyAccountV2'
              - properties:
                  complexAccountType:
                    description: >-
                      The type of account for the purposes of handling complex
                      account interactions. Valid values are INDIVIDUAL, JOINT
                      and ORGANIZATION.
                    enum:
                      - INDIVIDUAL
                      - JOINT
                      - ORGANIZATION
                    type: string
                  users:
                    description: >-
                      The array of all related users of the bank account e.g.
                      joint account holders, secondary users, or nominated
                      representatives.
                    type: array
                    items:
                      $ref: '#/components/schemas/RelatedUsers'
                    example:
                      - id: user123
                        email: user123@example.com
                        isAccountHolder: true
                      - id: user456
                        email: user456@example.com
                        isAccountHolder: false
                required:
                  - complexAccountType
                  - users
          type: array
      required:
        - accounts
      type: object
    LinksPaginated:
      description: >-
        URL Query parameters to obtain different pages of the response. Fiskil
        will combine these with the rest of the request URL to build full link
        URLs in the final response.
      example:
        first: page=1&page-size=25&oldest-date=2023-04-24
        last: page=4&page-size=25&oldest-date=2023-04-24
        next: page=3&page-size=25&oldest-date=2023-04-24
        prev: page=1&page-size=25&oldest-date=2023-04-24
      properties:
        first:
          description: >-
            A url-encoded query for the first page of this result set. Mandatory
            if this response is not the first page.
          type: string
        prev:
          description: >-
            A url-encoded query for the previous page. Mandatory if this
            response is not the first page
          type: string
        next:
          description: >-
            A url-encoded query for the next page. Mandatory if this response is
            not the last page.
          type: string
        last:
          description: >-
            A url-encoded query for the last page. Mandatory if this response is
            not the last page.
          type: string
      type: object
    MetaPaginated:
      example:
        totalRecords: 150
        totalPages: 6
      properties:
        totalRecords:
          description: >-
            The total number of records in the full set. See
            [pagination](#pagination).
          type: integer
          x-cds-type: NaturalNumber
        totalPages:
          description: >-
            The total number of pages in the full set. See
            [pagination](#pagination).
          type: integer
          x-cds-type: NaturalNumber
      required:
        - totalPages
        - totalRecords
      type: object
    GenericError:
      example:
        error: An error message
      type: object
      properties:
        error:
          type: string
          description: A message describing what caused the error
      required:
        - error
    EnergyAccountV2:
      allOf:
        - $ref: '#/components/schemas/EnergyAccountBaseV2'
        - $ref: '#/components/schemas/EnergyAccountV2_allOf'
    RelatedUsers:
      properties:
        id:
          type: string
          description: The unique identifier of the user
        email:
          type: string
          description: The email address of the user
        isAccountHolder:
          type: boolean
          description: Indicates if the user is the account holder
      required:
        - id
        - email
        - isAccountHolder
    EnergyAccountBaseV2:
      properties:
        accountId:
          description: >-
            The ID of the account.  To be created in accordance with CDR ID
            permanence requirements
          type: string
        accountNumber:
          description: >-
            Optional identifier of the account as defined by the data holder. 
            This must be the value presented on physical statements (if it
            exists) and must not be used for the value of accountId
          type: string
        displayName:
          description: >-
            An optional display name for the account if one exists or can be
            derived.  The content of this field is at the discretion of the data
            holder
          type: string
        openStatus:
          default: OPEN
          description: >-
            Open or closed status for the account. If not present then OPEN is
            assumed
          enum:
            - CLOSED
            - OPEN
          type: string
        creationDate:
          description: >-
            The date that the account was created or opened. Mandatory if
            openStatus is OPEN
          type: string
          x-cds-type: DateString
      required:
        - accountId
      type: object
      x-conditional:
        - creationDate
    EnergyAccountV2_allOf:
      description: The array of plans containing service points and associated plan details
      properties:
        plans:
          description: >-
            The array of plans containing service points and associated plan
            details
          items:
            $ref: '#/components/schemas/EnergyAccountV2_allOf_plans'
          type: array
      required:
        - plans
      type: object
    EnergyAccountV2_allOf_plans:
      properties:
        nickname:
          description: >-
            Optional display name for the plan provided by the customer to help
            differentiate multiple plans
          type: string
        servicePointIds:
          description: >-
            An array of servicePointIds, representing NMIs, that this plan is
            linked to.  If there are no service points allocated to this plan
            then an empty array would be expected
          items:
            type: string
          type: array
        planOverview:
          $ref: '#/components/schemas/EnergyAccountV2_allOf_planOverview'
      required:
        - servicePointIds
      type: object
      x-conditional:
        - planOverview
    EnergyAccountV2_allOf_planOverview:
      description: Mandatory if openStatus is OPEN
      properties:
        displayName:
          description: The name of the plan if one exists
          type: string
        startDate:
          description: The start date of the applicability of this plan
          type: string
          x-cds-type: DateString
        endDate:
          description: The end date of the applicability of this plan
          type: string
          x-cds-type: DateString
      required:
        - startDate
      type: object
  responses:
    responseErrorCustomerIdNotFound:
      description: The customer ID in the URL path is invalid or not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GenericError'
            example:
              error: Customer not found
  securitySchemes:
    bearerAuth:
      description: >
        The Fiskil Data Provider will include a self-signed JWT as a Bearer
        token in the `Authorization` header.

        You should verify this JWT using the JWKS URL you can find for your Data
        Provider instance in the Fiskil

        Console. To verify the JWT you **must**:
          * Verify the signature
          * Ensure the token has not expired by checking the `exp` claim
          * The `sub` and `iss` claims are your data provider subdomain
          * The `aud` claim is the URI of the resource being requested (excluding any query parameters)
          * The `jti` value is unique
        For further detail on security and authentication refer to our
        [Authentication](/docs/get-started/authentication) documentation
      type: http
      scheme: bearer
      bearerFormat: JWT

````