Energy Queensland
Ergon Energy Retail CDR Energy Product Reference Data API

The unauthenticated Consumer Data Right Product Reference Data surface for Energy Queensland's retail brand, Ergon Energy Retail - Get Generic Plans and Get Generic Plan Detail from the Consumer Data Standards CDR Energy API. In CDR energy, unlike CDR banking, generic plan data is not served by the data holder's own host: it is served centrally by the Australian Energy Regulator's Energy Made Easy CDR host under a per-brand path, and the ACCC CDR Register exposes that path as productBaseUri from register version x-v 2 onwards. Confirmed live 2026-07-27: GET /cds-au/v1/energy/plans with header x-v 1 returned HTTP 200 and meta.totalRecords 36 with meta.totalPages 36; the first record is planId ERG1064038RRE1@EME, brand "ergon", brandName "Ergon Energy", fuelType ELECTRICITY, type REGULATED, geography.distributors ["Ergon"] with several hundred regional Queensland postcodes. Plan detail requires x-v 3 or higher - x-v 1 returns urn:au-cds:error:cds-all:Header/UnsupportedVersion with HTTP 406, x-v 3 returns HTTP 200. The plan type is worth noting: Ergon Energy Retail sells Queensland government notified prices in regional Queensland, so these 36 plans are REGULATED rather than MARKET offers. No API key, no signup and no accreditation is needed to call it.
Documentation GitHub OpenAPI
OpenAPI Specification

