EnergyAustralia CDR Energy Plans API

openapi: 3.0.3
info:
  contact:
    email: contact@dsb.gov.au
    name: Data Standards Body
    url: https://dsb.gov.au/
  description: Specifications for resource endpoints applicable to data holders in the Energy sector.
  title: CDR Energy API
  version: 1.36.0
servers:
- description: MTLS
  url: https://mtls.dh.example.com/cds-au/v1
tags:
- description: Energy Plan endpoints
  name: Energy Plans
  x-shortName: Plans
- description: Electricity Service Point endpoints
  name: Electricity Service Points
  x-shortName: Service Points
- description: Electricity Usage endpoints
  name: Electricity Usage
  x-shortName: Usage
- description: Distributed Energy Resource endpoints
  name: Distributed Energy Resources
  x-shortName: Distributed Energy Resources
- description: Energy Account endpoints
  name: Energy Accounts
  x-shortName: Accounts
- description: Energy Account Balance endpoints
  name: Energy Account Balances
  x-shortName: Account Balances
- description: Energy Account Billing endpoints
  name: Energy Account Billing
  x-shortName: Billing
paths:
  /energy/plans:
    get:
      description: 'Obtain a list of energy plans that are currently offered to the market.


        Note that the results returned by this endpoint are expected to be ordered in descending order
        according to _lastUpdated_.'
      operationId: listEnergyPlans
      parameters:
      - description: Used to filter results on the _type_ field. Any one of the valid values for this
          field can be supplied plus `ALL`. If absent defaults to `ALL`.
        explode: true
        in: query
        name: type
        required: false
        schema:
          default: ALL
          enum:
          - STANDING
          - MARKET
          - REGULATED
          - ALL
          type: string
        style: form
      - description: Used to filter results on the _fuelType_ field. Any one of the valid values for this
          field can be supplied plus `ALL`. If absent defaults to `ALL`.
        explode: true
        in: query
        name: fuelType
        required: false
        schema:
          default: ALL
          enum:
          - ELECTRICITY
          - GAS
          - DUAL
          - ALL
          type: string
        style: form
      - description: Allows for the filtering of plans based on whether the current time is within the
          period of time defined as effective by the _effectiveFrom_ and _effectiveTo_ fields. Valid values
          are `CURRENT`, `FUTURE` and `ALL`. If absent defaults to `CURRENT`.
        explode: true
        in: query
        name: effective
        required: false
        schema:
          default: CURRENT
          enum:
          - CURRENT
          - FUTURE
          - ALL
          type: string
        style: form
      - description: Only include plans that have been updated after the specified date and time. If absent
          defaults to include all plans.
        explode: true
        in: query
        name: updated-since
        required: false
        schema:
          type: string
        style: form
        x-cds-type: DateTimeString
      - description: Used to filter results on the _brand_ field. If absent defaults to include all plans.
        explode: true
        in: query
        name: brand
        required: false
        schema:
          type: string
        style: form
      - 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
      - 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
      - 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
      - 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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnergyPlanListResponse'
          description: Successful response
          headers:
            x-v:
              $ref: '#/components/headers/XV'
        '400':
          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>
        '406':
          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>
        '422':
          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>
      servers:
      - description: TLS
        url: https://tls.dh.example.com/cds-au/v1
      summary: Get Generic Plans
      tags:
      - Energy Plans
      x-version: '1'
  /energy/plans/{planId}:
    get:
      description: 'Obtain detailed information on a single energy plan offered openly to the market.


        Other Versions: [v1](includes/obsolete/get-generic-plan-detail-v1.html), [v2](includes/obsolete/get-generic-plan-detail-v2.html).'
      operationId: getEnergyPlanDetail
      parameters:
      - description: ID of the specific plan requested.
        explode: false
        in: path
        name: planId
        required: true
        schema:
          $ref: '#/components/schemas/EnergyPlanId'
        style: simple
      - 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
      - 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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnergyPlanResponseV3'
          description: Successful response
          headers:
            x-v:
              $ref: '#/components/headers/XV'
        '400':
          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>
        '404':
          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>
        '406':
          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>
      servers:
      - description: TLS
        url: https://tls.dh.example.com/cds-au/v1
      summary: Get Generic Plan Detail
      tags:
      - Energy Plans
      x-version: '3'
      x-version-notes: The <i>dailySupplyChargeType</i> field was added in endpoint v3 as part of Standards
        v1.30.0. In Standards v1.32.0, the description of that field was changed to remove the default
        value, but it did not result in a new endpoint version. Refer to the [v1.32.0 release notes](includes/releasenotes/releasenotes.1.32.0.html)
        for more details.
  /energy/electricity/servicepoints:
    get:
      description: 'Obtain a list of service points owned by the customer that has authorised the current
        session.


        Other Versions: [v1](includes/obsolete/get-service-points-v1.html).'
      operationId: listElectricityServicePoints
      parameters:
      - 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
      - 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
      - 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
      - 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
      - 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
      - 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
      - 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
      - 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-conditional: true
        x-cds-type: Base64
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnergyServicePointListResponseV2'
          description: Successful response
          headers:
            x-v:
              $ref: '#/components/headers/XV'
            x-fapi-interaction-id:
              $ref: '#/components/headers/XFAPIInteractionId'
        '400':
          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'
        '406':
          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'
        '422':
          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'
      summary: Get Service Points
      tags:
      - Electricity Service Points
      x-scopes:
      - energy:electricity.servicepoints.basic:read
      x-version: '2'
  /energy/electricity/servicepoints/{servicePointId}:
    get:
      description: 'Obtain detailed standing information for a specific service point that is owned by
        the customer that has authorised the current session.


        Other Versions: [v1](includes/obsolete/get-service-point-detail-v1.html).'
      operationId: getElectricityServicePointDetail
      parameters:
      - 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
      - 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
      - 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
      - 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
      - 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
      - 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
      - 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-conditional: true
        x-cds-type: Base64
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnergyServicePointDetailResponseV2'
          description: Successful response
          headers:
            x-v:
              $ref: '#/components/headers/XV'
            x-fapi-interaction-id:
              $ref: '#/components/headers/XFAPIInteractionId'
        '400':
          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'
        '404':
          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'
        '406':
          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'
      summary: Get Service Point Detail
      tags:
      - Electricity Service Points
      x-scopes:
      - energy:electricity.servicepoints.detail:read
      x-version: '2'
  /energy/electricity/servicepoints/{servicePointId}/usage:
    get:
      description: Obtain a list of electricity usage data from a particular service point.
      operationId: getElectricityServicePointUsage
      parameters:
      - 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
      - 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
      - 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
      - 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
      - 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
      - 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
      - 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
      - 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
      - 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
      - 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
      - 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
      - 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-conditional: true
        x-cds-type: Base64
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnergyUsageListResponse'
          description: Successful response
          headers:
            x-v:
              $ref: '#/components/headers/XV'
            x-fapi-interaction-id:
              $ref: '#/components/headers/XFAPIInteractionId'
        '400':
          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'
        '404':
          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'
        '406':
          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'
        '422':
          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'
      summary: Get Usage For Service Point
      tags:
      - Electricity Usage
      x-scopes:
      - energy:electricity.usage:read
      x-version: '1'
  /energy/electricity/servicepoints/usage:
    get:
      description: Obtain usage data for all service points associated with the customer.
      operationId: listElectricityUsageBulk
      parameters:
      - 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
      - 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: s

# --- truncated at 32 KB (332 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/energyaustralia/refs/heads/main/openapi/energyaustralia-cds-energy-api-openapi.yml