Functional Requirements: HaaS (Energy) #
Last Updated: September 04, 2023
Definitions and Interpretations
The following definitions apply:
- Data Standards
- refers to the Data Standards website hosted at https://consumerdatastandardsaustralia.github.io/standards
Identity Services #
Provide the following functional requirements related to identity services:
| Functional Requirement | Category | Requirement |
|---|---|---|
| I1 | Identity | Comply with the CDR Standards Information Security Profile |
| I2 | Identity | Comply with the Financial-grade API specification |
| I3 | Identity | Incorporate an arrangement establishment interface (“consent flow”) |
| I4 | Identity | Store and maintain the arrangementIncorporate consent revocation interfaces |
| I5 | Identity | Manage and maintain OAuth2 Tokens in accordance with the Data Standards |
| I6 | Identity | Make available the Dynamic Client Registration interface, as prescribed by the CDR Standards, for Data Recipients to establish a registration |
| I7 | Identity | Manage and maintain CDR Metadata including the synchronisation of Data Recipient statuses from the CDR Register |
| I8 | Identity | Delivery of Admin API functionality, as per the Data Standards, currently Metadata Update and Get Metrics |
| I9 | Identity | Deliver and maintain usage statistics for the purpose of reporting metrics via the prescribed interfaces |
Management API #
If requested by the Client, provide a Management API, accessible in accordance with Biza Guides delivering the following functional requirements:
| Functional Requirement | Category | Requirement |
|---|---|---|
| M1 | Management API | Provide API providing support for Arrangement View |
| M2 | Management API | Provide API providing support for Arrangement Cancel |
| M3 | Management API | Provide API to allow for Disclosure Option Management functional |
| M4 | Management API | Other functionality as introduced into the CDR Obligations from time- to-time |
Consent Management Dashboard #
If requested by the Client, provide a Consent Management Dashboard that is:
| Functional Requirement | Category | Requirement |
|---|---|---|
| D1 | Consent Dashboard | Aligned with the prescribed CX Guidelines |
| D2 | Consent Dashboard | Branded in accordance with the Theming guidelines of Biza Guides |
| D3 | Consent Dashboard | Incorporates functionality required by the Data Standards |
| D4 | Consent Dashboard | Authenticated using the first two screens of the consent flow or Magic Link authentication |
Administration Interfaces #
Administration interface capability which provides:
| Functional Requirement | Category | Requirement |
|---|---|---|
| Z2 | Administration Interfaces | A web based interface for overall system monitoring and management |
| Z3 | Administration Interfaces | Single sign-on support for Client personnel access in alignment with the technical specifications outlined on Biza Guides |
Unauthenticated API #
Provide the following API interfaces, as documented by the Data Standards
| Functional Requirement | Category | Requirement |
|---|---|---|
| U1 | CDR API | Get Status API |
| U2 | CDR API | Get Outages API |
Authenticated API #
Provide the following API interfaces, as documented by the Data Standards, restricted to the Consumer Arrangement authorisation, using data provided by the Customer Data Source.
| Functional Requirement | Category | Requirement |
|---|---|---|
| C1 | CDR API | Get Customer API |
| C2 | CDR API | Get Customer Detail API |
| E1 | CDR API | Get Service Points |
| E2 | CDR API | Get Service Point Detail |
| E3 | CDR API | Get Usage for Service Points |
| E4 | CDR API | Get Bulk Usage |
| E5 | CDR API | Get Usage for Specific Service Points |
| E6 | CDR API | Get DER for Service Points |
| E7 | CDR API | Get Energy Accounts |
| E8 | CDR API | Get Energy Account Detail |
| E9 | CDR API | Get Agreed Payment Schedules |
| E10 | CDR API | Get Concessions |
| E11 | CDR API | Get Balance for Energy Accounts |
| E12 | CDR API | Get Bulk Balances for Energy |
| E13 | CDR API | Get Balances for Specific Energy Accounts |
| E14 | CDR API | Get Invoices for Energy |
| E15 | CDR API | Get Bulk Invoices |
| E16 | CDR API | Get Invoices for Specific Accounts |
| E17 | CDR API | Get Billing for Energy |
| E18 | CDR API | Get Bulk Billing |
| E19 | CDR API | Get Billing for Specific Accounts |
AEMO Passthrough #
If requested by the Client, provide passthrough data transfer support to AEMO MarketNet for the following endpoints:
| Functional Requirement | Category | Requirement |
|---|---|---|
| P1 | CDR API | Get Service Points |
| P2 | CDR API | Get Service Point Detail |
| P3 | CDR API | Get Usage for Service Points |
| P4 | CDR API | Get Bulk Usage |
| P5 | CDR API | Get Usage for Specific Service Points |
| P6 | CDR API | Get DER for Service Points |