openapi: 3.0.2
info:
  contact:
    email: hello@biza.io
    name: Biza.io
    url: https://biza.io/
  description: |
    This is the OpenAPI specification for the Open Gateway
  license:
    name: Commercial
    url: https://biza.io/
  title: Biza OG API (OpenAPI Client)
  version: 1.36.0
servers:
  - url: https://og.biza.io/dio-au/v1
tags:
  - name: Agreement
    description: APIs related to individual agreements
  - name: Agreement Template
    description: APIs related to agreement templates
  - name: 'CDR: Actions'
    description: Actions to be executed against CDR based participants
  - name: 'CDR: Banking'
    description: >-
      APIs reflecting those made available via the Consumer Data Right for the
      Banking sector
  - name: 'CDR: Common'
    description: Common APIs made available within the Consumer Data Right
  - name: 'CDR: Energy'
    description: >-
      APIs reflecting those made available via the Consumer Data Right for the
      Energy sector
  - name: 'CDR: Public'
    description: Publicly available APIs made available within the Consumer Data Right
  - name: DCR
    description: APIs related to Dynamic Client Registration
  - name: Directory
    description: APIs related to directory availability and participants
  - name: DR+ Energy Account Switch
    description: DR+ Energy Account Switch Apis
  - name: DR+ Data Sharing
    description: DR+ Data Sharing Apis
  - name: Illion
    description: Illion Credit Report APIs
  - name: Principal
    description: APIs related to specific principals
  - name: Callback
    description: APIs that OG calls back to reach out to software products
externalDocs:
  description: Read more about the Biza Open Gateway on Biza Guides
  url: https://guides.biza.io
paths:
  /directory:
    get:
      description: Retrieve a list of directories available
      operationId: listDirectories
      parameters:
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
      responses:
        '200':
          $ref: '#/components/responses/ListDirectories'
        '400':
          $ref: '#/components/responses/Generic400'
        '401':
          $ref: '#/components/responses/Generic401'
      summary: List Directories
      tags:
        - Directory
      security:
        - TokenBasedAuth:
            - biza-au:og:directory:read
  /directory/{directoryId}/participant:
    get:
      summary: List Participants
      description: Obtain a collated list of participants available
      operationId: listParticipants
      parameters:
        - $ref: '#/components/parameters/PathDirectoryId'
        - $ref: '#/components/parameters/QueryParticipantCapability'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      responses:
        '200':
          $ref: '#/components/responses/ListParticipants'
        '404':
          $ref: '#/components/responses/ListParticipants404'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - Directory
      security:
        - TokenBasedAuth:
            - biza-au:og:directory:read
  /directory/{directoryId}/action/cds-au/cdr-sharing-v1/prime:
    post:
      description: Prime a CDR Sharing Agreement
      operationId: primeCDRSharingV1
      summary: Prime a CDR Sharing Arrangement (V1)
      parameters:
        - $ref: '#/components/parameters/PathDirectoryId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      requestBody:
        $ref: '#/components/requestBodies/RequestActionCDRSharingPrime'
      responses:
        '200':
          $ref: '#/components/responses/ActionCDRSharingPrime'
        '400':
          $ref: '#/components/responses/Generic400'
        '406':
          $ref: '#/components/responses/Generic406'
        '422':
          $ref: '#/components/responses/Generic422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - 'CDR: Actions'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:sharing:prime
  /directory/{directoryId}/dio-au/actions/energy-account-switch/{switchId}:
    get:
      description: Retrieve the status of an Energy Account Switch
      operationId: getEnergySwitchStatus
      parameters:
        - $ref: '#/components/parameters/PathDirectoryId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/PathSwitchId'
      responses:
        '200':
          $ref: '#/components/responses/GetEnergySwitchStatus'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/GetEnergySwitchStatus404'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Energy Switch Status
      tags:
        - DR+ Energy Account Switch
      security:
        - TokenBasedAuth:
            - biza-au:og:dio:action
  /directory/{directoryId}/dio-au/actions/request-energy-account-switch:
    get:
      description: Endpoint to list energy account switch actions
      operationId: listEnergySwitchRequest
      summary: List Energy Switches
      parameters:
        - $ref: '#/components/parameters/PathDirectoryId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      responses:
        '200':
          $ref: '#/components/responses/ListEnergyAccountSwitch'
        '400':
          $ref: '#/components/responses/Generic400'
        '406':
          $ref: '#/components/responses/Generic406'
        '422':
          $ref: '#/components/responses/Generic422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - DR+ Energy Account Switch
      security:
        - TokenBasedAuth:
            - biza-au:og:dio:action
  /directory/{directoryId}/dio-au/actions/request-energy-account-switch/{actionId}:
    get:
      description: Retrieve an Energy Account Switch request
      operationId: getEnergySwitchRequest
      parameters:
        - $ref: '#/components/parameters/PathDirectoryId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/PathActionId'
      responses:
        '200':
          $ref: '#/components/responses/GetEnergySwitchRequest'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/GetEnergySwitchStatus404'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Energy Switch Request
      tags:
        - DR+ Energy Account Switch
      security:
        - TokenBasedAuth:
            - biza-au:og:dio:action
  /directory/{directoryId}/participant/{participantId}/action/cds-au/registration:
    post:
      description: >-
        Perform a Dynamic Client Registration for a specified participant
        contained within a specified directory
      operationId: dcrRegister
      summary: Dynamic Client Registration
      parameters:
        - $ref: '#/components/parameters/PathDirectoryId'
        - $ref: '#/components/parameters/PathParticipantId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      requestBody:
        $ref: '#/components/requestBodies/RequestActionCDRRegistration'
      responses:
        '201':
          $ref: '#/components/responses/ActionCDRRegistration'
        '400':
          $ref: '#/components/responses/DCRRegister400'
        '500':
          $ref: '#/components/responses/Generic500'
      tags:
        - DCR
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:registration:write
  /directory/{directoryId}/participant/{participantId}/action/cds-au/registration/{clientId}:
    get:
      description: >-
        Get a Client Registration for a specified participant contained within a
        specified directory
      operationId: dcrGet
      summary: Get a Client Registration
      parameters:
        - $ref: '#/components/parameters/PathDirectoryId'
        - $ref: '#/components/parameters/PathParticipantId'
        - $ref: '#/components/parameters/PathClientId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      responses:
        '200':
          $ref: '#/components/responses/ActionCDRRegistration'
        '403':
          $ref: '#/components/responses/Generic403'
        '500':
          $ref: '#/components/responses/Generic500'
      tags:
        - DCR
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:registration:read
    post:
      description: >-
        Update a Dynamic Client Registration for a specified participant
        contained within a specified directory
      operationId: dcrUpdate
      summary: Update a Client Registration
      parameters:
        - $ref: '#/components/parameters/PathDirectoryId'
        - $ref: '#/components/parameters/PathParticipantId'
        - $ref: '#/components/parameters/PathClientId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      requestBody:
        $ref: '#/components/requestBodies/RequestActionCDRRegistration'
      responses:
        '200':
          $ref: '#/components/responses/ActionCDRRegistration'
        '403':
          $ref: '#/components/responses/Generic403'
        '500':
          $ref: '#/components/responses/Generic500'
      tags:
        - DCR
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:registration:write
    delete:
      description: >-
        Delete a Client Registration for a specified participant contained
        within a specified directory
      operationId: dcrDelete
      summary: Delete a Client Registration
      parameters:
        - $ref: '#/components/parameters/PathDirectoryId'
        - $ref: '#/components/parameters/PathParticipantId'
        - $ref: '#/components/parameters/PathClientId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      responses:
        '204':
          description: Client deleted
        '403':
          $ref: '#/components/responses/Generic403'
        '500':
          $ref: '#/components/responses/Generic500'
      tags:
        - DCR
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:registration:delete
  /directory/{directoryId}/participant/{participantId}/cds-au/banking/products:
    get:
      description: >-
        Obtain a list of products that are currently openly offered to the
        market

        Will be implemented in a future release. See Biza Developer guides for
        future plans.


        Note that the results returned by this end point are expected to be
        ordered in descending order according to `lastUpdated`


        ### Conventions

        In the product reference payloads there are a number of recurring
        conventions that are explained here, in one place.


        #### Arrays Of Features


        In the product detail payload there are a number of arrays articulating
        generic features, constraints, prices, etc. The intent of these arrays
        is as follows:


        - Each element in an array has the same structure so that clients can
        reliably interpret the payloads

        - Each element as a type element that is an enumeration of the specific
        aspect of a product being described, such as types of fees.

        - Each element has a field name
        [additionalValue](https://consumerdatastandardsaustralia.github.io/standards/#productfeaturetypedoc).
        This is a generic field with contents that will vary based on the type
        of object being described. The contents of this field for the
        ADDITIONAL_CARDS feature is the number of cards allowed while the
        contents of this field for the MAX_LIMIT constraint would be the maximum
        credit limit allowed for the product.

        - An element in these arrays of the same type may appear more than once.
        For instance, a product may offer two separate loyalty programs that the
        customer can select from. A fixed term mortgage may have different rates
        for different term lengths.

        - An element in these arrays may contain an additionalInfo and
        additionalInfoUri field. The additionalInfo field is used to provide
        displayable text clarifying the purpose of the element in some way when
        the product is presented to a customer. The additionalInfoUri provides a
        link to externally hosted information specifically relevant to that
        feature of the product.

        - Depending on the type of data being represented there may be
        additional specific fields.


        #### URIs To More Information


        As the complexities and nuances of a financial product can not easily be
        fully expressed in a data structure without a high degree of complexity
        it is necessary to provide additional reference information that a
        potential customer can access so that they are fully informed of the
        features and implications of the product. The payloads for product
        reference therefore contain numerous fields that are provided to allow
        the product holder to describe the product more fully using a web page
        hosted on their online channels.


        These URIs do not need to all link to different pages. If desired, they
        can all link to a single hosted page and use difference HTML anchors to
        focus on a specific topic such as eligibility or fees.


        #### Linkage To Accounts

        From the moment that a customer applies for a product and an account is
        created the account and the product that spawned it will diverge.  Rates
        and features of the product may change and a discount may be negotiated
        for the account.


        For this reason, while productCategory is a common field between
        accounts and products, there is no specific ID that can be used to link
        an account to a product within the regime.


        Similarly, many of the fields and objects in the product payload will
        appear in the account detail payload but the structures and semantics
        are not identical as one refers to a product that can potentially be
        originated and one refers to an account that actual has been
        instantiated and created along with the associated decisions inherent in
        that process.


        #### Dates

        It is expected that data consumers needing this data will call
        relatively frequently to ensure the data they have is representative of
        the current offering from a bank.  To minimise the volume and frequency
        of these calls the ability to set a lastUpdated field with the date and
        time of the last update to this product is included.  A call for a list
        of products can then be filtered to only return products that have been
        updated since the last time that data was obtained using the
        updated-since query parameter.


        In addition, the concept of effective date and time has also been
        included.  This allows for a product to be marked for obsolescence, or
        introduction, from a certain time without the need for an update to show
        that a product has been changed.  The inclusion of these dates also
        removes the need to represent deleted products in the payload.  Products
        that are no long offered can be marked not effective for a few weeks
        before they are then removed from the product set as an option entirely.
      operationId: listBankingProducts
      parameters:
        - $ref: '#/components/parameters/PathDirectoryId'
        - $ref: '#/components/parameters/PathParticipantId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/QueryProductEffective'
        - $ref: '#/components/parameters/QueryUpdatedSince'
        - $ref: '#/components/parameters/QueryProductBrand'
        - $ref: '#/components/parameters/QueryProductCategory'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
      responses:
        '200':
          $ref: '#/components/responses/ListBankingProducts'
        '400':
          $ref: '#/components/responses/ListProducts400'
        '406':
          $ref: '#/components/responses/ListProducts406'
        '422':
          $ref: '#/components/responses/ListProducts422'
        '500':
          $ref: '#/components/responses/Generic500'
        '501':
          description: Not implemented.
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Banking Products
      tags:
        - 'CDR: Public'
      security:
        - TokenBasedAuth: []
  /directory/{directoryId}/participant/{participantId}/cds-au/banking/products/{productId}:
    get:
      summary: Get Banking Product Detail
      description: >-
        Obtain detailed information on a single product offered openly to the
        market. Will be implemented in a future release. See Biza Developer
        guides for future plans.
      operationId: getBankingProductDetail
      parameters:
        - $ref: '#/components/parameters/PathDirectoryId'
        - $ref: '#/components/parameters/PathParticipantId'
        - $ref: '#/components/parameters/PathProductId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
      responses:
        '200':
          $ref: '#/components/responses/GetBankingProductDetail'
        '400':
          $ref: '#/components/responses/GetProductDetail400'
        '404':
          $ref: '#/components/responses/GetProductDetail404'
        '406':
          $ref: '#/components/responses/GetProductDetail406'
        '500':
          $ref: '#/components/responses/Generic500'
        '501':
          description: Not implemented.
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - 'CDR: Public'
      security:
        - TokenBasedAuth: []
  /directory/{directoryId}/participant/{participantId}/cds-au/discovery/outages:
    get:
      description: >-
        Obtain a list of scheduled outages for the implementation. Will be
        implemented in a future release. See Biza Developer guides for future
        plans.
      operationId: getOutages
      parameters:
        - $ref: '#/components/parameters/PathDirectoryId'
        - $ref: '#/components/parameters/PathParticipantId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
      responses:
        '200':
          $ref: '#/components/responses/GetCommonOutages'
        '400':
          $ref: '#/components/responses/GetOutages400'
        '406':
          $ref: '#/components/responses/GetOutages406'
        '500':
          $ref: '#/components/responses/Generic500'
        '501':
          description: Not implemented.
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Outages
      tags:
        - 'CDR: Public'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:public
  /directory/{directoryId}/participant/{participantId}/cds-au/discovery/status:
    get:
      description: >-
        Obtain a health check status for the implementation. Will be implemented
        in a future release. See Biza Developer guides for future plans.
      operationId: getStatus
      parameters:
        - $ref: '#/components/parameters/PathDirectoryId'
        - $ref: '#/components/parameters/PathParticipantId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
      responses:
        '200':
          $ref: '#/components/responses/GetCommonStatus'
        '400':
          $ref: '#/components/responses/GetStatus400'
        '406':
          $ref: '#/components/responses/GetStatus406'
        '500':
          $ref: '#/components/responses/Generic500'
        '501':
          description: Not implemented.
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Status
      tags:
        - 'CDR: Public'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:public
  /directory/{directoryId}/participant/{participantId}/dio-au/actions/request-energy-account-switch:
    post:
      description: >-
        Endpoint to initiate an energy account opening via the DataRight+
        framework
      operationId: initiateEnergySwitch
      summary: Initiate Energy Switch
      parameters:
        - $ref: '#/components/parameters/PathDirectoryId'
        - $ref: '#/components/parameters/PathParticipantId'
        - in: header
          name: x-v
          required: true
          schema:
            $ref: '#/components/schemas/EnumRequestInitiateEnergySwitchV1'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      requestBody:
        $ref: '#/components/requestBodies/RequestInitiateEnergySwitch'
      responses:
        '200':
          $ref: '#/components/responses/OGInitiateEnergySwitch'
        '400':
          $ref: '#/components/responses/InitiateEnergySwitch400'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/InitiateEnergySwitch404'
        '406':
          $ref: '#/components/responses/InitiateEnergySwitch406'
        '422':
          $ref: '#/components/responses/InitiateEnergySwitch422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - DR+ Energy Account Switch
      security:
        - TokenBasedAuth:
            - biza-au:og:dio:action
  /principal/{principalId}/agreement/{agreementId}/dio-au/action/arrangement-v2/status:
    get:
      description: Retrieve the status of Arrangement V2
      operationId: getArrangementV2Status
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseGetSharingRequestV2'
          headers:
            x-fapi-interaction-id:
              $ref: '#/components/headers/XFAPIInteractionId'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/GetSharingRequest404'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Sharing Request
      tags:
        - DR+ Data Sharing
      security:
        - TokenBasedAuth:
            - biza-au:og:dio:sharing
  /principal:
    get:
      description: Retrieve a list of principals
      operationId: listPrincipals
      parameters:
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
      responses:
        '200':
          $ref: '#/components/responses/ListPrincipals'
        '400':
          $ref: '#/components/responses/Generic400'
        '401':
          $ref: '#/components/responses/Generic401'
      summary: List Principals
      tags:
        - Principal
      security:
        - TokenBasedAuth:
            - biza-au:og:agreement:read
  /principal/{principalId}:
    get:
      summary: Get Principal Detail
      description: Obtain information about a specific principal
      operationId: getPrincipalDetail
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      responses:
        '200':
          $ref: '#/components/responses/GetPrincipalDetail'
        '404':
          $ref: '#/components/responses/GetPrincipalDetail404'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - Principal
      security:
        - TokenBasedAuth:
            - biza-au:og:agreement:read
  /principal/{principalId}/user:
    get:
      summary: List Principal Users
      description: Obtain a list of users for a specific principal
      operationId: getPrincipalUsers
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      responses:
        '200':
          $ref: '#/components/responses/ListPrincipalUsers'
        '404':
          $ref: '#/components/responses/ListPrincipalUsers404'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - Principal
      security:
        - TokenBasedAuth:
            - biza-au:og:agreement:read
  /principal/{principalId}/agreement:
    get:
      description: Retrieve a list of agreements
      operationId: listAgreements
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/QueryAgreementStatus'
        - $ref: '#/components/parameters/QueryRevision'
        - $ref: '#/components/parameters/QueryCDRArrangementId'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      responses:
        '200':
          $ref: '#/components/responses/ListAgreements'
        '400':
          $ref: '#/components/responses/Generic400'
        '401':
          $ref: '#/components/responses/Generic401'
      summary: List Agreements
      tags:
        - Agreement
      security:
        - TokenBasedAuth:
            - biza-au:og:agreement:read
  /principal/{principalId}/agreement/{agreementId}:
    get:
      summary: Get Agreement Detail
      description: Obtain information about a specific agreement
      operationId: getAgreement
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      responses:
        '200':
          $ref: '#/components/responses/GetAgreementDetail'
        '404':
          $ref: '#/components/responses/ListParticipants404'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - Agreement
      security:
        - TokenBasedAuth:
            - biza-au:og:agreement:read
    delete:
      description: >-
        Initiates an agreement termination. As agreements can be many different
        types this has various meanings. For CDR Sharing Arrangements this
        triggers the revocation action from the Data Recipient to the Data
        Holder.
      operationId: terminateAgreement
      summary: Terminate an Agreement
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      responses:
        '200':
          $ref: '#/components/responses/GetAgreementDetail'
        '400':
          $ref: '#/components/responses/Generic400'
        '403':
          $ref: '#/components/responses/Generic403'
        '500':
          $ref: '#/components/responses/Generic500'
      tags:
        - Agreement
      security:
        - TokenBasedAuth:
            - biza-au:og:agreement:delete
  /principal/{principalId}/agreement/{agreementId}/cds-au/banking/accounts:
    get:
      summary: Get Accounts
      description: Obtain a list of accounts
      operationId: listBankingAccounts
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryProductCategory'
        - $ref: '#/components/parameters/QueryAccountOpenStatus'
        - $ref: '#/components/parameters/QueryAccountIsOwned'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/ListBankingAccounts'
        '400':
          $ref: '#/components/responses/ListBankingAccounts400'
        '403':
          $ref: '#/components/responses/Generic403'
        '406':
          $ref: '#/components/responses/ListBankingAccounts406'
        '422':
          $ref: '#/components/responses/ListBankingAccounts422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - 'CDR: Banking'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:bank:accounts.basic:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/banking/accounts/{accountId}:
    get:
      description: Obtain detailed information on a single account
      operationId: getBankingAccountDetail
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/PathAccountId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/GetBankingAccountDetail'
        '400':
          $ref: '#/components/responses/GetAccountDetail400'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/GetAccountDetail404'
        '406':
          $ref: '#/components/responses/GetAccountDetail406'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Account Detail
      tags:
        - 'CDR: Banking'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:bank:accounts.detail:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/banking/accounts/{accountId}/balance:
    get:
      description: Obtain the balance for a single specified account
      operationId: getBankingBalance
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/PathAccountId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/GetBankingBalance'
        '400':
          $ref: '#/components/responses/GetBalance400'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/GetBalance404'
        '406':
          $ref: '#/components/responses/GetBalance406'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Account Balance
      tags:
        - 'CDR: Banking'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:bank:accounts.basic:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/banking/accounts/{accountId}/scheduled-payments:
    get:
      description: Obtain scheduled, outgoing payments for a specific account
      operationId: listScheduledPayments
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/PathAccountId'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/ListBankingScheduledPayments'
        '400':
          $ref: '#/components/responses/ListScheduledPayments400'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/ListScheduledPayments404'
        '406':
          $ref: '#/components/responses/ListScheduledPayments406'
        '422':
          $ref: '#/components/responses/ListScheduledPayments422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Scheduled Payments for Account
      tags:
        - 'CDR: Banking'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:bank:regular_payments:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/banking/accounts/{accountId}/direct-debits:
    get:
      description: Obtain direct debit authorisations for a specific account
      operationId: listBankingDirectDebits
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/PathAccountId'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/ListBankingDirectDebits'
        '400':
          $ref: '#/components/responses/ListDirectDebits400'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/ListDirectDebits404'
        '406':
          $ref: '#/components/responses/ListDirectDebits406'
        '422':
          $ref: '#/components/responses/ListDirectDebits422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Direct Debits For Account
      tags:
        - 'CDR: Banking'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:bank:regular_payments:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/banking/accounts/{accountId}/transactions:
    get:
      description: >-
        Obtain transactions for a specific account.

        Some general notes that apply to all end points that retrieve
        transactions:
          - Where multiple transactions are returned, transactions should be ordered according to effective date in descending order
          - As the date and time for a transaction can alter depending on status and transaction type two separate date/times are included in the payload. There are still some scenarios where neither of these time stamps is available. For the purpose of filtering and ordering it is expected that the data holder will use the "effective" date/time which will be defined as:
            - Posted date/time if available, then
            - Execution date/time if available, then
            - A reasonable date/time nominated by the data holder using internal data structures
          - For transaction amounts it should be assumed that a negative value indicates a reduction of the available balance on the account while a positive value indicates an increase in the available balance on the account
          - For aggregated transactions (ie. groups of sub transactions reported as a single entry for the account) only the aggregated information, with as much consistent information across the subsidiary transactions as possible, is required to be shared
      operationId: getTransactions
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/PathAccountId'
        - $ref: '#/components/parameters/QueryOldestDateTime'
        - $ref: '#/components/parameters/QueryNewestDateTime'
        - $ref: '#/components/parameters/QueryMinAmount'
        - $ref: '#/components/parameters/QueryMaxAmount'
        - $ref: '#/components/parameters/QueryTransactionText'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/ListBankingTransactions'
        '400':
          $ref: '#/components/responses/GetTransactions400'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/GetTransactions404'
        '406':
          $ref: '#/components/responses/GetTransactions406'
        '422':
          $ref: '#/components/responses/GetTransactions422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Transactions For Account
      tags:
        - 'CDR: Banking'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:bank:transactions:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/banking/accounts/{accountId}/transactions/{transactionId}:
    get:
      description: Obtain detailed information on a transaction for a specific account
      operationId: getTransactionDetail
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/PathAccountId'
        - $ref: '#/components/parameters/PathTransactionId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/GetBankingTransactionDetail'
        '400':
          $ref: '#/components/responses/GetTransactionDetail400'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/GetTransactionDetail404'
        '406':
          $ref: '#/components/responses/GetTransactionDetail406'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Transaction Detail
      tags:
        - 'CDR: Banking'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:bank:transactions:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/banking/payees:
    get:
      description: Obtain a list of pre-registered payees
      operationId: listPayees
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryPayeeType'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/ListBankingPayees'
        '400':
          $ref: '#/components/responses/ListPayees400'
        '403':
          $ref: '#/components/responses/Generic403'
        '406':
          $ref: '#/components/responses/ListPayees406'
        '422':
          $ref: '#/components/responses/ListPayees422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Payees
      tags:
        - 'CDR: Banking'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:bank:payees:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/banking/payees/{payeeId}:
    get:
      description: >-
        Obtain detailed information on a single payee. Note that the payee
        sub-structure should be selected to represent the payment destination
        only rather than any known characteristics of the payment recipient
      operationId: getPayeeDetail
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/PathPayeeId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/GetBankingPayeeDetail'
        '400':
          $ref: '#/components/responses/GetPayeeDetail400'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/GetPayeeDetail404'
        '406':
          $ref: '#/components/responses/GetPayeeDetail406'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Payee Detail
      tags:
        - 'CDR: Banking'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:bank:payees:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/banking/scheduled-payments:
    get:
      description: >-
        Obtain scheduled payments for multiple, filtered accounts that are the
        source of funds for the payments
      operationId: listScheduledPaymentsBulk
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryProductCategory'
        - $ref: '#/components/parameters/QueryAccountOpenStatus'
        - $ref: '#/components/parameters/QueryAccountIsOwned'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/ListBankingScheduledPaymentsBulk'
        '400':
          $ref: '#/components/responses/ListScheduledPaymentsBulk400'
        '403':
          $ref: '#/components/responses/Generic403'
        '406':
          $ref: '#/components/responses/ListScheduledPaymentsBulk406'
        '422':
          $ref: '#/components/responses/ListScheduledPaymentsBulk422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Scheduled Payments Bulk
      tags:
        - 'CDR: Banking'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:bank:regular_payments:read
    post:
      description: Obtain scheduled payments for a specified list of accounts
      operationId: listScheduledPaymentsSpecificAccounts
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      requestBody:
        $ref: '#/components/requestBodies/RequestAccountIds'
      responses:
        '200':
          $ref: '#/components/responses/ListBankingScheduledPaymentsSpecificAccounts'
        '400':
          $ref: '#/components/responses/ListScheduledPaymentsSpecificAccounts400'
        '406':
          $ref: '#/components/responses/ListScheduledPaymentsSpecificAccounts406'
        '422':
          $ref: '#/components/responses/ListScheduledPaymentsSpecificAccounts422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Scheduled Payments For Specific Accounts
      tags:
        - 'CDR: Banking'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:bank:regular_payments:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/banking/direct-debits:
    get:
      description: Obtain direct debit authorisations for multiple, filtered accounts
      operationId: listBankingDirectDebitsBulk
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryProductCategory'
        - $ref: '#/components/parameters/QueryAccountOpenStatus'
        - $ref: '#/components/parameters/QueryAccountIsOwned'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/ListBankingDirectDebitsBulk'
        '400':
          $ref: '#/components/responses/ListDirectDebitsBulk400'
        '403':
          $ref: '#/components/responses/Generic403'
        '406':
          $ref: '#/components/responses/ListDirectDebitsBulk406'
        '422':
          $ref: '#/components/responses/ListDirectDebitsBulk422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Bulk Direct Debits
      tags:
        - 'CDR: Banking'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:bank:regular_payments:read
    post:
      description: Obtain direct debit authorisations for a specified list of accounts
      operationId: listDirectDebitsSpecificAccounts
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      requestBody:
        $ref: '#/components/requestBodies/RequestAccountIds'
      responses:
        '200':
          $ref: '#/components/responses/ListBankingDirectDebitsSpecificAccounts'
        '400':
          $ref: '#/components/responses/ListDirectDebitsSpecificAccounts400'
        '406':
          $ref: '#/components/responses/ListDirectDebitsSpecificAccounts406'
        '422':
          $ref: '#/components/responses/ListDirectDebitsSpecificAccounts422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Direct Debits For Specific Accounts
      tags:
        - 'CDR: Banking'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:bank:regular_payments:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/banking/balances:
    get:
      description: Obtain balances for multiple, filtered accounts
      operationId: listBankingBalancesBulk
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryProductCategory'
        - $ref: '#/components/parameters/QueryAccountOpenStatus'
        - $ref: '#/components/parameters/QueryAccountIsOwned'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/ListBankingBalancesBulk'
        '400':
          $ref: '#/components/responses/ListBalancesBulk400'
        '403':
          $ref: '#/components/responses/Generic403'
        '406':
          $ref: '#/components/responses/ListBalancesBulk406'
        '422':
          $ref: '#/components/responses/ListBalancesBulk422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Bulk Balances
      tags:
        - 'CDR: Banking'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:bank:accounts.basic:read
    post:
      description: Obtain balances for a specified list of accounts
      operationId: listBalancesSpecificBankingAccounts
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      requestBody:
        $ref: '#/components/requestBodies/RequestAccountIds'
      responses:
        '200':
          $ref: '#/components/responses/ListBankingBalancesSpecificAccounts'
        '400':
          $ref: '#/components/responses/ListBalancesSpecificBankingAccounts400'
        '406':
          $ref: '#/components/responses/ListBalancesSpecificBankingAccounts406'
        '422':
          $ref: '#/components/responses/ListBalancesSpecificBankingAccounts422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Balances For Specific Banking Accounts
      tags:
        - 'CDR: Banking'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:bank:accounts.basic:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/common/customer:
    get:
      description: >-
        Obtain basic information on the customer that has authorised the current
        session.

        *Conventions*

        In the customer payloads relevant conventions are explained here, in one
        place.

        **Given Names** firstName represents the first of a person's given names
        middleNames represents a collection of given names if the person has
        more than one given name

        Where a data holder holds a person's given names as a single string in
        source systems, it may not possible in some situations to reliably split
        these given names into their component first and middle names. In these
        situations, data holders MAY use the `firstName` field to return the
        single string of given names and an empty `middleNames` array.

        For example, a person whose given names are "John Paul Winston" but the
        data holder cannot determine what is the first name, can return
        `"firstName": "John Paul Winston"`.
      operationId: getCustomer
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/GetCommonCustomer'
        '400':
          $ref: '#/components/responses/GetCustomer400'
        '403':
          $ref: '#/components/responses/Generic403'
        '406':
          $ref: '#/components/responses/GetCustomer406'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Customer
      tags:
        - 'CDR: Common'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:common:customer.basic:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/common/customer/detail:
    get:
      description: >-
        Obtain detailed information on the authorised customer within the
        current session.
      operationId: getCustomerDetail
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/GetCommonCustomerDetail'
        '400':
          $ref: '#/components/responses/GetCustomerDetail400'
        '403':
          $ref: '#/components/responses/Generic403'
        '406':
          $ref: '#/components/responses/GetCustomerDetail406'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Customer Detail
      tags:
        - 'CDR: Common'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:common:customer.detail:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/energy/accounts:
    get:
      summary: Get Energy Accounts
      description: >-
        Obtain the list of energy accounts available under the authorised
        consent
      operationId: listEnergyAccounts
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryAccountOpenStatus'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/ListEnergyAccounts'
        '400':
          $ref: '#/components/responses/ListEnergyAccounts400'
        '403':
          $ref: '#/components/responses/Generic403'
        '406':
          $ref: '#/components/responses/ListEnergyAccounts406'
        '422':
          $ref: '#/components/responses/ListEnergyAccounts422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:accounts.basic:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/energy/accounts/{accountId}:
    get:
      description: Obtain detailed information for a specific energy account
      operationId: getEnergyAccountDetail
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/PathAccountId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/GetEnergyAccountDetail'
        '400':
          $ref: '#/components/responses/GetEnergyAccountDetail400'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/GetEnergyAccountDetail404'
        '406':
          $ref: '#/components/responses/GetEnergyAccountDetail406'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Energy Account Detail
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:accounts.detail:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/energy/accounts/{accountId}/payment-schedule:
    get:
      summary: Get Energy Account Payment Schedule
      description: >
        Obtain the agreed payment schedule and details, if any, for a specific
        energy account.


        Some general notes about this endpoint:


        - This API describes how the consumer has elected to pay for their
        account

        - Payments initiated by the consumer are classified as manual payments.
        The billing frequency is captured for manual
          payments. The consumer may choose to pay on a different schedule/frequency. The payment method and frequency is
          not captured for manual payments
        - Payments that can be initiated by the retailer, based on a consumer's
        preferences and permission, include payments
          based on a direct debit, card debit or digital wallet setup. Each of these requires a payment frequency to be provided
          along with other relevant fields
        - Information about payment plans related to debt repayments or
        arrangements due to hardship is not captured within this
          API
      operationId: getEnergyAccountPaymentSchedule
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/PathAccountId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/GetEnergyAccountPaymentSchedule'
        '400':
          $ref: '#/components/responses/GetEnergyAccountPaymentSchedule400'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/GetEnergyAccountPaymentSchedule404'
        '406':
          $ref: '#/components/responses/GetEnergyAccountPaymentSchedule406'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:accounts.paymentschedule:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/energy/accounts/{accountId}/concessions:
    get:
      summary: Get Energy Account Concessions
      description: >-
        Obtain the details of any concessions or arrangements applied to a
        specific energy account
      operationId: getEnergyAccountConcessions
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/PathAccountId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/GetEnergyAccountConcessions'
        '400':
          $ref: '#/components/responses/GetEnergyAccountConcessions400'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/GetEnergyAccountConcessions404'
        '406':
          $ref: '#/components/responses/GetEnergyAccountConcessions406'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:accounts.concessions:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/energy/accounts/{accountId}/balance:
    get:
      summary: Get Balance For Energy Account
      description: Obtain the current balance for a specific energy account
      operationId: getEnergyAccountBalance
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/PathAccountId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/GetEnergyAccountBalance'
        '400':
          $ref: '#/components/responses/GetEnergyAccountBalance400'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/GetEnergyAccountBalance404'
        '406':
          $ref: '#/components/responses/GetEnergyAccountBalance406'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:billing:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/energy/accounts/{accountId}/billing:
    get:
      summary: Get Billing for Energy Account
      description: Obtain the billing transactions for a specific account
      operationId: getEnergyAccountBilling
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/PathAccountId'
        - $ref: '#/components/parameters/QueryOldestDateTime'
        - $ref: '#/components/parameters/QueryNewestDateTime'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/GetEnergyAccountBilling'
        '400':
          $ref: '#/components/responses/GetEnergyAccountBilling400'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/GetEnergyAccountBilling404'
        '406':
          $ref: '#/components/responses/GetEnergyAccountBilling406'
        '422':
          $ref: '#/components/responses/GetEnergyAccountBilling422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:billing:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/energy/accounts/{accountId}/invoices:
    get:
      summary: Get Energy Account Invoices
      description: Obtain the invoices for a specific account
      operationId: listEnergyAccountInvoices
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/PathAccountId'
        - $ref: '#/components/parameters/QueryOldestDate'
        - $ref: '#/components/parameters/QueryNewestDate'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/ListEnergyAccountInvoices'
        '400':
          $ref: '#/components/responses/ListEnergyAccountInvoices400'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/ListEnergyAccountInvoices404'
        '406':
          $ref: '#/components/responses/ListEnergyAccountInvoices406'
        '422':
          $ref: '#/components/responses/ListEnergyAccountInvoices422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:billing:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/energy/invoices:
    get:
      summary: Get Bulk Invoices
      description: Obtain the invoices for all accounts
      operationId: listEnergyInvoices
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryOldestDate'
        - $ref: '#/components/parameters/QueryNewestDate'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/ListEnergyInvoices'
        '400':
          $ref: '#/components/responses/ListEnergyInvoices400'
        '403':
          $ref: '#/components/responses/Generic403'
        '406':
          $ref: '#/components/responses/ListEnergyInvoices406'
        '422':
          $ref: '#/components/responses/ListEnergyInvoices422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:billing:read
    post:
      summary: Get Invoices For Specific Energy Accounts
      description: Obtain invoices for a specified set of energy accounts
      operationId: listEnergyInvoicesSpecificAccounts
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryOldestDate'
        - $ref: '#/components/parameters/QueryNewestDate'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      requestBody:
        $ref: '#/components/requestBodies/RequestAccountIds'
      responses:
        '200':
          $ref: '#/components/responses/ListEnergyInvoicesSpecificAccounts'
        '400':
          $ref: '#/components/responses/ListEnergyInvoicesSpecificAccounts400'
        '406':
          $ref: '#/components/responses/ListEnergyInvoicesSpecificAccounts406'
        '422':
          $ref: '#/components/responses/ListEnergyInvoicesSpecificAccounts422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:billing:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/energy/billing:
    get:
      summary: Get Bulk Billing
      description: Obtain billing transactions for all accounts
      operationId: getEnergyAccountBillingBulk
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryOldestDateTime'
        - $ref: '#/components/parameters/QueryNewestDateTime'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/GetEnergyAccountBillingBulk'
        '400':
          $ref: '#/components/responses/GetEnergyAccountBillingBulk400'
        '403':
          $ref: '#/components/responses/Generic403'
        '406':
          $ref: '#/components/responses/GetEnergyAccountBillingBulk406'
        '422':
          $ref: '#/components/responses/GetEnergyAccountBillingBulk422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:billing:read
    post:
      summary: Get Billing for Specific Energy Accounts
      description: Obtain billing for a specified set of accounts
      operationId: listBillingSpecificEnergyAccounts
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryOldestDateTime'
        - $ref: '#/components/parameters/QueryNewestDateTime'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      requestBody:
        $ref: '#/components/requestBodies/RequestAccountIds'
      responses:
        '200':
          $ref: '#/components/responses/ListEnergyBillingSpecificAccounts'
        '400':
          $ref: '#/components/responses/ListEnergyBillingSpecificAccounts400'
        '406':
          $ref: '#/components/responses/ListEnergyBillingSpecificAccounts406'
        '422':
          $ref: '#/components/responses/ListEnergyBillingSpecificAccounts422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:billing:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/energy/balances:
    get:
      summary: Get Bulk Balances for Energy
      description: Obtain the current balance for all energy accounts
      operationId: getEnergyAccountBalances
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/ListEnergyAccountBalances'
        '400':
          $ref: '#/components/responses/ListEnergyAccountBalances400'
        '403':
          $ref: '#/components/responses/Generic403'
        '406':
          $ref: '#/components/responses/ListEnergyAccountBalances406'
        '422':
          $ref: '#/components/responses/ListEnergyAccountBalances422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:billing:read
    post:
      summary: Get Balances For Specific Energy Accounts
      description: Obtain the current balances for a specified list of energy accounts
      operationId: listBalancesSpecificEnergyAccounts
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      requestBody:
        $ref: '#/components/requestBodies/RequestAccountIds'
      responses:
        '200':
          $ref: '#/components/responses/ListEnergyBalancesSpecificAccounts'
        '400':
          $ref: '#/components/responses/ListBalancesSpecificEnergyAccounts400'
        '406':
          $ref: '#/components/responses/ListBalancesSpecificEnergyAccounts406'
        '422':
          $ref: '#/components/responses/ListBalancesSpecificEnergyAccounts422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:billing:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/energy/electricity/servicepoints:
    get:
      summary: Get Electricity Service Points
      description: >-
        Obtain a list of service points owned by the customer that has
        authorised the current session
      operationId: listElectricityServicePoints
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/ListElectricityServicePoints'
        '400':
          $ref: '#/components/responses/ListElectricityServicePoints400'
        '406':
          $ref: '#/components/responses/ListElectricityServicePoints406'
        '422':
          $ref: '#/components/responses/ListElectricityServicePoints422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:electricity.servicepoints.basic:read
      tags:
        - 'CDR: Energy'
  /principal/{principalId}/agreement/{agreementId}/cds-au/energy/electricity/servicepoints/der:
    get:
      description: Obtain DER data for all service points associated with the customer
      operationId: getElectricityServicePointDERBulk
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/GetElectricityServicePointDERBulk'
        '400':
          $ref: '#/components/responses/GetElectricityServicePointDERBulk400'
        '403':
          $ref: '#/components/responses/Generic403'
        '406':
          $ref: '#/components/responses/GetElectricityServicePointDERBulk406'
        '422':
          $ref: '#/components/responses/GetElectricityServicePointDERBulk422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Bulk DER
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:electricity.der:read
    post:
      description: Obtain DER data for a specific set of service points
      operationId: getElectricityDERSpecificServicePoints
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      requestBody:
        $ref: '#/components/requestBodies/RequestServicePointIds'
      responses:
        '200':
          $ref: '#/components/responses/GetElectricityDERSpecificServicePoints'
        '400':
          $ref: '#/components/responses/GetElectricityDERSpecificServicePoints400'
        '406':
          $ref: '#/components/responses/GetElectricityDERSpecificServicePoints406'
        '422':
          $ref: '#/components/responses/GetElectricityDERSpecificServicePoints422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get DER For Specific Service Points
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:electricity.der:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/energy/electricity/servicepoints/usage:
    get:
      description: Obtain usage data for all service points associated with the customer
      operationId: getElectricityServicePointUsageBulk
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryElectricityMeterIntervalReads'
        - $ref: '#/components/parameters/QueryOldestDate'
        - $ref: '#/components/parameters/QueryNewestDate'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/GetElectricityServicePointUsageBulk'
        '400':
          $ref: '#/components/responses/GetElectricityServicePointUsageBulk400'
        '403':
          $ref: '#/components/responses/Generic403'
        '406':
          $ref: '#/components/responses/GetElectricityServicePointUsageBulk406'
        '422':
          $ref: '#/components/responses/GetElectricityServicePointUsageBulk422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Bulk Service Point Usage
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:electricity.usage:read
    post:
      description: Obtain the electricity usage data for a specific set of service points
      operationId: getElectricityUsageSpecificServicePoints
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryOldestDate'
        - $ref: '#/components/parameters/QueryNewestDate'
        - $ref: '#/components/parameters/QueryElectricityMeterIntervalReads'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      requestBody:
        $ref: '#/components/requestBodies/RequestServicePointIds'
      responses:
        '200':
          $ref: '#/components/responses/GetElectricityUsageSpecificServicePoints'
        '400':
          $ref: '#/components/responses/GetElectricityUsageSpecificServicePoints400'
        '406':
          $ref: '#/components/responses/GetElectricityUsageSpecificServicePoints406'
        '422':
          $ref: '#/components/responses/GetElectricityUsageSpecificServicePoints422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Usage For Specific Service Points
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:electricity.usage:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/energy/electricity/servicepoints/{servicePointId}:
    get:
      summary: Get Electricity Service Point Detail
      description: >-
        Obtain detailed standing information for a specific service point that
        is owned by the customer that has authorised the current session
      operationId: getElectricityServicePointDetail
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/PathServicePointId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/GetElectricityServicePointDetail'
        '400':
          $ref: '#/components/responses/GetElectricityServicePointDetail400'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/GetElectricityServicePointDetail404'
        '406':
          $ref: '#/components/responses/GetElectricityServicePointDetail406'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:electricity.servicepoints.detail:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/energy/electricity/servicepoints/{servicePointId}/der:
    get:
      description: Obtain a list of DER data from a particular service point
      operationId: getElectricityServicePointDER
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/PathServicePointId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/GetElectricityServicePointDER'
        '400':
          $ref: '#/components/responses/GetElectricityServicePointDER400'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/GetElectricityServicePointDER404'
        '406':
          $ref: '#/components/responses/GetElectricityServicePointDER406'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get DER For Electricity Service Point
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:electricity.der:read
  /principal/{principalId}/agreement/{agreementId}/cds-au/energy/electricity/servicepoints/{servicePointId}/usage:
    get:
      summary: Get Usage For Electricity Service Point
      description: Obtain a list of electricity usage data from a particular service point
      operationId: getElectricityServicePointUsage
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/PathServicePointId'
        - $ref: '#/components/parameters/QueryOldestDate'
        - $ref: '#/components/parameters/QueryNewestDate'
        - $ref: '#/components/parameters/QueryElectricityMeterIntervalReads'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
        - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
        - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
        - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/GetElectricityServicePointUsage'
        '400':
          $ref: '#/components/responses/GetElectricityServicePointUsage400'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/GetElectricityServicePointUsage404'
        '406':
          $ref: '#/components/responses/GetElectricityServicePointUsage406'
        '422':
          $ref: '#/components/responses/GetElectricityServicePointUsage422'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - 'CDR: Energy'
      security:
        - TokenBasedAuth:
            - biza-au:og:cds-au:energy:electricity.usage:read
  /principal/{principalId}/agreement-history/{agreementId}:
    get:
      summary: Get Agreement History
      description: Obtain historical information about a specific agreement
      operationId: getAgreementHistory
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathAgreementId'
        - $ref: '#/components/parameters/QueryAgreementStatus'
        - $ref: '#/components/parameters/QueryRevision'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      responses:
        '200':
          $ref: '#/components/responses/GetAgreementHistory'
        '404':
          $ref: '#/components/responses/ListParticipants404'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - Agreement
      security:
        - TokenBasedAuth:
            - biza-au:og:agreement:read
  /template:
    get:
      description: Retrieve a list of agreement templates
      operationId: listAgreementTemplates
      summary: List Agreement Templates
      parameters:
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      responses:
        '200':
          description: List of agreement templates
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseAgreementTemplateList'
        '400':
          $ref: '#/components/responses/Generic400'
        '401':
          $ref: '#/components/responses/Generic401'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - Agreement Template
      security:
        - TokenBasedAuth:
            - biza-au:og:template:read
    post:
      description: Create a new Agreement Template
      operationId: createAgreementTemplate
      summary: Create an Agreement Template
      parameters:
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      requestBody:
        $ref: '#/components/requestBodies/RequestAgreementTemplate'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    example: 53e14d6c-1af4-4dc3-bd7a-18e7cccc5034
                    description: Id of the newly created agreement template
                required:
                  - id
        '400':
          $ref: '#/components/responses/Generic400'
        '401':
          $ref: '#/components/responses/Generic401'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - Agreement Template
      security:
        - TokenBasedAuth:
            - biza-au:og:template:write
  /template/{id}:
    delete:
      description: Deletes an agreement template with a given id
      operationId: deleteAgreementTemplate
      summary: Delete an Agreement Template
      parameters:
        - $ref: '#/components/parameters/PathAgreementTemplateId'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      responses:
        '204':
          description: Agreement Template deleted
        '400':
          $ref: '#/components/responses/Generic400'
        '401':
          $ref: '#/components/responses/Generic401'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - Agreement Template
      security:
        - TokenBasedAuth:
            - biza-au:og:template:delete
  /principal/{principalId}/illion/report:
    get:
      description: List Illion credit report(s) for a given principal.
      operationId: listIllionCreditReport
      summary: List Credit Reports
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/QueryPage'
        - $ref: '#/components/parameters/QueryPageSize'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      responses:
        '200':
          description: Credit reports
          headers:
            x-fapi-interaction-id:
              $ref: '#/components/headers/XFAPIInteractionId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseCreditReportList'
        '400':
          $ref: '#/components/responses/Generic400'
        '401':
          $ref: '#/components/responses/Generic401'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - Illion
      security:
        - TokenBasedAuth:
            - biza-au:og:illion:read
    post:
      description: Creates an Illion credit report for a given principal.
      operationId: createIllionCreditReport
      summary: Create Credit Report
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      requestBody:
        $ref: '#/components/requestBodies/RequestCreateIllionCreditReport'
      responses:
        '201':
          description: Submitted
          headers:
            x-fapi-interaction-id:
              $ref: '#/components/headers/XFAPIInteractionId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseCreateCreditReport'
        '400':
          $ref: '#/components/responses/Generic400'
        '401':
          $ref: '#/components/responses/Generic401'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - Illion
      security:
        - TokenBasedAuth:
            - biza-au:og:illion:write
  /principal/{principalId}/illion/report/{reportId}:
    get:
      description: Get an Illion credit report by id, for a given principal
      operationId: fetchIllionCreditReportByReportId
      summary: Get Credit Report By Id
      parameters:
        - $ref: '#/components/parameters/PathPrincipalId'
        - $ref: '#/components/parameters/PathReportId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
        - $ref: '#/components/parameters/HeaderXFapiInteractionId'
      responses:
        '200':
          description: Credit report
          headers:
            x-fapi-interaction-id:
              $ref: '#/components/headers/XFAPIInteractionId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseGetCreditReport'
        '400':
          $ref: '#/components/responses/Generic400'
        '401':
          $ref: '#/components/responses/Generic401'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      tags:
        - Illion
      security:
        - TokenBasedAuth:
            - biza-au:og:illion:read
  /delete:
    post:
      description: >-
        CDR end of life callback. This is the endpoint OG calls to let the
        software product do any CDR end of life activities. Example - data
        deletion.


        Software product **MUST** verify the JWT signature before using it. 


        OG's JWKS URL -  `https://<OG_PUBLIC_URI>/<Software Product id>/jwks`
      operationId: cdrEndOfLifeCallback
      summary: CDR end of life
      requestBody:
        description: >-
          JWT signed by OG with claims required to complete any CDR arrangement
          end of life activities. Claims include

          - **iss** - Issuer

          - **aud** - Audience - Software product

          - **nbf** - Token activation time

          - **iat** - Token issued time

          - **exp** - Token expiry - 60 seconds from the issued time

          - **cdrArrangementId** - arrangement id recognised in the CDR
          eco-system

          - **interactionId** - unique id sent by OG, which can be used by the
          software products to dedupe requests from OG

          - **principalId** - Principal Id of the User/Client

          - **softwareProductId** - Unique Id of the Software product
        content:
          application/jwt:
            schema:
              type: string
              format: JWT
        required: true
      responses:
        '204':
          description: Success
        '422':
          description: Failure
      tags:
        - Callback
      security: []
components:
  securitySchemes:
    TokenBasedAuth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://idp.og.gateway/token
          scopes:
            biza-au:og:directory:read: Read Access to the OG Directory
            biza-au:og:cds-au:sharing:init: Ability to initiate CDR Sharing V1 Agreements
            biza-au:og:cds-au:registration:write: Ability to create and update CDR registrations
            biza-au:og:cds-au:registration:read: Ability to read CDR registrations
            biza-au:og:cds-au:registration:delete: Ability to delete CDR registrations
            biza-au:og:cds-au:public: Access to APIs exposed publicly
            biza-au:og:agreement:read: >-
              Ability to read agreements and access principal related
              information
            biza-au:og:agreement:delete: Ability to initiate agreement deletions
            biza-au:og:cds-au:bank:accounts.basic:read: >-
              This scope would allow for the third party to access basic
              information of the customer’s accounts. Includes simple account
              information including balance. Does not include detailed account
              information such as account numbers, product information or
              transaction data.
            biza-au:og:cds-au:bank:accounts.detail:read: >-
              This scope would allow for the third party to access detailed
              information of the customer’s accounts. This scope is effectively
              additional authorisation to the Basic Bank Account Data scope.
              Granting this authorisation only makes sense if the Bank Account
              Data scope is also authorised. Includes basic account information
              plus account identifiers and product information. Does not include
              transaction data.
            biza-au:og:cds-au:bank:transactions:read: >-
              This scope would allow the third party to access transaction data
              for accounts. This scope is effectively additional authorisation
              to the Basic Bank Account Data scope. Granting this authorisation
              only makes sense if the Basic Bank Account Data scope is also
              authorised. Includes all account transaction data.
            biza-au:og:cds-au:bank:payees:read: >-
              This scope allows access to payee information stored by the
              customer. Includes payee information such as billers,
              international beneficiaries and domestic payees.
            biza-au:og:cds-au:bank:regular_payments:read: >-
              The scope would allow the third party to access regular payments.
              Includes Direct Debits and Scheduled Payments.
            biza-au:og:cds-au:energy:electricity.servicepoints.basic:read: >-
              This scope would allow for the third party to access basic
              standing data information of the customer’s service
              points.<br/><br/>Includes simple standing data including the
              National Meter Identifier (NMI). Does not include detailed service
              point information such as loaction or meter attributres.
            biza-au:og:cds-au:energy:electricity.servicepoints.detail:read: >-
              This scope would allow for the third party to access detailed
              information of the customer’s service point connection. This scope
              is effectively additional authorisation to the Basic Service Point
              Data scope. Granting this authorisation only makes sense if the
              Service Point Data scope is also authorised.<br/><br/>Includes
              basic service point information plus account identifiers and meter
              information.<br/>Does not include meter usage data.
            biza-au:og:cds-au:energy:electricity.usage:read: >-
              This scope would allow the third party to access electricity usage
              data for service points. This scope is effectively additional
              authorisation to the Basic Service Point Data scope. Granting this
              authorisation only makes sense if the Basic Service Point Data
              scope is also authorised.<br/><br/>Includes all electricity usage
              data including basic and interval meter meters.
            biza-au:og:cds-au:energy:electricity.der:read: >-
              This scope would allow the third party to access data about
              distributed energy resources for service points. This scope is
              effectively additional authorisation to the Basic Service Point
              Data scope. Granting this authorisation only makes sense if the
              Basic Service Point Data scope is also
              authorised.<br/><br/>Includes distributed energy resource data
              available in AEMOs DER Register
            biza-au:og:cds-au:energy:accounts.basic:read: >-
              This scope would allow for the third party to access basic
              information of the customer’s energy accounts with
              retailers.<br/><br/>Includes simple energy account information
              basic plan information and service points that are part of the
              account.<br/>Does not include detailed account information such as
              tailored plans, electricity contract details or discounts.
            biza-au:og:cds-au:energy:accounts.detail:read: >-
              This scope would allow for the third party to access detailed
              information of the customer’s energy accounts with retailers. This
              scope is effectively additional authorisation to the Basic Energy
              Account Data scope. Granting this authorisation only makes sense
              if the Energy Account Data scope is also
              authorised.<br/><br/>Includes basic energy account information
              plus tailored tariff information including charges included in the
              account or plan.<br/>Does not include usage data.
            biza-au:og:cds-au:energy:accounts.paymentschedule:read: >-
              The scope would allow the third party to access payment schedules
              for energy accounts. Includes Direct Debit or Credit based
              Scheduled Payments and Manual Payments.
            biza-au:og:cds-au:energy:accounts.concessions:read: >-
              The scope would allow the third party to access the details of any
              concessions or hardship arrangement data for a customer’s energy
              account.
            biza-au:og:cds-au:energy:billing:read: >-
              The scope would allow the third party to access the  billing and
              invoice data for a customer’s energy account.
            biza-au:og:cds-au:common:customer.basic:read: >-
              The scope would allow the third party to access personally
              identifiable information about the customer. For retail customers
              this would be information about the customer themselves. For
              business customers it would imply the name of specific user but
              also information about the business. Includes name and occupation
              for individuals or name, business numbers and industry code for
              organisations
            biza-au:og:cds-au:common:customer.detail:read: >-
              The scope would allow the third party to access more detailed
              information about the customer. Includes the data available with
              the Basic Customer Data scope plus contact details. Includes basic
              data plus phone, email and address information.
            biza-au:og:template:read: Ability to list agreement templates.
            biza-au:og:template:write: Ability to create a new agreement template.
            biza-au:og:template:delete: Ability to delete an existing agreement template.
            biza-au:og:user:write: Ability to update user details.
            biza-au:og:illion:read: Ability to read or query illion credit reports.
            biza-au:og:illion:write: Ability to create an illion credit report.
  parameters:
    HeaderXV:
      description: >
        Version of the API endpoint requested by the client. Must be set to a
        positive integer. The data holder should respond

        with the highest supported version

        between
        [_x-min-v_](https://consumerdatastandardsaustralia.github.io/standards/#request-headers)

        and
        [_x-v_](https://consumerdatastandardsaustralia.github.io/standards/#request-headers).
        If the value

        of
        [_x-min-v_](https://consumerdatastandardsaustralia.github.io/standards/#request-headers)
        is equal to or higher than the

        value of
        [_x-v_](https://consumerdatastandardsaustralia.github.io/standards/#request-headers)
        then

        the
        [_x-min-v_](https://consumerdatastandardsaustralia.github.io/standards/#request-headers)
        header should be treated as

        absent. If all versions requested are not supported then the data holder
        must respond with a 406 Not Acceptable.

        See [HTTP
        Headers](https://consumerdatastandardsaustralia.github.io/standards/#request-headers)
      explode: false
      in: header
      name: x-v
      required: true
      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 data holder should respond with
        the highest supported version between
        [_x-min-v_](https://consumerdatastandardsaustralia.github.io/standards/#request-headers)
        and
        [_x-v_](https://consumerdatastandardsaustralia.github.io/standards/#request-headers).
        If all versions requested are not supported then the data holder must
        respond with a 406 Not Acceptable.
      explode: false
      in: header
      name: x-min-v
      required: false
      schema:
        type: string
      style: simple
    HeaderXFapiInteractionId:
      description: >-
        An [RFC4122](https://tools.ietf.org/html/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](https://tools.ietf.org/html/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
        format: uuid
        example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8
      style: simple
    QueryPage:
      description: Page of results to request (standard pagination).
      explode: true
      in: query
      name: page
      required: false
      schema:
        default: 1
        minimum: 1
        type: integer
        x-cds-type: PositiveInteger
      style: form
    QueryPageSize:
      description: Page size to request. Default is 25 (standard pagination).
      explode: true
      in: query
      name: page-size
      required: false
      schema:
        default: 25
        minimum: 1
        type: integer
        x-cds-type: PositiveInteger
      style: form
    PathDirectoryId:
      description: Unique Directory Identifier
      in: path
      name: directoryId
      required: true
      schema:
        type: string
        format: uuid
    QueryParticipantCapability:
      description: Filter the participants by these capabilities
      in: query
      name: capabilities
      required: false
      schema:
        type: array
        items:
          $ref: '#/components/schemas/EnumParticipantCapabilityV1'
    PathSwitchId:
      description: Global unique identifier of an energy switch
      explode: false
      in: path
      name: switchId
      required: true
      schema:
        type: string
        x-cds-type: ASCIIString
      style: simple
    PathActionId:
      description: Global unique identifier of an action
      explode: false
      in: path
      name: actionId
      required: true
      schema:
        type: string
        x-cds-type: ASCIIString
      style: simple
    PathParticipantId:
      description: Unique Participant Identifier
      in: path
      name: participantId
      required: true
      schema:
        type: string
        format: uuid
    PathClientId:
      description: Unique Client Identifier
      in: path
      name: clientId
      required: true
      schema:
        type: string
    QueryProductEffective:
      description: >-
        Allows for the filtering of results 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:
        $ref: '#/components/schemas/EnumEffectiveWithAllV1'
      style: form
    QueryUpdatedSince:
      description: >-
        Only include items that have been updated after the specified date and
        time. If absent defaults to include all items.
      explode: true
      in: query
      name: updated-since
      required: false
      schema:
        type: string
        format: date-time
        x-cds-type: DateTimeString
      style: form
    QueryProductBrand:
      description: >-
        Filter results based on a specific brand. If absent defaults to include
        all plans.
      explode: true
      in: query
      name: brand
      required: false
      schema:
        type: string
      style: form
    QueryProductCategory:
      name: product-category
      explode: true
      in: query
      description: >-
        Used to filter results on the _productCategory_ field applicable to
        accounts. Any one of the valid values for this field can be supplied. If
        absent then all accounts returned.
      required: false
      schema:
        $ref: '#/components/schemas/EnumBankingProductCategoryV1'
      style: form
    PathProductId:
      description: ID of the specific product requested
      explode: false
      in: path
      name: productId
      required: true
      schema:
        type: string
      x-cds-type: ASCIIString
      style: simple
    PathPrincipalId:
      description: Unique Principal Identifier
      in: path
      name: principalId
      required: true
      schema:
        type: string
    PathAgreementId:
      description: Unique Agreement Identifier
      in: path
      name: agreementId
      required: true
      schema:
        type: string
        format: uuid
    HeaderXFAPIAuthDate:
      description: >-
        The time when the customer last logged in to the Data Recipient Software
        Product as described in
        [FAPI-1.0-Baseline](https://openid.net/specs/openid-financial-api-part-1-1_0.html).
        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
        example: Thu, 16 Jan 2020 16:50:15 GMT
      style: simple
      x-conditional: true
    HeaderXFAPICustomerIPAddress:
      description: >-
        The customer's original IP address if the customer is currently logged
        in to the Data Recipient Software Product. 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
        example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
      style: simple
    HeaderXCDSClientHeaders:
      description: >-
        The customer's original standard http headers
        [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types)
        encoded, including the original User-Agent header, if the customer is
        currently logged in to the Data Recipient Software Product. 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
        example: >-
          TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=
      x-cds-type: Base64
      style: simple
      x-conditional: true
    QueryAgreementStatus:
      description: Filter the agreements by these statuses
      in: query
      name: agreementStatus
      required: false
      schema:
        type: array
        items:
          $ref: '#/components/schemas/EnumAgreementCDRSharingStatusV1'
    QueryRevision:
      description: When there are multiple revisions, only return the most current
      in: query
      name: revision
      required: false
      schema:
        $ref: '#/components/schemas/EnumRevisionTypeV1'
    QueryCDRArrangementId:
      description: >-
        Unique identifier, shared amongst all revisions of a CDR Sharing
        arrangement
      in: query
      name: CDRArrangementId
      required: false
      schema:
        type: string
    QueryAccountOpenStatus:
      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:
        $ref: '#/components/schemas/EnumAccountOpenStatusWithAllV1'
      style: form
    QueryAccountIsOwned:
      description: >-
        Filters accounts based on whether they are owned by the authorised
        customer.  `true` for owned accounts, `false` for unowned accounts and
        absent for all accounts.
      explode: true
      in: query
      name: is-owned
      required: false
      schema:
        type: boolean
      style: form
      x-cds-type: Boolean
    PathAccountId:
      description: >-
        ID of a specific account to obtain data for. This is a tokenised ID
        previous obtained from the Account List endpoint.
      explode: false
      in: path
      name: accountId
      required: true
      schema:
        type: string
        x-cds-type: ASCIIString
      style: simple
    QueryOldestDateTime:
      description: >
        Constrain the transaction history request to transactions with effective
        time

        at or after this date/time. Format is aligned to DateTimeString common
        type.


        If absent defaults to the following dependent on call:

        - **Banking**: `newest-time` minus 90 days

        - **Energy**: `newest-time` minus 12 months
      explode: true
      in: query
      name: oldest-time
      required: false
      schema:
        type: string
        format: date-time
        x-cds-type: DateTimeString
      style: form
    QueryNewestDateTime:
      description: >-
        Constrain the transaction history request to transactions 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
        format: date-time
        x-cds-type: DateTimeString
      style: form
    QueryMinAmount:
      description: >-
        Filter transactions to only transactions with amounts higher than or
        equal to this amount.
      explode: true
      in: query
      name: min-amount
      required: false
      schema:
        type: string
      x-cds-type: AmountString
      style: form
    QueryMaxAmount:
      description: >-
        Filter transactions to only transactions with amounts less than or equal
        to this amount.
      explode: true
      in: query
      name: max-amount
      required: false
      schema:
        type: string
      x-cds-type: AmountString
      style: form
    QueryTransactionText:
      description: >-
        Filter transactions to only transactions where this string value is
        found as a substring of either the reference or description fields.
        Format is arbitrary ASCII string. This parameter is optionally
        implemented by data holders. If it is not implemented then a response
        should be provided as normal without text filtering applied and an
        additional boolean field named _isQueryParamUnsupported_ should be
        included in the meta object and set to `true` (whether the text
        parameter is supplied or not)
      explode: true
      in: query
      name: text
      required: false
      schema:
        type: string
      style: form
    PathTransactionId:
      description: >-
        ID of the transaction obtained from a previous call to one of the other
        transaction endpoints.
      explode: false
      in: path
      name: transactionId
      required: true
      schema:
        type: string
      x-cds-type: ASCIIString
      style: simple
    QueryPayeeType:
      description: >-
        Filter on the payee type field. In addition to normal type field values,
        `ALL` can be specified to retrieve all payees. If absent the assumed
        value is `ALL`.
      explode: true
      in: query
      name: type
      required: false
      schema:
        default: ALL
        enum:
          - ALL
          - BILLER
          - DIGITAL_WALLET
          - DOMESTIC
          - INTERNATIONAL
        type: string
      style: form
    PathPayeeId:
      description: The ID used to locate the details of a particular payee.
      explode: false
      in: path
      name: payeeId
      required: true
      schema:
        type: string
      x-cds-type: ASCIIString
      style: simple
    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
        format: date
        x-cds-type: DateString
      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
        format: date
        x-cds-type: DateString
      style: form
    QueryElectricityMeterIntervalReads:
      name: interval-reads
      in: query
      description: >-
        Type of interval reads. Any one of the valid values for this field can
        be supplied. If absent defaults to NONE
      explode: true
      required: false
      schema:
        $ref: '#/components/schemas/EnumElectricityMeterReadIntervalReadTypeV1'
      style: form
    PathServicePointId:
      description: >-
        ID of the specific service point requested. This is a tokenised ID
        previous obtained from the Service Point List Data endpoint. Note that
        it is not a nationalMeteringId.
      explode: false
      in: path
      name: servicePointId
      required: true
      schema:
        type: string
      x-cds-type: ASCIIString
      style: simple
    PathAgreementTemplateId:
      description: Unique Agreement Template Identifier
      in: path
      name: id
      required: true
      schema:
        type: string
        format: uuid
    PathReportId:
      description: Unique Credit Report Identifier
      in: path
      name: reportId
      required: true
      schema:
        type: string
        format: uuid
  headers:
    XFAPIInteractionId:
      description: >-
        An [RFC4122](https://tools.ietf.org/html/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](https://tools.ietf.org/html/rfc4122) UUID value is required to
        be provided in the response header to track the interaction. This header
        MUST be responded for success and error responses for authenticated
        APIs.
      explode: false
      schema:
        type: string
        format: uuid
        example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8
      style: simple
    HeaderXFapiInteractionId:
      description: >-
        An [RFC4122](https://tools.ietf.org/html/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](https://tools.ietf.org/html/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
        format: uuid
        example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8
      style: simple
  schemas:
    ResponseDirectoryList:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseDirectoryListV1'
      required:
        - version
        - links
        - meta
      type: object
    DirectoryV1:
      properties:
        directoryId:
          type: string
          example: 4f1cc672-88be-4cd8-bbe7-3fb6981b6958
          format: uuid
          description: Identifier for the Register
        directoryName:
          type: string
          example: Biza Test Register
          description: Free text description of the directory
      type: object
      required:
        - directoryId
    DirectoryListV1:
      type: object
      properties:
        directories:
          description: List of Directories
          items:
            $ref: '#/components/schemas/DirectoryV1'
          type: array
      required:
        - directories
    ResponseDirectoryListV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/ResponseDirectoryList'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/DirectoryListV1'
          required:
            - data
    LinksV1:
      properties:
        self:
          description: Fully qualified link that generated the current response document
          type: string
          format: uri
          x-cds-type: URIString
          example: https://api.bank.com.au/cds-au/v1/endpoint/path
      required:
        - self
      type: object
    MetaPaginatedV1:
      properties:
        totalPages:
          description: >-
            The total number of pages in the full set. See
            [pagination](https://consumerdatastandardsaustralia.github.io/standards/#pagination).
          type: integer
          x-cds-type: NaturalNumber
          minimum: 0
          example: 1
        totalRecords:
          description: >-
            The total number of records in the full set. See
            [pagination](https://consumerdatastandardsaustralia.github.io/standards/#pagination).
          type: integer
          x-cds-type: NaturalNumber
          minimum: 0
          example: 20
      required:
        - totalPages
        - totalRecords
      type: object
    ErrorFieldInvalidV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Field/Invalid
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Invalid Field
        detail:
          description: >-
            Holds a human readable description of this specific error. The error
            detail SHOULD be the parameter name of the invalid field. The error
            detail MAY include further details explaining the valid format.
          type: string
          example: Invalid format supplied for fieldName
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Field/Invalid
          type: object
      required:
        - code
        - title
        - detail
    ErrorGeneralExpectedV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:GeneralError/Expected
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Expected Error Encountered
        detail:
          description: >-
            Holds a human readable description of this specific error. The error
            detail SHOULD be populated with a meaningful error description,
            without revealing sensitive information.
          type: string
          example: General Expected error occurred
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:GeneralError/Expected
          type: object
      required:
        - code
        - title
        - detail
    ErrorHeaderInvalidV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Header/Invalid
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Invalid Header
        detail:
          description: >-
            Holds a human readable description of this specific error. The error
            detail SHOULD be the HTTP header name. The error detail MAY include
            further details explaining the valid format.
          type: string
          example: Supplied header headerName was invalid
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Header/Invalid
          type: object
      required:
        - code
        - title
        - detail
    Generic400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
    EnumParticipantCapabilityV1:
      description: >-

        Open Gateway Capabilities available.


        | Value |
        Description                                                                                            

        |-------|--------------------------------------------------------------------------------------------------------|

        CDS_AU_DATA_SHARING_BANKING | Consumer Data Right Data Sharing
        Arrangements for Banking sector

        CDS_AU_DATA_SHARING_ENERGY | Consumer Data Right Data Sharing
        Arrangements for Energy sector

        CDS_AU_DATA_SHARING_TELCO | Consumer Data Right Data Sharing
        Arrangements for Telecommunications sector

        CDS_AU_PRD_BANKING | Consumer Data Right Product Reference Data for
        Banking

        CDS_AU_PLAN_ENERGY | Consumer Data Right Generic Plan Data for the
        Energy sector
      enum:
        - CDS_AU_DATA_SHARING_BANKING
        - CDS_AU_DATA_SHARING_ENERGY
        - CDS_AU_DATA_SHARING_TELCO
        - CDS_AU_PRD_BANKING
        - CDS_AU_PLAN_ENERGY
      x-enum-varnames:
        - CDS_AU_DATA_SHARING_BANKING
        - CDS_AU_DATA_SHARING_ENERGY
        - CDS_AU_DATA_SHARING_TELCO
        - CDS_AU_PRD_BANKING
        - CDS_AU_PLAN_ENERGY
      type: string
      example: CDS_AU_DATA_SHARING_BANKING
    ResponseParticipantList:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseParticipantListV1'
      required:
        - version
        - links
        - meta
      type: object
    EnumLegalEntityTypeV1:
      type: string
      description: Legal organisation type
      enum:
        - SOLE_TRADER
        - COMPANY
        - PARTNERSHIP
        - TRUST
        - GOVERNMENT_ENTITY
        - OTHER
      example: OTHER
    ParticipantLegalEntityV1:
      properties:
        legalEntityName:
          type: string
          description: Unique legal name of the organisation
          example: ACME Bank Ltd
        legalEntityId:
          type: string
          description: Unique id of the organisation issued by the CDR Register
          example: 4f1cc672-88be-4cd8-bbe7-3fb6981b6958
        logoUri:
          type: string
          description: Legal Entity logo URI
          x-cds-type: URIString
          format: uri
          example: https://acme.bank/logo.png
        registrationNumber:
          type: string
          description: >-
            Unique registration number (if the company is registered outside
            Australia)
        registrationDate:
          type: string
          format: date
          description: >-
            Date of registration (if the company is registered outside
            Australia)
          x-cds-type: DateString
        registeredCountry:
          type: string
          description: >-
            Country of registration (if the company is registered outside
            Australia)
        abn:
          type: string
          description: Australian Business Number for the organisation
          maxLength: 11
        acn:
          type: string
          description: Australian Company Number for the organisation
          maxLength: 9
        arbn:
          type: string
          description: >-
            Australian Registered Body Number.  ARBNs are issued to registrable
            Australian bodies and foreign companies
          maxLength: 9
        anzsicDivision:
          type: string
          description: >-
            ANZSIC division of the organisation. [ANZSIC
            (2006)](http://www.abs.gov.au/anzsic)
          maxLength: 100
        organisationType:
          $ref: '#/components/schemas/EnumLegalEntityTypeV1'
      description: >-
        Legal Entity information of the Participant. It is possible for one
        legal entity to have many participants listed.
      type: object
      required:
        - legalEntityName
        - legalEntityId
        - logoUri
    EnumParticipantStatusV1:
      description: Participant Status
      enum:
        - ACTIVE
        - INACTIVE
        - REMOVED
      type: string
      default: ACTIVE
      example: ACTIVE
    ParticipantV1:
      properties:
        participantId:
          type: string
          example: 4f1cc672-88be-4cd8-bbe7-3fb6981b6958
          format: uuid
          description: Identifier for the Participant
        directoryId:
          type: string
          example: 5f2cc672-88be-4cd8-bbe7-3fb6981b6234
          format: uuid
          description: Identifier for the Directory
        participantName:
          type: string
          description: Name of the Participant
          example: ACME Bank
        logoUri:
          type: string
          description: Participant Logo URI
          format: uri
          example: https://acme.bank/logo.png
        legalEntity:
          $ref: '#/components/schemas/ParticipantLegalEntityV1'
        lastUpdated:
          type: string
          format: date-time
          description: Last Updated date/time of the participant
          example: '2022-08-20T03:01:42+00:00'
        status:
          $ref: '#/components/schemas/EnumParticipantStatusV1'
        capabilities:
          description: List of Open Gateway capabilities available from the Participant
          items:
            $ref: '#/components/schemas/EnumParticipantCapabilityV1'
          type: array
      type: object
      required:
        - participantId
        - participantName
        - logoUri
        - legalEntity
        - lastUpdated
        - status
        - capabilities
    ParticipantListV1:
      properties:
        participants:
          description: List of Participants
          items:
            $ref: '#/components/schemas/ParticipantV1'
          type: array
      required:
        - participants
      type: object
    ResponseParticipantListV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/ResponseParticipantList'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/ParticipantListV1'
          required:
            - data
    ErrorInvalidParticipantV1:
      type: object
      properties:
        code:
          description: Holds an end point specific error code.
          type: string
          format: uri
          x-cds-type: URIString
          default: urn:au-biza:error:og:Participant/InvalidParticipantId
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Invalid Participant Identifier
        detail:
          description: The specified participant identifier is invalid
          type: string
          example: The specified participant identifier is invalid
      required:
        - code
        - title
        - detail
    ListParticipants404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorInvalidParticipantV1'
      discriminator:
        propertyName: code
    ErrorGeneralUnexpectedV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:GeneralError/Unexpected
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Unexpected Error Encountered
        detail:
          description: >-
            Holds a human readable description of this specific error. The error
            detail SHOULD be populated with a meaningful error description,
            without revealing sensitive information.
          type: string
          example: General Unexpected error occurred
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:GeneralError/Unexpected
          type: object
      required:
        - code
        - title
        - detail
    ErrorServiceUnavailableV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Service/Unavailable
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Service Unavailable
        detail:
          description: Holds a human readable description of this specific error
          type: string
          example: Service Currently Unavailable
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Service/Unavailable
          type: object
      required:
        - code
        - title
        - detail
    RequestActionCDRSharingPrime:
      type: object
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/RequestActionCDRSharingPrimeV1'
      required:
        - version
    AgreementPrimeCDRSharingRequestV1:
      type: object
      properties:
        userId:
          description: User identifier of the user making the request
          type: string
          example: 8c63744e-6507-477c-8002-ae1fb9a190de
        name:
          description: Name of the user making the request
          type: string
          example: Joe Blogs
        email:
          description: Email of the user making the request
          type: string
          format: email
          example: joeblogs@gmail.com
        principalId:
          description: Principal identifier of the CDR consumer making the request
          type: string
          example: 4a28de94-52e9-4a5d-ad91-ae93916cadfb
        agreementId:
          description: >-
            Optional agreement identifier for the purpose of amending an
            agreement
          type: string
          format: uuid
          example: d5a4a443-cae7-4319-97ed-dc92bc20c66d
        templateId:
          description: >-
            Identifier for the agreement template to bootstrap the consent flow
            with
          type: string
          format: uuid
          example: 27a0d944-4eb7-452e-a63c-dc14d8f92428
        redirectUri:
          description: >-
            URI to redirect to once the disclosure (DH) authorisation is
            complete. Will be appended with a query param * state : as passed in
            this request
          type: string
          format: uri
          example: https://software-product.com.au
        errorRedirectUri:
          description: >-
            URI to redirect if an error occurs during consent flow. Will be
            appended with query params * error : as returned from holder *
            errorDescription : as returned from holder * errorUri : as returned
            from holder When not specified, the redirectUri will be used instead
          type: string
          format: uri
          example: https://software-product.com.au/error
        state:
          description: An optional field that will be reflected in the response
          type: string
        participantIds:
          description: >-
            List of unique participant id (OG's internal participant id). This
            is not the unique id of the Data Holder Brand issued by the CDR
            Register.
          type: array
          items:
            type: string
      required:
        - userId
        - name
        - email
        - principalId
        - templateId
        - redirectUri
    RequestActionCDRSharingPrimeV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/RequestActionCDRSharingPrime'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/AgreementPrimeCDRSharingRequestV1'
          required:
            - data
    ResponseActionCDRSharingPrime:
      type: object
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseActionCDRSharingPrimeV1'
      required:
        - version
    AgreementPrimeCDRSharingResponseV1:
      type: object
      properties:
        agreementId:
          description: A unique identifier for this agreement
          type: string
          format: uuid
          example: 27a0d944-4eb7-452e-a63c-dc14d8f92428
        redirectUri:
          description: >-
            The URI that the software product should send the user - to start
            the consent flow
          type: string
          format: uri
          example: https://software-product.com.au
      required:
        - agreementId
        - redirectUri
    ResponseActionCDRSharingPrimeV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/ResponseActionCDRSharingPrime'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/AgreementPrimeCDRSharingResponseV1'
          required:
            - data
    ErrorHeaderUnsupportedVersionV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Header/UnsupportedVersion
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Unsupported Version
        detail:
          description: >-
            A request is made for a version that is lower than the minimum
            version or greater than maximum version the Data Holder supports for
            the requested endpoint. The error detail MAY include the minimum and
            maximum versions the Data Holder supports.
          type: string
          example: Unsupported Version Requested
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Header/UnsupportedVersion
          type: object
      required:
        - code
        - title
        - detail
    Generic406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
    Generic422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
    ResponseGetEnergySwitchStatus:
      type: object
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseGetEnergySwitchStatusV1'
    EnumMSATSChangeRequestStatusCodeV1:
      type: string
      example: REQUESTED
      description: >-
        **MSATS Change Request Status Codes**


        MSATS Change Request Status Codes as sourced from the MSATS Technical
        Guide description for [Change
        Requests](https://visualisations.aemo.com.au/aemo/web-help/Content/MSATSTechnicalGuide/Change_requests.htm)


        | Code | Description        |
        Notes                                                                                                                                                                                                                                                                                                                                                             
        |

        |------|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

        | PVAL | Pending Validation | The Transaction passed Checksum
        Validation. <br />If the change request is awaiting missing data, MSATS
        updates the Proposed Change Date and Initiator when it receives the
        missing
        data                                                                                                                                                                          
        |

        | REQ  | Requested          | MSATS has sent Notifications.<br />MSATS
        has all data required to initiate the
        Transaction                                                                                                                                                                                                                                                                        
        |

        | PEND | Pending            | The Transaction has passed the objection
        period and is either:<br /><ul><li>Awaiting final details before it can
        complete</li><li>Awaiting arrival of the Proposed Change
        Date</li></ul>                                                                                                                                                                          
        |

        | OBJ  | Objected           | MSATS has received an objection and the
        transfer is suspended until the Objection is either: <br
        /><ul><li>Withdrawn</li><li>The objection period lapses (MSATS cancels
        the Change
        Request)</li></ul>                                                                                                                                                             
        |

        | CAN  | Cancelled          | Cancellation reasons: <br /><ul><li>The
        proposed new retailer is deregistered as a result of a RoLR event (the
        RoLR process cancels in-progress Change Requests for that
        Retailer)</li><li>A nominated number of days have passed since MSATS
        received Objections and they are not withdrawn</li><li>The initiator of
        the Change Request has withdrawn it</li></ul> |

        | COM  | Completed          | Completion reasons:<br /><ul><li>There are
        no outstanding Objections</li><li>The Proposed Change Date is either
        reached or passed</li><li>All data MSATS was awaiting, e.g. an Actual
        Change Date from an MDP is
        delivered</li>                                                                                                                                   
        |

        | REJ  | Rejected           | Rejection reasons: <br /><ul><li>Does not
        pass all validation
        rules</li></ul>                                                                                                                                                                                                                                                                                     
        |
      enum:
        - PVAL
        - REQ
        - PEND
        - OBJ
        - CAN
        - COM
        - REJ
    EnergyMSATSChangeRequestV1:
      description: MSATS Change Request
      properties:
        status:
          $ref: '#/components/schemas/EnumMSATSChangeRequestStatusCodeV1'
      required:
        - status
      type: object
    EnergySwitchStatusV1:
      properties:
        switchId:
          description: Switch Identifier following submission.
          type: string
          format: uuid
          example: e1529071-601f-46ff-a097-97cdaba84065
        msatsChangeRequest:
          $ref: '#/components/schemas/EnergyMSATSChangeRequestV1'
        creationDateTime:
          description: Creation Date/Time
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2024-02-31T08:14:25Z'
        lastUpdated:
          description: Last Status Update time
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2024-08-31T08:14:25Z'
      required:
        - switchId
        - msatsChangeRequest
        - creationDateTime
        - lastUpdated
      type: object
    MetaV1:
      type: object
    ResponseGetEnergySwitchStatusV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/ResponseGetEnergySwitchStatus'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/EnergySwitchStatusV1'
            links:
              $ref: '#/components/schemas/LinksV1'
            meta:
              $ref: '#/components/schemas/MetaV1'
          required:
            - data
            - links
            - meta
            - version
          example:
            version: V1
            data:
              switchId: 7a20c06e-17d6-4eb0-852b-6afea5e44eb2
              creationDateTime: '2023-09-21T14:44:16+10:00'
              msatsChangeRequest:
                status: REQ
              lastUpdated: '2023-09-23T11:44:16+10:00'
            links:
              self: >-
                https://api.provider.com.au/dio-au/actions/energy-account-switch/8ba3f97e-c22c-4516-b6ed-05c0486db195
    ErrorAuthorisationADRStatusNotActiveV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Authorisation/AdrStatusNotActive
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: ADR Status Is Not Active
        detail:
          description: >-
            Holds a human readable description of this specific error. The error
            detail SHOULD contain the current status of the ADR software
            product.
          type: string
          example: The ADR requesting this information is not Active
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Authorisation/AdrStatusNotActive
          type: object
      required:
        - code
        - title
        - detail
    ErrorAuthorisationConsentRevokedV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Authorisation/RevokedConsent
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Consent Is Revoked
        detail:
          description: >-
            The consumer's consent is no longer authorised (for example revoked
            or expired) and the requested resource will not be provided.
          type: string
          example: The Arrangement being access is no longer authorised
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Authorisation/RevokedConsent
          type: object
      required:
        - code
        - title
        - detail
    ErrorAuthorisationInvalidConsentV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Authorisation/InvalidConsent
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Consent Is Invalid
        detail:
          description: >-
            The authorised consumer's consent is not associated to the resource
            requested, is insufficient to execute the resource or is in a status
            that prevents the resource being executed. The error detail SHOULD
            be a description of the status of consent without revealing
            sensitive information.
          type: string
          example: >-
            The authorised consumer's consent is not associated to the resource
            requested.
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Authorisation/InvalidConsent
          type: object
      required:
        - code
        - title
        - detail
    Generic403Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorAuthorisationADRStatusNotActiveV1'
        - $ref: '#/components/schemas/ErrorAuthorisationConsentRevokedV1'
        - $ref: '#/components/schemas/ErrorAuthorisationInvalidConsentV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Authorisation/AdrStatusNotActive: '#/components/schemas/ErrorAuthorisationADRStatusNotActiveV1'
          urn:au-cds:error:cds-all:Authorisation/RevokedConsent: '#/components/schemas/ErrorAuthorisationConsentRevokedV1'
          urn:au-cds:error:cds-all:Authorisation/InvalidConsent: '#/components/schemas/ErrorAuthorisationInvalidConsentV1'
    ErrorResourceNotImplementedV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Resource/NotImplemented
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Resource Not Implemented
        detail:
          description: >-
            The requested resource URL is a valid API endpoint defined by the
            Consumer Data Standards, but it is not implemented or not currently
            supported.
          type: string
          example: >-
            The requested resource URL is a valid API endpoint defined by the
            Consumer Data Standards, but it is not implemented or not currently
            supported.
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Resource/NotImplemented
          type: object
      required:
        - code
        - title
        - detail
    GetEnergySwitchStatus404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    ResponseEnergyAccountSwitchList:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseEnergyAccountSwitchListV1'
      required:
        - version
        - links
        - meta
      type: object
    EnergyAccountSwitchV1:
      properties:
        actionId:
          description: Unique Action Identifier
          type: string
          example: 4f1cc672-88be-4cd8-bbe7-3fb6981b6958
      required:
        - actionId
      type: object
    ResponseEnergyAccountSwitchListV1:
      allOf:
        - $ref: '#/components/schemas/ResponseEnergyAccountSwitchList'
        - type: object
          properties:
            data:
              type: object
              properties:
                actions:
                  description: The list of energy account switch actions returned
                  items:
                    $ref: '#/components/schemas/EnergyAccountSwitchV1'
                  type: array
              required:
                - accounts
          required:
            - data
      type: object
    LinksPaginatedV1:
      properties:
        first:
          description: >-
            URI to the first page of this set. Mandatory if this response is not
            the first page
          type: string
          format: uri
          x-cds-type: URIString
          example: https://api.bank.com.au/cds-au/v1/endpoint/path?page=1&page-size=25
        last:
          description: >-
            URI to the last page of this set. Mandatory if this response is not
            the last page
          type: string
          format: uri
          x-cds-type: URIString
          example: https://api.bank.com.au/cds-au/v1/endpoint/path?page=5&page-size=25
        next:
          description: >-
            URI to the next page of this set. Mandatory if this response is not
            the last page
          type: string
          format: uri
          x-cds-type: URIString
          example: https://api.bank.com.au/cds-au/v1/endpoint/path?page=4&page-size=25
        prev:
          description: >-
            URI to the previous page of this set. Mandatory if this response is
            not the first page
          type: string
          format: uri
          x-cds-type: URIString
          example: https://api.bank.com.au/cds-au/v1/endpoint/path?page=2&page-size=25
        self:
          description: Fully qualified link that generated the current response document
          type: string
          format: uri
          x-cds-type: URIString
          example: https://api.bank.com.au/cds-au/v1/endpoint/path?page=3&page-size=25
      required:
        - self
      type: object
      x-conditional:
        - prev
        - next
        - first
        - last
    EnumCDRValidationErrorTypeV1:
      description: |-
        The type of CDR response validation error types:

        - **ATTRIBUTE_INVALID**: Invalid attribute in the response payload

        - **DATABASE_INTEGRITY**: Invalid data

        - **PATH_PARAMETER_INVALID**: Invalid path parameter
      enum:
        - ATTRIBUTE_INVALID
        - DATABASE_INTEGRITY
        - PATH_PARAMETER_INVALID
      type: string
      example: ATTRIBUTE_INVALID
    EnumCDRValidationSeverityTypeV1:
      description: |-
        The type of CDR response validation error types:

        - **INFO**: Info

        - **WARNING**: Warning

        - **ERROR**: Error
      enum:
        - INFO
        - WARNING
        - ERROR
      type: string
      example: ERROR
    ValidationError:
      properties:
        type:
          $ref: '#/components/schemas/EnumCDRValidationErrorTypeV1'
        fields:
          type: array
          description: Invalid item in the CDR model
          example:
            - data.availableBalance
          items:
            type: string
        message:
          type: string
          description: Validation failure message
          example: Must be specified and not an empty string
        severity:
          $ref: '#/components/schemas/EnumCDRValidationSeverityTypeV1'
      required:
        - type
        - fields
        - message
        - severity
    ResponseGetEnergySwitchRequest:
      type: object
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseGetEnergySwitchRequestV1'
    EnergyConnectionDetailV1:
      description: Energy Connection Request Detail
      type: object
      properties:
        planId:
          description: >-
            The Energy Plan to switch to, originally sourced from the Get Plans
            endpoint for the target Provider
          type: string
          example: 70342115-eca0-4847-84ae-d2750f238b4c
        nationalMeteringId:
          description: >-
            National Metering Identifier, sourced from the Service Point Detail
            of the source Provider
          type: string
          pattern: ^\d{10}$
          example: '4567123487'
        lifeSupportRequired:
          description: >-
            Does anyone intending to reside at the supply address require a life
            support machine?
          type: boolean
        concessionEligible:
          description: Does the Consumer hold an eligible concession?
          type: boolean
        electronicBills:
          description: Electronic Bills preferred and enabled
          type: boolean
      required:
        - planId
    EnumCommonIndustryCodeVersionV1:
      description: >-
        The applicable [ANZSIC](http://www.abs.gov.au/ANZSIC) release version of
        the industry code provided. Should only be supplied if industryCode is
        also supplied. If industryCode is supplied but industryCodeVersion is
        absent, default is ANZSIC_1292.0_2006_V2.0
      enum:
        - ANZSIC_1292.0_2006_V1.0
        - ANZSIC_1292.0_2006_V2.0
      type: string
      default: ANZSIC_1292.0_2006_V2.0
      example: ANZSIC_1292.0_2006_V2.0
    EnumCommonOrganisationTypeV1:
      description: Legal organisation type
      enum:
        - COMPANY
        - GOVERNMENT_ENTITY
        - OTHER
        - PARTNERSHIP
        - SOLE_TRADER
        - TRUST
      type: string
      example: COMPANY
    CommonOrganisationV1:
      properties:
        abn:
          description: Australian Business Number for the organisation
          type: string
        acn:
          description: >-
            Australian Company Number for the organisation. Required only if an
            ACN is applicable for the organisation type
          type: string
        agentFirstName:
          description: >-
            The first name of the individual providing access on behalf of the
            organisation. For people with single names this field need not be
            present. The single name should be in the lastName field
          type: string
        agentLastName:
          description: >-
            The last name of the individual providing access on behalf of the
            organisation. For people with single names the single name should be
            in this field
          type: string
          example: Doe
        agentRole:
          description: >-
            The role of the individual identified as the agent who is providing
            authorisation. Expected to be used for display. Default to
            Unspecified if the role is not known
          type: string
          default: Unspecified
        businessName:
          description: Name of the organisation
          type: string
          example: ACME
        establishmentDate:
          description: The date the organisation described was established
          type: string
          format: date
          x-cds-type: DateString
        industryCode:
          description: >-
            A valid [ANZSIC](http://www.abs.gov.au/ANZSIC) code for the
            organisation. If the industry code held by the data holder is not
            one of the supported [ANZSIC](http://www.abs.gov.au/ANZSIC)
            versions, then it must not be supplied.
          type: string
        industryCodeVersion:
          $ref: '#/components/schemas/EnumCommonIndustryCodeVersionV1'
        isACNCRegistered:
          description: >-
            True if registered with the ACNC. False if not. Absent or null if
            not confirmed.
          type: boolean
        lastUpdateTime:
          description: >-
            The date and time that this record was last updated by the customer.
            If no update has occurred then this date should reflect the initial
            creation date for the data
          type: string
          format: date-time
          x-cds-type: DateTimeString
        legalName:
          description: Legal name, if different to the business name
          type: string
        organisationType:
          $ref: '#/components/schemas/EnumCommonOrganisationTypeV1'
        registeredCountry:
          description: >-
            Enumeration with values from [ISO 3166
            Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country
            codes.  Assumed to be AUS if absent
          type: string
          x-cds-type: ExternalRef
        shortName:
          description: Short name used for communication, if different to the business name
          type: string
      required:
        - agentLastName
        - agentRole
        - businessName
        - organisationType
      type: object
      x-conditional:
        - industryCodeVersion
    EnumCommonStateV1:
      description: >-
        State in which the address belongs. Valid enumeration defined by
        Australia Post PAF code file [State Type
        Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf).
        NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT
      enum:
        - AAT
        - ACT
        - NSW
        - NT
        - QLD
        - SA
        - TAS
        - VIC
        - WA
      type: string
      example: NSW
    CommonPAFAddressV1:
      description: >-
        Australian address formatted according to the file format defined by the
        [PAF file
        format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf).
        Required if addressUType is set to paf
      properties:
        buildingName1:
          description: Building/Property name 1
          type: string
          example: CAPITAL HOUSE
        buildingName2:
          description: Building/Property name 2
          type: string
          example: WE WORK
        dpid:
          description: >-
            Unique identifier for an address as defined by Australia Post. Also
            known as Delivery Point Identifier
          type: string
          example: '34567890'
        flatUnitNumber:
          description: Unit number (including suffix, if applicable)
          type: string
          example: 2A
        flatUnitType:
          description: Type of flat or unit for the address
          type: string
          example: U
        floorLevelNumber:
          description: Floor or level number (including alpha characters)
          type: string
          example: '2'
        floorLevelType:
          description: Type of floor or level for the address
          type: string
          example: FL
        localityName:
          description: Full name of locality
          type: string
          example: RICHMOND
        lotNumber:
          description: Allotment number for the address
          type: string
          example: '20'
        postalDeliveryNumber:
          description: Postal delivery number if the address is a postal delivery type
          minimum: 1
          type: integer
          x-cds-type: PositiveInteger
          example: 2
        postalDeliveryNumberPrefix:
          description: Postal delivery number prefix related to the postal delivery number
          type: string
          example: 'N'
        postalDeliveryNumberSuffix:
          description: Postal delivery number suffix related to the postal delivery number
          type: string
          example: A
        postalDeliveryType:
          description: >-
            Postal delivery type. (eg. PO BOX). Valid enumeration defined by
            Australia Post PAF code file
          type: string
          example: PO BOX
        postcode:
          description: Postcode for the locality
          type: string
          example: '3024'
        state:
          $ref: '#/components/schemas/EnumCommonStateV1'
        streetName:
          description: The name of the street
          type: string
          example: SMITH
        streetSuffix:
          description: >-
            The street type suffix. Valid enumeration defined by Australia Post
            PAF code file
          type: string
          example: W
        streetType:
          description: >-
            The street type. Valid enumeration defined by Australia Post PAF
            code file
          type: string
          example: ST
        thoroughfareNumber1:
          description: >-
            Thoroughfare number for a property (first number in a property
            ranged address)
          type: integer
          x-cds-type: PositiveInteger
          minimum: 1
          example: 23
        thoroughfareNumber1Suffix:
          description: >-
            Suffix for the thoroughfare number. Only relevant if
            thoroughfareNumber1 is populated
          type: string
          example: A
        thoroughfareNumber2:
          description: >-
            Second thoroughfare number (only used if the property has a ranged
            address eg 23-25)
          type: integer
          x-cds-type: PositiveInteger
          example: 25
          minimum: 1
        thoroughfareNumber2Suffix:
          description: >-
            Suffix for the second thoroughfare number. Only relevant if
            thoroughfareNumber2 is populated
          type: string
          example: B
      required:
        - localityName
        - postcode
        - state
      type: object
    CommonSimpleAddressV1:
      description: Required if addressUType is set to simple
      properties:
        addressLine1:
          description: First line of the standard address object
          type: string
          example: 55 McDonald Avenue
        addressLine2:
          description: Second line of the standard address object
          type: string
        addressLine3:
          description: Third line of the standard address object
          type: string
        city:
          description: Name of the city or locality
          type: string
          example: Maryville
        country:
          default: AUS
          description: >-
            A valid [ISO 3166
            Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country
            code. Australia (AUS) is assumed if country is not present.
          type: string
          x-cds-type: ExternalRef
        mailingName:
          description: >-
            Name of the individual or business formatted for inclusion in an
            address used for physical mail
          type: string
        postcode:
          description: Mandatory for Australian addresses
          type: string
          example: '2293'
        state:
          description: >-
            Free text if the country is not Australia. If country is Australia
            then must be one of the values defined by the [State Type
            Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf)
            in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT
          type: string
          example: NSW
      required:
        - addressLine1
        - city
        - state
      type: object
      x-conditional:
        - postcode
    CommonPhysicalAddressV1:
      properties:
        addressUType:
          description: The type of address object present
          enum:
            - paf
            - simple
          type: string
          example: simple
        paf:
          $ref: '#/components/schemas/CommonPAFAddressV1'
        simple:
          $ref: '#/components/schemas/CommonSimpleAddressV1'
      required:
        - addressUType
      type: object
      x-conditional:
        - simple
        - paf
    CommonPhysicalAddressWithPurposeV1:
      allOf:
        - $ref: '#/components/schemas/CommonPhysicalAddressV1'
        - properties:
            purpose:
              description: >-
                Enumeration of values indicating the purpose of the physical
                address
              enum:
                - MAIL
                - OTHER
                - PHYSICAL
                - REGISTERED
                - WORK
              type: string
              example: MAIL
          required:
            - purpose
          type: object
    CommonOrganisationDetailV2:
      description: Mandatory if `customerUType` is `organisation`
      allOf:
        - $ref: '#/components/schemas/CommonOrganisationV1'
        - properties:
            physicalAddresses:
              description: >-
                Array is mandatory but may be empty if no valid addresses are
                held. One and only one address may have the purpose of
                REGISTERED. Zero or one, and no more than one, record may have
                the purpose of MAIL. If zero then the REGISTERED address is to
                be used for mail
              items:
                $ref: '#/components/schemas/CommonPhysicalAddressWithPurposeV1'
              type: array
          required:
            - physicalAddresses
          type: object
    EnumCommonOccupationCodeVersionV1:
      description: >-
        The applicable
        [ANZSCO](https://consumerdatastandardsaustralia.github.io/standards/#iref-ANZSCO)
        release version of the occupation code provided. Mandatory if an
        occupationCode is supplied. If occupationCode is supplied but
        occupationCodeVersion is absent, default is ANZSCO_1220.0_2013_V1.2
      enum:
        - ANZSCO_1220.0_2006_V1.0
        - ANZSCO_1220.0_2006_V1.1
        - ANZSCO_1220.0_2013_V1.2
        - ANZSCO_1220.0_2013_V1.3
      type: string
      default: ANZSCO_1220.0_2013_V1.2
      example: ANZSCO_1220.0_2013_V1.2
    CommonPersonV1:
      properties:
        firstName:
          description: >-
            For people with single names this field need not be present. The
            single name should be in the lastName field. Where a data holder
            cannot determine first and middle names from a collection of given
            names, a single string representing all given names MAY be provided.
          type: string
        lastName:
          description: For people with single names the single name should be in this field
          type: string
          example: Doe
        lastUpdateTime:
          description: >-
            The date and time that this record was last updated by the customer.
            If no update has occurred then this date should reflect the initial
            creation date for the data
          type: string
          format: date-time
          x-cds-type: DateTimeString
        middleNames:
          description: Field is mandatory but array may be empty
          items:
            type: string
          type: array
        occupationCode:
          description: >-
            Value is a valid
            [ANZSCO](https://consumerdatastandardsaustralia.github.io/standards/#iref-ANZSCO)
            Standard Occupation classification code. If the occupation code held
            by the data holder is not one of the supported
            [ANZSCO](https://consumerdatastandardsaustralia.github.io/standards/#iref-ANZSCO)
            versions, then it must not be supplied.
          type: string
        occupationCodeVersion:
          $ref: '#/components/schemas/EnumCommonOccupationCodeVersionV1'
        prefix:
          description: >-
            Also known as title or salutation. The prefix to the name (e.g. Mr,
            Mrs, Ms, Miss, Sir, etc)
          type: string
        suffix:
          description: Used for a trailing suffix to the name (e.g. Jr)
          type: string
      required:
        - lastName
        - middleNames
      type: object
      x-conditional:
        - occupationCodeVersion
    EnumCommonEmailAddressPurposeV1:
      description: The purpose for the email, as specified by the customer (Enumeration)
      enum:
        - HOME
        - OTHER
        - UNSPECIFIED
        - WORK
      type: string
      example: HOME
    CommonEmailAddressV1:
      properties:
        address:
          description: >-
            A correctly formatted email address, as defined by the addr-spec
            format in [RFC 5322](https://www.ietf.org/rfc/rfc5322.txt)
          type: string
          format: email
          x-cds-type: ExternalRef
          example: john@doe.com
        isPreferred:
          description: >-
            May be true for one and only one email record in the collection.
            Denotes the default email address
          type: boolean
          example: true
        purpose:
          $ref: '#/components/schemas/EnumCommonEmailAddressPurposeV1'
      required:
        - address
        - purpose
      type: object
    EnumCommonPhoneNumberPurposeV1:
      description: The purpose of the number as specified by the customer
      enum:
        - HOME
        - INTERNATIONAL
        - MOBILE
        - OTHER
        - UNSPECIFIED
        - WORK
      type: string
      example: MOBILE
    CommonPhoneNumberV1:
      properties:
        areaCode:
          description: >-
            Required for non Mobile Phones, if field is present and refers to
            Australian code - the leading 0 should be omitted.
          type: string
        countryCode:
          description: If absent, assumed to be Australia (+61). The + should be included
          type: string
        extension:
          description: An extension number (if applicable)
          type: string
        fullNumber:
          description: >-
            Fully formatted phone number with country code, area code, number
            and extension incorporated. Formatted according to section 5.1.4. of
            [RFC 3966](https://www.ietf.org/rfc/rfc3966.txt)
          type: string
          x-cds-type: ExternalRef
          example: '+61439123123'
        isPreferred:
          description: >-
            May be true for one and only one entry to indicate the preferred
            phone number. Assumed to be 'false' if not present
          type: boolean
          example: true
        number:
          description: The actual phone number, with leading zeros as appropriate
          type: string
          example: '0439123123'
        purpose:
          $ref: '#/components/schemas/EnumCommonPhoneNumberPurposeV1'
      required:
        - fullNumber
        - number
        - purpose
      type: object
      x-conditional:
        - areaCode
    CommonPersonDetailV2:
      description: Mandatory if `customerUType` is `person`
      allOf:
        - $ref: '#/components/schemas/CommonPersonV1'
        - properties:
            emailAddresses:
              description: May be empty
              items:
                $ref: '#/components/schemas/CommonEmailAddressV1'
              type: array
            phoneNumbers:
              description: Array is mandatory but may be empty if no phone numbers are held
              items:
                $ref: '#/components/schemas/CommonPhoneNumberV1'
              type: array
            physicalAddresses:
              description: >-
                Array is mandatory but may be empty if no valid addresses are
                held.  One and only one address may have the purpose of
                REGISTERED.  Zero or one, and no more than one, record may have
                the purpose of MAIL.  If zero then the REGISTERED address is to
                be used for mail.
              items:
                $ref: '#/components/schemas/CommonPhysicalAddressWithPurposeV1'
              type: array
          required:
            - emailAddresses
            - phoneNumbers
            - physicalAddresses
          type: object
    RequestInitiateEnergySwitchDataV1:
      type: object
      properties:
        connectionDetail:
          $ref: '#/components/schemas/EnergyConnectionDetailV1'
        customerDetail:
          type: object
          properties:
            customerUType:
              description: The type of customer object that is present
              enum:
                - organisation
                - person
              type: string
              example: person
            organisation:
              $ref: '#/components/schemas/CommonOrganisationDetailV2'
            person:
              $ref: '#/components/schemas/CommonPersonDetailV2'
      required:
        - connectionDetail
      example:
        connectionDetail:
          planId: ENERGY_SAVER_PLAN
          nationalMeteringId: 6987332211
          lifeSupportRequired: false
          concessionEligible: false
          electronicBills: true
        customerDetail:
          customerUType: person
          person:
            firstName: John
            lastName: Doe
            middleNames: []
            emailAddresses:
              - address: john@doe.com
                purpose: HOME
            phoneNumbers:
              - fullNumber: '+61439123123'
                number: '0439123123'
                purpose: MOBILE
            physicalAddresses:
              - addressUType: simple
                purpose: MAIL
                simple:
                  addressLine1: 55 McDonald Avenue
                  city: Maryville
                  postcode: '2293'
                  state: NSW
    MetaInitiateEnergySwitchV1:
      properties:
        actionId:
          description: Unique Action Identifier
          type: string
          format: uuid
          example: 9fe3f97e-c22c-4516-b6ed-05c0486db195
        switchId:
          description: >-
            Switch identifier assigned following onboarding form completion. <br
            />       **MUST** be provided if `actionStatus` is `SUCCESS`.
          type: string
          format: uuid
          example: e1529071-601f-46ff-a097-97cdaba84065
        actionStatus:
          description: Current status of the requested action
          enum:
            - PENDING
            - CLAIMED
            - IN_PROGRESS
            - SUCCESS
            - FAILED
            - EXPIRED
          type: string
          example: IN_PROGRESS
        actionStatusDescription:
          type: string
          description: >-
            Description of the current status, can be used to provide an
            extended description
          example: Authorisation has been initiated by the User Agent
        creationDateTime:
          description: Creation Date/Time
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2024-02-31T08:14:25Z'
        lastUpdated:
          description: Last Status Update time
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2024-08-31T08:14:25Z'
      required:
        - actionId
        - actionStatus
        - actionStatusDescription
        - lastUpdated
        - creationDateTime
      type: object
    ResponseGetEnergySwitchRequestV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/ResponseGetEnergySwitchRequest'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/RequestInitiateEnergySwitchDataV1'
            links:
              $ref: '#/components/schemas/LinksV1'
            meta:
              $ref: '#/components/schemas/MetaInitiateEnergySwitchV1'
          required:
            - data
            - links
            - meta
            - version
          example:
            version: V1
            data:
              connectionDetail:
                planId: ENERGY_SAVER_PLAN
                nationalMeteringId: 6987332211
                lifeSupportRequired: false
                concessionEligible: false
                electronicBills: true
              customerDetail:
                customerUType: person
                person:
                  firstName: John
                  lastName: Doe
                  middleNames: []
                  emailAddresses:
                    - address: john@doe.com
                      purpose: HOME
                  phoneNumbers:
                    - fullNumber: '+61439123123'
                      number: '0439123123'
                      purpose: MOBILE
                  physicalAddresses:
                    - addressUType: simple
                      purpose: MAIL
                      simple:
                        addressLine1: 55 McDonald Avenue
                        city: Maryville
                        postcode: '2293'
                        state: NSW
            links:
              self: >-
                https://api.provider.com.au/dio-au/actions/energy-account-switch/8ba3f97e-c22c-4516-b6ed-05c0486db195
            meta:
              actionId: 8ba3f97e-c22c-4516-b6ed-05c0486db195
              switchId: 7a20c06e-17d6-4eb0-852b-6afea5e44eb2
              actionStatus: SUCCESS
              actionStatusDescription: >-
                Energy Account Switch successfully initiated, refer to Switch
                Status for more information
    RequestActionCDRRegistration:
      type: object
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/RequestActionCDRRegistrationV1'
      required:
        - version
    ActionCDRRegistrationV1:
      type: object
      properties:
        redirectUris:
          description: >-
            Array of redirect URIs used for redirect-based flows. If supplied,
            must be a subset of the redirect URIs in  the directory SSA. If
            omitted, will be made equal to the redirect URIs in the directory
            SSA.
          type: array
          items:
            type: string
    RequestActionCDRRegistrationV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/RequestActionCDRRegistration'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/ActionCDRRegistrationV1'
          required:
            - data
    ResponseCDRRegistration:
      type: object
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseCDRRegistrationV1'
      required:
        - version
    ResponseRegistrationPropertiesV1:
      properties:
        client_id:
          type: string
          example: 35a5a70b-5b8d-41f4-9cbd-96cfbc15c58a
          description: Data Holder issued client identifier string
        client_id_issued_at:
          type: integer
          example: 1571808167
          description: >-
            Time at which the client identifier was issued expressed as seconds
            since 1970-01-01T00:00:00Z as measured in UTC
          x-cds-type: ExternalRef
        client_name:
          type: string
          example: Mock Software
          description: >-
            Human-readable string name of the software product to be presented
            to the end-user during authorization
        client_description:
          type: string
          example: A mock software product
          description: >-
            Human-readable string name of the software product description to be
            presented to the end user during authorization
        client_uri:
          type: string
          example: https://www.mockcompany.com.au
          description: URL string of a web page providing information about the client
          format: uri
          x-cds-type: URIString
        legal_entity_id:
          type: string
          example: 344F0E809-BDBE-4F8E-BD30-5E6C3CB78D7B
          description: >-
            A unique identifier string assigned by the CDR Register that
            identifies the Accredited Data Recipient Legal Entity
        legal_entity_name:
          type: string
          example: Mock Company Pty Ltd.
          description: >-
            Human-readable string name of the Accredited Data Recipient Legal
            Entity
        org_id:
          type: string
          example: 3B0B0A7B-3E7B-4A2C-9497-E357A71D07C8
          description: >-
            A unique identifier string assigned by the CDR Register that
            identifies the Accredited Data Recipient Brand
        org_name:
          type: string
          example: Mock Company Brand
          description: >-
            Human-readable string name of the Accredited Data Recipient to be
            presented to the end user during authorization
        redirect_uris:
          type: array
          example:
            - https://www.mockcompany.com.au/redirects/redirect1
            - https://www.mockcompany.com.au/redirects/redirect2
          description: >-
            Array of redirection URI strings for use in redirect-based flows. If
            used, redirect_uris MUST match or be a subset of the redirect_uris
            as defined in the SSA
          items:
            type: string
            format: uri
            x-cds-type: URIString
        sector_identifier_uri:
          type: string
          example: https://www.mockcompany.com.au/sector_identifier.json
          description: >-
            URL string referencing the client sector identifier URI, used as an
            optional input to the Pairwise Identifier
          format: uri
          x-cds-type: URIString
        logo_uri:
          type: string
          example: https://www.mockcompany.com.au/logos/logo1.png
          description: >-
            URL string that references a logo for the client. If present, the
            server SHOULD display this image to the end-user during approval
          format: uri
          x-cds-type: URIString
        tos_uri:
          type: string
          example: https://www.mockcompany.com.au/tos.html
          description: >-
            URL string that points to a human-readable terms of service document
            for the Software Product
          format: uri
          x-cds-type: URIString
        policy_uri:
          type: string
          example: https://www.mockcompany.com.au/policy.html
          description: >-
            URL string that points to a human-readable policy document for the
            Software Product
          format: uri
          x-cds-type: URIString
        jwks_uri:
          type: string
          example: https://www.mockcompany.com.au/jwks
          description: >-
            URL string referencing the client JSON Web Key (JWK) Set [RFC7517]
            document, which contains the client public keys
          format: uri
          x-cds-type: URIString
        revocation_uri:
          type: string
          example: https://www.mockcompany.com.au/revocation
          description: >-
            URI string that references the location of the Software Product
            consent revocation endpoint
          format: uri
          x-cds-type: URIString
        recipient_base_uri:
          type: string
          example: https://www.mockcompany.com.au
          description: >-
            Base URI for the Consumer Data Standard Data Recipient endpoints.
            This should be the base to provide reference to all other Data
            Recipient Endpoints
          format: uri
          x-cds-type: URIString
        token_endpoint_auth_method:
          type: string
          description: The requested authentication method for the token endpoint
          enum:
            - private_key_jwt
          example: private_key_jwt
          x-cds-type: Enum
        token_endpoint_auth_signing_alg:
          type: string
          description: The algorithm used for signing the JWT
          enum:
            - PS256
            - ES256
          example: PS256
          x-cds-type: Enum
        grant_types:
          type: array
          description: >-
            Array of OAuth 2.0 grant type strings that the client can use at the
            token endpoint
          example:
            - client_credentials
            - authorization_code
            - refresh_token
          items:
            type: string
            enum:
              - client_credentials
              - authorization_code
              - refresh_token
            x-cds-type: Enum
        response_types:
          type: array
          description: >-
            Array of the OAuth 2.0 response type strings that the client can use
            at the authorization endpoint. Response type value `code` is
            required for Authorization Code Flow. Response type value `code
            id_token` is required for OIDC Hybrid Flow.
          items:
            type: string
            enum:
              - code
              - code id_token
            x-cds-type: Enum
        application_type:
          type: string
          description: >-
            Kind of the application. The only supported application type will be
            `web`
          enum:
            - web
          x-cds-type: Enum
        id_token_signed_response_alg:
          type: string
          description: Algorithm with which an id_token is to be signed
          enum:
            - PS256
            - ES256
          example: PS256
          x-cds-type: Enum
        id_token_encrypted_response_alg:
          type: string
          example: RSA-OAEP
          description: >-
            JWE `alg` algorithm with which an id_token is to be encrypted.
            Required if OIDC Hybrid Flow (response type `code id_token`) is
            registered.
          x-cds-type: ExternalRef
        id_token_encrypted_response_enc:
          type: string
          example: A256GCM
          description: >-
            JWE `enc` algorithm with which an id_token is to be encrypted.
            Required if OIDC Hybrid Flow (response type `code id_token`) is
            registered.
          x-cds-type: ExternalRef
        authorization_signed_response_alg:
          description: >-
            The JWS `alg` algorithm required for signing authorization
            responses. If this is specified, the response will be signed using
            JWS and the configured algorithm. The algorithm "none" is not
            allowed.<br><br>Required if response_type of "code" is registered by
            the client.
          enum:
            - PS256
            - ES256
          example: PS256
          type: string
          x-cds-type: Enum
          x-conditional: true
        authorization_encrypted_response_alg:
          description: >-
            The JWE `alg` algorithm required for encrypting authorization
            responses. If unspecified, the default is that no encryption is
            performed.<br><br>Required if "authorization_encrypted_response_enc"
            is included.
          enum:
            - RSA-OAEP
            - RSA-OAEP-256
          example: RSA-OAEP
          type: string
          x-cds-type: Enum
          x-conditional: true
        authorization_encrypted_response_enc:
          description: >-
            The JWE `enc` algorithm required for encrypting authorization
            responses. If "authorization_encrypted_response_alg" is specified,
            the default for this value is "A128CBC-HS256".
          enum:
            - A256GCM
            - A128CBC-HS256
          example: A128CBC-HS256
          type: string
          x-cds-type: Enum
        request_object_signing_alg:
          type: string
          description: >-
            Algorithm which the ADR expects to sign the request object if a
            request object will be part of the authorization request sent to the
            Data Holder
          enum:
            - PS256
            - ES256
          example: PS256
          x-cds-type: Enum
        software_statement:
          type: string
          format: JWT
          description: The Software Statement Assertion, as defined in CDR standards
          example: Software Statement Content
        software_id:
          type: string
          example: 740C368F-ECF9-4D29-A2EA-0514A66B0CDE
          description: >-
            String representing a unique identifier assigned by the Register and
            used by registration endpoints to identify the software product to
            be dynamically registered. The "software_id" will remain the same
            for the lifetime of the product, across multiple updates and
            versions
        software_roles:
          type: string
          description: >-
            String containing a role of the software in the CDR Regime.
            Initially the only value used will be
            `data-recipient-software-product`
          enum:
            - data-recipient-software-product
          x-cds-type: Enum
        scope:
          type: string
          example: >-
            openid profile bank:accounts.basic:read bank:accounts.detail:read
            bank:transactions:read bank:payees:read bank:regular_payments:read
            common:customer.basic:read common:customer.detail:read
            cdr:registration
          description: >-
            String containing a space-separated list of scope values that the
            client can use when requesting access tokens.
      type: object
      required:
        - client_description
        - client_id
        - client_name
        - client_uri
        - grant_types
        - id_token_signed_response_alg
        - jwks_uri
        - logo_uri
        - org_id
        - org_name
        - redirect_uris
        - request_object_signing_alg
        - response_types
        - scope
        - software_id
        - software_statement
        - token_endpoint_auth_method
        - token_endpoint_auth_signing_alg
      x-conditional:
        - id_token_encrypted_response_alg
        - id_token_encrypted_response_enc
        - authorization_signed_response_alg
        - authorization_encrypted_response_alg
    ResponseCDRRegistrationV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/ResponseCDRRegistration'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/ResponseRegistrationPropertiesV1'
          required:
            - data
    ResponseRegistrationErrorV1:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: >-
            Predefined error code as described in [section 3.3 OIDC Dynamic
            Client
            Registration](https://openid.net/specs/openid-connect-registration-1_0.html)
          enum:
            - invalid_redirect_uri
            - invalid_client_metadata
            - invalid_software_statement
            - unapproved_software_statement
          example: invalid_software_statement
          x-cds-type: Enum
        error_description:
          type: string
          description: Additional text description of the error for debugging.
          x-cds-type: ASCIIString
    EnumEffectiveWithAllV1:
      description: Effective Date with All
      default: CURRENT
      enum:
        - ALL
        - CURRENT
        - FUTURE
      type: string
      example: CURRENT
    EnumBankingProductCategoryV1:
      description: >+

        The productCategory enumeration provides the values for categorising
        products and accounts. These are explained in the following tables:


        **Deposit Products**


        | Enum | Description

        |------|------------|

        | TRANS_AND_SAVINGS_ACCOUNTS | This grouping of products includes all
        accounts where cash is deposited in the account and is accessible to the
        customer when they choose. These are given many names on the market
        including Cash Accounts, Saving Accounts, Transaction Accounts, Current
        Accounts, Cheque Accounts, Passbook Accounts, etc... |

        | TERM_DEPOSITS              | This grouping of products includes all
        accounts where cash is deposited in the account for a set time period
        with restrictions on when funds can be withdrawn. Includes traditional
        Term Deposits and specialised deposits with either fixed terms or notice
        periods for withdrawal of funds. |

        | TRAVEL_CARDS               | This grouping of products includes
        prepaid cards with multi-currency capabilities.|

        | REGULATED_TRUST_ACCOUNTS   | This grouping of products includes
        accounts were funds are held in trust in regulated industries with
        complex rules embedded on how the products must operate. Industries that
        require this sort of product include real estate agents, solicitors and
        conveyancers. |


        **Lending Products**


        |Enum|Description|

        |----|-----------|

        |BUSINESS_LOANS|This grouping of products incorporates all types of
        lending for business purpose that is not a trade finance facility,
        lease, overdraft, residential mortgage, credit card or margin lending.
        It includes traditional term loans, bank guarantees and commercial
        bills. This category would incorporate both secured and unsecured
        business purpose lending including all business purpose equipment
        finance that is not covered by a lease.|

        |CRED_AND_CHRG_CARDS|This grouping of products includes all lending
        products that are issued for the purpose of allowing a flexible line of
        credit accessed through use of a card. These may be called various names
        including Credit Cards, Charge Cards and Store Cards.|

        |LEASES|This grouping of products will include all types of leases
        including Financial Lease, Operating Lease, Sale and leaseback, etc...|

        |MARGIN_LOANS|This grouping of products includes all types of margin
        loans which let you borrow money to invest in traded assets including
        shares & commodities or in managed funds.|

        |OVERDRAFTS|This grouping of products includes all types of lending
        which allows for the loan amount to be withdrawn, repaid, and redrawn
        again in any manner and any number of times, until the arrangement
        expires. These loans may be secured or unsecured, and generally don’t
        have set / minimum repayment requirements.|

        |PERS_LOANS|This grouping of products includes all lending for personal
        purposes that is not a residential mortgage, credit card or margin
        lending. These loans may be unsecured loans and term loans for purchase
        assets used as security such as motor vehicles. These may be called
        various names including Personal Loans and Car Loans.|

        |RESIDENTIAL_MORTGAGES|This grouping of products includes all lending
        products that are available for the primary purpose of borrowing for the
        purpose of purchasing or renovating residential property, where a
        residential property will be used as security. This group will include
        both fixed, variable & secured overdraft types of product and may
        include both owner-occupied and investment purpose borrowing.|

        |TRADE_FINANCE | This grouping of products includes specialised lending
        products specifically designed to facilitate domestic & international
        trade. This includes the issuance of letters of credit, factoring,
        export credit.

      enum:
        - BUSINESS_LOANS
        - CRED_AND_CHRG_CARDS
        - LEASES
        - MARGIN_LOANS
        - OVERDRAFTS
        - PERS_LOANS
        - REGULATED_TRUST_ACCOUNTS
        - RESIDENTIAL_MORTGAGES
        - TERM_DEPOSITS
        - TRADE_FINANCE
        - TRANS_AND_SAVINGS_ACCOUNTS
        - TRAVEL_CARDS
      type: string
      example: TRANS_AND_SAVINGS_ACCOUNTS
    ResponseBankingProductList:
      properties:
        version:
          type: string
          example: V2
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V3: '#/components/schemas/ResponseBankingProductListV2'
          V4: '#/components/schemas/ResponseBankingProductListV3'
          V5: '#/components/schemas/ResponseBankingProductListV4'
      required:
        - version
        - links
        - meta
      type: object
    BankingProductAdditionalInformationUriV1:
      type: object
      required:
        - additionalInfoUri
      properties:
        description:
          type: string
          description: Display text providing more information about the document URI
          example: Additional Product Information can be found at ACME Bank website
        additionalInfoUri:
          type: string
          description: The URI describing the additional information
          format: uri
          x-cds-type: URIString
          example: >-
            https://www.acmebank.com.au/products/home-loans/home-loans-full-example.pdf
    BankingProductAdditionalInformationV2:
      description: Object that contains links to additional information on specific topics
      properties:
        bundleUri:
          description: >-
            Description of a bundle that this product can be part of. Mandatory
            if `additionalBundleUris` includes one or more supporting documents.
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/bundles
        eligibilityUri:
          description: >-
            Eligibility rules and criteria for the product. Mandatory if
            `additionalEligibilityUris` includes one or more supporting
            documents.
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/eligibility
        feesAndPricingUri:
          description: >-
            Description of fees, pricing, discounts, exemptions and bonuses for
            the product. Mandatory if `additionalFeesAndPricingUris` includes
            one or more supporting documents.
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/fees-and-charges
        overviewUri:
          description: >-
            General overview of the product. Mandatory if
            `additionalOverviewUris` includes one or more supporting documents.
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products
        termsUri:
          description: >-
            Terms and conditions for the product. Mandatory if
            `additionalTermsUris` includes one or more supporting documents.
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/terms
        additionalOverviewUris:
          type: array
          description: >-
            An array of additional general overviews for the product or features
            of the product, if applicable. To be treated as secondary documents
            to the `overviewUri`. Only to be used if there is a primary
            `overviewUri`.
          items:
            $ref: '#/components/schemas/BankingProductAdditionalInformationUriV1'
        additionalTermsUris:
          type: array
          description: >-
            An array of additional terms and conditions for the product, if
            applicable. To be treated as secondary documents to the `termsUri`.
            Only to be used if there is a primary `termsUri`.
          items:
            $ref: '#/components/schemas/BankingProductAdditionalInformationUriV1'
        additionalEligibilityUris:
          type: array
          description: >-
            An array of additional eligibility rules and criteria for the
            product, if applicable. To be treated as secondary documents to the
            `eligibilityUri`. Only to be used if there is a primary
            `eligibilityUri`.
          items:
            $ref: '#/components/schemas/BankingProductAdditionalInformationUriV1'
        additionalFeesAndPricingUris:
          type: array
          description: >-
            An array of additional fees, pricing, discounts, exemptions and
            bonuses for the product, if applicable. To be treated as secondary
            documents to the `feesAndPricingUri`. Only to be used if there is a
            primary `feesAndPricingUri`.
          items:
            $ref: '#/components/schemas/BankingProductAdditionalInformationUriV1'
        additionalBundleUris:
          type: array
          description: >-
            An array of additional bundles for the product, if applicable. To be
            treated as secondary documents to the `bundleUri`. Only to be used
            if there is a primary `bundleUri`.
          items:
            $ref: '#/components/schemas/BankingProductAdditionalInformationUriV1'
      type: object
      x-conditional:
        - overviewUri
        - termsUri
        - eligibilityUri
        - feesAndPricingUri
        - bundleUri
    BankingProductCardArtV1:
      properties:
        imageUri:
          description: >-
            URI reference to a PNG, JPG or GIF image with proportions defined by
            ISO 7810 ID-1 and width no greater than 512 pixels. The URI
            reference may be a link or url-encoded data URI according to
            [RFC2397](https://tools.ietf.org/html/rfc2397).
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/card-art.png
        title:
          description: Display label for the specific image
          type: string
          example: Customise your card and look snazzy
      required:
        - imageUri
    BankingProductV4:
      properties:
        additionalInformation:
          $ref: '#/components/schemas/BankingProductAdditionalInformationV2'
        applicationUri:
          description: >-
            A link to an application web page where this product can be applied
            for.
          type: string
          format: uri
          x-cds-type: URIString
        brand:
          description: >-
            A label of the brand for the product. Able to be used for filtering.
            For data holders with single brands this value is still required
          type: string
          example: ACME
        brandName:
          description: An optional display name of the brand
          type: string
        cardArt:
          description: An array of card art images
          items:
            $ref: '#/components/schemas/BankingProductCardArtV1'
          type: array
        description:
          description: A description of the product
          type: string
          example: An amazing example product
        effectiveFrom:
          description: >-
            The date and time from which this product is effective (i.e. is
            available for origination). Used to enable the articulation of
            products to the regime before they are available for customers to
            originate.
          type: string
          format: date-time
          x-cds-type: DateTimeString
        effectiveTo:
          description: >-
            The date and time at which this product will be retired and will no
            longer be offered.  Used to enable the managed deprecation of
            products
          type: string
          format: date-time
          x-cds-type: DateTimeString
        isTailored:
          description: >-
            Indicates whether the product is specifically tailored to a
            circumstance.  In this case fees and prices are significantly
            negotiated depending on context. While all products are open to a
            degree of tailoring this flag indicates that tailoring is expected
            and thus that the provision of specific fees and rates is not
            applicable
          type: boolean
          example: true
        lastUpdated:
          description: >-
            The last date and time that the information for this product was
            changed (or the creation date for the product if it has never been
            altered).
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-08-20T03:01:42+00:00'
        name:
          description: The display name of the product
          type: string
          example: Example Product
        productCategory:
          $ref: '#/components/schemas/EnumBankingProductCategoryV1'
        productId:
          description: >-
            A data holder specific unique identifier for this product. This
            identifier must be unique to a product but does not otherwise need
            to adhere to ID permanence guidelines.
          type: string
          example: 9bf2cae7-ca32-4124-905b-68404de9628f
      required:
        - brand
        - description
        - isTailored
        - lastUpdated
        - name
        - productCategory
        - productId
      type: object
    ResponseBankingProductListV2:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingProductList'
        - type: object
          properties:
            data:
              type: object
              properties:
                products:
                  description: >-
                    The list of products returned.  If the filter results in an
                    empty set then this array may have no records
                  items:
                    $ref: '#/components/schemas/BankingProductV4'
                  type: array
              required:
                - products
          required:
            - data
      type: object
    BankingProductCardArtV2:
      properties:
        cardScheme:
          description: Card scheme available with the account.
          enum:
            - AMEX
            - EFTPOS
            - MASTERCARD
            - VISA
            - OTHER
          type: string
          example: OTHER
        cardType:
          description: Card type available with the account.
          enum:
            - CHARGE
            - CREDIT
            - DEBIT
          type: string
          example: DEBIT
        title:
          description: Display label for the specific image.
          type: string
        imageUri:
          description: >-
            URI reference to a PNG, JPG or GIF image with proportions defined by
            ISO 7810 ID-1 and width no greater than 512 pixels. The URI
            reference may be a link or url-encoded data URI according to
            **[[RFC2397]](#nref-RFC2397)**.
          type: string
          format: uri
          x-cds-type: URIString
          example: https://acme.recipient/logo.png
      required:
        - cardScheme
        - cardType
        - imageUri
      type: object
    BankingProductV5:
      properties:
        productId:
          description: >-
            A data holder-specific unique identifier for a Banking product. This
            identifier must be unique to a product but does not otherwise need
            to adhere to ID permanence guidelines.
          type: string
          x-cds-type: ASCIIString
          example: 9bf2cae7-ca32-4124-905b-68404de9628f
        effectiveFrom:
          description: >-
            The date and time from which this product is effective (i.e. is
            available for origination). Used to enable the articulation of
            products to the regime before they are available for customers to
            originate.
          type: string
          format: date-time
          x-cds-type: DateTimeString
        effectiveTo:
          description: >-
            The date and time at which this product will be retired and will no
            longer be offered. Used to enable the managed deprecation of
            products.
          type: string
          format: date-time
          x-cds-type: DateTimeString
        lastUpdated:
          description: >-
            The last date and time that the information for this product was
            changed (or the creation date for the product if it has never been
            altered).
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-08-20T03:01:42+00:00'
        productCategory:
          $ref: '#/components/schemas/EnumBankingProductCategoryV1'
        name:
          description: The display name of the product.
          type: string
          example: Example Product
        description:
          description: A description of the product.
          type: string
          example: An amazing example product
        brand:
          description: >-
            A label of the brand for the product. Able to be used for filtering.
            For data holders with single brands this value is still required.
          type: string
          example: ACME
        brandName:
          description: An optional display name of the brand.
          type: string
        applicationUri:
          description: >-
            A link to an application web page where this product can be applied
            for.
          type: string
          format: uri
          x-cds-type: URIString
        isTailored:
          description: >-
            Indicates whether the product is specifically tailored to a
            circumstance. In this case fees and prices are significantly
            negotiated depending on context. While all products are open to a
            degree of tailoring this flag indicates that tailoring is expected
            and thus that the provision of specific fees and rates is not
            applicable.
          type: boolean
          example: true
        additionalInformation:
          $ref: '#/components/schemas/BankingProductAdditionalInformationV2'
        cardArt:
          description: Information about any cards available with the account.
          items:
            $ref: '#/components/schemas/BankingProductCardArtV2'
          type: array
      required:
        - brand
        - description
        - isTailored
        - lastUpdated
        - name
        - productCategory
        - productId
      type: object
    ResponseBankingProductListV3:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingProductList'
        - type: object
          properties:
            data:
              type: object
              properties:
                products:
                  description: >-
                    The list of products returned.  If the filter results in an
                    empty set then this array may have no records
                  items:
                    $ref: '#/components/schemas/BankingProductV5'
                  type: array
              required:
                - products
          required:
            - data
      type: object
    EnumBankingProductCategoryV2:
      description: >+
        The productCategory enumeration provides the values for categorising
        products and accounts. These are explained in the

        following tables:


        **Deposit Products**


        | Enum                       |
        Description                                                                                                                                                                                                                                                                                                      

        |----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

        | TRANS_AND_SAVINGS_ACCOUNTS | This grouping of products includes all
        accounts where cash is deposited in the account and is accessible to the
        customer when they choose. These are given many names on the market
        including Cash Accounts, Saving Accounts, Transaction Accounts, Current
        Accounts, Cheque Accounts, Passbook Accounts, etc... |

        | TERM_DEPOSITS              | This grouping of products includes all
        accounts where cash is deposited in the account for a set time period
        with restrictions on when funds can be withdrawn. Includes traditional
        Term Deposits and specialised deposits with either fixed terms or notice
        periods for withdrawal of funds.                    |

        | TRAVEL_CARDS               | This grouping of products includes
        prepaid cards with multi-currency
        capabilities.                                                                                                                                                                                                                              
        |

        | REGULATED_TRUST_ACCOUNTS   | This grouping of products includes
        accounts were funds are held in trust in regulated industries with
        complex rules embedded on how the products must operate. Industries that
        require this sort of product include real estate agents, solicitors and
        conveyancers.                                             |


        **Lending Products**


        | Enum                  |
        Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       
        |

        |-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

        | BUSINESS_LOANS        | This grouping of products incorporates all
        types of lending for business purpose that is not a trade finance
        facility, lease, overdraft, residential mortgage, credit card or margin
        lending. It includes traditional term loans, bank guarantees and
        commercial bills. This category would incorporate both secured and
        unsecured business purpose lending including all business purpose
        equipment finance that is not covered by a
        lease.                                                       |

        | BUY_NOW_PAY_LATER     | This grouping includes products regulated as a
        buy now pay later arrangement under the National Consumer Credit
        Protection Act 2009 and other Buy Now, Pay Later (BNPL) products with
        key characteristics which may include (but are not limited to): the
        provision of finance (excluding supplying cash), the involvement of a
        third-party financing entity, a fixed charge for providing credit under
        a prescribed limit instead of charging interest, and a fixed charge for
        missing a payment. |

        | CRED_AND_CHRG_CARDS   | This grouping of products includes all lending
        products that are issued for the purpose of allowing a flexible line of
        credit accessed through use of a card. These may be called various names
        including Credit Cards, Charge Cards and Store
        Cards.                                                                                                                                                                                                                                             
        |

        | LEASES                | This grouping of products will include all
        types of leases including Financial Lease, Operating Lease, Sale and
        leaseback,
        etc...                                                                                                                                                                                                                                                                                                                                                                 
        |

        | MARGIN_LOANS          | This grouping of products includes all types
        of margin loans which let you borrow money to invest in traded assets
        including shares & commodities or in managed
        funds.                                                                                                                                                                                                                                                                                                                            
        |

        | OVERDRAFTS            | This grouping of products includes all types
        of lending which allows for the loan amount to be withdrawn, repaid, and
        redrawn again in any manner and any number of times, until the
        arrangement expires. These loans may be secured or unsecured, and
        generally don’t have set / minimum repayment
        requirements.                                                                                                                                                                                 
        |

        | PERS_LOANS            | This grouping of products includes all lending
        for personal purposes that is not a residential mortgage, credit card or
        margin lending. These loans may be unsecured loans and term loans for
        purchase assets used as security such as motor vehicles. These may be
        called various names including Personal Loans and Car
        Loans.                                                                                                                                                                  
        |

        | RESIDENTIAL_MORTGAGES | This grouping of products includes all lending
        products that are available for the primary purpose of borrowing for the
        purpose of purchasing or renovating residential property, where a
        residential property will be used as security. This group will include
        both fixed, variable & secured overdraft types of product and may
        include both owner-occupied and investment purpose
        borrowing.                                                                                                  
        |

        | TRADE_FINANCE         | This grouping of products includes specialised
        lending products specifically designed to facilitate domestic &
        international trade. This includes the issuance of letters of credit,
        factoring, export
        credit.                                                                                                                                                                                                                                                                                     

      enum:
        - BUSINESS_LOANS
        - BUY_NOW_PAY_LATER
        - CRED_AND_CHRG_CARDS
        - LEASES
        - MARGIN_LOANS
        - OVERDRAFTS
        - PERS_LOANS
        - REGULATED_TRUST_ACCOUNTS
        - RESIDENTIAL_MORTGAGES
        - TERM_DEPOSITS
        - TRADE_FINANCE
        - TRANS_AND_SAVINGS_ACCOUNTS
        - TRAVEL_CARDS
      type: string
      example: TRANS_AND_SAVINGS_ACCOUNTS
    BankingProductV6:
      properties:
        productId:
          description: >-
            A data holder-specific unique identifier for a Banking product. This
            identifier must be unique to a product but does not otherwise need
            to adhere to ID permanence guidelines.
          type: string
          x-cds-type: ASCIIString
          example: 9bf2cae7-ca32-4124-905b-68404de9628f
        effectiveFrom:
          description: >-
            The date and time from which this product is effective (i.e. is
            available for origination). Used to enable the articulation of
            products to the regime before they are available for customers to
            originate.
          type: string
          format: date-time
          x-cds-type: DateTimeString
        effectiveTo:
          description: >-
            The date and time at which this product will be retired and will no
            longer be offered. Used to enable the managed deprecation of
            products.
          type: string
          format: date-time
          x-cds-type: DateTimeString
        lastUpdated:
          description: >-
            The last date and time that the information for this product was
            changed (or the creation date for the product if it has never been
            altered).
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-08-20T03:01:42+00:00'
        productCategory:
          $ref: '#/components/schemas/EnumBankingProductCategoryV2'
        name:
          description: The display name of the product.
          type: string
          example: Example Product
        description:
          description: A description of the product.
          type: string
          example: An amazing example product
        brand:
          description: >-
            A label of the brand for the product. Able to be used for filtering.
            For data holders with single brands this value is still required.
          type: string
          example: ACME
        brandName:
          description: An optional display name of the brand.
          type: string
        brandGroup:
          description: >-
            The *brandGroup* of a consumer data sharing brand that the product
            is associated with.
          type: string
          x-cds-type: ASCIIString
        applicationUri:
          description: >-
            A link to an application web page where this product can be applied
            for.
          type: string
          format: uri
          x-cds-type: URIString
        isTailored:
          description: >-
            Indicates whether the product is specifically tailored to a
            circumstance. In this case fees and prices are significantly
            negotiated depending on context. While all products are open to a
            degree of tailoring this flag indicates that tailoring is expected
            and thus that the provision of specific fees and rates is not
            applicable.
          type: boolean
          example: true
        additionalInformation:
          $ref: '#/components/schemas/BankingProductAdditionalInformationV2'
        cardArt:
          description: Information about any cards available with the account.
          items:
            $ref: '#/components/schemas/BankingProductCardArtV2'
          type: array
      required:
        - brand
        - description
        - isTailored
        - lastUpdated
        - name
        - productCategory
        - productId
      type: object
    ResponseBankingProductListV4:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingProductList'
        - type: object
          properties:
            data:
              type: object
              properties:
                products:
                  description: >-
                    The list of products returned.  If the filter results in an
                    empty set then this array may have no records
                  items:
                    $ref: '#/components/schemas/BankingProductV6'
                  type: array
              required:
                - products
          required:
            - data
      type: object
    ErrorFieldMissingV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Field/Missing
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Missing Required Field
        detail:
          description: >-
            Holds a human readable description of this specific error. The error
            detail SHOULD be the parameter name of the missing field.
          type: string
          example: fieldName missing
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Field/Missing
          type: object
      required:
        - code
        - title
        - detail
    ErrorFieldInvalidDateTimeV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Field/InvalidDateTime
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Invalid Date
        detail:
          description: >-
            Holds a human readable description of this specific error. The error
            detail SHOULD be the parameter name of the invalid date field. The
            error detail MAY include further details explaining the expected
            date value.
          type: string
          example: Invalid Date Time field specified
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Field/InvalidDateTime
          type: object
      required:
        - code
        - title
        - detail
    ErrorFieldInvalidPageSizeV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Field/InvalidPageSize
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Invalid Page Size
        detail:
          description: Holds a human readable description of this specific error.
          type: string
          example: Invalid Page Size Field
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Field/InvalidPageSize
          type: object
      required:
        - code
        - title
        - detail
    ErrorHeaderInvalidVersionV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Header/InvalidVersion
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Invalid Version
        detail:
          description: Holds a human readable description of this specific error.
          type: string
          example: Invalid Version specified
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Header/InvalidVersion
          type: object
      required:
        - code
        - title
        - detail
    ErrorHeaderMissingV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Header/Missing
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Missing Required Header
        detail:
          description: >-
            Holds a human readable description of this specific error. The error
            detail SHOULD be the HTTP header name.
          type: string
          example: Required header headerName is missing
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Header/Missing
          type: object
      required:
        - code
        - title
        - detail
    ListProducts400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidDateTimeV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidDateTime: '#/components/schemas/ErrorFieldInvalidDateTimeV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListProducts406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ErrorFieldInvalidPageV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Field/InvalidPage
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Invalid Page
        detail:
          description: >-
            The page being requested it out of of range. For example, the valid
            pagination range is 5 pages and the client requested page=10). The
            error detail SHOULD be the maximum number of pages that are
            available.
          type: string
          example: Invalid Page
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Field/InvalidPage
          type: object
      required:
        - code
        - title
        - detail
    ListProducts422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseBankingProductById:
      properties:
        version:
          type: string
          example: V3
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V3: '#/components/schemas/ResponseBankingProductByIdV3'
          V4: '#/components/schemas/ResponseBankingProductByIdV4'
          V5: '#/components/schemas/ResponseBankingProductByIdV5'
          V6: '#/components/schemas/ResponseBankingProductByIdV6'
          V7: '#/components/schemas/ResponseBankingProductByIdV7'
      required:
        - version
        - links
      type: object
    BankingProductAdditionalInformationV1:
      description: Object that contains links to additional information on specific topics
      properties:
        bundleUri:
          description: Description of a bundle that this product can be part of
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/bundles
        eligibilityUri:
          description: Eligibility rules and criteria for the product
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/eligibility
        feesAndPricingUri:
          description: >-
            Description of fees, pricing, discounts, exemptions and bonuses for
            the product
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/fees-and-charges
        overviewUri:
          description: General overview of the product
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products
        termsUri:
          description: Terms and conditions for the product
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/terms
    BankingProductV3:
      properties:
        additionalInformation:
          $ref: '#/components/schemas/BankingProductAdditionalInformationV1'
        applicationUri:
          description: >-
            A link to an application web page where this product can be applied
            for.
          type: string
          format: uri
          x-cds-type: URIString
        brand:
          description: >-
            A label of the brand for the product. Able to be used for filtering.
            For data holders with single brands this value is still required
          type: string
          example: ACME
        brandName:
          description: An optional display name of the brand
          type: string
        cardArt:
          description: An array of card art images
          items:
            $ref: '#/components/schemas/BankingProductCardArtV1'
          type: array
        description:
          description: A description of the product
          type: string
          example: An amazing example product
        effectiveFrom:
          description: >-
            The date and time from which this product is effective (ie. is
            available for origination).  Used to enable the articulation of
            products to the regime before they are available for customers to
            originate
          type: string
          format: date-time
          x-cds-type: DateTimeString
        effectiveTo:
          description: >-
            The date and time at which this product will be retired and will no
            longer be offered.  Used to enable the managed deprecation of
            products
          type: string
          format: date-time
          x-cds-type: DateTimeString
        isTailored:
          description: >-
            Indicates whether the product is specifically tailored to a
            circumstance.  In this case fees and prices are significantly
            negotiated depending on context. While all products are open to a
            degree of tailoring this flag indicates that tailoring is expected
            and thus that the provision of specific fees and rates is not
            applicable
          type: boolean
          example: true
        lastUpdated:
          description: >-
            The last date and time that the information for this product was
            changed (or the creation date for the product if it has never been
            altered)
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-08-20T03:01:42+00:00'
        name:
          description: The display name of the product
          type: string
          example: Example Product
        productCategory:
          $ref: '#/components/schemas/EnumBankingProductCategoryV1'
        productId:
          description: >-
            A data holder specific unique identifier for this product. This
            identifier must be unique to a product but does not otherwise need
            to adhere to ID permanence guidelines.
          type: string
          example: 9bf2cae7-ca32-4124-905b-68404de9628f
      required:
        - brand
        - description
        - isTailored
        - lastUpdated
        - name
        - productCategory
        - productId
      type: object
    BankingProductBundleV1:
      properties:
        additionalInfo:
          description: Display text providing more information on the bundle
          type: string
          example: A great bundle with all the extras
        additionalInfoUri:
          description: >-
            Link to a web page with more information on the bundle criteria and
            benefits
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/bundles
        description:
          description: Description of the bundle
          type: string
          example: Provides a savings account and loan
        name:
          description: Name of the bundle
          type: string
          example: ACME Super Bundle
        productIds:
          description: >-
            Array of product IDs for products included in the bundle that are
            available via the product endpoints.  Note that this array is not
            intended to represent a comprehensive model of the products included
            in the bundle and some products available for the bundle may not be
            available via the product reference endpoints
          items:
            type: string
          type: array
      required:
        - description
        - name
      type: object
    EnumBankingProductConstraintTypeV1:
      description: >

        Each Product or Account has a set of Constraints. These are explained in
        a table as follows:


        | Value | Description | Use of `additionalValue` Field

        |-------|-------------|-------------------------------|

        MIN_BALANCE | A minimum balance is required for the product | The
        minimum balance in AmountString format

        MAX_BALANCE | A maximum balance is required for the product | The
        maximum balance in AmountString format

        OPENING_BALANCE | An opening balance is required for the product | The
        minimum opening balance in AmountString format

        MAX_LIMIT | A maximum limit exists (such as a maximum loan balance
        denoting the borrowable amount or maximum allowable credit limit) | The
        maximum limit in AmountString format

        MIN_LIMIT | A minimum limit exists (such as a minimum loan balance
        denoting the borrowable amount or minimum credit limit) | The minimum
        limit in AmountString format
      enum:
        - MAX_BALANCE
        - MAX_LIMIT
        - MIN_BALANCE
        - MIN_LIMIT
        - OPENING_BALANCE
      type: string
      example: MIN_BALANCE
    BankingProductConstraintV1:
      properties:
        additionalInfo:
          description: Display text providing more information on the constraint
          type: string
          example: Some information about the constraint
        additionalInfoUri:
          description: Link to a web page with more information on the constraint
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/constraints
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [constraintType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductconstrainttypedoc)
            specified.  Whether mandatory or not is dependent on the value of
            [constraintType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductconstrainttypedoc)
          type: string
          example: Type specific value, see documentation
        constraintType:
          $ref: '#/components/schemas/EnumBankingProductConstraintTypeV1'
      required:
        - constraintType
      type: object
      x-conditional:
        - additionalValue
    EnumBankingDepositRateTypeV1:
      description: >

        The type of rate (base, bonus, etc). These are explained in a table as
        follows:


        | Value | Description | Use of `additionalValue` Field

        |-------|-------------|-------------------------------|

        BONUS | A bonus rate available by meeting a specific criteria | A
        description of the criteria to obtain the bonus

        BUNDLE_BONUS | A bonus rate obtained by originating a bundle instead of
        a standalone product | The name of the bundle

        FIXED | Fixed rate for a period of time | The period of time fixed.
        Formatted according to ISO 8601 Durations

        VARIABLE | A variable base rate for the product | NA

        INTRODUCTORY | An introductory discount that will expire after a set
        period | The period of time for the introductory rate. Formatted
        according to ISO 8601 Durations

        DISCOUNT | A specific discount rate that may be applied. A discount rate
        reduces the interest payable | Description of the discount rate that is
        applicable

        PENALTY | A specific penalty rate that may be applied. A penalty rate
        increases the interest payable | Description of the penalty rate that is
        applicable

        FLOATING | A floating rate is relatively fixed but still adjusts under
        specific circumstances | Details of the float parameters

        MARKET_LINKED | A rate that is linked to a specific market, commodity or
        asset class | Details of the market linkage

        CASH_ADVANCE | Specific rate applied to cash advances from the account |
        NA

        PURCHASE | Specific rate applied to purchases from the account | NA

        BUNDLE_DISCOUNT_FIXED | A discount rate off the fixed rate obtained by
        originating a bundle instead of a standalone product | The name of the
        bundle

        BUNDLE_DISCOUNT_VARIABLE | A discount rate off the variable rate
        obtained by originating a bundle instead of a standalone product | The
        name of the bundle
      enum:
        - BONUS
        - BUNDLE_BONUS
        - FIXED
        - FLOATING
        - INTRODUCTORY
        - MARKET_LINKED
        - VARIABLE
      type: string
      example: FIXED
    BankingProductRateConditionV1:
      description: Defines a condition for the applicability of a tiered rate
      properties:
        additionalInfo:
          description: Display text providing more information on the condition
          type: string
          example: >-
            Package discount is assessed on the package lending balance when you
            apply for a package.
        additionalInfoUri:
          description: Link to a web page with more information on this condition
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.bank.com.au/home-loans/package.html
      type: object
    EnumBankingRateApplicationMethodV1:
      description: >-
        The method used to calculate the amount to be applied using one or more
        tiers. A single rate may be applied to the entire balance or each
        applicable tier rate is applied to the portion of the balance that falls
        into that tier (referred to as 'bands' or 'steps')
      enum:
        - PER_TIER
        - WHOLE_BALANCE
      type: string
      example: WHOLE_BALANCE
    EnumUnitOfMeasureV1:
      description: >-
        The unit of measure that applies to the minimumValue and maximumValue
        values e.g. a **DOLLAR** amount. **PERCENT** (in the case of
        loan-to-value ratio or LVR). Tier term period representing a discrete
        number of **MONTH**'s or **DAY**'s (in the case of term deposit tiers)
      enum:
        - DAY
        - DOLLAR
        - MONTH
        - PERCENT
      type: string
      example: DOLLAR
    BankingProductRateTierV3:
      description: Defines the criteria and conditions for which a rate applies
      properties:
        additionalInfo:
          description: Display text providing more information on the rate tier.
          type: string
        additionalInfoUri:
          description: Link to a web page with more information on this rate tier
          type: string
          format: uri
          x-cds-type: URIString
        applicabilityConditions:
          $ref: '#/components/schemas/BankingProductRateConditionV1'
        maximumValue:
          description: >-
            The number of unitOfMeasure units that form the upper bound of the
            tier or band. For a tier with a discrete value (as opposed to a
            range of values e.g. 1 month) this must be the same as minimumValue.
            Where this is the same as the minimumValue value of the next-higher
            tier the referenced tier should be exclusive of this value. For
            example a term deposit of 2 months falls into the upper tier of the
            following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's
            range has no upper bound.
          type: number
        minimumValue:
          description: >-
            The number of unitOfMeasure units that form the lower bound of the
            tier. The tier should be inclusive of this value
          type: number
          example: 0.05
        name:
          description: A display name for the tier
          type: string
          example: Example Rate Tier
        rateApplicationMethod:
          $ref: '#/components/schemas/EnumBankingRateApplicationMethodV1'
        unitOfMeasure:
          $ref: '#/components/schemas/EnumUnitOfMeasureV1'
      required:
        - minimumValue
        - name
        - unitOfMeasure
      type: object
    BankingProductDepositRateV2:
      properties:
        additionalInfo:
          description: Display text providing more information on the rate
          type: string
          example: A great deposit rate
        additionalInfoUri:
          description: Link to a web page with more information on this rate
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/home-loans/deposit-rates
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [depositRateType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductdepositratetypedoc)
            specified. Whether mandatory or not is dependent on the value of
            [depositRateType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductdepositratetypedoc)
          type: string
          example: Type specific value, see docs
        applicationFrequency:
          description: >-
            The period after which the calculated amount(s) (see
            calculationFrequency) are 'applied' (i.e. debited or credited) to
            the account. Formatted according to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax)
          type: string
          x-cds-type: DurationString
          example: P30D
        calculationFrequency:
          description: >-
            The period after which the rate is applied to the balance to
            calculate the amount due for the period. Calculation of the amount
            is often daily (as balances may change) but accumulated until the
            total amount is 'applied' to the account (see applicationFrequency).
            Formatted according to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax)
          type: string
          x-cds-type: DurationString
          example: P1D
        depositRateType:
          $ref: '#/components/schemas/EnumBankingDepositRateTypeV1'
        rate:
          description: The rate to be applied
          type: string
          x-cds-type: RateString
          example: '0.011'
        tiers:
          description: Rate tiers applicable for this rate
          items:
            $ref: '#/components/schemas/BankingProductRateTierV3'
          type: array
      required:
        - depositRateType
        - rate
      type: object
      x-conditional:
        - additionalValue
    EnumBankingProductEligibilityTypeV1:
      description: >

        Each Product or Account has a set of Product Eligibility types. These
        are explained in a table as follows:


        | Value | Description | Use of `additionalValue` Field

        |-------|-------------|-------------------------------|

        BUSINESS | Only business may apply for the account | NA

        PENSION_RECIPIENT | A recipient of a government pension may apply for
        the product | NA

        MIN_AGE | Only customers older than a minimum age may apply | The
        minimum age in years

        MAX_AGE | Only customers younger than a maximum age may apply | The
        maximum age in years

        MIN_INCOME | The customer must have an income greater than a specified
        threshold to obtain the product | Minimum income in AmountString format

        MIN_TURNOVER | Only a business with greater than a minimum turnover may
        apply | Minimum turnover in AmountString format

        STAFF | Only a staff member of the provider may apply | NA

        STUDENT | Only students may apply for the product | NA

        EMPLOYMENT_STATUS | An eligibility constraint based on employment status
        applies | A description of the status required

        RESIDENCY_STATUS | An eligibility constraint based on residency status
        applies | A description of the status required

        NATURAL_PERSON | The customer must be a natural person rather than
        another legal entity | NA

        OTHER | Another eligibility criteria exists as described in the
        additionalInfo field (if this option is specified then the
        additionalInfo field is mandatory) | NA
      enum:
        - BUSINESS
        - EMPLOYMENT_STATUS
        - MAX_AGE
        - MIN_AGE
        - MIN_INCOME
        - MIN_TURNOVER
        - NATURAL_PERSON
        - OTHER
        - PENSION_RECIPIENT
        - RESIDENCY_STATUS
        - STAFF
        - STUDENT
      type: string
      example: MIN_TURNOVER
    BankingProductEligibilityV1:
      properties:
        additionalInfo:
          description: >-
            Display text providing more information on the
            [eligibility](https://consumerdatastandardsaustralia.github.io/standards/#tocSproducteligibilitytypedoc)
            criteria. Mandatory if the field is set to OTHER
          type: string
          example: Eligibility Criteria
        additionalInfoUri:
          description: >-
            Link to a web page with more information on this eligibility
            criteria
          type: string
          format: uri
          x-cds-type: URIString
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [eligibilityType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproducteligibilitytypedoc)
            specified. Whether mandatory or not is dependent on the value of
            [eligibilityType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproducteligibilitytypedoc)
          type: string
          example: Type dependent value, see docs
        eligibilityType:
          $ref: '#/components/schemas/EnumBankingProductEligibilityTypeV1'
      required:
        - eligibilityType
      type: object
      x-conditional:
        - additionalValue
        - additionalInfo
    EnumBankingProductFeatureTypeV1:
      description: >

        Each Product or Account has a set of Product Features. These are
        explained in a table as follows:


        | Value | Description | Use of `additionalValue` Field

        |-------|-------------|-------------------------------|

        CARD_ACCESS | A card is available for the product to access funds | Text
        describing list of card types that this product can be linked to

        ADDITIONAL_CARDS | Additional cards can be requested | The maximum
        number of additional cards. If no maximum then should be set to null

        UNLIMITED_TXNS | Unlimited free transactions available | NA

        FREE_TXNS | A set number of free transactions available per month | The
        number of free transactions

        FREE_TXNS_ALLOWANCE | A set amount of transaction fee value that is
        discounted per month | The amount of transaction fee discounted (in AUD)

        LOYALTY_PROGRAM | A points based loyalty program is available | Name of
        the loyalty program

        OFFSET | An offset account can be connected to the product | NA

        OVERDRAFT | An overdraft can be applied for | NA

        REDRAW | Redraw of repaid principal above minimum required is available
        | NA

        INSURANCE | Insurance is provided as an additional feature of the
        product | Text description of the type of insurance (e.g. Travel
        Insurance)

        BALANCE_TRANSFERS | Balance transfers can be made to the account (eg.
        for credit cards) | NA

        INTEREST_FREE | Interest free period for purchases | Interest free
        period. Formatted according to ISO 8601 Durations

        INTEREST_FREE_TRANSFERS | Interest free period for balance transfers |
        Interest free period. Formatted according to ISO 8601 Durations

        DIGITAL_WALLET | A Digital wallet can be attached to the product | The
        name or brand of the wallet

        DIGITAL_BANKING | Access is available to online banking features for the
        product | NA

        NPP_PAYID | An account of this product type can be used as the target of
        an NPP PayID | NA

        NPP_ENABLED | An account of this product type can be used to receive
        funds as a result of a BSB/Number based NPP payment | NA

        DONATE_INTEREST | Indicates that interest generated from the product can
        be automatically donated to a charity or community group | NA

        BILL_PAYMENT | The product can be attached to an automatic budgeting and
        bill payment service | Optional name of the service

        COMPLEMENTARY_PRODUCT_DISCOUNTS | Indicates that complementary,
        discounted offerings (such as gift cards, or discounted travel) is
        available | Description of the complementary offering

        BONUS_REWARDS | Bonus loyalty rewards points are available | Number of
        points available

        NOTIFICATIONS | Advanced notifications are available for the product |
        Description of the notification capability

        OTHER | Another feature that can not be included in any of the other
        categories. The additionalInfo field is mandatory for this type | NA
      enum:
        - ADDITIONAL_CARDS
        - BALANCE_TRANSFERS
        - BILL_PAYMENT
        - BONUS_REWARDS
        - CARD_ACCESS
        - COMPLEMENTARY_PRODUCT_DISCOUNTS
        - DIGITAL_BANKING
        - DIGITAL_WALLET
        - DONATE_INTEREST
        - FREE_TXNS
        - FREE_TXNS_ALLOWANCE
        - INSURANCE
        - INTEREST_FREE
        - INTEREST_FREE_TRANSFERS
        - LOYALTY_PROGRAM
        - NOTIFICATIONS
        - NPP_ENABLED
        - NPP_PAYID
        - OFFSET
        - OTHER
        - OVERDRAFT
        - REDRAW
        - UNLIMITED_TXNS
      type: string
      example: CARD_ACCESS
    BankingProductFeatureV1:
      properties:
        additionalInfo:
          description: >-
            Display text providing more information on the feature. Mandatory if
            the [feature
            type](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            is set to OTHER
          type: string
          example: Additional Feature Information
        additionalInfoUri:
          description: Link to a web page with more information on this feature
          type: string
          format: uri
          x-cds-type: URIString
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [featureType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            specified. Whether mandatory or not is dependent on the value of the
            [featureType.](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
          example: Type specific value, see docs
          type: string
        featureType:
          $ref: '#/components/schemas/EnumBankingProductFeatureTypeV1'
      required:
        - featureType
      type: object
      x-conditional:
        - additionalValue
        - additionalInfo
    EnumBankingProductDiscountTypeV1:
      description: >

        Each Product or Account has a set of Discount Types types. These are
        explained in a table as follows:


        | Value | Description | Use of `additionalValue` Field

        |-------|-------------|-------------------------------|

        BALANCE | Discount on a fee for maintaining a set balance. As the
        discount applies to a fee the period is the same as for the fee | The
        minimum balance in AmountString format

        DEPOSITS | Discount for depositing a certain amount of money in a
        period. As the discount applies to a fee the period is the same as for
        the fee | The minimum deposit amount in AmountString format

        PAYMENTS | Discount for outbound payments from the account under a
        certain amount of money in a period. As the discount applies to a fee
        the period is the same as for the fee | The payment threshold amount in
        AmountString format

        FEE_CAP | The amount, balanceRate, transactionRate, accruedRate or
        feeRate fields of the discount represent the maximum amount charged in a
        time period | The time period for which the fee cap applies. Formatted
        according to ISO 8601 Durations

        ELIGIBILITY_ONLY | Discount applies based on customer eligibility
        (eligibility array must be populated) | N/A
      enum:
        - BALANCE
        - DEPOSITS
        - ELIGIBILITY_ONLY
        - FEE_CAP
        - PAYMENTS
      type: string
      example: BALANCE
    EnumBankingProductDiscountEligibilityTypeV1:
      description: >

        Each Product or Account has a set of Discount Eligibility Types types.
        These are explained in a table as follows:


        | Value | Description | Use of `additionalValue` Field

        |-------|-------------|-------------------------------|

        BUSINESS | A business or other non-person legal entity | NA

        PENSION_RECIPIENT | A recipient of a government pension may receive the
        discount | Optional. Should contain a description of which pensions
        qualify

        MIN_AGE | Only customers older than a minimum age receive the discount |
        The minimum age in years

        MAX_AGE | Only customers younger than a maximum age receive the discount
        | The maximum age in years

        MIN_INCOME | The customer must have an income greater than a specified
        threshold to obtain the discount | Minimum income in AmountString format

        MIN_TURNOVER | Only a business with greater than a minimum turnover is
        eligible | Minimum turnover in AmountString format

        STAFF | Only a staff member of the provider may receive the discount |
        NA

        STUDENT | Only students may receive the discount | Optional. Should
        contain a description of who qualifies as a student, e.g. do apprentices
        qualify?

        EMPLOYMENT_STATUS | An eligibility constraint based on employment status
        applies | A description of the status required

        RESIDENCY_STATUS | An eligibility constraint based on residency status
        applies | A description of the status required

        NATURAL_PERSON | The customer must be a natural person rather than
        another legal entity | NA

        INTRODUCTORY | The discount is only available during an introductory
        period | The period of time for the introductory discount. Formatted
        according to ISO 8601 Durations

        OTHER | Another eligibility criteria exists as described in the
        additionalInfo field (if this option is specified then the
        additionalInfo field is mandatory) | NA
      enum:
        - BUSINESS
        - EMPLOYMENT_STATUS
        - INTRODUCTORY
        - MAX_AGE
        - MIN_AGE
        - MIN_INCOME
        - MIN_TURNOVER
        - NATURAL_PERSON
        - OTHER
        - PENSION_RECIPIENT
        - RESIDENCY_STATUS
        - STAFF
        - STUDENT
      type: string
      example: BUSINESS
    BankingProductDiscountEligibilityV1:
      properties:
        additionalInfo:
          description: >-
            Display text providing more information on this eligibility
            constraint. Whether mandatory or not is dependent on the value of
            discountEligibilityType.
          type: string
          example: Eligibility criteria explanation
        additionalInfoUri:
          description: >-
            Link to a web page with more information on this eligibility
            constraint
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/eligibility
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [discountEligibilityType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductdiscounteligibilitydoc)
            specified. Whether mandatory or not is dependent on the value of
            [discountEligibilityType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductdiscounteligibilitydoc)
          type: string
          example: Type specific value, see docs
        discountEligibilityType:
          $ref: '#/components/schemas/EnumBankingProductDiscountEligibilityTypeV1'
      required:
        - discountEligibilityType
      type: object
      x-conditional:
        - additionalInfo
        - additionalValue
    BankingProductDiscountV1:
      properties:
        accruedRate:
          description: >-
            A discount rate calculated based on a proportion of the calculated
            interest accrued on the account. Note that the currency of the fee
            discount is expected to be the same as the currency of the fee
            itself. One of amount, balanceRate, transactionRate, accruedRate and
            feeRate is mandatory. Unless noted in additionalInfo, assumes the
            application and calculation frequency are the same as the
            corresponding fee
          type: string
          x-cds-type: RateString
          example: '0.012'
        additionalInfo:
          description: Display text providing more information on the discount
          type: string
          example: Discount Information
        additionalInfoUri:
          description: Link to a web page with more information on this discount
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/discounts
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [discountType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductdiscounttypedoc)
            specified. Whether mandatory or not is dependent on the value of
            [discountType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductdiscounttypedoc)
          type: string
          example: Type specific value, see docs
        amount:
          description: >-
            Dollar value of the discount. One of amount, balanceRate,
            transactionRate, accruedRate and feeRate is mandatory.
          type: string
          x-cds-type: AmountString
          example: '11.00'
        balanceRate:
          description: >-
            A discount rate calculated based on a proportion of the balance.
            Note that the currency of the fee discount is expected to be the
            same as the currency of the fee itself. One of amount, balanceRate,
            transactionRate, accruedRate and feeRate is mandatory. Unless noted
            in additionalInfo, assumes the application and calculation frequency
            are the same as the corresponding fee
          type: string
          x-cds-type: RateString
          example: '0.0103'
        description:
          description: Description of the discount
          type: string
          example: A great discount offer for having multiple accounts with us.
        discountType:
          $ref: '#/components/schemas/EnumBankingProductDiscountTypeV1'
        eligibility:
          description: >-
            Eligibility constraints that apply to this discount. Mandatory if
            discountType is ELIGIBILITY_ONLY.
          items:
            $ref: '#/components/schemas/BankingProductDiscountEligibilityV1'
          type: array
        feeRate:
          description: >-
            A discount rate calculated based on a proportion of the fee to which
            this discount is attached. Note that the currency of the fee
            discount is expected to be the same as the currency of the fee
            itself. One of amount, balanceRate, transactionRate, accruedRate and
            feeRate is mandatory. Unless noted in additionalInfo, assumes the
            application and calculation frequency are the same as the
            corresponding fee
          type: string
          x-cds-type: RateString
          example: '0.0124'
        transactionRate:
          description: >-
            A discount rate calculated based on a proportion of a transaction.
            Note that the currency of the fee discount is expected to be the
            same as the currency of the fee itself. One of amount, balanceRate,
            transactionRate, accruedRate and feeRate is mandatory
          type: string
          x-cds-type: RateString
          example: '0.00234'
      required:
        - description
        - discountType
      type: object
      x-conditional:
        - accruedRate
        - additionalValue
        - amount
        - balanceRate
        - eligibility
        - feeRate
        - transactionRate
    EnumBankingProductFeeTypeV1:
      description: >

        Each Product or Account has a set of Fee Types. These are explained in a
        table as follows:


        | Value | Description | Use of `additionalValue` Field

        |-------|-------------|-------------------------------|

        PERIODIC | A periodic fee such as a monthly account servicing fee | The
        period of charge. Formatted according to ISO 8601 Durations

        TRANSACTION | A fee associated with any transaction (incorporates
        WITHDRAWAL, DEPOSIT, PAYMENT and PURCHASE) | NA

        WITHDRAWAL | A fee associated with making a withdrawal | NA

        DEPOSIT | A fee associated with making a deposit | NA

        PAYMENT | A fee associated with making a payment | NA

        PURCHASE | A fee associated with making a purchase at a merchant | NA

        EVENT | A fee in relation to a particular event (e.g. ordering a new
        card, viewing a balance or stopping a cheque) | NA

        UPFRONT | A fee paid at the beginning of the product lifecycle, such as
        an establishment fee, loyalty program fee or application fee | NA

        EXIT | A fee for closing the product | NA

        VARIABLE | An at-cost fee that is relevant to a customer's circumstances
        where the amount or rate may not be known until negotiated with the
        customer | NA
      enum:
        - DEPOSIT
        - EVENT
        - EXIT
        - PAYMENT
        - PERIODIC
        - PURCHASE
        - TRANSACTION
        - UPFRONT
        - VARIABLE
        - WITHDRAWAL
      type: string
      example: EXIT
    BankingProductFeeV1:
      properties:
        accrualFrequency:
          description: >-
            The indicative frequency with which the fee is calculated on the
            account. Only applies if balanceRate or accruedRate is also present.
            Formatted according to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax)
          type: string
          x-cds-type: DurationString
          example: P1D
        accruedRate:
          description: >-
            A fee rate calculated based on a proportion of the calculated
            interest accrued on the account. One of amount, balanceRate,
            transactionRate and accruedRate is mandatory unless the feeType is
            `VARIABLE`
          type: string
          x-cds-type: AmountString
          example: '0.002'
        additionalInfo:
          description: Display text providing more information on the fee
          type: string
          example: Additional Fee Information
        additionalInfoUri:
          description: Link to a web page with more information on this fee
          type: string
          format: uri
          x-cds-type: URIString
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [feeType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeetypedoc)
            specified. Whether mandatory or not is dependent on the value of
            [feeType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeetypedoc)
          type: string
          example: Type specific value, see docs
        amount:
          description: >-
            The amount charged for the fee. One of amount, balanceRate,
            transactionRate and accruedRate is mandatory unless the feeType is
            `VARIABLE`
          type: string
          x-cds-type: AmountString
          example: '10.01'
        balanceRate:
          description: >-
            A fee rate calculated based on a proportion of the balance. One of
            amount, balanceRate, transactionRate and accruedRate is mandatory
            unless the feeType is `VARIABLE`
          type: string
          x-cds-type: AmountString
          example: '0.0023'
        currency:
          description: The currency the fee will be charged in. Assumes AUD if absent
          type: string
          x-cds-type: CurrencyString
          example: AUD
          pattern: \w{3}
        discounts:
          description: An optional list of discounts to this fee that may be available
          items:
            $ref: '#/components/schemas/BankingProductDiscountV1'
          type: array
        feeType:
          $ref: '#/components/schemas/EnumBankingProductFeeTypeV1'
        name:
          description: Name of the fee
          type: string
          example: Fee Name
        transactionRate:
          description: >-
            A fee rate calculated based on a proportion of a transaction. One of
            amount, balanceRate, transactionRate and accruedRate is mandatory
            unless the feeType is `VARIABLE`
          type: string
          x-cds-type: AmountString
          example: '0.0023'
      required:
        - feeType
        - name
      type: object
      x-conditional:
        - additionalValue
        - amount
        - balanceRate
        - transactionRate
        - accruedRate
    EnumBankingInterestPaymentDueV1:
      description: >-
        When loan payments are due to be paid within each period. The investment
        benefit of earlier payments affect the rate that can be offered
      enum:
        - IN_ADVANCE
        - IN_ARREARS
      type: string
      example: IN_ARREARS
    EnumBankingLendingRateTypeV1:
      description: >

        The type of rate (base, bonus, etc). These are explained in a table as
        follows:


        | Value | Description | Use of `additionalValue` Field

        |-------|-------------|-------------------------------|

        FIXED | Fixed rate for a period of time | The period of time fixed.
        Formatted according to ISO 8601 Durations

        VARIABLE | A variable base rate for the product | NA

        INTRODUCTORY | An introductory discount that will expire after a set
        period | The period of time for the introductory rate. Formatted
        according to ISO 8601 Durations

        DISCOUNT | A specific discount rate that may be applied. A discount rate
        reduces the interest payable | Description of the discount rate that is
        applicable

        PENALTY | A specific penalty rate that may be applied. A penalty rate
        increases the interest payable | Description of the penalty rate that is
        applicable

        FLOATING | A floating rate is relatively fixed but still adjusts under
        specific circumstances | Details of the float parameters

        MARKET_LINKED | A rate that is linked to a specific market, commodity or
        asset class | Details of the market linkage

        CASH_ADVANCE | Specific rate applied to cash advances from the account |
        NA

        PURCHASE | Specific rate applied to purchases from the account | NA

        BUNDLE_DISCOUNT_FIXED | A discount rate off the fixed rate obtained by
        originating a bundle instead of a standalone product | The name of the
        bundle

        BUNDLE_DISCOUNT_VARIABLE | A discount rate off the variable rate
        obtained by originating a bundle instead of a standalone product | The
        name of the bundle
      enum:
        - BUNDLE_DISCOUNT_FIXED
        - BUNDLE_DISCOUNT_VARIABLE
        - CASH_ADVANCE
        - DISCOUNT
        - FIXED
        - FLOATING
        - INTRODUCTORY
        - MARKET_LINKED
        - PENALTY
        - PURCHASE
        - VARIABLE
      type: string
      example: FIXED
    EnumBankingLoanPurposeV1:
      description: >-
        The reason for taking out the loan. If absent, the lending rate is
        applicable to all loan purposes
      enum:
        - INVESTMENT
        - OWNER_OCCUPIED
      type: string
      example: OWNER_OCCUPIED
    EnumBankingProductLendingRateRepaymentTypeV1:
      description: >-
        Options in place for repayments. If absent, the lending rate is
        applicable to all repayment types
      enum:
        - INTEREST_ONLY
        - PRINCIPAL_AND_INTEREST
      type: string
      example: PRINCIPAL_AND_INTEREST
    BankingProductLendingRateV2:
      properties:
        additionalInfo:
          description: Display text providing more information on the rate.
          type: string
          example: Owner Occupied with Principal and Interest repayment type
        additionalInfoUri:
          description: Link to a web page with more information on this rate
          type: string
          format: uri
          x-cds-type: URIString
          example: >-
            https://www.bank.com.au/personal/apply-online/download-printed-forms/home-loan-update-002842.pdf
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [lendingRateType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductlendingratetypedoc)
            specified. Whether mandatory or not is dependent on the value of
            [lendingRateType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductlendingratetypedoc)
          type: string
          example: P1Y
        applicationFrequency:
          description: >-
            The period after which the calculated amount(s) (see
            calculationFrequency) are 'applied' (i.e. debited or credited) to
            the account. Formatted according to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax)
          type: string
          x-cds-type: DurationString
          example: P1M
        calculationFrequency:
          description: >-
            The period after which the rate is applied to the balance to
            calculate the amount due for the period. Calculation of the amount
            is often daily (as balances may change) but accumulated until the
            total amount is 'applied' to the account (see applicationFrequency).
            Formatted according to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax)
          type: string
          x-cds-type: DurationString
          example: P1D
        comparisonRate:
          description: A comparison rate equivalent for this rate
          type: string
          x-cds-type: RateString
          example: '0.0456'
        interestPaymentDue:
          $ref: '#/components/schemas/EnumBankingInterestPaymentDueV1'
        lendingRateType:
          $ref: '#/components/schemas/EnumBankingLendingRateTypeV1'
        loanPurpose:
          $ref: '#/components/schemas/EnumBankingLoanPurposeV1'
        rate:
          description: The rate to be applied
          type: string
          x-cds-type: RateString
          example: '0.0456'
        repaymentType:
          $ref: '#/components/schemas/EnumBankingProductLendingRateRepaymentTypeV1'
        tiers:
          description: Rate tiers applicable for this rate
          items:
            $ref: '#/components/schemas/BankingProductRateTierV3'
          type: array
      required:
        - lendingRateType
        - rate
      type: object
      x-conditional:
        - additionalValue
    BankingProductDetailV3:
      allOf:
        - $ref: '#/components/schemas/BankingProductV3'
        - properties:
            bundles:
              description: >-
                An array of bundles that this product participates in.  Each
                bundle is described by free form information but also by a list
                of product IDs of the other products that are included in the
                bundle.  It is assumed that the current product is included in
                the bundle also
              items:
                $ref: '#/components/schemas/BankingProductBundleV1'
              type: array
            constraints:
              description: >-
                Constraints on the application for or operation of the product
                such as minimum balances or limit thresholds
              items:
                $ref: '#/components/schemas/BankingProductConstraintV1'
              type: array
            depositRates:
              description: Interest rates available for deposits
              items:
                $ref: '#/components/schemas/BankingProductDepositRateV2'
              type: array
            eligibility:
              description: Eligibility criteria for the product
              items:
                $ref: '#/components/schemas/BankingProductEligibilityV1'
              type: array
            features:
              description: Array of features available for the product
              items:
                $ref: '#/components/schemas/BankingProductFeatureV1'
              type: array
            fees:
              description: Fees applicable to the product
              items:
                $ref: '#/components/schemas/BankingProductFeeV1'
              type: array
            lendingRates:
              description: Interest rates charged against lending balances
              items:
                $ref: '#/components/schemas/BankingProductLendingRateV2'
              type: array
          type: object
    ResponseBankingProductByIdV3:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingProductById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/BankingProductDetailV3'
          required:
            - data
      type: object
    EnumBankingProductFeatureTypeV2:
      description: >
        Each Product or Account has a set of Product Features. These are
        explained in a table as follows:


        | Value                           |
        Description                                                                                                                                                                                                                                
        | Use of `additionalValue`
        Field                                                                                      

        |---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|

        | ADDITIONAL_CARDS                | Additional cards can be
        requested                                                                                                                                                                                                          
        | The maximum number of additional cards.  If no maximum then should be
        set to null                                   |

        | BALANCE_TRANSFERS               | Balance transfers can be made to the
        account (eg. for credit
        cards)                                                                                                                                                                        
        |
        NA                                                                                                                 
        |

        | BILL_PAYMENT                    | The product can be attached to an
        automatic budgeting and bill payment
        service                                                                                                                                                             
        | Optional name of the
        service                                                                                       
        |

        | BONUS_REWARDS                   | Bonus loyalty rewards points are
        available                                                                                                                                                                                                 
        | Number of points
        available                                                                                         
        |

        | CARD_ACCESS                     | A card is available for the product
        to access
        funds                                                                                                                                                                                        
        | Text describing list of card types that this product can be linked
        to                                               |

        | CASHBACK_OFFER                  | Subject to terms, conditions and
        eligibility criteria, the product has a cashback offer for opening an
        account or by spending at a certain
        retailer.                                                                                       
        | The amount of the cashback offer (in
        AUD)                                                                          
        |

        | COMPLEMENTARY_PRODUCT_DISCOUNTS | Indicates that complementary,
        discounted offerings (such as gift cards, or discounted travel) is
        available                                                                                                                                 
        | Description of the complementary
        offering                                                                          
        |

        | DIGITAL_BANKING                 | Access is available to online
        banking features for the
        product                                                                                                                                                                             
        |
        NA                                                                                                                 
        |

        | DIGITAL_WALLET                  | A Digital wallet can be attached to
        the
        product                                                                                                                                                                                            
        | The name or brand of the
        wallet                                                                                    
        |

        | DONATE_INTEREST                 | Indicates that interest generated
        from the product can be automatically donated to a charity or community
        group                                                                                                                            
        |
        NA                                                                                                                 
        |

        | EXTRA_REPAYMENTS                | Indicates that the product has the
        option to accept extra repayments without incurring additional charges
        (for example Buy Now, Pay Later (BNPL) or line of credit products may
        offer the facility to repay instalments on an adhoc basis). |
        NA                                                                                                                 
        |

        | FRAUD_PROTECTION                | The product includes fraud
        protection
        features.                                                                                                                                                                                            
        |
        NA                                                                                                                 
        |

        | FREE_TXNS                       | A set number of free transactions
        available per
        month                                                                                                                                                                                      
        | The number of free
        transactions                                                                                    
        |

        | FREE_TXNS_ALLOWANCE             | A set amount of transaction fee
        value that is discounted per
        month                                                                                                                                                                         
        | The amount of transaction fee discounted (in
        AUD)                                                                   |

        | GUARANTOR                       | Subject to terms and conditions, the
        customer may be able to nominate a guarantor during the origination
        process.                                                                                                                          
        |
        NA                                                                                                                 
        |

        | INSURANCE                       | Insurance is provided as an
        additional feature of the
        product                                                                                                                                                                              
        | Text description of the type of insurance (e.g. Travel
        Insurance)                                                   |

        | INSTALMENT_PLAN                 | The product has the option to pay
        for eligible purchases over time with a set number of
        payments.                                                                                                                                          
        |
        NA                                                                                                                 
        |

        | INTEREST_FREE                   | Interest free period for
        purchases                                                                                                                                                                                                         
        | Interest free period. Formatted according to [ISO 8601
        Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) |

        | INTEREST_FREE_TRANSFERS         | Interest free period for balance
        transfers                                                                                                                                                                                                 
        | Interest free period. Formatted according to [ISO 8601
        Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) |

        | LOYALTY_PROGRAM                 | A points based loyalty program is
        available                                                                                                                                                                                                
        | Name of the loyalty
        program                                                                                        
        |

        | NOTIFICATIONS                   | Advanced notifications are available
        for the
        product                                                                                                                                                                                       
        | Description of the notification
        capability                                                                         
        |

        | NPP_ENABLED                     | An account of this product type can
        be used to receive funds as a result of a BSB/Number based NPP
        payment                                                                                                                                 
        |
        NA                                                                                                                 
        |

        | NPP_PAYID                       | An account of this product type can
        be used as the target of an NPP
        PayID                                                                                                                                                                  
        |
        NA                                                                                                                 
        |

        | OFFSET                          | An offset account can be connected
        to the
        product                                                                                                                                                                                          
        |
        NA                                                                                                                 
        |

        | OTHER                           | Another feature that can not be
        included in any of the other categories.  The additionalInfo field is
        mandatory for this
        type                                                                                                              
        |
        NA                                                                                                                 
        |

        | OVERDRAFT                       | An overdraft can be applied
        for                                                                                                                                                                                                            
        |
        NA                                                                                                                 
        |

        | REDRAW                          | Redraw of repaid principal above
        minimum required is
        available                                                                                                                                                                             
        |
        NA                                                                                                                 
        |

        | RELATIONSHIP_MANAGEMENT         | Relationship management is available
        for eligible
        customers.                                                                                                                                                                               
        |
        NA                                                                                                                 
        |

        | UNLIMITED_TXNS                  | Unlimited free transactions
        available                                                                                                                                                                                                      
        |
        NA                                                                                                                 
        |
      enum:
        - ADDITIONAL_CARDS
        - BALANCE_TRANSFERS
        - BILL_PAYMENT
        - BONUS_REWARDS
        - CASHBACK_OFFER
        - CARD_ACCESS
        - COMPLEMENTARY_PRODUCT_DISCOUNTS
        - DIGITAL_BANKING
        - DIGITAL_WALLET
        - DONATE_INTEREST
        - EXTRA_REPAYMENTS
        - FRAUD_PROTECTION
        - FREE_TXNS
        - FREE_TXNS_ALLOWANCE
        - GUARANTOR
        - INSTALMENT_PLAN
        - INSURANCE
        - INTEREST_FREE
        - INTEREST_FREE_TRANSFERS
        - LOYALTY_PROGRAM
        - NOTIFICATIONS
        - NPP_ENABLED
        - NPP_PAYID
        - OFFSET
        - OTHER
        - OVERDRAFT
        - REDRAW
        - RELATIONSHIP_MANAGEMENT
        - UNLIMITED_TXNS
      type: string
      example: CARD_ACCESS
    BankingProductFeatureV2:
      properties:
        additionalInfo:
          description: >-
            Display text providing more information on the feature. Mandatory if
            the [feature
            type](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            is set to OTHER
          type: string
          example: Additional Feature Information
        additionalInfoUri:
          description: Link to a web page with more information on this feature
          type: string
          format: uri
          x-cds-type: URIString
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [featureType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            specified. Whether mandatory or not is dependent on the value of the
            [featureType.](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
          example: Type specific value, see docs
          type: string
        featureType:
          $ref: '#/components/schemas/EnumBankingProductFeatureTypeV2'
      required:
        - featureType
      type: object
      x-conditional:
        - additionalValue
        - additionalInfo
    BankingProductDetailV4:
      allOf:
        - $ref: '#/components/schemas/BankingProductV4'
        - properties:
            bundles:
              description: >-
                An array of bundles that this product participates in.  Each
                bundle is described by free form information but also by a list
                of product IDs of the other products that are included in the
                bundle.  It is assumed that the current product is included in
                the bundle also
              items:
                $ref: '#/components/schemas/BankingProductBundleV1'
              type: array
            constraints:
              description: >-
                Constraints on the application for or operation of the product
                such as minimum balances or limit thresholds
              items:
                $ref: '#/components/schemas/BankingProductConstraintV1'
              type: array
            depositRates:
              description: Interest rates available for deposits
              items:
                $ref: '#/components/schemas/BankingProductDepositRateV2'
              type: array
            eligibility:
              description: Eligibility criteria for the product
              items:
                $ref: '#/components/schemas/BankingProductEligibilityV1'
              type: array
            features:
              description: Array of features available for the product
              items:
                $ref: '#/components/schemas/BankingProductFeatureV2'
              type: array
            fees:
              description: Fees applicable to the product
              items:
                $ref: '#/components/schemas/BankingProductFeeV1'
              type: array
            lendingRates:
              description: Interest rates charged against lending balances
              items:
                $ref: '#/components/schemas/BankingProductLendingRateV2'
              type: array
          type: object
    ResponseBankingProductByIdV4:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingProductById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/BankingProductDetailV4'
          required:
            - data
      type: object
    EnumBankingProductConstraintTypeV2:
      description: >

        Each Product or Account has a set of Constraints. These are explained in
        a table as follows:


        | Value | Description | Use of `additionalValue` Field

        |-------|-------------|-------------------------------|

        MIN_BALANCE | A minimum balance is required for the product | The
        minimum balance in AmountString format

        MAX_BALANCE | A maximum balance is required for the product | The
        maximum balance in AmountString format

        OPENING_BALANCE | An opening balance is required for the product | The
        minimum opening balance in AmountString format

        MAX_LIMIT | A maximum limit exists (such as a maximum loan balance
        denoting the borrowable amount or maximum allowable credit limit) | The
        maximum limit in AmountString format

        MIN_LIMIT | A minimum limit exists (such as a minimum loan balance
        denoting the borrowable amount or minimum credit limit) | The minimum
        limit in AmountString format

        | MAX_LVR | A maximum LVR (Loan to Value Ratio) exists. | The maximum
        LVR in [RateString](#common-field-types) format. 

        | MIN_LVR | A minimum LVR (Loan to Value Ratio) exists. | The minimum
        LVR in [RateString](#common-field-types) format.
      enum:
        - MAX_BALANCE
        - MAX_LIMIT
        - MAX_LVR
        - MIN_BALANCE
        - MIN_LIMIT
        - MIN_LVR
        - OPENING_BALANCE
      type: string
      example: MIN_BALANCE
    BankingProductConstraintV2:
      properties:
        additionalInfo:
          description: Display text providing more information on the constraint
          type: string
          example: Some information about the constraint
        additionalInfoUri:
          description: Link to a web page with more information on the constraint
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/constraints
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [constraintType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductconstrainttypedoc)
            specified.  Whether mandatory or not is dependent on the value of
            [constraintType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductconstrainttypedoc)
          type: string
          example: Type specific value, see documentation
        constraintType:
          $ref: '#/components/schemas/EnumBankingProductConstraintTypeV2'
      required:
        - constraintType
      type: object
      x-conditional:
        - additionalValue
    BankingProductDetailV5:
      allOf:
        - $ref: '#/components/schemas/BankingProductV4'
        - properties:
            bundles:
              description: >-
                An array of bundles that this product participates in.  Each
                bundle is described by free form information but also by a list
                of product IDs of the other products that are included in the
                bundle.  It is assumed that the current product is included in
                the bundle also
              items:
                $ref: '#/components/schemas/BankingProductBundleV1'
              type: array
            constraints:
              description: >-
                Constraints on the application for or operation of the product
                such as minimum balances or limit thresholds
              items:
                $ref: '#/components/schemas/BankingProductConstraintV2'
              type: array
            depositRates:
              description: Interest rates available for deposits
              items:
                $ref: '#/components/schemas/BankingProductDepositRateV2'
              type: array
            eligibility:
              description: Eligibility criteria for the product
              items:
                $ref: '#/components/schemas/BankingProductEligibilityV1'
              type: array
            features:
              description: Array of features available for the product
              items:
                $ref: '#/components/schemas/BankingProductFeatureV2'
              type: array
            fees:
              description: Fees applicable to the product
              items:
                $ref: '#/components/schemas/BankingProductFeeV1'
              type: array
            lendingRates:
              description: Interest rates charged against lending balances
              items:
                $ref: '#/components/schemas/BankingProductLendingRateV2'
              type: array
          type: object
    ResponseBankingProductByIdV5:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingProductById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/BankingProductDetailV5'
          required:
            - data
      type: object
    EnumBankingProductFeatureTypeV3:
      description: >+
        Each Product or Account has a set of Product Features. These are
        explained in a table as follows:


        | Value                           |
        Description                                                                                                                                                                                                                                
        | Use of `additionalValue`
        Field                                                                                      

        |---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|

        | ADDITIONAL_CARDS                | Additional cards can be
        requested                                                                                                                                                                                                          
        | The maximum number of additional cards.  If no maximum then should be
        set to null                                   |

        | BALANCE_TRANSFERS               | Balance transfers can be made to the
        account (eg. for credit
        cards)                                                                                                                                                                        
        |
        NA                                                                                                                 
        |

        | BILL_PAYMENT                    | The product can be attached to an
        automatic budgeting and bill payment
        service                                                                                                                                                             
        | Optional name of the
        service                                                                                       
        |

        | BONUS_REWARDS                   | Bonus loyalty rewards points are
        available                                                                                                                                                                                                 
        | Number of points
        available                                                                                         
        |

        | CARD_ACCESS                     | A card is available for the product
        to access
        funds                                                                                                                                                                                        
        | Text describing list of card types that this product can be linked
        to                                               |

        | CASHBACK_OFFER                  | Subject to terms, conditions and
        eligibility criteria, the product has a cashback offer for opening an
        account or by spending at a certain
        retailer.                                                                                       
        | The amount of the cashback offer (in
        AUD)                                                                          
        |

        | COMPLEMENTARY_PRODUCT_DISCOUNTS | Indicates that complementary,
        discounted offerings (such as gift cards, or discounted travel) is
        available                                                                                                                                 
        | Description of the complementary
        offering                                                                          
        |

        | DIGITAL_BANKING                 | Access is available to online
        banking features for the
        product                                                                                                                                                                             
        |
        NA                                                                                                                 
        |

        | DIGITAL_WALLET                  | A Digital wallet can be attached to
        the
        product                                                                                                                                                                                            
        | The name or brand of the
        wallet                                                                                    
        |

        | DONATE_INTEREST                 | Indicates that interest generated
        from the product can be automatically donated to a charity or community
        group                                                                                                                            
        |
        NA                                                                                                                 
        |

        | EXTRA_REPAYMENTS                | Indicates that the product has the
        option to accept extra repayments without incurring additional charges
        (for example Buy Now, Pay Later (BNPL) or line of credit products may
        offer the facility to repay instalments on an adhoc basis). |
        NA                                                                                                                 
        |

        | FRAUD_PROTECTION                | The product includes fraud
        protection
        features.                                                                                                                                                                                            
        |
        NA                                                                                                                 
        |

        | FREE_TXNS                       | A set number of free transactions
        available per
        month                                                                                                                                                                                      
        | The number of free
        transactions                                                                                    
        |

        | FREE_TXNS_ALLOWANCE             | A set amount of transaction fee
        value that is discounted per
        month                                                                                                                                                                         
        | The amount of transaction fee discounted (in
        AUD)                                                                   |

        | FUNDS_AVAILABLE_AFTER           | Deposited funds are available after
        a specified time period. This is distinct from a term deposit
        duration.                                                                                                                                
        |
        NA                                                                                                                 
        |

        | GUARANTOR                       | Subject to terms and conditions, the
        customer may be able to nominate a guarantor during the origination
        process.                                                                                                                          
        |
        NA                                                                                                                 
        |

        | INSURANCE                       | Insurance is provided as an
        additional feature of the
        product                                                                                                                                                                              
        | Text description of the type of insurance (e.g. Travel
        Insurance)                                                   |

        | INSTALMENT_PLAN                 | The product has the option to pay
        for eligible purchases over time with a set number of
        payments.                                                                                                                                          
        |
        NA                                                                                                                 
        |

        | INTEREST_FREE                   | Interest free period for
        purchases                                                                                                                                                                                                         
        | Interest free period. Formatted according to [ISO 8601
        Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) |

        | INTEREST_FREE_TRANSFERS         | Interest free period for balance
        transfers                                                                                                                                                                                                 
        | Interest free period. Formatted according to [ISO 8601
        Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) |

        | LOYALTY_PROGRAM                 | A points based loyalty program is
        available                                                                                                                                                                                                
        | Name of the loyalty
        program                                                                                        
        |

        | NOTIFICATIONS                   | Advanced notifications are available
        for the
        product                                                                                                                                                                                       
        | Description of the notification
        capability                                                                         
        |

        | NPP_ENABLED                     | An account of this product type can
        be used to receive funds as a result of a BSB/Number based NPP
        payment                                                                                                                                 
        |
        NA                                                                                                                 
        |

        | NPP_PAYID                       | An account of this product type can
        be used as the target of an NPP
        PayID                                                                                                                                                                  
        |
        NA                                                                                                                 
        |

        | OFFSET                          | An offset account can be connected
        to the
        product                                                                                                                                                                                          
        |
        NA                                                                                                                 
        |

        | OTHER                           | Another feature that can not be
        included in any of the other categories.  The additionalInfo field is
        mandatory for this
        type                                                                                                              
        |
        NA                                                                                                                 
        |

        | OVERDRAFT                       | An overdraft can be applied
        for                                                                                                                                                                                                            
        |
        NA                                                                                                                 
        |

        | REDRAW                          | Redraw of repaid principal above
        minimum required is
        available                                                                                                                                                                             
        |
        NA                                                                                                                 
        |

        | RELATIONSHIP_MANAGEMENT         | Relationship management is available
        for eligible
        customers.                                                                                                                                                                               
        |
        NA                                                                                                                 
        |

        | UNLIMITED_TXNS                  | Unlimited free transactions
        available                                                                                                                                                                                                      
        |
        NA                                                                                                                 
        |

      enum:
        - ADDITIONAL_CARDS
        - BALANCE_TRANSFERS
        - BILL_PAYMENT
        - BONUS_REWARDS
        - CASHBACK_OFFER
        - CARD_ACCESS
        - COMPLEMENTARY_PRODUCT_DISCOUNTS
        - DIGITAL_BANKING
        - DIGITAL_WALLET
        - DONATE_INTEREST
        - EXTRA_REPAYMENTS
        - FRAUD_PROTECTION
        - FREE_TXNS
        - FREE_TXNS_ALLOWANCE
        - FUNDS_AVAILABLE_AFTER
        - GUARANTOR
        - INSTALMENT_PLAN
        - INSURANCE
        - INTEREST_FREE
        - INTEREST_FREE_TRANSFERS
        - LOYALTY_PROGRAM
        - NOTIFICATIONS
        - NPP_ENABLED
        - NPP_PAYID
        - OFFSET
        - OTHER
        - OVERDRAFT
        - REDRAW
        - RELATIONSHIP_MANAGEMENT
        - UNLIMITED_TXNS
      type: string
      example: CARD_ACCESS
    BankingProductFeatureV3:
      properties:
        additionalInfo:
          description: >-
            Display text providing more information on the feature. Mandatory if
            the [feature
            type](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            is set to OTHER
          type: string
          example: Additional Feature Information
        additionalInfoUri:
          description: Link to a web page with more information on this feature
          type: string
          format: uri
          x-cds-type: URIString
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [featureType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            specified. Whether mandatory or not is dependent on the value of the
            [featureType.](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
          example: Type specific value, see docs
          type: string
        featureType:
          $ref: '#/components/schemas/EnumBankingProductFeatureTypeV3'
      required:
        - featureType
      type: object
      x-conditional:
        - additionalValue
        - additionalInfo
    EnumBankingProductConstraintTypeV3:
      description: >
        Each Product or Account has a set of Constraints. These are explained in
        a table as follows:


        | Value           |
        Description                                                                                                                     
        | Use of `additionalValue` Field                               

        |-----------------|----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|
         MIN_BALANCE     | A minimum balance is required for the product                                                                                    | The minimum balance in AmountString format                   
         MAX_BALANCE     | A maximum balance is required for the product                                                                                    | The maximum balance in AmountString format                   
         OPENING_BALANCE | An opening balance is required for the product                                                                                   | The minimum opening balance in AmountString format           
         MAX_LIMIT       | A maximum limit exists (such as a maximum loan balance denoting the borrowable amount or maximum allowable credit limit)         | The maximum limit in AmountString format                     
         MIN_LIMIT       | A minimum limit exists (such as a minimum loan balance denoting the borrowable amount or minimum credit limit)                   | The minimum limit in AmountString format                     
        | MAX_LVR         | A maximum LVR (Loan to Value Ratio)
        exists.                                                                                     
        | The maximum LVR in [RateString](#common-field-types) format. 

        | MIN_LVR         | A minimum LVR (Loan to Value Ratio)
        exists.                                                                                     
        | The minimum LVR in [RateString](#common-field-types) format. 

        | OTHER           | Another constraint that can not be included in any
        of the other categories. The additionalInfo field is mandatory for this
        type. | The minimum LVR in [RateString](#common-field-types) format.
      enum:
        - MAX_BALANCE
        - MAX_LIMIT
        - MAX_LVR
        - MIN_BALANCE
        - MIN_LIMIT
        - MIN_LVR
        - OPENING_BALANCE
        - OTHER
      type: string
      example: MIN_BALANCE
    BankingProductConstraintV3:
      properties:
        additionalInfo:
          description: >-
            Display text providing more information on the constraint. Mandatory
            if constraintType = OTHER
          type: string
          example: Some information about the constraint
        additionalInfoUri:
          description: Link to a web page with more information on the constraint
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/constraints
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [constraintType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductconstrainttypedoc)
            specified.  Whether mandatory or not is dependent on the value of
            [constraintType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductconstrainttypedoc)
          type: string
          example: Type specific value, see documentation
        constraintType:
          $ref: '#/components/schemas/EnumBankingProductConstraintTypeV3'
      required:
        - constraintType
      type: object
      x-conditional:
        - additionalValue
        - additionalInfo
    BankingProductEligibilityV2:
      properties:
        additionalInfo:
          description: >-
            Display text providing more information on the
            [eligibility](https://consumerdatastandardsaustralia.github.io/standards/#tocSproducteligibilitytypedoc)
            criteria. Mandatory if the eligibilityType value is OTHER.
          type: string
          example: Eligibility Criteria
        additionalInfoUri:
          description: >-
            Link to a web page with more information on this eligibility
            criteria
          type: string
          format: uri
          x-cds-type: URIString
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [eligibilityType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproducteligibilitytypedoc)
            specified. Whether mandatory or not is dependent on the value of
            [eligibilityType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproducteligibilitytypedoc)
          type: string
          example: Type dependent value, see docs
        eligibilityType:
          $ref: '#/components/schemas/EnumBankingProductEligibilityTypeV1'
      required:
        - eligibilityType
      type: object
      x-conditional:
        - additionalValue
        - additionalInfo
    EnumBankingProductFeeTypeV2:
      description: >

        Each Product or Account has a set of Fee Types. These are explained in a
        table as follows:

        | **Fee Type**       |
        **Description**                                                                                                            
        | **Additional Conditions / Notes**                                    |

        | ------------------ |
        ---------------------------------------------------------------------------------------------------------------------------
        | -------------------------------------------------------------------- |

        | `CASH_ADVANCE`     | A fee associated with a cash
        advance.                                                                                      
        | N/A                                                                  |

        | `DEPOSIT`          | A fee associated with making a
        deposit.                                                                                    
        | N/A                                                                  |

        | `DISHONOUR`        | A fee associated with a
        dishonour.                                                                                         
        | N/A                                                                  |

        | `ENQUIRY`          | A fee associated with an enquiry, including a
        balance
        enquiry.                                                              |
        N/A                                                                  |

        | `EVENT`            | A fee in relation to a particular event (e.g.,
        ordering a new card, viewing a balance or stopping a
        cheque).                |
        N/A                                                                  |

        | `EXIT`             | A fee for closing the
        product.                                                                                             
        | N/A                                                                  |

        | `LATE_PAYMENT`     | A fee associated with making a payment after a
        due
        date.                                                                   
        | Number of days late, after which the associated fee will be applied. |

        | `OTHER`            | Another fee that cannot be included in any of the
        other
        categories.                                                         |
        The `additionalInfo` field is **mandatory** for this type.           |

        | `PAYMENT`          | A fee associated with making a
        payment.                                                                                    
        | N/A                                                                  |

        | `PERIODIC`         | A periodic fee such as a monthly account
        servicing
        fee.                                                                    
        | The period of charge, formatted according to **ISO 8601 Durations**. |

        | `PURCHASE`         | A fee associated with making a purchase at a
        merchant.                                                                     
        | N/A                                                                  |

        | `REPLACEMENT`      | A fee associated with receiving a replacement,
        including cards, cheques, statements, security
        tokens.                       |
        N/A                                                                  |

        | `TRANSACTION`      | A fee associated with any transaction
        (incorporates WITHDRAWAL, DEPOSIT, PAYMENT and
        PURCHASE).                             |
        N/A                                                                  |

        | `UPFRONT`          | A fee paid at the beginning of the product
        lifecycle, such as an establishment fee, loyalty program fee or
        application fee. |
        N/A                                                                  |

        | `UPFRONT_PER_PLAN` | A fee paid at the creation of a new payment plan,
        such as an instalment
        plan.                                               |
        N/A                                                                  |

        | `VARIATION`        | A fee associated with a request for a variation,
        including to an existing process, instruction or
        terms.                    |
        N/A                                                                  |

        | `WITHDRAWAL`       | A fee associated with making a
        withdrawal.                                                                                 
        | N/A                                                                  |
      enum:
        - CASH_ADVANCE
        - DEPOSIT
        - DISHONOUR
        - ENQUIRY
        - EVENT
        - EXIT
        - LATE_PAYMENT
        - OTHER
        - PAYMENT
        - PERIODIC
        - PURCHASE
        - REPLACEMENT
        - TRANSACTION
        - UPFRONT
        - UPFRONT_PER_PLAN
        - VARIATION
        - WITHDRAWAL
      example: CASH_ADVANCE
      type: string
    BankingFeeAmountV1:
      properties:
        amount:
          description: The specific amount charged for the fee each time it is incurred.
          type: string
          x-cds-type: AmountString
          example: '10.00'
      required:
        - amount
      type: object
    BankingFeeRangeV1:
      description: >-
        A minimum or maximum fee amount where a specific fixed amount is not
        known until the fee is incurred.
      properties:
        feeMinimum:
          description: The minimum fee that will be charged per occurrence.
          type: string
          x-cds-type: AmountString
        feeMaximum:
          description: The maximum fee that will be charged per occurrence.
          type: string
          x-cds-type: AmountString
      type: object
    BankingFeeRateV1:
      properties:
        rateType:
          description: >-
            Type of fee rate calculation.<ul><li>`BALANCE` A fee rate based on a
            balance</li><li>`INTEREST_ACCRUED` A fee rate based on interest
            accrued</li><li>`TRANSACTION` A fee rate based on a
            transaction.</li></ul>
          enum:
            - BALANCE
            - INTEREST_ACCRUED
            - TRANSACTION
          type: string
          example: BALANCE
        rate:
          description: The fee rate calculated according to the _rateType_.
          type: string
          x-cds-type: RateString
          example: '0.05'
        accrualFrequency:
          description: >-
            The indicative frequency with which the fee is calculated on the
            account if applicable. Formatted according to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax).
          type: string
          x-cds-type: ExternalRef
        amountRange:
          $ref: '#/components/schemas/BankingFeeRangeV1'
      required:
        - rate
        - rateType
      type: object
      x-conditional:
        - balanceRate
        - transactionRate
        - accruedRate
    BankingFeeDiscountAmountV1:
      properties:
        amount:
          description: >-
            The specific amount discounted from the fee each time it is
            incurred.
          type: string
          x-cds-type: AmountString
          example: '10.00'
      required:
        - amount
      type: object
    BankingFeeDiscountRangeV1:
      description: >-
        A minimum or maximum fee discount amount where a specific fixed amount
        is not known until the fee is incurred.
      properties:
        discountMinimum:
          description: The minimum fee discount that will be applied per occurrence.
          type: string
          x-cds-type: AmountString
        discountMaximum:
          description: The maximum fee discount that will be applied per occurrence.
          type: string
          x-cds-type: AmountString
      type: object
    BankingFeeDiscountRateV1:
      properties:
        rateType:
          description: >-
            Type of fee rate discount calculation.<ul><li>`BALANCE` A fee rate
            discount based on a balance</li><li>`FEE` A fee rate discount based
            on the fee to which the discount is
            attached</li><li>`INTEREST_ACCRUED` A fee rate discount based on
            interest accrued</li><li>`TRANSACTION` A fee rate discount based on
            a transaction.</li></ul>
          enum:
            - BALANCE
            - FEE
            - INTEREST_ACCRUED
            - TRANSACTION
          type: string
          example: FEE
        rate:
          description: The fee rate discount calculated according to the _rateType_.
          type: string
          x-cds-type: RateString
          example: '0.05'
        amountRange:
          $ref: '#/components/schemas/BankingFeeDiscountRangeV1'
      required:
        - rate
        - rateType
      type: object
    BankingProductDiscountV2:
      description: >-
        Note that the currency of the fee discount is expected to be the same as
        the currency of the fee itself.
      properties:
        description:
          description: Description of the discount.
          type: string
          example: Christmas special discount
        discountType:
          description: >-
            The type of discount. For further details, refer to [Product
            Discount Types](#tocSproductdiscounttypedoc).
          enum:
            - BALANCE
            - DEPOSITS
            - ELIGIBILITY_ONLY
            - FEE_CAP
            - PAYMENTS
          type: string
          example: PAYMENTS
        discountMethodUType:
          description: Reference to the applicable fee discount method structure.
          enum:
            - fixedAmount
            - rateBased
          type: string
          example: fixedAmount
        fixedAmount:
          allOf:
            - $ref: '#/components/schemas/BankingFeeDiscountAmountV1'
          description: >-
            Mandatory if the _discountMethodUType_ value is `fixedAmount`. Where
            the discount is a specific amount.
        rateBased:
          allOf:
            - $ref: '#/components/schemas/BankingFeeDiscountRateV1'
          description: >-
            Mandatory if the _discountMethodUType_ value is `rateBased`. Where
            the discount is based on a type of rate. Unless noted in
            _additionalInfo_, assumes the application and calculation frequency
            are the same as the corresponding fee.
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [_discountType_](#tocSproductdiscounttypedoc) specified. Whether
            mandatory or not is dependent on the value of
            [_discountType_](#tocSproductdiscounttypedoc).
          type: string
        additionalInfo:
          description: Display text providing more information on the discount.
          type: string
        additionalInfoUri:
          description: Link to a web page with more information on this discount.
          type: string
          format: uri
          x-cds-type: URIString
        eligibility:
          description: >-
            Eligibility constraints that apply to this discount. Mandatory if
            _discountType_ is `ELIGIBILITY_ONLY`.
          items:
            $ref: '#/components/schemas/BankingProductDiscountEligibilityV1'
          type: array
      required:
        - description
        - discountMethodUType
        - discountType
      type: object
      x-conditional:
        - fixedAmount
        - rateBased
        - additionalValue
        - eligibility
    BankingProductFeeV2:
      properties:
        name:
          description: Name of the fee.
          type: string
          example: Special fee
        feeType:
          $ref: '#/components/schemas/EnumBankingProductFeeTypeV2'
        feeMethodUType:
          description: Reference to the applicable fee charging method structure.
          enum:
            - fixedAmount
            - rateBased
            - variable
          type: string
          example: rateBased
        fixedAmount:
          allOf:
            - $ref: '#/components/schemas/BankingFeeAmountV1'
          description: >-
            Mandatory if the _feeMethodUType_ value is `fixedAmount`. Where the
            fee is a specific amount.
        rateBased:
          allOf:
            - $ref: '#/components/schemas/BankingFeeRateV1'
          description: >-
            Mandatory if the _feeMethodUType_ value is `rateBased`. Where the
            fee is based on a type of rate.
        variable:
          allOf:
            - $ref: '#/components/schemas/BankingFeeRangeV1'
          description: >-
            Mandatory if the _feeMethodUType_ value is `variable`. Where the
            amount or rate may not be known until the fee is incurred.
        feeCap:
          description: >-
            The cap amount if multiple occurrences of the fee are capped to a
            limit.
          type: string
          x-cds-type: AmountString
        feeCapPeriod:
          description: >-
            Specifies a duration over which multiple occurrences of the fee will
            be capped. Formatted according to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax).
          type: string
          x-cds-type: ExternalRef
        currency:
          default: AUD
          description: The currency the fee will be charged in. Assumes `AUD` if absent.
          type: string
          x-cds-type: CurrencyString
          pattern: \w{3}
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [_feeType_](#tocSproductfeetypedoc) specified. Whether mandatory or
            not is dependent on the value of
            [_feeType_](#tocSproductfeetypedoc).
          type: string
        additionalInfo:
          description: >-
            Display text providing more information on the fee. Mandatory if the
            feeType value is OTHER.
          type: string
        additionalInfoUri:
          description: Link to a web page with more information on this fee.
          type: string
          format: uri
          x-cds-type: URIString
        discounts:
          description: An optional list of discounts to this fee that may be available.
          items:
            $ref: '#/components/schemas/BankingProductDiscountV2'
          type: array
      required:
        - feeMethodUType
        - feeType
        - name
      type: object
      x-conditional:
        - fixedAmount
        - rateBased
        - variable
        - additionalValue
        - additionalInfo
    BankingProductRateConditionV2:
      description: Defines a condition for the applicability of a rate.
      properties:
        rateApplicabilityType:
          description: >-
            Category of applicability condition associated with the rate. For
            more information refer to [Rate and Tier Applicability
            Types](#tocSbankingproductrateconditiondoc).
          enum:
            - MIN_DEPOSITS
            - MIN_DEPOSIT_AMOUNT
            - DEPOSIT_BALANCE_INCREASED
            - EXISTING_CUST
            - NEW_ACCOUNTS
            - NEW_CUSTOMER
            - NEW_CUSTOMER_TO_GROUP
            - ONLINE_ONLY
            - OTHER
            - MIN_PURCHASES
            - MAX_WITHDRAWALS
            - MAX_WITHDRAWAL_AMOUNT
          example: NEW_CUSTOMER
          type: string
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            _rateApplicabilityType_ specified. Whether mandatory or not is
            dependent on the value of
            [_rateApplicabilityType_](#tocSbankingproductrateconditiondoc).
          type: string
        additionalInfo:
          description: >-
            Display text providing more information on the condition. Mandatory
            if the
            [_rateApplicabilityType_](#tocSbankingproductrateconditiondoc) value
            is `OTHER`.
          type: string
        additionalInfoUri:
          description: Link to a web page with more information on this condition.
          type: string
          format: uri
          x-cds-type: URIString
      required:
        - rateApplicabilityType
      type: object
      x-conditional:
        - additionalValue
        - additionalInfo
    BankingProductRateTierV4:
      description: Defines the criteria and conditions for which a rate applies.
      properties:
        name:
          description: A display name for the tier.
          type: string
          example: Sample display name
        unitOfMeasure:
          description: >-
            The unit of measure that applies to the _minimumValue_ and
            _maximumValue_ values, e.g.,<ul><li>`DOLLAR` for a dollar amount
            (with values in AmountString format)<li>`PERCENT` for Loan-to-Value
            Ratio or LVR (with values in RateString format)<li>`MONTH` or `DAY`
            for a period representing a discrete number of months or days for a
            fixed-term deposit or loan (with values as a string containing a
            positive integer).</ul>
          enum:
            - DAY
            - DOLLAR
            - MONTH
            - PERCENT
          type: string
          example: DAY
        minimumValue:
          description: >-
            The number of _unitOfMeasure_ units that form the lower bound of the
            tier. The tier should be inclusive of this value.
          type: string
          example: '10'
        maximumValue:
          description: >-
            The number of _unitOfMeasure_ units that form the upper bound of the
            tier or band. For a tier with a discrete value (as opposed to a
            range of values e.g., 1 month) this must be the same as
            _minimumValue_. Where this is the same as the _minimumValue_ value
            of the next-higher tier the referenced tier should be exclusive of
            this value. For example a term deposit of 2 months falls into the
            upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If
            absent the tier's range has no upper bound.
          type: string
        rateApplicationMethod:
          description: >-
            The method used to calculate the amount to be applied using one or
            more tiers. A single rate may be applied to the entire balance or
            each applicable tier rate is applied to the portion of the balance
            that falls into that tier (referred to as 'bands' or 'steps').
          enum:
            - PER_TIER
            - WHOLE_BALANCE
          type: string
        applicabilityConditions:
          description: Applicability conditions for the rate tier.
          items:
            $ref: '#/components/schemas/BankingProductRateConditionV2'
          type: array
        additionalInfo:
          description: Display text providing more information on the rate tier.
          type: string
        additionalInfoUri:
          description: Link to a web page with more information on this rate tier.
          type: string
          format: uri
          x-cds-type: URIString
      required:
        - minimumValue
        - name
        - unitOfMeasure
      type: object
    BankingProductDepositRateV3:
      properties:
        depositRateType:
          $ref: '#/components/schemas/EnumBankingDepositRateTypeV1'
        rate:
          description: The rate to be applied.
          type: string
          x-cds-type: RateString
          example: '0.05'
        calculationFrequency:
          description: >-
            The period after which the rate is applied to the balance to
            calculate the amount due for the period. Calculation of the amount
            is often daily (as balances may change) but accumulated until the
            total amount is 'applied' to the account (see
            _applicationFrequency_). Formatted according to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax).
          type: string
          x-cds-type: ExternalRef
        applicationType:
          description: The type of approach used to apply the rate to the account.
          enum:
            - MATURITY
            - PERIODIC
            - UPFRONT
          example: PERIODIC
          type: string
        applicationFrequency:
          description: >-
            The period after which the calculated amount(s) (see
            _calculationFrequency_) are 'applied' (i.e. debited or credited) to
            the account. Formatted according to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax). Mandatory if the _applicationType_
            value is `PERIODIC`.
          type: string
          x-cds-type: ExternalRef
        tiers:
          description: Rate tiers applicable for this rate.
          items:
            $ref: '#/components/schemas/BankingProductRateTierV4'
          type: array
        applicabilityConditions:
          description: Applicability conditions for the rate.
          items:
            $ref: '#/components/schemas/BankingProductRateConditionV2'
          type: array
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [_depositRateType_](#tocSproductdepositratetypedoc) specified.
            Whether mandatory or not is dependent on the value of
            [_depositRateType_](#tocSproductdepositratetypedoc).
          type: string
        additionalInfo:
          description: Display text providing more information on the rate.
          type: string
        additionalInfoUri:
          description: Link to a web page with more information on this rate.
          type: string
          format: uri
          x-cds-type: URIString
      required:
        - applicationType
        - depositRateType
        - rate
      type: object
      x-conditional:
        - additionalValue
        - applicationFrequency
    EnumBankingLendingRateTypeV2:
      description: >
        The type of rate (base, bonus, etc). These are explained in a table as
        follows:


        | Value                    |
        Description                                                                                                                               
        | Use of `additionalValue`
        Field                                                          

        |--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|
         FIXED                    | Fixed rate for a period of time                                                                                                            | The period of time fixed. Formatted according to ISO 8601 Durations                     
         VARIABLE                 | A variable base rate for the product                                                                                                       | NA                                                                                      
         INTRODUCTORY             | An introductory discount that will expire after a set period                                                                               | The period of time for the introductory rate. Formatted according to ISO 8601 Durations 
         DISCOUNT                 | A specific discount rate that may be applied. A discount rate reduces the interest payable                                                 | Description of the discount rate that is applicable                                     
         PENALTY                  | A specific penalty rate that may be applied. A penalty rate increases the interest payable                                                 | Description of the penalty rate that is applicable                                      
         FLOATING                 | A floating rate is relatively fixed but still adjusts under specific circumstances                                                         | Details of the float parameters                                                         
         MARKET_LINKED            | A rate that is linked to a specific market, commodity or asset class                                                                       | Details of the market linkage                                                           
         CASH_ADVANCE             | Specific rate applied to cash advances from the account                                                                                    | NA                                                                                      
         PURCHASE                 | Specific rate applied to purchases from the account                                                                                        | NA                                                                                      
         BUNDLE_DISCOUNT_FIXED    | A discount rate off the fixed rate obtained by originating a bundle instead of a standalone product                                        | The name of the bundle                                                                  
         BUNDLE_DISCOUNT_VARIABLE | A discount rate off the variable rate obtained by originating a bundle instead of a standalone product                                     | The name of the bundle                                                                  
         BALANCE_TRANSFER         | Specific rate applied to balance transfers to the account. This is expected to apply to products in the CRED_AND_CHRG_CARDS category only. | NA
      enum:
        - BUNDLE_DISCOUNT_FIXED
        - BUNDLE_DISCOUNT_VARIABLE
        - CASH_ADVANCE
        - DISCOUNT
        - FIXED
        - FLOATING
        - INTRODUCTORY
        - MARKET_LINKED
        - PENALTY
        - PURCHASE
        - VARIABLE
        - BALANCE_TRANSFER
      type: string
      example: FIXED
    EnumBankingProductLendingRateRepaymentTypeV2:
      description: Option in place for repayments.
      enum:
        - INTEREST_ONLY
        - OTHER
        - PRINCIPAL_AND_INTEREST
        - UNCONSTRAINED
      type: string
    EnumBankingLoanPurposeV2:
      description: The reason for taking out the loan.
      enum:
        - INVESTMENT
        - OTHER
        - OWNER_OCCUPIED
        - UNCONSTRAINED
      type: string
    BankingProductLendingRateV3:
      properties:
        lendingRateType:
          $ref: '#/components/schemas/EnumBankingLendingRateTypeV2'
        rate:
          description: The rate to be applied.
          type: string
          x-cds-type: RateString
          example: '0.05'
        comparisonRate:
          description: A comparison rate equivalent for this rate.
          type: string
          x-cds-type: RateString
        calculationFrequency:
          description: >-
            The period after which the rate is applied to the balance to
            calculate the amount due for the period. Calculation of the amount
            is often daily (as balances may change) but accumulated until the
            total amount is 'applied' to the account (see
            _applicationFrequency_). Formatted according to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax).
          type: string
          x-cds-type: ExternalRef
        applicationType:
          description: The type of approach used to apply the rate to the account.
          enum:
            - MATURITY
            - PERIODIC
            - UPFRONT
          example: PERIODIC
          type: string
        applicationFrequency:
          description: >-
            The period after which the calculated amount(s) (see
            _calculationFrequency_) are 'applied' (i.e. debited or credited) to
            the account. Formatted according to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax). Mandatory if the _applicationType_
            value is `PERIODIC`.
          type: string
          x-cds-type: ExternalRef
        interestPaymentDue:
          description: >-
            When loan payments are due to be paid within each period. The
            investment benefit of earlier payments affect the rate that can be
            offered.
          enum:
            - IN_ADVANCE
            - IN_ARREARS
          type: string
        repaymentType:
          $ref: '#/components/schemas/EnumBankingProductLendingRateRepaymentTypeV2'
        loanPurpose:
          $ref: '#/components/schemas/EnumBankingLoanPurposeV2'
        tiers:
          description: Rate tiers applicable for this rate.
          items:
            $ref: '#/components/schemas/BankingProductRateTierV4'
          type: array
        applicabilityConditions:
          description: Applicability conditions for the rate.
          items:
            $ref: '#/components/schemas/BankingProductRateConditionV2'
          type: array
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [_lendingRateType_] specified. Whether mandatory or not is dependent
            on the value of [_lendingRateType_].
          type: string
        additionalInfo:
          description: Display text providing more information on the rate.
          type: string
        additionalInfoUri:
          description: Link to a web page with more information on this rate.
          type: string
          format: uri
          x-cds-type: URIString
      required:
        - applicationType
        - lendingRateType
        - loanPurpose
        - rate
        - repaymentType
      type: object
      x-conditional:
        - additionalValue
        - applicationFrequency
    BankingProductDetailV6:
      allOf:
        - $ref: '#/components/schemas/BankingProductV5'
        - properties:
            bundles:
              description: >-
                An array of bundles that this product participates in. Each
                bundle is described by free form information but also by a list
                of _productID_ values of the other products that are included in
                the bundle. It is assumed that the current product is included
                in the bundle also.
              items:
                $ref: '#/components/schemas/BankingProductBundleV1'
              type: array
            features:
              description: Array of features and limitations of the product.
              items:
                $ref: '#/components/schemas/BankingProductFeatureV3'
              type: array
            constraints:
              description: >-
                Constraints on the application for the product such as minimum
                balances or limit thresholds.
              items:
                $ref: '#/components/schemas/BankingProductConstraintV3'
              type: array
            eligibility:
              description: Eligibility criteria for the product.
              items:
                $ref: '#/components/schemas/BankingProductEligibilityV2'
              type: array
            fees:
              description: Fees applicable to the product.
              items:
                $ref: '#/components/schemas/BankingProductFeeV2'
              type: array
            depositRates:
              description: Interest rates available for deposits.
              items:
                $ref: '#/components/schemas/BankingProductDepositRateV3'
              type: array
            lendingRates:
              description: Interest rates charged against lending balances.
              items:
                $ref: '#/components/schemas/BankingProductLendingRateV3'
              type: array
          type: object
    ResponseBankingProductByIdV6:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingProductById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/BankingProductDetailV6'
          required:
            - data
      type: object
    EnumBankingProductFeatureTypeV4:
      description: >+
        Each Product or Account has a set of Product Features. These are
        explained in a table as follows:


        | Value                           |
        Description                                                                                                                                                                                                                                                          
        | Use of `additionalValue`
        Field                                                                                      

        |---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|

        | ADDITIONAL_CARDS                | Additional cards can be
        requested                                                                                                                                                                                                                                    
        | The maximum number of additional cards.  If no maximum then should be
        set to null                                   |

        | BALANCE_TRANSFERS               | Balance transfers can be made to the
        account (eg. for credit
        cards)                                                                                                                                                                                                  
        |
        NA                                                                                                                 
        |

        | BILL_PAYMENT                    | The product can be attached to an
        automatic budgeting and bill payment
        service                                                                                                                                                                                       
        | Optional name of the
        service                                                                                       
        |

        | BONUS_REWARDS                   | Bonus loyalty rewards points are
        available                                                                                                                                                                                                                           
        | Number of points
        available                                                                                         
        |

        | CARD_ACCESS                     | A card is available for the product
        to access
        funds                                                                                                                                                                                                                  
        | Text describing list of card types that this product can be linked
        to                                               |

        | CASHBACK_OFFER                  | Subject to terms, conditions and
        eligibility criteria, the product has a cashback offer for opening an
        account or by spending at a certain
        retailer.                                                                                                                 
        | The amount of the cashback offer (in
        AUD)                                                                          
        |

        | COMPLEMENTARY_PRODUCT_DISCOUNTS | Indicates that complementary,
        discounted offerings (such as gift cards, or discounted travel) is
        available                                                                                                                                                           
        | Description of the complementary
        offering                                                                          
        |

        | DIGITAL_BANKING                 | Access is available to online
        banking features for the
        product                                                                                                                                                                                                       
        |
        NA                                                                                                                 
        |

        | DIGITAL_WALLET                  | A Digital wallet can be attached to
        the
        product                                                                                                                                                                                                                      
        | The name or brand of the
        wallet                                                                                    
        |

        | DONATE_INTEREST                 | Indicates that interest generated
        from the product can be automatically donated to a charity or community
        group                                                                                                                                                      
        |
        NA                                                                                                                 
        |

        | EXTRA_REPAYMENTS                | Indicates that the product has the
        option to accept extra repayments without incurring additional charges
        (for example Buy Now, Pay Later (BNPL) or line of credit products may
        offer the facility to repay instalments on an adhoc
        basis).                           |
        NA                                                                                                                 
        |

        | FRAUD_PROTECTION                | The product includes fraud
        protection
        features.                                                                                                                                                                                                                      
        |
        NA                                                                                                                 
        |

        | FREE_TXNS                       | A set number of free transactions
        available per
        month                                                                                                                                                                                                                
        | The number of free
        transactions                                                                                    
        |

        | FREE_TXNS_ALLOWANCE             | A set amount of transaction fee
        value that is discounted per
        month                                                                                                                                                                                                   
        | The amount of transaction fee discounted (in
        AUD)                                                                   |

        | FUNDS_AVAILABLE_AFTER           | Deposited funds are available after
        a specified time period. This is distinct from a term deposit
        duration.                                                                                                                                                          
        |
        NA                                                                                                                 
        |

        | GUARANTOR                       | Subject to terms and conditions, the
        customer may be able to nominate a guarantor during the origination
        process.                                                                                                                                                    
        |
        NA                                                                                                                 
        |

        | INSURANCE                       | Insurance is provided as an
        additional feature of the
        product                                                                                                                                                                                                        
        | Text description of the type of insurance (e.g. Travel
        Insurance)                                                   |

        | INSTALMENT_PLAN                 | The product has the option to pay
        for eligible purchases over time with a set number of
        payments.                                                                                                                                                                    
        |
        NA                                                                                                                 
        |

        | INTEREST_FREE                   | Interest free period for
        purchases                                                                                                                                                                                                                                   
        | Interest free period. Formatted according to [ISO 8601
        Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) |

        | INTEREST_FREE_TRANSFERS         | Interest free period for balance
        transfers                                                                                                                                                                                                                           
        | Interest free period. Formatted according to [ISO 8601
        Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) |

        | LOYALTY_PROGRAM                 | A points based loyalty program is
        available                                                                                                                                                                                                                          
        | Name of the loyalty
        program                                                                                        
        |

        | NOTIFICATIONS                   | Advanced notifications are available
        for the
        product                                                                                                                                                                                                                 
        | Description of the notification
        capability                                                                         
        |

        | NPP_ENABLED                     | An account of this product type can
        be used to receive funds as a result of a BSB/Number based NPP
        payment                                                                                                                                                           
        |
        NA                                                                                                                 
        |

        | NPP_PAYID                       | An account of this product type can
        be used as the target of an NPP
        PayID                                                                                                                                                                                            
        |
        NA                                                                                                                 
        |

        | OFFSET                          | An offset account can be connected
        to the
        product                                                                                                                                                                                                                    
        |
        NA                                                                                                                 
        |

        | OTHER                           | Another feature that can not be
        included in any of the other categories.  The additionalInfo field is
        mandatory for this
        type                                                                                                                                        
        |
        NA                                                                                                                 
        |

        | OVERDRAFT                       | An overdraft can be applied
        for                                                                                                                                                                                                                                      
        |
        NA                                                                                                                 
        |

        | REDRAW                          | Redraw of repaid principal above
        minimum required is
        available                                                                                                                                                                                                       
        |
        NA                                                                                                                 
        |

        | RELATIONSHIP_MANAGEMENT         | Relationship management is available
        for eligible
        customers.                                                                                                                                                                                                         
        |
        NA                                                                                                                 
        |

        | UNLIMITED_TXNS                  | Unlimited free transactions
        available                                                                                                                                                                                                                                
        |
        NA                                                                                                                 
        |

        | EXTRA_DOWN_PAYMENT              | When a transaction value would
        exceed the credit limit available for an instalment plan, there is an
        ability to make a larger than usual initial down payment to enable the
        creation of a plan based on a reduced amount outstanding, so it remains
        within the limit. |
        NA                                                                                                                 
        |

      enum:
        - ADDITIONAL_CARDS
        - BALANCE_TRANSFERS
        - BILL_PAYMENT
        - BONUS_REWARDS
        - CASHBACK_OFFER
        - CARD_ACCESS
        - COMPLEMENTARY_PRODUCT_DISCOUNTS
        - DIGITAL_BANKING
        - DIGITAL_WALLET
        - DONATE_INTEREST
        - EXTRA_REPAYMENTS
        - FRAUD_PROTECTION
        - FREE_TXNS
        - FREE_TXNS_ALLOWANCE
        - FUNDS_AVAILABLE_AFTER
        - GUARANTOR
        - INSTALMENT_PLAN
        - INSURANCE
        - INTEREST_FREE
        - INTEREST_FREE_TRANSFERS
        - LOYALTY_PROGRAM
        - NOTIFICATIONS
        - NPP_ENABLED
        - NPP_PAYID
        - OFFSET
        - OTHER
        - OVERDRAFT
        - REDRAW
        - RELATIONSHIP_MANAGEMENT
        - UNLIMITED_TXNS
        - EXTRA_DOWN_PAYMENT
      type: string
      example: CARD_ACCESS
    BankingProductFeatureV4:
      properties:
        additionalInfo:
          description: >-
            Display text providing more information on the feature. Mandatory if
            the [feature
            type](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            value is OTHER
          type: string
          example: Additional Feature Information
        additionalInfoUri:
          description: Link to a web page with more information on this feature
          type: string
          format: uri
          x-cds-type: URIString
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [featureType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            specified. Whether mandatory or not is dependent on the value of the
            [featureType.](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
          example: Type specific value, see docs
          type: string
        featureType:
          $ref: '#/components/schemas/EnumBankingProductFeatureTypeV4'
      required:
        - featureType
      type: object
      x-conditional:
        - additionalValue
        - additionalInfo
    BankingProductInstalmentsV1:
      description: Details of instalment features on the account.
      properties:
        maximumConcurrentPlans:
          description: >-
            Maximum number of concurrent active instalment plans that may be
            created on the account. If `null`, there is no predetermined maximum
            number.
          type: integer
          x-cds-type: NaturalNumber
        instalmentsLimit:
          description: >-
            Maximum combined limit of all instalment plans that may be created
            on the account. If `null` or not present, an opened account balance
            _creditLimit_ may be assumed to provide a maximum limit for
            instalments.
          type: string
          x-cds-type: AmountString
        minimumPlanValue:
          description: Minimum value that can be opened as an instalment plan.
          type: string
          x-cds-type: AmountString
        maximumPlanValue:
          description: >-
            Maximum value that can be opened as an instalment plan. If `null` or
            not present, _instalmentsLimit_ is assumed to be the maximum
            individual plan value.
          type: string
          x-cds-type: AmountString
        minimumSplit:
          description: Minimum number of instalment payments a plan can be created with.
          example: 4
          type: integer
          x-cds-type: PositiveInteger
        maximumSplit:
          description: Maximum number of instalment payments a plan can be created with.
          example: 4
          type: integer
          x-cds-type: PositiveInteger
      required:
        - maximumSplit
        - minimumSplit
      type: object
    BankingProductDetailV7:
      allOf:
        - $ref: '#/components/schemas/BankingProductV6'
        - properties:
            bundles:
              description: >-
                An array of bundles that this product participates in. Each
                bundle is described by free form information but also by a list
                of _productID_ values of the other products that are included in
                the bundle. It is assumed that the current product is included
                in the bundle also.
              items:
                $ref: '#/components/schemas/BankingProductBundleV1'
              type: array
            features:
              description: Array of features and limitations of the product.
              items:
                $ref: '#/components/schemas/BankingProductFeatureV4'
              type: array
            constraints:
              description: >-
                Constraints on the application for the product such as minimum
                balances or limit thresholds.
              items:
                $ref: '#/components/schemas/BankingProductConstraintV3'
              type: array
            eligibility:
              description: Eligibility criteria for the product.
              items:
                $ref: '#/components/schemas/BankingProductEligibilityV2'
              type: array
            fees:
              description: Fees applicable to the product.
              items:
                $ref: '#/components/schemas/BankingProductFeeV2'
              type: array
            depositRates:
              description: Interest rates available for deposits.
              items:
                $ref: '#/components/schemas/BankingProductDepositRateV3'
              type: array
            lendingRates:
              description: Interest rates charged against lending balances.
              items:
                $ref: '#/components/schemas/BankingProductLendingRateV3'
              type: array
            instalments:
              $ref: '#/components/schemas/BankingProductInstalmentsV1'
          type: object
    ResponseBankingProductByIdV7:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingProductById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/BankingProductDetailV7'
          required:
            - data
      type: object
    GetProductDetail400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ErrorResourceUnavailableV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Resource/Unavailable
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Unavailable Resource
        detail:
          description: >-
            The requested resource identifier is temporarily unavailable.
            Subsequent requests for the resource may be successful. Applies when
            the resource ID is provided in the request body. The error detail is
            the resource ID of the resource being requested.
          type: string
          example: The requested resource identifier is temporarily unavailable.
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Resource/Unavailable
          type: object
      required:
        - code
        - title
        - detail
    ErrorResourceNotFoundV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Resource/NotFound
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Resource Not Found
        detail:
          description: >-
            The requested resource URL is not an API endpoint defined by the
            Consumer Data Standards and it is not a URL recognised by the Data
            Holder or Data Recipient.
          type: string
          example: >-
            The requested resource URL is not an API endpoint defined by the
            Consumer Data Standards
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Resource/NotFound
          type: object
      required:
        - code
        - title
        - detail
    ErrorResourceInvalidV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Resource/Invalid
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Invalid Resource
        detail:
          description: >-
            The requested resource identifier is permanently unavailable. No
            subsequent request for the resource will be successful. Applies when
            the resource ID is provided in the URI. The error detail is the
            resource ID of the resource being requested.
          type: string
          example: The requested resource identifier is permanently unavailable.
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Resource/Invalid
          type: object
      required:
        - code
        - title
        - detail
    GetProductDetail404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorResourceUnavailableV1'
        - $ref: '#/components/schemas/ErrorResourceNotFoundV1'
        - $ref: '#/components/schemas/ErrorResourceInvalidV1'
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Resource/Unavailable: '#/components/schemas/ErrorResourceUnavailableV1'
          urn:au-cds:error:cds-all:Resource/NotFound: '#/components/schemas/ErrorResourceNotFoundV1'
          urn:au-cds:error:cds-all:Resource/Invalid: '#/components/schemas/ErrorResourceInvalidV1'
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    GetProductDetail406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseDiscoveryOutagesList:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseDiscoveryOutagesListV1'
      required:
        - version
        - links
      type: object
    DiscoveryOutageV1:
      properties:
        duration:
          description: >-
            Planned duration of the outage. Formatted according to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax)
          type: string
          x-cds-type: DurationString
          example: PT2H30M
        explanation:
          description: >-
            Provides an explanation of the current outage that can be displayed
            to an end customer
          type: string
          example: There is an ongoing outage
        isPartial:
          description: >-
            Flag that indicates, if present and set to true, that the outage is
            only partial meaning that only a subset of normally available
            endpoints will be affected by the outage
          type: boolean
          example: true
        outageTime:
          description: Date and time that the outage is scheduled to begin
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-08-20T01:55:05Z'
      required:
        - duration
        - explanation
        - outageTime
      type: object
    ResponseDiscoveryOutagesListV1:
      allOf:
        - $ref: '#/components/schemas/ResponseDiscoveryOutagesList'
        - type: object
          properties:
            data:
              type: object
              properties:
                outages:
                  description: >-
                    List of scheduled outages. Property is mandatory but may
                    contain and empty list if no outages are scheduled
                  items:
                    $ref: '#/components/schemas/DiscoveryOutageV1'
                  type: array
              required:
                - outages
          required:
            - data
      type: object
    GetOutages400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetOutages406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseCommonDiscoveryStatus:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseCommonDiscoveryStatusV1'
      required:
        - version
        - links
      type: object
    EnumCommonDiscoveryStatusV1:
      description: >-
        Enumeration with values. OK (implementation is fully functional).
        PARTIAL_FAILURE (one or more endpoints are unexpectedly unavailable).
        UNAVAILABLE (the full implementation is unexpectedly unavailable).
        SCHEDULED_OUTAGE (an advertised outage is in effect)
      enum:
        - OK
        - PARTIAL_FAILURE
        - SCHEDULED_OUTAGE
        - UNAVAILABLE
      type: string
      example: OK
    ResponseCommonDiscoveryStatusV1:
      allOf:
        - $ref: '#/components/schemas/ResponseCommonDiscoveryStatus'
        - type: object
          properties:
            data:
              type: object
              properties:
                detectionTime:
                  description: >-
                    The date and time that the current outage was detected.
                    Should only be present if the status property is
                    PARTIAL_FAILURE or UNAVAILABLE
                  type: string
                  format: date-time
                  x-cds-type: DateTimeString
                  example: '2022-08-20T02:23:25Z'
                expectedResolutionTime:
                  description: >-
                    The date and time that full service is expected to resume
                    (if known). Should not be present if the status property has
                    a value of OK.
                  type: string
                  format: date-time
                  x-cds-type: DateTimeString
                  example: '2022-08-21T02:23:25Z'
                explanation:
                  description: >-
                    Provides an explanation of the current outage that can be
                    displayed to an end customer. Mandatory if the status
                    property is any value other than OK
                  type: string
                  example: There is an outage we are looking into
                status:
                  $ref: '#/components/schemas/EnumCommonDiscoveryStatusV1'
                updateTime:
                  description: >-
                    The date and time that this status was last updated by the
                    Data Holder.
                  type: string
                  format: date-time
                  x-cds-type: DateTimeString
                  example: '2022-08-20T12:23:25Z'
              required:
                - status
                - updateTime
              x-conditional:
                - explanation
          required:
            - data
      type: object
    GetStatus400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetStatus406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    EnumRequestInitiateEnergySwitchV1:
      description: Supported Request Version
      enum:
        - V1
      type: string
      example: V1
    RequestInitiateEnergySwitch:
      type: object
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/RequestInitiateEnergySwitchV1'
    RequestInitiateEnergySwitchV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/RequestInitiateEnergySwitch'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/RequestInitiateEnergySwitchDataV1'
          required:
            - data
            - version
    OGResponseInitiateEnergySwitch:
      type: object
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/OGResponseInitiateEnergySwitchV1'
    OGResponseInitiateEnergySwitchV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/OGResponseInitiateEnergySwitch'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/RequestInitiateEnergySwitchDataV1'
            redirectUri:
              type: string
              format: uri
              x-cds-type: URIString
              example: https://api.provider.com.au/cds-au/v1/endpoint/path
            links:
              $ref: '#/components/schemas/LinksV1'
            meta:
              $ref: '#/components/schemas/MetaInitiateEnergySwitchV1'
          required:
            - data
            - links
            - meta
            - version
          example:
            version: V1
            data:
              connectionDetail:
                planId: ENERGY_SAVER_PLAN
                nationalMeteringId: 6987332211
                lifeSupportRequired: false
                concessionEligible: false
                electronicBills: true
              customerDetail:
                customerUType: person
                person:
                  firstName: John
                  lastName: Doe
                  middleNames: []
                  emailAddresses:
                    - address: john@doe.com
                      purpose: HOME
                  phoneNumbers:
                    - fullNumber: '+61439123123'
                      number: '0439123123'
                      purpose: MOBILE
                  physicalAddresses:
                    - addressUType: simple
                      purpose: MAIL
                      simple:
                        addressLine1: 55 McDonald Avenue
                        city: Maryville
                        postcode: '2293'
                        state: NSW
            links:
              self: >-
                https://api.provider.com.au/dio-au/actions/energy-account-switch/8ba3f97e-c22c-4516-b6ed-05c0486db195
            meta:
              actionId: 8ba3f97e-c22c-4516-b6ed-05c0486db195
              actionStatus: IN_PROGRESS
              actionStatusDescription: Energy Account Switch is currently in progress
              authStatus: COMPLETE
              authStatusDescription: Authorisation for action has been completed
    InitiateEnergySwitch400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    InitiateEnergySwitch404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    InitiateEnergySwitch406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    InitiateEnergySwitch422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    EnumDataClusterV1:
      type: string
      example: BANK_ACCOUNTS_BASIC_READ
      description: Data Cluster Breakdown
      enum:
        - OPENID
        - PROFILE
        - COMMON_CUSTOMER_BASIC_READ
        - COMMON_CUSTOMER_DETAIL_READ
        - BANK_ACCOUNTS_BASIC_READ
        - BANK_ACCOUNTS_DETAIL_READ
        - BANK_TRANSACTIONS_READ
        - BANK_REGULAR_PAYMENTS_READ
        - BANK_PAYEES_READ
        - ENERGY_ACCOUNTS_BASIC_READ
        - ENERGY_ACCOUNTS_DETAIL_READ
        - ENERGY_ACCOUNTS_CONCESSIONS_READ
        - ENERGY_ACCOUNTS_PAYMENTSCHEDULE_READ
        - ENERGY_BILLING_READ
        - ENERGY_ELECTRICITY_SERVICEPOINTS_BASIC_READ
        - ENERGY_ELECTRICITY_SERVICEPOINTS_DETAIL_READ
        - ENERGY_ELECTRICITY_DER_READ
        - ENERGY_ELECTRICITY_USAGE_READ
    EnumConsumerTypeV1:
      type: string
      description: Specific Consumer Type
      enum:
        - INDIVIDUAL
        - NON_INDIVIDUAL
    RequestSharingAgreementDataV2:
      type: object
      properties:
        agreementId:
          description: >-
            Unique Agreement Identifier, if provided during initialisation
            triggers an agreement amendment for the included duration and data
            clusters
          type: string
        sharingDuration:
          description: Length, in seconds, to request sharing to be granted for
          type: integer
          minimum: 0
          maximum: 31536000
          example: 7776000
        dataClusters:
          description: One or more data clusters to enable sharing for
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/EnumDataClusterV1'
        consumerType:
          $ref: '#/components/schemas/EnumConsumerTypeV1'
        oldestDate:
          description: Oldest Record Date, if undefined specifies no record filter
          type: string
          format: date
          x-cds-type: DateString
        newestDate:
          description: Newest Record Date, if undefined specifies no record filter
          type: string
          format: date
          x-cds-type: DateString
      required:
        - sharingDuration
        - dataClusters
      example:
        sharingDuration: 31536000
        dataClusters:
          - BANK_ACCOUNTS_BASIC_READ
    MetaRequestDataSharingV1:
      properties:
        actionId:
          description: Unique Action Identifier
          type: string
          example: 9fe3f97e-c22c-4516-b6ed-05c0486db195
        agreementId:
          description: >-
            Agreement Id assigned following Data Sharing completion. <br
            />       **MUST** be provided if `actionStatus` is `SUCCESS`.
          type: string
          format: uuid
          example: e1529071-601f-46ff-a097-97cdaba84065
        actionStatus:
          description: Current status of the requested action
          enum:
            - PENDING
            - IN_PROGRESS
            - SUCCESS
            - FAILED
          type: string
          example: IN_PROGRESS
        actionStatusDescription:
          type: string
          description: >-
            Description of the current status, can be used to provide an
            extended description
          example: Authorisation has been initiated by the User Agent
        authStatus:
          description: Authorisation Status information
          example: PRE_AUTHENTICATION
          type: string
          enum:
            - PENDING
            - PRE_IDENTIFICATION
            - PRE_AUTHENTICATION
            - MANUAL_STEP_REQUIRED
            - PRE_ACCOUNT_SELECTION
            - PRE_AUTHORISATION
            - AWAITING_CODE_CLAIM
            - COMPLETE
        authStatusDescription:
          type: string
          description: Description of the current authorisation status
          example: Customer completed identification but did not authenticate correctly
        creationDateTime:
          description: Creation Date/Time
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2024-02-31T08:14:25Z'
        lastUpdated:
          description: Last Status Update time
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2024-08-31T08:14:25Z'
      required:
        - actionId
        - actionStatus
        - actionStatusDescription
        - authStatus
        - authStatusDescription
        - lastUpdated
        - creationDateTime
      type: object
    ResponseGetSharingRequestV2:
      properties:
        version:
          type: string
          default: V2
        data:
          $ref: '#/components/schemas/RequestSharingAgreementDataV2'
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaRequestDataSharingV1'
      required:
        - data
        - links
        - meta
      type: object
      example:
        version: V2
        data:
          sharingDuration: 31536000
          dataClusters:
            - BANK_ACCOUNTS_BASIC_READ
        links:
          self: >-
            https://api.provider.com.au/dio-au/actions/request-data-sharing/8ba3f97e-c22c-4516-b6ed-05c0486db195
        meta:
          actionId: 8ba3f97e-c22c-4516-b6ed-05c0486db195
          agreementId: e1529071-601f-46ff-a097-97cdaba84065
          actionStatus: SUCCESS
          actionStatusDescription: Sharing Arrangement Established
          authStatus: COMPLETE
          authStatusDescription: Authorisation for sharing has been completed
    GetSharingRequest404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    ResponsePrincipalList:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponsePrincipalListV1'
      required:
        - version
        - links
        - meta
      type: object
    PrincipalV1:
      properties:
        id:
          type: string
          example: 4f1cc672-88be-4cd8-bbe7-3fb6981b6958
          format: uuid
          description: Unique Identifier for the Principal
        principalId:
          type: string
          example: 4f1cc672-88be-4cd8-bbe7-3fb6981b6958
          description: External unique Identifier for the Principal
        displayName:
          type: string
          description: Display Name of the Principal
          example: John Doe
      type: object
      required:
        - id
        - principalId
        - displayName
    ResponsePrincipalListV1:
      allOf:
        - $ref: '#/components/schemas/ResponsePrincipalList'
        - type: object
          properties:
            data:
              type: object
              properties:
                principals:
                  description: List of Principals
                  items:
                    $ref: '#/components/schemas/PrincipalV1'
                  type: array
              required:
                - principals
          required:
            - data
      type: object
    ResponsePrincipalDetail:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponsePrincipalDetailV1'
      required:
        - version
      type: object
    PrincipalDetailV1:
      properties:
        id:
          type: string
          example: 4f1cc672-88be-4cd8-bbe7-3fb6981b6958
          format: uuid
          description: Unique Identifier for the Principal
        principalId:
          type: string
          example: 4f1cc672-88be-4cd8-bbe7-3fb6981b6958
          description: External unique Identifier for the Principal
        displayName:
          type: string
          description: Display Name of the Principal
          example: John Doe
      type: object
      required:
        - id
        - principalId
        - displayName
    ResponsePrincipalDetailV1:
      allOf:
        - $ref: '#/components/schemas/ResponsePrincipalDetail'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/PrincipalDetailV1'
          required:
            - data
      type: object
    ErrorInvalidPrincipalV1:
      type: object
      properties:
        code:
          description: Holds an end point specific error code.
          type: string
          format: uri
          x-cds-type: URIString
          default: urn:au-biza:error:og:Principal/InvalidPrincipalId
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Invalid Principal Identifier
        detail:
          description: The specified principal identifier is invalid
          type: string
          example: The specified principal identifier is invalid
      required:
        - code
        - title
        - detail
    GetPrincipalDetail404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorInvalidPrincipalV1'
      discriminator:
        propertyName: code
    ResponseUserList:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseUserListV1'
      required:
        - version
        - links
        - meta
      type: object
    UserV1:
      properties:
        userId:
          type: string
          example: 4f1cc672-88be-4cd8-bbe7-3fb6981b6958
          description: Unique Identifier for the User
        displayName:
          type: string
          description: Display Name of the User
          example: John Doe
      type: object
      required:
        - userId
        - displayName
    ResponseUserListV1:
      allOf:
        - $ref: '#/components/schemas/ResponseUserList'
        - type: object
          properties:
            data:
              type: object
              properties:
                users:
                  description: List of Principal Users
                  items:
                    $ref: '#/components/schemas/UserV1'
                  type: array
              required:
                - users
          required:
            - data
      type: object
    ListPrincipalUsers404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorInvalidPrincipalV1'
      discriminator:
        propertyName: code
    EnumAgreementCDRSharingStatusV1:
      description: >-
        The status of the arrangement:

        - **PRIMED**: Arrangement has been Primed with information by the
        Software Product

        - **INIT**: Arrangement is in Initialisation status

        - **ACTIVE**: Sharing Arrangement is active and available

        - **EXPIRED**: Sharing Arrangement has expired

        - **REVOKED**: Sharing Arrangement has been revoked
      enum:
        - PRIMED
        - INIT
        - ACTIVE
        - EXPIRED
        - REVOKED
      type: string
      example: ACTIVE
    EnumRevisionTypeV1:
      description: >
        Describe which revisions should be returned:


        - **LATEST**: Most recent version of those stored

        - **ACTIVATED**: Only those revisions that have been activated at some
        point
      type: string
      enum:
        - LATEST
        - ACTIVATED
      example: LATEST
    ResponseAgreementList:
      type: object
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseAgreementListV1'
      required:
        - version
        - links
        - meta
    AgreementV1:
      type: object
      properties:
        id:
          description: >-
            A unique identifier for this agreement (not equal to the
            cdr_arrangement_id).
          type: string
          format: uuid
          example: 27a0d944-4eb7-452e-a63c-dc14d8f92428
        agreementType:
          description: CDR Sharing Arrangement V1 agreement type
          type: string
          default: CDR_SHARING_ARRANGEMENT_V1
      required:
        - id
        - agreementType
      discriminator:
        propertyName: agreementType
        mapping:
          CDR_SHARING_ARRANGEMENT_V1: '#/components/schemas/AgreementCDRSharingV1'
    AgreementCollectionConsentV1:
      type: object
      properties:
        id:
          description: A unique identifier for this consent
          type: string
          example: 27a0d944-4eb7-452e-a63c-dc14d8f92428
        scopes:
          description: Array of scopes which are included in this sharing arrangement
          type: array
          items:
            type: string
        duration:
          description: Specifies the number of seconds until sharing expires
          type: integer
          format: int64
          example: 86400
        purpose:
          description: A description of the purpose of this consent
          example: To perform an analysis of your spending
        createdAt:
          description: Specifies when the consent was created
          type: integer
          format: int64
          example: 1685000
        expiredAt:
          description: Specifies when the consent expired as an epoch
          type: integer
          format: int64
      required:
        - id
        - scopes
        - duration
        - purpose
        - createdAt
    AgreementUseConsentV1:
      type: object
      properties:
        id:
          description: A unique identifier for this consent
          type: string
          example: 27a0d944-4eb7-452e-a63c-dc14d8f92428
        duration:
          description: Specifies the number of seconds until sharing expires
          type: integer
          format: int64
          example: 86400
        purpose:
          description: A description of the purpose of this consent
          example: >-
            To provide you with on-going recommendations to optimise your
            spending
        createdAt:
          description: Specifies when the consent was created
          type: integer
          format: int64
          example: 1685000
        expiredAt:
          description: Specifies when the consent expired as an epoch
          type: integer
          format: int64
      required:
        - id
        - duration
        - purpose
        - createdAt
    AgreementDirectMarketingConsentV1:
      type: object
      properties:
        id:
          description: A unique identifier for this consent
          type: string
          example: 27a0d944-4eb7-452e-a63c-dc14d8f92428
        optionEnabled:
          description: Indicates if the user was shown the direct marketing consent option
          type: boolean
          example: true
        consentedTo:
          description: >-
            Indicates whether or not the user consented to direct marketing for
            this arrangement
          type: boolean
          example: true
      required:
        - id
        - optionEnabled
    AgreementConfigurationV1:
      type: object
      properties:
        softwareProductName:
          description: The name of the software product
          type: string
          example: Software Product Name
        dataRecipientBrandName:
          description: The name of the data recipient brand of the software product
          type: string
          example: Data Recipient Brand Name
        accreditationNumber:
          description: The accreditation number of the data recipient
          type: string
          example: '0012345'
        logoUri:
          description: The logo URI of the software product
          type: string
          format: uri
          example: https://logo-uri.com.au
        collectionScopes:
          description: A set of scopes that the user can select from
          type: array
          items:
            type: string
        collectionDuration:
          description: A set of collection consent durations that the user can select from
          type: array
          items:
            type: string
        collectionPurpose:
          description: A description of the purpose of the collection consent
          type: string
          example: To perform an analysis of your spending
        useDuration:
          description: A set of use consent durations that the user can select from
          type: array
          items:
            type: string
        usePurpose:
          description: A description of the purpose of the use consent
          type: string
          example: >-
            To provide you with on-going recommendations to optimise your
            spending
        directMarketingShown:
          description: >-
            Determines whether or not the user has the option to consent to
            direct marketing
          type: boolean
          example: true
        redirectUri:
          description: The URI that the user is redirected to after disclosure (DH) consent
          type: string
          format: uri
          example: https://software-product.com.au
        errorRedirectUri:
          description: >-
            URI to redirect if an error occurs during consent flow. Will be
            appended with query params * error : as returned from holder *
            errorDescription : as returned from holder * errorUri : as returned
            from holder When not specified, the redirectUri will be used instead
          type: string
          format: uri
          example: https://software-product.com.au/error
        state:
          description: An optional field that will be reflected in the response
          type: string
        dataHandlingDefault:
          description: >-
            A default option for how this software product handles redundant
            data.  This still allows for the user to change how they want the
            software product to handle redundant data.
          type: string
          enum:
            - DEIDENTIFY
            - DELETE
          example: DEIDENTIFY
        requireAllScopes:
          type: boolean
          example: true
          description: >-
            Describe data scopes - when false indicates at least one scope is
            required. When true all scopes must be consented to.
        agreementEndCallbackUrl:
          description: >-
            The POST URL webhook that will be called to post data deletion
            request with a jwt payload
          type: string
          default: ''
          example: https://software-product.com.au/data/delete
        dataHolderIndustry:
          type: array
          items:
            $ref: '#/components/schemas/EnumParticipantCapabilityV1'
          description: >-
            Only include holders that have the specified capability, empty
            implies no filtering, multiple values logical or
      required:
        - softwareProductName
        - dataRecipientBrandName
        - accreditationNumber
        - logoUri
        - collectionScopes
        - collectionDuration
        - collectionPurpose
        - useDuration
        - usePurpose
        - directMarketingShown
        - redirectUri
        - dataHandlingDefault
        - requireAllScopes
        - agreementEndCallbackUrl
    ParticipantSummaryV1:
      properties:
        participantId:
          type: string
          example: 4f1cc672-88be-4cd8-bbe7-3fb6981b6958
          format: uuid
          description: Identifier for the Participant
        participantName:
          type: string
          description: Name of the Participant
          example: ACME Bank
        logoUri:
          type: string
          description: Participant Logo URI
          format: uri
          example: https://acme.bank/logo.png
      type: object
      required:
        - participantId
        - participantName
        - logoUri
    AgreementCDRSharingV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/AgreementV1'
        - type: object
          properties:
            createdAt:
              description: Specifies when the sharing arrangement was created
              type: integer
              example: 1739414478
              format: int64
            principal:
              $ref: '#/components/schemas/PrincipalV1'
            cdrArrangementId:
              description: The CDR Sharing Arrangement identifier provided by the Holder
              type: string
              example: 99e4b801-97b2-4a07-a92e-f76e0331c959
            status:
              $ref: '#/components/schemas/EnumAgreementCDRSharingStatusV1'
            collectionConsent:
              $ref: '#/components/schemas/AgreementCollectionConsentV1'
            useConsent:
              $ref: '#/components/schemas/AgreementUseConsentV1'
            directMarketingConsent:
              $ref: '#/components/schemas/AgreementDirectMarketingConsentV1'
            configuration:
              $ref: '#/components/schemas/AgreementConfigurationV1'
            participant:
              $ref: '#/components/schemas/ParticipantSummaryV1'
          required:
            - status
            - configuration
            - createdAt
    AgreementListV1:
      type: object
      properties:
        agreements:
          description: List of Agreements
          items:
            $ref: '#/components/schemas/AgreementV1'
          type: array
      required:
        - agreements
    ResponseAgreementListV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/ResponseAgreementList'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/AgreementListV1'
          required:
            - data
    ResponseAgreementDetail:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseAgreementDetailV1'
      required:
        - version
        - links
      type: object
    AgreementDetailV1:
      type: object
      properties:
        id:
          description: >-
            A unique identifier for this agreement (not equal to the
            cdr_arrangement_id).
          type: string
          format: uuid
          example: 27a0d944-4eb7-452e-a63c-dc14d8f92428
        agreementType:
          description: CDR Sharing Arrangement V1 agreement type
          type: string
          default: CDR_SHARING_ARRANGEMENT_V1
      required:
        - id
        - agreementType
      discriminator:
        propertyName: agreementType
        mapping:
          CDR_SHARING_ARRANGEMENT_V1: '#/components/schemas/AgreementDetailCDRSharingV1'
    AgreementDetailCDRSharingV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/AgreementDetailV1'
        - type: object
          properties:
            cdrArrangementId:
              description: The CDR Sharing Arrangement identifier provided by the Holder
              type: string
              example: 99e4b801-97b2-4a07-a92e-f76e0331c959
            principal:
              $ref: '#/components/schemas/PrincipalV1'
            createdAt:
              description: Specifies when the sharing arrangement was created
              type: integer
              example: 1739414478
              format: int64
            expiresAt:
              description: Specifies when the sharing expires as an epoch
              type: integer
              example: 1739414478
              format: int64
            status:
              $ref: '#/components/schemas/EnumAgreementCDRSharingStatusV1'
            collectionConsent:
              $ref: '#/components/schemas/AgreementCollectionConsentV1'
            useConsent:
              $ref: '#/components/schemas/AgreementUseConsentV1'
            directMarketingConsent:
              $ref: '#/components/schemas/AgreementDirectMarketingConsentV1'
            configuration:
              $ref: '#/components/schemas/AgreementConfigurationV1'
            participant:
              $ref: '#/components/schemas/ParticipantV1'
          required:
            - createdAt
            - expiresAt
            - status
            - configuration
    ResponseAgreementDetailV1:
      allOf:
        - $ref: '#/components/schemas/ResponseAgreementDetail'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/AgreementDetailV1'
          required:
            - data
      type: object
    EnumAccountOpenStatusWithAllV1:
      description: Account Open Status with ALL
      default: ALL
      enum:
        - ALL
        - CLOSED
        - OPEN
      type: string
    ResponseBankingAccountList:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseBankingAccountListV1'
          V2: '#/components/schemas/ResponseBankingAccountListV2'
      required:
        - version
        - links
        - meta
      type: object
    EnumBankingAccountOpenStatusV1:
      default: OPEN
      description: >-
        Open or closed status for the account. If not present then OPEN is
        assumed
      enum:
        - CLOSED
        - OPEN
      type: string
      example: OPEN
    BankingAccountV1:
      properties:
        accountId:
          description: >-
            A unique ID of the account adhering to the standards for ID
            permanence
          type: string
          example: jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay
        creationDate:
          description: Date that the account was created (if known)
          type: string
          format: date
          x-cds-type: DateString
          example: '2020-03-01'
        displayName:
          description: >-
            The display name of the account as defined by the bank. This should
            not incorporate account numbers or PANs. If it does the values
            should be masked according to the rules of the MaskedAccountString
            common type.
          type: string
          example: ACME Savings Account
        isOwned:
          default: true
          description: >-
            Flag indicating that the customer associated with the authorisation
            is an owner of the account. Does not indicate sole ownership,
            however. If not present then 'true' is assumed
          type: boolean
          example: true
        maskedNumber:
          description: >-
            A masked version of the account. Whether BSB/Account Number, Credit
            Card PAN or another number
          type: string
          x-cds-type: MaskedAccountString
          example: XXXX-XXXX-XXXX-1234
        nickname:
          description: A customer supplied nickname for the account
          type: string
          example: Holiday Fund
        openStatus:
          $ref: '#/components/schemas/EnumBankingAccountOpenStatusV1'
        productCategory:
          $ref: '#/components/schemas/EnumBankingProductCategoryV1'
        productName:
          description: >-
            The unique identifier of the account as defined by the data holder
            (akin to model number for the account)
          type: string
          example: ACME Savings Maximiser
      required:
        - accountId
        - displayName
        - maskedNumber
        - productCategory
        - productName
      type: object
    ResponseBankingAccountListV1:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingAccountList'
        - type: object
          properties:
            data:
              type: object
              properties:
                accounts:
                  description: >-
                    The list of accounts returned. If the filter results in an
                    empty set then this array may have no records
                  items:
                    $ref: '#/components/schemas/BankingAccountV1'
                  type: array
              required:
                - accounts
          required:
            - data
      type: object
    EnumBankingAccountOwnershipV1:
      description: >-
        Value indicating the number of customers that have ownership of the
        account, according to the data holder's definition of account ownership.
        Does not indicate that all account owners are eligible consumers
      enum:
        - UNKNOWN
        - ONE_PARTY
        - TWO_PARTY
        - MANY_PARTY
        - OTHER
      type: string
      example: UNKNOWN
    BankingAccountV2:
      properties:
        accountId:
          description: >-
            A unique ID of the account adhering to the standards for ID
            permanence
          type: string
          example: jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay
        creationDate:
          description: Date that the account was created (if known)
          type: string
          format: date
          x-cds-type: DateString
          example: '2020-03-01'
        displayName:
          description: >-
            The display name of the account as defined by the bank. This should
            not incorporate account numbers or PANs. If it does the values
            should be masked according to the rules of the MaskedAccountString
            common type.
          type: string
          example: ACME Savings Account
        isOwned:
          default: true
          description: >-
            Flag indicating that the customer associated with the authorisation
            is an owner of the account. Does not indicate sole ownership,
            however. If not present then 'true' is assumed
          type: boolean
          example: true
        accountOwnership:
          $ref: '#/components/schemas/EnumBankingAccountOwnershipV1'
        maskedNumber:
          description: >-
            A masked version of the account. Whether BSB/Account Number, Credit
            Card PAN or another number
          type: string
          x-cds-type: MaskedAccountString
          example: XXXX-XXXX-XXXX-1234
        nickname:
          description: A customer supplied nickname for the account
          type: string
          example: Holiday Fund
        openStatus:
          $ref: '#/components/schemas/EnumBankingAccountOpenStatusV1'
        productCategory:
          $ref: '#/components/schemas/EnumBankingProductCategoryV1'
        productName:
          description: >-
            The unique identifier of the account as defined by the data holder
            (akin to model number for the account)
          type: string
          example: ACME Savings Maximiser
      required:
        - accountId
        - accountOwnership
        - displayName
        - maskedNumber
        - productCategory
        - productName
      type: object
    ResponseBankingAccountListV2:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingAccountList'
        - type: object
          properties:
            data:
              type: object
              properties:
                accounts:
                  description: >-
                    The list of accounts returned. If the filter results in an
                    empty set then this array may have no records
                  items:
                    $ref: '#/components/schemas/BankingAccountV2'
                  type: array
              required:
                - accounts
          required:
            - data
      type: object
    ListBankingAccounts400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListBankingAccounts406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListBankingAccounts422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseBankingAccountById:
      properties:
        version:
          type: string
          example: V2
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseBankingAccountByIdV1'
          V2: '#/components/schemas/ResponseBankingAccountByIdV2'
          V3: '#/components/schemas/ResponseBankingAccountByIdV3'
          V4: '#/components/schemas/ResponseBankingAccountByIdV4'
          V5: '#/components/schemas/ResponseBankingAccountByIdV5'
      required:
        - version
        - links
      type: object
    BankingCreditCardAccountV1:
      description: Mandatory if the _specificAccountUType_ value is `creditCard`.
      properties:
        minPaymentAmount:
          description: The minimum payment amount due for the next card payment
          type: string
          x-cds-type: AmountString
          example: '10.00'
        paymentCurrency:
          description: If absent assumes AUD
          type: string
          x-cds-type: CurrencyString
          example: AUD
          pattern: \w{3}
        paymentDueAmount:
          description: The amount due for the next card payment
          type: string
          x-cds-type: AmountString
          example: '10.00'
        paymentDueDate:
          description: Date that the next payment for the card is due
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-05-01'
      required:
        - minPaymentAmount
        - paymentDueAmount
        - paymentDueDate
      type: object
    BankingProductFeatureWithActivatedV1:
      properties:
        additionalInfo:
          description: >-
            Display text providing more information on the feature. Mandatory if
            the [feature
            type](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            is set to OTHER
          type: string
          example: Additional Feature Information
        additionalInfoUri:
          description: Link to a web page with more information on this feature
          type: string
          format: uri
          x-cds-type: URIString
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [featureType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            specified. Whether mandatory or not is dependent on the value of the
            [featureType.](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
          example: Type specific value, see docs
          type: string
        featureType:
          $ref: '#/components/schemas/EnumBankingProductFeatureTypeV1'
        isActivated:
          default: true
          description: >-
            True if the feature is already activated and false if the feature is
            available for activation. Defaults to true if absent. (note this is
            an additional field appended to the feature object defined in the
            Product Reference payload)
          type: boolean
      required:
        - featureType
      type: object
      x-conditional:
        - additionalValue
        - additionalInfo
    EnumBankingLoanAccountRepaymentTypeV1:
      description: >-
        Options in place for repayments. If absent defaults to
        PRINCIPAL_AND_INTEREST
      default: PRINCIPAL_AND_INTEREST
      enum:
        - INTEREST_ONLY
        - PRINCIPAL_AND_INTEREST
      type: string
      example: PRINCIPAL_AND_INTEREST
    BankingLoanAccountV1:
      properties:
        loanEndDate:
          description: Date that the loan is due to be repaid in full
          type: string
          format: date
          x-cds-type: DateString
          example: '2035-06-01'
        maxRedraw:
          description: >-
            Maximum amount of funds that can be redrawn. If not present redraw
            is not available even if the feature exists for the account
          type: string
          x-cds-type: AmountString
          example: '1000.00'
        maxRedrawCurrency:
          description: If absent assumes AUD
          type: string
          x-cds-type: CurrencyString
          pattern: \w{3}
          example: AUD
        minInstalmentAmount:
          description: Minimum amount of next instalment
          type: string
          x-cds-type: AmountString
          example: '122.22'
        minInstalmentCurrency:
          description: If absent assumes AUD
          type: string
          x-cds-type: CurrencyString
          example: AUD
          pattern: \w{3}
        minRedraw:
          description: Minimum redraw amount
          type: string
          x-cds-type: AmountString
          example: '500.00'
        minRedrawCurrency:
          description: If absent assumes AUD
          type: string
          x-cds-type: CurrencyString
          example: AUD
          pattern: \w{3}
        nextInstalmentDate:
          description: Next date that an instalment is required
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-10-02'
        offsetAccountEnabled:
          description: >-
            Set to true if one or more offset accounts are configured for this
            loan account
          type: boolean
          example: false
        offsetAccountIds:
          description: >-
            The accountIDs of the configured offset accounts attached to this
            loan. Only offset accounts that can be accessed under the current
            authorisation should be included. It is expected behaviour that
            offsetAccountEnabled is set to true but the offsetAccountIds field
            is absent or empty. This represents a situation where an offset
            account exists but details can not be accessed under the current
            authorisation
          items:
            type: string
          type: array
        originalLoanAmount:
          description: Optional original loan value
          type: string
          x-cds-type: AmountString
          example: '526000.00'
        originalLoanCurrency:
          description: If absent assumes AUD
          type: string
          x-cds-type: CurrencyString
          pattern: \w{3}
          default: AUD
        originalStartDate:
          description: Optional original start date for the loan
          type: string
          format: date
          x-cds-type: DateString
          example: '2021-06-01'
        repaymentFrequency:
          description: >-
            The expected or required repayment frequency. Formatted according to
            [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax)
          type: string
          x-cds-type: DurationString
          example: P1M
        repaymentType:
          $ref: '#/components/schemas/EnumBankingLoanAccountRepaymentTypeV1'
      required:
        - loanEndDate
        - nextInstalmentDate
        - repaymentFrequency
      type: object
    EnumBankingMaturityInstructionsV1:
      description: >-
        Current instructions on action to be taken at maturity. This includes
        default actions that may be specified in the terms and conditions for
        the product e.g. roll-over to the same term and frequency of interest
        payments.
      enum:
        - HOLD_ON_MATURITY
        - PAID_OUT_AT_MATURITY
        - ROLLED_OVER
      type: string
      example: PAID_OUT_AT_MATURITY
    BankingTermDepositAccountV1:
      properties:
        lodgementDate:
          description: The lodgement date of the original deposit
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-01-01'
        maturityAmount:
          description: >-
            Amount to be paid upon maturity. If absent it implies the amount to
            paid is variable and cannot currently be calculated
          type: string
          x-cds-type: AmountString
        maturityCurrency:
          description: If absent assumes AUD
          type: string
          x-cds-type: CurrencyString
          pattern: \w{3}
        maturityDate:
          description: Maturity date for the term deposit
          type: string
          format: date
          x-cds-type: DateString
          example: '2024-01-01'
        maturityInstructions:
          $ref: '#/components/schemas/EnumBankingMaturityInstructionsV1'
      required:
        - lodgementDate
        - maturityDate
        - maturityInstructions
      type: object
    BankingAccountDetailV1:
      allOf:
        - $ref: '#/components/schemas/BankingAccountV1'
        - properties:
            accountNumber:
              description: >-
                The unmasked account number for the account. Should not be
                supplied if the account number is a PAN requiring PCI
                compliance. Is expected to be formatted as digits only with
                leading zeros included and no punctuation or spaces
              type: string
              example: '01231234'
            addresses:
              description: The addresses for the account to be used for correspondence
              items:
                $ref: '#/components/schemas/CommonPhysicalAddressV1'
              type: array
            bsb:
              description: >-
                The unmasked BSB for the account. Is expected to be formatted as
                digits only with leading zeros included and no punctuation or
                spaces
              type: string
              example: '999999'
            bundleName:
              description: >-
                Optional field to indicate if this account is part of a bundle
                that is providing additional benefit for to the customer
              type: string
              example: Great Bundle Savings
            creditCard:
              $ref: '#/components/schemas/BankingCreditCardAccountV1'
            depositRate:
              description: >-
                Current rate to calculate interest earned being applied to
                deposit balances as it stands at the time of the API call
              type: string
              x-cds-type: RateString
              example: '0.02'
            depositRates:
              description: >-
                Fully described deposit rates for this account based on the
                equivalent structure in Product Reference
              items:
                $ref: '#/components/schemas/BankingProductDepositRateV2'
              type: array
            features:
              description: >-
                Array of features of the account based on the equivalent
                structure in Product Reference with the following additional
                field
              items:
                $ref: '#/components/schemas/BankingProductFeatureWithActivatedV1'
              type: array
            fees:
              description: >-
                Fees and charges applicable to the account based on the
                equivalent structure in Product Reference
              items:
                $ref: '#/components/schemas/BankingProductFeeV1'
              type: array
            lendingRate:
              description: >-
                The current rate to calculate interest payable being applied to
                lending balances as it stands at the time of the API call
              type: string
              x-cds-type: RateString
              example: '0.02'
            lendingRates:
              description: >-
                Fully described deposit rates for this account based on the
                equivalent structure in Product Reference
              items:
                $ref: '#/components/schemas/BankingProductLendingRateV2'
              type: array
            loan:
              $ref: '#/components/schemas/BankingLoanAccountV1'
            specificAccountUType:
              description: The type of structure to present account specific fields.
              enum:
                - creditCard
                - loan
                - termDeposit
              type: string
              example: loan
            termDeposit:
              items:
                $ref: '#/components/schemas/BankingTermDepositAccountV1'
              type: array
          type: object
          x-conditional:
            - termDeposit
            - creditCard
            - loan
    ResponseBankingAccountByIdV1:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingAccountById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/BankingAccountDetailV1'
          required:
            - data
      type: object
    BankingProductFeatureWithActivatedV2:
      properties:
        additionalInfo:
          description: >-
            Display text providing more information on the feature. Mandatory if
            the [feature
            type](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            is set to OTHER
          type: string
          example: Additional Feature Information
        additionalInfoUri:
          description: Link to a web page with more information on this feature
          type: string
          format: uri
          x-cds-type: URIString
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [featureType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            specified. Whether mandatory or not is dependent on the value of the
            [featureType.](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
          example: Type specific value, see docs
          type: string
        featureType:
          $ref: '#/components/schemas/EnumBankingProductFeatureTypeV2'
        isActivated:
          default: true
          description: >-
            True if the feature is already activated and false if the feature is
            available for activation. Defaults to true if absent. (note this is
            an additional field appended to the feature object defined in the
            Product Reference payload)
          type: boolean
      required:
        - featureType
      type: object
      x-conditional:
        - additionalValue
        - additionalInfo
    BankingLoanAccountV2:
      properties:
        loanEndDate:
          description: Date that the loan is due to be repaid in full
          type: string
          format: date
          x-cds-type: DateString
          example: '2035-06-01'
        maxRedraw:
          description: >-
            Maximum amount of funds that can be redrawn. If not present redraw
            is not available even if the feature exists for the account
          type: string
          x-cds-type: AmountString
          example: '1000.00'
        maxRedrawCurrency:
          description: If absent assumes AUD
          type: string
          x-cds-type: CurrencyString
          pattern: \w{3}
          example: AUD
        minInstalmentAmount:
          description: Minimum amount of next instalment
          type: string
          x-cds-type: AmountString
          example: '122.22'
        minInstalmentCurrency:
          description: If absent assumes AUD
          type: string
          x-cds-type: CurrencyString
          example: AUD
          pattern: \w{3}
        minRedraw:
          description: Minimum redraw amount
          type: string
          x-cds-type: AmountString
          example: '500.00'
        minRedrawCurrency:
          description: If absent assumes AUD
          type: string
          x-cds-type: CurrencyString
          example: AUD
          pattern: \w{3}
        nextInstalmentDate:
          description: Next date that an instalment is required
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-10-02'
        offsetAccountEnabled:
          description: >-
            Set to true if one or more offset accounts are configured for this
            loan account
          type: boolean
          example: false
        offsetAccountIds:
          description: >-
            The accountIDs of the configured offset accounts attached to this
            loan. Only offset accounts that can be accessed under the current
            authorisation should be included. It is expected behaviour that
            offsetAccountEnabled is set to true but the offsetAccountIds field
            is absent or empty. This represents a situation where an offset
            account exists but details can not be accessed under the current
            authorisation
          items:
            type: string
          type: array
        originalLoanAmount:
          description: Optional original loan value
          type: string
          x-cds-type: AmountString
          example: '526000.00'
        originalLoanCurrency:
          description: If absent assumes AUD
          type: string
          x-cds-type: CurrencyString
          pattern: \w{3}
          default: AUD
        originalStartDate:
          description: Optional original start date for the loan
          type: string
          format: date
          x-cds-type: DateString
          example: '2021-06-01'
        repaymentFrequency:
          description: >-
            The expected or required repayment frequency. Formatted according to
            [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax)
          type: string
          x-cds-type: DurationString
          example: P1M
        repaymentType:
          $ref: '#/components/schemas/EnumBankingLoanAccountRepaymentTypeV1'
      type: object
    BankingAccountDetailV2:
      allOf:
        - $ref: '#/components/schemas/BankingAccountV1'
        - properties:
            accountNumber:
              description: >-
                The unmasked account number for the account. Should not be
                supplied if the account number is a PAN requiring PCI
                compliance. Is expected to be formatted as digits only with
                leading zeros included and no punctuation or spaces
              type: string
              example: '01231234'
            addresses:
              description: The addresses for the account to be used for correspondence
              items:
                $ref: '#/components/schemas/CommonPhysicalAddressV1'
              type: array
            bsb:
              description: >-
                The unmasked BSB for the account. Is expected to be formatted as
                digits only with leading zeros included and no punctuation or
                spaces
              type: string
              example: '999999'
            bundleName:
              description: >-
                Optional field to indicate if this account is part of a bundle
                that is providing additional benefit for to the customer
              type: string
              example: Great Bundle Savings
            creditCard:
              $ref: '#/components/schemas/BankingCreditCardAccountV1'
            depositRate:
              description: >-
                Current rate to calculate interest earned being applied to
                deposit balances as it stands at the time of the API call
              type: string
              x-cds-type: RateString
              example: '0.02'
            depositRates:
              description: >-
                Fully described deposit rates for this account based on the
                equivalent structure in Product Reference
              items:
                $ref: '#/components/schemas/BankingProductDepositRateV2'
              type: array
            features:
              description: >-
                Array of features of the account based on the equivalent
                structure in Product Reference with the following additional
                field
              items:
                $ref: '#/components/schemas/BankingProductFeatureWithActivatedV2'
              type: array
            fees:
              description: >-
                Fees and charges applicable to the account based on the
                equivalent structure in Product Reference
              items:
                $ref: '#/components/schemas/BankingProductFeeV1'
              type: array
            lendingRate:
              description: >-
                The current rate to calculate interest payable being applied to
                lending balances as it stands at the time of the API call
              type: string
              x-cds-type: RateString
              example: '0.02'
            lendingRates:
              description: >-
                Fully described deposit rates for this account based on the
                equivalent structure in Product Reference
              items:
                $ref: '#/components/schemas/BankingProductLendingRateV2'
              type: array
            loan:
              $ref: '#/components/schemas/BankingLoanAccountV2'
            specificAccountUType:
              description: The type of structure to present account specific fields.
              enum:
                - creditCard
                - loan
                - termDeposit
              type: string
              example: loan
            termDeposit:
              items:
                $ref: '#/components/schemas/BankingTermDepositAccountV1'
              type: array
          type: object
          x-conditional:
            - termDeposit
            - creditCard
            - loan
    ResponseBankingAccountByIdV2:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingAccountById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/BankingAccountDetailV2'
          required:
            - data
      type: object
    BankingAccountDetailV3:
      allOf:
        - $ref: '#/components/schemas/BankingAccountV2'
        - properties:
            accountNumber:
              description: >-
                The unmasked account number for the account. Should not be
                supplied if the account number is a PAN requiring PCI
                compliance. Is expected to be formatted as digits only with
                leading zeros included and no punctuation or spaces
              type: string
              example: '01231234'
            addresses:
              description: The addresses for the account to be used for correspondence
              items:
                $ref: '#/components/schemas/CommonPhysicalAddressV1'
              type: array
            bsb:
              description: >-
                The unmasked BSB for the account. Is expected to be formatted as
                digits only with leading zeros included and no punctuation or
                spaces
              type: string
              example: '999999'
            bundleName:
              description: >-
                Optional field to indicate if this account is part of a bundle
                that is providing additional benefit to the customer
              type: string
              example: Great Bundle Savings
            creditCard:
              $ref: '#/components/schemas/BankingCreditCardAccountV1'
            depositRate:
              description: >-
                Current rate to calculate interest earned being applied to
                deposit balances as it stands at the time of the API call
              type: string
              x-cds-type: RateString
              example: '0.02'
            depositRates:
              description: >-
                Fully described deposit rates for this account based on the
                equivalent structure in Product Reference
              items:
                $ref: '#/components/schemas/BankingProductDepositRateV2'
              type: array
            features:
              description: >-
                Array of features of the account based on the equivalent
                structure in Product Reference with the following additional
                field
              items:
                $ref: '#/components/schemas/BankingProductFeatureWithActivatedV2'
              type: array
            fees:
              description: >-
                Fees and charges applicable to the account based on the
                equivalent structure in Product Reference
              items:
                $ref: '#/components/schemas/BankingProductFeeV1'
              type: array
            lendingRate:
              description: >-
                The current rate to calculate interest payable being applied to
                lending balances as it stands at the time of the API call
              type: string
              x-cds-type: RateString
              example: '0.02'
            lendingRates:
              description: >-
                Fully described lending rates for this account based on the
                equivalent structure in Product Reference
              items:
                $ref: '#/components/schemas/BankingProductLendingRateV2'
              type: array
            loan:
              $ref: '#/components/schemas/BankingLoanAccountV2'
            specificAccountUType:
              description: The type of structure to present account specific fields.
              enum:
                - creditCard
                - loan
                - termDeposit
              type: string
              example: loan
            termDeposit:
              items:
                $ref: '#/components/schemas/BankingTermDepositAccountV1'
              type: array
          type: object
          x-conditional:
            - termDeposit
            - creditCard
            - loan
    ResponseBankingAccountByIdV3:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingAccountById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/BankingAccountDetailV3'
          required:
            - data
      type: object
    BankingAccountIdV1:
      description: >-
        A unique identifier for a Banking account, generated according to CDR ID
        Permanence requirements.
      type: string
      x-cds-type: ASCIIString
    BankingLoanAccountV3:
      description: Mandatory if the _specificAccountUType_ value is `loan`.
      properties:
        originalStartDate:
          description: Optional original start date for the loan.
          type: string
          format: date
          x-cds-type: DateString
        originalLoanAmount:
          description: Optional original loan value.
          type: string
          x-cds-type: AmountString
          example: '10.00'
        originalLoanCurrency:
          default: AUD
          description: If absent assumes `AUD`.
          type: string
          x-cds-type: CurrencyString
          pattern: \w{3}
        loanEndDate:
          description: Date that the loan is due to be repaid in full.
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-07-15'
        nextInstalmentDate:
          description: Next date that an instalment is required.
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-07-15'
        minInstalmentAmount:
          description: Minimum amount of next instalment.
          type: string
          x-cds-type: AmountString
          example: '10.00'
        minInstalmentCurrency:
          default: AUD
          description: If absent assumes `AUD`.
          type: string
          x-cds-type: CurrencyString
          pattern: \w{3}
        maxRedraw:
          description: >-
            Maximum amount of funds that can be redrawn. If not present redraw
            is not available even if the feature exists for the account.
          type: string
          x-cds-type: AmountString
          example: '10.00'
        maxRedrawCurrency:
          default: AUD
          description: If absent assumes `AUD`.
          type: string
          x-cds-type: CurrencyString
          pattern: \w{3}
        minRedraw:
          description: Minimum redraw amount.
          type: string
          x-cds-type: AmountString
          example: '10.00'
        minRedrawCurrency:
          default: AUD
          description: If absent assumes `AUD`.
          type: string
          x-cds-type: CurrencyString
          pattern: \w{3}
        offsetAccountEnabled:
          description: >-
            Set to `true` if one or more offset accounts are configured for this
            loan account.
          type: boolean
        offsetAccountIds:
          description: >-
            The _accountId_ values of the configured offset accounts attached to
            this loan. Only offset accounts that can be accessed under the
            current authorisation should be included. It is expected behaviour
            that _offsetAccountEnabled_ is set to `true` but the
            _offsetAccountIds_ field is absent or empty. This represents a
            situation where an offset account exists but details can not be
            accessed under the current authorisation.
          items:
            $ref: '#/components/schemas/BankingAccountIdV1'
          type: array
        repaymentType:
          description: Option in place for repayments.
          enum:
            - INTEREST_ONLY
            - OTHER
            - PRINCIPAL_AND_INTEREST
            - UNCONSTRAINED
          type: string
          example: OTHER
        repaymentFrequency:
          description: >-
            The expected or required repayment frequency. Formatted according to
            [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax).
          type: string
          x-cds-type: ExternalRef
      required:
        - repaymentType
      type: object
    BankingProductFeatureWithActivatedV3:
      allOf:
        - $ref: '#/components/schemas/BankingProductFeatureV3'
        - properties:
            isActivated:
              default: UNKNOWN
              description: >-
                <ul><li>`ACTIVATED` if the feature has been activated by the
                customer or is a standard feature of the
                product</li><li>`NOT_ACTIVATED` if the feature is not activated
                but is available for activation</li><li>`UNKNOWN` or absent if
                the activation state is unknown.</ul>**Note:** This is an
                additional field appended to the feature structure defined in
                the Product Reference payload.
              enum:
                - ACTIVATED
                - NOT_ACTIVATED
                - UNKNOWN
              type: string
          type: object
      type: object
    BankingAccountDetailV4:
      allOf:
        - $ref: '#/components/schemas/BankingAccountV2'
        - properties:
            bsb:
              description: >-
                The unmasked BSB for the account. Is expected to be formatted as
                digits only with leading zeros included and no punctuation or
                spaces.
              type: string
            accountNumber:
              description: >-
                The unmasked account number for the account. Should not be
                supplied if the account number is a PAN requiring PCI
                compliance. Is expected to be formatted as digits only with
                leading zeros included and no punctuation or spaces.
              type: string
            bundleName:
              description: >-
                Optional field to indicate if this account is part of a bundle
                that is providing additional benefit to the customer.
              type: string
            specificAccountUType:
              description: The type of structure to present account specific fields.
              enum:
                - creditCard
                - loan
                - termDeposit
              type: string
            termDeposit:
              description: Mandatory if the _specificAccountUType_ value is `termDeposit`.
              items:
                $ref: '#/components/schemas/BankingTermDepositAccountV1'
              type: array
            creditCard:
              $ref: '#/components/schemas/BankingCreditCardAccountV1'
            loan:
              $ref: '#/components/schemas/BankingLoanAccountV3'
            depositRate:
              description: >-
                Current rate to calculate interest earned being applied to
                deposit balances as it stands at the time of the API call.
              type: string
              x-cds-type: RateString
            lendingRate:
              description: >-
                The current rate to calculate interest payable being applied to
                lending balances as it stands at the time of the API call.
              type: string
              x-cds-type: RateString
            depositRates:
              description: >-
                Fully described deposit rates for this account based on the
                equivalent structure in Product Reference.
              items:
                $ref: '#/components/schemas/BankingProductDepositRateV3'
              type: array
            lendingRates:
              description: >-
                Fully described lending rates for this account based on the
                equivalent structure in Product Reference.
              items:
                $ref: '#/components/schemas/BankingProductLendingRateV3'
              type: array
            features:
              description: >-
                Array of features of the account based on the equivalent
                structure in Product Reference with the following additional
                field.
              items:
                $ref: '#/components/schemas/BankingProductFeatureWithActivatedV3'
              type: array
            fees:
              description: >-
                Fees and charges applicable to the account based on the
                equivalent structure in Product Reference.
              items:
                $ref: '#/components/schemas/BankingProductFeeV2'
              type: array
            addresses:
              description: The addresses for the account to be used for correspondence.
              items:
                $ref: '#/components/schemas/CommonPhysicalAddressV1'
              type: array
          type: object
          x-conditional:
            - termDeposit
            - creditCard
            - loan
    ResponseBankingAccountByIdV4:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingAccountById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/BankingAccountDetailV4'
          required:
            - data
      type: object
    BankingAccountV3:
      properties:
        accountId:
          allOf:
            - $ref: '#/components/schemas/BankingAccountIdV1'
        creationDate:
          description: Date that the account was created (if known)
          type: string
          format: date
          x-cds-type: DateString
          example: '2020-03-01'
        displayName:
          description: >-
            The display name of the account as defined by the bank. This should
            not incorporate account numbers or PANs. If it does the values
            should be masked according to the rules of the MaskedAccountString
            common type.
          type: string
          example: ACME Savings Account
        isOwned:
          default: true
          description: >-
            Flag indicating that the customer associated with the authorisation
            is an owner of the account. Does not indicate sole ownership,
            however. If not present then `true` is assumed.
          type: boolean
        accountOwnership:
          $ref: '#/components/schemas/EnumBankingAccountOwnershipV1'
        maskedNumber:
          description: >-
            A masked version of the account. Whether BSB/Account Number, Credit
            Card PAN or another number
          type: string
          x-cds-type: MaskedAccountString
          example: XXXX-XXXX-XXXX-1234
        nickname:
          description: A customer supplied nickname for the account
          type: string
          example: Holiday Fund
        openStatus:
          $ref: '#/components/schemas/EnumBankingAccountOpenStatusV1'
        productCategory:
          $ref: '#/components/schemas/EnumBankingProductCategoryV2'
        productName:
          description: >-
            The unique identifier of the account as defined by the data holder
            (akin to model number for the account)
          type: string
          example: ACME Savings Maximiser
        isInstalmentDetailAvailable:
          default: false
          description: >-
            `true` if any active or inactive instalment plans are available in
            the Get Instalment Plans endpoints. `false` if instalment plans are
            not applicable to the account.
          type: boolean
      required:
        - accountId
        - accountOwnership
        - displayName
        - maskedNumber
        - productCategory
        - productName
      type: object
    BankingProductFeatureWithActivatedV4:
      allOf:
        - $ref: '#/components/schemas/BankingProductFeatureV4'
        - properties:
            isActivated:
              default: UNKNOWN
              description: >-
                <ul><li>`ACTIVATED` if the feature has been activated by the
                customer or is a standard feature of the
                product</li><li>`NOT_ACTIVATED` if the feature is not activated
                but is available for activation</li><li>`UNKNOWN` or absent if
                the activation state is unknown.</ul>**Note:** This is an
                additional field appended to the feature structure defined in
                the Product Reference payload.
              enum:
                - ACTIVATED
                - NOT_ACTIVATED
                - UNKNOWN
              type: string
          type: object
      type: object
    BankingAccountDetailV5:
      allOf:
        - $ref: '#/components/schemas/BankingAccountV3'
        - properties:
            bsb:
              description: >-
                The unmasked BSB for the account. Is expected to be formatted as
                digits only with leading zeros included and no punctuation or
                spaces.
              type: string
            accountNumber:
              description: >-
                The unmasked account number for the account. Should not be
                supplied if the account number is a PAN requiring PCI
                compliance. Is expected to be formatted as digits only with
                leading zeros included and no punctuation or spaces.
              type: string
            bundleName:
              description: >-
                Optional field to indicate if this account is part of a bundle
                that is providing additional benefit to the customer.
              type: string
            instalments:
              $ref: '#/components/schemas/BankingProductInstalmentsV1'
            specificAccountUType:
              description: The type of structure to present account specific fields.
              enum:
                - creditCard
                - loan
                - termDeposit
              type: string
            termDeposit:
              description: Mandatory if the _specificAccountUType_ value is `termDeposit`.
              items:
                $ref: '#/components/schemas/BankingTermDepositAccountV1'
              type: array
            creditCard:
              $ref: '#/components/schemas/BankingCreditCardAccountV1'
            loan:
              $ref: '#/components/schemas/BankingLoanAccountV3'
            depositRate:
              description: >-
                Current rate to calculate interest earned being applied to
                deposit balances as it stands at the time of the API call.
              type: string
              x-cds-type: RateString
            lendingRate:
              description: >-
                The current rate to calculate interest payable being applied to
                lending balances as it stands at the time of the API call.
              type: string
              x-cds-type: RateString
            depositRates:
              description: >-
                Fully described deposit rates for this account based on the
                equivalent structure in Product Reference.
              items:
                $ref: '#/components/schemas/BankingProductDepositRateV3'
              type: array
            lendingRates:
              description: >-
                Fully described lending rates for this account based on the
                equivalent structure in Product Reference.
              items:
                $ref: '#/components/schemas/BankingProductLendingRateV3'
              type: array
            features:
              description: >-
                Array of features of the account based on the equivalent
                structure in Product Reference with the following additional
                field.
              items:
                $ref: '#/components/schemas/BankingProductFeatureWithActivatedV4'
              type: array
            fees:
              description: >-
                Fees and charges applicable to the account based on the
                equivalent structure in Product Reference.
              items:
                $ref: '#/components/schemas/BankingProductFeeV2'
              type: array
            addresses:
              description: The addresses for the account to be used for correspondence.
              items:
                $ref: '#/components/schemas/CommonPhysicalAddressV1'
              type: array
          type: object
          x-conditional:
            - termDeposit
            - creditCard
            - loan
    ResponseBankingAccountByIdV5:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingAccountById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/BankingAccountDetailV5'
          required:
            - data
      type: object
    GetAccountDetail400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ErrorBankingAuthorisationUnavailableAccountV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-banking:Authorisation/UnavailableBankingAccount
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Unavailable Banking Account
        detail:
          description: >-
            The requested bank account is temporarily unavailable. Subsequent
            requests for the account may be successful. Applies when the account
            ID is provided in the URI. The error detail is the account ID of the
            resource being requested.
          type: string
          example: The requested bank account is temporarily unavailable.
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: >-
                urn:au-cds:error:cds-banking:Authorisation/UnavailableBankingAccount
          type: object
      required:
        - code
        - title
        - detail
    ErrorBankingAuthorisationInvalidAccountV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-banking:Authorisation/InvalidBankingAccount
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Invalid Banking Account
        detail:
          description: >-
            The requested bank account is permanently unavailable. No subsequent
            request for the account will be successful. Applies when the account
            ID is provided in the URI. The error detail is the account ID of the
            resource being requested.
          type: string
          example: The requested bank account is permanently unavailable.
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-banking:Authorisation/InvalidBankingAccount
          type: object
      required:
        - code
        - title
        - detail
    GetAccountDetail404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorBankingAuthorisationUnavailableAccountV1'
        - $ref: '#/components/schemas/ErrorBankingAuthorisationInvalidAccountV1'
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-banking:Authorisation/UnavailableBankingAccount: '#/components/schemas/ErrorBankingAuthorisationUnavailableAccountV1'
          urn:au-cds:error:cds-banking:Authorisation/InvalidBankingAccount: '#/components/schemas/ErrorBankingAuthorisationInvalidAccountV1'
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    GetAccountDetail406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseBankingAccountsBalanceById:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseBankingAccountsBalanceByIdV1'
      required:
        - version
        - links
      type: object
    BankingBalancePurseV1:
      properties:
        amount:
          description: The balance available for this additional currency purse
          type: string
          x-cds-type: AmountString
          example: '10.00'
        currency:
          description: The currency for the purse
          type: string
          x-cds-type: CurrencyString
          example: AUD
          pattern: \w{3}
      required:
        - amount
      type: object
    BankingBalanceV1:
      properties:
        accountId:
          $ref: '#/components/schemas/BankingAccountIdV1'
        amortisedLimit:
          description: >-
            Object representing the available limit amortised according to
            payment schedule. Assumed to be zero if absent
          type: string
          x-cds-type: AmountString
          example: '10.00'
        availableBalance:
          description: >-
            Balance representing the amount of funds available for transfer.
            Assumed to be zero or positive
          type: string
          x-cds-type: AmountString
          example: '10.00'
        creditLimit:
          description: >-
            Object representing the maximum amount of credit that is available
            for this account. Assumed to be zero if absent
          type: string
          x-cds-type: AmountString
          example: '10.00'
        currency:
          description: The currency for the balance amounts. If absent assumed to be AUD
          type: string
          x-cds-type: CurrencyString
          pattern: \w{3}
          example: AUD
        currentBalance:
          description: >-
            The balance of the account at this time. Should align to the balance
            available via other channels such as Internet Banking. Assumed to be
            negative if the customer has money owing
          type: string
          x-cds-type: AmountString
          example: '10.00'
        purses:
          description: >-
            Optional array of balances for the account in other currencies.
            Included to support accounts that support multi-currency purses such
            as Travel Cards
          items:
            $ref: '#/components/schemas/BankingBalancePurseV1'
          type: array
      required:
        - accountId
        - availableBalance
        - currentBalance
      type: object
    ResponseBankingAccountsBalanceByIdV1:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingAccountsBalanceById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/BankingBalanceV1'
          required:
            - data
      type: object
    GetBalance400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetBalance404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorBankingAuthorisationUnavailableAccountV1'
        - $ref: '#/components/schemas/ErrorBankingAuthorisationInvalidAccountV1'
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-banking:Authorisation/UnavailableBankingAccount: '#/components/schemas/ErrorBankingAuthorisationUnavailableAccountV1'
          urn:au-cds:error:cds-banking:Authorisation/InvalidBankingAccount: '#/components/schemas/ErrorBankingAuthorisationInvalidAccountV1'
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    GetBalance406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseBankingScheduledPaymentsList:
      properties:
        version:
          type: string
          example: V2
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseBankingScheduledPaymentsListV1'
          V2: '#/components/schemas/ResponseBankingScheduledPaymentsListV2'
      required:
        - version
        - links
        - meta
      type: object
    BankingScheduledPaymentFromV1:
      description: >-
        Object containing details of the source of the payment. Currently only
        specifies an accountId but provided as an object to facilitate future
        extensibility and consistency with the to object
      properties:
        accountId:
          description: AccountID of the account that is the source of funds for the payment
          type: string
          example: jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay
      required:
        - accountId
      type: object
    BankingBillerPayeeV1:
      description: BPAY Payee details. Present if `uType` is set to `biller`
      properties:
        billerCode:
          description: BPAY Biller Code of the Biller
          type: string
          example: '12345'
        billerName:
          description: Name of the Biller
          type: string
          example: BPAY Electricity Co
        crn:
          description: >-
            BPAY CRN of the Biller(if available). Where the CRN contains
            sensitive information, it should be masked in line
              with how the Data Holder currently displays account identifiers in their existing online banking channels.
              If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules
              applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the
              rules applicable for the MaskedAccountString common type.
          type: string
          example: XXXXXXXXXXXX1234
      required:
        - billerCode
        - billerName
      type: object
      x-conditional:
        - crn
    BankingDomesticPayeeAccountV1:
      properties:
        accountName:
          description: Name of the account to pay to
          type: string
          example: Woolie Jumpers Shop
        accountNumber:
          description: Number of the account to pay to
          type: string
          example: '1234123423'
        bsb:
          description: BSB of the account to pay to
          type: string
          example: 123-123
      required:
        - accountNumber
        - bsb
      type: object
    BankingDomesticPayeeCardV1:
      properties:
        cardNumber:
          description: Number of the card to pay to
          type: string
          x-cds-type: MaskedPANString
          example: XXXX-XXXX-XXXX-1234
      required:
        - cardNumber
      type: object
    BankingDomesticPayeePayIdV1:
      properties:
        identifier:
          description: The identifier of the PayID (dependent on type)
          type: string
          example: hello@biza.io
        name:
          description: The name assigned to the PayID by the owner of the PayID
          type: string
          example: Biza Pty Ltd
        type:
          description: The type of the PayID
          enum:
            - EMAIL
            - TELEPHONE
            - ABN
            - ORG_IDENTIFIER
          type: string
          example: EMAIL
      required:
        - identifier
        - type
      type: object
    BankingDomesticPayeeV1:
      description: Domestic Payee details. Present if `uType` is set to `domestic`
      properties:
        account:
          $ref: '#/components/schemas/BankingDomesticPayeeAccountV1'
        card:
          $ref: '#/components/schemas/BankingDomesticPayeeCardV1'
        payId:
          $ref: '#/components/schemas/BankingDomesticPayeePayIdV1'
        payeeAccountUType:
          description: >-
            Type of account object included. Valid values are: **account** A
            standard Australian account defined by BSB/Account Number. **card**
            A credit or charge card to pay to (note that PANs are masked).
            **payId** A PayID recognised by NPP
          enum:
            - account
            - card
            - payId
          type: string
          example: payId
      required:
        - payeeAccountUType
      type: object
      x-conditional:
        - account
        - card
        - payId
    BankingInternationalPayeeBankDetailsBankAddressV1:
      properties:
        address:
          description: Address of the recipient Bank
          type: string
          example: 100 Wiltock Place, London, GB
        name:
          description: Name of the recipient Bank
          type: string
          example: ACME Bank
      required:
        - address
        - name
    BankingInternationalPayeeBankDetailsV1:
      properties:
        accountNumber:
          description: Account Targeted for payment
          type: string
          example: '12341234'
        bankAddress:
          $ref: >-
            #/components/schemas/BankingInternationalPayeeBankDetailsBankAddressV1
        beneficiaryBankBIC:
          description: >-
            Swift bank code.  Aligns with standard [ISO
            9362](https://www.iso.org/standard/60390.html)
          type: string
          x-cds-type: ExternalRef
          example: ACMEAUSYHOM
        chipNumber:
          description: Number for the Clearing House Interbank Payments System
          type: string
          example: '12341234'
        country:
          description: >-
            Country of the recipient institution. A valid [ISO 3166
            Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country
            code
          type: string
          x-cds-type: ExternalRef
          example: AUS
        fedWireNumber:
          description: Number for Fedwire payment (Federal Reserve Wire Network)
          type: string
          example: '12939281'
        legalEntityIdentifier:
          description: >-
            The legal entity identifier (LEI) for the beneficiary.  Aligns with
            [ISO 17442](https://www.iso.org/standard/59771.html)
          type: string
          x-cds-type: ExternalRef
          example: 549300TGFLH2QZV80T70
        routingNumber:
          description: International bank routing number
          type: string
          example: '18281828'
        sortCode:
          description: Sort code used for account identification in some jurisdictions
          type: string
          example: '01'
      required:
        - accountNumber
        - country
    BankingInternationalPayeeBeneficiaryDetailsV1:
      properties:
        country:
          description: >-
            Country where the beneficiary resides. A valid [ISO 3166
            Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country
            code
          type: string
          x-cds-type: ExternalRef
          example: AUS
        message:
          description: Response message for the payment
          type: string
          example: Payment Received
        name:
          description: Name of the beneficiary
          type: string
          example: Woolie Jumpers International
      required:
        - country
    BankingInternationalPayeeV1:
      description: >-
        International Payee details. Present if `uType` is set to
        `international`
      properties:
        bankDetails:
          $ref: '#/components/schemas/BankingInternationalPayeeBankDetailsV1'
        beneficiaryDetails:
          $ref: '#/components/schemas/BankingInternationalPayeeBeneficiaryDetailsV1'
      required:
        - bankDetails
        - beneficiaryDetails
      type: object
    BankingScheduledPaymentToV1:
      description: >-
        Object containing details of the destination of the payment. Used to
        specify a variety of payment destination types
      properties:
        accountId:
          description: >-
            Present if toUType is set to accountId. Indicates that the payment
            is to another account that is accessible under the current consent
          type: string
          example: jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay
        biller:
          $ref: '#/components/schemas/BankingBillerPayeeV1'
        domestic:
          $ref: '#/components/schemas/BankingDomesticPayeeV1'
        international:
          $ref: '#/components/schemas/BankingInternationalPayeeV1'
        payeeId:
          description: >-
            Present if toUType is set to payeeId. Indicates that the payment is
            to registered payee that can be accessed using the payee endpoint.
            If the Bank Payees scope has not been consented to then a payeeId
            should not be provided and the full payee details should be provided
            instead
          type: string
          example: 8a0e108e03d1b05f049d4bd4f612e314517bb967fa907b76029e17b6f42d2131
        nickname:
          type: string
          description: >-
            The short display name of the payee as provided by the customer
            unless toUType is set to payeeId. Where a customer has not provided
            a nickname, a display name derived by the bank for payee should be
            provided that is consistent with existing digital banking channels
          example: John Doe
        payeeReference:
          type: string
          description: >-
            The reference for the transaction, if applicable, that will be
            provided by the originating institution for the specific payment. If
            not empty, it overrides the value provided at the
            BankingScheduledPayment level.
          example: Dinner Payback
        toUType:
          description: >-
            The type of object provided that specifies the destination of the
            funds for the payment.
          enum:
            - accountId
            - biller
            - domestic
            - international
            - payeeId
          type: string
          example: domestic
      required:
        - toUType
      type: object
      x-conditional:
        - accountId
        - payeeId
        - domestic
        - biller
        - international
        - nickname
        - payeeReference
    BankingScheduledPaymentSetV1:
      description: >-
        The set of payment amounts and destination accounts for this payment
        accommodating multi-part payments. A single entry indicates a simple
        payment with one destination account. Must have at least one entry
      properties:
        amount:
          description: >-
            The amount of the next payment if known. Mandatory unless the
            isAmountCalculated field is set to true. Must be zero or positive if
            present
          type: string
          x-cds-type: AmountString
          example: '151.33'
        currency:
          description: The currency for the payment. AUD assumed if not present
          type: string
          x-cds-type: CurrencyString
          pattern: \w{3}
        isAmountCalculated:
          description: >-
            Flag indicating whether the amount of the payment is calculated
            based on the context of the event. For instance a payment to reduce
            the balance of a credit card to zero. If absent then false is
            assumed
          type: boolean
          example: true
        to:
          $ref: '#/components/schemas/BankingScheduledPaymentToV1'
      required:
        - to
      x-conditional:
        - amount
    BankingScheduledPaymentRecurrenceEventBasedV1:
      description: >-
        Indicates that the schedule of payments is defined according to an
        external event that cannot be predetermined. Mandatory if
        recurrenceUType is set to eventBased
      properties:
        description:
          description: >-
            Description of the event and conditions that will result in the
            payment. Expected to be formatted for display to a customer
          type: string
          example: Overdraw Charge
      required:
        - description
      type: object
    BankingScheduledPaymentIntervalV1:
      properties:
        dayInInterval:
          description: >-
            Uses an interval to define the ordinal day within the interval
            defined by the interval field on which the payment occurs. If the
            resulting duration is 0 days in length or larger than the number of
            days in the interval then the payment will occur on the last day of
            the interval. A duration of 1 day indicates the first day of the
            interval. If absent the assumed value is P1D. Formatted according to
            [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax) with components less than a day in
            length ignored. The first day of a week is considered to be Monday.
          type: string
          x-cds-type: DurationString
          example: P1D
        interval:
          description: >-
            An interval for the payment. Formatted according to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) 
            (excludes recurrence syntax) with components less than a day in
            length ignored. This duration defines the period between payments
            starting with nextPaymentDate
          type: string
          x-cds-type: DurationString
          example: P5D
      required:
        - interval
      type: object
    EnumBankingNonBusinessDayTreatmentV1:
      description: >-
        Enumerated field giving the treatment where a scheduled payment date is
        not a business day. If absent assumed to be ON.<br/>**AFTER** - If a
        scheduled payment date is a non-business day the payment will be made on
        the first business day after the scheduled payment date.<br/>**BEFORE**
        - If a scheduled payment date is a non-business day the payment will be
        made on the first business day before the scheduled payment
        date.<br/>**ON** - If a scheduled payment date is a non-business day the
        payment will be made on that day regardless.<br/>**ONLY** - Payments
        only occur on business days. If a scheduled payment date is a
        non-business day the payment will be ignored
      enum:
        - AFTER
        - BEFORE
        - 'ON'
        - ONLY
      default: 'ON'
      type: string
      example: 'ON'
    BankingScheduledPaymentRecurrenceIntervalScheduleV1:
      description: >-
        Indicates that the schedule of payments is defined by a series of
        intervals. Mandatory if recurrenceUType is set to intervalSchedule
      properties:
        finalPaymentDate:
          description: >-
            The limit date after which no more payments should be made using
            this schedule. If both finalPaymentDate and paymentsRemaining are
            present then payments will stop according to the most constraining
            value. If neither field is present the payments will continue
            indefinitely
          type: string
          format: date
          x-cds-type: DateString
          example: '2023-05-01'
        intervals:
          description: >-
            An array of interval objects defining the payment schedule.  Each
            entry in the array is additive, in that it adds payments to the
            overall payment schedule.  If multiple intervals result in a payment
            on the same day then only one payment will be made. Must have at
            least one entry
          items:
            $ref: '#/components/schemas/BankingScheduledPaymentIntervalV1'
          type: array
        nonBusinessDayTreatment:
          $ref: '#/components/schemas/EnumBankingNonBusinessDayTreatmentV1'
        paymentsRemaining:
          description: >-
            Indicates the number of payments remaining in the schedule. If both
            finalPaymentDate and paymentsRemaining are present then payments
            will stop according to the most constraining value, If neither field
            is present the payments will continue indefinitely
          type: integer
          x-cds-type: PositiveInteger
          minimum: 1
          example: 1
      required:
        - intervals
      type: object
    EnumWeekDayV1:
      description: >-
        The weekDay specified. The payment will occur on the last occurrence of
        this weekday in the interval.
      enum:
        - FRI
        - MON
        - SAT
        - SUN
        - THU
        - TUE
        - WED
      type: string
      example: MON
    BankingScheduledPaymentRecurrenceLastWeekdayV1:
      description: >-
        Indicates that the schedule of payments is defined according to the last
        occurrence of a specific weekday in an interval. Mandatory if
        recurrenceUType is set to lastWeekDay
      properties:
        finalPaymentDate:
          description: >-
            The limit date after which no more payments should be made using
            this schedule. If both finalPaymentDate and paymentsRemaining are
            present then payments will stop according to the most constraining
            value. If neither field is present the payments will continue
            indefinitely
          type: string
          format: date
          x-cds-type: DateString
          example: '2023-05-01'
        interval:
          description: >-
            The interval for the payment. Formatted according to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax) with components less than a day in
            length ignored. This duration defines the period between payments
            starting with nextPaymentDate
          type: string
          x-cds-type: DurationString
          example: P1D
        lastWeekDay:
          $ref: '#/components/schemas/EnumWeekDayV1'
        nonBusinessDayTreatment:
          $ref: '#/components/schemas/EnumBankingNonBusinessDayTreatmentV1'
        paymentsRemaining:
          description: >-
            Indicates the number of payments remaining in the schedule. If both
            finalPaymentDate and paymentsRemaining are present then payments
            will stop according to the most constraining value. If neither field
            is present the payments will continue indefinitely
          type: integer
          x-cds-type: PositiveInteger
          minimum: 1
          example: 1
      required:
        - interval
        - lastWeekDay
      type: object
    BankingScheduledPaymentRecurrenceOnceOffV1:
      description: >-
        Indicates that the payment is a once off payment on a specific future
        date. Mandatory if recurrenceUType is set to onceOff
      properties:
        paymentDate:
          description: The scheduled date for the once off payment
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-08-11'
      required:
        - paymentDate
      type: object
    BankingScheduledPaymentRecurrenceV1:
      description: Object containing the detail of the schedule for the payment
      properties:
        eventBased:
          $ref: '#/components/schemas/BankingScheduledPaymentRecurrenceEventBasedV1'
        intervalSchedule:
          $ref: >-
            #/components/schemas/BankingScheduledPaymentRecurrenceIntervalScheduleV1
        lastWeekDay:
          $ref: '#/components/schemas/BankingScheduledPaymentRecurrenceLastWeekdayV1'
        nextPaymentDate:
          description: The date of the next payment under the recurrence schedule
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-09-13'
        onceOff:
          $ref: '#/components/schemas/BankingScheduledPaymentRecurrenceOnceOffV1'
        recurrenceUType:
          description: The type of recurrence used to define the schedule
          enum:
            - eventBased
            - intervalSchedule
            - lastWeekDay
            - onceOff
          type: string
          example: intervalSchedule
      required:
        - recurrenceUType
      type: object
      x-conditional:
        - onceOff
        - intervalSchedule
        - lastWeekDay
        - eventBased
    BankingScheduledPaymentV1:
      properties:
        from:
          $ref: '#/components/schemas/BankingScheduledPaymentFromV1'
        nickname:
          description: >-
            The short display name of the scheduled payment as provided by the
            customer if provided. Where a customer has not provided a nickname,
            a display name derived by the bank for the scheduled payment should
            be provided that is consistent with existing digital banking
            channels
          type: string
        payeeReference:
          description: >-
            The reference for the transaction, if applicable, that will be
            provided by the originating institution for all payments in the
            payment set. Empty string if no data provided.
          type: string
        payerReference:
          description: >-
            The reference for the transaction that will be used by the
            originating institution for the purposes of constructing a statement
            narrative on the payer’s account. Empty string if no data provided
          type: string
          example: Football Membership Fees
        paymentSet:
          items:
            $ref: '#/components/schemas/BankingScheduledPaymentSetV1'
          type: array
        recurrence:
          $ref: '#/components/schemas/BankingScheduledPaymentRecurrenceV1'
        scheduledPaymentId:
          description: >-
            A unique ID of the scheduled payment adhering to the standards for
            ID permanence
          type: string
          x-cds-type: ASCIIString
          example: 50accd7daeeccf2e8245dc46b549aa68def146049c82c17bc4ab53f74d5586b1
        status:
          description: >-
            Indicates whether the schedule is currently active. The value SKIP
            is equivalent to ACTIVE except that the customer has requested the
            next normal occurrence to be skipped.
          enum:
            - ACTIVE
            - SKIP
            - INACTIVE
          example: ACTIVE
          type: string
      required:
        - from
        - payerReference
        - paymentSet
        - recurrence
        - scheduledPaymentId
        - status
      x-conditional:
        - payeeReference
      type: object
    ResponseBankingScheduledPaymentsListV1:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingScheduledPaymentsList'
        - type: object
          properties:
            data:
              type: object
              properties:
                scheduledPayments:
                  description: The list of scheduled payments to return
                  items:
                    $ref: '#/components/schemas/BankingScheduledPaymentV1'
                  type: array
              required:
                - scheduledPayments
          required:
            - data
      type: object
    EnumBankingPayeeDigitalWalletTypeV1:
      description: |
        The identifier to use:
        - **EMAIL**: An email address
        - **CONTACT_NAME**: Contact name
        - **TELEPHONE**: Telephone number
      enum:
        - EMAIL
        - CONTACT_NAME
        - TELEPHONE
      type: string
      example: EMAIL
    EnumBankingPayeeDigitalWalletProviderV1:
      description: >-
        The provider of the digital wallet service. PAYPAL_AU for PayPal, OTHER
        for other service provider.
      enum:
        - PAYPAL_AU
        - OTHER
      type: string
      example: OTHER
    BankingDigitalWalletPayeeV1:
      properties:
        name:
          description: >-
            The display name of the wallet as given by the customer, else a
            default value defined by the data holder
          type: string
          example: My Digital Wallet
        identifier:
          description: The identifier of the digital wallet (dependent on type)
          type: string
          example: user@digital.wallet.com
        type:
          $ref: '#/components/schemas/EnumBankingPayeeDigitalWalletTypeV1'
        provider:
          $ref: '#/components/schemas/EnumBankingPayeeDigitalWalletProviderV1'
      required:
        - name
        - identifier
        - type
        - provider
      type: object
    BankingScheduledPaymentToV2:
      description: >-
        Object containing details of the destination of the payment. Used to
        specify a variety of payment destination types
      properties:
        accountId:
          description: >-
            Present if toUType is set to accountId. Indicates that the payment
            is to another account that is accessible under the current consent
          type: string
          example: jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay
        biller:
          $ref: '#/components/schemas/BankingBillerPayeeV1'
        digitalWallet:
          $ref: '#/components/schemas/BankingDigitalWalletPayeeV1'
        domestic:
          $ref: '#/components/schemas/BankingDomesticPayeeV1'
        international:
          $ref: '#/components/schemas/BankingInternationalPayeeV1'
        payeeId:
          description: >-
            Present if toUType is set to payeeId. Indicates that the payment is
            to registered payee that can be accessed using the payee endpoint.
            If the Bank Payees scope has not been consented to then a payeeId
            should not be provided and the full payee details should be provided
            instead
          type: string
          example: 8a0e108e03d1b05f049d4bd4f612e314517bb967fa907b76029e17b6f42d2131
        nickname:
          type: string
          description: >-
            The short display name of the payee as provided by the customer
            unless toUType is set to payeeId. Where a customer has not provided
            a nickname, a display name derived by the bank for payee should be
            provided that is consistent with existing digital banking channels
          example: John Doe
        payeeReference:
          type: string
          description: >-
            The reference for the transaction, if applicable, that will be
            provided by the originating institution for the specific payment. If
            not empty, it overrides the value provided at the
            BankingScheduledPayment level.
          example: Dinner Payback
        toUType:
          description: >-
            The type of object provided that specifies the destination of the
            funds for the payment.
          enum:
            - accountId
            - biller
            - digitalWallet
            - domestic
            - international
            - payeeId
          type: string
          example: domestic
      required:
        - toUType
      type: object
      x-conditional:
        - accountId
        - payeeId
        - digitalWallet
        - domestic
        - biller
        - international
        - nickname
        - payeeReference
    BankingScheduledPaymentSetV2:
      description: >-
        The set of payment amounts and destination accounts for this payment
        accommodating multi-part payments. A single entry indicates a simple
        payment with one destination account. Must have at least one entry
      properties:
        amount:
          description: >-
            The amount of the next payment if known. Mandatory unless the
            isAmountCalculated field is set to true. Must be zero or positive if
            present
          type: string
          x-cds-type: AmountString
          example: '151.33'
        currency:
          description: The currency for the payment. AUD assumed if not present
          type: string
          x-cds-type: CurrencyString
          pattern: \w{3}
        isAmountCalculated:
          description: >-
            Flag indicating whether the amount of the payment is calculated
            based on the context of the event. For instance a payment to reduce
            the balance of a credit card to zero. If absent then false is
            assumed
          type: boolean
          example: true
        to:
          $ref: '#/components/schemas/BankingScheduledPaymentToV2'
      required:
        - to
      x-conditional:
        - amount
    BankingScheduledPaymentV2:
      properties:
        from:
          $ref: '#/components/schemas/BankingScheduledPaymentFromV1'
        nickname:
          description: >-
            The short display name of the scheduled payment as provided by the
            customer if provided. Where a customer has not provided a nickname,
            a display name derived by the bank for the scheduled payment should
            be provided that is consistent with existing digital banking
            channels
          type: string
        payeeReference:
          description: >-
            The reference for the transaction, if applicable, that will be
            provided by the originating institution for all payments in the
            payment set. Empty string if no data provided.
          type: string
        payerReference:
          description: >-
            The reference for the transaction that will be used by the
            originating institution for the purposes of constructing a statement
            narrative on the payer’s account. Empty string if no data provided
          type: string
          example: Football Membership Fees
        paymentSet:
          items:
            $ref: '#/components/schemas/BankingScheduledPaymentSetV2'
          type: array
        recurrence:
          $ref: '#/components/schemas/BankingScheduledPaymentRecurrenceV1'
        scheduledPaymentId:
          description: >-
            A unique ID of the scheduled payment adhering to the standards for
            ID permanence
          type: string
          x-cds-type: ASCIIString
          example: 50accd7daeeccf2e8245dc46b549aa68def146049c82c17bc4ab53f74d5586b1
        status:
          description: >-
            Indicates whether the schedule is currently active. The value SKIP
            is equivalent to ACTIVE except that the customer has requested the
            next normal occurrence to be skipped.
          enum:
            - ACTIVE
            - SKIP
            - INACTIVE
          example: ACTIVE
          type: string
      required:
        - from
        - payerReference
        - paymentSet
        - recurrence
        - scheduledPaymentId
        - status
      x-conditional:
        - payeeReference
      type: object
    ResponseBankingScheduledPaymentsListV2:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingScheduledPaymentsList'
        - type: object
          properties:
            data:
              type: object
              properties:
                scheduledPayments:
                  description: The list of scheduled payments to return
                  items:
                    $ref: '#/components/schemas/BankingScheduledPaymentV2'
                  type: array
              required:
                - scheduledPayments
          required:
            - data
      type: object
    ListScheduledPayments400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListScheduledPayments404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorBankingAuthorisationUnavailableAccountV1'
        - $ref: '#/components/schemas/ErrorBankingAuthorisationInvalidAccountV1'
        - $ref: '#/components/schemas/ErrorResourceInvalidV1'
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-banking:Authorisation/UnavailableBankingAccount: '#/components/schemas/ErrorBankingAuthorisationUnavailableAccountV1'
          urn:au-cds:error:cds-banking:Authorisation/InvalidBankingAccount: '#/components/schemas/ErrorBankingAuthorisationInvalidAccountV1'
          urn:au-cds:error:cds-all:Resource/Invalid: '#/components/schemas/ErrorResourceInvalidV1'
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    ListScheduledPayments406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListScheduledPayments422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseBankingDirectDebitAuthorisationList:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseBankingDirectDebitAuthorisationListV1'
      required:
        - version
        - links
        - meta
      type: object
    BankingAuthorisedEntityV1:
      properties:
        abn:
          description: Australian Business Number for the authorised entity
          type: string
          example: 54 624 797 655
        acn:
          description: Australian Company Number for the authorised entity
          type: string
          example: 624 797 655
        arbn:
          description: Australian Registered Body Number for the authorised entity
          type: string
          example: 000 000 123
        description:
          description: >-
            Description of the authorised entity derived from previously
            executed direct debits
          type: string
          example: Biza Pty Ltd
        financialInstitution:
          description: >-
            Name of the financial institution through which the direct debit
            will be executed. Is required unless the payment is made via a
            credit card scheme
          type: string
          example: ACME Bank
      type: object
      x-conditional:
        - financialInstitution
    BankingDirectDebitV1:
      properties:
        accountId:
          description: >-
            A unique ID of the account adhering to the standards for ID
            permanence.
          type: string
          example: jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay
        authorisedEntity:
          $ref: '#/components/schemas/BankingAuthorisedEntityV1'
        lastDebitAmount:
          description: The amount of the last debit executed under this authorisation
          type: string
          x-cds-type: AmountString
          example: '10.00'
        lastDebitDateTime:
          description: >-
            The date and time of the last debit executed under this
            authorisation
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2007-05-01T15:43:00.12345Z'
      required:
        - accountId
        - authorisedEntity
      type: object
    ResponseBankingDirectDebitAuthorisationListV1:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingDirectDebitAuthorisationList'
        - type: object
          properties:
            data:
              type: object
              properties:
                directDebitAuthorisations:
                  description: The list of authorisations returned
                  items:
                    $ref: '#/components/schemas/BankingDirectDebitV1'
                  type: array
              required:
                - directDebitAuthorisations
          required:
            - data
      type: object
    ListDirectDebits400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListDirectDebits404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorBankingAuthorisationUnavailableAccountV1'
        - $ref: '#/components/schemas/ErrorBankingAuthorisationInvalidAccountV1'
        - $ref: '#/components/schemas/ErrorResourceInvalidV1'
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-banking:Authorisation/UnavailableBankingAccount: '#/components/schemas/ErrorBankingAuthorisationUnavailableAccountV1'
          urn:au-cds:error:cds-banking:Authorisation/InvalidBankingAccount: '#/components/schemas/ErrorBankingAuthorisationInvalidAccountV1'
          urn:au-cds:error:cds-all:Resource/Invalid: '#/components/schemas/ErrorResourceInvalidV1'
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    ListDirectDebits406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListDirectDebits422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseBankingTransactionList:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedTransactionV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseBankingTransactionListV1'
      required:
        - version
        - links
        - meta
      type: object
    EnumBankingTransactionStatusV1:
      description: >-
        Status of the transaction whether pending or posted. Note that there is
        currently no provision in the standards to guarantee the ability to
        correlate a pending transaction with an associated posted transaction
      enum:
        - PENDING
        - POSTED
      type: string
      example: POSTED
    EnumBankingTransactionTypeV1:
      description: The type of the transaction
      enum:
        - DIRECT_DEBIT
        - FEE
        - INTEREST_CHARGED
        - INTEREST_PAID
        - OTHER
        - PAYMENT
        - TRANSFER_INCOMING
        - TRANSFER_OUTGOING
      type: string
      example: PAYMENT
    BankingTransactionV1:
      properties:
        accountId:
          description: ID of the account for which transactions are provided
          type: string
          example: jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay
        amount:
          description: >-
            The value of the transaction. Negative values mean money was
            outgoing from the account
          type: string
          x-cds-type: AmountString
          example: '133.55'
        apcaNumber:
          description: >-
            6 Digit APCA number for the initiating institution. The field is
            fixed-width and padded with leading zeros if applicable.
          type: string
          example: '484799'
        billerCode:
          description: BPAY Biller Code for the transaction (if available)
          type: string
          example: '75556'
        billerName:
          description: Name of the BPAY biller for the transaction (if available)
          type: string
          example: TAX OFFICE PAYMENTS
        crn:
          description: >-
            BPAY CRN for the transaction (if available). Where the CRN contains
            sensitive information, it should be masked in line with how the Data
            Holder currently displays account identifiers in their existing
            online banking channels. If the contents of the CRN match the format
            of a Credit Card PAN they should be masked according to the rules
            applicable for MaskedPANString. If the contents are otherwise
            sensitive, then it should be masked using the rules applicable for
            the MaskedAccountString common type.
          type: string
          example: '1234123412341'
        currency:
          description: The currency for the transaction amount. AUD assumed if not present
          type: string
          x-cds-type: CurrencyString
          pattern: \w{3}
          example: AUD
        description:
          description: The transaction description as applied by the financial institution
          type: string
          example: Outbound payment to ATO
        executionDateTime:
          description: >-
            The time the transaction was executed by the originating customer,
            if available
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-03-03T03:03:03.3Z'
        isDetailAvailable:
          description: >-
            True if extended information is available using the transaction
            detail end point. False if extended data is not available
          type: boolean
          example: true
        merchantCategoryCode:
          description: >-
            The merchant category code (or MCC) for an outgoing payment to a
            merchant
          type: string
          example: '5200'
        merchantName:
          description: Name of the merchant for an outgoing payment to a merchant
          type: string
          example: Freedom Furniture
        postingDateTime:
          description: >-
            The time the transaction was posted. This field is Mandatory if the
            transaction has status POSTED.  This is the time that appears on a
            standard statement
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-03-03T03:03:03.3Z'
        reference:
          description: >-
            The reference for the transaction provided by the originating
            institution. Empty string if no data provided
          type: string
          example: Payment for Services
        status:
          $ref: '#/components/schemas/EnumBankingTransactionStatusV1'
        transactionId:
          description: >-
            A unique ID of the transaction adhering to the standards for ID
            permanence.  This is mandatory (through hashing if necessary) unless
            there are specific and justifiable technical reasons why a
            transaction cannot be uniquely identified for a particular account
            type. It is mandatory if `isDetailAvailable` is set to true.
          type: string
          example: 8cce04fbcc0fe8307e8c221b5ae497691935a368e98f5478610c60ca4ef81caf
        type:
          $ref: '#/components/schemas/EnumBankingTransactionTypeV1'
        valueDateTime:
          description: >-
            Date and time at which assets become available to the account owner
            in case of a credit entry, or cease to be available to the account
            owner in case of a debit transaction entry
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-03-13T03:03:03.3Z'
      required:
        - accountId
        - amount
        - description
        - isDetailAvailable
        - reference
        - status
        - type
      type: object
      x-conditional:
        - transactionId
        - postingDateTime
        - crn
    ResponseBankingTransactionListV1:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingTransactionList'
        - type: object
          properties:
            data:
              type: object
              properties:
                transactions:
                  items:
                    $ref: '#/components/schemas/BankingTransactionV1'
                  type: array
              required:
                - transactions
          required:
            - data
      type: object
    MetaPaginatedTransactionV1:
      properties:
        totalPages:
          description: >-
            The total number of pages in the full set. See
            [pagination](https://consumerdatastandardsaustralia.github.io/standards/#pagination).
          type: integer
          x-cds-type: NaturalNumber
          minimum: 0
          example: 1
        totalRecords:
          description: >-
            The total number of records in the full set. See
            [pagination](https://consumerdatastandardsaustralia.github.io/standards/#pagination).
          type: integer
          x-cds-type: NaturalNumber
          minimum: 0
          example: 10
        isQueryParamUnsupported:
          description: Specified if the text filter is not supported
          type: boolean
          example: true
      required:
        - totalPages
        - totalRecords
      type: object
    GetTransactions400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidDateTimeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Field/InvalidDateTime: '#/components/schemas/ErrorFieldInvalidDateTimeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetTransactions404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorBankingAuthorisationUnavailableAccountV1'
        - $ref: '#/components/schemas/ErrorBankingAuthorisationInvalidAccountV1'
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-banking:Authorisation/UnavailableBankingAccount: '#/components/schemas/ErrorBankingAuthorisationUnavailableAccountV1'
          urn:au-cds:error:cds-banking:Authorisation/InvalidBankingAccount: '#/components/schemas/ErrorBankingAuthorisationInvalidAccountV1'
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    GetTransactions406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    GetTransactions422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseBankingTransactionById:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseBankingTransactionByIdV1'
          V2: '#/components/schemas/ResponseBankingTransactionByIdV2'
      required:
        - version
        - links
      type: object
    BankingTransactionDetailExtendedDataX2P101PayloadV1:
      properties:
        endToEndId:
          description: An end to end ID for the payment created at initiation
          type: string
        extendedDescription:
          description: >-
            An extended string description. Required if the extensionUType field
            is `x2p101Payload`
          type: string
          example: An extended string description.
        purposeCode:
          description: >-
            Purpose of the payment.  Format is defined by NPP standards for the
            x2p1.01 overlay service
          type: string
      type: object
      x-conditional:
        - extendedDescription
    BankingTransactionDetailExtendedDataV1:
      properties:
        extensionUType:
          description: Optional extended data specific to transactions originated via NPP
          enum:
            - x2p101Payload
          type: string
        payee:
          description: >-
            Label of the target PayID.  Mandatory for an outbound payment. The
            name assigned to the BSB/Account Number or PayID (by the owner of
            the PayID)
          type: string
        payer:
          description: Label of the originating payer. Mandatory for inbound payment
          type: string
        service:
          description: >-
            Identifier of the applicable overlay service. Valid values are:
            X2P1.01
          enum:
            - X2P1.01
          type: string
          example: X2P1.01
        x2p101Payload:
          $ref: >-
            #/components/schemas/BankingTransactionDetailExtendedDataX2P101PayloadV1
      required:
        - service
      type: object
      x-conditional:
        - payer
        - payee
        - x2p101Payload
    BankingTransactionDetailV1:
      allOf:
        - $ref: '#/components/schemas/BankingTransactionV1'
        - properties:
            extendedData:
              $ref: '#/components/schemas/BankingTransactionDetailExtendedDataV1'
          required:
            - extendedData
          type: object
    ResponseBankingTransactionByIdV1:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingTransactionById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/BankingTransactionDetailV1'
          required:
            - data
      type: object
    EnumBankingNppPaymentServiceV1:
      description: >-
        Identifier of the applicable overlay service. The _service_ is used in
        conjunction with the _serviceVersion_. See
        [here](https://consumerdatastandardsaustralia.github.io/standards/#npp-services)
        for more details.
      enum:
        - X2P1
        - IFTI
        - BSCT
        - CATSCT
      example: X2P1
      type: string
    BankingTransactionDetailExtendedDataNppPayloadV1:
      description: Required if the _extensionUType_ value is `nppPayload`.
      properties:
        endToEndId:
          description: An end to end ID for the payment created at initiation.
          type: string
        extendedDescription:
          description: >-
            An extended string description. Required if the _extensionUType_
            value is `nppPayload`.
          type: string
          example: An extended string description.
        purposeCode:
          description: >-
            Purpose of the payment. Format is defined by the NPP standards for
            the NPP overlay services including Osko (X2P1).
          type: string
        service:
          $ref: '#/components/schemas/EnumBankingNppPaymentServiceV1'
        serviceVersion:
          description: Two-digit NPP service overlay version with leading zero.
          example: '03'
          type: string
      required:
        - service
        - serviceVersion
      type: object
      x-conditional:
        - extendedDescription
    BankingTransactionDetailExtendedDataV2:
      properties:
        extensionUType:
          description: >-
            Optional extended data specific to transactions. Currently extended
            data is supported for NPP service overlays.
          enum:
            - nppPayload
          type: string
        payee:
          description: >-
            Label of the target PayID.  Mandatory for an outbound payment. The
            name assigned to the BSB/Account Number or PayID (by the owner of
            the PayID).
          type: string
        payer:
          description: Label of the originating payer. Mandatory for inbound payment.
          type: string
        nppPayload:
          $ref: >-
            #/components/schemas/BankingTransactionDetailExtendedDataNppPayloadV1
      type: object
      x-conditional:
        - payer
        - payee
        - nppPayload
    BankingTransactionDetailV2:
      allOf:
        - $ref: '#/components/schemas/BankingTransactionV1'
        - properties:
            extendedData:
              $ref: '#/components/schemas/BankingTransactionDetailExtendedDataV2'
          required:
            - extendedData
          type: object
    ResponseBankingTransactionByIdV2:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingTransactionById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/BankingTransactionDetailV2'
          required:
            - data
      type: object
    GetTransactionDetail400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetTransactionDetail404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorBankingAuthorisationUnavailableAccountV1'
        - $ref: '#/components/schemas/ErrorBankingAuthorisationInvalidAccountV1'
        - $ref: '#/components/schemas/ErrorResourceUnavailableV1'
        - $ref: '#/components/schemas/ErrorResourceInvalidV1'
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-banking:Authorisation/UnavailableBankingAccount: '#/components/schemas/ErrorBankingAuthorisationUnavailableAccountV1'
          urn:au-cds:error:cds-banking:Authorisation/InvalidBankingAccount: '#/components/schemas/ErrorBankingAuthorisationInvalidAccountV1'
          urn:au-cds:error:cds-all:Resource/Unavailable: '#/components/schemas/ErrorResourceUnavailableV1'
          urn:au-cds:error:cds-all:Resource/Invalid: '#/components/schemas/ErrorResourceInvalidV1'
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    GetTransactionDetail406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseBankingPayeeList:
      properties:
        version:
          type: string
          example: V2
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseBankingPayeeListV1'
          V2: '#/components/schemas/ResponseBankingPayeeListV2'
      required:
        - version
        - links
        - meta
      type: object
    EnumBankingPayeeTypeV1:
      description: >-
        The type of payee. DOMESTIC means a registered payee for domestic
        payments including NPP. INTERNATIONAL means a registered payee for
        international payments. BILLER means a registered payee for BPAY
      enum:
        - BILLER
        - DOMESTIC
        - INTERNATIONAL
      type: string
      example: BILLER
    BankingPayeeV1:
      properties:
        creationDate:
          description: The date the payee was created by the customer
          type: string
          format: date
          x-cds-type: DateString
          example: '2007-05-01'
        description:
          description: A description of the payee provided by the customer
          type: string
          example: Joe's Flowers
        nickname:
          description: >-
            The short display name of the payee as provided by the customer.
            Where a customer has not provided a nickname, a display name derived
            by the bank for the payee consistent with existing digital banking
            channels.
          type: string
          example: Friendly Joe
        payeeId:
          description: ID of the payee adhering to the rules of ID permanence
          type: string
          example: abwvgooyreohudvlszokbadxgozfhibifwmarjxmbpogdazskkimxucqjkzvvmfz
        type:
          $ref: '#/components/schemas/EnumBankingPayeeTypeV1'
      required:
        - nickname
        - payeeId
        - type
      type: object
    ResponseBankingPayeeListV1:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingPayeeList'
        - type: object
          properties:
            data:
              type: object
              properties:
                payees:
                  description: The list of payees returned
                  items:
                    $ref: '#/components/schemas/BankingPayeeV1'
                  type: array
              required:
                - payees
          required:
            - data
      type: object
    EnumBankingPayeeTypeV2:
      description: |-
        The type of payee:
        - **DOMESTIC**: A registered payee for domestic payments including NPP
        - **INTERNATIONAL**: A registered payee for international payments
        - **BILLER**: A registered payee for BPAY
        - **DIGITAL_WALLET**: A registered payee for a bank digital wallet
      enum:
        - BILLER
        - DIGITAL_WALLET
        - DOMESTIC
        - INTERNATIONAL
      type: string
      example: BILLER
    BankingPayeeV2:
      properties:
        creationDate:
          description: The date the payee was created by the customer
          type: string
          format: date
          x-cds-type: DateString
          example: '2007-05-01'
        description:
          description: A description of the payee provided by the customer
          type: string
          example: Joe's Flowers
        nickname:
          description: >-
            The short display name of the payee as provided by the customer.
            Where a customer has not provided a nickname, a display name derived
            by the bank for the payee consistent with existing digital banking
            channels.
          type: string
          example: Friendly Joe
        payeeId:
          description: ID of the payee adhering to the rules of ID permanence
          type: string
          example: abwvgooyreohudvlszokbadxgozfhibifwmarjxmbpogdazskkimxucqjkzvvmfz
        type:
          $ref: '#/components/schemas/EnumBankingPayeeTypeV2'
      required:
        - nickname
        - payeeId
        - type
      type: object
    ResponseBankingPayeeListV2:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingPayeeList'
        - type: object
          properties:
            data:
              type: object
              properties:
                payees:
                  description: The list of payees returned
                  items:
                    $ref: '#/components/schemas/BankingPayeeV2'
                  type: array
              required:
                - payees
          required:
            - data
      type: object
    ListPayees400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListPayees406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListPayees422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseBankingPayeeById:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseBankingPayeeByIdV1'
          V2: '#/components/schemas/ResponseBankingPayeeByIdV2'
      required:
        - version
        - links
      type: object
    BankingPayeeDetailV1:
      allOf:
        - $ref: '#/components/schemas/BankingPayeeV1'
        - properties:
            biller:
              $ref: '#/components/schemas/BankingBillerPayeeV1'
            domestic:
              $ref: '#/components/schemas/BankingDomesticPayeeV1'
            international:
              $ref: '#/components/schemas/BankingInternationalPayeeV1'
            payeeUType:
              description: Type of object included that describes the payee in detail
              enum:
                - biller
                - domestic
                - international
              type: string
              example: biller
          required:
            - payeeUType
          type: object
          x-conditional:
            - domestic
            - biller
            - international
    ResponseBankingPayeeByIdV1:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingPayeeById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/BankingPayeeDetailV1'
          required:
            - data
      type: object
    BankingPayeeDetailV2:
      allOf:
        - $ref: '#/components/schemas/BankingPayeeV2'
        - properties:
            biller:
              $ref: '#/components/schemas/BankingBillerPayeeV1'
            digitalWallet:
              $ref: '#/components/schemas/BankingDigitalWalletPayeeV1'
            domestic:
              $ref: '#/components/schemas/BankingDomesticPayeeV1'
            international:
              $ref: '#/components/schemas/BankingInternationalPayeeV1'
            payeeUType:
              description: Type of object included that describes the payee in detail
              enum:
                - biller
                - digitalWallet
                - domestic
                - international
              type: string
              example: biller
          required:
            - payeeUType
          type: object
          x-conditional:
            - domestic
            - biller
            - international
            - digitalWallet
    ResponseBankingPayeeByIdV2:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingPayeeById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/BankingPayeeDetailV2'
          required:
            - data
      type: object
    GetPayeeDetail400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetPayeeDetail404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorResourceUnavailableV1'
        - $ref: '#/components/schemas/ErrorResourceNotFoundV1'
        - $ref: '#/components/schemas/ErrorResourceInvalidV1'
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Resource/Unavailable: '#/components/schemas/ErrorResourceUnavailableV1'
          urn:au-cds:error:cds-all:Resource/NotFound: '#/components/schemas/ErrorResourceNotFoundV1'
          urn:au-cds:error:cds-all:Resource/Invalid: '#/components/schemas/ErrorResourceInvalidV1'
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    GetPayeeDetail406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListScheduledPaymentsBulk400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListScheduledPaymentsBulk406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListScheduledPaymentsBulk422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    RequestAccountIdsV1:
      type: object
      properties:
        data:
          type: object
          properties:
            accountIds:
              description: Array of specific account IDs to obtain data for.
              items:
                type: string
                x-cds-type: ASCIIString
              type: array
          required:
            - accountIds
        meta:
          type: object
      required:
        - data
    ListScheduledPaymentsSpecificAccounts400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListScheduledPaymentsSpecificAccounts406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListScheduledPaymentsSpecificAccounts422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorBankingAuthorisationUnavailableAccountV1'
        - $ref: '#/components/schemas/ErrorBankingAuthorisationInvalidAccountV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-banking:Authorisation/UnavailableBankingAccount: '#/components/schemas/ErrorBankingAuthorisationUnavailableAccountV1'
          urn:au-cds:error:cds-banking:Authorisation/InvalidBankingAccount: '#/components/schemas/ErrorBankingAuthorisationInvalidAccountV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListDirectDebitsBulk400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListDirectDebitsBulk406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListDirectDebitsBulk422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListDirectDebitsSpecificAccounts400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListDirectDebitsSpecificAccounts406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListDirectDebitsSpecificAccounts422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorBankingAuthorisationUnavailableAccountV1'
        - $ref: '#/components/schemas/ErrorBankingAuthorisationInvalidAccountV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-banking:Authorisation/UnavailableBankingAccount: '#/components/schemas/ErrorBankingAuthorisationUnavailableAccountV1'
          urn:au-cds:error:cds-banking:Authorisation/InvalidBankingAccount: '#/components/schemas/ErrorBankingAuthorisationInvalidAccountV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseBankingAccountsBalanceList:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseBankingAccountsBalanceListV1'
      required:
        - version
        - links
        - meta
      type: object
    ResponseBankingAccountsBalanceListV1:
      allOf:
        - $ref: '#/components/schemas/ResponseBankingAccountsBalanceList'
        - type: object
          properties:
            data:
              type: object
              properties:
                balances:
                  description: The list of balances returned
                  items:
                    $ref: '#/components/schemas/BankingBalanceV1'
                  type: array
              required:
                - balances
          required:
            - data
      type: object
    ListBalancesBulk400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListBalancesBulk406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListBalancesBulk422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListBalancesSpecificBankingAccounts400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListBalancesSpecificBankingAccounts406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListBalancesSpecificBankingAccounts422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorBankingAuthorisationUnavailableAccountV1'
        - $ref: '#/components/schemas/ErrorBankingAuthorisationInvalidAccountV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-banking:Authorisation/UnavailableBankingAccount: '#/components/schemas/ErrorBankingAuthorisationUnavailableAccountV1'
          urn:au-cds:error:cds-banking:Authorisation/InvalidBankingAccount: '#/components/schemas/ErrorBankingAuthorisationInvalidAccountV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseCommonCustomer:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseCommonCustomerV1'
      required:
        - version
        - links
      type: object
    ResponseCommonCustomerV1:
      allOf:
        - $ref: '#/components/schemas/ResponseCommonCustomer'
        - type: object
          properties:
            data:
              type: object
              properties:
                customerUType:
                  description: The type of customer object that is present
                  enum:
                    - organisation
                    - person
                  type: string
                  example: person
                organisation:
                  $ref: '#/components/schemas/CommonOrganisationV1'
                person:
                  $ref: '#/components/schemas/CommonPersonV1'
              required:
                - customerUType
              x-conditional:
                - person
                - organisation
          required:
            - data
      type: object
      x-conditional:
        - person
        - organisation
    GetCustomer400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetCustomer406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseCommonCustomerDetail:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseCommonCustomerDetailV1'
          V2: '#/components/schemas/ResponseCommonCustomerDetailV2'
      required:
        - version
        - links
      type: object
    CommonOrganisationDetailV1:
      description: Mandatory if `customerUType` is `organisation`
      allOf:
        - $ref: '#/components/schemas/CommonOrganisationV1'
        - properties:
            physicalAddresses:
              description: >-
                Must contain at least one address. One and only one address may
                have the purpose of REGISTERED. Zero or one, and no more than
                one, record may have the purpose of MAIL. If zero then the
                REGISTERED address is to be used for mail
              items:
                $ref: '#/components/schemas/CommonPhysicalAddressWithPurposeV1'
              type: array
          required:
            - physicalAddresses
          type: object
    CommonPersonDetailV1:
      description: Mandatory if `customerUType` is `person`
      allOf:
        - $ref: '#/components/schemas/CommonPersonV1'
        - properties:
            emailAddresses:
              description: May be empty
              items:
                $ref: '#/components/schemas/CommonEmailAddressV1'
              type: array
            phoneNumbers:
              description: Array is mandatory but may be empty if no phone numbers are held
              items:
                $ref: '#/components/schemas/CommonPhoneNumberV1'
              type: array
            physicalAddresses:
              description: >-
                Must contain at least one address. One and only one address may
                have the purpose of REGISTERED. Zero or one, and no more than
                one, record may have the purpose of MAIL. If zero then the
                REGISTERED address is to be used for mail
              items:
                $ref: '#/components/schemas/CommonPhysicalAddressWithPurposeV1'
              type: array
          required:
            - emailAddresses
            - phoneNumbers
            - physicalAddresses
          type: object
    ResponseCommonCustomerDetailV1:
      allOf:
        - $ref: '#/components/schemas/ResponseCommonCustomerDetail'
        - type: object
          properties:
            data:
              type: object
              properties:
                customerUType:
                  description: The type of customer object that is present
                  enum:
                    - organisation
                    - person
                  type: string
                  example: person
                organisation:
                  $ref: '#/components/schemas/CommonOrganisationDetailV1'
                person:
                  $ref: '#/components/schemas/CommonPersonDetailV1'
              required:
                - customerUType
              x-conditional:
                - person
                - organisation
          required:
            - data
      type: object
      x-conditional:
        - person
        - organisation
    ResponseCommonCustomerDetailV2:
      allOf:
        - $ref: '#/components/schemas/ResponseCommonCustomerDetail'
        - type: object
          properties:
            data:
              type: object
              properties:
                customerUType:
                  description: The type of customer object that is present
                  enum:
                    - organisation
                    - person
                  type: string
                  example: person
                organisation:
                  $ref: '#/components/schemas/CommonOrganisationDetailV2'
                person:
                  $ref: '#/components/schemas/CommonPersonDetailV2'
              required:
                - customerUType
              x-conditional:
                - person
                - organisation
          required:
            - data
      type: object
      x-conditional:
        - person
        - organisation
    GetCustomerDetail400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetCustomerDetail406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseEnergyAccountsList:
      properties:
        version:
          type: string
          example: V2
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V2: '#/components/schemas/ResponseEnergyAccountsListV2'
      required:
        - version
        - links
        - meta
      type: object
    EnumEnergyAccountOpenStatusV1:
      default: OPEN
      description: >-
        Open or closed status for the account. If not present then OPEN is
        assumed
      enum:
        - CLOSED
        - OPEN
      type: string
      example: OPEN
    EnergyAccountBaseV2:
      properties:
        accountId:
          description: >-
            The ID of the account.  To be created in accordance with CDR ID
            permanence requirements
          type: string
          example: jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay
        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
          example: '28326662'
        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
          example: My Home Energy
        openStatus:
          $ref: '#/components/schemas/EnumEnergyAccountOpenStatusV1'
        creationDate:
          description: >-
            The date that the account was created or opened. Mandatory if
            openStatus is OPEN
          type: string
          format: date
          x-cds-type: DateString
          example: '2021-08-03'
      required:
        - accountId
      type: object
      x-conditional:
        - creationDate
    EnergyAccountPlanOverviewV1:
      description: Mandatory if openStatus is OPEN
      properties:
        displayName:
          description: The name of the plan if one exists
          type: string
          example: Solar Saver
        startDate:
          description: The start date of the applicability of this plan
          type: string
          format: date
          x-cds-type: DateString
          example: '2021-01-01'
        endDate:
          description: The end date of the applicability of this plan
          type: string
          format: date
          x-cds-type: DateString
          example: '2023-07-01'
      required:
        - startDate
      type: object
    EnergyAccountPlanV2:
      properties:
        nickname:
          description: >-
            Optional display name for the plan provided by the customer to help
            differentiate multiple plans
          type: string
          example: Solar Saver Plan
        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
          example:
            - aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa
        planOverview:
          $ref: '#/components/schemas/EnergyAccountPlanOverviewV1'
      required:
        - servicePointIds
      type: object
      x-conditional:
        - planOverview
    EnergyAccountV2:
      allOf:
        - $ref: '#/components/schemas/EnergyAccountBaseV2'
        - properties:
            plans:
              description: >-
                The array of plans containing service points and associated plan
                details
              items:
                $ref: '#/components/schemas/EnergyAccountPlanV2'
              type: array
          required:
            - plans
          type: object
    ResponseEnergyAccountsListV2:
      allOf:
        - $ref: '#/components/schemas/ResponseEnergyAccountsList'
        - type: object
          properties:
            data:
              type: object
              properties:
                accounts:
                  description: The list of energy accounts returned
                  items:
                    $ref: '#/components/schemas/EnergyAccountV2'
                  type: array
              required:
                - accounts
          required:
            - data
      type: object
    ListEnergyAccounts400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListEnergyAccounts406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListEnergyAccounts422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseEnergyAccountById:
      properties:
        version:
          type: string
          example: V3
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V2: '#/components/schemas/ResponseEnergyAccountByIdV2'
          V3: '#/components/schemas/ResponseEnergyAccountByIdV3'
          V4: '#/components/schemas/ResponseEnergyAccountByIdV4'
      required:
        - version
        - links
      type: object
    EnumEnergyFuelTypeV1:
      description: The fuel types covered by the plan
      enum:
        - ELECTRICITY
        - GAS
        - DUAL
      type: string
      example: ELECTRICITY
    EnergyMeteringChargeV1:
      properties:
        displayName:
          description: Display name of the charge
          type: string
          example: Base Metering Charge
        description:
          description: Description of the charge
          type: string
          example: A metering charge applied to all bills
        minimumValue:
          description: >-
            Minimum value of the charge if the charge is a range or the absolute
            value of the charge if no range is specified
          type: string
          x-cds-type: AmountString
          example: '1.00'
        maximumValue:
          description: The upper limit of the charge if the charge could occur in a range
          type: string
          x-cds-type: AmountString
          example: '15.00'
        period:
          description: >-
            The charges that occur on a schedule indicates the frequency.
            Formatted according to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax)
          type: string
          x-cds-type: DurationString
          example: P1M
      required:
        - displayName
        - minimumValue
      type: object
    EnumEnergyPlanContractPricingModelV1:
      description: >
        The pricing model for the contract.  Contracts for gas must

        use SINGLE_RATE.


        Note that the detail for the enumeration values are:


        - **SINGLE_RATE**: all energy usage is charged at a single unit rate no
        matter when it is consumed. Multiple unit rates may exist that
        correspond to varying volumes of usage i.e. a 'block' or 'step' tariff
        (first 50kWh @ X cents, next 50kWh at Y cents etc

        - **SINGLE_RATE_CONT_LOAD**: As per *SINGLE_RATE* but with an
        additional, separate unit rate charged for all energy usage from a
        controlled load i.e. separately metered appliance like hot water
        service, pool pump etc.

        - **TIME_OF_USE**: energy usage is charged at unit rates that vary
        dependent on time of day and day of week that the energy is consumed

        - **TIME_OF_USE_CONT_LOAD**: Same as *TIME_OF_USE*, but with an
        additional, separate unit rate charged for all energy usage from a
        controlled load i.e. separately metered appliance like hot water
        service, pool pump etc.

        - **FLEXIBLE**: energy usage is charged at unit rates that vary based on
        external factors

        - **FLEXIBLE_CONT_LOAD**: Same as *FLEXIBLE* but with an additional,
        separate unit rate charged for all energy usage from a controlled load
        i.e. separately metered appliance like hot water service, pool pump etc.

        - **QUOTA**: All energy usage is charged at a single fixed rate, up to a
        specified usage quota/allowance. All excess usage beyond the allowance
        is then charged at a single unit rate (may not be the best way to
        explain it but it is essentially a 'subscription'

        or telco style product i.e. $50/month for up to 150kWh included usage)
      enum:
        - SINGLE_RATE
        - SINGLE_RATE_CONT_LOAD
        - TIME_OF_USE
        - TIME_OF_USE_CONT_LOAD
        - FLEXIBLE
        - FLEXIBLE_CONT_LOAD
        - QUOTA
      type: string
      example: SINGLE_RATE
    EnumEnergyPlanContractTimeZoneV1:
      description: >-
        Required if pricingModel is set to TIME_OF_USE.  Defines the time zone
        to use for calculation of the time of use thresholds. Defaults to AEST
        if absent
      enum:
        - LOCAL
        - AEST
      type: string
      example: AEST
    EnumEnergyPaymentMethodV1:
      description: Payment method
      enum:
        - PAPER_BILL
        - CREDIT_CARD
        - DIRECT_DEBIT
        - BPAY
        - OTHER
      type: string
      example: CREDIT_CARD
    EnergyPlanIntrinsicGreenPowerV1:
      description: >-
        Describes intrinsic green power for the plan.  If present then the plan
        includes a percentage of green power in the base plan. Should not be
        present for gas contracts
      properties:
        greenPercentage:
          description: Percentage of green power intrinsically included in the plan
          type: string
          x-cds-type: RateString
          example: '0.95'
      required:
        - greenPercentage
      type: object
    EnumEnergyUsageMeasureUnitV1:
      description: The measurement unit. Assumed to be KWH if absent
      enum:
        - KWH
        - KVA
        - KVAR
        - KVARH
        - KW
        - DAYS
        - METER
        - MONTH
      default: KWH
      type: string
      example: KWH
    EnergyPlanRateV1:
      description: Rate
      properties:
        unitPrice:
          description: Unit price of usage per measure unit (exclusive of GST)
          type: string
          x-cds-type: AmountString
          example: '0.044'
        measureUnit:
          $ref: '#/components/schemas/EnumEnergyUsageMeasureUnitV1'
        volume:
          description: >-
            Volume that this rate applies to. Only applicable for 'stepped'
            rates where different rates apply for different volumes of usage in
            a period
          type: number
          example: 145
      required:
        - unitPrice
      type: object
    EnergyPlanControlledLoadSingleRateV1:
      description: >-
        Object representing a single controlled load rate.  Required if
        rateBlockUType is singleRate
      properties:
        displayName:
          description: Display name of the controlled load rate
          type: string
          example: Single Rate Charge
        description:
          description: Description of the controlled load rate
          type: string
        dailySupplyCharge:
          description: >-
            The daily supply charge (exclusive of GST) for this controlled load
            tier
          type: string
          x-cds-type: AmountString
        rates:
          description: Array of controlled load rates in order of usage volume
          items:
            $ref: '#/components/schemas/EnergyPlanRateV1'
          type: array
      required:
        - displayName
        - rates
      type: object
    EnumEnergyDayV1:
      description: Day
      enum:
        - SUN
        - MON
        - TUE
        - WED
        - THU
        - FRI
        - SAT
        - PUBLIC_HOLIDAYS
      type: string
      example: MON
    EnumEnergyControlledLoadTimeOfUseRateTypeV1:
      description: The type of usage that the rate applies to
      enum:
        - PEAK
        - OFF_PEAK
        - SHOULDER
        - SOLAR_SPONGE
      type: string
      example: PEAK
    EnergyPlanControlledLoadTimeOfUseRateV1:
      properties:
        displayName:
          description: Display name of the controlled load rate
          type: string
          example: Time of use charge applied
        description:
          description: Description of the controlled load rate
          type: string
        dailySupplyCharge:
          description: >-
            The daily supply charge (exclusive of GST) for this controlled load
            tier
          type: string
          x-cds-type: AmountString
        rates:
          description: Array of controlled load rates in order of usage volume
          items:
            $ref: '#/components/schemas/EnergyPlanRateV1'
          type: array
        timeOfUse:
          description: Array of times of use.
          items:
            properties:
              days:
                description: The days that the rate applies to
                items:
                  $ref: '#/components/schemas/EnumEnergyDayV1'
                type: array
                example:
                  - PUBLIC_HOLIDAYS
              startTime:
                description: >-
                  The beginning of the time period per day for which the
                  controlled load rate applies. Required if endTime provided

                  Formatted according to [ISO 8601
                  Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the
                  time is provided without a UTC offset, the time zone will be
                  determined by the value of EnergyPlanContract.timeZone.
                type: string
                x-cds-type: TimeString
                example: 17:00:00.000+10:00
              endTime:
                description: >-
                  The end of the time period per day for which the controlled
                  load rate applies. Required if startTime provided

                  Formatted according to [ISO 8601
                  Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the
                  time is provided without a UTC offset, the time zone will be
                  determined by the value of EnergyPlanContract.timeZone.
                type: string
                x-cds-type: TimeString
                example: 20:59:59.999+10:00
              additionalInfo:
                description: >-
                  Display text providing more information on the controlled
                  load, for e.g. controlled load availability if specific
                  day/time is not known. Required if startTime and endTime
                  absent or if additionalInfoUri provided
                type: string
              additionalInfoUri:
                description: >-
                  Optional link to additional information regarding the
                  controlled load
                type: string
                format: uri
                x-cds-type: URIString
            type: object
            x-conditional:
              - startTime
              - endTime
              - additionalInfo
          type: array
        type:
          $ref: '#/components/schemas/EnumEnergyControlledLoadTimeOfUseRateTypeV1'
      required:
        - displayName
        - rates
        - timeOfUse
        - type
      type: object
    EnergyPlanControlledLoadV1:
      properties:
        displayName:
          description: A display name for the controlled load
          type: string
          example: Electric hot water system
        rateBlockUType:
          description: Specifies the type of controlled load rate
          enum:
            - singleRate
            - timeOfUseRates
          type: string
          example: singleRate
        startDate:
          description: Optional start date of the application of the controlled load rate
          type: string
          format: date
          x-cds-type: DateString
          example: '2021-10-23'
        endDate:
          description: Optional end date of the application of the controlled load rate
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-04-30'
        singleRate:
          $ref: '#/components/schemas/EnergyPlanControlledLoadSingleRateV1'
        timeOfUseRates:
          description: >-
            Array of objects representing time of use rates.  Required if
            rateBlockUType is timeOfUseRates
          items:
            $ref: '#/components/schemas/EnergyPlanControlledLoadTimeOfUseRateV1'
          type: array
      required:
        - displayName
        - rateBlockUType
      type: object
      x-conditional:
        - singleRate
        - timeOfUseRates
    EnumEnergyPlanIncentiveCategoryV1:
      description: The type of the incentive
      enum:
        - GIFT
        - ACCOUNT_CREDIT
        - OTHER
      type: string
      example: ACCOUNT_CREDIT
    EnergyPlanIncentiveV1:
      description: Incentives related to an Energy Plan
      properties:
        displayName:
          description: The display name of the incentive
          type: string
          example: Pay Early Discount
        description:
          description: The description of the incentive
          type: string
          example: Pay Early and Receive a 5% Discount
        category:
          $ref: '#/components/schemas/EnumEnergyPlanIncentiveCategoryV1'
        eligibility:
          description: A display message outlining an eligibility criteria that may apply
          type: string
          example: Pay by the due date and you will be credited 5% off your next bill
      required:
        - category
        - description
        - displayName
      type: object
    EnumEnergyPlanDiscountTypeV1:
      description: The type of the discount
      enum:
        - CONDITIONAL
        - GUARANTEED
        - OTHER
      type: string
      example: CONDITIONAL
    EnumEnergyPlanDiscountCategoryV1:
      description: >-
        The type of the discount.  Mandatory if the discount type is
        `CONDITIONAL`
      enum:
        - PAY_ON_TIME
        - DIRECT_DEBIT
        - GUARANTEED_DISCOUNT
        - OTHER
      type: string
      example: GUARANTEED_DISCOUNT
    EnumEnergyPlanDiscountMethodV1:
      description: The method of calculation of the discount
      enum:
        - percentOfBill
        - percentOfUse
        - fixedAmount
        - percentOverThreshold
      type: string
      example: percentOfBill
    EnergyPlanDiscountPercentOfBillV1:
      description: Required if methodUType is percentOfBill
      properties:
        rate:
          description: The rate of the discount applied to the bill amount
          type: string
          x-cds-type: RateString
          example: '0.05'
      required:
        - rate
      type: object
    EnergyPlanDiscountPercentOfUseV1:
      description: Required if methodUType is percentOfUse
      properties:
        rate:
          description: The rate of the discount applied to the usageamount
          type: string
          x-cds-type: RateString
          example: '0.05'
      required:
        - rate
      type: object
    EnergyPlanDiscountFixedAmountV1:
      description: Required if methodUType is fixedAmount
      properties:
        amount:
          description: The amount of the discount
          type: string
          x-cds-type: AmountString
          example: '15.00'
      required:
        - amount
      type: object
    EnergyPlanDiscountPercentOverThresholdV1:
      description: Required if methodUType is percentOverThreshold
      properties:
        rate:
          description: The rate of the discount over the usage amount
          type: string
          x-cds-type: RateString
          example: '0.05'
        usageAmount:
          description: The usage amount threshold above which the discount applies
          type: string
          x-cds-type: AmountString
          example: '1.15'
      required:
        - rate
        - usageAmount
      type: object
    EnergyPlanDiscountV1:
      description: Discount to apply to an Energy Plan
      properties:
        displayName:
          description: The display name of the discount
          type: string
          example: Pensioner Discount
        description:
          description: The description of the discount
          type: string
          example: Provide Pensioner card and you will receive a 15% discount
        type:
          $ref: '#/components/schemas/EnumEnergyPlanDiscountTypeV1'
        category:
          $ref: '#/components/schemas/EnumEnergyPlanDiscountCategoryV1'
        endDate:
          description: >-
            Optional end date for the discount after which the discount is no
            longer available
          type: string
          format: date
          x-cds-type: DateString
          example: '2023-01-01'
        methodUType:
          $ref: '#/components/schemas/EnumEnergyPlanDiscountMethodV1'
        percentOfBill:
          $ref: '#/components/schemas/EnergyPlanDiscountPercentOfBillV1'
        percentOfUse:
          $ref: '#/components/schemas/EnergyPlanDiscountPercentOfUseV1'
        fixedAmount:
          $ref: '#/components/schemas/EnergyPlanDiscountFixedAmountV1'
        percentOverThreshold:
          $ref: '#/components/schemas/EnergyPlanDiscountPercentOverThresholdV1'
      required:
        - displayName
        - methodUType
        - type
      type: object
      x-conditional:
        - percentOfBill
        - percentOfUse
        - fixedAmount
        - percentOverThreshold
    EnumEnergyPlanGreenPowerChargeSchemeV1:
      description: The applicable green power scheme
      enum:
        - GREENPOWER
        - OTHER
      type: string
      example: GREENPOWER
    EnumEnergyPlanGreenPowerChargeTypeV1:
      description: The type of charge
      enum:
        - FIXED_PER_DAY
        - FIXED_PER_WEEK
        - FIXED_PER_MONTH
        - FIXED_PER_UNIT
        - PERCENT_OF_USE
        - PERCENT_OF_BILL
      type: string
      example: FIXED_PER_DAY
    EnergyPlanGreenPowerChargeTierV1:
      description: >-
        Charge tier based on the percentage of green power used for the period
        implied by the type.
      properties:
        percentGreen:
          description: The upper percentage of green power used applicable for this tier
          type: string
          x-cds-type: RateString
          example: '0.90'
        rate:
          description: The rate of the charge if the type implies the application of a rate
          type: string
          x-cds-type: RateString
          example: '0.345'
        amount:
          description: >-
            The amount of the charge if the type implies the application of a
            fixed amount
          type: string
          x-cds-type: AmountString
          example: '10.00'
      required:
        - percentGreen
      type: object
      x-conditional:
        - rate
        - amount
    EnergyPlanGreenPowerChargeV1:
      properties:
        displayName:
          description: The display name of the charge
          type: string
          example: Green Power Surcharge
        description:
          description: The description of the charge
          type: string
          example: A surcharge applied for saving the planet
        scheme:
          $ref: '#/components/schemas/EnumEnergyPlanGreenPowerChargeSchemeV1'
        type:
          $ref: '#/components/schemas/EnumEnergyPlanGreenPowerChargeTypeV1'
        tiers:
          description: >-
            Array of charge tiers based on the percentage of green power used
            for the period implied by the type.  Array is in order of increasing
            percentage of green power
          items:
            $ref: '#/components/schemas/EnergyPlanGreenPowerChargeTierV1'
          type: array
      required:
        - displayName
        - scheme
        - tiers
        - type
      type: object
    EnumEnergyPlanEligibilityTypeV1:
      description: >-
        The type of the eligibility restriction. The `CONTINGENT_PLAN` value
        indicates that the plan is contingent on the customer taking up an
        alternate fuel plan from the same retailer (for instance, if the
        fuelType is `ELECTRICITY` then a `GAS` plan from the same retailer must
        be taken up)
      enum:
        - EXISTING_CUST
        - EXISTING_POOL
        - EXISTING_SOLAR
        - EXISTING_BATTERY
        - EXISTING_SMART_METER
        - EXISTING_BASIC_METER
        - SENIOR_CARD
        - SMALL_BUSINESS
        - NO_SOLAR_FIT
        - NEW_CUSTOMER
        - ONLINE_ONLY
        - REQ_EQUIP_SUPPLIER
        - THIRD_PARTY_ONLY
        - SPORT_CLUB_MEMBER
        - ORG_MEMBER
        - SPECIFIC_LOCATION
        - MINIMUM_USAGE
        - LOYALTY_MEMBER
        - GROUP_BUY_MEMBER
        - CONTINGENT_PLAN
        - OTHER
      type: string
      example: EXISTING_CUST
    EnergyPlanEligibilityV1:
      properties:
        type:
          $ref: '#/components/schemas/EnumEnergyPlanEligibilityTypeV1'
        information:
          description: >-
            Information of the eligibility restriction specific to the type of
            the restriction
          type: string
          example: Eligibility restrictions apply for this restriction
        description:
          description: A description of the eligibility restriction
          type: string
          example: Must be a remote property
      required:
        - information
        - type
      type: object
    EnumEnergyPlanFeeTypeV1:
      description: The type of the fee
      enum:
        - EXIT
        - ESTABLISHMENT
        - LATE_PAYMENT
        - DISCONNECTION
        - DISCONNECT_MOVE_OUT
        - DISCONNECT_NON_PAY
        - RECONNECTION
        - CONNECTION
        - PAYMENT_PROCESSING
        - CC_PROCESSING
        - CHEQUE_DISHONOUR
        - DD_DISHONOUR
        - MEMBERSHIP
        - CONTRIBUTION
        - PAPER_BILL
        - OTHER
      type: string
      example: ESTABLISHMENT
    EnumEnergyPlanFeeTermV1:
      description: The term of the fee
      enum:
        - FIXED
        - 1_YEAR
        - 2_YEAR
        - 3_YEAR
        - 4_YEAR
        - 5_YEAR
        - PERCENT_OF_BILL
        - ANNUAL
        - DAILY
        - WEEKLY
        - MONTHLY
        - BIANNUAL
        - VARIABLE
      type: string
      example: FIXED
    EnergyPlanFeeV1:
      description: Energy Plan Fee Value
      properties:
        type:
          $ref: '#/components/schemas/EnumEnergyPlanFeeTypeV1'
        term:
          $ref: '#/components/schemas/EnumEnergyPlanFeeTermV1'
        amount:
          description: The fee amount. Required if term is not `PERCENT_OF_BILL`
          type: string
          x-cds-type: AmountString
          example: '1.55'
        rate:
          description: The fee rate. Required if term is `PERCENT_OF_BILL`
          type: string
          x-cds-type: RateString
          example: '0.10'
        description:
          description: A description of the fee
          type: string
          example: Initial Setup Charge
      required:
        - term
        - type
      type: object
      x-conditional:
        - amount
        - rate
    EnumEnergyPlanSolarFeedInTariffSchemeTypeV1:
      description: The applicable scheme
      enum:
        - PREMIUM
        - OTHER
      type: string
      example: PREMIUM
    EnumEnergyPlanSolarFeedInTariffPayerTypeV1:
      description: The type of the payer
      enum:
        - GOVERNMENT
        - RETAILER
      type: string
      example: RETAILER
    EnumEnergyTariffTimeVaryingTariffTypeV1:
      description: The type of the charging time period. If absent applies to all periods
      enum:
        - PEAK
        - OFF_PEAK
        - SHOULDER
      type: string
      example: PEAK
    EnergyPlanSolarFeedInTariffV1:
      properties:
        displayName:
          description: The name of the tariff
          type: string
          example: Solar Feed In Tariff
        description:
          description: A description of the tariff
          type: string
          example: A base charge for feeding back into the grid
        scheme:
          $ref: '#/components/schemas/EnumEnergyPlanSolarFeedInTariffSchemeTypeV1'
        payerType:
          $ref: '#/components/schemas/EnumEnergyPlanSolarFeedInTariffPayerTypeV1'
        tariffUType:
          description: The type of the tariff
          enum:
            - singleTariff
            - timeVaryingTariffs
          type: string
          example: singleTariff
        singleTariff:
          description: >-
            Represents a constant tariff.  Mandatory if tariffUType is set to
            singleTariff
          properties:
            amount:
              description: The tariff amount
              type: string
              x-cds-type: AmountString
              example: '0.05'
          required:
            - amount
          type: object
        timeVaryingTariffs:
          description: >-
            Represents a tariff based on time.  Mandatory if tariffUType is set
            to timeVaryingTariffs
          properties:
            type:
              $ref: '#/components/schemas/EnumEnergyTariffTimeVaryingTariffTypeV1'
            amount:
              description: The tariff amount
              type: string
              x-cds-type: AmountString
              example: '0.13'
            timeVariations:
              description: Array of time periods for which this tariff is applicable
              items:
                properties:
                  days:
                    description: >-
                      The days that the tariff applies to. At least one entry
                      required
                    items:
                      $ref: '#/components/schemas/EnumEnergyDayV1'
                    type: array
                    minItems: 1
                  startTime:
                    description: >-
                      The beginning of the time period per day for which the
                      tariff applies.  If absent assumes start of day (ie.
                      midnight)
                    type: string
                    x-cds-type: TimeString
                    example: '12:00'
                  endTime:
                    description: >-
                      The end of the time period per day for which the tariff
                      applies.  If absent assumes end of day (ie. one second
                      before midnight)
                    type: string
                    x-cds-type: TimeString
                    example: '23:00'
                required:
                  - days
                type: object
              type: array
          required:
            - amount
            - timeVariations
          type: object
      required:
        - displayName
        - payerType
        - scheme
        - tariffUType
      type: object
      x-conditional:
        - singleTariff
        - timeVaryingTariffs
    EnumEnergyPlanTariffTypeV1:
      description: Type of charge. Assumed to be `OTHER` if absent
      default: OTHER
      enum:
        - ENVIRONMENTAL
        - REGULATED
        - NETWORK
        - METERING
        - RETAIL_SERVICE
        - RCTI
        - OTHER
      type: string
      example: OTHER
    EnumEnergyTariffPeriodTimeZoneV1:
      description: >-
        Specifies the charge specific time zone for calculation of the time of
        use thresholds. If absent, timezone value in EnergyPlanContract is
        assumed
      enum:
        - LOCAL
        - AEST
      type: string
      example: AEST
    EnergyPlanTariffPeriodSingleRateV1:
      description: >-
        Object representing a single rate.  Required if rateBlockUType is
        singleRate
      properties:
        displayName:
          description: Display name of the rate
          type: string
          example: Single Rate Charge
        description:
          description: Description of the rate
          type: string
          example: A single universal rate
        generalUnitPrice:
          description: >-
            The block rate (unit price) for any usage above the included fixed
            usage, in dollars per kWh inclusive of GST.  Only required if
            pricingModel field is `QUOTA`
          type: string
          x-cds-type: AmountString
          example: '0.12'
        rates:
          description: Array of controlled load rates in order of usage volume
          items:
            $ref: '#/components/schemas/EnergyPlanRateV1'
          type: array
        period:
          description: >-
            Usage period for which the block rate applies. Formatted according
            to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax)
          type: string
          x-cds-type: DurationString
          example: PT2H30M
      required:
        - displayName
        - rates
      type: object
      x-conditional:
        - generalUnitPrice
    EnumEnergyTariffPeriodTimeOfUseRateTypeV1:
      description: The type of usage that the rate applies to
      enum:
        - PEAK
        - OFF_PEAK
        - SHOULDER
        - SHOULDER1
        - SHOULDER2
      type: string
      example: PEAK
    EnergyPlanTariffPeriodTimeOfUseRateV1:
      properties:
        displayName:
          description: Display name of the rate
          type: string
          example: Time of use charge applied
        description:
          description: Description of the rate
          type: string
          example: Rate applied based on the time the energy is used
        rates:
          description: Array of controlled load rates in order of usage volume
          items:
            $ref: '#/components/schemas/EnergyPlanRateV1'
          type: array
        timeOfUse:
          description: Array of times of use
          items:
            properties:
              days:
                description: The days that the rate applies to
                items:
                  $ref: '#/components/schemas/EnumEnergyDayV1'
                type: array
                example:
                  - MON
                  - TUE
                  - WED
                  - THU
                  - FRI
              startTime:
                description: >-
                  Start of the period

                  Formatted according to [ISO 8601
                  Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the
                  time is provided without a UTC offset, the time zone will be
                  determined by the value of EnergyPlanContract.timeZone.
                type: string
                x-cds-type: TimeString
                example: 17:00:00.000+10:00
              endTime:
                description: >-
                  End of the period

                  Formatted according to [ISO 8601
                  Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the
                  time is provided without a UTC offset, the time zone will be
                  determined by the value of EnergyPlanContract.timeZone.
                type: string
                x-cds-type: TimeString
                example: 20:59:59.999+10:00
            required:
              - days
              - endTime
              - startTime
            type: object
          type: array
        type:
          $ref: '#/components/schemas/EnumEnergyTariffPeriodTimeOfUseRateTypeV1'
      required:
        - displayName
        - rates
        - timeOfUse
        - type
      type: object
    EnumEnergyDemandMeasureUnitV1:
      description: The measurement unit of rate. Assumed to be KVA if absent
      enum:
        - KWH
        - KVA
        - KVAR
        - KVARH
        - KW
        - DAYS
        - METER
        - MONTH
      type: string
      example: KWH
    EnumEnergyPlanTariffMeasurementPeriodV1:
      description: Application period for the demand tariff
      enum:
        - DAY
        - MONTH
        - TARIFF_PERIOD
      type: string
      example: DAY
    EnumEnergyPlanTariffChargePeriodV1:
      description: Charge period for the demand tariff
      enum:
        - DAY
        - MONTH
        - TARIFF_PERIOD
      type: string
      example: DAY
    EnergyPlanTariffDemandChargeV1:
      properties:
        displayName:
          description: Display name of the charge
          type: string
          example: Demand Charge
        description:
          description: Description of the charge
          type: string
          example: A tariff applied based on the level of demand
        amount:
          description: The charge amount per  measure unit exclusive of GST
          type: string
          x-cds-type: AmountString
          example: '0.2444'
        measureUnit:
          $ref: '#/components/schemas/EnumEnergyDemandMeasureUnitV1'
        startTime:
          description: Start of the period
          type: string
          x-cds-type: TimeString
          example: 06:45:00Z
        endTime:
          description: End of the period
          type: string
          x-cds-type: TimeString
          example: 21:45:00Z
        days:
          description: The days that the demand tariff applies to
          items:
            $ref: '#/components/schemas/EnumEnergyDayV1'
          type: array
        minDemand:
          default: '0.00'
          description: >-
            Minimum demand for this demand tariff in kW.  If absent then 0 is
            assumed
          type: string
          x-cds-type: AmountString
        maxDemand:
          description: >-
            Maximum demand for this demand tariff in kW.  If present, must be
            higher than the value of the minDemand field
          type: string
          x-cds-type: AmountString
          example: '15.00'
        measurementPeriod:
          $ref: '#/components/schemas/EnumEnergyPlanTariffMeasurementPeriodV1'
        chargePeriod:
          $ref: '#/components/schemas/EnumEnergyPlanTariffChargePeriodV1'
      required:
        - amount
        - chargePeriod
        - displayName
        - endTime
        - measurementPeriod
        - startTime
      type: object
    EnergyPlanTariffPeriodV1:
      properties:
        type:
          $ref: '#/components/schemas/EnumEnergyPlanTariffTypeV1'
        displayName:
          description: The name of the tariff period
          type: string
          example: Plan Tariff
        startDate:
          description: >-
            The start date of the tariff period in a calendar year.  Formatted
            in mm-dd format
          type: string
          pattern: ^\d\d-\d\d$
          example: 08-01
        endDate:
          description: >-
            The end date of the tariff period in a calendar year.  Formatted in
            mm-dd format
          type: string
          pattern: ^\d\d-\d\d$
          example: 12-01
        dailySupplyCharges:
          description: >-
            The amount of access charge for the tariff period, in dollars per
            day exclusive of GST.
          type: string
          x-cds-type: AmountString
          example: '1.00'
        timeZone:
          $ref: '#/components/schemas/EnumEnergyTariffPeriodTimeZoneV1'
        rateBlockUType:
          description: Specifies the type of rate applicable to this tariff period
          enum:
            - singleRate
            - timeOfUseRates
            - demandCharges
          type: string
          example: singleRate
        singleRate:
          $ref: '#/components/schemas/EnergyPlanTariffPeriodSingleRateV1'
        timeOfUseRates:
          description: >-
            Array of objects representing time of use rates.  Required if
            rateBlockUType is timeOfUseRates
          items:
            $ref: '#/components/schemas/EnergyPlanTariffPeriodTimeOfUseRateV1'
          type: array
        demandCharges:
          description: >-
            Array of demand charges.  Required if rateBlockUType is
            demandCharges
          items:
            $ref: '#/components/schemas/EnergyPlanTariffDemandChargeV1'
          type: array
      required:
        - displayName
        - endDate
        - rateBlockUType
        - startDate
      type: object
      x-conditional:
        - singleRate
        - timeOfUseRates
        - demandCharges
    EnergyPlanContractV1:
      properties:
        additionalFeeInformation:
          description: >-
            Free text field containing additional information of the fees for
            this contract
          type: string
          example: Additional Solar Feed In Fee
        pricingModel:
          $ref: '#/components/schemas/EnumEnergyPlanContractPricingModelV1'
        timeZone:
          $ref: '#/components/schemas/EnumEnergyPlanContractTimeZoneV1'
        isFixed:
          description: Flag indicating whether prices are fixed or variable
          type: boolean
          example: true
        variation:
          description: >-
            Free text description of price variation policy and conditions for
            the contract.  Mandatory if isFixed is false
          type: string
          example: Price Variations possible by calling support center
        onExpiryDescription:
          description: >-
            Free text field that describes what will occur on or prior to expiry
            of the fixed contract term or benefit period
          type: string
          example: >-
            On expiry of the contract the price will revert to the spot price at
            any given time
        paymentOption:
          description: Payment options for this contract
          items:
            $ref: '#/components/schemas/EnumEnergyPaymentMethodV1'
          type: array
        intrinsicGreenPower:
          $ref: '#/components/schemas/EnergyPlanIntrinsicGreenPowerV1'
        controlledLoad:
          description: >-
            Required if pricing model is SINGLE_RATE_CONT_LOAD or
            TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD
          items:
            $ref: '#/components/schemas/EnergyPlanControlledLoadV1'
          type: array
        incentives:
          description: Optional list of incentives available for the contract
          items:
            $ref: '#/components/schemas/EnergyPlanIncentiveV1'
          type: array
        discounts:
          description: Optional list of discounts available for the contract
          items:
            $ref: '#/components/schemas/EnergyPlanDiscountV1'
          type: array
        greenPowerCharges:
          description: Optional list of charges applicable to green power
          items:
            $ref: '#/components/schemas/EnergyPlanGreenPowerChargeV1'
          type: array
        eligibility:
          description: Eligibility restrictions or requirements
          items:
            $ref: '#/components/schemas/EnergyPlanEligibilityV1'
          type: array
        fees:
          description: An array of fees applicable to the plan
          items:
            $ref: '#/components/schemas/EnergyPlanFeeV1'
          type: array
        solarFeedInTariff:
          description: Array of feed in tariffs for solar power
          items:
            $ref: '#/components/schemas/EnergyPlanSolarFeedInTariffV1'
          type: array
        tariffPeriod:
          description: Array of tariff periods
          items:
            $ref: '#/components/schemas/EnergyPlanTariffPeriodV1'
          type: array
      required:
        - isFixed
        - paymentOption
        - pricingModel
        - tariffPeriod
      type: object
      x-conditional:
        - timeZone
        - variation
        - controlledLoad
    EnergyAccountPlanDetailV1:
      description: >-
        Detail on the plan applicable to this account. Mandatory if openStatus
        is OPEN
      properties:
        fuelType:
          $ref: '#/components/schemas/EnumEnergyFuelTypeV1'
        isContingentPlan:
          default: false
          description: >-
            Flag that indicates that the plan is contingent on the customer
            taking up an alternate fuel plan from the same retailer (for
            instance, if the fuelType is `ELECTRICITY` then a `GAS` plan from
            the same retailer must be taken up). Has no meaning if the plan has
            a fuelType of `DUAL`. If absent the value is assumed to be false
          type: boolean
        meteringCharges:
          description: Charges for metering included in the plan
          items:
            $ref: '#/components/schemas/EnergyMeteringChargeV1'
          type: array
        gasContract:
          $ref: '#/components/schemas/EnergyPlanContractV1'
        electricityContract:
          $ref: '#/components/schemas/EnergyPlanContractV1'
      required:
        - fuelType
      type: object
      x-conditional:
        - gasContract
        - electricityContract
    EnergyAccountAuthorisedContactV1:
      properties:
        firstName:
          description: >-
            For people with single names this field need not be present. The
            single name should be in the lastName field
          type: string
          example: John
        lastName:
          description: For people with single names the single name should be in this field
          type: string
          example: Doe
        middleNames:
          description: Field is mandatory but array may be empty
          items:
            type: string
          type: array
          example:
            - Jefferey
        prefix:
          description: >-
            Also known as title or salutation. The prefix to the name (e.g. Mr,
            Mrs, Ms, Miss, Sir, etc)
          type: string
          example: Mr.
        suffix:
          description: Used for a trailing suffix to the name (e.g. Jr)
          type: string
          example: Sr.
      required:
        - lastName
      type: object
    EnergyAccountDetailPlanV2:
      description: >-
        Energy account plan containing service points and associated plan
        details
      properties:
        nickname:
          description: >-
            Optional display name for the plan provided by the customer to help
            differentiate multiple plans
          type: string
          example: Solar Saver
        servicePointIds:
          description: >-
            An array of servicePointIds, representing NMIs, that this account is
            linked to
          items:
            type: string
          type: array
          example:
            - aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa
        planOverview:
          $ref: '#/components/schemas/EnergyAccountPlanOverviewV1'
        planDetail:
          $ref: '#/components/schemas/EnergyAccountPlanDetailV1'
        authorisedContacts:
          description: >-
            An array of additional contacts that are authorised to act on this
            account
          items:
            $ref: '#/components/schemas/EnergyAccountAuthorisedContactV1'
          type: array
      required:
        - servicePointIds
      type: object
      x-conditional:
        - planDetail
        - planOverview
    EnergyAccountDetailV2:
      allOf:
        - $ref: '#/components/schemas/EnergyAccountBaseV2'
        - properties:
            plans:
              description: >-
                The array of plans containing service points and associated plan
                details
              items:
                $ref: '#/components/schemas/EnergyAccountDetailPlanV2'
              type: array
          required:
            - plans
          type: object
    ResponseEnergyAccountByIdV2:
      allOf:
        - $ref: '#/components/schemas/ResponseEnergyAccountById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/EnergyAccountDetailV2'
          required:
            - data
      type: object
    EnergyPlanSolarFeedInTariffV2:
      properties:
        displayName:
          description: The name of the tariff
          type: string
          example: Solar Feed In Tariff
        description:
          description: A description of the tariff
          type: string
          example: A base charge for feeding back into the grid
        startDate:
          description: The start date of the application of the feed in tariff
          type: string
          format: date
          x-cds-type: DateString
          example: '2021-08-03'
        endDate:
          description: The end date of the application of the feed in tariff
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-08-02'
        scheme:
          $ref: '#/components/schemas/EnumEnergyPlanSolarFeedInTariffSchemeTypeV1'
        payerType:
          $ref: '#/components/schemas/EnumEnergyPlanSolarFeedInTariffPayerTypeV1'
        tariffUType:
          description: The type of the tariff
          enum:
            - singleTariff
            - timeVaryingTariffs
          type: string
          example: singleTariff
        singleTariff:
          description: >-
            Represents a constant tariff.  Mandatory if tariffUType is set to
            singleTariff
          properties:
            rates:
              description: Array of feed in rates
              items:
                $ref: '#/components/schemas/EnergyPlanRateV1'
              type: array
          required:
            - rates
          type: object
        timeVaryingTariffs:
          description: >-
            Represents a tariff based on time.  Mandatory if tariffUType is set
            to timeVaryingTariffs
          properties:
            type:
              $ref: '#/components/schemas/EnumEnergyTariffTimeVaryingTariffTypeV1'
            rates:
              description: Array of feed in rates
              items:
                $ref: '#/components/schemas/EnergyPlanRateV1'
              type: array
            timeVariations:
              description: Array of time periods for which this tariff is applicable
              items:
                properties:
                  days:
                    description: >-
                      The days that the tariff applies to. At least one entry
                      required
                    items:
                      $ref: '#/components/schemas/EnumEnergyDayV1'
                    type: array
                    minItems: 1
                  startTime:
                    description: >-
                      The beginning of the time period per day for which the
                      tariff applies.  If absent assumes start of day (ie.
                      midnight)

                      Formatted according to [ISO 8601
                      Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If
                      the time is provided without a UTC offset, the time zone
                      will be determined by the value of
                      EnergyPlanContract.timeZone.
                    type: string
                    x-cds-type: TimeString
                    example: 17:00:00.000+10:00
                  endTime:
                    description: >-
                      The end of the time period per day for which the tariff
                      applies.  If absent assumes end of day (ie. one second
                      before midnight)

                      Formatted according to [ISO 8601
                      Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If
                      the time is provided without a UTC offset, the time zone
                      will be determined by the value of
                      EnergyPlanContract.timeZone.
                    type: string
                    x-cds-type: TimeString
                    example: 20:59:59.999+10:00
                required:
                  - days
                type: object
              type: array
          required:
            - rates
            - timeVariations
          type: object
      required:
        - displayName
        - payerType
        - scheme
        - tariffUType
      type: object
      x-conditional:
        - singleTariff
        - timeVaryingTariffs
    EnergyPlanContractV2:
      properties:
        additionalFeeInformation:
          description: >-
            Free text field containing additional information of the fees for
            this contract
          type: string
          example: Additional Solar Feed In Fee
        pricingModel:
          $ref: '#/components/schemas/EnumEnergyPlanContractPricingModelV1'
        timeZone:
          $ref: '#/components/schemas/EnumEnergyPlanContractTimeZoneV1'
        isFixed:
          description: Flag indicating whether prices are fixed or variable
          type: boolean
          example: true
        variation:
          description: >-
            Free text description of price variation policy and conditions for
            the contract.  Mandatory if isFixed is false
          type: string
          example: Price Variations possible by calling support center
        onExpiryDescription:
          description: >-
            Free text field that describes what will occur on or prior to expiry
            of the fixed contract term or benefit period
          type: string
          example: >-
            On expiry of the contract the price will revert to the spot price at
            any given time
        paymentOption:
          description: Payment options for this contract
          items:
            $ref: '#/components/schemas/EnumEnergyPaymentMethodV1'
          type: array
        intrinsicGreenPower:
          $ref: '#/components/schemas/EnergyPlanIntrinsicGreenPowerV1'
        controlledLoad:
          description: >-
            Required if pricing model is SINGLE_RATE_CONT_LOAD or
            TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD
          items:
            $ref: '#/components/schemas/EnergyPlanControlledLoadV1'
          type: array
        incentives:
          description: Optional list of incentives available for the contract
          items:
            $ref: '#/components/schemas/EnergyPlanIncentiveV1'
          type: array
        discounts:
          description: Optional list of discounts available for the contract
          items:
            $ref: '#/components/schemas/EnergyPlanDiscountV1'
          type: array
        greenPowerCharges:
          description: Optional list of charges applicable to green power
          items:
            $ref: '#/components/schemas/EnergyPlanGreenPowerChargeV1'
          type: array
        eligibility:
          description: Eligibility restrictions or requirements
          items:
            $ref: '#/components/schemas/EnergyPlanEligibilityV1'
          type: array
        fees:
          description: An array of fees applicable to the plan
          items:
            $ref: '#/components/schemas/EnergyPlanFeeV1'
          type: array
        solarFeedInTariff:
          description: Array of feed in tariffs for solar power
          items:
            $ref: '#/components/schemas/EnergyPlanSolarFeedInTariffV2'
          type: array
        tariffPeriod:
          description: Array of tariff periods
          items:
            $ref: '#/components/schemas/EnergyPlanTariffPeriodV1'
          type: array
      required:
        - isFixed
        - paymentOption
        - pricingModel
        - tariffPeriod
      type: object
      x-conditional:
        - timeZone
        - variation
        - controlledLoad
    EnergyAccountPlanDetailV2:
      description: >-
        Detail on the plan applicable to this account. Mandatory if openStatus
        is OPEN
      properties:
        fuelType:
          $ref: '#/components/schemas/EnumEnergyFuelTypeV1'
        isContingentPlan:
          default: false
          description: >-
            Flag that indicates that the plan is contingent on the customer
            taking up an alternate fuel plan from the same retailer (for
            instance, if the fuelType is `ELECTRICITY` then a `GAS` plan from
            the same retailer must be taken up). Has no meaning if the plan has
            a fuelType of `DUAL`. If absent the value is assumed to be false
          type: boolean
        meteringCharges:
          description: Charges for metering included in the plan
          items:
            $ref: '#/components/schemas/EnergyMeteringChargeV1'
          type: array
        gasContract:
          $ref: '#/components/schemas/EnergyPlanContractV2'
        electricityContract:
          $ref: '#/components/schemas/EnergyPlanContractV2'
      required:
        - fuelType
      type: object
      x-conditional:
        - gasContract
        - electricityContract
    EnergyAccountDetailPlanV3:
      description: >-
        Energy account plan containing service points and associated plan
        details
      properties:
        nickname:
          description: >-
            Optional display name for the plan provided by the customer to help
            differentiate multiple plans
          type: string
          example: Solar Saver
        servicePointIds:
          description: >-
            An array of servicePointIds, representing NMIs, that this account is
            linked to
          items:
            type: string
          type: array
          example:
            - aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa
        planOverview:
          $ref: '#/components/schemas/EnergyAccountPlanOverviewV1'
        planDetail:
          $ref: '#/components/schemas/EnergyAccountPlanDetailV2'
        authorisedContacts:
          description: >-
            An array of additional contacts that are authorised to act on this
            account
          items:
            $ref: '#/components/schemas/EnergyAccountAuthorisedContactV1'
          type: array
      required:
        - servicePointIds
      type: object
      x-conditional:
        - planDetail
        - planOverview
    EnergyAccountDetailV3:
      allOf:
        - $ref: '#/components/schemas/EnergyAccountBaseV2'
        - properties:
            plans:
              description: >-
                The array of plans containing service points and associated plan
                details
              items:
                $ref: '#/components/schemas/EnergyAccountDetailPlanV3'
              type: array
          required:
            - plans
          type: object
    ResponseEnergyAccountByIdV3:
      allOf:
        - $ref: '#/components/schemas/ResponseEnergyAccountById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/EnergyAccountDetailV3'
          required:
            - data
      type: object
    EnergyPlanControlledLoadSingleRateV2:
      description: >-
        Object representing a single controlled load rate.  Required if
        rateBlockUType is singleRate
      properties:
        displayName:
          description: Display name of the controlled load rate
          type: string
          example: Single Rate Charge
        description:
          description: Description of the controlled load rate
          type: string
        dailySupplyCharge:
          description: >-
            The daily supply charge (exclusive of GST) for this controlled load
            tier
          type: string
          x-cds-type: AmountString
        rates:
          description: Array of controlled load rates in order of usage volume
          items:
            $ref: '#/components/schemas/EnergyPlanRateV1'
          type: array
        period:
          description: >-
            Usage period for which the block rate applies. Formatted according
            to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax). Defaults to P1Y if absent.
          type: string
          x-cds-type: DurationString
      required:
        - displayName
        - rates
      type: object
    EnergyPlanControlledLoadTimeOfUseRateV2:
      properties:
        displayName:
          description: Display name of the controlled load rate
          type: string
          example: Time of use charge applied
        description:
          description: Description of the controlled load rate
          type: string
        dailySupplyCharge:
          description: >-
            The daily supply charge (exclusive of GST) for this controlled load
            tier
          type: string
          x-cds-type: AmountString
        rates:
          description: Array of controlled load rates in order of usage volume
          items:
            $ref: '#/components/schemas/EnergyPlanRateV1'
          type: array
        period:
          description: >-
            Usage period for which the block rate applies. Formatted according
            to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax). Defaults to P1Y if absent.
          type: string
          x-cds-type: DurationString
        timeOfUse:
          description: Array of times of use.
          items:
            properties:
              days:
                description: The days that the rate applies to
                items:
                  $ref: '#/components/schemas/EnumEnergyDayV1'
                type: array
                example:
                  - PUBLIC_HOLIDAYS
              startTime:
                description: >-
                  The beginning of the time period per day for which the
                  controlled load rate applies. Required if endTime provided

                  Formatted according to [ISO 8601
                  Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the
                  time is provided without a UTC offset, the time zone will be
                  determined by the value of EnergyPlanContract.timeZone.
                type: string
                x-cds-type: TimeString
                example: 17:00:00.000+10:00
              endTime:
                description: >-
                  The end of the time period per day for which the controlled
                  load rate applies. Required if startTime provided

                  Formatted according to [ISO 8601
                  Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the
                  time is provided without a UTC offset, the time zone will be
                  determined by the value of EnergyPlanContract.timeZone.
                type: string
                x-cds-type: TimeString
                example: 20:59:59.999+10:00
              additionalInfo:
                description: >-
                  Display text providing more information on the controlled
                  load, for e.g. controlled load availability if specific
                  day/time is not known. Required if startTime and endTime
                  absent or if additionalInfoUri provided
                type: string
              additionalInfoUri:
                description: >-
                  Optional link to additional information regarding the
                  controlled load
                type: string
                format: uri
                x-cds-type: URIString
            type: object
            x-conditional:
              - startTime
              - endTime
              - additionalInfo
          type: array
        type:
          $ref: '#/components/schemas/EnumEnergyControlledLoadTimeOfUseRateTypeV1'
      required:
        - displayName
        - rates
        - timeOfUse
        - type
      type: object
    EnergyPlanControlledLoadV2:
      properties:
        displayName:
          description: A display name for the controlled load
          type: string
          example: Electric hot water system
        rateBlockUType:
          description: Specifies the type of controlled load rate
          enum:
            - singleRate
            - timeOfUseRates
          type: string
          example: singleRate
        startDate:
          description: Optional start date of the application of the controlled load rate
          type: string
          format: date
          x-cds-type: DateString
          example: '2021-10-23'
        endDate:
          description: Optional end date of the application of the controlled load rate
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-04-30'
        singleRate:
          $ref: '#/components/schemas/EnergyPlanControlledLoadSingleRateV2'
        timeOfUseRates:
          description: >-
            Array of objects representing time of use rates.  Required if
            rateBlockUType is timeOfUseRates
          items:
            $ref: '#/components/schemas/EnergyPlanControlledLoadTimeOfUseRateV2'
          type: array
      required:
        - displayName
        - rateBlockUType
      type: object
      x-conditional:
        - singleRate
        - timeOfUseRates
    EnumEnergyPlanSolarFeedInTariffSchemeTypeV2:
      description: The applicable scheme
      enum:
        - PREMIUM
        - CURRENT
        - VARIABLE
        - OTHER
      type: string
      example: PREMIUM
    EnergyPlanSolarFeedInTariffV3:
      properties:
        displayName:
          description: The name of the tariff
          type: string
          example: Solar Feed In Tariff
        description:
          description: A description of the tariff
          type: string
          example: A base charge for feeding back into the grid
        startDate:
          description: The start date of the application of the feed in tariff
          type: string
          format: date
          x-cds-type: DateString
          example: '2021-08-03'
        endDate:
          description: The end date of the application of the feed in tariff
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-08-02'
        scheme:
          $ref: '#/components/schemas/EnumEnergyPlanSolarFeedInTariffSchemeTypeV2'
        payerType:
          $ref: '#/components/schemas/EnumEnergyPlanSolarFeedInTariffPayerTypeV1'
        tariffUType:
          description: Reference to the applicable tariff structure
          enum:
            - singleTariff
            - timeVaryingTariffs
          type: string
          example: singleTariff
        singleTariff:
          description: >-
            Represents a constant tariff.  Mandatory if tariffUType is set to
            singleTariff
          properties:
            rates:
              description: Array of feed in rates
              items:
                $ref: '#/components/schemas/EnergyPlanRateV1'
              type: array
            period:
              description: >-
                Usage period for which the block rate applies. Formatted
                according to [ISO 8601
                Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
                (excludes recurrence syntax). Defaults to P1Y if absent.
              type: string
              x-cds-type: DurationString
          required:
            - rates
          type: object
        timeVaryingTariffs:
          description: >-
            Represents a tariff based on time.  Mandatory if tariffUType is set
            to timeVaryingTariffs
          items:
            properties:
              type:
                $ref: '#/components/schemas/EnumEnergyTariffTimeVaryingTariffTypeV1'
              displayName:
                description: Display name of the tariff
                type: string
                example: Solar Feed In Tariff Time Varying Tariff
              rates:
                description: Array of feed in rates
                items:
                  $ref: '#/components/schemas/EnergyPlanRateV1'
                type: array
              period:
                description: >-
                  Usage period for which the block rate applies. Formatted
                  according to [ISO 8601
                  Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
                  (excludes recurrence syntax). Defaults to P1Y if absent.
                type: string
                x-cds-type: DurationString
              timeVariations:
                description: Array of time periods for which this tariff is applicable
                items:
                  properties:
                    days:
                      description: >-
                        The days that the tariff applies to. At least one entry
                        required
                      items:
                        $ref: '#/components/schemas/EnumEnergyDayV1'
                      type: array
                      minItems: 1
                    startTime:
                      description: >-
                        The beginning of the time period per day for which the
                        tariff applies.  If absent assumes start of day (ie.
                        midnight)

                        Formatted according to [ISO 8601
                        Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If
                        the time is provided without a UTC offset, the time zone
                        will be determined by the value of
                        EnergyPlanContract.timeZone.
                      type: string
                      x-cds-type: TimeString
                      example: '12:00'
                    endTime:
                      description: >-
                        The end of the time period per day for which the tariff
                        applies.  If absent assumes end of day (ie. one second
                        before midnight)

                        Formatted according to [ISO 8601
                        Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If
                        the time is provided without a UTC offset, the time zone
                        will be determined by the value of
                        EnergyPlanContract.timeZone.
                      type: string
                      x-cds-type: TimeString
                      example: '23:00'
                  required:
                    - days
                  type: object
                type: array
            required:
              - timeVariations
              - displayName
            type: object
          type: array
      required:
        - displayName
        - payerType
        - scheme
        - tariffUType
      type: object
      x-conditional:
        - singleTariff
        - timeVaryingTariffs
    EnumEnergyPlanTariffDailySupplyChargeTypeV1:
      description: Specifies if daily supply charge is single or banded.
      enum:
        - SINGLE
        - BAND
      type: string
      example: SINGLE
    EnumEnergyBandedDailySupplyMeasureUnitV1:
      description: The measurement unit of rate. Assumed to be DAYS if absent
      enum:
        - KWH
        - KVA
        - KVAR
        - KVARH
        - KW
        - DAYS
        - METER
        - MONTH
      type: string
      example: DAYS
    EnergyPlanBandedDailySupplyChargeV1:
      type: object
      properties:
        unitPrice:
          description: >-
            The amount of daily supply charge for the band, in dollars per day
            exclusive of GST
          type: string
          x-cds-type: AmountString
          example: '0.35'
        measureUnit:
          $ref: '#/components/schemas/EnumEnergyBandedDailySupplyMeasureUnitV1'
        volume:
          description: Volume the charge applies to
          type: number
      required:
        - unitPrice
    EnergyPlanTariffPeriodTimeOfUseRateV2:
      properties:
        displayName:
          description: Display name of the rate
          type: string
          example: Time of use charge applied
        description:
          description: Description of the rate
          type: string
          example: Rate applied based on the time the energy is used
        rates:
          description: Array of controlled load rates in order of usage volume
          items:
            $ref: '#/components/schemas/EnergyPlanRateV1'
          type: array
        period:
          description: >-
            Usage period for which the block rate applies. Formatted according
            to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax). Defaults to P1Y if absent.
          type: string
          x-cds-type: DurationString
        timeOfUse:
          description: Array of times of use
          items:
            properties:
              days:
                description: The days that the rate applies to
                items:
                  $ref: '#/components/schemas/EnumEnergyDayV1'
                type: array
                example:
                  - MON
                  - TUE
                  - WED
                  - THU
                  - FRI
              startTime:
                description: >-
                  Start of the period

                  Formatted according to [ISO 8601
                  Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the
                  time is provided without a UTC offset, the time zone will be
                  determined by the value of EnergyPlanContract.timeZone.
                type: string
                x-cds-type: TimeString
                example: 17:00:00.000+10:00
              endTime:
                description: >-
                  End of the period

                  Formatted according to [ISO 8601
                  Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the
                  time is provided without a UTC offset, the time zone will be
                  determined by the value of EnergyPlanContract.timeZone.
                type: string
                x-cds-type: TimeString
                example: 20:59:59.999+10:00
            required:
              - days
              - endTime
              - startTime
            type: object
          type: array
        type:
          $ref: '#/components/schemas/EnumEnergyTariffPeriodTimeOfUseRateTypeV1'
      required:
        - displayName
        - rates
        - timeOfUse
        - type
      type: object
    EnergyPlanTariffPeriodV2:
      properties:
        type:
          $ref: '#/components/schemas/EnumEnergyPlanTariffTypeV1'
        displayName:
          description: The name of the tariff period
          type: string
          example: Plan Tariff
        startDate:
          description: >-
            The start date of the tariff period in a calendar year.  Formatted
            in mm-dd format
          type: string
          pattern: ^\d\d-\d\d$
          example: 08-01
        endDate:
          description: >-
            The end date of the tariff period in a calendar year.  Formatted in
            mm-dd format
          type: string
          pattern: ^\d\d-\d\d$
          example: 12-01
        dailySupplyChargeType:
          $ref: '#/components/schemas/EnumEnergyPlanTariffDailySupplyChargeTypeV1'
        dailySupplyCharge:
          description: >-
            The amount of access charge for the tariff period, in dollars per
            day exclusive of GST. Mandatory if dailySupplyChargeType is SINGLE
          type: string
          x-cds-type: AmountString
          example: '1.00'
        bandedDailySupplyCharges:
          type: array
          description: >-
            Array representing banded daily supply charge rates.  Mandatory if
            dailySupplyChargeType is BAND
          items:
            $ref: '#/components/schemas/EnergyPlanBandedDailySupplyChargeV1'
        timeZone:
          $ref: '#/components/schemas/EnumEnergyTariffPeriodTimeZoneV1'
        rateBlockUType:
          description: Specifies the type of rate applicable to this tariff period
          enum:
            - singleRate
            - timeOfUseRates
            - demandCharges
          type: string
          example: singleRate
        singleRate:
          $ref: '#/components/schemas/EnergyPlanTariffPeriodSingleRateV1'
        timeOfUseRates:
          description: >-
            Array of objects representing time of use rates.  Required if
            rateBlockUType is timeOfUseRates
          items:
            $ref: '#/components/schemas/EnergyPlanTariffPeriodTimeOfUseRateV2'
          type: array
        demandCharges:
          description: >-
            Array of demand charges.  Required if rateBlockUType is
            demandCharges
          items:
            $ref: '#/components/schemas/EnergyPlanTariffDemandChargeV1'
          type: array
      required:
        - displayName
        - endDate
        - rateBlockUType
        - startDate
      type: object
      x-conditional:
        - singleRate
        - timeOfUseRates
        - demandCharges
        - dailySupplyCharge
        - bandedDailySupplyCharges
    EnergyPlanContractV3:
      properties:
        additionalFeeInformation:
          description: >-
            Free text field containing additional information of the fees for
            this contract
          type: string
          example: Additional Solar Feed In Fee
        pricingModel:
          $ref: '#/components/schemas/EnumEnergyPlanContractPricingModelV1'
        timeZone:
          $ref: '#/components/schemas/EnumEnergyPlanContractTimeZoneV1'
        isFixed:
          description: Flag indicating whether prices are fixed or variable
          type: boolean
          example: true
        variation:
          description: >-
            Free text description of price variation policy and conditions for
            the contract.  Mandatory if isFixed is false
          type: string
          example: Price Variations possible by calling support center
        onExpiryDescription:
          description: >-
            Free text field that describes what will occur on or prior to expiry
            of the fixed contract term or benefit period
          type: string
          example: >-
            On expiry of the contract the price will revert to the spot price at
            any given time
        paymentOption:
          description: Payment options for this contract
          items:
            $ref: '#/components/schemas/EnumEnergyPaymentMethodV1'
          type: array
        intrinsicGreenPower:
          $ref: '#/components/schemas/EnergyPlanIntrinsicGreenPowerV1'
        controlledLoad:
          description: >-
            Required if pricing model is SINGLE_RATE_CONT_LOAD or
            TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD
          items:
            $ref: '#/components/schemas/EnergyPlanControlledLoadV2'
          type: array
        incentives:
          description: Optional list of incentives available for the contract
          items:
            $ref: '#/components/schemas/EnergyPlanIncentiveV1'
          type: array
        discounts:
          description: Optional list of discounts available for the contract
          items:
            $ref: '#/components/schemas/EnergyPlanDiscountV1'
          type: array
        greenPowerCharges:
          description: Optional list of charges applicable to green power
          items:
            $ref: '#/components/schemas/EnergyPlanGreenPowerChargeV1'
          type: array
        eligibility:
          description: Eligibility restrictions or requirements
          items:
            $ref: '#/components/schemas/EnergyPlanEligibilityV1'
          type: array
        fees:
          description: An array of fees applicable to the plan
          items:
            $ref: '#/components/schemas/EnergyPlanFeeV1'
          type: array
        solarFeedInTariff:
          description: Array of feed in tariffs for solar power
          items:
            $ref: '#/components/schemas/EnergyPlanSolarFeedInTariffV3'
          type: array
        tariffPeriod:
          description: Array of tariff periods
          items:
            $ref: '#/components/schemas/EnergyPlanTariffPeriodV2'
          type: array
      required:
        - isFixed
        - paymentOption
        - pricingModel
        - tariffPeriod
      type: object
      x-conditional:
        - timeZone
        - variation
        - controlledLoad
    EnergyAccountPlanDetailV3:
      description: >-
        Detail on the plan applicable to this account. Mandatory if openStatus
        is OPEN
      properties:
        fuelType:
          $ref: '#/components/schemas/EnumEnergyFuelTypeV1'
        isContingentPlan:
          default: false
          description: >-
            Flag that indicates that the plan is contingent on the customer
            taking up an alternate fuel plan from the same retailer (for
            instance, if the fuelType is `ELECTRICITY` then a `GAS` plan from
            the same retailer must be taken up). Has no meaning if the plan has
            a fuelType of `DUAL`. If absent the value is assumed to be false
          type: boolean
        meteringCharges:
          description: Charges for metering included in the plan
          items:
            $ref: '#/components/schemas/EnergyMeteringChargeV1'
          type: array
        gasContract:
          $ref: '#/components/schemas/EnergyPlanContractV3'
        electricityContract:
          $ref: '#/components/schemas/EnergyPlanContractV3'
      required:
        - fuelType
      type: object
      x-conditional:
        - gasContract
        - electricityContract
    EnergyAccountDetailPlanV4:
      description: >-
        Energy account plan containing service points and associated plan
        details
      properties:
        nickname:
          description: >-
            Optional display name for the plan provided by the customer to help
            differentiate multiple plans
          type: string
          example: Solar Saver
        servicePointIds:
          description: >-
            An array of servicePointIds, representing NMIs, that this account is
            linked to
          items:
            type: string
          type: array
          example:
            - aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa
        planOverview:
          $ref: '#/components/schemas/EnergyAccountPlanOverviewV1'
        planDetail:
          $ref: '#/components/schemas/EnergyAccountPlanDetailV3'
        authorisedContacts:
          description: >-
            An array of additional contacts that are authorised to act on this
            account
          items:
            $ref: '#/components/schemas/EnergyAccountAuthorisedContactV1'
          type: array
      required:
        - servicePointIds
      type: object
      x-conditional:
        - planDetail
        - planOverview
    EnergyAccountDetailV4:
      allOf:
        - $ref: '#/components/schemas/EnergyAccountBaseV2'
        - properties:
            plans:
              description: >-
                The array of plans containing service points and associated plan
                details
              items:
                $ref: '#/components/schemas/EnergyAccountDetailPlanV4'
              type: array
          required:
            - plans
          type: object
    ResponseEnergyAccountByIdV4:
      allOf:
        - $ref: '#/components/schemas/ResponseEnergyAccountById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/EnergyAccountDetailV4'
          required:
            - data
      type: object
    GetEnergyAccountDetail400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ErrorEnergyUnavailableAccountV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-energy:Authorisation/UnavailableEnergyAccount
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Unavailable Energy Account
        detail:
          description: >-
            The requested energy account is temporarily unavailable. Subsequent
            requests for the account may be successful. Applies when the account
            ID is provided in the URI. The error detail is the account ID of the
            resource being requested. This error code MUST be supported for
            authenticated APIs.
          type: string
          example: The requested energy account is temporarily unavailable.
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: >-
                urn:au-cds:error:cds-energy:Authorisation/UnavailableEnergyAccount
          type: object
      required:
        - code
        - title
        - detail
    ErrorEnergyInvalidAccountV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-energy:Authorisation/InvalidEnergyAccount
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Invalid Energy Account
        detail:
          description: >-
            The requested energy account is permanently unavailable. No
            subsequent request for the account will be successful. Applies when
            the account ID is provided in the URI. The error detail is the
            account ID of the resource being requested. This error code MUST be
            supported for authenticated APIs.
          type: string
          example: The requested energy account is permanently unavailable
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-energy:Authorisation/InvalidEnergyAccount
          type: object
      required:
        - code
        - title
        - detail
    GetEnergyAccountDetail404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorEnergyUnavailableAccountV1'
        - $ref: '#/components/schemas/ErrorEnergyInvalidAccountV1'
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-energy:Authorisation/UnavailableEnergyAccount: '#/components/schemas/ErrorEnergyUnavailableAccountV1'
          urn:au-cds:error:cds-energy:Authorisation/InvalidEnergyAccount: '#/components/schemas/ErrorEnergyInvalidAccountV1'
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    GetEnergyAccountDetail406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseEnergyAccountPaymentScheduleList:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseEnergyAccountPaymentScheduleListV1'
      required:
        - version
        - links
      type: object
    EnumBankingCardSchemeV1:
      description: The type of credit card held on file
      enum:
        - VISA
        - MASTERCARD
        - AMEX
        - DINERS
        - OTHER
        - UNKNOWN
      type: string
      example: VISA
    EnumEnergyPaymentScheduleCalculationTypeV1:
      description: >+
        The mechanism by which the payment amount is calculated.  Explanation

        of values are as follows:


        - **STATIC**: Indicates a consistent, static amount, per payment

        - **BALANCE** - Indicates that the outstanding balance for the account
        is paid per period

        - **CALCULATED** - Indicates that the payment amount is variable and
        calculated using a pre-defined algorithm

      enum:
        - STATIC
        - BALANCE
        - CALCULATED
      type: string
      example: CALCULATED
    EnergyPaymentScheduleCreditCardV1:
      description: >-
        Represents a regular credit card payment schedule. Mandatory if
        paymentScheduleUType is set to cardDebit
      properties:
        cardScheme:
          $ref: '#/components/schemas/EnumBankingCardSchemeV1'
        paymentFrequency:
          description: >-
            The frequency that payments will occur.  Formatted according to [ISO
            8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax)
          type: string
          x-cds-type: DurationString
          example: P3M
        calculationType:
          $ref: '#/components/schemas/EnumEnergyPaymentScheduleCalculationTypeV1'
      required:
        - calculationType
        - cardScheme
        - paymentFrequency
      type: object
    EnergyPaymentScheduleDirectDebitV1:
      description: >-
        Represents a regular direct debit from a specified bank account.
        Mandatory if paymentScheduleUType is set to directDebit
      properties:
        isTokenised:
          description: >-
            Flag indicating that the account details are tokenised, or held in a
            closed system, and is not accessible through any other channels.
            False if absent
          type: boolean
        bsb:
          description: >-
            The unmasked BSB for the account to be debited. Is expected to be
            formatted as digits only with leading zeros included and no
            punctuation or spaces.  Is required if isTokenised is absent or
            false
          type: string
        accountNumber:
          description: >-
            The unmasked account number for the account to be debited. Is
            expected to be formatted as digits only with leading zeros included
            and no punctuation or spaces.  Is required if isTokenised is absent
            or false
          type: string
        paymentFrequency:
          description: >-
            The frequency that payments will occur.  Formatted according to [ISO
            8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax)
          type: string
          x-cds-type: DurationString
          example: P3M
        calculationType:
          $ref: '#/components/schemas/EnumEnergyPaymentScheduleCalculationTypeV1'
      required:
        - calculationType
        - paymentFrequency
      type: object
      x-conditional:
        - bsb
        - accountNumber
    EnumEnergyDigitalWalletIdentifierTypeV1:
      description: |
        The type of the digital wallet identifier:
        - **EMAIL**: An email address
        - **CONTACT_NAME**: Contact name
        - **TELEPHONE**: Telephone number
      enum:
        - EMAIL
        - CONTACT_NAME
        - TELEPHONE
      type: string
      example: EMAIL
    EnumEnergyDigitalWalletProviderV1:
      description: >-
        The provider of the digital wallet service. PAYPAL_AU for PayPal, OTHER
        for other service provider.
      enum:
        - PAYPAL_AU
        - OTHER
      type: string
      example: OTHER
    EnergyPaymentScheduleDigitalWalletV1:
      description: >-
        Represents a regular payment from a digital wallet. Mandatory if
        paymentScheduleUType is set to digitalWallet
      properties:
        name:
          description: >-
            The display name of the wallet as given by the customer, else a
            default value defined by the data holder
          type: string
          example: My Digital Wallet
        identifier:
          description: The identifier of the digital wallet (dependent on type)
          type: string
          example: user@digital.wallet.com
        type:
          $ref: '#/components/schemas/EnumEnergyDigitalWalletIdentifierTypeV1'
        provider:
          $ref: '#/components/schemas/EnumEnergyDigitalWalletProviderV1'
        paymentFrequency:
          description: >-
            The frequency that payments will occur. Formatted according to [ISO
            8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax)
          type: string
          x-cds-type: DurationString
          example: P3M
        calculationType:
          $ref: '#/components/schemas/EnumEnergyPaymentScheduleCalculationTypeV1'
      required:
        - calculationType
        - identifier
        - name
        - paymentFrequency
        - provider
        - type
      type: object
    EnergyPaymentScheduleManualPaymentV1:
      description: >-
        Represents a manual payment schedule where the customer pays in response
        to a delivered statement. Mandatory if paymentScheduleUType is set to
        manualPayment
      properties:
        billFrequency:
          description: >-
            The frequency with which a bill will be issued.  Formatted according
            to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax)
          type: string
          x-cds-type: DurationString
          example: P3M
      required:
        - billFrequency
      type: object
    EnergyPaymentScheduleV1:
      properties:
        amount:
          description: >-
            Optional payment amount indicating that a constant payment amount is
            scheduled to be paid (used in bill smoothing scenarios)
          type: string
          x-cds-type: AmountString
        paymentScheduleUType:
          description: The type of object present in this response
          enum:
            - cardDebit
            - directDebit
            - digitalWallet
            - manualPayment
          type: string
          example: manualPayment
        cardDebit:
          $ref: '#/components/schemas/EnergyPaymentScheduleCreditCardV1'
        directDebit:
          $ref: '#/components/schemas/EnergyPaymentScheduleDirectDebitV1'
        digitalWallet:
          $ref: '#/components/schemas/EnergyPaymentScheduleDigitalWalletV1'
        manualPayment:
          $ref: '#/components/schemas/EnergyPaymentScheduleManualPaymentV1'
      required:
        - paymentScheduleUType
      type: object
      x-conditional:
        - cardDebit
        - directDebit
        - digitalWallet
        - manualPayment
    ResponseEnergyAccountPaymentScheduleListV1:
      allOf:
        - $ref: '#/components/schemas/ResponseEnergyAccountPaymentScheduleList'
        - type: object
          properties:
            data:
              type: object
              properties:
                paymentSchedules:
                  description: Array may be empty if no payment schedule exist
                  items:
                    $ref: '#/components/schemas/EnergyPaymentScheduleV1'
                  type: array
              required:
                - paymentSchedules
          required:
            - data
      type: object
    GetEnergyAccountPaymentSchedule400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ErrorEnergyUnavailableServicePointV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-energy:Authorisation/UnavailableServicePoint
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Unavailable Service Point
        detail:
          description: >-
            The requested service point is temporarily unavailable. Subsequent
            requests for the service point may be successful. Applies when the
            service point ID is provided in the URI. The error detail is the
            service point ID of the resource being requested. This error code
            MUST be supported for authenticated APIs.
          type: string
          example: The requested service point is temporarily unavailable.
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: >-
                urn:au-cds:error:cds-energy:Authorisation/UnavailableServicePoint
          type: object
      required:
        - code
        - title
        - detail
    ErrorEnergyInvalidServicePointV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-energy:Authorisation/InvalidServicePoint
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Invalid Service Point
        detail:
          description: >-
            The requested service point is permanently unavailable. No
            subsequent request for the service point will be successful. Applies
            when the service point is provided in the URI. The error detail is
            the service point ID of the resource being requested. This error
            code MUST be supported for authenticated APIs.
          type: string
          example: The requested service point is permanently unavailable.
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-energy:Authorisation/InvalidServicePoint
          type: object
      required:
        - code
        - title
        - detail
    GetEnergyAccountPaymentSchedule404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorEnergyUnavailableServicePointV1'
        - $ref: '#/components/schemas/ErrorEnergyInvalidServicePointV1'
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-energy:Authorisation/UnavailableServicePoint: '#/components/schemas/ErrorEnergyUnavailableServicePointV1'
          urn:au-cds:error:cds-energy:Authorisation/InvalidServicePoint: '#/components/schemas/ErrorEnergyInvalidServicePointV1'
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    GetEnergyAccountPaymentSchedule406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseEnergyAccountConcessionList:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseEnergyAccountConcessionListV1'
      required:
        - version
        - links
      type: object
    EnumEnergyConcessionTypeV1:
      description: Indicator of the method of concession calculation
      enum:
        - FIXED_AMOUNT
        - FIXED_PERCENTAGE
        - VARIABLE
      type: string
      example: FIXED_AMOUNT
    EnumEnergyConcessionApplicationV1:
      description: Specify what an energy account concession applies to
      enum:
        - INVOICE
        - USAGE
        - SERVICE_CHARGE
        - CONTROLLED_LOAD
      type: string
      example: INVOICE
    EnergyConcessionV1:
      properties:
        type:
          $ref: '#/components/schemas/EnumEnergyConcessionTypeV1'
        displayName:
          description: The display name of the concession
          type: string
          example: Pensioner Discount
        additionalInfo:
          description: >-
            Display text providing more information on the concession. Mandatory
            if type is VARIABLE
          type: string
        additionalInfoUri:
          description: Optional link to additional information regarding the concession
          type: string
          x-cds-type: URIString
          format: uri
        startDate:
          description: Optional start date for the application of the concession
          type: string
          format: date
          x-cds-type: DateString
        endDate:
          description: Optional end date for the application of the concession
          type: string
          format: date
          x-cds-type: DateString
        discountFrequency:
          description: >-
            Conditional attribute for frequency at which a concession is
            applied. Required if type is FIXED_AMOUNT or FIXED_PERCENTAGE.
            Formatted according to [ISO 8601
            Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
            (excludes recurrence syntax)
          type: string
          x-cds-type: DurationString
        amount:
          description: >-
            Conditional attribute for the amount of discount for the concession-
            required if type is FIXED_AMOUNT
          type: string
          x-cds-type: AmountString
          example: '67.39'
        percentage:
          description: >-
            Conditional attribute for the percentage of discount of concession -
            required if type is FIXED_PERCENTAGE
          type: string
          x-cds-type: RateString
          example: '0.05'
        appliedTo:
          description: >-
            Array of ENUM's to specify what the concession applies to. Multiple
            ENUM values can be provided. If absent, USAGE is assumed
          items:
            $ref: '#/components/schemas/EnumEnergyConcessionApplicationV1'
          type: array
      required:
        - displayName
        - type
      type: object
      x-conditional:
        - additionalInfo
        - discountFrequency
        - amount
        - percentage
    ResponseEnergyAccountConcessionListV1:
      allOf:
        - $ref: '#/components/schemas/ResponseEnergyAccountConcessionList'
        - type: object
          properties:
            data:
              type: object
              properties:
                concessions:
                  description: Array may be empty if no concessions exist
                  items:
                    $ref: '#/components/schemas/EnergyConcessionV1'
                  type: array
              required:
                - concessions
          required:
            - data
      type: object
    GetEnergyAccountConcessions400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetEnergyAccountConcessions404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorEnergyUnavailableAccountV1'
        - $ref: '#/components/schemas/ErrorEnergyInvalidAccountV1'
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-energy:Authorisation/UnavailableEnergyAccount: '#/components/schemas/ErrorEnergyUnavailableAccountV1'
          urn:au-cds:error:cds-energy:Authorisation/InvalidEnergyAccount: '#/components/schemas/ErrorEnergyInvalidAccountV1'
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    GetEnergyAccountConcessions406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseEnergyAccountBalanceById:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseEnergyAccountBalanceByIdV1'
      required:
        - version
        - links
      type: object
    ResponseEnergyAccountBalanceByIdV1:
      allOf:
        - $ref: '#/components/schemas/ResponseEnergyAccountBalanceById'
        - type: object
          properties:
            data:
              properties:
                balance:
                  description: >-
                    The current balance of the account. A positive value
                    indicates that amount is owing to be paid. A negative value
                    indicates that the account is in credit
                  type: string
                  x-cds-type: AmountString
                  example: '11.55'
              type: object
              required:
                - balance
          required:
            - data
      type: object
    GetEnergyAccountBalance400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetEnergyAccountBalance404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorEnergyUnavailableAccountV1'
        - $ref: '#/components/schemas/ErrorEnergyInvalidAccountV1'
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-energy:Authorisation/UnavailableEnergyAccount: '#/components/schemas/ErrorEnergyUnavailableAccountV1'
          urn:au-cds:error:cds-energy:Authorisation/InvalidEnergyAccount: '#/components/schemas/ErrorEnergyInvalidAccountV1'
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    GetEnergyAccountBalance406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseEnergyAccountBillingList:
      properties:
        version:
          type: string
          example: V2
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseEnergyAccountBillingListV1'
          V2: '#/components/schemas/ResponseEnergyAccountBillingListV2'
          V3: '#/components/schemas/ResponseEnergyAccountBillingListV3'
      required:
        - version
        - links
        - meta
      type: object
    EnumEnergyBillingTransactionTimeOfUseTypeV1:
      description: The time of use type that the transaction applies to
      enum:
        - PEAK
        - OFF_PEAK
        - OFF_PEAK_DEMAND_CHARGE
        - SHOULDER
        - SHOULDER1
        - SHOULDER2
        - CONTROLLED_LOAD
        - SOLAR
        - AGGREGATE
      type: string
      example: PEAK
    EnergyBillingTransactionCalculationFactorV1:
      properties:
        value:
          description: The value of the calculation factor
          type: number
          example: 1.34
        type:
          description: The type of the calculation factor
          enum:
            - DLF
            - MLF
          type: string
          example: DLF
      required:
        - type
        - value
      type: object
    EnergyBillingTransactionAdjustmentV1:
      properties:
        amount:
          description: The amount of the adjustment
          type: string
          x-cds-type: AmountString
          example: '10.00'
        description:
          description: A free text description of the adjustment
          type: string
          example: Adjustment
      required:
        - amount
        - description
      type: object
    EnergyBillingTransactionUsageV1:
      description: >-
        Represents a usage charge or generation credit. Mandatory if
        transactionUType is equal to usage
      properties:
        servicePointId:
          description: The ID of the service point to which this transaction applies if any
          type: string
        invoiceNumber:
          description: >-
            The number of the invoice in which this transaction is included if
            it has been issued
          type: string
        timeOfUseType:
          $ref: '#/components/schemas/EnumEnergyBillingTransactionTimeOfUseTypeV1'
        description:
          description: >-
            Optional description of the transaction that can be used for display
            purposes
          type: string
        isEstimate:
          description: >-
            Flag indicating if the usage is estimated or actual.  True indicates
            estimate.  False or absent indicates actual
          type: boolean
          example: false
        startDate:
          description: Date and time when the usage period starts
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-08-20T03:01:42+00:00'
        endDate:
          description: Date and time when the usage period ends
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-09-20T03:01:42+00:00'
        measureUnit:
          $ref: '#/components/schemas/EnumEnergyUsageMeasureUnitV1'
        usage:
          description: >-
            The usage for the period in measure unit.  A negative value
            indicates power generated
          type: number
          example: 1.55
        amount:
          description: >-
            The amount charged or credited for this transaction prior to any
            adjustments being applied.  A negative value indicates a credit
          type: string
          x-cds-type: AmountString
          example: '1.56'
        calculationFactors:
          description: Additional calculation factors that inform the transaction
          items:
            $ref: '#/components/schemas/EnergyBillingTransactionCalculationFactorV1'
          type: array
        adjustments:
          description: Optional array of adjustments arising for this transaction
          items:
            $ref: '#/components/schemas/EnergyBillingTransactionAdjustmentV1'
          type: array
      required:
        - amount
        - endDate
        - startDate
        - timeOfUseType
        - usage
      type: object
    EnergyBillingTransactionDemandV1:
      description: >-
        Represents a demand charge or generation credit. Mandatory if
        transactionUType is equal to demand
      properties:
        servicePointId:
          description: The ID of the service point to which this transaction applies if any
          type: string
          example: aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa
        invoiceNumber:
          description: >-
            The number of the invoice in which this transaction is included if
            it has been issued
          type: string
        timeOfUseType:
          $ref: '#/components/schemas/EnumEnergyBillingTransactionTimeOfUseTypeV1'
        description:
          description: >-
            Optional description of the transaction that can be used for display
            purposes
          type: string
        isEstimate:
          description: >-
            Flag indicating if the usage is estimated or actual.  True indicates
            estimate.  False or absent indicates actual
          type: boolean
        startDate:
          description: Date and time when the demand period starts
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-07-20T03:01:42+00:00'
        endDate:
          description: Date and time when the demand period ends
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-08-20T03:01:42+00:00'
        rate:
          description: >-
            The rate for the demand charge in kVA.  A negative value indicates
            power generated
          type: number
          example: 0.044
        amount:
          description: >-
            The amount charged or credited for this transaction prior to any
            adjustments being applied.  A negative value indicates a credit
          type: string
          x-cds-type: AmountString
          example: '10.00'
        calculationFactors:
          description: Additional calculation factors that inform the transaction
          items:
            $ref: '#/components/schemas/EnergyBillingTransactionCalculationFactorV1'
          type: array
        adjustments:
          description: Optional array of adjustments arising for this transaction
          items:
            $ref: '#/components/schemas/EnergyBillingTransactionAdjustmentV1'
          type: array
      required:
        - amount
        - endDate
        - rate
        - startDate
        - timeOfUseType
      type: object
    EnergyBillingTransactionOnceOffV1:
      description: >-
        Represents a once off charge or credit. Mandatory if transactionUType is
        equal to onceOff
      properties:
        servicePointId:
          description: The ID of the service point to which this transaction applies if any
          type: string
          example: aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa
        invoiceNumber:
          description: >-
            The number of the invoice in which this transaction is included if
            it has been issued
          type: string
        amount:
          description: >-
            The amount of the charge or credit.  A positive value indicates a
            charge and a negative value indicates a credit
          type: string
          x-cds-type: AmountString
          example: '10.00'
        description:
          description: A free text description of the item
          type: string
          example: Once Off Setup Charge
      required:
        - amount
        - description
      type: object
    EnergyBillingTransactionOtherV1:
      description: >-
        Represents charge other than usage and once off. Mandatory if
        transactionUType is equal to otherCharge
      properties:
        servicePointId:
          description: The ID of the service point to which this transaction applies if any
          type: string
          example: aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa
        invoiceNumber:
          description: >-
            The number of the invoice in which this transaction is included if
            it has been issued
          type: string
        startDate:
          description: Optional start date for the application of the charge
          type: string
          format: date
          x-cds-type: DateString
        endDate:
          description: Optional end date for the application of the charge
          type: string
          format: date
          x-cds-type: DateString
        type:
          $ref: '#/components/schemas/EnumEnergyPlanTariffTypeV1'
        amount:
          description: The amount of the charge
          type: string
          x-cds-type: AmountString
          example: '14.55'
        description:
          description: A free text description of the item
          type: string
          example: Miscellaneous Supply Charge
        calculationFactors:
          description: Additional calculation factors that inform the transaction
          items:
            $ref: '#/components/schemas/EnergyBillingTransactionCalculationFactorV1'
          type: array
        adjustments:
          description: Optional array of adjustments arising for this transaction
          items:
            $ref: '#/components/schemas/EnergyBillingTransactionAdjustmentV1'
          type: array
      required:
        - amount
        - description
      type: object
    EnumEnergyBillingTransactionPaymentMethodV1:
      description: The method of payment
      enum:
        - DIRECT_DEBIT
        - CARD
        - TRANSFER
        - BPAY
        - CASH
        - CHEQUE
        - OTHER
      type: string
      example: CARD
    EnergyBillingTransactionPaymentV1:
      description: >-
        Represents a payment to the account. Mandatory if transactionUType is
        equal to payment
      properties:
        amount:
          description: The amount paid
          type: string
          x-cds-type: AmountString
          example: '1.00'
        method:
          $ref: '#/components/schemas/EnumEnergyBillingTransactionPaymentMethodV1'
      required:
        - amount
        - method
      type: object
    EnergyBillingTransactionV1:
      properties:
        accountId:
          description: The ID of the account for which transaction applies
          type: string
          example: jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay
        executionDateTime:
          description: The date and time that the transaction occurred
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-08-20T03:01:42+00:00'
        gst:
          description: >-
            The GST incurred in the transaction.  Should not be included for
            credits or payments.  If absent zero is assumed
          type: string
          x-cds-type: AmountString
        transactionUType:
          description: Indicator of the type of transaction object present in this record
          enum:
            - usage
            - demand
            - onceOff
            - otherCharges
            - payment
          type: string
          example: onceOff
        usage:
          $ref: '#/components/schemas/EnergyBillingTransactionUsageV1'
        demand:
          $ref: '#/components/schemas/EnergyBillingTransactionDemandV1'
        onceOff:
          $ref: '#/components/schemas/EnergyBillingTransactionOnceOffV1'
        otherCharges:
          $ref: '#/components/schemas/EnergyBillingTransactionOtherV1'
        payment:
          $ref: '#/components/schemas/EnergyBillingTransactionPaymentV1'
      required:
        - accountId
        - executionDateTime
        - transactionUType
      type: object
      x-conditional:
        - usage
        - demand
        - onceOff
        - otherCharges
        - payment
    ResponseEnergyAccountBillingListV1:
      allOf:
        - $ref: '#/components/schemas/ResponseEnergyAccountBillingList'
        - type: object
          properties:
            data:
              type: object
              properties:
                transactions:
                  description: >-
                    Array of transactions sorted by date and time in descending
                    order
                  items:
                    $ref: '#/components/schemas/EnergyBillingTransactionV1'
                  type: array
              required:
                - transactions
          required:
            - data
      type: object
    EnumEnergyBillingTransactionUsageTimeOfUseTypeV2:
      description: The time of use type that the transaction applies to
      enum:
        - PEAK
        - OFF_PEAK
        - OFF_PEAK_DEMAND_CHARGE
        - SHOULDER
        - SHOULDER1
        - SHOULDER2
        - CONTROLLED_LOAD
        - SOLAR
        - AGGREGATE
        - ALL_DAY
      type: string
      example: PEAK
    EnergyBillingTransactionUsageV2:
      description: >-
        Represents a usage charge or generation credit. Mandatory if
        transactionUType is equal to usage
      properties:
        servicePointId:
          description: The ID of the service point to which this transaction applies if any
          type: string
        invoiceNumber:
          description: >-
            The number of the invoice in which this transaction is included if
            it has been issued
          type: string
        timeOfUseType:
          $ref: >-
            #/components/schemas/EnumEnergyBillingTransactionUsageTimeOfUseTypeV2
        description:
          description: >-
            Optional description of the transaction that can be used for display
            purposes
          type: string
        isEstimate:
          description: >-
            Flag indicating if the usage is estimated or actual.  True indicates
            estimate.  False or absent indicates actual
          type: boolean
          example: false
        startDate:
          description: Date and time when the usage period starts
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-08-20T03:01:42+00:00'
        endDate:
          description: Date and time when the usage period ends
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-09-20T03:01:42+00:00'
        measureUnit:
          $ref: '#/components/schemas/EnumEnergyUsageMeasureUnitV1'
        usage:
          description: >-
            The usage for the period in measure unit.  A negative value
            indicates power generated
          type: number
          example: 1.55
        amount:
          description: >-
            The amount charged or credited for this transaction prior to any
            adjustments being applied.  A negative value indicates a credit
          type: string
          x-cds-type: AmountString
          example: '1.56'
        calculationFactors:
          description: Additional calculation factors that inform the transaction
          items:
            $ref: '#/components/schemas/EnergyBillingTransactionCalculationFactorV1'
          type: array
        adjustments:
          description: Optional array of adjustments arising for this transaction
          items:
            $ref: '#/components/schemas/EnergyBillingTransactionAdjustmentV1'
          type: array
      required:
        - amount
        - endDate
        - startDate
        - timeOfUseType
        - usage
      type: object
    EnumEnergyBillingTransactionDemandTimeOfUseTypeV2:
      description: The time of use type that the transaction applies to
      enum:
        - PEAK
        - OFF_PEAK
        - OFF_PEAK_DEMAND_CHARGE
        - SHOULDER
        - SHOULDER1
        - SHOULDER2
        - CONTROLLED_LOAD
        - SOLAR
        - AGGREGATE
        - ALL_DAY
        - EXCESS
      type: string
      example: PEAK
    EnergyBillingTransactionDemandV2:
      description: >-
        Represents a demand charge or generation credit. Mandatory if
        transactionUType is equal to demand
      properties:
        servicePointId:
          description: The ID of the service point to which this transaction applies if any
          type: string
          example: aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa
        invoiceNumber:
          description: >-
            The number of the invoice in which this transaction is included if
            it has been issued
          type: string
        timeOfUseType:
          $ref: >-
            #/components/schemas/EnumEnergyBillingTransactionDemandTimeOfUseTypeV2
        description:
          description: >-
            Optional description of the transaction that can be used for display
            purposes
          type: string
        isEstimate:
          description: >-
            Flag indicating if the usage is estimated or actual.  True indicates
            estimate.  False or absent indicates actual
          type: boolean
        startDate:
          description: Date and time when the demand period starts
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-07-20T03:01:42+00:00'
        endDate:
          description: Date and time when the demand period ends
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-08-20T03:01:42+00:00'
        rate:
          description: >-
            The rate for the demand charge in kVA.  A negative value indicates
            power generated
          type: number
          example: 0.044
        amount:
          description: >-
            The amount charged or credited for this transaction prior to any
            adjustments being applied.  A negative value indicates a credit
          type: string
          x-cds-type: AmountString
          example: '10.00'
        calculationFactors:
          description: Additional calculation factors that inform the transaction
          items:
            $ref: '#/components/schemas/EnergyBillingTransactionCalculationFactorV1'
          type: array
        adjustments:
          description: Optional array of adjustments arising for this transaction
          items:
            $ref: '#/components/schemas/EnergyBillingTransactionAdjustmentV1'
          type: array
      required:
        - amount
        - endDate
        - rate
        - startDate
        - timeOfUseType
      type: object
    EnergyBillingTransactionV2:
      properties:
        accountId:
          description: The ID of the account for which transaction applies
          type: string
          example: jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay
        executionDateTime:
          description: The date and time that the transaction occurred
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-08-20T03:01:42+00:00'
        gst:
          description: >-
            The GST incurred in the transaction.  Should not be included for
            credits or payments.  If absent zero is assumed
          type: string
          x-cds-type: AmountString
        transactionUType:
          description: Indicator of the type of transaction object present in this record
          enum:
            - usage
            - demand
            - onceOff
            - otherCharges
            - payment
          type: string
          example: onceOff
        usage:
          $ref: '#/components/schemas/EnergyBillingTransactionUsageV2'
        demand:
          $ref: '#/components/schemas/EnergyBillingTransactionDemandV2'
        onceOff:
          $ref: '#/components/schemas/EnergyBillingTransactionOnceOffV1'
        otherCharges:
          $ref: '#/components/schemas/EnergyBillingTransactionOtherV1'
        payment:
          $ref: '#/components/schemas/EnergyBillingTransactionPaymentV1'
      required:
        - accountId
        - executionDateTime
        - transactionUType
      type: object
      x-conditional:
        - usage
        - demand
        - onceOff
        - otherCharges
        - payment
    ResponseEnergyAccountBillingListV2:
      allOf:
        - $ref: '#/components/schemas/ResponseEnergyAccountBillingList'
        - type: object
          properties:
            data:
              type: object
              properties:
                transactions:
                  description: >-
                    Array of transactions sorted by date and time in descending
                    order
                  items:
                    $ref: '#/components/schemas/EnergyBillingTransactionV2'
                  type: array
              required:
                - transactions
          required:
            - data
      type: object
    EnergyBillingTransactionDemandV3:
      description: >-
        Represents a demand charge or generation credit. Mandatory if
        transactionUType is equal to demand
      properties:
        servicePointId:
          description: The ID of the service point to which this transaction applies if any
          type: string
          example: aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa
        invoiceNumber:
          description: >-
            The number of the invoice in which this transaction is included if
            it has been issued
          type: string
        timeOfUseType:
          $ref: >-
            #/components/schemas/EnumEnergyBillingTransactionDemandTimeOfUseTypeV2
        description:
          description: >-
            Optional description of the transaction that can be used for display
            purposes
          type: string
        isEstimate:
          description: >-
            Flag indicating if the usage is estimated or actual.  True indicates
            estimate.  False or absent indicates actual
          type: boolean
        startDate:
          description: Date and time when the demand period starts
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-07-20T03:01:42+00:00'
        endDate:
          description: Date and time when the demand period ends
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-08-20T03:01:42+00:00'
        measureUnit:
          $ref: '#/components/schemas/EnumEnergyDemandMeasureUnitV1'
        rate:
          description: >-
            The rate for the demand charge in measureUnit. Assumed to be KVA if
            measureUnit not provided. A negative value indicates power generated
          type: number
          example: 0.044
        amount:
          description: >-
            The amount charged or credited for this transaction prior to any
            adjustments being applied.  A negative value indicates a credit
          type: string
          x-cds-type: AmountString
          example: '10.00'
        calculationFactors:
          description: Additional calculation factors that inform the transaction
          items:
            $ref: '#/components/schemas/EnergyBillingTransactionCalculationFactorV1'
          type: array
        adjustments:
          description: Optional array of adjustments arising for this transaction
          items:
            $ref: '#/components/schemas/EnergyBillingTransactionAdjustmentV1'
          type: array
      required:
        - amount
        - endDate
        - rate
        - startDate
        - timeOfUseType
      type: object
    EnergyBillingTransactionV3:
      properties:
        accountId:
          description: The ID of the account for which transaction applies
          type: string
          example: jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay
        executionDateTime:
          description: The date and time that the transaction occurred
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-08-20T03:01:42+00:00'
        gst:
          description: >-
            The GST incurred in the transaction.  Should not be included for
            credits or payments.  If absent zero is assumed
          type: string
          x-cds-type: AmountString
        transactionUType:
          description: Indicator of the type of transaction object present in this record
          enum:
            - usage
            - demand
            - onceOff
            - otherCharges
            - payment
          type: string
          example: onceOff
        usage:
          $ref: '#/components/schemas/EnergyBillingTransactionUsageV2'
        demand:
          $ref: '#/components/schemas/EnergyBillingTransactionDemandV3'
        onceOff:
          $ref: '#/components/schemas/EnergyBillingTransactionOnceOffV1'
        otherCharges:
          $ref: '#/components/schemas/EnergyBillingTransactionOtherV1'
        payment:
          $ref: '#/components/schemas/EnergyBillingTransactionPaymentV1'
      required:
        - accountId
        - executionDateTime
        - transactionUType
      type: object
      x-conditional:
        - usage
        - demand
        - onceOff
        - otherCharges
        - payment
    ResponseEnergyAccountBillingListV3:
      allOf:
        - $ref: '#/components/schemas/ResponseEnergyAccountBillingList'
        - type: object
          properties:
            data:
              type: object
              properties:
                transactions:
                  description: >-
                    Array of transactions sorted by date and time in descending
                    order
                  items:
                    $ref: '#/components/schemas/EnergyBillingTransactionV3'
                  type: array
              required:
                - transactions
          required:
            - data
      type: object
    GetEnergyAccountBilling400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetEnergyAccountBilling404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorEnergyUnavailableAccountV1'
        - $ref: '#/components/schemas/ErrorEnergyInvalidAccountV1'
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-energy:Authorisation/UnavailableEnergyAccount: '#/components/schemas/ErrorEnergyUnavailableAccountV1'
          urn:au-cds:error:cds-energy:Authorisation/InvalidEnergyAccount: '#/components/schemas/ErrorEnergyInvalidAccountV1'
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    GetEnergyAccountBilling406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    GetEnergyAccountBilling422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseEnergyAccountInvoiceList:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseEnergyAccountInvoiceListV1'
      required:
        - version
        - links
        - meta
      type: object
    EnergyInvoicePeriodV1:
      description: >-
        Object containing the start and end date for the period covered by the
        invoice.  Mandatory if any usage or demand based charges are included in
        the invoice
      properties:
        startDate:
          description: The start date of the period covered by this invoice
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-01-01'
        endDate:
          description: The end date of the period covered by this invoice
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-06-30'
      required:
        - endDate
        - startDate
      type: object
    EnergyInvoicePayOnTimeDiscountV1:
      description: A discount for on time payment
      properties:
        discountAmount:
          description: >-
            The amount that will be discounted if the invoice is paid by the
            date specified
          type: string
          x-cds-type: AmountString
          example: '5.00'
        gstAmount:
          description: >-
            The GST amount that will be discounted if the invoice is paid by the
            date specified.  If absent then zero is assumed
          type: string
          x-cds-type: AmountString
          example: '0.50'
        date:
          description: >-
            The date by which the invoice must be paid to receive the pay on
            time discount
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-07-15'
      required:
        - date
        - discountAmount
      type: object
    EnergyInvoiceChargeUsageOtherV1:
      properties:
        type:
          $ref: '#/components/schemas/EnumEnergyPlanTariffTypeV1'
        amount:
          description: The aggregate total of charges for this item (exclusive of GST)
          type: string
          x-cds-type: AmountString
          example: '5.00'
        description:
          description: A free text description of the type of charge
          type: string
          example: Other Usage
      required:
        - amount
        - description
      type: object
    EnergyInvoiceChargeUsageV1:
      properties:
        totalUsageCharges:
          description: >-
            The aggregate total of usage charges for the period covered by the
            invoice (exclusive of GST)
          type: string
          x-cds-type: AmountString
          example: '10.00'
        totalGenerationCredits:
          description: >-
            The aggregate total of generation credits for the period covered by
            the invoice (exclusive of GST)
          type: string
          x-cds-type: AmountString
          example: '7.00'
        totalOnceOffCharges:
          description: >-
            The aggregate total of any once off charges arising from usage for
            the period covered by the invoice (exclusive of GST)
          type: string
          x-cds-type: AmountString
          example: '10.00'
        totalOnceOffDiscounts:
          description: >-
            The aggregate total of any once off discounts or credits arising
            from usage for the period covered by the invoice (exclusive of GST)
          type: string
          x-cds-type: AmountString
          example: '10.00'
        otherCharges:
          description: >-
            Optional array of charges that may be part of the invoice (for e.g.
            environmental charges for C&I consumers) (exclusive of GST)
          items:
            $ref: '#/components/schemas/EnergyInvoiceChargeUsageOtherV1'
          type: array
        totalGst:
          description: The total GST for all usage charges.  If absent then zero is assumed
          type: string
          x-cds-type: AmountString
          example: '1.36'
      required:
        - totalGenerationCredits
        - totalOnceOffCharges
        - totalOnceOffDiscounts
        - totalUsageCharges
      type: object
    EnergyInvoiceChargeAccountV1:
      description: >-
        Object contains account level charges and credits related to electricity
        usage
      properties:
        totalCharges:
          description: >-
            The aggregate total of account level charges for the period covered
            by the invoice
          type: string
          x-cds-type: AmountString
          example: '15.00'
        totalDiscounts:
          description: >-
            The aggregate total of account level discounts or credits for the
            period covered by the invoice
          type: string
          x-cds-type: AmountString
          example: '10.00'
        totalGst:
          description: >-
            The total GST for all account level charges.  If absent then zero is
            assumed
          type: string
          x-cds-type: AmountString
          example: '1.36'
      required:
        - totalCharges
        - totalDiscounts
      type: object
    EnergyInvoiceV1:
      properties:
        accountId:
          description: The ID of the account for which the invoice was issued
          type: string
          example: jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay
        invoiceNumber:
          description: The number assigned to this invoice by the energy Retailer
          type: string
          example: '109818233'
        issueDate:
          description: >-
            The date that the invoice was actually issued (as opposed to
            generated or calculated)
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-08-01'
        dueDate:
          description: The date that the invoice is due to be paid
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-09-01'
        period:
          $ref: '#/components/schemas/EnergyInvoicePeriodV1'
        invoiceAmount:
          description: The net amount due for this invoice regardless of previous balance
          type: string
          x-cds-type: AmountString
          example: '22.00'
        gstAmount:
          description: >-
            The total GST amount for this invoice.  If absent then zero is
            assumed
          type: string
          x-cds-type: AmountString
          example: '20.00'
        payOnTimeDiscount:
          $ref: '#/components/schemas/EnergyInvoicePayOnTimeDiscountV1'
        balanceAtIssue:
          description: The account balance at the time the invoice was issued
          type: string
          x-cds-type: AmountString
          example: '10.00'
        servicePoints:
          description: >-
            Array of service point IDs to which this invoice applies. May be
            empty if the invoice contains no electricity usage related charges
          items:
            type: string
          type: array
          example:
            - aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa
        gas:
          $ref: '#/components/schemas/EnergyInvoiceChargeUsageV1'
        electricity:
          $ref: '#/components/schemas/EnergyInvoiceChargeUsageV1'
        accountCharges:
          $ref: '#/components/schemas/EnergyInvoiceChargeAccountV1'
        paymentStatus:
          description: Indicator of the payment status for the invoice
          enum:
            - PAID
            - PARTIALLY_PAID
            - NOT_PAID
          type: string
          example: NOT_PAID
      required:
        - accountId
        - balanceAtIssue
        - invoiceNumber
        - issueDate
        - paymentStatus
        - servicePoints
      type: object
      x-conditional:
        - period
    ResponseEnergyAccountInvoiceListV1:
      allOf:
        - $ref: '#/components/schemas/ResponseEnergyAccountInvoiceList'
        - type: object
          properties:
            data:
              type: object
              properties:
                invoices:
                  description: Array of invoices sorted by issue date in descending order
                  items:
                    $ref: '#/components/schemas/EnergyInvoiceV1'
                  type: array
              required:
                - invoices
          required:
            - data
      type: object
    ListEnergyAccountInvoices400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListEnergyAccountInvoices404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorEnergyUnavailableServicePointV1'
        - $ref: '#/components/schemas/ErrorEnergyInvalidServicePointV1'
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-energy:Authorisation/UnavailableServicePoint: '#/components/schemas/ErrorEnergyUnavailableServicePointV1'
          urn:au-cds:error:cds-energy:Authorisation/InvalidServicePoint: '#/components/schemas/ErrorEnergyInvalidServicePointV1'
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    ListEnergyAccountInvoices406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListEnergyAccountInvoices422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListEnergyInvoices400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListEnergyInvoices406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListEnergyInvoices422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListEnergyInvoicesSpecificAccounts400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListEnergyInvoicesSpecificAccounts406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListEnergyInvoicesSpecificAccounts422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorEnergyUnavailableAccountV1'
        - $ref: '#/components/schemas/ErrorEnergyInvalidAccountV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-energy:Authorisation/UnavailableEnergyAccount: '#/components/schemas/ErrorEnergyUnavailableAccountV1'
          urn:au-cds:error:cds-energy:Authorisation/InvalidEnergyAccount: '#/components/schemas/ErrorEnergyInvalidAccountV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    GetEnergyAccountBillingBulk400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetEnergyAccountBillingBulk406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    GetEnergyAccountBillingBulk422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListEnergyBillingSpecificAccounts400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListEnergyBillingSpecificAccounts406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListEnergyBillingSpecificAccounts422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorEnergyUnavailableAccountV1'
        - $ref: '#/components/schemas/ErrorEnergyInvalidAccountV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-energy:Authorisation/UnavailableEnergyAccount: '#/components/schemas/ErrorEnergyUnavailableAccountV1'
          urn:au-cds:error:cds-energy:Authorisation/InvalidEnergyAccount: '#/components/schemas/ErrorEnergyInvalidAccountV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseEnergyAccountBalanceList:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseEnergyAccountBalanceListV1'
      required:
        - version
        - links
        - meta
      type: object
    EnergyAccountBalanceV1:
      properties:
        accountId:
          description: >-
            The ID of the account.  To be created in accordance with CDR ID
            permanence requirements
          type: string
          example: jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay
        balance:
          description: >-
            The current balance of the account. A positive value indicates that
            amount is owing to be paid. A negative value indicates that the
            account is in credit
          type: string
          x-cds-type: AmountString
          example: '15.66'
      required:
        - accountId
        - balance
      type: object
    ResponseEnergyAccountBalanceListV1:
      allOf:
        - $ref: '#/components/schemas/ResponseEnergyAccountBalanceList'
        - type: object
          properties:
            data:
              type: object
              properties:
                balances:
                  description: Array of account balances
                  items:
                    $ref: '#/components/schemas/EnergyAccountBalanceV1'
                  type: array
              required:
                - balances
          required:
            - data
      type: object
    ListEnergyAccountBalances400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListEnergyAccountBalances406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListEnergyAccountBalances422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListBalancesSpecificEnergyAccounts400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListBalancesSpecificEnergyAccounts406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListBalancesSpecificEnergyAccounts422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorEnergyUnavailableAccountV1'
        - $ref: '#/components/schemas/ErrorEnergyInvalidAccountV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-energy:Authorisation/UnavailableEnergyAccount: '#/components/schemas/ErrorEnergyUnavailableAccountV1'
          urn:au-cds:error:cds-energy:Authorisation/InvalidEnergyAccount: '#/components/schemas/ErrorEnergyInvalidAccountV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseElectricityServicePointsList:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseElectricityServicePointsListV1'
          V2: '#/components/schemas/ResponseElectricityServicePointsListV2'
      required:
        - version
        - links
        - meta
      type: object
    EnumElectricityServicePointClassificationV1:
      description: The classification of the service point as defined in MSATS procedures
      enum:
        - EXTERNAL_PROFILE
        - GENERATOR
        - LARGE
        - SMALL
        - WHOLESALE
        - NON_CONTEST_UNMETERED_LOAD
        - NON_REGISTERED_EMBEDDED_GENERATOR
        - DISTRIBUTION_WHOLESALE
      type: string
      example: GENERATOR
    EnumElectricityServicePointStatusV1:
      description: >
        Code used to indicate the status of the service point. Note the details
        for the enumeration values below:

        - **ACTIVE**: An active, energised, service point

        - **DE_ENERGISED**: The service point exists but is deenergised

        - **EXTINCT**: The service point has been permanently decommissioned

        - **GREENFIELD**: Applies to a service point that has never been
        energised

        - **OFF_MARKET**: Applies when the service point is no longer settled in
        the NEM
      enum:
        - ACTIVE
        - DE_ENERGISED
        - EXTINCT
        - GREENFIELD
        - OFF_MARKET
      type: string
      example: ACTIVE
    EnumElectricityServicePointJurisdictionCodeWithAllV1:
      description: |-
        Jurisdiction code to which the service point belongs.This code
        defines the jurisdictional rules which apply to the service point. Note
        the details of enumeration values below:
          - **ALL**: All Jurisdictions
          - **ACT**: Australian Capital Territory
          - **NEM**: National Electricity Market
          - **NSW**: New South Wales
          - **QLD**: Queensland
          - **SA**: South Australia
          - **TAS**: Tasmania
          - **VIC**: Victoria
      enum:
        - ALL
        - ACT
        - NEM
        - NSW
        - QLD
        - SA
        - TAS
        - VIC
      type: string
      example: QLD
    EnumEnergyConsumerClassificationV1:
      description: >-
        A code that defines the consumer class as defined in the National Energy
        Retail Regulations, or in overriding Jurisdictional instruments
      enum:
        - BUSINESS
        - RESIDENTIAL
      type: string
      example: RESIDENTIAL
    EnumEnergyConsumerConsumptionThresholdV1:
      description: >-
        A code that defines the consumption threshold as defined in the National
        Energy Retail Regulations, or in overriding Jurisdictional

        instruments. 


        Note the details of enumeration values below:

        - **LOW**: Consumption is less than the _lower consumption threshold_ as
        defined in the National Energy Retail Regulations

        - **MEDIUM** - Consumption is equal to or greater than the _lower
        consumption threshold_, but less than the _upper consumption threshold_,
        as defined in the National Energy Retail Regulations

        - **HIGH**: Consumption is equal to or greater than the _upper
        consumption threshold_ as defined in the National Energy

        Retail Regulations
      enum:
        - LOW
        - MEDIUM
        - HIGH
      type: string
      example: LOW
    EnergyElectricityServicePointConsumerProfileV1:
      properties:
        classification:
          $ref: '#/components/schemas/EnumEnergyConsumerClassificationV1'
        threshold:
          $ref: '#/components/schemas/EnumEnergyConsumerConsumptionThresholdV1'
      type: object
    EnergyElectricityServicePointV1:
      description: Electricity Service Point
      properties:
        servicePointId:
          description: >-
            Tokenised ID of the service point to be used for referring to the
            service point in the CDR API suite. To be created in accordance with
            CDR ID permanence requirements
          type: string
          example: 217c06338290152ff6b1fb2bbafea8e02cc8ac2e0e2807c5d3200222e24230e3
        nationalMeteringId:
          description: >-
            The independent ID of the service point, known in the industry as
            the NMI
          type: string
          pattern: ^\d{10}$
          example: '4567123487'
        servicePointClassification:
          $ref: '#/components/schemas/EnumElectricityServicePointClassificationV1'
        servicePointStatus:
          $ref: '#/components/schemas/EnumElectricityServicePointStatusV1'
        jurisdictionCode:
          $ref: >-
            #/components/schemas/EnumElectricityServicePointJurisdictionCodeWithAllV1
        isGenerator:
          description: >-
            This flag determines whether the energy at this connection point is
            to be treated as consumer load or as a generating unit(this may
            include generator auxiliary loads). If absent defaults to false.
            <br>**Note:** Only applicable for scheduled or semischeduled
            generators, does not indicate on site generation by consumer
          type: boolean
          example: false
        validFromDate:
          description: >-
            The latest start date from which the constituent data sets of this
            service point became valid
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-08-01'
        lastUpdateDateTime:
          description: >-
            The date and time that the information for this service point was
            modified
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-05-20T02:23:25Z'
        consumerProfile:
          $ref: '#/components/schemas/EnergyElectricityServicePointConsumerProfileV1'
      required:
        - jurisdictionCode
        - lastUpdateDateTime
        - nationalMeteringId
        - servicePointClassification
        - servicePointId
        - servicePointStatus
        - validFromDate
      type: object
    ResponseElectricityServicePointsListV1:
      allOf:
        - $ref: '#/components/schemas/ResponseElectricityServicePointsList'
        - type: object
          properties:
            data:
              type: object
              properties:
                servicePoints:
                  description: The list of electricity service points returned
                  items:
                    $ref: '#/components/schemas/EnergyElectricityServicePointV1'
                  type: array
              required:
                - servicePoints
          required:
            - data
      type: object
    EnergyElectricityServicePointV2:
      description: Electricity Service Point
      properties:
        servicePointId:
          description: >-
            Tokenised ID of the service point to be used for referring to the
            service point in the CDR API suite. To be created in accordance with
            CDR ID permanence requirements
          type: string
          example: 217c06338290152ff6b1fb2bbafea8e02cc8ac2e0e2807c5d3200222e24230e3
        nationalMeteringId:
          description: >-
            The independent ID of the service point, known in the industry as
            the NMI
          type: string
          pattern: ^\d{10}$
          example: '4567123487'
        servicePointClassification:
          $ref: '#/components/schemas/EnumElectricityServicePointClassificationV1'
        servicePointStatus:
          $ref: '#/components/schemas/EnumElectricityServicePointStatusV1'
        jurisdictionCode:
          $ref: >-
            #/components/schemas/EnumElectricityServicePointJurisdictionCodeWithAllV1
        isGenerator:
          description: >-
            This flag determines whether the energy at this connection point is
            to be treated as consumer load or as a generating unit(this may
            include generator auxiliary loads). If absent defaults to false.
            <br>**Note:** Only applicable for scheduled or semischeduled
            generators, does not indicate on site generation by consumer
          type: boolean
          example: false
        validFromDate:
          description: >-
            The latest start date from which the constituent data sets of this
            service point became valid
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-08-01'
        lastUpdateDateTime:
          description: >-
            The date and time that the information for this service point was
            modified
          type: string
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-05-20T02:23:25Z'
        lastConsumerChangeDate:
          description: The date the account holder changed for the NMI.
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-08-01'
        consumerProfile:
          $ref: '#/components/schemas/EnergyElectricityServicePointConsumerProfileV1'
      required:
        - jurisdictionCode
        - lastUpdateDateTime
        - nationalMeteringId
        - servicePointClassification
        - servicePointId
        - servicePointStatus
        - validFromDate
      type: object
    ResponseElectricityServicePointsListV2:
      allOf:
        - $ref: '#/components/schemas/ResponseElectricityServicePointsList'
        - type: object
          properties:
            data:
              type: object
              properties:
                servicePoints:
                  description: The list of electricity service points returned
                  items:
                    $ref: '#/components/schemas/EnergyElectricityServicePointV2'
                  type: array
              required:
                - servicePoints
          required:
            - data
      type: object
    ListElectricityServicePoints400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ListElectricityServicePoints406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ListElectricityServicePoints422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseElectricityDERList:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseElectricityDERListV1'
      required:
        - version
        - links
        - meta
      type: object
    EnergyElectricityProtectionModeV1:
      description: >-
        Required only when the hasCentralProtectionAndControl flag is set to
        true.  One or more of the object fields will be provided to describe the
        protection modes in place
      properties:
        exportLimitKva:
          description: >-
            Maximum amount of power (kVA) that may be exported from a connection
            point to the grid, as monitored by a control / relay function. An
            absent value indicates no limit
          type: number
          example: 50
        underFrequencyProtection:
          description: Protective function limit in Hz.
          type: number
          example: 65
        underFrequencyProtectionDelay:
          description: Trip delay time in seconds.
          type: number
          example: 0.05
        overFrequencyProtection:
          description: Protective function limit in Hz.
          type: number
          example: 70
        overFrequencyProtectionDelay:
          description: Trip delay time in seconds.
          type: number
          example: 3
        underVoltageProtection:
          description: Protective function limit in V.
          type: number
          example: 210
        underVoltageProtectionDelay:
          description: Trip delay time in seconds.
          type: number
          example: 0.23
        overVoltageProtection:
          description: Protective function limit in V.
          type: number
          example: 260
        overVoltageProtectionDelay:
          description: Trip delay time in seconds.
          type: number
          example: 0.22
        sustainedOverVoltage:
          description: Sustained over voltage.
          type: number
          example: 255
        sustainedOverVoltageDelay:
          description: Sustained Over voltage protection delay in seconds.
          type: number
          example: 1.55
        frequencyRateOfChange:
          description: Rate of change of frequency trip point (Hz/s).
          type: number
          example: 5
        voltageVectorShift:
          description: Trip angle in degrees.
          type: number
          example: 90
        interTripScheme:
          description: >-
            Description of the form of inter-trip (e.g. 'from local
            substation').
          type: string
          example: From local subscription
        neutralVoltageDisplacement:
          description: Trip voltage.
          type: number
          example: 105
      type: object
    EnumElectricityEquipmentTypeV1:
      description: >-
        Indicates whether the DER device is connected via an inverter (and what
        category of inverter it is) or not (e.g. rotating machine). If absent,
        assume equipment type to be `OTHER`.
      enum:
        - INVERTER
        - OTHER
      type: string
      example: INVERTER
    EnumElectricityDeviceStatusV1:
      description: >-
        Code used to indicate the status of the device. This will be used to
        identify if an inverter is active or inactive or decommissioned
      enum:
        - ACTIVE
        - INACTIVE
        - DECOMMISSIONED
      type: string
      example: ACTIVE
    EnumElectricityDeviceTypeV1:
      description: Used to indicate the primary technology used in the DER device
      enum:
        - FOSSIL
        - HYDRO
        - WIND
        - SOLAR_PV
        - RENEWABLE
        - GEOTHERMAL
        - STORAGE
        - OTHER
      type: string
      example: RENEWABLE
    EnergyElectricityDeviceV1:
      properties:
        deviceIdentifier:
          description: >-
            Unique identifier for a single DER device or a group of DER devices
            with the same attributes. Does not align with CDR ID permanence
            standards
          type: number
          example: 2927816
        count:
          description: Number of devices in the group of DER devices
          minimum: 1
          type: integer
          x-cds-type: PositiveInteger
          example: 3
        manufacturer:
          description: >-
            The name of the device manufacturer. If absent then assumed to be
            unknown
          type: string
          example: APC
        modelNumber:
          description: The model number of the device. If absent then assumed to be unknown
          type: string
          example: '3000'
        status:
          $ref: '#/components/schemas/EnumElectricityDeviceStatusV1'
        type:
          $ref: '#/components/schemas/EnumElectricityDeviceTypeV1'
        subtype:
          description: >-
            Used to indicate the primary technology used in the DER device. This
            field is also used to record for example the battery chemistry, or
            the type of PV panel. It is also used to record if a battery is
            contained in an electric vehicle connected in a vehicle-to-grid
            arrangement. If absent then assumed to be other.
          type: string
          example: OTHER
        nominalRatedCapacity:
          description: >-
            Maximum output in kVA that is listed in the product specification by
            the manufacturer. This refers to the capacity of each unit within
            the device group. Default is 0 if value not known
          type: number
          example: 50
        nominalStorageCapacity:
          description: >-
            Maximum storage capacity in kVAh. This refers to the capacity of
            each storage module within the device group. Mandatory if type is
            equal to `STORAGE`. Default is 0 if value not known
          type: number
          example: 25
      required:
        - count
        - deviceIdentifier
        - nominalRatedCapacity
        - type
      type: object
      x-conditional:
        - nominalStorageCapacity
    EnergyElectricityACConnectionV1:
      properties:
        connectionIdentifier:
          description: >-
            AC Connection ID as defined in the DER register.  Does not align
            with CDR ID permanence standards
          type: number
          example: 19283
        count:
          description: >-
            Number of AC Connections in the group. For the suite of AC
            Connections to be considered as a group, all of the AC Connections
            included must have the same attributes
          minimum: 1
          type: integer
          x-cds-type: PositiveInteger
          example: 3
        equipmentType:
          $ref: '#/components/schemas/EnumElectricityEquipmentTypeV1'
        manufacturerName:
          description: >-
            The name of the inverter manufacturer. Mandatory if equipmentType is
            `INVERTER`
          type: string
          example: APC Power Inverter
        inverterSeries:
          description: The inverter series. Mandatory if equipmentType is `INVERTER`
          type: string
          example: INV3000
        inverterModelNumber:
          description: The inverter model number. Mandatory if equipmentType is `INVERTER`
          type: string
          example: '3000'
        commissioningDate:
          description: The date that the DER installation is commissioned
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-08-01'
        status:
          $ref: '#/components/schemas/EnumElectricityDeviceStatusV1'
        inverterDeviceCapacity:
          description: >-
            The rated AC output power that is listed in the product specified by
            the manufacturer. Mandatory if equipmentType is INVERTER. Default is
            0 if value not known
          type: number
          example: 100
        derDevices:
          items:
            $ref: '#/components/schemas/EnergyElectricityDeviceV1'
          type: array
      required:
        - commissioningDate
        - connectionIdentifier
        - count
        - derDevices
        - status
      type: object
      x-conditional:
        - manufacturerName
        - inverterSeries
        - inverterModelNumber
        - inverterDeviceCapacity
    EnergyElectricityDERV1:
      properties:
        servicePointId:
          description: >-
            Tokenised ID of the service point to be used for referring to the
            service point in the CDR API suite.  To be created in accordance
            with CDR ID permanence requirements
          type: string
          example: aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa
        approvedCapacity:
          description: >-
            Approved small generating unit capacity as agreed with NSP in the
            connection agreement, expressed in kVA. Value of 0 indicates no DER
            record exists for the given servicePointId
          type: number
          example: 100
        availablePhasesCount:
          description: >-
            The number of phases available for the installation of DER.
            Acceptable values are 0, 1, 2 or 3. Value of 0 indicates no DER
            record exists for the given servicePointId
          type: integer
          x-cds-type: NaturalNumber
          minimum: 0
          maximum: 3
          example: 3
        installedPhasesCount:
          description: >-
            The number of phases that DER is connected to. Acceptable values are
            0, 1, 2 or 3. Value of 0 indicates no DER record exists for the
            given servicePointId
          type: integer
          x-cds-type: NaturalNumber
          minimum: 0
          maximum: 3
          example: 3
        islandableInstallation:
          description: >-
            For identification of small generating units designed with the
            ability to operate in an islanded mode
          type: boolean
          example: true
        hasCentralProtectionControl:
          default: false
          description: >-
            For DER installations where NSPs specify the need for additional
            forms of protection above those inbuilt in an inverter.  If absent
            then assumed to be false
          type: boolean
          example: true
        protectionMode:
          $ref: '#/components/schemas/EnergyElectricityProtectionModeV1'
        acConnections:
          items:
            $ref: '#/components/schemas/EnergyElectricityACConnectionV1'
          type: array
      required:
        - acConnections
        - approvedCapacity
        - availablePhasesCount
        - installedPhasesCount
        - islandableInstallation
        - servicePointId
      type: object
      x-conditional:
        - protectionMode
    ResponseElectricityDERListV1:
      allOf:
        - $ref: '#/components/schemas/ResponseElectricityDERList'
        - type: object
          properties:
            data:
              type: object
              properties:
                derRecords:
                  description: The list of meter reads
                  items:
                    $ref: '#/components/schemas/EnergyElectricityDERV1'
                  type: array
              required:
                - derRecords
          required:
            - data
      type: object
    GetElectricityServicePointDERBulk400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetElectricityServicePointDERBulk406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    GetElectricityServicePointDERBulk422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    RequestServicePointIdsV1:
      type: object
      properties:
        data:
          type: object
          properties:
            servicePointIds:
              description: Array of specific servicePointIds to obtain data for
              items:
                type: string
                x-cds-type: ASCIIString
              type: array
          required:
            - servicePointIds
        meta:
          type: object
      required:
        - data
    GetElectricityDERSpecificServicePoints400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetElectricityDERSpecificServicePoints406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    GetElectricityDERSpecificServicePoints422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorEnergyUnavailableServicePointV1'
        - $ref: '#/components/schemas/ErrorEnergyInvalidServicePointV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-energy:Authorisation/UnavailableServicePoint: '#/components/schemas/ErrorEnergyUnavailableServicePointV1'
          urn:au-cds:error:cds-energy:Authorisation/InvalidServicePoint: '#/components/schemas/ErrorEnergyInvalidServicePointV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    EnumElectricityMeterReadIntervalReadTypeV1:
      default: NONE
      enum:
        - NONE
        - MIN_30
        - FULL
      type: string
      example: NONE
    ResponseElectricityUsage:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseElectricityUsageV1'
      required:
        - version
        - links
        - meta
      type: object
    EnumElectricityMeterReadQualityV1:
      default: ACTUAL
      description: The quality of the read taken.  If absent then assumed to be `ACTUAL`
      enum:
        - ACTUAL
        - SUBSTITUTE
        - FINAL_SUBSTITUTE
      type: string
      example: ACTUAL
    EnergyElectricityMeterReadBasicV1:
      description: Mandatory if readUType is set to basicRead
      properties:
        quality:
          $ref: '#/components/schemas/EnumElectricityMeterReadQualityV1'
        value:
          description: >-
            Meter read value.  If positive then it means consumption, if
            negative it means export
          type: number
          example: 14.23
      required:
        - value
      type: object
    EnumElectricityMeterReadQualityNotActualV1:
      description: The quality of the read taken that is not `ACTUAL`
      enum:
        - SUBSTITUTE
        - FINAL_SUBSTITUTE
      type: string
      example: SUBSTITUTE
    EnergyElectricityMeterReadIntervalReadQualitiesV1:
      properties:
        startInterval:
          description: Start interval for read quality flag. First read begins at 1
          type: integer
          minimum: 1
          x-cds-type: PositiveInteger
          example: 1
        endInterval:
          description: End interval for read quality flag
          minimum: 1
          type: integer
          x-cds-type: PositiveInteger
          example: 5
        quality:
          $ref: '#/components/schemas/EnumElectricityMeterReadQualityNotActualV1'
          example: FINAL_SUBSTITUTE
      required:
        - endInterval
        - quality
        - startInterval
      type: object
    EnergyElectricityMeterReadIntervalV1:
      description: Mandatory if readUType is set to intervalRead
      properties:
        readIntervalLength:
          description: >-
            Read interval length in minutes. Required when interval-reads query
            parameter equals FULL or MIN_30
          minimum: 1
          type: integer
          x-cds-type: PositiveInteger
          example: 15
        aggregateValue:
          description: >-
            The aggregate sum of the interval read values. If positive then it
            means net consumption, if negative it means net export
          type: number
          example: 150
        intervalReads:
          description: >-
            Array of Interval read values. If positive then it means
            consumption, if negative it means export. Required when
            interval-reads query parameter equals FULL or  MIN_30. Each read
            value indicates the read for the interval specified by
            readIntervalLength beginning at midnight of readStartDate (for
            example 00:00 to 00:30 would be the first reading in a 30 minute
            Interval)
          items:
            type: number
          type: array
        readQualities:
          description: >-
            Specifies quality of reads that are not ACTUAL. For read indices
            that are not specified, quality is assumed to be ACTUAL. If not
            present, all quality of all reads are assumed to be actual. Required
            when interval-reads query parameter equals FULL or MIN_30
          items:
            $ref: >-
              #/components/schemas/EnergyElectricityMeterReadIntervalReadQualitiesV1
          type: array
      required:
        - aggregateValue
      type: object
      x-conditional:
        - readIntervalLength
        - intervalReads
        - readQualities
    EnergyElectricityMeterReadV1:
      properties:
        servicePointId:
          description: >-
            Tokenised ID of the service point to be used for referring to the
            service point in the CDR API suite.  To be created in accordance
            with CDR ID permanence requirements
          type: string
          example: aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa
        registerId:
          description: Register ID of the meter register where the meter reads are obtained
          type: string
          example: '0100'
        registerSuffix:
          description: >-
            Register suffix of the meter register where the meter reads are
            obtained
          type: string
          example: P
        meterId:
          description: >-
            Meter id/serial number as it appears in customer's bill. ID
            permanence rules do not apply.
          type: string
          example: '29821234'
        controlledLoad:
          description: >-
            Indicates whether the energy recorded by this register is created
            under a Controlled Load regime. ControlledLoad field will have *No*
            if register does not relate to a Controlled Load.  If the register
            relates to a Controlled Load, it should contain a description of the
            Controlled Load regime. ControlledLoad field will have *No* if
            register does not relate to a Controlled Load, *Yes* if register
            relates to a Controlled Load If absent the status is unknown.
          type: boolean
          example: true
        readStartDate:
          description: >-
            Date when the meter reads start in AEST and assumed to start from
            12:00 am AEST.
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-06-19'
        readEndDate:
          description: >-
            Date when the meter reads end in AEST. If absent then assumed to be
            equal to readStartDate. In this case the entry represents data for a
            single date specified by readStartDate.
          type: string
          format: date
          x-cds-type: DateString
          example: '2022-06-20'
        unitOfMeasure:
          description: >-
            Unit of measure of the meter reads. Refer to Appendix B of <a
            href='https://www.aemo.com.au/-/media/files/stakeholder_consultation/consultations/nem-consultations/2019/5ms-metering-package-2/final-determination/mdff-specification-nem12-nem13-v21-final-determination-clean.pdf?la=en&hash=03FCBA0D60E091DE00F2361AE76206EA'>MDFF
            Specification NEM12 NEM13 v2.1</a> for a list of possible values
          type: string
          x-cds-type: ExternalRef
          example: KWH
        readUType:
          description: Specify the type of the meter read data
          enum:
            - basicRead
            - intervalRead
          type: string
          example: basicRead
        basicRead:
          $ref: '#/components/schemas/EnergyElectricityMeterReadBasicV1'
        intervalRead:
          $ref: '#/components/schemas/EnergyElectricityMeterReadIntervalV1'
      required:
        - readStartDate
        - readUType
        - registerSuffix
        - servicePointId
      type: object
      x-conditional:
        - basicRead
        - intervalRead
    ResponseElectricityUsageV1:
      allOf:
        - $ref: '#/components/schemas/ResponseElectricityUsage'
        - type: object
          properties:
            data:
              properties:
                reads:
                  description: Electricity Service Point Usage records
                  items:
                    $ref: '#/components/schemas/EnergyElectricityMeterReadV1'
                  type: array
              required:
                - reads
              type: object
          required:
            - data
      type: object
    GetElectricityServicePointUsageBulk400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetElectricityServicePointUsageBulk406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    GetElectricityServicePointUsageBulk422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    GetElectricityUsageSpecificServicePoints400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetElectricityUsageSpecificServicePoints406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    GetElectricityUsageSpecificServicePoints422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorEnergyUnavailableServicePointV1'
        - $ref: '#/components/schemas/ErrorEnergyInvalidServicePointV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-energy:Authorisation/UnavailableServicePoint: '#/components/schemas/ErrorEnergyUnavailableServicePointV1'
          urn:au-cds:error:cds-energy:Authorisation/InvalidServicePoint: '#/components/schemas/ErrorEnergyInvalidServicePointV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseElectricityServicePointById:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseElectricityServicePointByIdV1'
          V2: '#/components/schemas/ResponseElectricityServicePointByIdV2'
      required:
        - version
        - links
      type: object
    EnergyElectricityServicePointDistributionLossFactorV1:
      properties:
        code:
          description: >-
            A code used to identify data loss factor for the service point
            values.  Refer to AEMO distribution loss factor documents for each
            financial year to interpret
          type: string
          example: A
        description:
          description: Description of the data loss factor code and value
          type: string
          example: Distribution Loss Factor A
        lossValue:
          description: The value associated with the loss factor code
          type: string
          example: '1.23'
      required:
        - code
        - description
        - lossValue
      type: object
    EnumEnergyParticipantRoleV1:
      description: >
        The role performed by this participant in relation to the service point.


        Note the details of enumeration values below:

        - **FRMP**: Financially Responsible Market Participant

        - **LNSP**: Local Network Service Provider or Embedded Network Manager
        for child connection points

        - **DRSP**: Wholesale Demand Response and/or market ancillary Service
        Provider and note that where it is not relevant for a NMI it will not be
        included
      enum:
        - FRMP
        - LNSP
        - DRSP
      type: string
      example: FRMP
    EnergyElectricityServicePointRelatedParticipantsV1:
      properties:
        party:
          description: The name of the party/organisation related to this service point
          type: string
          example: Origin Energy
        role:
          $ref: '#/components/schemas/EnumEnergyParticipantRoleV1'
      required:
        - party
        - role
      type: object
    EnumElectricityMeterStatusV1:
      description: >-
        A code to denote the status of the meter. 


        Note the details of enumeration values below:

        - **CURRENT**: Applies when a meter is current and not disconnected

        - **DISCONNECTED**: Applies when a meter is present but has been
        remotely disconnected
      enum:
        - CURRENT
        - DISCONNECTED
      type: string
      example: CURRENT
    EnumElectricityMeterInstallationTypeV1:
      description: >-
        The metering Installation type code indicates whether the metering
        installation has to be manually read. Note the details of enumeration
        values below:
          - **BASIC**: Accumulation Meter Type 6
          - **COMMS1**: Interval Meter with communications Type 1
          - **COMMS2**: Interval Meter with communications Type 2
          - **COMMS3**: Interval Meter with communications Type 3
          - **COMMS4**: Interval Meter with communications Type 4
          - **COMMS4C**: CT connected metering installation that meets the minimum services specifications
          - **COMMS4D**: Whole current metering installation that meets the minimum services specifications
          - **MRAM**: Small customer metering installation Type 4A
          - **MRIM**: Manually Read Interval Meter Type 5
          - **UMCP**: Unmetered Supply Type 7
          - **VICAMI**: A relevant metering installation as defined in clause 9.9C of the NER
          - **NCONUML** - Non-contestable unmeter load. Introduced as part of Global Settlement.
      enum:
        - BASIC
        - COMMS1
        - COMMS2
        - COMMS3
        - COMMS4
        - COMMS4C
        - COMMS4D
        - MRAM
        - MRIM
        - PROF
        - SAMPLE
        - UMCP
        - VICAMI
        - NCOLNUML
      type: string
      example: BASIC
    EnergyElectricityServicePointMeterSpecificationV1:
      description: Technical characteristics of the meter
      properties:
        status:
          $ref: '#/components/schemas/EnumElectricityMeterStatusV1'
        installationType:
          $ref: '#/components/schemas/EnumElectricityMeterInstallationTypeV1'
        manufacturer:
          description: Free text field to identify the manufacturer of the installed meter
          type: string
          example: APC
        model:
          description: >-
            Free text field to identify the meter manufacturer's designation for
            the meter model
          type: string
          example: APC Metering Device
        readType:
          description: >-
            Code to denote the method and frequency of Meter Reading.


            The value is formatted as follows:

            - First Character (Read Type):
              - **R**: Remote
              - **M**: Manual
            - Second Character (Mode):
              - **T**: Telephone
              - **W**: Wireless
              - **P**: Powerline
              - **I**: Infra-red
              - **G**: Galvanic
              - **V**: Visual
            - Third Character (Frequency of Scheduled Meter Readings):
              - **1**: Twelve times per year 
              - **2**: Six times per year 
              - **3**: Four times per year 
              - **D**: Daily or Weekly
            - Fourth Character [Optional] (Identify Meter Interval Length
            Capability):
              - **A**: 5 minute
              - **B**: 15 minute
              - **C**: 30 minute
              - **D**: Cannot convert to 5 minute (i.e. due to metering installation de-energised)
              - **M**: Manually Read Accumulation Meter

            Examples:

            - **MV3**: Manual, Visual, Quarterly

            - **MV3M**: Manual, Visual, Quarterly, Manually Read Accumulation
            Meter 

            - **RWDC**: Remote, Wireless, Daily, 30 minutes interval
          type: string
        nextScheduledReadDate:
          description: >-
            This date is the next scheduled meter read date (NSRD) if a manual
            Meter Reading is required
          type: string
          format: date
          x-cds-type: DateString
          example: '2023-01-04'
      required:
        - installationType
        - status
      type: object
    EnumElectricityServicePointRegisterConsumptionTypeV1:
      description: Indicates the consumption type of register
      enum:
        - INTERVAL
        - BASIC
        - PROFILE_DATA
        - ACTIVE_IMPORT
        - ACTIVE
        - REACTIVE_IMPORT
        - REACTIVE
      type: string
      example: INTERVAL
    EnumElectricityServicePointMeterRegisterTimeOfDayV1:
      description: Code to identify the time validity of register contents
      enum:
        - ALLDAY
        - INTERVAL
        - PEAK
        - BUSINESS
        - SHOULDER
        - EVENING
        - OFFPEAK
        - CONTROLLED
        - DEMAND
      type: string
      example: ALLDAY
    EnumElectricityServicePointMeterRegisterConsumptionTypeV1:
      description: >-
        Actual/Subtractive Indicator. Note the details of enumeration values
        below:

        **ACTUAL**: Implies volume of energy actually metered between two dates
        **CUMULATIVE** indicates a meter reading for a specific date. 

        A second Meter Reading is required to determine the consumption between
        those two Meter Reading dates
      enum:
        - ACTUAL
        - CUMULATIVE
      type: string
      example: ACTUAL
    EnergyElectricityServicePointMeterRegistersV1:
      description: Usage data registers available from the meter
      properties:
        registerId:
          description: >-
            Unique identifier of the register within this service point. Is not
            globally unique
          type: string
          example: '0100'
        registerSuffix:
          description: >-
            Register suffix of the meter register where the meter reads are
            obtained
          type: string
          example: A
        averagedDailyLoad:
          description: >-
            The energy delivered through a connection point or metering point
            over an extended period normalised to a 'per day' basis (kWh). This
            value is calculated annually.
          type: number
          example: 23.23
        registerConsumptionType:
          $ref: >-
            #/components/schemas/EnumElectricityServicePointRegisterConsumptionTypeV1
        networkTariffCode:
          description: >-
            The Network Tariff Code is a free text field containing a code
            supplied and published by the local network service provider
          type: string
          example: P
        unitOfMeasure:
          description: The unit of measure for data held in this register
          type: string
          example: KWH
        timeOfDay:
          $ref: >-
            #/components/schemas/EnumElectricityServicePointMeterRegisterTimeOfDayV1
        multiplier:
          description: >-
            Multiplier required to take a register value and turn it into a
            value representing billable energy
          type: number
          example: 1
        controlledLoad:
          description: >-
            Indicates whether the energy recorded by this register is created
            under a Controlled Load regime. ControlledLoad field will have *No*
            if register does not relate to a Controlled Load.  If the register
            relates to a Controlled Load, it should contain a description of the
            Controlled Load regime. ControlledLoad field will have *No* if
            register does not relate to a Controlled Load, *Yes* if register
            relates to a Controlled Load If absent the status is unknown.
          type: boolean
          example: true
        consumptionType:
          $ref: >-
            #/components/schemas/EnumElectricityServicePointMeterRegisterConsumptionTypeV1
      required:
        - registerConsumptionType
        - registerId
      type: object
    EnergyElectricityServicePointMetersV1:
      properties:
        meterId:
          description: >-
            The meter ID uniquely identifies a meter for a given service point. 
            It is unique in the context of the service point.  It is not
            globally unique
          type: string
          example: 4b5e3fc483dc79ca7b831a8ebaa10c4a6abc761d0417ed2fbda5c1cf936d82da
        specifications:
          $ref: >-
            #/components/schemas/EnergyElectricityServicePointMeterSpecificationV1
        registers:
          description: >-
            Usage data registers available from the meter. This may be empty
            where there are no meters physically installed at the service point
          items:
            $ref: '#/components/schemas/EnergyElectricityServicePointMeterRegistersV1'
          type: array
      required:
        - meterId
        - specifications
      type: object
    EnergyElectricityServicePointDetailV1:
      allOf:
        - $ref: '#/components/schemas/EnergyElectricityServicePointV1'
        - properties:
            distributionLossFactor:
              $ref: >-
                #/components/schemas/EnergyElectricityServicePointDistributionLossFactorV1
            relatedParticipants:
              items:
                $ref: >-
                  #/components/schemas/EnergyElectricityServicePointRelatedParticipantsV1
              type: array
            location:
              $ref: '#/components/schemas/CommonPhysicalAddressV1'
            meters:
              description: >-
                The meters associated with the service point. This may be empty
                where there are no meters physically installed at the service
                point
              items:
                $ref: '#/components/schemas/EnergyElectricityServicePointMetersV1'
              type: array
          required:
            - distributionLossFactor
            - location
            - relatedParticipants
          type: object
    ResponseElectricityServicePointByIdV1:
      allOf:
        - $ref: '#/components/schemas/ResponseElectricityServicePointById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/EnergyElectricityServicePointDetailV1'
          required:
            - data
      type: object
    EnergyElectricityServicePointDetailV2:
      allOf:
        - $ref: '#/components/schemas/EnergyElectricityServicePointV2'
        - properties:
            distributionLossFactor:
              $ref: >-
                #/components/schemas/EnergyElectricityServicePointDistributionLossFactorV1
            relatedParticipants:
              items:
                $ref: >-
                  #/components/schemas/EnergyElectricityServicePointRelatedParticipantsV1
              type: array
            location:
              $ref: '#/components/schemas/CommonPhysicalAddressV1'
            meters:
              description: >-
                The meters associated with the service point. This may be empty
                where there are no meters physically installed at the service
                point
              items:
                $ref: '#/components/schemas/EnergyElectricityServicePointMetersV1'
              type: array
          required:
            - distributionLossFactor
            - location
            - relatedParticipants
          type: object
    ResponseElectricityServicePointByIdV2:
      allOf:
        - $ref: '#/components/schemas/ResponseElectricityServicePointById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/EnergyElectricityServicePointDetailV2'
          required:
            - data
      type: object
    GetElectricityServicePointDetail400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetElectricityServicePointDetail404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorEnergyUnavailableServicePointV1'
        - $ref: '#/components/schemas/ErrorEnergyInvalidServicePointV1'
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-energy:Authorisation/UnavailableServicePoint: '#/components/schemas/ErrorEnergyUnavailableServicePointV1'
          urn:au-cds:error:cds-energy:Authorisation/InvalidServicePoint: '#/components/schemas/ErrorEnergyInvalidServicePointV1'
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    GetElectricityServicePointDetail406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseElectricityDERById:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaV1'
        validationErrors:
          description: >-
            List of validation errors in the CDR response from a Data Holder.
            This duplicates BabelValidationError
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseElectricityDERByIdV1'
      required:
        - version
        - links
      type: object
    ResponseElectricityDERByIdV1:
      allOf:
        - $ref: '#/components/schemas/ResponseElectricityDERById'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/EnergyElectricityDERV1'
          required:
            - data
      type: object
    GetElectricityServicePointDER400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetElectricityServicePointDER404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorEnergyUnavailableServicePointV1'
        - $ref: '#/components/schemas/ErrorEnergyInvalidServicePointV1'
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-energy:Authorisation/UnavailableServicePoint: '#/components/schemas/ErrorEnergyUnavailableServicePointV1'
          urn:au-cds:error:cds-energy:Authorisation/InvalidServicePoint: '#/components/schemas/ErrorEnergyInvalidServicePointV1'
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    GetElectricityServicePointDER406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    GetElectricityServicePointUsage400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidV1'
        - $ref: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Field/Invalid: '#/components/schemas/ErrorFieldInvalidV1'
          urn:au-cds:error:cds-all:Field/InvalidPageSize: '#/components/schemas/ErrorFieldInvalidPageSizeV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    GetElectricityServicePointUsage404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorEnergyUnavailableServicePointV1'
        - $ref: '#/components/schemas/ErrorEnergyInvalidServicePointV1'
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-energy:Authorisation/UnavailableServicePoint: '#/components/schemas/ErrorEnergyUnavailableServicePointV1'
          urn:au-cds:error:cds-energy:Authorisation/InvalidServicePoint: '#/components/schemas/ErrorEnergyInvalidServicePointV1'
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    GetElectricityServicePointUsage406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    GetElectricityServicePointUsage422Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldInvalidPageV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/InvalidPage: '#/components/schemas/ErrorFieldInvalidPageV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ResponseAgreementHistory:
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksV1'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseAgreementHistoryV1'
      required:
        - version
        - links
      type: object
    AgreementHistoryV1:
      type: object
      properties:
        agreements:
          description: History of this agreement
          items:
            $ref: '#/components/schemas/AgreementDetailV1'
          type: array
      required:
        - agreements
    ResponseAgreementHistoryV1:
      allOf:
        - $ref: '#/components/schemas/ResponseAgreementHistory'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/AgreementHistoryV1'
          required:
            - data
      type: object
    ResponseAgreementTemplateList:
      type: object
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseAgreementTemplateListV1'
      required:
        - version
        - links
        - meta
    EnumAgreementTemplateDuration:
      description: >-
        Duration formatted according to [ISO 8601
        Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)


        - **P1D**: 1 day

        - **P1M**: 1 month

        - **P3M**: 3 month

        - **P6M**: 6 month

        - **P12M**: 12 month
      enum:
        - P1D
        - P1M
        - P3M
        - P6M
        - P12M
      x-enum-varnames:
        - P1D
        - P1M
        - P3M
        - P6M
        - P12M
      type: string
      example: P1D
    AgreementTemplateV1:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 4f1cc672-88be-4cd8-bbe7-3fb6981b6958
          description: Unique agreement template id
        description:
          type: string
          example: Template for basic data sharing
          description: >-
            Meaningful agreement template description that explains the purpose
            of the template, but not shown to consumers.
        collection_scopes:
          type: array
          items:
            type: string
          example:
            - bank:accounts.basic:read
            - bank:accounts.basic:read
          description: Mandatory scopes you required from a consumer.
        require_all_scopes:
          type: boolean
          example: true
          description: >-
            Describe data scopes - when false indicates at least one scope is
            required. When true all scopes must be consented to.
        collection_durations:
          type: array
          items:
            $ref: '#/components/schemas/EnumAgreementTemplateDuration'
        collection_purpose:
          type: string
          example: To allow for the testing of data holder CDR sharing API's
          description: Describes the purpose behind collection.
        use_durations:
          type: array
          items:
            $ref: '#/components/schemas/EnumAgreementTemplateDuration'
        use_purpose:
          type: string
          example: To allow for the testing of data holder CDR sharing API's
          description: Describes how/for what the data collected will be used.
        direct_marketing_shown:
          default: true
          type: boolean
          example: true
          description: Should the marketing consent be asked for.
        allowed_redirect_uris:
          type: array
          items:
            type: string
          example:
            - http://localhost:1234
            - http://localhost:5678
          description: List of valid software product hosts.
        data_handling_default:
          description: >-
            A default option for how this software product handles redundant
            data.  This still allows for the user to change how they want the
            software product to handle redundant data.
          type: string
          enum:
            - DEIDENTIFY
            - DELETE
          example: DEIDENTIFY
        active:
          type: boolean
          example: true
          description: Represents if a template is active or inactive
        agreementEndCallbackUrl:
          description: >-
            The POST URL webhook that will be called to post data deletion
            request with a jwt payload
          type: string
          default: ''
          example: https://software-product.com.au/data/delete
        data_holder_industry:
          type: array
          items:
            $ref: '#/components/schemas/EnumParticipantCapabilityV1'
          description: >-
            Only include holders that have the specified capability, empty
            implies no filtering, multiple values logical or
      required:
        - description
        - collection_scopes
        - collection_durations
        - collection_purpose
        - use_durations
        - use_purpose
        - allowed_redirect_uris
        - data_handling_default
        - active
        - require_all_scopes
        - agreementEndCallbackUrl
    AgreementTemplateListV1:
      type: object
      properties:
        templates:
          description: List of Agreement Templates
          items:
            $ref: '#/components/schemas/AgreementTemplateV1'
          type: array
      required:
        - templates
    ResponseAgreementTemplateListV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/ResponseAgreementTemplateList'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/AgreementTemplateListV1'
          required:
            - data
    AgreementTemplateCreateRequest:
      type: object
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/AgreementTemplateCreateRequestV1'
      required:
        - version
    AgreementTemplateCreateRequestV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/AgreementTemplateCreateRequest'
        - type: object
          properties:
            description:
              type: string
              example: Template for basic data sharing
              description: >-
                Meaningful agreement template description that explains the
                purpose of the template, but not shown to consumers.
            collection_scopes:
              type: array
              items:
                type: string
              example:
                - bank:accounts.basic:read
                - bank:accounts.basic:read
              description: Mandatory scopes you required from a consumer.
            collection_durations:
              type: array
              items:
                $ref: '#/components/schemas/EnumAgreementTemplateDuration'
            collection_purpose:
              type: string
              example: To allow for the testing of data holder CDR sharing API's
              description: Describes the purpose behind collection.
            use_durations:
              type: array
              items:
                $ref: '#/components/schemas/EnumAgreementTemplateDuration'
            use_purpose:
              type: string
              example: To allow for the testing of data holder CDR sharing API's
              description: Describes how/for what the data collected will be used.
            direct_marketing_shown:
              default: true
              type: boolean
              example: true
              description: Should the marketing consent be asked for.
            allowed_redirect_uris:
              type: array
              items:
                type: string
              example:
                - http://localhost:1234
                - http://localhost:5678
              description: List of valid software product hosts.
            data_handling_default:
              description: >-
                A default option for how this software product handles redundant
                data.  This still allows for the user to change how they want
                the software product to handle redundant data.
              type: string
              enum:
                - DEIDENTIFY
                - DELETE
              example: DEIDENTIFY
            agreementEndCallbackUrl:
              description: >-
                The POST URL webhook that will be called to post data deletion
                request with a jwt payload
              type: string
              default: ''
              example: https://software-product.com.au/data/delete
            data_holder_industry:
              type: array
              items:
                $ref: '#/components/schemas/EnumParticipantCapabilityV1'
          description: >-
            Only include holders that have the specified capability, empty
            implies no filtering, multiple values logical or
          required:
            - description
            - collection_scopes
            - collection_durations
            - collection_purpose
            - use_durations
            - use_purpose
            - allowed_redirect_uris
            - data_handling_default
            - agreementEndCallbackUrl
    ResponseCreditReportList:
      type: object
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseCreditReportListV1'
      required:
        - version
        - links
        - meta
    EnumIllionCreditReportStatusV1:
      description: >-
        The status of the Illion credit report request:

        - **REQUESTED**: Request to generate credit report is successfully
        submitted to OG

        - **SUBMITTED**: Request to generate credit report is successfully
        submitted to Illion

        - **COMPLETED**: Credit report is successfully generated

        - **FAILED**: Request failed to create generate a credit report
      enum:
        - REQUESTED
        - SUBMITTED
        - COMPLETED
        - FAILED
      type: string
      example: COMPLETED
    CreditReportV1:
      type: object
      properties:
        reportId:
          description: Unique report Identifier
          type: string
          example: 77g4b801-97b2-4a07-a92e-f76e0331c959
        status:
          description: Status of the report creation process
          $ref: '#/components/schemas/EnumIllionCreditReportStatusV1'
        resource:
          description: Report resources
          type: object
          properties:
            pdf:
              description: URL reference to a PDF resource
              type: string
              example: https://test1.com/pre-signed-s3-url-credit-report1.pdf
            json:
              description: URL reference to a JSON resource
              type: string
              example: https://test1.com/pre-signed-s3-url-credit-report1.json
            html:
              description: URL reference to a HTML resource
              type: string
              example: https://test1.com/pre-signed-s3-url-credit-report1.html
      required:
        - reportId
        - status
    CreditReportListV1:
      type: object
      properties:
        reports:
          type: array
          items:
            $ref: '#/components/schemas/CreditReportV1'
      required:
        - reports
    ResponseCreditReportListV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/ResponseCreditReportList'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/CreditReportListV1'
          required:
            - data
    RequestCreateIllionCreditReport:
      type: object
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/RequestCreateIllionCreditReportV1'
      required:
        - version
    CreateIllionCreditReportV1:
      type: object
      properties:
        agreementIds:
          description: List of agreement ids for a given principal
          type: array
          example:
            - 77g4b801-97b2-4a07-a92e-f76e0331c959
            - 56g4b801-97b2-4a07-a92e-f76e0331c952
          items:
            type: string
            example: 77g4b801-97b2-4a07-a92e-f76e0331c959
      required:
        - agreementIds
    RequestCreateIllionCreditReportV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/RequestCreateIllionCreditReport'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/CreateIllionCreditReportV1'
          required:
            - data
    ResponseCreateCreditReport:
      type: object
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseCreateCreditReportV1'
      required:
        - version
        - links
        - meta
    CreateCreditReportV1:
      type: object
      properties:
        reportId:
          description: Unique id of the report created
          type: string
          example: 99e4b801-97b2-4a07-a92e-f76e0331c959
      required:
        - reportId
    ResponseCreateCreditReportV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/ResponseCreateCreditReport'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/CreateCreditReportV1'
          required:
            - data
    ResponseGetCreditReport:
      type: object
      properties:
        version:
          type: string
          example: V1
          description: Payload Version
        links:
          $ref: '#/components/schemas/LinksPaginatedV1'
        meta:
          $ref: '#/components/schemas/MetaPaginatedV1'
      discriminator:
        propertyName: version
        mapping:
          V1: '#/components/schemas/ResponseGetCreditReportV1'
      required:
        - version
        - links
        - meta
    ResponseGetCreditReportV1:
      type: object
      allOf:
        - $ref: '#/components/schemas/ResponseGetCreditReport'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/CreditReportV1'
          required:
            - data
  responses:
    ListDirectories:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseDirectoryList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    Generic400:
      description: >-
        Request has malformed, missing or non-compliant JSON body or URL
        parameters.
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/Generic400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    Generic401:
      description: >-
        The client request has not been completed because it lacks valid
        authentication credentials for the requested resource
      headers:
        WWW-Authenticate:
          description: The Response Header Field as per **[[RFC6750]](#nref-RFC6750)**
          explode: false
          schema:
            pattern: ^Bearer .*
            type: string
          style: simple
    ListParticipants:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseParticipantList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListParticipants404:
      description: Resource Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListParticipants404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    Generic500:
      description: Internal Server Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ErrorGeneralUnexpectedV1'
                type: array
            required:
              - errors
            type: object
    Generic503:
      description: Service Unavailable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ErrorServiceUnavailableV1'
                type: array
            required:
              - errors
            type: object
    ActionCDRSharingPrime:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseActionCDRSharingPrime'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    Generic406:
      description: >-
        The request contained an Accept header other than permitted media types,
        a character set other than UTF-8 or a version that was not supported.
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/Generic406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    Generic422:
      description: >-
        The request was well formed but was unable to be processed due to
        business logic specific to the request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/Generic422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergySwitchStatus:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseGetEnergySwitchStatus'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    Generic403:
      description: Forbidden
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/Generic403Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergySwitchStatus404:
      description: Resource Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergySwitchStatus404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyAccountSwitch:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnergyAccountSwitchList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergySwitchRequest:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseGetEnergySwitchRequest'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/HeaderXFapiInteractionId'
    ActionCDRRegistration:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseCDRRegistration'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    DCRRegister400:
      description: Error Encountered
      content:
        application/json:
          schema:
            x-cds-allowMissingDiscriminator: true
            oneOf:
              - $ref: '#/components/schemas/ResponseRegistrationErrorV1'
    ListBankingProducts:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseBankingProductList'
    ListProducts400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListProducts400Item'
                type: array
            required:
              - errors
            type: object
    ListProducts406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListProducts406Item'
                type: array
            required:
              - errors
            type: object
    ListProducts422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListProducts422Item'
                type: array
            required:
              - errors
            type: object
    GetBankingProductDetail:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseBankingProductById'
    GetProductDetail400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetProductDetail400Item'
                type: array
            required:
              - errors
            type: object
    GetProductDetail404:
      description: Resource Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetProductDetail404Item'
                type: array
            required:
              - errors
            type: object
    GetProductDetail406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetProductDetail406Item'
                type: array
            required:
              - errors
            type: object
    GetCommonOutages:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseDiscoveryOutagesList'
    GetOutages400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetOutages400Item'
                type: array
            required:
              - errors
            type: object
    GetOutages406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetOutages406Item'
                type: array
            required:
              - errors
            type: object
    GetCommonStatus:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseCommonDiscoveryStatus'
    GetStatus400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetStatus400Item'
                type: array
            required:
              - errors
            type: object
    GetStatus406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetStatus406Item'
                type: array
            required:
              - errors
            type: object
    OGInitiateEnergySwitch:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OGResponseInitiateEnergySwitch'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/HeaderXFapiInteractionId'
    InitiateEnergySwitch400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/InitiateEnergySwitch400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    InitiateEnergySwitch404:
      description: Resource Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/InitiateEnergySwitch404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    InitiateEnergySwitch406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/InitiateEnergySwitch406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    InitiateEnergySwitch422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/InitiateEnergySwitch422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetSharingRequest404:
      description: Resource Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetSharingRequest404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListPrincipals:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponsePrincipalList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetPrincipalDetail:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponsePrincipalDetail'
    GetPrincipalDetail404:
      description: Resource Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetPrincipalDetail404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListPrincipalUsers:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseUserList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListPrincipalUsers404:
      description: Resource Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListPrincipalUsers404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListAgreements:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseAgreementList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetAgreementDetail:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseAgreementDetail'
    ListBankingAccounts:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseBankingAccountList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBankingAccounts400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListBankingAccounts400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBankingAccounts406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListBankingAccounts406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBankingAccounts422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListBankingAccounts422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetBankingAccountDetail:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseBankingAccountById'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetAccountDetail400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetAccountDetail400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetAccountDetail404:
      description: Resource Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetAccountDetail404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetAccountDetail406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetAccountDetail406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetBankingBalance:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseBankingAccountsBalanceById'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetBalance400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetBalance400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetBalance404:
      description: Resource Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetBalance404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetBalance406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetBalance406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBankingScheduledPayments:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseBankingScheduledPaymentsList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListScheduledPayments400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListScheduledPayments400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListScheduledPayments404:
      description: Resource Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListScheduledPayments404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListScheduledPayments406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListScheduledPayments406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListScheduledPayments422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListScheduledPayments422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBankingDirectDebits:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseBankingDirectDebitAuthorisationList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListDirectDebits400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListDirectDebits400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListDirectDebits404:
      description: Resource Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListDirectDebits404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListDirectDebits406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListDirectDebits406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListDirectDebits422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListDirectDebits422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBankingTransactions:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseBankingTransactionList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetTransactions400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetTransactions400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetTransactions404:
      description: Resource Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetTransactions404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetTransactions406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetTransactions406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetTransactions422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetTransactions422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetBankingTransactionDetail:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseBankingTransactionById'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetTransactionDetail400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetTransactionDetail400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetTransactionDetail404:
      description: Resource Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetTransactionDetail404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetTransactionDetail406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetTransactionDetail406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBankingPayees:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseBankingPayeeList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListPayees400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListPayees400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListPayees406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListPayees406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListPayees422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListPayees422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetBankingPayeeDetail:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseBankingPayeeById'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetPayeeDetail400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetPayeeDetail400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetPayeeDetail404:
      description: Resource Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetPayeeDetail404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetPayeeDetail406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetPayeeDetail406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBankingScheduledPaymentsBulk:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseBankingScheduledPaymentsList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListScheduledPaymentsBulk400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListScheduledPaymentsBulk400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListScheduledPaymentsBulk406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListScheduledPaymentsBulk406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListScheduledPaymentsBulk422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListScheduledPaymentsBulk422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBankingScheduledPaymentsSpecificAccounts:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseBankingScheduledPaymentsList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListScheduledPaymentsSpecificAccounts400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/ListScheduledPaymentsSpecificAccounts400Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListScheduledPaymentsSpecificAccounts406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/ListScheduledPaymentsSpecificAccounts406Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListScheduledPaymentsSpecificAccounts422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/ListScheduledPaymentsSpecificAccounts422Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBankingDirectDebitsBulk:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseBankingDirectDebitAuthorisationList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListDirectDebitsBulk400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListDirectDebitsBulk400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListDirectDebitsBulk406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListDirectDebitsBulk406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListDirectDebitsBulk422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListDirectDebitsBulk422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBankingDirectDebitsSpecificAccounts:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseBankingDirectDebitAuthorisationList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListDirectDebitsSpecificAccounts400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListDirectDebitsSpecificAccounts400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListDirectDebitsSpecificAccounts406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListDirectDebitsSpecificAccounts406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListDirectDebitsSpecificAccounts422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListDirectDebitsSpecificAccounts422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBankingBalancesBulk:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseBankingAccountsBalanceList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBalancesBulk400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListBalancesBulk400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBalancesBulk406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListBalancesBulk406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBalancesBulk422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListBalancesBulk422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBankingBalancesSpecificAccounts:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseBankingAccountsBalanceList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBalancesSpecificBankingAccounts400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/ListBalancesSpecificBankingAccounts400Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBalancesSpecificBankingAccounts406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/ListBalancesSpecificBankingAccounts406Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBalancesSpecificBankingAccounts422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/ListBalancesSpecificBankingAccounts422Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetCommonCustomer:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseCommonCustomer'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetCustomer400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetCustomer400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetCustomer406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetCustomer406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetCommonCustomerDetail:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseCommonCustomerDetail'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetCustomerDetail400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetCustomerDetail400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetCustomerDetail406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetCustomerDetail406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyAccounts:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnergyAccountsList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyAccounts400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListEnergyAccounts400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyAccounts406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListEnergyAccounts406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyAccounts422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListEnergyAccounts422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountDetail:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnergyAccountById'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountDetail400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountDetail400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountDetail404:
      description: Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountDetail404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountDetail406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountDetail406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountPaymentSchedule:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnergyAccountPaymentScheduleList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountPaymentSchedule400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountPaymentSchedule400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountPaymentSchedule404:
      description: Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountPaymentSchedule404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountPaymentSchedule406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountPaymentSchedule406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountConcessions:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnergyAccountConcessionList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountConcessions400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountConcessions400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountConcessions404:
      description: Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountConcessions404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountConcessions406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountConcessions406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountBalance:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnergyAccountBalanceById'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountBalance400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountBalance400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountBalance404:
      description: Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountBalance404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountBalance406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountBalance406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountBilling:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnergyAccountBillingList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountBilling400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountBilling400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountBilling404:
      description: Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountBilling404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountBilling406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountBilling406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountBilling422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountBilling422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyAccountInvoices:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnergyAccountInvoiceList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyAccountInvoices400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListEnergyAccountInvoices400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyAccountInvoices404:
      description: Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListEnergyAccountInvoices404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyAccountInvoices406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListEnergyAccountInvoices406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyAccountInvoices422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListEnergyAccountInvoices422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyInvoices:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnergyAccountInvoiceList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyInvoices400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListEnergyInvoices400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyInvoices406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListEnergyInvoices406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyInvoices422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListEnergyInvoices422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyInvoicesSpecificAccounts:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnergyAccountInvoiceList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyInvoicesSpecificAccounts400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/ListEnergyInvoicesSpecificAccounts400Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyInvoicesSpecificAccounts406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/ListEnergyInvoicesSpecificAccounts406Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyInvoicesSpecificAccounts422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/ListEnergyInvoicesSpecificAccounts422Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountBillingBulk:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnergyAccountBillingList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountBillingBulk400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountBillingBulk400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountBillingBulk406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountBillingBulk406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetEnergyAccountBillingBulk422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetEnergyAccountBillingBulk422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyBillingSpecificAccounts:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnergyAccountBillingList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyBillingSpecificAccounts400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/ListEnergyBillingSpecificAccounts400Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyBillingSpecificAccounts406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/ListEnergyBillingSpecificAccounts406Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyBillingSpecificAccounts422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/ListEnergyBillingSpecificAccounts422Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyAccountBalances:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnergyAccountBalanceList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyAccountBalances400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListEnergyAccountBalances400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyAccountBalances406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListEnergyAccountBalances406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyAccountBalances422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListEnergyAccountBalances422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListEnergyBalancesSpecificAccounts:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnergyAccountBalanceList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBalancesSpecificEnergyAccounts400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/ListBalancesSpecificEnergyAccounts400Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBalancesSpecificEnergyAccounts406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/ListBalancesSpecificEnergyAccounts406Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListBalancesSpecificEnergyAccounts422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/ListBalancesSpecificEnergyAccounts422Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListElectricityServicePoints:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseElectricityServicePointsList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListElectricityServicePoints400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListElectricityServicePoints400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListElectricityServicePoints406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListElectricityServicePoints406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    ListElectricityServicePoints422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ListElectricityServicePoints422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointDERBulk:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseElectricityDERList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointDERBulk400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/GetElectricityServicePointDERBulk400Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointDERBulk406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/GetElectricityServicePointDERBulk406Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointDERBulk422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/GetElectricityServicePointDERBulk422Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityDERSpecificServicePoints:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseElectricityDERList'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityDERSpecificServicePoints400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/GetElectricityDERSpecificServicePoints400Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityDERSpecificServicePoints406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/GetElectricityDERSpecificServicePoints406Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityDERSpecificServicePoints422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/GetElectricityDERSpecificServicePoints422Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointUsageBulk:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseElectricityUsage'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointUsageBulk400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/GetElectricityServicePointUsageBulk400Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointUsageBulk406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/GetElectricityServicePointUsageBulk406Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointUsageBulk422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/GetElectricityServicePointUsageBulk422Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityUsageSpecificServicePoints:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseElectricityUsage'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityUsageSpecificServicePoints400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/GetElectricityUsageSpecificServicePoints400Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityUsageSpecificServicePoints406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/GetElectricityUsageSpecificServicePoints406Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityUsageSpecificServicePoints422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: >-
                    #/components/schemas/GetElectricityUsageSpecificServicePoints422Item
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointDetail:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseElectricityServicePointById'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointDetail400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetElectricityServicePointDetail400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointDetail404:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetElectricityServicePointDetail404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointDetail406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetElectricityServicePointDetail406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointDER:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseElectricityDERById'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointDER400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetElectricityServicePointDER400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointDER404:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetElectricityServicePointDER404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointDER406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetElectricityServicePointDER406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointUsage:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseElectricityUsage'
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointUsage400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetElectricityServicePointUsage400Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointUsage404:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetElectricityServicePointUsage404Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointUsage406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetElectricityServicePointUsage406Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetElectricityServicePointUsage422:
      description: Unprocessable Entity Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetElectricityServicePointUsage422Item'
                type: array
            required:
              - errors
            type: object
      headers:
        x-fapi-interaction-id:
          $ref: '#/components/headers/XFAPIInteractionId'
    GetAgreementHistory:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseAgreementHistory'
  requestBodies:
    RequestActionCDRSharingPrime:
      description: Request payload for a priming a CDR Sharing agreement
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestActionCDRSharingPrime'
    RequestActionCDRRegistration:
      description: Request payload for a Dynamic Client Registration
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestActionCDRRegistration'
    RequestInitiateEnergySwitch:
      description: Initiate Energy Account Switch
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestInitiateEnergySwitch'
          encoding:
            payload:
              contentType: application/json
      required: true
    RequestAccountIds:
      description: Request payload containing list of specific Accounts to obtain data for
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestAccountIdsV1'
      required: true
    RequestServicePointIds:
      description: >-
        Request payload containing list of specific Service Points to obtain
        data for
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestServicePointIdsV1'
      required: true
    RequestAgreementTemplate:
      description: Request payload for creating a new agreement template
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AgreementTemplateCreateRequest'
    RequestCreateIllionCreditReport:
      description: Request payload for Create Credit report
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestCreateIllionCreditReport'