# Provenance: This is the shared DSB Consumer Data Standards "CDR Energy API"
# (cds_energy) v1.36.0, harvested verbatim on 2026-07-27 from the Data Standards
# Body at https://consumerdatastandardsaustralia.github.io/standards/includes/swagger/cds_energy.json
# (HTTP 200). NOT an Energy-Queensland-proprietary specification. Energy Queensland,
# Ergon Energy Retail, Ergon Energy Network and Energex publish no OpenAPI of their own.
#
# Energy Queensland's retail subsidiary, Ergon Energy Retail (Ergon Energy Queensland
# Pty Ltd, ABN 11121177802), is a designated Consumer Data Right energy data holder and
# implements this contract. The two Energy Plans paths in this document are served
# anonymously for the "ergon" brand by the Australian Energy Regulator's Energy Made
# Easy CDR host - CONFIRMED LIVE 2026-07-27:
#   GET https://cdr.energymadeeasy.gov.au/ergon/cds-au/v1/energy/plans (HTTP 200, x-v: 1,
#       meta.totalRecords 36, first planId ERG1064038RRE1@EME, type REGULATED)
#   GET https://cdr.energymadeeasy.gov.au/ergon/cds-au/v1/energy/plans/ERG1064038RRE1@EME
#       (HTTP 406 at x-v: 1 with urn:au-cds:error:cds-all:Header/UnsupportedVersion;
#        HTTP 200 at x-v: 3)
# The remaining sixteen paths - service points, electricity usage, distributed energy
# resources, accounts, balances, invoices, billing, concessions and payment schedules -
# are consumer-authorised and reachable only by an ACCC-accredited data recipient over
# mutual TLS. They were NOT called. The Ergon Energy Retail CDR resource host
# api.cdr.ergonretail.com.au does resolve and its TLS server hello includes a
# "Request CERT" message with a private CDR certificate chain, which is behavioural
# evidence of the mTLS gate but is not a call to any endpoint.
#
# The Energy Queensland DISTRIBUTION businesses (Energex, Ergon Energy Network) are NOT
# CDR data holders - the energy designation names retailers, with AEMO as secondary data
# holder - and they implement no part of this document.
components:
  headers:
    XFAPIInteractionId:
      description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder **MUST**
        play back this value in the _x-fapi-interaction-id_ response header. If not provided a **[[RFC4122]](#nref-RFC4122)**
        UUID value is required to be provided in the response header to track the interaction.
      explode: false
      required: true
      schema:
        type: string
      style: simple
    XV:
      description: The [payload version](#response-headers) that the endpoint has responded with.
      explode: false
      required: true
      schema:
        type: string
      style: simple
  parameters:
    HeaderXCDSClientHeaders:
      description: The customer's original standard http headers [Base64](#common-field-types) encoded, including the original
        User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls.
        Not required for unattended or unauthenticated calls.
      explode: false
      in: header
      name: x-cds-client-headers
      required: false
      schema:
        type: string
      style: simple
      x-cds-type: Base64
      x-conditional: true
    HeaderXFAPIAuthDate:
      description: The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**.
        Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
      explode: false
      in: header
      name: x-fapi-auth-date
      required: false
      schema:
        type: string
      style: simple
      x-conditional: true
    HeaderXFAPICustomerIPAddress:
      description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence
        of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated
        calls.
      explode: false
      in: header
      name: x-fapi-customer-ip-address
      required: false
      schema:
        type: string
      style: simple
    HeaderXFAPIInteractionId:
      description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder **MUST**
        play back this value in the _x-fapi-interaction-id_ response header. If not provided a **[[RFC4122]](#nref-RFC4122)**
        UUID value is required to be provided in the response header to track the interaction.
      explode: false
      in: header
      name: x-fapi-interaction-id
      required: false
      schema:
        type: string
      style: simple
    HeaderXMinV:
      description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided.
        The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers).
        If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.
      explode: false
      in: header
      name: x-min-v
      required: false
      schema:
        type: string
      style: simple
    HeaderXV:
      description: Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should
        respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If
        the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then
        the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported
        then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).
      explode: false
      in: header
      name: x-v
      required: true
      schema:
        type: string
      style: simple
    PathAccountId:
      description: The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints.
      explode: false
      in: path
      name: accountId
      required: true
      schema:
        $ref: '#/components/schemas/EnergyAccountId'
      style: simple
    PathServicePointId:
      description: The _servicePointId_ to obtain data for. _servicePointId_ values are returned by service point list endpoints.
        Note that it is not a _nationalMeteringId_.
      explode: false
      in: path
      name: servicePointId
      required: true
      schema:
        $ref: '#/components/schemas/EnergyServicePointId'
      style: simple
    QueryEnergyAccountOpenStatus:
      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
    QueryEnergyIntervalReads:
      description: Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults
        to `NONE`.
      explode: true
      in: query
      name: interval-reads
      required: false
      schema:
        default: NONE
        enum:
        - NONE
        - MIN_30
        - FULL
        type: string
      style: form
    QueryNewestDate:
      description: Constrain the request to records with effective date at or before this date. If absent defaults to current
        date. Format is aligned to DateString common type.
      explode: true
      in: query
      name: newest-date
      required: false
      schema:
        type: string
      style: form
      x-cds-type: DateString
    QueryNewestDateInvoices:
      description: Constrain the request to records with issue date at or before this date. If absent defaults to current
        date. Format is aligned to DateString common type.
      explode: true
      in: query
      name: newest-date
      required: false
      schema:
        type: string
      style: form
      x-cds-type: DateString
    QueryNewestTime:
      description: Constrain the request to records with effective time at or before this date/time. If absent defaults to
        current date/time. Format is aligned to DateTimeString common type.
      explode: true
      in: query
      name: newest-time
      required: false
      schema:
        type: string
      style: form
      x-cds-type: DateTimeString
    QueryOldestDate:
      description: Constrain the request to records with effective date at or after this date. If absent defaults to _newest-date_
        minus 24 months. Format is aligned to DateString common type.
      explode: true
      in: query
      name: oldest-date
      required: false
      schema:
        type: string
      style: form
      x-cds-type: DateString
    QueryOldestDateInvoices:
      description: Constrain the request to records with issue date at or after this date. If absent defaults to _newest-date_
        minus 24 months. Format is aligned to DateString common type.
      explode: true
      in: query
      name: oldest-date
      required: false
      schema:
        type: string
      style: form
      x-cds-type: DateString
    QueryOldestTime:
      description: Constrain the request to records with effective time at or after this date/time. If absent defaults to
        _newest-time_ minus 12 months. Format is aligned to DateTimeString common type.
      explode: true
      in: query
      name: oldest-time
      required: false
      schema:
        type: string
      style: form
      x-cds-type: DateTimeString
    QueryPage:
      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
    QueryPageSize:
      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
  requestBodies:
    RequestAccountIds:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestAccountIdListV1'
      description: Request payload containing a list of _accountId_ values to obtain data for.
      required: true
    RequestServicePointIds:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestServicePointIdListV1'
      description: Request payload containing a list of _servicePointId_ values to obtain data for.
      required: true
  responses:
    GetBillingForEnergyAccount200:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EnergyBillingListResponseV3'
      description: Successful response
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
        x-v:
          $ref: '#/components/headers/XV'
    GetBillingForEnergyAccount400:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400
        - Missing Required Field](#error-400-field-missing)</li><li>[400 - Invalid Date](#error-400-field-invalid-date-time)</li><li>[400
        - Invalid Page Size](#error-400-field-invalid-page-size)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetBillingForEnergyAccount404:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[404 - Unavailable
        Energy Account](#error-404-unavailable-energy-account)</li><li>[404 - Invalid Energy Account](#error-404-invalid-energy-account)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetBillingForEnergyAccount406:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported
        Version](#error-406-header-unsupported-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetBillingForEnergyAccount422:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[422 - Invalid Page](#error-422-field-invalid-page)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityDERForServicePoint200:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EnergyDerDetailResponse'
      description: Successful response
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
        x-v:
          $ref: '#/components/headers/XV'
    GetElectricityDERForServicePoint400:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PrimaryResponseErrorListV1'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400
        - Missing Required Field](#error-400-field-missing)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityDERForServicePoint404:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PrimaryResponseErrorListV1'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[404 - Unavailable
        Service Point](#error-404-unavailable-service-point)</li><li>[404 - Invalid Service Point](#error-404-invalid-service-point)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityDERForServicePoint406:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PrimaryResponseErrorListV1'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported
        Version](#error-406-header-unsupported-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointDetail200:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EnergyServicePointDetailResponseV2'
      description: Successful response
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
        x-v:
          $ref: '#/components/headers/XV'
    GetElectricityServicePointDetail400:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PrimaryResponseErrorListV1'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400
        - Missing Required Field](#error-400-field-missing)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointDetail404:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PrimaryResponseErrorListV1'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[404 - Unavailable
        Service Point](#error-404-unavailable-service-point)</li><li>[404 - Invalid Service Point](#error-404-invalid-service-point)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointDetail406:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PrimaryResponseErrorListV1'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported
        Version](#error-406-header-unsupported-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointUsage200:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EnergyUsageListResponse'
      description: Successful response
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
        x-v:
          $ref: '#/components/headers/XV'
    GetElectricityServicePointUsage400:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PrimaryResponseErrorListV1'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400
        - Missing Required Field](#error-400-field-missing)</li><li>[400 - Invalid Date](#error-400-field-invalid-date-time)</li><li>[400
        - Invalid Page Size](#error-400-field-invalid-page-size)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointUsage404:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PrimaryResponseErrorListV1'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[404 - Unavailable
        Service Point](#error-404-unavailable-service-point)</li><li>[404 - Invalid Service Point](#error-404-invalid-service-point)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointUsage406:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PrimaryResponseErrorListV1'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported
        Version](#error-406-header-unsupported-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointUsage422:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PrimaryResponseErrorListV1'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[422 - Invalid Page](#error-422-field-invalid-page)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountBalance200:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EnergyBalanceResponse'
      description: Successful response
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
        x-v:
          $ref: '#/components/headers/XV'
    GetEnergyAccountBalance400:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400
        - Missing Required Field](#error-400-field-missing)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountBalance404:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[404 - Unavailable
        Energy Account](#error-404-unavailable-energy-account)</li><li>[404 - Invalid Energy Account](#error-404-invalid-energy-account)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountBalance406:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported
        Version](#error-406-header-unsupported-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountConcessions200:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EnergyConcessionsResponse'
      description: Successful response
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
        x-v:
          $ref: '#/components/headers/XV'
    GetEnergyAccountConcessions400:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400
        - Missing Required Field](#error-400-field-missing)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountConcessions404:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[404 - Unavailable
        Energy Account](#error-404-unavailable-energy-account)</li><li>[404 - Invalid Energy Account](#error-404-invalid-energy-account)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountConcessions406:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported
        Version](#error-406-header-unsupported-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountDetail200:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EnergyAccountDetailResponseV4'
      description: Successful response
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
        x-v:
          $ref: '#/components/headers/XV'
    GetEnergyAccountDetail400:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400
        - Missing Required Field](#error-400-field-missing)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountDetail404:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[404 - Unavailable
        Energy Account](#error-404-unavailable-energy-account)</li><li>[404 - Invalid Energy Account](#error-404-invalid-energy-account)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountDetail406:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported
        Version](#error-406-header-unsupported-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountInvoices200:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EnergyInvoiceListResponse'
      description: Successful response
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
        x-v:
          $ref: '#/components/headers/XV'
    GetEnergyAccountInvoices400:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400
        - Missing Required Field](#error-400-field-missing)</li><li>[400 - Invalid Date](#error-400-field-invalid-date-time)</li><li>[400
        - Invalid Page Size](#error-400-field-invalid-page-size)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountInvoices404:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[404 - Unavailable
        Energy Account](#error-404-unavailable-energy-account)</li><li>[404 - Invalid Energy Account](#error-404-invalid-energy-account)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountInvoices406:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported
        Version](#error-406-header-unsupported-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountInvoices422:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[422 - Invalid Page](#error-422-field-invalid-page)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountPaymentSchedule200:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EnergyPaymentScheduleResponse'
      description: Successful response
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
        x-v:
          $ref: '#/components/headers/XV'
    GetEnergyAccountPaymentSchedule400:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400
        - Missing Required Field](#error-400-field-missing)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountPaymentSchedule404:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[404 - Unavailable
        Energy Account](#error-404-unavailable-energy-account)</li><li>[404 - Invalid Energy Account](#error-404-invalid-energy-account)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountPaymentSchedule406:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported
        Version](#error-406-header-unsupported-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyPlanDetail200:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EnergyPlanResponseV3'
      description: Successful response
      headers:
        x-v:
          $ref: '#/components/headers/XV'
    GetEnergyPlanDetail400:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400
        - Missing Required Field](#error-400-field-missing)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>
    GetEnergyPlanDetail404:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[404 - Invalid Resource](#error-404-resource-invalid)</li></ul>
    GetEnergyPlanDetail406:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseErrorListV2'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported
        Version](#error-406-header-unsupported-version)</li></ul>
    ListElectricityDERBulk200:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EnergyDerListResponse'
      description: Successful response
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
        x-v:
          $ref: '#/components/headers/XV'
    ListElectricityDERBulk400:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PrimaryResponseErrorListV1'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400
        - Missing Required Field](#error-400-field-missing)</li><li>[400 - Invalid Page Size](#error-400-field-invalid-page-size)</li><li>[400
        - Invalid Version](#error-400-header-invalid-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListElectricityDERBulk406:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PrimaryResponseErrorListV1'
      description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported
        Version](#error-406-header-unsupported-version)</li></ul>
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListElectricityDERBulk422:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PrimaryResponseErrorListV1'
      description: The following error co

# --- truncated at 32 KB (331 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/energy-queensland/refs/heads/main/openapi/energy-queensland-cds-energy-openapi.yml
Ergon Energy Retail CDR Energy Product Reference Data API

Documentation

Specifications

Other Resources

OpenAPI Specification
