diff --git a/docs/includes/archives b/docs/includes/archives
index 86f0c815..aae09c2e 100644
--- a/docs/includes/archives
+++ b/docs/includes/archives
@@ -9,6 +9,11 @@
+24/04/2023
+1.23.0
+Changes arising from Decision Proposal 298
+
+
22/03/2023
1.22.1
Changes arising from Change Request 576 (Maintenance iteration 14)
diff --git a/docs/includes/cds_admin b/docs/includes/cds_admin
index d4b76784..ca2da9d6 100644
--- a/docs/includes/cds_admin
+++ b/docs/includes/cds_admin
@@ -226,7 +226,7 @@ This operation may only be called by the CDR Register
query
string
optional
-The period of metrics to be requested. Values can be CURRENT (meaning metrics for current day), HISTORIC (meaning metrics for previous days or months) or ALL. If absent the default is ALL.
+The period of metrics to be requested. Values can be CURRENT (meaning metrics for current period, dependent on the metric type), HISTORIC (meaning metrics for previous period, depending on the metric type) or ALL. If absent the default is ALL.
x-v
@@ -1551,7 +1551,7 @@ This operation may only be called by the CDR Register
unauthenticated
object
mandatory
-Rejection counts for all uauthenticated end points
+Rejection counts for all unauthenticated end points
» currentDay
@@ -1618,7 +1618,7 @@ This operation may only be called by the CDR Register
rejections
object
mandatory
-Number of calls resulting in a rejection due to server execution over time
+Number of calls rejected due to traffic thresholds over time
» currentDay
diff --git a/docs/includes/cds_banking b/docs/includes/cds_banking
index 93c25ba9..33250f5a 100644
--- a/docs/includes/cds_banking
+++ b/docs/includes/cds_banking
@@ -1626,7 +1626,7 @@ To perform this operation, you must be authenticated and authorised with the fol
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 accross the subsidiary transactions as possible, is required to be shared
+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
Endpoint Version
@@ -8295,7 +8295,7 @@ This operation does not require authentication
» lendingRates
[BankingProductLendingRateV2 ]
optional
-Fully described deposit rates for this account based on the equivalent structure in Product Reference
+Fully described lending rates for this account based on the equivalent structure in Product Reference
» features
@@ -8857,7 +8857,7 @@ This operation does not require authentication
crn
string
conditional
-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 are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
+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.
apcaNumber
@@ -9964,7 +9964,7 @@ This operation does not require authentication
crn
string
conditional
-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 are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
+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.
billerName
diff --git a/docs/includes/cds_common b/docs/includes/cds_common
index c4900769..5e2b7388 100644
--- a/docs/includes/cds_common
+++ b/docs/includes/cds_common
@@ -99,7 +99,7 @@
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-R-Draft] . Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address
@@ -327,7 +327,7 @@ To perform this operation, you must be authenticated and authorised with the fol
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-R-Draft] . Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address
diff --git a/docs/includes/cds_dcr b/docs/includes/cds_dcr
index 4dc4e9d1..d5269973 100644
--- a/docs/includes/cds_dcr
+++ b/docs/includes/cds_dcr
@@ -28,7 +28,9 @@
POST /register
-Register a client using a CDR Register issued Software Statement Assertion.
+Register a client using a CDR Register issued Software Statement Assertion.
+
+This endpoint does not require CORS.
Body parameter
diff --git a/docs/includes/cds_energy b/docs/includes/cds_energy
index bdc4fe47..9ccdf187 100644
--- a/docs/includes/cds_energy
+++ b/docs/includes/cds_energy
@@ -281,27 +281,6 @@ x-min-v: string
The version of the API end point that the data holder has responded with.
-
-400
-x-fapi-interaction-id
-string
-
-An [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] UUID value is required to be provided in the response header to track the interaction.
-
-
-406
-x-fapi-interaction-id
-string
-
-An [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] UUID value is required to be provided in the response header to track the interaction.
-
-
-422
-x-fapi-interaction-id
-string
-
-An [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] UUID value is required to be provided in the response header to track the interaction.
-
@@ -339,7 +318,9 @@ x-min-v: string
GET /energy/plans/{planId}
-Obtain detailed information on a single energy plan offered openly to the market
+Obtain detailed information on a single energy plan offered openly to the market.
+
+Other Versions: v1
Endpoint Version
@@ -349,7 +330,7 @@ x-min-v: string
Version
-1
+2
@@ -558,15 +539,29 @@ x-min-v: string
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [
@@ -779,15 +774,29 @@ x-min-v: string
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [
@@ -896,7 +905,7 @@ x-min-v: string
200
OK
Successful response
-EnergyPlanResponse
+EnergyPlanResponseV2
400
@@ -934,27 +943,6 @@ x-min-v: string
The version of the API end point that the data holder has responded with.
-
-400
-x-fapi-interaction-id
-string
-
-An [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] UUID value is required to be provided in the response header to track the interaction.
-
-
-404
-x-fapi-interaction-id
-string
-
-An [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] UUID value is required to be provided in the response header to track the interaction.
-
-
-406
-x-fapi-interaction-id
-string
-
-An [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] UUID value is required to be provided in the response header to track the interaction.
-
@@ -3673,7 +3661,7 @@ x-cds-client-headers: string
Obtain detailed information for a specific energy account
-Other Versions: v1
+Other Versions: v1 v2
Endpoint Version
@@ -3683,7 +3671,7 @@ x-cds-client-headers: string
Version
-2
+3
@@ -3889,15 +3877,21 @@ x-cds-client-headers: string
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {}
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {}
+ ],
"timeVariations" : [
{}
]
@@ -4054,15 +4048,21 @@ x-cds-client-headers: string
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {}
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {}
+ ],
"timeVariations" : [
{}
]
@@ -4149,7 +4149,7 @@ x-cds-client-headers: string
200
OK
Successful response
-EnergyAccountDetailResponseV2
+EnergyAccountDetailResponseV3
400
@@ -7543,9 +7543,9 @@ To perform this operation, you must be authenticated and authorised with the fol
-EnergyPlanResponse
+EnergyPlanResponseV2
-
+
{
"data" : {
"planId" : "string" ,
@@ -7712,15 +7712,29 @@ To perform this operation, you must be authenticated and authorised with the fol
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [
@@ -7933,15 +7947,29 @@ To perform this operation, you must be authenticated and authorised with the fol
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [
@@ -8047,7 +8075,7 @@ To perform this operation, you must be authenticated and authorised with the fol
data
-EnergyPlanDetail
+EnergyPlanDetailV2
mandatory
none
@@ -8621,9 +8649,9 @@ To perform this operation, you must be authenticated and authorised with the fol
-EnergyAccountDetailResponseV2
+EnergyAccountDetailResponseV3
-
+
{
"data" : {
"accountId" : "string" ,
@@ -8759,15 +8787,21 @@ To perform this operation, you must be authenticated and authorised with the fol
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {}
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {}
+ ],
"timeVariations" : [
{}
]
@@ -8924,15 +8958,21 @@ To perform this operation, you must be authenticated and authorised with the fol
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {}
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {}
+ ],
"timeVariations" : [
{}
]
@@ -9016,7 +9056,7 @@ To perform this operation, you must be authenticated and authorised with the fol
data
-EnergyAccountDetailV2
+EnergyAccountDetailV3
mandatory
none
@@ -9770,13 +9810,13 @@ To perform this operation, you must be authenticated and authorised with the fol
» excludedPostcodes
[string]
optional
-Array of valid Australian post codes that are specifically excluded from the plan. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999)
+Array of valid Australian postcodes that are specifically excluded from the plan. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999)
» includedPostcodes
[string]
optional
-Array of valid Australian post codes that are included from the plan. If absent defaults to all non-excluded post codes. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999)
+Array of valid Australian postcodes that are included from the plan. If absent defaults to all non-excluded postcodes. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999)
» distributors
@@ -9826,9 +9866,9 @@ To perform this operation, you must be authenticated and authorised with the fol
-EnergyPlanDetail
+EnergyPlanDetailV2
-
+
{
"planId" : "string" ,
"effectiveFrom" : "string" ,
@@ -9994,15 +10034,29 @@ To perform this operation, you must be authenticated and authorised with the fol
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [
@@ -10215,15 +10269,29 @@ To perform this operation, you must be authenticated and authorised with the fol
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [
@@ -10386,21 +10454,21 @@ To perform this operation, you must be authenticated and authorised with the fol
» gasContract
-EnergyPlanContractFull
+EnergyPlanContractFullV2
conditional
The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to GAS or DUAL
» electricityContract
-EnergyPlanContractFull
+EnergyPlanContractFullV2
conditional
The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to ELECTRICITY or DUAL
-EnergyPlanContract
+EnergyPlanContractV2
-
+
{
"additionalFeeInformation" : "string" ,
"pricingModel" : "SINGLE_RATE" ,
@@ -10526,15 +10594,29 @@ To perform this operation, you must be authenticated and authorised with the fol
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [
@@ -10714,7 +10796,7 @@ To perform this operation, you must be authenticated and authorised with the fol
solarFeedInTariff
-EnergyPlanSolarFeedInTariff
+EnergyPlanSolarFeedInTariffV2
optional
Array of feed in tariffs for solar power
@@ -10790,9 +10872,9 @@ To perform this operation, you must be authenticated and authorised with the fol
-EnergyPlanContractFull
+EnergyPlanContractFullV2
-
+
{
"additionalFeeInformation" : "string" ,
"pricingModel" : "SINGLE_RATE" ,
@@ -10918,15 +11000,29 @@ To perform this operation, you must be authenticated and authorised with the fol
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [
@@ -11028,7 +11124,7 @@ To perform this operation, you must be authenticated and authorised with the fol
anonymous
-EnergyPlanContract
+EnergyPlanContractV2
mandatory
none
@@ -12162,22 +12258,36 @@ To perform this operation, you must be authenticated and authorised with the fol
-EnergyPlanSolarFeedInTariff
+EnergyPlanSolarFeedInTariffV2
-
+
[
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [
@@ -12215,6 +12325,18 @@ To perform this operation, you must be authenticated and authorised with the fol
A description of the tariff
+startDate
+DateString
+optional
+The start date of the application of the feed in tariff
+
+
+endDate
+DateString
+optional
+The end date of the application of the feed in tariff
+
+
scheme
string
mandatory
@@ -12239,49 +12361,85 @@ To perform this operation, you must be authenticated and authorised with the fol
Represents a constant tariff. Mandatory if tariffUType is set to singleTariff
-» amount
+» rates
+[object]
+mandatory
+Array of feed in rates
+
+
+»» unitPrice
AmountString
mandatory
-The tariff amount
+Unit price of usage per measure unit (exclusive of GST)
-timeVaryingTariffs
+»» measureUnit
+string
+optional
+The measurement unit of rate. Assumed to be KWH if absent
+
+
+»» volume
+number
+optional
+Volume that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period
+
+
+» timeVaryingTariffs
object
conditional
Represents a tariff based on time. Mandatory if tariffUType is set to timeVaryingTariffs
-» type
+»» type
string
optional
The type of the charging time period. If absent applies to all periods
-» amount
+»» rates
+[object]
+optional
+Array of feed in rates
+
+
+»»» unitPrice
AmountString
mandatory
-The tariff amount
+Unit price of usage per measure unit (exclusive of GST)
-» timeVariations
+»»» measureUnit
+string
+optional
+The measurement unit of rate. Assumed to be KWH if absent
+
+
+»»» volume
+number
+optional
+Volume that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period
+
+
+»» timeVariations
[object]
mandatory
Array of time periods for which this tariff is applicable
-»» days
+»»» days
[string]
mandatory
The days that the tariff applies to. At least one entry required
-»» startTime
+»»» startTime
TimeString
optional
The beginning of the time period per day for which the tariff applies. If absent assumes start of day (ie. midnight)
-»» endTime
+»»» endTime
TimeString
optional
The end of the time period per day for which the tariff applies. If absent assumes end of day (ie. one second before midnight)
@@ -12319,6 +12477,38 @@ To perform this operation, you must be authenticated and authorised with the fol
timeVaryingTariffs
+measureUnit
+KWH
+
+
+measureUnit
+KVA
+
+
+measureUnit
+KVAR
+
+
+measureUnit
+KVARH
+
+
+measureUnit
+KW
+
+
+measureUnit
+DAYS
+
+
+measureUnit
+METER
+
+
+measureUnit
+MONTH
+
+
type
PEAK
@@ -12331,6 +12521,38 @@ To perform this operation, you must be authenticated and authorised with the fol
SHOULDER
+measureUnit
+KWH
+
+
+measureUnit
+KVA
+
+
+measureUnit
+KVAR
+
+
+measureUnit
+KVARH
+
+
+measureUnit
+KW
+
+
+measureUnit
+DAYS
+
+
+measureUnit
+METER
+
+
+measureUnit
+MONTH
+
+
days
SUN
@@ -14511,9 +14733,9 @@ To perform this operation, you must be authenticated and authorised with the fol
-EnergyAccountDetailV2
+EnergyAccountDetailV3
-
+
{
"accountId" : "string" ,
"accountNumber" : "string" ,
@@ -14656,15 +14878,29 @@ To perform this operation, you must be authenticated and authorised with the fol
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [],
@@ -14843,15 +15079,29 @@ To perform this operation, you must be authenticated and authorised with the fol
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [],
@@ -15066,13 +15316,13 @@ To perform this operation, you must be authenticated and authorised with the fol
»»» gasContract
-EnergyPlanContract
+EnergyPlanContractV2
conditional
The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to GAS or DUAL
»»» electricityContract
-EnergyPlanContract
+EnergyPlanContractV2
conditional
The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to ELECTRICITY or DUAL
@@ -15178,7 +15428,7 @@ To perform this operation, you must be authenticated and authorised with the fol
amount
AmountString
optional
-Optional payment amount indicating that a constant payment amount is scheduled to be paid (used in bill smooting scenarios)
+Optional payment amount indicating that a constant payment amount is scheduled to be paid (used in bill smoothing scenarios)
paymentScheduleUType
diff --git a/docs/includes/cds_register b/docs/includes/cds_register
index 5f5e50a1..c82b868a 100644
--- a/docs/includes/cds_register
+++ b/docs/includes/cds_register
@@ -27,6 +27,8 @@ Accept: application/json
GET /.well-known/openid-configuration
Endpoint used by participants to discover the CDR Register OpenID configuration and obtain information needed to interact with it, including its OAuth 2.0 endpoint locations.
+
+This endpoint does not require CORS.
Endpoint Version
@@ -129,6 +131,8 @@ Accept: application/json
GET /jwks
JWKS endpoint containing the public keys used by the CDR Register to validate the signature of issued SSAs and authenticate outbound calls to participants in the CDR.
+
+This endpoint does not require CORS.
Endpoint Version
diff --git a/docs/includes/cds_telco b/docs/includes/cds_telco
index 4fd0b894..dc70d17c 100644
--- a/docs/includes/cds_telco
+++ b/docs/includes/cds_telco
@@ -7323,7 +7323,7 @@ To perform this operation, you must be authenticated and authorised with the fol
amount
AmountString
optional
-Optional payment amount indicating that a constant payment amount is scheduled to be paid (used in bill smooting scenarios)
+Optional payment amount indicating that a constant payment amount is scheduled to be paid (used in bill smoothing scenarios)
paymentScheduleUType
diff --git a/docs/includes/changelog b/docs/includes/changelog
index 6e91782f..fc7f882a 100644
--- a/docs/includes/changelog
+++ b/docs/includes/changelog
@@ -10,6 +10,12 @@
+07/05/2023
+1.24.0
+Changes arising from Decision 281 (Maintenance iteration 14)
+See release notes and Decision 281 for details.
+
+
14/04/2023
1.23.0
Changes arising from Decision Proposal 298
diff --git a/docs/includes/cx_standards/authorisation b/docs/includes/cx_standards/authorisation
index c2a733e7..007668e2 100644
--- a/docs/includes/cx_standards/authorisation
+++ b/docs/includes/cx_standards/authorisation
@@ -1,4 +1,6 @@
-Authorisation Standards
+Authorisation Standards Added new Authorisation CX Standard:
++ Authorisation: Account selection functionality
+
Area
@@ -10,6 +12,10 @@
Data holders MUST allow the consumer to select which of their accounts to share data from if the data request includes account-specific data and if there are multiple accounts available. The Data holder MAY omit this step if none of the data being requested is specific to an account (e.g. Saved Payees).
+Authorisation: Account selection functionality
+Data holders MAY include additional functionality to support account discovery and selection where further navigation or interaction is required to view all accounts. This may, for example, include search, sort, filter, scroll, grouping, and pagination, or other controls in line with existing consumer experiences. Any such functionality MUST NOT introduce unwarranted friction.
Note: Unwarranted friction should have regard to CDR Rule 4.24 and is considered to include the addition of any requirements beyond normal data holder practices for an equivalent account selection process.
+
+
Authorisation: Profile selection
Data holders MAY add a 'profile selection' step or equivalent prior to the account selection step if a single identifier provides access to different customer accounts. For example, one customer ID may give access to business customer and individual customer accounts.
The 'profile selection' step SHOULD only be considered if it is an existing customer experience, and SHOULD be as minimal as possible to avoid introducing unwarranted friction (having regard to CDR Rule 4.24).
diff --git a/docs/includes/endpoint-version-schedule/index.html b/docs/includes/endpoint-version-schedule/index.html
index 5ded25a2..83a1fcae 100644
--- a/docs/includes/endpoint-version-schedule/index.html
+++ b/docs/includes/endpoint-version-schedule/index.html
@@ -745,8 +745,19 @@ Energy APIs
GET
V1
2022-10-01
-N/A
+2024-09-09
2021-10-29, V1.14.0
+2023-05-07, 1.24.0
+
+
+Energy APIs
+Get Generic Plan Detail
+/energy/plans/{planId}
+GET
+V2
+2023-11-01
+N/A
+2023-05-07, 1.24.0
N/A
@@ -789,8 +800,19 @@ Energy APIs
GET
V2
2023-04-14
-N/A
+2024-09-09
2022-09-13, V1.19.0
+2023-05-07, 1.24.0
+
+
+Energy APIs
+Get Energy Account Detail
+/energy/accounts/{accountId}
+GET
+V3
+2023-11-01
+N/A
+2023-05-07, 1.24.0
N/A
diff --git a/docs/includes/nfrs b/docs/includes/nfrs
index 381a89da..766be46c 100644
--- a/docs/includes/nfrs
+++ b/docs/includes/nfrs
@@ -27,9 +27,13 @@
Large Payload : An API which is capable of returning a large data response that would reasonably impose higher data retrieval times on the resource server. Typically bulk request end points.
-Session Requirements
-
-A expiry time of a unique session should be set according to the statements included in the Security Profile .
+Session Requirements Corrected following typo:
+Replaced:
+- A expiry time of a unique...
+ with:
++ The expiry time of a unique...
+
+The expiry time of a unique session should be set according to the statements included in the Security Profile .
After a unique session is expired it is expected that the Data Recipient Software Product, for the same customer, may establish a new session as long as the authorisation is still valid.
@@ -52,8 +56,21 @@
The unavailability of a secondary data holder will mean that some requests cannot be fulfilled by a data holder making a Shared Responsibility Data Request. This will not be taken to mean that the data holder is unavailable.
-
-
+Listed specific APIs in the `Unattended` section
+
+Fixed incorrect Energy API names replacing:
+- Get Accounts
+- Get Account Detail
+- Get Balance For Account
+- Get Bulk Balances
+- Get Balances For Specific Accounts
+ with:
++ Get Energy Accounts
++ Get Energy Account Detail
++ Get Balance For Energy Account
++ Get Bulk Balances for Energy
++ Get Balances For Specific Energy Accounts
+
API end point performance will be measured in response time of individual API requests from receipt of request to delivery of response.
It is understood that different response times can be measured depending on which technical layer of an API implementation stack is instrumented and that not all of the technical layers between the Data Recipient Software Product and the Data Holder will be in the control of the Data Holder. As this is implementation specific it is expected that the Data Holder will ensure that the measurement of response time occurs as close to the Data Recipient Software Product as practicable.
@@ -63,7 +80,8 @@
95% of calls per hour responded to within a nominated threshold
The nominated threshold for each end point will be according to the following table:
-
+Corrected the requirement for the Large Payload tier to remove reference to unattended calls
+
Tier
@@ -79,22 +97,22 @@
High Priority
1000ms
-All calls to the following end points:All InfoSec end points including Dynamic Client Registration CDR Arrangement Revocation The following Unauthenticated end points:Common Get Status Get Outages Customer Present calls to the following end points:Banking Get Accounts Energy Get Accounts Get Account Detail Get Balance For Account Get Invoices For Account Common Get Customer Get Customer Detail
+All calls to the following end points:All InfoSec end points including Dynamic Client Registration CDR Arrangement Revocation The following unauthenticated end points:Common Get Status Get Outages Customer Present calls to the following end points:Banking Get Accounts Energy Get Energy Accounts Get Energy Account Detail Get Balance For Energy Account Get Invoices For Account Common Get Customer Get Customer Detail
Low Priority
1500ms
-Customer Present calls to the following end points:Banking Get Account Detail Get Account Balance Get Bulk Balances Get Balances For Specific Accounts Get Transactions For Account Get Transaction Detail Get Payees Get Payee Detail Get Direct Debits For Account Get Scheduled Payments For Account Get Scheduled Payments Bulk Get Scheduled Payments For Specific Accounts Energy Get Agreed Payment Schedule Get Concessions Get Bulk Balances Get Balances For Specific Accounts Get Bulk Invoices Get Invoices For Specific Accounts Get Billing For Account
+Customer Present calls to the following end points:Banking Get Account Detail Get Account Balance Get Bulk Balances Get Balances For Specific Accounts Get Transactions For Account Get Transaction Detail Get Payees Get Payee Detail Get Direct Debits For Account Get Scheduled Payments For Account Get Scheduled Payments Bulk Get Scheduled Payments For Specific Accounts Energy Get Agreed Payment Schedule Get Concessions Get Bulk Balances for Energy Get Balances For Specific Energy Accounts Get Bulk Invoices Get Invoices For Specific Accounts Get Billing For Account
Unattended
4000ms
-Unattended calls to the following end points that are not Large Payload end points:High Priority Authenticated end points Low Priority Authenticated end points All Admin end points.
+Unattended calls to the following end points:Banking Get Accounts Get Account Detail Get Account Balance Get Bulk Balances Get Balances For Specific Accounts Get Transactions For Account Get Transaction Detail Get Payees Get Payee Detail Get Direct Debits For Account Get Scheduled Payments For Account Get Scheduled Payments Bulk Get Scheduled Payments For Specific Accounts Energy Get Energy Accounts Get Energy Account Detail Get Balance For Energy Account Get Invoices For Account Get Agreed Payment Schedule Get Concessions Get Bulk Balances for Energy Get Balances For Specific Energy Accounts Get Bulk Invoices Get Invoices For Specific Accounts Get Billing For Account Common Get Customer Get Customer Detail Admin Metadata Update Get Metrics
Large Payload
6000ms
-Any Unattended calls to the following end points:Banking Get Bulk Direct Debits Get Direct Debits For Specific Accounts Energy Get Bulk Billing Get Billing For Specific Accounts
+Any calls to the following end points:Banking Get Bulk Direct Debits Get Direct Debits For Specific Accounts Energy Get Bulk Billing Get Billing For Specific Accounts
Secondary Request
diff --git a/docs/includes/obsolete/get-energy-account-detail-v2.html b/docs/includes/obsolete/get-energy-account-detail-v2.html
new file mode 100644
index 00000000..e6d2646b
--- /dev/null
+++ b/docs/includes/obsolete/get-energy-account-detail-v2.html
@@ -0,0 +1,4296 @@
+
+
+
+
+
+
+
+ Get Energy Account Detail v2
+
+
+
+
+
+
+
+
+
+
+
+ NAV
+
+
+
+
+
+
+
+
+
+
+
+
Get Energy Account Detail V2
+
This page documents version 2 of the Get Energy Account Detail end point.
+
+
+Data Holder MUST implement Get Energy Account Detail v3 by November 1st 2023 .
+
+
+
This version is to be ceased to be called by data recipients by September 9th 2024 and can be decommissioned by data holders as of that date.
+
Get Energy Account Detail
+
+
+
+Code samples
+
+
GET /energy/accounts/{accountId} HTTP / 1.1
+
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
var headers = {
+ 'Accept' : 'application/json' ,
+ 'x-v' : 'string' ,
+ 'x-min-v' : 'string' ,
+ 'x-fapi-interaction-id' : 'string' ,
+ 'x-fapi-auth-date' : 'string' ,
+ 'x-fapi-customer-ip-address' : 'string' ,
+ 'x-cds-client-headers' : 'string'
+
+};
+
+$ . ajax ({
+ url : '/energy/accounts/{accountId}' ,
+ method : 'get' ,
+
+ headers : headers ,
+ success : function ( data ) {
+ console . log ( JSON . stringify ( data ));
+ }
+})
+
+
+
GET /energy/accounts/{accountId}
+
+
Obtain detailed information for a specific energy account
+
+
Other Versions: v1
+
Endpoint Version
+
+
+
+
+
+
+
+Version
+2
+
+
+
+
Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+accountId
+path
+string
+mandatory
+ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List end point.
+
+
+x-v
+header
+string
+mandatory
+Version of the API end point 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+
+
+x-min-v
+header
+string
+optional
+Minimum version of the API end point 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+
+
+x-fapi-interaction-id
+header
+string
+optional
+An [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] UUID value is required to be provided in the response header to track the interaction.
+
+
+x-fapi-auth-date
+header
+string
+conditional
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-R-Draft] . Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
+
+
+x-fapi-customer-ip-address
+header
+string
+optional
+The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
+
+
+x-cds-client-headers
+header
+Base64
+conditional
+The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+
+
+
+
+Example responses
+
+200 Response
+
+
{
+ "data" : {
+ "accountId" : "string" ,
+ "accountNumber" : "string" ,
+ "displayName" : "string" ,
+ "openStatus" : "CLOSED" ,
+ "creationDate" : "string" ,
+ "plans" : [
+ {
+ "nickname" : "string" ,
+ "servicePointIds" : [
+ "string"
+ ],
+ "planOverview" : {
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string"
+ },
+ "planDetail" : {
+ "fuelType" : "ELECTRICITY" ,
+ "isContingentPlan" : false ,
+ "meteringCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "minimumValue" : "string" ,
+ "maximumValue" : "string" ,
+ "period" : "string"
+ }
+ ],
+ "gasContract" : {
+ "additionalFeeInformation" : "string" ,
+ "pricingModel" : "SINGLE_RATE" ,
+ "timeZone" : "LOCAL" ,
+ "isFixed" : true ,
+ "variation" : "string" ,
+ "onExpiryDescription" : "string" ,
+ "paymentOption" : [
+ "PAPER_BILL"
+ ],
+ "intrinsicGreenPower" : {
+ "greenPercentage" : "string"
+ },
+ "controlledLoad" : [
+ {
+ "displayName" : "string" ,
+ "rateBlockUType" : "singleRate" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {}
+ ]
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [],
+ "timeOfUse" : [],
+ "type" : "PEAK"
+ }
+ ]
+ }
+ ],
+ "incentives" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "category" : "GIFT" ,
+ "eligibility" : "string"
+ }
+ ],
+ "discounts" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "CONDITIONAL" ,
+ "category" : "PAY_ON_TIME" ,
+ "endDate" : "string" ,
+ "methodUType" : "percentOfBill" ,
+ "percentOfBill" : {
+ "rate" : "string"
+ },
+ "percentOfUse" : {
+ "rate" : "string"
+ },
+ "fixedAmount" : {
+ "amount" : "string"
+ },
+ "percentOverThreshold" : {
+ "rate" : "string" ,
+ "usageAmount" : "string"
+ }
+ }
+ ],
+ "greenPowerCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "GREENPOWER" ,
+ "type" : "FIXED_PER_DAY" ,
+ "tiers" : [
+ {
+ "percentGreen" : "string" ,
+ "rate" : "string" ,
+ "amount" : "string"
+ }
+ ]
+ }
+ ],
+ "eligibility" : [
+ {
+ "type" : "EXISTING_CUST" ,
+ "information" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "fees" : [
+ {
+ "type" : "EXIT" ,
+ "term" : "FIXED" ,
+ "amount" : "string" ,
+ "rate" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "solarFeedInTariff" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "PREMIUM" ,
+ "payerType" : "GOVERNMENT" ,
+ "tariffUType" : "singleTariff" ,
+ "singleTariff" : {
+ "amount" : "string"
+ },
+ "timeVaryingTariffs" : {
+ "type" : "PEAK" ,
+ "amount" : "string" ,
+ "timeVariations" : [
+ {}
+ ]
+ }
+ }
+ ],
+ "tariffPeriod" : [
+ {
+ "type" : "ENVIRONMENTAL" ,
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "dailySupplyCharges" : "string" ,
+ "timeZone" : "LOCAL" ,
+ "rateBlockUType" : "singleRate" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "generalUnitPrice" : "string" ,
+ "rates" : [
+ {}
+ ],
+ "period" : "string"
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "rates" : [],
+ "timeOfUse" : [],
+ "type" : "PEAK"
+ }
+ ],
+ "demandCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "amount" : "string" ,
+ "measureUnit" : "KWH" ,
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "days" : [],
+ "minDemand" : "string" ,
+ "maxDemand" : "string" ,
+ "measurementPeriod" : "DAY" ,
+ "chargePeriod" : "DAY"
+ }
+ ]
+ }
+ ]
+ },
+ "electricityContract" : {
+ "additionalFeeInformation" : "string" ,
+ "pricingModel" : "SINGLE_RATE" ,
+ "timeZone" : "LOCAL" ,
+ "isFixed" : true ,
+ "variation" : "string" ,
+ "onExpiryDescription" : "string" ,
+ "paymentOption" : [
+ "PAPER_BILL"
+ ],
+ "intrinsicGreenPower" : {
+ "greenPercentage" : "string"
+ },
+ "controlledLoad" : [
+ {
+ "displayName" : "string" ,
+ "rateBlockUType" : "singleRate" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {}
+ ]
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [],
+ "timeOfUse" : [],
+ "type" : "PEAK"
+ }
+ ]
+ }
+ ],
+ "incentives" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "category" : "GIFT" ,
+ "eligibility" : "string"
+ }
+ ],
+ "discounts" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "CONDITIONAL" ,
+ "category" : "PAY_ON_TIME" ,
+ "endDate" : "string" ,
+ "methodUType" : "percentOfBill" ,
+ "percentOfBill" : {
+ "rate" : "string"
+ },
+ "percentOfUse" : {
+ "rate" : "string"
+ },
+ "fixedAmount" : {
+ "amount" : "string"
+ },
+ "percentOverThreshold" : {
+ "rate" : "string" ,
+ "usageAmount" : "string"
+ }
+ }
+ ],
+ "greenPowerCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "GREENPOWER" ,
+ "type" : "FIXED_PER_DAY" ,
+ "tiers" : [
+ {
+ "percentGreen" : "string" ,
+ "rate" : "string" ,
+ "amount" : "string"
+ }
+ ]
+ }
+ ],
+ "eligibility" : [
+ {
+ "type" : "EXISTING_CUST" ,
+ "information" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "fees" : [
+ {
+ "type" : "EXIT" ,
+ "term" : "FIXED" ,
+ "amount" : "string" ,
+ "rate" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "solarFeedInTariff" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "PREMIUM" ,
+ "payerType" : "GOVERNMENT" ,
+ "tariffUType" : "singleTariff" ,
+ "singleTariff" : {
+ "amount" : "string"
+ },
+ "timeVaryingTariffs" : {
+ "type" : "PEAK" ,
+ "amount" : "string" ,
+ "timeVariations" : [
+ {}
+ ]
+ }
+ }
+ ],
+ "tariffPeriod" : [
+ {
+ "type" : "ENVIRONMENTAL" ,
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "dailySupplyCharges" : "string" ,
+ "timeZone" : "LOCAL" ,
+ "rateBlockUType" : "singleRate" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "generalUnitPrice" : "string" ,
+ "rates" : [
+ {}
+ ],
+ "period" : "string"
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "rates" : [],
+ "timeOfUse" : [],
+ "type" : "PEAK"
+ }
+ ],
+ "demandCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "amount" : "string" ,
+ "measureUnit" : "KWH" ,
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "days" : [],
+ "minDemand" : "string" ,
+ "maxDemand" : "string" ,
+ "measurementPeriod" : "DAY" ,
+ "chargePeriod" : "DAY"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "authorisedContacts" : [
+ {
+ "firstName" : "string" ,
+ "lastName" : "string" ,
+ "middleNames" : [
+ "string"
+ ],
+ "prefix" : "string" ,
+ "suffix" : "string"
+ }
+ ]
+ }
+ ]
+ },
+ "links" : {
+ "self" : "string"
+ },
+ "meta" : {}
+ }
+
+
Responses
+
+
+
+
+
+Status
+Header
+Type
+Format
+Description
+
+
+
+200
+x-v
+string
+
+The version of the API end point that the data holder has responded with.
+
+
+200
+x-fapi-interaction-id
+string
+
+An [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] UUID value is required to be provided in the response header to track the interaction.
+
+
+400
+x-fapi-interaction-id
+string
+
+An [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] UUID value is required to be provided in the response header to track the interaction.
+
+
+404
+x-fapi-interaction-id
+string
+
+An [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] UUID value is required to be provided in the response header to track the interaction.
+
+
+406
+x-fapi-interaction-id
+string
+
+An [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] UUID value is required to be provided in the response header to track the interaction.
+
+
+
+
+
+
EnergyAccountDetailResponseV2
+
+
+
{
+ "data" : {
+ "accountId" : "string" ,
+ "accountNumber" : "string" ,
+ "displayName" : "string" ,
+ "openStatus" : "CLOSED" ,
+ "creationDate" : "string" ,
+ "plans" : [
+ {
+ "nickname" : "string" ,
+ "servicePointIds" : [
+ "string"
+ ],
+ "planOverview" : {
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string"
+ },
+ "planDetail" : {
+ "fuelType" : "ELECTRICITY" ,
+ "isContingentPlan" : false ,
+ "meteringCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "minimumValue" : "string" ,
+ "maximumValue" : "string" ,
+ "period" : "string"
+ }
+ ],
+ "gasContract" : {
+ "additionalFeeInformation" : "string" ,
+ "pricingModel" : "SINGLE_RATE" ,
+ "timeZone" : "LOCAL" ,
+ "isFixed" : true ,
+ "variation" : "string" ,
+ "onExpiryDescription" : "string" ,
+ "paymentOption" : [
+ "PAPER_BILL"
+ ],
+ "intrinsicGreenPower" : {
+ "greenPercentage" : "string"
+ },
+ "controlledLoad" : [
+ {
+ "displayName" : "string" ,
+ "rateBlockUType" : "singleRate" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {}
+ ]
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [],
+ "timeOfUse" : [],
+ "type" : "PEAK"
+ }
+ ]
+ }
+ ],
+ "incentives" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "category" : "GIFT" ,
+ "eligibility" : "string"
+ }
+ ],
+ "discounts" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "CONDITIONAL" ,
+ "category" : "PAY_ON_TIME" ,
+ "endDate" : "string" ,
+ "methodUType" : "percentOfBill" ,
+ "percentOfBill" : {
+ "rate" : "string"
+ },
+ "percentOfUse" : {
+ "rate" : "string"
+ },
+ "fixedAmount" : {
+ "amount" : "string"
+ },
+ "percentOverThreshold" : {
+ "rate" : "string" ,
+ "usageAmount" : "string"
+ }
+ }
+ ],
+ "greenPowerCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "GREENPOWER" ,
+ "type" : "FIXED_PER_DAY" ,
+ "tiers" : [
+ {
+ "percentGreen" : "string" ,
+ "rate" : "string" ,
+ "amount" : "string"
+ }
+ ]
+ }
+ ],
+ "eligibility" : [
+ {
+ "type" : "EXISTING_CUST" ,
+ "information" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "fees" : [
+ {
+ "type" : "EXIT" ,
+ "term" : "FIXED" ,
+ "amount" : "string" ,
+ "rate" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "solarFeedInTariff" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "PREMIUM" ,
+ "payerType" : "GOVERNMENT" ,
+ "tariffUType" : "singleTariff" ,
+ "singleTariff" : {
+ "amount" : "string"
+ },
+ "timeVaryingTariffs" : {
+ "type" : "PEAK" ,
+ "amount" : "string" ,
+ "timeVariations" : [
+ {}
+ ]
+ }
+ }
+ ],
+ "tariffPeriod" : [
+ {
+ "type" : "ENVIRONMENTAL" ,
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "dailySupplyCharges" : "string" ,
+ "timeZone" : "LOCAL" ,
+ "rateBlockUType" : "singleRate" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "generalUnitPrice" : "string" ,
+ "rates" : [
+ {}
+ ],
+ "period" : "string"
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "rates" : [],
+ "timeOfUse" : [],
+ "type" : "PEAK"
+ }
+ ],
+ "demandCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "amount" : "string" ,
+ "measureUnit" : "KWH" ,
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "days" : [],
+ "minDemand" : "string" ,
+ "maxDemand" : "string" ,
+ "measurementPeriod" : "DAY" ,
+ "chargePeriod" : "DAY"
+ }
+ ]
+ }
+ ]
+ },
+ "electricityContract" : {
+ "additionalFeeInformation" : "string" ,
+ "pricingModel" : "SINGLE_RATE" ,
+ "timeZone" : "LOCAL" ,
+ "isFixed" : true ,
+ "variation" : "string" ,
+ "onExpiryDescription" : "string" ,
+ "paymentOption" : [
+ "PAPER_BILL"
+ ],
+ "intrinsicGreenPower" : {
+ "greenPercentage" : "string"
+ },
+ "controlledLoad" : [
+ {
+ "displayName" : "string" ,
+ "rateBlockUType" : "singleRate" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {}
+ ]
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [],
+ "timeOfUse" : [],
+ "type" : "PEAK"
+ }
+ ]
+ }
+ ],
+ "incentives" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "category" : "GIFT" ,
+ "eligibility" : "string"
+ }
+ ],
+ "discounts" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "CONDITIONAL" ,
+ "category" : "PAY_ON_TIME" ,
+ "endDate" : "string" ,
+ "methodUType" : "percentOfBill" ,
+ "percentOfBill" : {
+ "rate" : "string"
+ },
+ "percentOfUse" : {
+ "rate" : "string"
+ },
+ "fixedAmount" : {
+ "amount" : "string"
+ },
+ "percentOverThreshold" : {
+ "rate" : "string" ,
+ "usageAmount" : "string"
+ }
+ }
+ ],
+ "greenPowerCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "GREENPOWER" ,
+ "type" : "FIXED_PER_DAY" ,
+ "tiers" : [
+ {
+ "percentGreen" : "string" ,
+ "rate" : "string" ,
+ "amount" : "string"
+ }
+ ]
+ }
+ ],
+ "eligibility" : [
+ {
+ "type" : "EXISTING_CUST" ,
+ "information" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "fees" : [
+ {
+ "type" : "EXIT" ,
+ "term" : "FIXED" ,
+ "amount" : "string" ,
+ "rate" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "solarFeedInTariff" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "PREMIUM" ,
+ "payerType" : "GOVERNMENT" ,
+ "tariffUType" : "singleTariff" ,
+ "singleTariff" : {
+ "amount" : "string"
+ },
+ "timeVaryingTariffs" : {
+ "type" : "PEAK" ,
+ "amount" : "string" ,
+ "timeVariations" : [
+ {}
+ ]
+ }
+ }
+ ],
+ "tariffPeriod" : [
+ {
+ "type" : "ENVIRONMENTAL" ,
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "dailySupplyCharges" : "string" ,
+ "timeZone" : "LOCAL" ,
+ "rateBlockUType" : "singleRate" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "generalUnitPrice" : "string" ,
+ "rates" : [
+ {}
+ ],
+ "period" : "string"
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "rates" : [],
+ "timeOfUse" : [],
+ "type" : "PEAK"
+ }
+ ],
+ "demandCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "amount" : "string" ,
+ "measureUnit" : "KWH" ,
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "days" : [],
+ "minDemand" : "string" ,
+ "maxDemand" : "string" ,
+ "measurementPeriod" : "DAY" ,
+ "chargePeriod" : "DAY"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "authorisedContacts" : [
+ {
+ "firstName" : "string" ,
+ "lastName" : "string" ,
+ "middleNames" : [
+ "string"
+ ],
+ "prefix" : "string" ,
+ "suffix" : "string"
+ }
+ ]
+ }
+ ]
+ },
+ "links" : {
+ "self" : "string"
+ },
+ "meta" : {}
+ }
+
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+data
+EnergyAccountDetailV2
+mandatory
+none
+
+
+links
+Links
+mandatory
+none
+
+
+meta
+Meta
+optional
+none
+
+
+
+
EnergyAccountDetailV2
+
+
+
{
+ "accountId" : "string" ,
+ "accountNumber" : "string" ,
+ "displayName" : "string" ,
+ "openStatus" : "CLOSED" ,
+ "creationDate" : "string" ,
+ "plans" : [
+ {
+ "nickname" : "string" ,
+ "servicePointIds" : [
+ "string"
+ ],
+ "planOverview" : {
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string"
+ },
+ "planDetail" : {
+ "fuelType" : "ELECTRICITY" ,
+ "isContingentPlan" : false ,
+ "meteringCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "minimumValue" : "string" ,
+ "maximumValue" : "string" ,
+ "period" : "string"
+ }
+ ],
+ "gasContract" : {
+ "additionalFeeInformation" : "string" ,
+ "pricingModel" : "SINGLE_RATE" ,
+ "timeZone" : "LOCAL" ,
+ "isFixed" : true ,
+ "variation" : "string" ,
+ "onExpiryDescription" : "string" ,
+ "paymentOption" : [
+ "PAPER_BILL"
+ ],
+ "intrinsicGreenPower" : {
+ "greenPercentage" : "string"
+ },
+ "controlledLoad" : [
+ {
+ "displayName" : "string" ,
+ "rateBlockUType" : "singleRate" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {}
+ ],
+ "timeOfUse" : [
+ {}
+ ],
+ "type" : "PEAK"
+ }
+ ]
+ }
+ ],
+ "incentives" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "category" : "GIFT" ,
+ "eligibility" : "string"
+ }
+ ],
+ "discounts" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "CONDITIONAL" ,
+ "category" : "PAY_ON_TIME" ,
+ "endDate" : "string" ,
+ "methodUType" : "percentOfBill" ,
+ "percentOfBill" : {
+ "rate" : "string"
+ },
+ "percentOfUse" : {
+ "rate" : "string"
+ },
+ "fixedAmount" : {
+ "amount" : "string"
+ },
+ "percentOverThreshold" : {
+ "rate" : "string" ,
+ "usageAmount" : "string"
+ }
+ }
+ ],
+ "greenPowerCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "GREENPOWER" ,
+ "type" : "FIXED_PER_DAY" ,
+ "tiers" : [
+ {
+ "percentGreen" : "string" ,
+ "rate" : "string" ,
+ "amount" : "string"
+ }
+ ]
+ }
+ ],
+ "eligibility" : [
+ {
+ "type" : "EXISTING_CUST" ,
+ "information" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "fees" : [
+ {
+ "type" : "EXIT" ,
+ "term" : "FIXED" ,
+ "amount" : "string" ,
+ "rate" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "solarFeedInTariff" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "PREMIUM" ,
+ "payerType" : "GOVERNMENT" ,
+ "tariffUType" : "singleTariff" ,
+ "singleTariff" : {
+ "amount" : "string"
+ },
+ "timeVaryingTariffs" : {
+ "type" : "PEAK" ,
+ "amount" : "string" ,
+ "timeVariations" : [
+ {
+ "days" : [],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ]
+ }
+ }
+ ],
+ "tariffPeriod" : [
+ {
+ "type" : "ENVIRONMENTAL" ,
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "dailySupplyCharges" : "string" ,
+ "timeZone" : "LOCAL" ,
+ "rateBlockUType" : "singleRate" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "generalUnitPrice" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "period" : "string"
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "rates" : [
+ {}
+ ],
+ "timeOfUse" : [
+ {}
+ ],
+ "type" : "PEAK"
+ }
+ ],
+ "demandCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "amount" : "string" ,
+ "measureUnit" : "KWH" ,
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "days" : [
+ "SUN"
+ ],
+ "minDemand" : "string" ,
+ "maxDemand" : "string" ,
+ "measurementPeriod" : "DAY" ,
+ "chargePeriod" : "DAY"
+ }
+ ]
+ }
+ ]
+ },
+ "electricityContract" : {
+ "additionalFeeInformation" : "string" ,
+ "pricingModel" : "SINGLE_RATE" ,
+ "timeZone" : "LOCAL" ,
+ "isFixed" : true ,
+ "variation" : "string" ,
+ "onExpiryDescription" : "string" ,
+ "paymentOption" : [
+ "PAPER_BILL"
+ ],
+ "intrinsicGreenPower" : {
+ "greenPercentage" : "string"
+ },
+ "controlledLoad" : [
+ {
+ "displayName" : "string" ,
+ "rateBlockUType" : "singleRate" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {}
+ ],
+ "timeOfUse" : [
+ {}
+ ],
+ "type" : "PEAK"
+ }
+ ]
+ }
+ ],
+ "incentives" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "category" : "GIFT" ,
+ "eligibility" : "string"
+ }
+ ],
+ "discounts" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "CONDITIONAL" ,
+ "category" : "PAY_ON_TIME" ,
+ "endDate" : "string" ,
+ "methodUType" : "percentOfBill" ,
+ "percentOfBill" : {
+ "rate" : "string"
+ },
+ "percentOfUse" : {
+ "rate" : "string"
+ },
+ "fixedAmount" : {
+ "amount" : "string"
+ },
+ "percentOverThreshold" : {
+ "rate" : "string" ,
+ "usageAmount" : "string"
+ }
+ }
+ ],
+ "greenPowerCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "GREENPOWER" ,
+ "type" : "FIXED_PER_DAY" ,
+ "tiers" : [
+ {
+ "percentGreen" : "string" ,
+ "rate" : "string" ,
+ "amount" : "string"
+ }
+ ]
+ }
+ ],
+ "eligibility" : [
+ {
+ "type" : "EXISTING_CUST" ,
+ "information" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "fees" : [
+ {
+ "type" : "EXIT" ,
+ "term" : "FIXED" ,
+ "amount" : "string" ,
+ "rate" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "solarFeedInTariff" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "PREMIUM" ,
+ "payerType" : "GOVERNMENT" ,
+ "tariffUType" : "singleTariff" ,
+ "singleTariff" : {
+ "amount" : "string"
+ },
+ "timeVaryingTariffs" : {
+ "type" : "PEAK" ,
+ "amount" : "string" ,
+ "timeVariations" : [
+ {
+ "days" : [],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ]
+ }
+ }
+ ],
+ "tariffPeriod" : [
+ {
+ "type" : "ENVIRONMENTAL" ,
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "dailySupplyCharges" : "string" ,
+ "timeZone" : "LOCAL" ,
+ "rateBlockUType" : "singleRate" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "generalUnitPrice" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "period" : "string"
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "rates" : [
+ {}
+ ],
+ "timeOfUse" : [
+ {}
+ ],
+ "type" : "PEAK"
+ }
+ ],
+ "demandCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "amount" : "string" ,
+ "measureUnit" : "KWH" ,
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "days" : [
+ "SUN"
+ ],
+ "minDemand" : "string" ,
+ "maxDemand" : "string" ,
+ "measurementPeriod" : "DAY" ,
+ "chargePeriod" : "DAY"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "authorisedContacts" : [
+ {
+ "firstName" : "string" ,
+ "lastName" : "string" ,
+ "middleNames" : [
+ "string"
+ ],
+ "prefix" : "string" ,
+ "suffix" : "string"
+ }
+ ]
+ }
+ ]
+ }
+
+
Properties
+
allOf
+
+
+
+Name
+Type
+Required
+Description
+
+
+
+anonymous
+EnergyAccountBaseV2
+mandatory
+none
+
+
+
+
and
+
+
+
+Name
+Type
+Required
+Description
+
+
+
+anonymous
+object
+mandatory
+The array of plans containing service points and associated plan details
+
+
+» plans
+[object]
+mandatory
+The array of plans containing service points and associated plan details
+
+
+»» nickname
+string
+optional
+Optional display name for the plan provided by the customer to help differentiate multiple plans
+
+
+»» servicePointIds
+[string]
+mandatory
+An array of servicePointIds, representing NMIs, that this account is linked to
+
+
+»» planOverview
+object
+conditional
+Mandatory if openStatus is OPEN
+
+
+»»» displayName
+string
+optional
+The name of the plan if one exists
+
+
+»»» startDate
+DateString
+mandatory
+The start date of the applicability of this plan
+
+
+»»» endDate
+DateString
+optional
+The end date of the applicability of this plan
+
+
+»» planDetail
+object
+conditional
+Detail on the plan applicable to this account. Mandatory if openStatus is OPEN
+
+
+»»» fuelType
+string
+mandatory
+The fuel types covered by the plan
+
+
+»»» isContingentPlan
+boolean
+optional
+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
+
+
+»»» meteringCharges
+[object]
+optional
+Charges for metering included in the plan
+
+
+»»»» displayName
+string
+mandatory
+Display name of the charge
+
+
+»»»» description
+string
+optional
+Description of the charge
+
+
+»»»» minimumValue
+AmountString
+mandatory
+Minimum value of the charge if the charge is a range or the absolute value of the charge if no range is specified
+
+
+»»»» maximumValue
+AmountString
+optional
+The upper limit of the charge if the charge could occur in a range
+
+
+»»»» period
+ExternalRef
+optional
+The charges that occur on a schedule indicates the frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+
+
+»»» gasContract
+EnergyPlanContract
+conditional
+The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to GAS or DUAL
+
+
+»»» electricityContract
+EnergyPlanContract
+conditional
+The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to ELECTRICITY or DUAL
+
+
+»» authorisedContacts
+[object]
+optional
+An array of additional contacts that are authorised to act on this account
+
+
+»»» firstName
+string
+optional
+For people with single names this field need not be present. The single name should be in the lastName field
+
+
+»»» lastName
+string
+mandatory
+For people with single names the single name should be in this field
+
+
+»»» middleNames
+[string]
+optional
+Field is mandatory but array may be empty
+
+
+»»» prefix
+string
+optional
+Also known as title or salutation. The prefix to the name (e.g. Mr, Mrs, Ms, Miss, Sir, etc)
+
+
+»»» suffix
+string
+optional
+Used for a trailing suffix to the name (e.g. Jr)
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+fuelType
+ELECTRICITY
+
+
+fuelType
+GAS
+
+
+fuelType
+DUAL
+
+
+
+
EnergyAccountBaseV2
+
+
+
{
+ "accountId" : "string" ,
+ "accountNumber" : "string" ,
+ "displayName" : "string" ,
+ "openStatus" : "CLOSED" ,
+ "creationDate" : "string"
+ }
+
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+accountId
+string
+mandatory
+The ID of the account. To be created in accordance with CDR ID permanence requirements
+
+
+accountNumber
+string
+optional
+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
+
+
+displayName
+string
+optional
+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
+
+
+openStatus
+string
+optional
+Open or closed status for the account. If not present then OPEN is assumed
+
+
+creationDate
+DateString
+conditional
+The date that the account was created or opened. Mandatory if openStatus is OPEN
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+openStatus
+CLOSED
+
+
+openStatus
+OPEN
+
+
+
+
EnergyPlanContract
+
+
+
{
+ "additionalFeeInformation" : "string" ,
+ "pricingModel" : "SINGLE_RATE" ,
+ "timeZone" : "LOCAL" ,
+ "isFixed" : true ,
+ "variation" : "string" ,
+ "onExpiryDescription" : "string" ,
+ "paymentOption" : [
+ "PAPER_BILL"
+ ],
+ "intrinsicGreenPower" : {
+ "greenPercentage" : "string"
+ },
+ "controlledLoad" : [
+ {
+ "displayName" : "string" ,
+ "rateBlockUType" : "singleRate" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "additionalInfo" : "string" ,
+ "additionalInfoUri" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ]
+ }
+ ],
+ "incentives" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "category" : "GIFT" ,
+ "eligibility" : "string"
+ }
+ ],
+ "discounts" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "CONDITIONAL" ,
+ "category" : "PAY_ON_TIME" ,
+ "endDate" : "string" ,
+ "methodUType" : "percentOfBill" ,
+ "percentOfBill" : {
+ "rate" : "string"
+ },
+ "percentOfUse" : {
+ "rate" : "string"
+ },
+ "fixedAmount" : {
+ "amount" : "string"
+ },
+ "percentOverThreshold" : {
+ "rate" : "string" ,
+ "usageAmount" : "string"
+ }
+ }
+ ],
+ "greenPowerCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "GREENPOWER" ,
+ "type" : "FIXED_PER_DAY" ,
+ "tiers" : [
+ {
+ "percentGreen" : "string" ,
+ "rate" : "string" ,
+ "amount" : "string"
+ }
+ ]
+ }
+ ],
+ "eligibility" : [
+ {
+ "type" : "EXISTING_CUST" ,
+ "information" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "fees" : [
+ {
+ "type" : "EXIT" ,
+ "term" : "FIXED" ,
+ "amount" : "string" ,
+ "rate" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "solarFeedInTariff" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "PREMIUM" ,
+ "payerType" : "GOVERNMENT" ,
+ "tariffUType" : "singleTariff" ,
+ "singleTariff" : {
+ "amount" : "string"
+ },
+ "timeVaryingTariffs" : {
+ "type" : "PEAK" ,
+ "amount" : "string" ,
+ "timeVariations" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ]
+ }
+ }
+ ],
+ "tariffPeriod" : [
+ {
+ "type" : "ENVIRONMENTAL" ,
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "dailySupplyCharges" : "string" ,
+ "timeZone" : "LOCAL" ,
+ "rateBlockUType" : "singleRate" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "generalUnitPrice" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "period" : "string"
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ],
+ "demandCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "amount" : "string" ,
+ "measureUnit" : "KWH" ,
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "days" : [
+ "SUN"
+ ],
+ "minDemand" : "string" ,
+ "maxDemand" : "string" ,
+ "measurementPeriod" : "DAY" ,
+ "chargePeriod" : "DAY"
+ }
+ ]
+ }
+ ]
+ }
+
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+additionalFeeInformation
+string
+optional
+Free text field containing additional information of the fees for this contract
+
+
+pricingModel
+string
+mandatory
+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 above, 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 consumedTIME_OF_USE_CONT_LOAD - as above, 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 factorsFLEXIBLE_CONT_LOAD - as above, 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
+
+
+timeZone
+string
+conditional
+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
+
+
+isFixed
+boolean
+mandatory
+Flag indicating whether prices are fixed or variable
+
+
+variation
+string
+conditional
+Free text description of price variation policy and conditions for the contract. Mandatory if isFixed
is false
+
+
+onExpiryDescription
+string
+optional
+Free text field that describes what will occur on or prior to expiry of the fixed contract term or benefit period
+
+
+paymentOption
+[string]
+mandatory
+Payment options for this contract
+
+
+intrinsicGreenPower
+object
+optional
+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
+
+
+» greenPercentage
+RateString
+mandatory
+Percentage of green power intrinsically included in the plan
+
+
+controlledLoad
+EnergyPlanControlledLoad
+conditional
+Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD
+
+
+incentives
+EnergyPlanIncentives
+optional
+Optional list of incentives available for the contract
+
+
+discounts
+EnergyPlanDiscounts
+optional
+Optional list of discounts available for the contract
+
+
+greenPowerCharges
+EnergyPlanGreenPowerCharges
+optional
+Optional list of charges applicable to green power
+
+
+eligibility
+EnergyPlanEligibility
+optional
+Eligibility restrictions or requirements
+
+
+fees
+EnergyPlanFees
+optional
+An array of fees applicable to the plan
+
+
+solarFeedInTariff
+EnergyPlanSolarFeedInTariff
+optional
+Array of feed in tariffs for solar power
+
+
+tariffPeriod
+EnergyPlanTariffPeriod
+mandatory
+Array of tariff periods
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+pricingModel
+SINGLE_RATE
+
+
+pricingModel
+SINGLE_RATE_CONT_LOAD
+
+
+pricingModel
+TIME_OF_USE
+
+
+pricingModel
+TIME_OF_USE_CONT_LOAD
+
+
+pricingModel
+FLEXIBLE
+
+
+pricingModel
+FLEXIBLE_CONT_LOAD
+
+
+pricingModel
+QUOTA
+
+
+timeZone
+LOCAL
+
+
+timeZone
+AEST
+
+
+paymentOption
+PAPER_BILL
+
+
+paymentOption
+CREDIT_CARD
+
+
+paymentOption
+DIRECT_DEBIT
+
+
+paymentOption
+BPAY
+
+
+paymentOption
+OTHER
+
+
+
+
EnergyPlanControlledLoad
+
+
+
[
+ {
+ "displayName" : "string" ,
+ "rateBlockUType" : "singleRate" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "additionalInfo" : "string" ,
+ "additionalInfoUri" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ]
+ }
+ ]
+
+
+
Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+displayName
+string
+mandatory
+A display name for the controlled load
+
+
+rateBlockUType
+string
+mandatory
+Specifies the type of controlloed load rate
+
+
+startDate
+DateString
+optional
+Optional start date of the application of the controlled load rate
+
+
+endDate
+DateString
+optional
+Optional end date of the application of the controlled load rate
+
+
+singleRate
+object
+conditional
+Object representing a single controlled load rate. Required if rateBlockUType is singleRate
+
+
+» displayName
+string
+mandatory
+Display name of the controlled load rate
+
+
+» description
+string
+optional
+Description of the controlled load rate
+
+
+» dailySupplyCharge
+AmountString
+optional
+The daily supply charge (exclusive of GST) for this controlled load tier
+
+
+» rates
+[object]
+mandatory
+Array of controlled load rates in order of usage volume
+
+
+»» unitPrice
+AmountString
+mandatory
+Unit price of usage per measure unit (exclusive of GST)
+
+
+»» measureUnit
+string
+optional
+The measurement unit of rate. Assumed to be KWH if absent
+
+
+»» volume
+number
+optional
+Volume in kWh that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period
+
+
+» timeOfUseRates
+[object]
+conditional
+Array of objects representing time of use rates. Required if rateBlockUType is timeOfUseRates
+
+
+»» displayName
+string
+mandatory
+Display name of the controlled load rate
+
+
+»» description
+string
+optional
+Description of the controlled load rate
+
+
+»» dailySupplyCharge
+AmountString
+optional
+The daily supply charge (exclusive of GST) for this controlled load tier
+
+
+»» rates
+[object]
+mandatory
+Array of controlled load rates in order of usage volume
+
+
+»»» unitPrice
+AmountString
+mandatory
+Unit price of usage per measure unit (exclusive of GST)
+
+
+»»» measureUnit
+string
+optional
+The measurement unit of rate. Assumed to be KWH if absent
+
+
+»»» volume
+number
+optional
+Volume in kWh that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period
+
+
+»» timeOfUse
+[object]
+mandatory
+Array of times of use.
+
+
+»»» days
+[string]
+optional
+The days that the rate applies to
+
+
+»»» startTime
+TimeString
+conditional
+The beginning of the time period per day for which the controlled load rate applies. Required if endTime provided
+
+
+»»» endTime
+TimeString
+conditional
+The end of the time period per day for which the controlled load rate applies. Required if startTime provided
+
+
+»»» additionalInfo
+string
+conditional
+Display text providing more information on the contrlled load, for e.g. controlled load availability if specific day/time is not known. Required if startTime and endTime absent or if additionalInfoUri provided
+
+
+»»» additionalInfoUri
+URIString
+optional
+Optional link to additional information regarding the controlled load
+
+
+»» type
+string
+mandatory
+The type of usage that the rate applies to
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+rateBlockUType
+singleRate
+
+
+rateBlockUType
+timeOfUseRates
+
+
+measureUnit
+KWH
+
+
+measureUnit
+KVA
+
+
+measureUnit
+KVAR
+
+
+measureUnit
+KVARH
+
+
+measureUnit
+KW
+
+
+measureUnit
+DAYS
+
+
+measureUnit
+METER
+
+
+measureUnit
+MONTH
+
+
+measureUnit
+KWH
+
+
+measureUnit
+KVA
+
+
+measureUnit
+KVAR
+
+
+measureUnit
+KVARH
+
+
+measureUnit
+KW
+
+
+measureUnit
+DAYS
+
+
+measureUnit
+METER
+
+
+measureUnit
+MONTH
+
+
+days
+SUN
+
+
+days
+MON
+
+
+days
+TUE
+
+
+days
+WED
+
+
+days
+THU
+
+
+days
+FRI
+
+
+days
+SAT
+
+
+days
+PUBLIC_HOLIDAYS
+
+
+type
+PEAK
+
+
+type
+OFF_PEAK
+
+
+type
+SHOULDER
+
+
+type
+SOLAR_SPONGE
+
+
+
+
EnergyPlanIncentives
+
+
+
[
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "category" : "GIFT" ,
+ "eligibility" : "string"
+ }
+ ]
+
+
+
Optional list of incentives available for the contract
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+displayName
+string
+mandatory
+The display name of the incentive
+
+
+description
+string
+mandatory
+The description of the incentive
+
+
+category
+string
+mandatory
+The type of the incentive
+
+
+eligibility
+string
+optional
+A display message outlining an eligibility criteria that may apply
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+category
+GIFT
+
+
+category
+ACCOUNT_CREDIT
+
+
+category
+OTHER
+
+
+
+
EnergyPlanDiscounts
+
+
+
[
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "CONDITIONAL" ,
+ "category" : "PAY_ON_TIME" ,
+ "endDate" : "string" ,
+ "methodUType" : "percentOfBill" ,
+ "percentOfBill" : {
+ "rate" : "string"
+ },
+ "percentOfUse" : {
+ "rate" : "string"
+ },
+ "fixedAmount" : {
+ "amount" : "string"
+ },
+ "percentOverThreshold" : {
+ "rate" : "string" ,
+ "usageAmount" : "string"
+ }
+ }
+ ]
+
+
+
Optional list of discounts available for the contract
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+displayName
+string
+mandatory
+The display name of the discount
+
+
+description
+string
+optional
+The description of the discount
+
+
+type
+string
+mandatory
+The type of the discount
+
+
+category
+string
+optional
+The type of the discount. Mandatory if the discount type is CONDITIONAL
+
+
+endDate
+DateString
+optional
+Optional end date for the discount after which the discount is no longer available
+
+
+methodUType
+string
+mandatory
+The method of calculation of the discount
+
+
+percentOfBill
+object
+conditional
+Required if methodUType is percentOfBill
+
+
+» rate
+RateString
+mandatory
+The rate of the discount applied to the bill amount
+
+
+percentOfUse
+object
+conditional
+Required if methodUType is percentOfUse
+
+
+» rate
+RateString
+mandatory
+The rate of the discount applied to the usageamount
+
+
+fixedAmount
+object
+conditional
+Required if methodUType is fixedAmount
+
+
+» amount
+AmountString
+mandatory
+The amount of the discount
+
+
+percentOverThreshold
+object
+conditional
+Required if methodUType is percentOverThreshold
+
+
+» rate
+RateString
+mandatory
+The rate of the discount over the usage amount
+
+
+» usageAmount
+AmountString
+mandatory
+The usage amount threshold above which the discount applies
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+type
+CONDITIONAL
+
+
+type
+GUARANTEED
+
+
+type
+OTHER
+
+
+category
+PAY_ON_TIME
+
+
+category
+DIRECT_DEBIT
+
+
+category
+GUARANTEED_DISCOUNT
+
+
+category
+OTHER
+
+
+methodUType
+percentOfBill
+
+
+methodUType
+percentOfUse
+
+
+methodUType
+fixedAmount
+
+
+methodUType
+percentOverThreshold
+
+
+
+
EnergyPlanGreenPowerCharges
+
+
+
[
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "GREENPOWER" ,
+ "type" : "FIXED_PER_DAY" ,
+ "tiers" : [
+ {
+ "percentGreen" : "string" ,
+ "rate" : "string" ,
+ "amount" : "string"
+ }
+ ]
+ }
+ ]
+
+
+
Optional list of charges applicable to green power
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+displayName
+string
+mandatory
+The display name of the charge
+
+
+description
+string
+optional
+The description of the charge
+
+
+scheme
+string
+mandatory
+The applicable green power scheme
+
+
+type
+string
+mandatory
+The type of charge
+
+
+tiers
+[object]
+mandatory
+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
+
+
+» percentGreen
+RateString
+mandatory
+The upper percentage of green power used applicable for this tier
+
+
+» rate
+RateString
+conditional
+The rate of the charge if the type implies the application of a rate
+
+
+» amount
+AmountString
+conditional
+The amount of the charge if the type implies the application of a fixed amount
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+scheme
+GREENPOWER
+
+
+scheme
+OTHER
+
+
+type
+FIXED_PER_DAY
+
+
+type
+FIXED_PER_WEEK
+
+
+type
+FIXED_PER_MONTH
+
+
+type
+FIXED_PER_UNIT
+
+
+type
+PERCENT_OF_USE
+
+
+type
+PERCENT_OF_BILL
+
+
+
+
EnergyPlanEligibility
+
+
+
[
+ {
+ "type" : "EXISTING_CUST" ,
+ "information" : "string" ,
+ "description" : "string"
+ }
+ ]
+
+
+
Eligibility restrictions or requirements
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+type
+string
+mandatory
+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)
+
+
+information
+string
+mandatory
+Information of the eligibility restriction specific to the type of the restriction
+
+
+description
+string
+optional
+A description of the eligibility restriction
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+type
+EXISTING_CUST
+
+
+type
+EXISTING_POOL
+
+
+type
+EXISTING_SOLAR
+
+
+type
+EXISTING_BATTERY
+
+
+type
+EXISTING_SMART_METER
+
+
+type
+EXISTING_BASIC_METER
+
+
+type
+SENIOR_CARD
+
+
+type
+SMALL_BUSINESS
+
+
+type
+NO_SOLAR_FIT
+
+
+type
+NEW_CUSTOMER
+
+
+type
+ONLINE_ONLY
+
+
+type
+REQ_EQUIP_SUPPLIER
+
+
+type
+THIRD_PARTY_ONLY
+
+
+type
+SPORT_CLUB_MEMBER
+
+
+type
+ORG_MEMBER
+
+
+type
+SPECIFIC_LOCATION
+
+
+type
+MINIMUM_USAGE
+
+
+type
+LOYALTY_MEMBER
+
+
+type
+GROUP_BUY_MEMBER
+
+
+type
+CONTINGENT_PLAN
+
+
+type
+OTHER
+
+
+
+
EnergyPlanFees
+
+
+
[
+ {
+ "type" : "EXIT" ,
+ "term" : "FIXED" ,
+ "amount" : "string" ,
+ "rate" : "string" ,
+ "description" : "string"
+ }
+ ]
+
+
+
An array of fees applicable to the plan
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+type
+string
+mandatory
+The type of the fee
+
+
+term
+string
+mandatory
+The term of the fee
+
+
+amount
+AmountString
+conditional
+The fee amount. Required if term is not PERCENT_OF_BILL
+
+
+rate
+RateString
+conditional
+The fee rate. Required if term is PERCENT_OF_BILL
+
+
+description
+string
+optional
+A description of the fee
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+type
+EXIT
+
+
+type
+ESTABLISHMENT
+
+
+type
+LATE_PAYMENT
+
+
+type
+DISCONNECTION
+
+
+type
+DISCONNECT_MOVE_OUT
+
+
+type
+DISCONNECT_NON_PAY
+
+
+type
+RECONNECTION
+
+
+type
+CONNECTION
+
+
+type
+PAYMENT_PROCESSING
+
+
+type
+CC_PROCESSING
+
+
+type
+CHEQUE_DISHONOUR
+
+
+type
+DD_DISHONOUR
+
+
+type
+MEMBERSHIP
+
+
+type
+CONTRIBUTION
+
+
+type
+PAPER_BILL
+
+
+type
+OTHER
+
+
+term
+FIXED
+
+
+term
+1_YEAR
+
+
+term
+2_YEAR
+
+
+term
+3_YEAR
+
+
+term
+4_YEAR
+
+
+term
+5_YEAR
+
+
+term
+PERCENT_OF_BILL
+
+
+term
+ANNUAL
+
+
+term
+DAILY
+
+
+term
+WEEKLY
+
+
+term
+MONTHLY
+
+
+term
+BIANNUAL
+
+
+term
+VARIABLE
+
+
+
+
EnergyPlanSolarFeedInTariff
+
+
+
[
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "PREMIUM" ,
+ "payerType" : "GOVERNMENT" ,
+ "tariffUType" : "singleTariff" ,
+ "singleTariff" : {
+ "amount" : "string"
+ },
+ "timeVaryingTariffs" : {
+ "type" : "PEAK" ,
+ "amount" : "string" ,
+ "timeVariations" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ]
+ }
+ }
+ ]
+
+
+
Array of feed in tariffs for solar power
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+displayName
+string
+mandatory
+The name of the tariff
+
+
+description
+string
+optional
+A description of the tariff
+
+
+scheme
+string
+mandatory
+The applicable scheme
+
+
+payerType
+string
+mandatory
+The type of the payer
+
+
+tariffUType
+string
+mandatory
+The type of the payer
+
+
+singleTariff
+object
+conditional
+Represents a constant tariff. Mandatory if tariffUType is set to singleTariff
+
+
+» amount
+AmountString
+mandatory
+The tariff amount
+
+
+timeVaryingTariffs
+object
+conditional
+Represents a tariff based on time. Mandatory if tariffUType is set to timeVaryingTariffs
+
+
+» type
+string
+optional
+The type of the charging time period. If absent applies to all periods
+
+
+» amount
+AmountString
+mandatory
+The tariff amount
+
+
+» timeVariations
+[object]
+mandatory
+Array of time periods for which this tariff is applicable
+
+
+»» days
+[string]
+mandatory
+The days that the tariff applies to. At least one entry required
+
+
+»» startTime
+TimeString
+optional
+The beginning of the time period per day for which the tariff applies. If absent assumes start of day (ie. midnight)
+
+
+»» endTime
+TimeString
+optional
+The end of the time period per day for which the tariff applies. If absent assumes end of day (ie. one second before midnight)
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+scheme
+PREMIUM
+
+
+scheme
+OTHER
+
+
+payerType
+GOVERNMENT
+
+
+payerType
+RETAILER
+
+
+tariffUType
+singleTariff
+
+
+tariffUType
+timeVaryingTariffs
+
+
+type
+PEAK
+
+
+type
+OFF_PEAK
+
+
+type
+SHOULDER
+
+
+days
+SUN
+
+
+days
+MON
+
+
+days
+TUE
+
+
+days
+WED
+
+
+days
+THU
+
+
+days
+FRI
+
+
+days
+SAT
+
+
+days
+PUBLIC_HOLIDAYS
+
+
+
+
EnergyPlanTariffPeriod
+
+
+
[
+ {
+ "type" : "ENVIRONMENTAL" ,
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "dailySupplyCharges" : "string" ,
+ "timeZone" : "LOCAL" ,
+ "rateBlockUType" : "singleRate" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "generalUnitPrice" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "period" : "string"
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ],
+ "demandCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "amount" : "string" ,
+ "measureUnit" : "KWH" ,
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "days" : [
+ "SUN"
+ ],
+ "minDemand" : "string" ,
+ "maxDemand" : "string" ,
+ "measurementPeriod" : "DAY" ,
+ "chargePeriod" : "DAY"
+ }
+ ]
+ }
+ ]
+
+
+
Array of tariff periods
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+type
+string
+optional
+Type of charge. Assumed to be other if absent
+
+
+displayName
+string
+mandatory
+The name of the tariff period
+
+
+startDate
+string
+mandatory
+The start date of the tariff period in a calendar year. Formatted in mm-dd format
+
+
+endDate
+string
+mandatory
+The end date of the tariff period in a calendar year. Formatted in mm-dd format
+
+
+dailySupplyCharges
+AmountString
+optional
+The amount of access charge for the tariff period, in dollars per day exclusive of GST.
+
+
+timeZone
+string
+optional
+Specifies the charge specific time zone for calculation of the time of use thresholds. If absent, timezone value in EnergyPlanContract is assumed.
+
+
+rateBlockUType
+string
+mandatory
+Specifies the type of rate applicable to this tariff period
+
+
+singleRate
+object
+conditional
+Object representing a single rate. Required if rateBlockUType is singleRate
+
+
+» displayName
+string
+mandatory
+Display name of the rate
+
+
+» description
+string
+optional
+Description of the rate
+
+
+» generalUnitPrice
+AmountString
+conditional
+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’
+
+
+» rates
+[object]
+mandatory
+Array of controlled load rates in order of usage volume
+
+
+»» unitPrice
+AmountString
+mandatory
+Unit price of usage per measure unit (exclusive of GST)
+
+
+»» measureUnit
+string
+optional
+The measurement unit of rate. Assumed to be KWH if absent
+
+
+»» volume
+number
+optional
+Volume in kWh that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period
+
+
+» period
+ExternalRef
+optional
+Usage period for which the block rate applies. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+
+
+timeOfUseRates
+[object]
+conditional
+Array of objects representing time of use rates. Required if rateBlockUType is timeOfUseRates
+
+
+» displayName
+string
+mandatory
+Display name of the rate
+
+
+» description
+string
+optional
+Description of the rate
+
+
+» rates
+[object]
+mandatory
+Array of controlled load rates in order of usage volume
+
+
+»» unitPrice
+AmountString
+mandatory
+Unit price of usage per measure unit (exclusive of GST)
+
+
+»» measureUnit
+string
+optional
+The measurement unit of rate. Assumed to be KWH if absent
+
+
+»» volume
+number
+optional
+Volume in kWh that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period
+
+
+» timeOfUse
+[object]
+mandatory
+Array of times of use
+
+
+»» days
+[string]
+mandatory
+The days that the rate applies to
+
+
+»» startTime
+TimeString
+mandatory
+Start of the period
+
+
+»» endTime
+TimeString
+mandatory
+End of the period
+
+
+» type
+string
+mandatory
+The type of usage that the rate applies to
+
+
+demandCharges
+[object]
+conditional
+Array of demand charges. Required if rateBlockUType is demandCharges
+
+
+» displayName
+string
+mandatory
+Display name of the charge
+
+
+» description
+string
+optional
+Description of the charge
+
+
+» amount
+AmountString
+mandatory
+The charge amount per measure unit exclusive of GST
+
+
+» measureUnit
+string
+optional
+The measurement unit of charge amount. Assumed to be KWH if absent
+
+
+» startTime
+TimeString
+mandatory
+Start of the period
+
+
+» endTime
+TimeString
+mandatory
+End of the period
+
+
+» days
+[string]
+optional
+The days that the demand tariff applies to
+
+
+» minDemand
+AmountString
+optional
+Minimum demand for this demand tariff in kW. If absent then 0 is assumed
+
+
+» maxDemand
+AmountString
+optional
+Maximum demand for this demand tariff in kW. If present, must be higher than the value of the minDemand field
+
+
+» measurementPeriod
+string
+mandatory
+Application period for the demand tariff
+
+
+» chargePeriod
+string
+mandatory
+Charge period for the demand tariff
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+type
+ENVIRONMENTAL
+
+
+type
+REGULATED
+
+
+type
+NETWORK
+
+
+type
+METERING
+
+
+type
+RETAIL_SERVICE
+
+
+type
+RCTI
+
+
+type
+OTHER
+
+
+timeZone
+LOCAL
+
+
+timeZone
+AEST
+
+
+rateBlockUType
+singleRate
+
+
+rateBlockUType
+timeOfUseRates
+
+
+rateBlockUType
+demandCharges
+
+
+measureUnit
+KWH
+
+
+measureUnit
+KVA
+
+
+measureUnit
+KVAR
+
+
+measureUnit
+KVARH
+
+
+measureUnit
+KW
+
+
+measureUnit
+DAYS
+
+
+measureUnit
+METER
+
+
+measureUnit
+MONTH
+
+
+measureUnit
+KWH
+
+
+measureUnit
+KVA
+
+
+measureUnit
+KVAR
+
+
+measureUnit
+KVARH
+
+
+measureUnit
+KW
+
+
+measureUnit
+DAYS
+
+
+measureUnit
+METER
+
+
+measureUnit
+MONTH
+
+
+days
+SUN
+
+
+days
+MON
+
+
+days
+TUE
+
+
+days
+WED
+
+
+days
+THU
+
+
+days
+FRI
+
+
+days
+SAT
+
+
+days
+PUBLIC_HOLIDAYS
+
+
+type
+PEAK
+
+
+type
+OFF_PEAK
+
+
+type
+SHOULDER
+
+
+type
+SHOULDER1
+
+
+type
+SHOULDER2
+
+
+measureUnit
+KWH
+
+
+measureUnit
+KVA
+
+
+measureUnit
+KVAR
+
+
+measureUnit
+KVARH
+
+
+measureUnit
+KW
+
+
+measureUnit
+DAYS
+
+
+measureUnit
+METER
+
+
+measureUnit
+MONTH
+
+
+days
+SUN
+
+
+days
+MON
+
+
+days
+TUE
+
+
+days
+WED
+
+
+days
+THU
+
+
+days
+FRI
+
+
+days
+SAT
+
+
+days
+PUBLIC_HOLIDAYS
+
+
+measurementPeriod
+DAY
+
+
+measurementPeriod
+MONTH
+
+
+measurementPeriod
+TARIFF_PERIOD
+
+
+chargePeriod
+DAY
+
+
+chargePeriod
+MONTH
+
+
+chargePeriod
+TARIFF_PERIOD
+
+
+
+
ResponseErrorListV2
+
+
+
{
+ "errors" : [
+ {
+ "code" : "string" ,
+ "title" : "string" ,
+ "detail" : "string" ,
+ "meta" : {
+ "urn" : "string"
+ }
+ }
+ ]
+ }
+
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+errors
+[object]
+mandatory
+none
+
+
+» code
+string
+mandatory
+The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
+
+
+» title
+string
+mandatory
+A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
+
+
+» detail
+string
+mandatory
+A human-readable explanation specific to this occurrence of the problem.
+
+
+» meta
+object
+optional
+Additional data for customised error codes
+
+
+»» urn
+string
+conditional
+The CDR error code URN which the application-specific error code extends. Mandatory if the error code
is an application-specific error rather than a standardised error code.
+
+
+
+
Links
+
+
+
{
+ "self" : "string"
+ }
+
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+self
+URIString
+mandatory
+Fully qualified link that generated the current response document
+
+
+
+
+
+
+
{}
+
+
Properties
+
None
+
+
+
+
+
+
diff --git a/docs/includes/obsolete/get-generic-plan-detail-v1.html b/docs/includes/obsolete/get-generic-plan-detail-v1.html
new file mode 100644
index 00000000..0515a078
--- /dev/null
+++ b/docs/includes/obsolete/get-generic-plan-detail-v1.html
@@ -0,0 +1,4905 @@
+
+
+
+
+
+
+
+ Get Generic Plan Detail v1
+
+
+
+
+
+
+
+
+
+
+
+ NAV
+
+
+
+
+
+
+
+
+
+
+
+
Get Generic Plan Detail V1
+
This page documents version 1 of the Get Generic Plan Detail end point.
+
+
+Data Holder MUST implement Get Energy Plan Detail v2 by November 1st 2023 .
+
+
+
This version is to be ceased to be called by data recipients by September 9th 2024 and can be decommissioned by data holders as of that date.
+
Get Generic Plan Detail
+
+
+
+Code samples
+
+
GET /energy/plans/{planId} HTTP / 1.1
+
+Accept: application/json
+x-v: string
+x-min-v: string
+
+
var headers = {
+ 'Accept' : 'application/json' ,
+ 'x-v' : 'string' ,
+ 'x-min-v' : 'string'
+
+};
+
+$ . ajax ({
+ url : '/energy/plans/{planId}' ,
+ method : 'get' ,
+
+ headers : headers ,
+ success : function ( data ) {
+ console . log ( JSON . stringify ( data ));
+ }
+})
+
+
+
GET /energy/plans/{planId}
+
+
Obtain detailed information on a single energy plan offered openly to the market
+
Endpoint Version
+
+
+
+
+
+
+
+Version
+1
+
+
+
+
Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+planId
+path
+string
+mandatory
+ID of the specific plan requested
+
+
+x-v
+header
+string
+mandatory
+Version of the API end point 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+
+
+x-min-v
+header
+string
+optional
+Minimum version of the API end point 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+
+
+
+
+Example responses
+
+200 Response
+
+
{
+ "data" : {
+ "planId" : "string" ,
+ "effectiveFrom" : "string" ,
+ "effectiveTo" : "string" ,
+ "lastUpdated" : "string" ,
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "STANDING" ,
+ "fuelType" : "ELECTRICITY" ,
+ "brand" : "string" ,
+ "brandName" : "string" ,
+ "applicationUri" : "string" ,
+ "additionalInformation" : {
+ "overviewUri" : "string" ,
+ "termsUri" : "string" ,
+ "eligibilityUri" : "string" ,
+ "pricingUri" : "string" ,
+ "bundleUri" : "string"
+ },
+ "customerType" : "RESIDENTIAL" ,
+ "geography" : {
+ "excludedPostcodes" : [
+ "string"
+ ],
+ "includedPostcodes" : [
+ "string"
+ ],
+ "distributors" : [
+ "string"
+ ]
+ },
+ "meteringCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "minimumValue" : "string" ,
+ "maximumValue" : "string" ,
+ "period" : "string"
+ }
+ ],
+ "gasContract" : {
+ "additionalFeeInformation" : "string" ,
+ "pricingModel" : "SINGLE_RATE" ,
+ "timeZone" : "LOCAL" ,
+ "isFixed" : true ,
+ "variation" : "string" ,
+ "onExpiryDescription" : "string" ,
+ "paymentOption" : [
+ "PAPER_BILL"
+ ],
+ "intrinsicGreenPower" : {
+ "greenPercentage" : "string"
+ },
+ "controlledLoad" : [
+ {
+ "displayName" : "string" ,
+ "rateBlockUType" : "singleRate" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "additionalInfo" : "string" ,
+ "additionalInfoUri" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ]
+ }
+ ],
+ "incentives" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "category" : "GIFT" ,
+ "eligibility" : "string"
+ }
+ ],
+ "discounts" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "CONDITIONAL" ,
+ "category" : "PAY_ON_TIME" ,
+ "endDate" : "string" ,
+ "methodUType" : "percentOfBill" ,
+ "percentOfBill" : {
+ "rate" : "string"
+ },
+ "percentOfUse" : {
+ "rate" : "string"
+ },
+ "fixedAmount" : {
+ "amount" : "string"
+ },
+ "percentOverThreshold" : {
+ "rate" : "string" ,
+ "usageAmount" : "string"
+ }
+ }
+ ],
+ "greenPowerCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "GREENPOWER" ,
+ "type" : "FIXED_PER_DAY" ,
+ "tiers" : [
+ {
+ "percentGreen" : "string" ,
+ "rate" : "string" ,
+ "amount" : "string"
+ }
+ ]
+ }
+ ],
+ "eligibility" : [
+ {
+ "type" : "EXISTING_CUST" ,
+ "information" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "fees" : [
+ {
+ "type" : "EXIT" ,
+ "term" : "FIXED" ,
+ "amount" : "string" ,
+ "rate" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "solarFeedInTariff" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "PREMIUM" ,
+ "payerType" : "GOVERNMENT" ,
+ "tariffUType" : "singleTariff" ,
+ "singleTariff" : {
+ "amount" : "string"
+ },
+ "timeVaryingTariffs" : {
+ "type" : "PEAK" ,
+ "amount" : "string" ,
+ "timeVariations" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ]
+ }
+ }
+ ],
+ "tariffPeriod" : [
+ {
+ "type" : "ENVIRONMENTAL" ,
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "dailySupplyCharges" : "string" ,
+ "timeZone" : "LOCAL" ,
+ "rateBlockUType" : "singleRate" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "generalUnitPrice" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "period" : "string"
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ],
+ "demandCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "amount" : "string" ,
+ "measureUnit" : "KWH" ,
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "days" : [
+ "SUN"
+ ],
+ "minDemand" : "string" ,
+ "maxDemand" : "string" ,
+ "measurementPeriod" : "DAY" ,
+ "chargePeriod" : "DAY"
+ }
+ ]
+ }
+ ],
+ "termType" : "1_YEAR" ,
+ "benefitPeriod" : "string" ,
+ "terms" : "string" ,
+ "meterTypes" : [
+ "string"
+ ],
+ "coolingOffDays" : 0 ,
+ "billFrequency" : [
+ "string"
+ ]
+ },
+ "electricityContract" : {
+ "additionalFeeInformation" : "string" ,
+ "pricingModel" : "SINGLE_RATE" ,
+ "timeZone" : "LOCAL" ,
+ "isFixed" : true ,
+ "variation" : "string" ,
+ "onExpiryDescription" : "string" ,
+ "paymentOption" : [
+ "PAPER_BILL"
+ ],
+ "intrinsicGreenPower" : {
+ "greenPercentage" : "string"
+ },
+ "controlledLoad" : [
+ {
+ "displayName" : "string" ,
+ "rateBlockUType" : "singleRate" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "additionalInfo" : "string" ,
+ "additionalInfoUri" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ]
+ }
+ ],
+ "incentives" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "category" : "GIFT" ,
+ "eligibility" : "string"
+ }
+ ],
+ "discounts" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "CONDITIONAL" ,
+ "category" : "PAY_ON_TIME" ,
+ "endDate" : "string" ,
+ "methodUType" : "percentOfBill" ,
+ "percentOfBill" : {
+ "rate" : "string"
+ },
+ "percentOfUse" : {
+ "rate" : "string"
+ },
+ "fixedAmount" : {
+ "amount" : "string"
+ },
+ "percentOverThreshold" : {
+ "rate" : "string" ,
+ "usageAmount" : "string"
+ }
+ }
+ ],
+ "greenPowerCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "GREENPOWER" ,
+ "type" : "FIXED_PER_DAY" ,
+ "tiers" : [
+ {
+ "percentGreen" : "string" ,
+ "rate" : "string" ,
+ "amount" : "string"
+ }
+ ]
+ }
+ ],
+ "eligibility" : [
+ {
+ "type" : "EXISTING_CUST" ,
+ "information" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "fees" : [
+ {
+ "type" : "EXIT" ,
+ "term" : "FIXED" ,
+ "amount" : "string" ,
+ "rate" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "solarFeedInTariff" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "PREMIUM" ,
+ "payerType" : "GOVERNMENT" ,
+ "tariffUType" : "singleTariff" ,
+ "singleTariff" : {
+ "amount" : "string"
+ },
+ "timeVaryingTariffs" : {
+ "type" : "PEAK" ,
+ "amount" : "string" ,
+ "timeVariations" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ]
+ }
+ }
+ ],
+ "tariffPeriod" : [
+ {
+ "type" : "ENVIRONMENTAL" ,
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "dailySupplyCharges" : "string" ,
+ "timeZone" : "LOCAL" ,
+ "rateBlockUType" : "singleRate" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "generalUnitPrice" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "period" : "string"
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ],
+ "demandCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "amount" : "string" ,
+ "measureUnit" : "KWH" ,
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "days" : [
+ "SUN"
+ ],
+ "minDemand" : "string" ,
+ "maxDemand" : "string" ,
+ "measurementPeriod" : "DAY" ,
+ "chargePeriod" : "DAY"
+ }
+ ]
+ }
+ ],
+ "termType" : "1_YEAR" ,
+ "benefitPeriod" : "string" ,
+ "terms" : "string" ,
+ "meterTypes" : [
+ "string"
+ ],
+ "coolingOffDays" : 0 ,
+ "billFrequency" : [
+ "string"
+ ]
+ }
+ },
+ "links" : {
+ "self" : "string"
+ },
+ "meta" : {}
+ }
+
+
Responses
+
+
+
+
+
+Status
+Header
+Type
+Format
+Description
+
+
+
+200
+x-v
+string
+
+The version of the API end point that the data holder has responded with.
+
+
+400
+x-fapi-interaction-id
+string
+
+An [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] UUID value is required to be provided in the response header to track the interaction.
+
+
+404
+x-fapi-interaction-id
+string
+
+An [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] UUID value is required to be provided in the response header to track the interaction.
+
+
+406
+x-fapi-interaction-id
+string
+
+An [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] UUID value is required to be provided in the response header to track the interaction.
+
+
+
+
+This operation does not require authentication
+
+
+
EnergyPlanResponse
+
+
+
{
+ "data" : {
+ "planId" : "string" ,
+ "effectiveFrom" : "string" ,
+ "effectiveTo" : "string" ,
+ "lastUpdated" : "string" ,
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "STANDING" ,
+ "fuelType" : "ELECTRICITY" ,
+ "brand" : "string" ,
+ "brandName" : "string" ,
+ "applicationUri" : "string" ,
+ "additionalInformation" : {
+ "overviewUri" : "string" ,
+ "termsUri" : "string" ,
+ "eligibilityUri" : "string" ,
+ "pricingUri" : "string" ,
+ "bundleUri" : "string"
+ },
+ "customerType" : "RESIDENTIAL" ,
+ "geography" : {
+ "excludedPostcodes" : [
+ "string"
+ ],
+ "includedPostcodes" : [
+ "string"
+ ],
+ "distributors" : [
+ "string"
+ ]
+ },
+ "meteringCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "minimumValue" : "string" ,
+ "maximumValue" : "string" ,
+ "period" : "string"
+ }
+ ],
+ "gasContract" : {
+ "additionalFeeInformation" : "string" ,
+ "pricingModel" : "SINGLE_RATE" ,
+ "timeZone" : "LOCAL" ,
+ "isFixed" : true ,
+ "variation" : "string" ,
+ "onExpiryDescription" : "string" ,
+ "paymentOption" : [
+ "PAPER_BILL"
+ ],
+ "intrinsicGreenPower" : {
+ "greenPercentage" : "string"
+ },
+ "controlledLoad" : [
+ {
+ "displayName" : "string" ,
+ "rateBlockUType" : "singleRate" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "additionalInfo" : "string" ,
+ "additionalInfoUri" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ]
+ }
+ ],
+ "incentives" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "category" : "GIFT" ,
+ "eligibility" : "string"
+ }
+ ],
+ "discounts" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "CONDITIONAL" ,
+ "category" : "PAY_ON_TIME" ,
+ "endDate" : "string" ,
+ "methodUType" : "percentOfBill" ,
+ "percentOfBill" : {
+ "rate" : "string"
+ },
+ "percentOfUse" : {
+ "rate" : "string"
+ },
+ "fixedAmount" : {
+ "amount" : "string"
+ },
+ "percentOverThreshold" : {
+ "rate" : "string" ,
+ "usageAmount" : "string"
+ }
+ }
+ ],
+ "greenPowerCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "GREENPOWER" ,
+ "type" : "FIXED_PER_DAY" ,
+ "tiers" : [
+ {
+ "percentGreen" : "string" ,
+ "rate" : "string" ,
+ "amount" : "string"
+ }
+ ]
+ }
+ ],
+ "eligibility" : [
+ {
+ "type" : "EXISTING_CUST" ,
+ "information" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "fees" : [
+ {
+ "type" : "EXIT" ,
+ "term" : "FIXED" ,
+ "amount" : "string" ,
+ "rate" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "solarFeedInTariff" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "PREMIUM" ,
+ "payerType" : "GOVERNMENT" ,
+ "tariffUType" : "singleTariff" ,
+ "singleTariff" : {
+ "amount" : "string"
+ },
+ "timeVaryingTariffs" : {
+ "type" : "PEAK" ,
+ "amount" : "string" ,
+ "timeVariations" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ]
+ }
+ }
+ ],
+ "tariffPeriod" : [
+ {
+ "type" : "ENVIRONMENTAL" ,
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "dailySupplyCharges" : "string" ,
+ "timeZone" : "LOCAL" ,
+ "rateBlockUType" : "singleRate" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "generalUnitPrice" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "period" : "string"
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ],
+ "demandCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "amount" : "string" ,
+ "measureUnit" : "KWH" ,
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "days" : [
+ "SUN"
+ ],
+ "minDemand" : "string" ,
+ "maxDemand" : "string" ,
+ "measurementPeriod" : "DAY" ,
+ "chargePeriod" : "DAY"
+ }
+ ]
+ }
+ ],
+ "termType" : "1_YEAR" ,
+ "benefitPeriod" : "string" ,
+ "terms" : "string" ,
+ "meterTypes" : [
+ "string"
+ ],
+ "coolingOffDays" : 0 ,
+ "billFrequency" : [
+ "string"
+ ]
+ },
+ "electricityContract" : {
+ "additionalFeeInformation" : "string" ,
+ "pricingModel" : "SINGLE_RATE" ,
+ "timeZone" : "LOCAL" ,
+ "isFixed" : true ,
+ "variation" : "string" ,
+ "onExpiryDescription" : "string" ,
+ "paymentOption" : [
+ "PAPER_BILL"
+ ],
+ "intrinsicGreenPower" : {
+ "greenPercentage" : "string"
+ },
+ "controlledLoad" : [
+ {
+ "displayName" : "string" ,
+ "rateBlockUType" : "singleRate" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "additionalInfo" : "string" ,
+ "additionalInfoUri" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ]
+ }
+ ],
+ "incentives" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "category" : "GIFT" ,
+ "eligibility" : "string"
+ }
+ ],
+ "discounts" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "CONDITIONAL" ,
+ "category" : "PAY_ON_TIME" ,
+ "endDate" : "string" ,
+ "methodUType" : "percentOfBill" ,
+ "percentOfBill" : {
+ "rate" : "string"
+ },
+ "percentOfUse" : {
+ "rate" : "string"
+ },
+ "fixedAmount" : {
+ "amount" : "string"
+ },
+ "percentOverThreshold" : {
+ "rate" : "string" ,
+ "usageAmount" : "string"
+ }
+ }
+ ],
+ "greenPowerCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "GREENPOWER" ,
+ "type" : "FIXED_PER_DAY" ,
+ "tiers" : [
+ {
+ "percentGreen" : "string" ,
+ "rate" : "string" ,
+ "amount" : "string"
+ }
+ ]
+ }
+ ],
+ "eligibility" : [
+ {
+ "type" : "EXISTING_CUST" ,
+ "information" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "fees" : [
+ {
+ "type" : "EXIT" ,
+ "term" : "FIXED" ,
+ "amount" : "string" ,
+ "rate" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "solarFeedInTariff" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "PREMIUM" ,
+ "payerType" : "GOVERNMENT" ,
+ "tariffUType" : "singleTariff" ,
+ "singleTariff" : {
+ "amount" : "string"
+ },
+ "timeVaryingTariffs" : {
+ "type" : "PEAK" ,
+ "amount" : "string" ,
+ "timeVariations" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ]
+ }
+ }
+ ],
+ "tariffPeriod" : [
+ {
+ "type" : "ENVIRONMENTAL" ,
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "dailySupplyCharges" : "string" ,
+ "timeZone" : "LOCAL" ,
+ "rateBlockUType" : "singleRate" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "generalUnitPrice" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "period" : "string"
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ],
+ "demandCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "amount" : "string" ,
+ "measureUnit" : "KWH" ,
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "days" : [
+ "SUN"
+ ],
+ "minDemand" : "string" ,
+ "maxDemand" : "string" ,
+ "measurementPeriod" : "DAY" ,
+ "chargePeriod" : "DAY"
+ }
+ ]
+ }
+ ],
+ "termType" : "1_YEAR" ,
+ "benefitPeriod" : "string" ,
+ "terms" : "string" ,
+ "meterTypes" : [
+ "string"
+ ],
+ "coolingOffDays" : 0 ,
+ "billFrequency" : [
+ "string"
+ ]
+ }
+ },
+ "links" : {
+ "self" : "string"
+ },
+ "meta" : {}
+ }
+
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+data
+EnergyPlanDetail
+mandatory
+none
+
+
+links
+Links
+mandatory
+none
+
+
+meta
+Meta
+optional
+none
+
+
+
+
EnergyPlanDetail
+
+
+
{
+ "planId" : "string" ,
+ "effectiveFrom" : "string" ,
+ "effectiveTo" : "string" ,
+ "lastUpdated" : "string" ,
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "STANDING" ,
+ "fuelType" : "ELECTRICITY" ,
+ "brand" : "string" ,
+ "brandName" : "string" ,
+ "applicationUri" : "string" ,
+ "additionalInformation" : {
+ "overviewUri" : "string" ,
+ "termsUri" : "string" ,
+ "eligibilityUri" : "string" ,
+ "pricingUri" : "string" ,
+ "bundleUri" : "string"
+ },
+ "customerType" : "RESIDENTIAL" ,
+ "geography" : {
+ "excludedPostcodes" : [
+ "string"
+ ],
+ "includedPostcodes" : [
+ "string"
+ ],
+ "distributors" : [
+ "string"
+ ]
+ },
+ "meteringCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "minimumValue" : "string" ,
+ "maximumValue" : "string" ,
+ "period" : "string"
+ }
+ ],
+ "gasContract" : {
+ "additionalFeeInformation" : "string" ,
+ "pricingModel" : "SINGLE_RATE" ,
+ "timeZone" : "LOCAL" ,
+ "isFixed" : true ,
+ "variation" : "string" ,
+ "onExpiryDescription" : "string" ,
+ "paymentOption" : [
+ "PAPER_BILL"
+ ],
+ "intrinsicGreenPower" : {
+ "greenPercentage" : "string"
+ },
+ "controlledLoad" : [
+ {
+ "displayName" : "string" ,
+ "rateBlockUType" : "singleRate" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "additionalInfo" : "string" ,
+ "additionalInfoUri" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ]
+ }
+ ],
+ "incentives" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "category" : "GIFT" ,
+ "eligibility" : "string"
+ }
+ ],
+ "discounts" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "CONDITIONAL" ,
+ "category" : "PAY_ON_TIME" ,
+ "endDate" : "string" ,
+ "methodUType" : "percentOfBill" ,
+ "percentOfBill" : {
+ "rate" : "string"
+ },
+ "percentOfUse" : {
+ "rate" : "string"
+ },
+ "fixedAmount" : {
+ "amount" : "string"
+ },
+ "percentOverThreshold" : {
+ "rate" : "string" ,
+ "usageAmount" : "string"
+ }
+ }
+ ],
+ "greenPowerCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "GREENPOWER" ,
+ "type" : "FIXED_PER_DAY" ,
+ "tiers" : [
+ {
+ "percentGreen" : "string" ,
+ "rate" : "string" ,
+ "amount" : "string"
+ }
+ ]
+ }
+ ],
+ "eligibility" : [
+ {
+ "type" : "EXISTING_CUST" ,
+ "information" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "fees" : [
+ {
+ "type" : "EXIT" ,
+ "term" : "FIXED" ,
+ "amount" : "string" ,
+ "rate" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "solarFeedInTariff" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "PREMIUM" ,
+ "payerType" : "GOVERNMENT" ,
+ "tariffUType" : "singleTariff" ,
+ "singleTariff" : {
+ "amount" : "string"
+ },
+ "timeVaryingTariffs" : {
+ "type" : "PEAK" ,
+ "amount" : "string" ,
+ "timeVariations" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ]
+ }
+ }
+ ],
+ "tariffPeriod" : [
+ {
+ "type" : "ENVIRONMENTAL" ,
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "dailySupplyCharges" : "string" ,
+ "timeZone" : "LOCAL" ,
+ "rateBlockUType" : "singleRate" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "generalUnitPrice" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "period" : "string"
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ],
+ "demandCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "amount" : "string" ,
+ "measureUnit" : "KWH" ,
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "days" : [
+ "SUN"
+ ],
+ "minDemand" : "string" ,
+ "maxDemand" : "string" ,
+ "measurementPeriod" : "DAY" ,
+ "chargePeriod" : "DAY"
+ }
+ ]
+ }
+ ],
+ "termType" : "1_YEAR" ,
+ "benefitPeriod" : "string" ,
+ "terms" : "string" ,
+ "meterTypes" : [
+ "string"
+ ],
+ "coolingOffDays" : 0 ,
+ "billFrequency" : [
+ "string"
+ ]
+ },
+ "electricityContract" : {
+ "additionalFeeInformation" : "string" ,
+ "pricingModel" : "SINGLE_RATE" ,
+ "timeZone" : "LOCAL" ,
+ "isFixed" : true ,
+ "variation" : "string" ,
+ "onExpiryDescription" : "string" ,
+ "paymentOption" : [
+ "PAPER_BILL"
+ ],
+ "intrinsicGreenPower" : {
+ "greenPercentage" : "string"
+ },
+ "controlledLoad" : [
+ {
+ "displayName" : "string" ,
+ "rateBlockUType" : "singleRate" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "additionalInfo" : "string" ,
+ "additionalInfoUri" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ]
+ }
+ ],
+ "incentives" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "category" : "GIFT" ,
+ "eligibility" : "string"
+ }
+ ],
+ "discounts" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "CONDITIONAL" ,
+ "category" : "PAY_ON_TIME" ,
+ "endDate" : "string" ,
+ "methodUType" : "percentOfBill" ,
+ "percentOfBill" : {
+ "rate" : "string"
+ },
+ "percentOfUse" : {
+ "rate" : "string"
+ },
+ "fixedAmount" : {
+ "amount" : "string"
+ },
+ "percentOverThreshold" : {
+ "rate" : "string" ,
+ "usageAmount" : "string"
+ }
+ }
+ ],
+ "greenPowerCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "GREENPOWER" ,
+ "type" : "FIXED_PER_DAY" ,
+ "tiers" : [
+ {
+ "percentGreen" : "string" ,
+ "rate" : "string" ,
+ "amount" : "string"
+ }
+ ]
+ }
+ ],
+ "eligibility" : [
+ {
+ "type" : "EXISTING_CUST" ,
+ "information" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "fees" : [
+ {
+ "type" : "EXIT" ,
+ "term" : "FIXED" ,
+ "amount" : "string" ,
+ "rate" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "solarFeedInTariff" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "PREMIUM" ,
+ "payerType" : "GOVERNMENT" ,
+ "tariffUType" : "singleTariff" ,
+ "singleTariff" : {
+ "amount" : "string"
+ },
+ "timeVaryingTariffs" : {
+ "type" : "PEAK" ,
+ "amount" : "string" ,
+ "timeVariations" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ]
+ }
+ }
+ ],
+ "tariffPeriod" : [
+ {
+ "type" : "ENVIRONMENTAL" ,
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "dailySupplyCharges" : "string" ,
+ "timeZone" : "LOCAL" ,
+ "rateBlockUType" : "singleRate" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "generalUnitPrice" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "period" : "string"
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ],
+ "demandCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "amount" : "string" ,
+ "measureUnit" : "KWH" ,
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "days" : [
+ "SUN"
+ ],
+ "minDemand" : "string" ,
+ "maxDemand" : "string" ,
+ "measurementPeriod" : "DAY" ,
+ "chargePeriod" : "DAY"
+ }
+ ]
+ }
+ ],
+ "termType" : "1_YEAR" ,
+ "benefitPeriod" : "string" ,
+ "terms" : "string" ,
+ "meterTypes" : [
+ "string"
+ ],
+ "coolingOffDays" : 0 ,
+ "billFrequency" : [
+ "string"
+ ]
+ }
+ }
+
+
Properties
+
allOf
+
+
+
+Name
+Type
+Required
+Description
+
+
+
+anonymous
+EnergyPlan
+mandatory
+none
+
+
+
+
and
+
+
+
+Name
+Type
+Required
+Description
+
+
+
+anonymous
+object
+mandatory
+none
+
+
+» meteringCharges
+[object]
+optional
+Charges for metering included in the plan
+
+
+»» displayName
+string
+mandatory
+Display name of the charge
+
+
+»» description
+string
+optional
+Description of the charge
+
+
+»» minimumValue
+AmountString
+mandatory
+Minimum value of the charge if the charge is a range or the absolute value of the charge if no range is specified
+
+
+»» maximumValue
+AmountString
+optional
+The upper limit of the charge if the charge could occur in a range
+
+
+»» period
+ExternalRef
+optional
+The charges that occur on a schedule indicates the frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+
+
+» gasContract
+EnergyPlanContractFull
+conditional
+The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to GAS or DUAL
+
+
+» electricityContract
+EnergyPlanContractFull
+conditional
+The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to ELECTRICITY or DUAL
+
+
+
+
EnergyPlan
+
+
+
{
+ "planId" : "string" ,
+ "effectiveFrom" : "string" ,
+ "effectiveTo" : "string" ,
+ "lastUpdated" : "string" ,
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "STANDING" ,
+ "fuelType" : "ELECTRICITY" ,
+ "brand" : "string" ,
+ "brandName" : "string" ,
+ "applicationUri" : "string" ,
+ "additionalInformation" : {
+ "overviewUri" : "string" ,
+ "termsUri" : "string" ,
+ "eligibilityUri" : "string" ,
+ "pricingUri" : "string" ,
+ "bundleUri" : "string"
+ },
+ "customerType" : "RESIDENTIAL" ,
+ "geography" : {
+ "excludedPostcodes" : [
+ "string"
+ ],
+ "includedPostcodes" : [
+ "string"
+ ],
+ "distributors" : [
+ "string"
+ ]
+ }
+ }
+
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+planId
+ASCIIString
+mandatory
+The ID of the specific plan
+
+
+effectiveFrom
+DateTimeString
+optional
+The date and time from which this plan 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
+
+
+effectiveTo
+DateTimeString
+optional
+The date and time at which this plan will be retired and will no longer be offered. Used to enable the managed deprecation of plans
+
+
+lastUpdated
+DateTimeString
+mandatory
+The last date and time that the information for this plan was changed (or the creation date for the plan if it has never been altered)
+
+
+displayName
+string
+optional
+The display name of the plan
+
+
+description
+string
+optional
+A description of the plan
+
+
+type
+string
+mandatory
+The type of the plan
+
+
+fuelType
+string
+mandatory
+The fuel types covered by the plan
+
+
+brand
+ASCIIString
+mandatory
+The ID of the brand under which this plan is offered
+
+
+brandName
+string
+mandatory
+The display name of the brand under which this plan is offered
+
+
+applicationUri
+URIString
+optional
+A link to an application web page where this plan can be applied for
+
+
+additionalInformation
+object
+optional
+Object that contains links to additional information on specific topics
+
+
+» overviewUri
+URIString
+optional
+A link to a general overview of the plan
+
+
+» termsUri
+URIString
+optional
+A link to terms and conditions for the plan
+
+
+» eligibilityUri
+URIString
+optional
+A link to detail on eligibility criteria for the plan
+
+
+» pricingUri
+URIString
+optional
+A link to detail on pricing for the plan
+
+
+» bundleUri
+URIString
+optional
+A link to detail on bundles that this plan can be a part of
+
+
+customerType
+string
+optional
+The type of customer that the plan is offered to. If absent then the plan is available to all customers
+
+
+geography
+object
+optional
+Describes the geographical area that the plan is available for. If absent then it is assumed the plan is not geographically limited
+
+
+» excludedPostcodes
+[string]
+optional
+Array of valid Australian post codes that are specifically excluded from the plan. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999)
+
+
+» includedPostcodes
+[string]
+optional
+Array of valid Australian post codes that are included from the plan. If absent defaults to all non-excluded post codes. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999)
+
+
+» distributors
+[string]
+mandatory
+Array of distributors for the plan. Must have at least one entry
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+type
+STANDING
+
+
+type
+MARKET
+
+
+type
+REGULATED
+
+
+fuelType
+ELECTRICITY
+
+
+fuelType
+GAS
+
+
+fuelType
+DUAL
+
+
+customerType
+RESIDENTIAL
+
+
+customerType
+BUSINESS
+
+
+
+
EnergyPlanContractFull
+
+
+
{
+ "additionalFeeInformation" : "string" ,
+ "pricingModel" : "SINGLE_RATE" ,
+ "timeZone" : "LOCAL" ,
+ "isFixed" : true ,
+ "variation" : "string" ,
+ "onExpiryDescription" : "string" ,
+ "paymentOption" : [
+ "PAPER_BILL"
+ ],
+ "intrinsicGreenPower" : {
+ "greenPercentage" : "string"
+ },
+ "controlledLoad" : [
+ {
+ "displayName" : "string" ,
+ "rateBlockUType" : "singleRate" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "additionalInfo" : "string" ,
+ "additionalInfoUri" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ]
+ }
+ ],
+ "incentives" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "category" : "GIFT" ,
+ "eligibility" : "string"
+ }
+ ],
+ "discounts" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "CONDITIONAL" ,
+ "category" : "PAY_ON_TIME" ,
+ "endDate" : "string" ,
+ "methodUType" : "percentOfBill" ,
+ "percentOfBill" : {
+ "rate" : "string"
+ },
+ "percentOfUse" : {
+ "rate" : "string"
+ },
+ "fixedAmount" : {
+ "amount" : "string"
+ },
+ "percentOverThreshold" : {
+ "rate" : "string" ,
+ "usageAmount" : "string"
+ }
+ }
+ ],
+ "greenPowerCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "GREENPOWER" ,
+ "type" : "FIXED_PER_DAY" ,
+ "tiers" : [
+ {
+ "percentGreen" : "string" ,
+ "rate" : "string" ,
+ "amount" : "string"
+ }
+ ]
+ }
+ ],
+ "eligibility" : [
+ {
+ "type" : "EXISTING_CUST" ,
+ "information" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "fees" : [
+ {
+ "type" : "EXIT" ,
+ "term" : "FIXED" ,
+ "amount" : "string" ,
+ "rate" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "solarFeedInTariff" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "PREMIUM" ,
+ "payerType" : "GOVERNMENT" ,
+ "tariffUType" : "singleTariff" ,
+ "singleTariff" : {
+ "amount" : "string"
+ },
+ "timeVaryingTariffs" : {
+ "type" : "PEAK" ,
+ "amount" : "string" ,
+ "timeVariations" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ]
+ }
+ }
+ ],
+ "tariffPeriod" : [
+ {
+ "type" : "ENVIRONMENTAL" ,
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "dailySupplyCharges" : "string" ,
+ "timeZone" : "LOCAL" ,
+ "rateBlockUType" : "singleRate" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "generalUnitPrice" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "period" : "string"
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ],
+ "demandCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "amount" : "string" ,
+ "measureUnit" : "KWH" ,
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "days" : [
+ "SUN"
+ ],
+ "minDemand" : "string" ,
+ "maxDemand" : "string" ,
+ "measurementPeriod" : "DAY" ,
+ "chargePeriod" : "DAY"
+ }
+ ]
+ }
+ ],
+ "termType" : "1_YEAR" ,
+ "benefitPeriod" : "string" ,
+ "terms" : "string" ,
+ "meterTypes" : [
+ "string"
+ ],
+ "coolingOffDays" : 0 ,
+ "billFrequency" : [
+ "string"
+ ]
+ }
+
+
Properties
+
allOf
+
+
+
+Name
+Type
+Required
+Description
+
+
+
+anonymous
+EnergyPlanContract
+mandatory
+none
+
+
+
+
and
+
+
+
+Name
+Type
+Required
+Description
+
+
+
+anonymous
+object
+mandatory
+none
+
+
+» termType
+string
+optional
+The term for the contract. If absent assumes no specified term
+
+
+» benefitPeriod
+string
+conditional
+Description of the benefit period. Should only be present if termType has the value ONGOING
+
+
+» terms
+string
+optional
+Free text description of the terms for the contract
+
+
+» meterTypes
+[string]
+optional
+An array of the meter types that this contract is available for
+
+
+» coolingOffDays
+PositiveInteger
+conditional
+Number of days in the cooling off period for the contract. Mandatory for plans with type of MARKET
+
+
+» billFrequency
+[string]
+mandatory
+An array of the available billing schedules for this contract. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+termType
+1_YEAR
+
+
+termType
+2_YEAR
+
+
+termType
+3_YEAR
+
+
+termType
+4_YEAR
+
+
+termType
+5_YEAR
+
+
+termType
+ONGOING
+
+
+termType
+OTHER
+
+
+
+
EnergyPlanContract
+
+
+
{
+ "additionalFeeInformation" : "string" ,
+ "pricingModel" : "SINGLE_RATE" ,
+ "timeZone" : "LOCAL" ,
+ "isFixed" : true ,
+ "variation" : "string" ,
+ "onExpiryDescription" : "string" ,
+ "paymentOption" : [
+ "PAPER_BILL"
+ ],
+ "intrinsicGreenPower" : {
+ "greenPercentage" : "string"
+ },
+ "controlledLoad" : [
+ {
+ "displayName" : "string" ,
+ "rateBlockUType" : "singleRate" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "additionalInfo" : "string" ,
+ "additionalInfoUri" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ]
+ }
+ ],
+ "incentives" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "category" : "GIFT" ,
+ "eligibility" : "string"
+ }
+ ],
+ "discounts" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "CONDITIONAL" ,
+ "category" : "PAY_ON_TIME" ,
+ "endDate" : "string" ,
+ "methodUType" : "percentOfBill" ,
+ "percentOfBill" : {
+ "rate" : "string"
+ },
+ "percentOfUse" : {
+ "rate" : "string"
+ },
+ "fixedAmount" : {
+ "amount" : "string"
+ },
+ "percentOverThreshold" : {
+ "rate" : "string" ,
+ "usageAmount" : "string"
+ }
+ }
+ ],
+ "greenPowerCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "GREENPOWER" ,
+ "type" : "FIXED_PER_DAY" ,
+ "tiers" : [
+ {
+ "percentGreen" : "string" ,
+ "rate" : "string" ,
+ "amount" : "string"
+ }
+ ]
+ }
+ ],
+ "eligibility" : [
+ {
+ "type" : "EXISTING_CUST" ,
+ "information" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "fees" : [
+ {
+ "type" : "EXIT" ,
+ "term" : "FIXED" ,
+ "amount" : "string" ,
+ "rate" : "string" ,
+ "description" : "string"
+ }
+ ],
+ "solarFeedInTariff" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "PREMIUM" ,
+ "payerType" : "GOVERNMENT" ,
+ "tariffUType" : "singleTariff" ,
+ "singleTariff" : {
+ "amount" : "string"
+ },
+ "timeVaryingTariffs" : {
+ "type" : "PEAK" ,
+ "amount" : "string" ,
+ "timeVariations" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ]
+ }
+ }
+ ],
+ "tariffPeriod" : [
+ {
+ "type" : "ENVIRONMENTAL" ,
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "dailySupplyCharges" : "string" ,
+ "timeZone" : "LOCAL" ,
+ "rateBlockUType" : "singleRate" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "generalUnitPrice" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "period" : "string"
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ],
+ "demandCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "amount" : "string" ,
+ "measureUnit" : "KWH" ,
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "days" : [
+ "SUN"
+ ],
+ "minDemand" : "string" ,
+ "maxDemand" : "string" ,
+ "measurementPeriod" : "DAY" ,
+ "chargePeriod" : "DAY"
+ }
+ ]
+ }
+ ]
+ }
+
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+additionalFeeInformation
+string
+optional
+Free text field containing additional information of the fees for this contract
+
+
+pricingModel
+string
+mandatory
+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 above, 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 consumedTIME_OF_USE_CONT_LOAD - as above, 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 factorsFLEXIBLE_CONT_LOAD - as above, 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
+
+
+timeZone
+string
+conditional
+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
+
+
+isFixed
+boolean
+mandatory
+Flag indicating whether prices are fixed or variable
+
+
+variation
+string
+conditional
+Free text description of price variation policy and conditions for the contract. Mandatory if isFixed
is false
+
+
+onExpiryDescription
+string
+optional
+Free text field that describes what will occur on or prior to expiry of the fixed contract term or benefit period
+
+
+paymentOption
+[string]
+mandatory
+Payment options for this contract
+
+
+intrinsicGreenPower
+object
+optional
+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
+
+
+» greenPercentage
+RateString
+mandatory
+Percentage of green power intrinsically included in the plan
+
+
+controlledLoad
+EnergyPlanControlledLoad
+conditional
+Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD
+
+
+incentives
+EnergyPlanIncentives
+optional
+Optional list of incentives available for the contract
+
+
+discounts
+EnergyPlanDiscounts
+optional
+Optional list of discounts available for the contract
+
+
+greenPowerCharges
+EnergyPlanGreenPowerCharges
+optional
+Optional list of charges applicable to green power
+
+
+eligibility
+EnergyPlanEligibility
+optional
+Eligibility restrictions or requirements
+
+
+fees
+EnergyPlanFees
+optional
+An array of fees applicable to the plan
+
+
+solarFeedInTariff
+EnergyPlanSolarFeedInTariff
+optional
+Array of feed in tariffs for solar power
+
+
+tariffPeriod
+EnergyPlanTariffPeriod
+mandatory
+Array of tariff periods
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+pricingModel
+SINGLE_RATE
+
+
+pricingModel
+SINGLE_RATE_CONT_LOAD
+
+
+pricingModel
+TIME_OF_USE
+
+
+pricingModel
+TIME_OF_USE_CONT_LOAD
+
+
+pricingModel
+FLEXIBLE
+
+
+pricingModel
+FLEXIBLE_CONT_LOAD
+
+
+pricingModel
+QUOTA
+
+
+timeZone
+LOCAL
+
+
+timeZone
+AEST
+
+
+paymentOption
+PAPER_BILL
+
+
+paymentOption
+CREDIT_CARD
+
+
+paymentOption
+DIRECT_DEBIT
+
+
+paymentOption
+BPAY
+
+
+paymentOption
+OTHER
+
+
+
+
EnergyPlanControlledLoad
+
+
+
[
+ {
+ "displayName" : "string" ,
+ "rateBlockUType" : "singleRate" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "dailySupplyCharge" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "additionalInfo" : "string" ,
+ "additionalInfoUri" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ]
+ }
+ ]
+
+
+
Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+displayName
+string
+mandatory
+A display name for the controlled load
+
+
+rateBlockUType
+string
+mandatory
+Specifies the type of controlloed load rate
+
+
+startDate
+DateString
+optional
+Optional start date of the application of the controlled load rate
+
+
+endDate
+DateString
+optional
+Optional end date of the application of the controlled load rate
+
+
+singleRate
+object
+conditional
+Object representing a single controlled load rate. Required if rateBlockUType is singleRate
+
+
+» displayName
+string
+mandatory
+Display name of the controlled load rate
+
+
+» description
+string
+optional
+Description of the controlled load rate
+
+
+» dailySupplyCharge
+AmountString
+optional
+The daily supply charge (exclusive of GST) for this controlled load tier
+
+
+» rates
+[object]
+mandatory
+Array of controlled load rates in order of usage volume
+
+
+»» unitPrice
+AmountString
+mandatory
+Unit price of usage per measure unit (exclusive of GST)
+
+
+»» measureUnit
+string
+optional
+The measurement unit of rate. Assumed to be KWH if absent
+
+
+»» volume
+number
+optional
+Volume in kWh that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period
+
+
+» timeOfUseRates
+[object]
+conditional
+Array of objects representing time of use rates. Required if rateBlockUType is timeOfUseRates
+
+
+»» displayName
+string
+mandatory
+Display name of the controlled load rate
+
+
+»» description
+string
+optional
+Description of the controlled load rate
+
+
+»» dailySupplyCharge
+AmountString
+optional
+The daily supply charge (exclusive of GST) for this controlled load tier
+
+
+»» rates
+[object]
+mandatory
+Array of controlled load rates in order of usage volume
+
+
+»»» unitPrice
+AmountString
+mandatory
+Unit price of usage per measure unit (exclusive of GST)
+
+
+»»» measureUnit
+string
+optional
+The measurement unit of rate. Assumed to be KWH if absent
+
+
+»»» volume
+number
+optional
+Volume in kWh that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period
+
+
+»» timeOfUse
+[object]
+mandatory
+Array of times of use.
+
+
+»»» days
+[string]
+optional
+The days that the rate applies to
+
+
+»»» startTime
+TimeString
+conditional
+The beginning of the time period per day for which the controlled load rate applies. Required if endTime provided
+
+
+»»» endTime
+TimeString
+conditional
+The end of the time period per day for which the controlled load rate applies. Required if startTime provided
+
+
+»»» additionalInfo
+string
+conditional
+Display text providing more information on the contrlled load, for e.g. controlled load availability if specific day/time is not known. Required if startTime and endTime absent or if additionalInfoUri provided
+
+
+»»» additionalInfoUri
+URIString
+optional
+Optional link to additional information regarding the controlled load
+
+
+»» type
+string
+mandatory
+The type of usage that the rate applies to
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+rateBlockUType
+singleRate
+
+
+rateBlockUType
+timeOfUseRates
+
+
+measureUnit
+KWH
+
+
+measureUnit
+KVA
+
+
+measureUnit
+KVAR
+
+
+measureUnit
+KVARH
+
+
+measureUnit
+KW
+
+
+measureUnit
+DAYS
+
+
+measureUnit
+METER
+
+
+measureUnit
+MONTH
+
+
+measureUnit
+KWH
+
+
+measureUnit
+KVA
+
+
+measureUnit
+KVAR
+
+
+measureUnit
+KVARH
+
+
+measureUnit
+KW
+
+
+measureUnit
+DAYS
+
+
+measureUnit
+METER
+
+
+measureUnit
+MONTH
+
+
+days
+SUN
+
+
+days
+MON
+
+
+days
+TUE
+
+
+days
+WED
+
+
+days
+THU
+
+
+days
+FRI
+
+
+days
+SAT
+
+
+days
+PUBLIC_HOLIDAYS
+
+
+type
+PEAK
+
+
+type
+OFF_PEAK
+
+
+type
+SHOULDER
+
+
+type
+SOLAR_SPONGE
+
+
+
+
EnergyPlanIncentives
+
+
+
[
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "category" : "GIFT" ,
+ "eligibility" : "string"
+ }
+ ]
+
+
+
Optional list of incentives available for the contract
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+displayName
+string
+mandatory
+The display name of the incentive
+
+
+description
+string
+mandatory
+The description of the incentive
+
+
+category
+string
+mandatory
+The type of the incentive
+
+
+eligibility
+string
+optional
+A display message outlining an eligibility criteria that may apply
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+category
+GIFT
+
+
+category
+ACCOUNT_CREDIT
+
+
+category
+OTHER
+
+
+
+
EnergyPlanDiscounts
+
+
+
[
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "type" : "CONDITIONAL" ,
+ "category" : "PAY_ON_TIME" ,
+ "endDate" : "string" ,
+ "methodUType" : "percentOfBill" ,
+ "percentOfBill" : {
+ "rate" : "string"
+ },
+ "percentOfUse" : {
+ "rate" : "string"
+ },
+ "fixedAmount" : {
+ "amount" : "string"
+ },
+ "percentOverThreshold" : {
+ "rate" : "string" ,
+ "usageAmount" : "string"
+ }
+ }
+ ]
+
+
+
Optional list of discounts available for the contract
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+displayName
+string
+mandatory
+The display name of the discount
+
+
+description
+string
+optional
+The description of the discount
+
+
+type
+string
+mandatory
+The type of the discount
+
+
+category
+string
+optional
+The type of the discount. Mandatory if the discount type is CONDITIONAL
+
+
+endDate
+DateString
+optional
+Optional end date for the discount after which the discount is no longer available
+
+
+methodUType
+string
+mandatory
+The method of calculation of the discount
+
+
+percentOfBill
+object
+conditional
+Required if methodUType is percentOfBill
+
+
+» rate
+RateString
+mandatory
+The rate of the discount applied to the bill amount
+
+
+percentOfUse
+object
+conditional
+Required if methodUType is percentOfUse
+
+
+» rate
+RateString
+mandatory
+The rate of the discount applied to the usageamount
+
+
+fixedAmount
+object
+conditional
+Required if methodUType is fixedAmount
+
+
+» amount
+AmountString
+mandatory
+The amount of the discount
+
+
+percentOverThreshold
+object
+conditional
+Required if methodUType is percentOverThreshold
+
+
+» rate
+RateString
+mandatory
+The rate of the discount over the usage amount
+
+
+» usageAmount
+AmountString
+mandatory
+The usage amount threshold above which the discount applies
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+type
+CONDITIONAL
+
+
+type
+GUARANTEED
+
+
+type
+OTHER
+
+
+category
+PAY_ON_TIME
+
+
+category
+DIRECT_DEBIT
+
+
+category
+GUARANTEED_DISCOUNT
+
+
+category
+OTHER
+
+
+methodUType
+percentOfBill
+
+
+methodUType
+percentOfUse
+
+
+methodUType
+fixedAmount
+
+
+methodUType
+percentOverThreshold
+
+
+
+
EnergyPlanGreenPowerCharges
+
+
+
[
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "GREENPOWER" ,
+ "type" : "FIXED_PER_DAY" ,
+ "tiers" : [
+ {
+ "percentGreen" : "string" ,
+ "rate" : "string" ,
+ "amount" : "string"
+ }
+ ]
+ }
+ ]
+
+
+
Optional list of charges applicable to green power
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+displayName
+string
+mandatory
+The display name of the charge
+
+
+description
+string
+optional
+The description of the charge
+
+
+scheme
+string
+mandatory
+The applicable green power scheme
+
+
+type
+string
+mandatory
+The type of charge
+
+
+tiers
+[object]
+mandatory
+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
+
+
+» percentGreen
+RateString
+mandatory
+The upper percentage of green power used applicable for this tier
+
+
+» rate
+RateString
+conditional
+The rate of the charge if the type implies the application of a rate
+
+
+» amount
+AmountString
+conditional
+The amount of the charge if the type implies the application of a fixed amount
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+scheme
+GREENPOWER
+
+
+scheme
+OTHER
+
+
+type
+FIXED_PER_DAY
+
+
+type
+FIXED_PER_WEEK
+
+
+type
+FIXED_PER_MONTH
+
+
+type
+FIXED_PER_UNIT
+
+
+type
+PERCENT_OF_USE
+
+
+type
+PERCENT_OF_BILL
+
+
+
+
EnergyPlanEligibility
+
+
+
[
+ {
+ "type" : "EXISTING_CUST" ,
+ "information" : "string" ,
+ "description" : "string"
+ }
+ ]
+
+
+
Eligibility restrictions or requirements
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+type
+string
+mandatory
+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)
+
+
+information
+string
+mandatory
+Information of the eligibility restriction specific to the type of the restriction
+
+
+description
+string
+optional
+A description of the eligibility restriction
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+type
+EXISTING_CUST
+
+
+type
+EXISTING_POOL
+
+
+type
+EXISTING_SOLAR
+
+
+type
+EXISTING_BATTERY
+
+
+type
+EXISTING_SMART_METER
+
+
+type
+EXISTING_BASIC_METER
+
+
+type
+SENIOR_CARD
+
+
+type
+SMALL_BUSINESS
+
+
+type
+NO_SOLAR_FIT
+
+
+type
+NEW_CUSTOMER
+
+
+type
+ONLINE_ONLY
+
+
+type
+REQ_EQUIP_SUPPLIER
+
+
+type
+THIRD_PARTY_ONLY
+
+
+type
+SPORT_CLUB_MEMBER
+
+
+type
+ORG_MEMBER
+
+
+type
+SPECIFIC_LOCATION
+
+
+type
+MINIMUM_USAGE
+
+
+type
+LOYALTY_MEMBER
+
+
+type
+GROUP_BUY_MEMBER
+
+
+type
+CONTINGENT_PLAN
+
+
+type
+OTHER
+
+
+
+
EnergyPlanFees
+
+
+
[
+ {
+ "type" : "EXIT" ,
+ "term" : "FIXED" ,
+ "amount" : "string" ,
+ "rate" : "string" ,
+ "description" : "string"
+ }
+ ]
+
+
+
An array of fees applicable to the plan
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+type
+string
+mandatory
+The type of the fee
+
+
+term
+string
+mandatory
+The term of the fee
+
+
+amount
+AmountString
+conditional
+The fee amount. Required if term is not PERCENT_OF_BILL
+
+
+rate
+RateString
+conditional
+The fee rate. Required if term is PERCENT_OF_BILL
+
+
+description
+string
+optional
+A description of the fee
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+type
+EXIT
+
+
+type
+ESTABLISHMENT
+
+
+type
+LATE_PAYMENT
+
+
+type
+DISCONNECTION
+
+
+type
+DISCONNECT_MOVE_OUT
+
+
+type
+DISCONNECT_NON_PAY
+
+
+type
+RECONNECTION
+
+
+type
+CONNECTION
+
+
+type
+PAYMENT_PROCESSING
+
+
+type
+CC_PROCESSING
+
+
+type
+CHEQUE_DISHONOUR
+
+
+type
+DD_DISHONOUR
+
+
+type
+MEMBERSHIP
+
+
+type
+CONTRIBUTION
+
+
+type
+PAPER_BILL
+
+
+type
+OTHER
+
+
+term
+FIXED
+
+
+term
+1_YEAR
+
+
+term
+2_YEAR
+
+
+term
+3_YEAR
+
+
+term
+4_YEAR
+
+
+term
+5_YEAR
+
+
+term
+PERCENT_OF_BILL
+
+
+term
+ANNUAL
+
+
+term
+DAILY
+
+
+term
+WEEKLY
+
+
+term
+MONTHLY
+
+
+term
+BIANNUAL
+
+
+term
+VARIABLE
+
+
+
+
EnergyPlanSolarFeedInTariff
+
+
+
[
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "scheme" : "PREMIUM" ,
+ "payerType" : "GOVERNMENT" ,
+ "tariffUType" : "singleTariff" ,
+ "singleTariff" : {
+ "amount" : "string"
+ },
+ "timeVaryingTariffs" : {
+ "type" : "PEAK" ,
+ "amount" : "string" ,
+ "timeVariations" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ]
+ }
+ }
+ ]
+
+
+
Array of feed in tariffs for solar power
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+displayName
+string
+mandatory
+The name of the tariff
+
+
+description
+string
+optional
+A description of the tariff
+
+
+scheme
+string
+mandatory
+The applicable scheme
+
+
+payerType
+string
+mandatory
+The type of the payer
+
+
+tariffUType
+string
+mandatory
+The type of the payer
+
+
+singleTariff
+object
+conditional
+Represents a constant tariff. Mandatory if tariffUType is set to singleTariff
+
+
+» amount
+AmountString
+mandatory
+The tariff amount
+
+
+timeVaryingTariffs
+object
+conditional
+Represents a tariff based on time. Mandatory if tariffUType is set to timeVaryingTariffs
+
+
+» type
+string
+optional
+The type of the charging time period. If absent applies to all periods
+
+
+» amount
+AmountString
+mandatory
+The tariff amount
+
+
+» timeVariations
+[object]
+mandatory
+Array of time periods for which this tariff is applicable
+
+
+»» days
+[string]
+mandatory
+The days that the tariff applies to. At least one entry required
+
+
+»» startTime
+TimeString
+optional
+The beginning of the time period per day for which the tariff applies. If absent assumes start of day (ie. midnight)
+
+
+»» endTime
+TimeString
+optional
+The end of the time period per day for which the tariff applies. If absent assumes end of day (ie. one second before midnight)
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+scheme
+PREMIUM
+
+
+scheme
+OTHER
+
+
+payerType
+GOVERNMENT
+
+
+payerType
+RETAILER
+
+
+tariffUType
+singleTariff
+
+
+tariffUType
+timeVaryingTariffs
+
+
+type
+PEAK
+
+
+type
+OFF_PEAK
+
+
+type
+SHOULDER
+
+
+days
+SUN
+
+
+days
+MON
+
+
+days
+TUE
+
+
+days
+WED
+
+
+days
+THU
+
+
+days
+FRI
+
+
+days
+SAT
+
+
+days
+PUBLIC_HOLIDAYS
+
+
+
+
EnergyPlanTariffPeriod
+
+
+
[
+ {
+ "type" : "ENVIRONMENTAL" ,
+ "displayName" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
+ "dailySupplyCharges" : "string" ,
+ "timeZone" : "LOCAL" ,
+ "rateBlockUType" : "singleRate" ,
+ "singleRate" : {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "generalUnitPrice" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "period" : "string"
+ },
+ "timeOfUseRates" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
+ "timeOfUse" : [
+ {
+ "days" : [
+ "SUN"
+ ],
+ "startTime" : "string" ,
+ "endTime" : "string"
+ }
+ ],
+ "type" : "PEAK"
+ }
+ ],
+ "demandCharges" : [
+ {
+ "displayName" : "string" ,
+ "description" : "string" ,
+ "amount" : "string" ,
+ "measureUnit" : "KWH" ,
+ "startTime" : "string" ,
+ "endTime" : "string" ,
+ "days" : [
+ "SUN"
+ ],
+ "minDemand" : "string" ,
+ "maxDemand" : "string" ,
+ "measurementPeriod" : "DAY" ,
+ "chargePeriod" : "DAY"
+ }
+ ]
+ }
+ ]
+
+
+
Array of tariff periods
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+type
+string
+optional
+Type of charge. Assumed to be other if absent
+
+
+displayName
+string
+mandatory
+The name of the tariff period
+
+
+startDate
+string
+mandatory
+The start date of the tariff period in a calendar year. Formatted in mm-dd format
+
+
+endDate
+string
+mandatory
+The end date of the tariff period in a calendar year. Formatted in mm-dd format
+
+
+dailySupplyCharges
+AmountString
+optional
+The amount of access charge for the tariff period, in dollars per day exclusive of GST.
+
+
+timeZone
+string
+optional
+Specifies the charge specific time zone for calculation of the time of use thresholds. If absent, timezone value in EnergyPlanContract is assumed.
+
+
+rateBlockUType
+string
+mandatory
+Specifies the type of rate applicable to this tariff period
+
+
+singleRate
+object
+conditional
+Object representing a single rate. Required if rateBlockUType is singleRate
+
+
+» displayName
+string
+mandatory
+Display name of the rate
+
+
+» description
+string
+optional
+Description of the rate
+
+
+» generalUnitPrice
+AmountString
+conditional
+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’
+
+
+» rates
+[object]
+mandatory
+Array of controlled load rates in order of usage volume
+
+
+»» unitPrice
+AmountString
+mandatory
+Unit price of usage per measure unit (exclusive of GST)
+
+
+»» measureUnit
+string
+optional
+The measurement unit of rate. Assumed to be KWH if absent
+
+
+»» volume
+number
+optional
+Volume in kWh that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period
+
+
+» period
+ExternalRef
+optional
+Usage period for which the block rate applies. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+
+
+timeOfUseRates
+[object]
+conditional
+Array of objects representing time of use rates. Required if rateBlockUType is timeOfUseRates
+
+
+» displayName
+string
+mandatory
+Display name of the rate
+
+
+» description
+string
+optional
+Description of the rate
+
+
+» rates
+[object]
+mandatory
+Array of controlled load rates in order of usage volume
+
+
+»» unitPrice
+AmountString
+mandatory
+Unit price of usage per measure unit (exclusive of GST)
+
+
+»» measureUnit
+string
+optional
+The measurement unit of rate. Assumed to be KWH if absent
+
+
+»» volume
+number
+optional
+Volume in kWh that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period
+
+
+» timeOfUse
+[object]
+mandatory
+Array of times of use
+
+
+»» days
+[string]
+mandatory
+The days that the rate applies to
+
+
+»» startTime
+TimeString
+mandatory
+Start of the period
+
+
+»» endTime
+TimeString
+mandatory
+End of the period
+
+
+» type
+string
+mandatory
+The type of usage that the rate applies to
+
+
+demandCharges
+[object]
+conditional
+Array of demand charges. Required if rateBlockUType is demandCharges
+
+
+» displayName
+string
+mandatory
+Display name of the charge
+
+
+» description
+string
+optional
+Description of the charge
+
+
+» amount
+AmountString
+mandatory
+The charge amount per measure unit exclusive of GST
+
+
+» measureUnit
+string
+optional
+The measurement unit of charge amount. Assumed to be KWH if absent
+
+
+» startTime
+TimeString
+mandatory
+Start of the period
+
+
+» endTime
+TimeString
+mandatory
+End of the period
+
+
+» days
+[string]
+optional
+The days that the demand tariff applies to
+
+
+» minDemand
+AmountString
+optional
+Minimum demand for this demand tariff in kW. If absent then 0 is assumed
+
+
+» maxDemand
+AmountString
+optional
+Maximum demand for this demand tariff in kW. If present, must be higher than the value of the minDemand field
+
+
+» measurementPeriod
+string
+mandatory
+Application period for the demand tariff
+
+
+» chargePeriod
+string
+mandatory
+Charge period for the demand tariff
+
+
+
Enumerated Values
+
+
+Property
+Value
+
+
+
+type
+ENVIRONMENTAL
+
+
+type
+REGULATED
+
+
+type
+NETWORK
+
+
+type
+METERING
+
+
+type
+RETAIL_SERVICE
+
+
+type
+RCTI
+
+
+type
+OTHER
+
+
+timeZone
+LOCAL
+
+
+timeZone
+AEST
+
+
+rateBlockUType
+singleRate
+
+
+rateBlockUType
+timeOfUseRates
+
+
+rateBlockUType
+demandCharges
+
+
+measureUnit
+KWH
+
+
+measureUnit
+KVA
+
+
+measureUnit
+KVAR
+
+
+measureUnit
+KVARH
+
+
+measureUnit
+KW
+
+
+measureUnit
+DAYS
+
+
+measureUnit
+METER
+
+
+measureUnit
+MONTH
+
+
+measureUnit
+KWH
+
+
+measureUnit
+KVA
+
+
+measureUnit
+KVAR
+
+
+measureUnit
+KVARH
+
+
+measureUnit
+KW
+
+
+measureUnit
+DAYS
+
+
+measureUnit
+METER
+
+
+measureUnit
+MONTH
+
+
+days
+SUN
+
+
+days
+MON
+
+
+days
+TUE
+
+
+days
+WED
+
+
+days
+THU
+
+
+days
+FRI
+
+
+days
+SAT
+
+
+days
+PUBLIC_HOLIDAYS
+
+
+type
+PEAK
+
+
+type
+OFF_PEAK
+
+
+type
+SHOULDER
+
+
+type
+SHOULDER1
+
+
+type
+SHOULDER2
+
+
+measureUnit
+KWH
+
+
+measureUnit
+KVA
+
+
+measureUnit
+KVAR
+
+
+measureUnit
+KVARH
+
+
+measureUnit
+KW
+
+
+measureUnit
+DAYS
+
+
+measureUnit
+METER
+
+
+measureUnit
+MONTH
+
+
+days
+SUN
+
+
+days
+MON
+
+
+days
+TUE
+
+
+days
+WED
+
+
+days
+THU
+
+
+days
+FRI
+
+
+days
+SAT
+
+
+days
+PUBLIC_HOLIDAYS
+
+
+measurementPeriod
+DAY
+
+
+measurementPeriod
+MONTH
+
+
+measurementPeriod
+TARIFF_PERIOD
+
+
+chargePeriod
+DAY
+
+
+chargePeriod
+MONTH
+
+
+chargePeriod
+TARIFF_PERIOD
+
+
+
+
ResponseErrorListV2
+
+
+
{
+ "errors" : [
+ {
+ "code" : "string" ,
+ "title" : "string" ,
+ "detail" : "string" ,
+ "meta" : {
+ "urn" : "string"
+ }
+ }
+ ]
+ }
+
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+errors
+[object]
+mandatory
+none
+
+
+» code
+string
+mandatory
+The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
+
+
+» title
+string
+mandatory
+A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
+
+
+» detail
+string
+mandatory
+A human-readable explanation specific to this occurrence of the problem.
+
+
+» meta
+object
+optional
+Additional data for customised error codes
+
+
+»» urn
+string
+conditional
+The CDR error code URN which the application-specific error code extends. Mandatory if the error code
is an application-specific error rather than a standardised error code.
+
+
+
+
Links
+
+
+
{
+ "self" : "string"
+ }
+
+
Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+self
+URIString
+mandatory
+Fully qualified link that generated the current response document
+
+
+
+
+
+
+
{}
+
+
Properties
+
None
+
+
+
+
+
+
diff --git a/docs/includes/releasenotes/releasenotes.1.24.0.html b/docs/includes/releasenotes/releasenotes.1.24.0.html
new file mode 100644
index 00000000..3baf4d2b
--- /dev/null
+++ b/docs/includes/releasenotes/releasenotes.1.24.0.html
@@ -0,0 +1,416 @@
+
+
+
+
+
+
+
+ Consumer Data Standards - v1.24.0 Release Notes
+
+
+
+
+
+
+
+
+
+
+
+ NAV
+
+
+
+
+
+
+
+
+
+
+
V1.24.0 Release Notes
+
Release notes for version v1.24.0 of the CDR Standards .
+
Changes Made Change Requests
+
This release addresses the following minor defects raised on Standards Staging :
+
+
+
+
This release addresses the following change requests raised on Standards Maintenance :
+
+
+
Decision Proposals
+
This release addresses the following Decision Proposals published on Standards :
+
+
+
Introduction
+
No Change
+
High Level Standards
+
+
API End Points
+
+
+
+
+Change
+Description
+Link
+
+
+
+RFC6749 conformant Private Key JWT Client Authentication
+Change to support [RFC7521] such that, until November 13th 2023, clients authenticating using Private Key JWT are recommended to provide the client_id
, but no longer required. From November 13th 2023, it is then optional to provide the client_id
. This applies to ADRs and the CDR Register authenticating with Data Holders and ADRs authenticating with the CDR Register. During the RECOMMENDED phase in period, Data Holders and the CDR Register may reject clients that do not provide the client_id
. ADRs may re-attempt client authentication by providing the client_id
. During this phase in period, Data Holders and the CDR Register may stop requiring the client_id
. If the client provides the client_id
, the Data Holder/CDR Register must validate that its value is the same as the iss
and sub
claims in accordance with RFC7521
+Private Key JWT Client Authentication
+
+
+Certificate Management corrections
+Standards Maintenance #565 : Updated wording and corrected a typo in the "Issued by the Register CA for Data Recipients" table. Corrected a typo in the "CDR Certificate Authority" section. Addresses Issue 565 comment .
+Certificate Management
+
+
+CORS clarification
+Standards Maintenance #565 : Added statements noting CORS is not required at relevant endpoints in Security Endpoints section. Addresses Issue 565 comment .
+Security Endpoints
+
+
+Certificate Management
+Updated the Certificate Management Section with following: Made various changes to the Certificate Signing Request Profile table to provide additional guidance to participants. Removed the Test Environment details from the Certificate Trust Model section
+Certificate Management
+
+
+
Consumer Experience
+
+
Non Functional Requirements
+
+
Known Issues
+
No Change
+
+
+
+
+
diff --git a/docs/includes/swagger/cds_admin.json b/docs/includes/swagger/cds_admin.json
index c1dc211e..bfd83313 100644
--- a/docs/includes/swagger/cds_admin.json
+++ b/docs/includes/swagger/cds_admin.json
@@ -12,7 +12,7 @@
"url" : "https://opensource.org/licenses/MIT"
},
"title" : "CDR Admin API",
- "version" : "1.23.0"
+ "version" : "1.24.0"
},
"servers" : [ {
"url" : "https://data.holder.com.au/cds-au/v1"
@@ -106,7 +106,7 @@
"description" : "This end point allows the ACCC to obtain operational statistics from the Data Holder on the operation of their CDR compliant implementation. The statistics obtainable from this end point are determined by the non-functional requirements for the CDR regime.\n\nThis end point is not required to be implemented by the Australian Energy Market Operator, the Australian Energy Regulator or the Department of State administered by the Minister of Victoria administering the National Electricity (Victoria) Act 2005 (Vic).\n\nNOTE: This version must be implemented by **October 1st 2022**\n\nObsolete versions: [v1](includes/obsolete/get-metrics-v1.html) [v2](includes/obsolete/get-metrics-v2.html).\n\nIf the Data Holder supports private_key_jwt client authentication they MUST validate the scope.",
"operationId" : "getMetrics",
"parameters" : [ {
- "description" : "The period of metrics to be requested. Values can be CURRENT (meaning metrics for current day), HISTORIC (meaning metrics for previous days or months) or ALL. If absent the default is ALL.",
+ "description" : "The period of metrics to be requested. Values can be CURRENT (meaning metrics for current period, dependent on the metric type), HISTORIC (meaning metrics for previous period, depending on the metric type) or ALL. If absent the default is ALL.",
"explode" : true,
"in" : "query",
"name" : "period",
@@ -830,7 +830,7 @@
"x-conditional" : [ "currentDay", "previousDays" ]
},
"RejectionMetricsV2_unauthenticated" : {
- "description" : "Rejection counts for all uauthenticated end points",
+ "description" : "Rejection counts for all unauthenticated end points",
"properties" : {
"currentDay" : {
"description" : "Number of calls rejected for current day",
@@ -866,7 +866,7 @@
"x-conditional" : [ "currentDay", "previousDays" ]
},
"SecondaryHolderMetrics_rejections" : {
- "description" : "Number of calls resulting in a rejection due to server execution over time",
+ "description" : "Number of calls rejected due to traffic thresholds over time",
"properties" : {
"currentDay" : {
"description" : "Number of rejections for current day",
diff --git a/docs/includes/swagger/cds_admin.yaml b/docs/includes/swagger/cds_admin.yaml
index f43c750c..f76c6c8e 100644
--- a/docs/includes/swagger/cds_admin.yaml
+++ b/docs/includes/swagger/cds_admin.yaml
@@ -11,7 +11,7 @@ info:
name: MIT License
url: https://opensource.org/licenses/MIT
title: CDR Admin API
- version: 1.23.0
+ version: 1.24.0
servers:
- url: https://data.holder.com.au/cds-au/v1
paths:
@@ -106,8 +106,9 @@ paths:
operationId: getMetrics
parameters:
- description: The period of metrics to be requested. Values can be CURRENT
- (meaning metrics for current day), HISTORIC (meaning metrics for previous
- days or months) or ALL. If absent the default is ALL.
+ (meaning metrics for current period, dependent on the metric type), HISTORIC
+ (meaning metrics for previous period, depending on the metric type) or ALL.
+ If absent the default is ALL.
explode: true
in: query
name: period
@@ -1315,7 +1316,7 @@ components:
- currentDay
- previousDays
RejectionMetricsV2_unauthenticated:
- description: Rejection counts for all uauthenticated end points
+ description: Rejection counts for all unauthenticated end points
example:
previousDays:
- 7.740351818741173
@@ -1359,8 +1360,7 @@ components:
- currentDay
- previousDays
SecondaryHolderMetrics_rejections:
- description: Number of calls resulting in a rejection due to server execution
- over time
+ description: Number of calls rejected due to traffic thresholds over time
example:
previousDays:
- 4.078845849666752
diff --git a/docs/includes/swagger/cds_banking.json b/docs/includes/swagger/cds_banking.json
index 2f67cd16..6149d71c 100644
--- a/docs/includes/swagger/cds_banking.json
+++ b/docs/includes/swagger/cds_banking.json
@@ -12,7 +12,7 @@
"url" : "https://opensource.org/licenses/MIT"
},
"title" : "CDR Banking API",
- "version" : "1.23.0"
+ "version" : "1.24.0"
},
"servers" : [ {
"url" : "https://data.holder.com.au/cds-au/v1"
@@ -1037,7 +1037,7 @@
},
"/banking/accounts/{accountId}/transactions" : {
"get" : {
- "description" : "Obtain transactions for a specific account.\n\nSome general notes that apply to all end points that retrieve transactions:\n\n- Where multiple transactions are returned, transactions should be ordered according to effective date in descending order\n- 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:\n - Posted date/time if available, then\n - Execution date/time if available, then\n - A reasonable date/time nominated by the data holder using internal data structures\n- 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\n- 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 accross the subsidiary transactions as possible, is required to be shared",
+ "description" : "Obtain transactions for a specific account.\n\nSome general notes that apply to all end points that retrieve transactions:\n\n- Where multiple transactions are returned, transactions should be ordered according to effective date in descending order\n- 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:\n - Posted date/time if available, then\n - Execution date/time if available, then\n - A reasonable date/time nominated by the data holder using internal data structures\n- 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\n- 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" : [ {
"description" : "ID of the account to get transactions for. Must have previously been returned by one of the account list end points.",
@@ -4627,7 +4627,7 @@
"type" : "string"
},
"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 are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.",
+ "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"
},
"apcaNumber" : {
@@ -4892,7 +4892,7 @@
"type" : "string"
},
"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 are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.",
+ "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"
},
"billerName" : {
@@ -5679,7 +5679,7 @@
"type" : "array"
},
"lendingRates" : {
- "description" : "Fully described deposit rates for this account based on the equivalent structure in Product Reference",
+ "description" : "Fully described lending rates for this account based on the equivalent structure in Product Reference",
"items" : {
"$ref" : "#/components/schemas/BankingProductLendingRateV2"
},
diff --git a/docs/includes/swagger/cds_banking.yaml b/docs/includes/swagger/cds_banking.yaml
index c3097d1b..68fd803c 100644
--- a/docs/includes/swagger/cds_banking.yaml
+++ b/docs/includes/swagger/cds_banking.yaml
@@ -11,7 +11,7 @@ info:
name: MIT License
url: https://opensource.org/licenses/MIT
title: CDR Banking API
- version: 1.23.0
+ version: 1.24.0
servers:
- url: https://data.holder.com.au/cds-au/v1
paths:
@@ -1068,7 +1068,7 @@ paths:
- 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 accross the subsidiary transactions as possible, is required to be shared
+ - 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:
- description: ID of the account to get transactions for. Must have previously
@@ -5173,8 +5173,8 @@ components:
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 are otherwise sensitive, then
- it should be masked using the rules applicable for the MaskedAccountString
+ for MaskedPANString. If the contents are otherwise sensitive, then it
+ should be masked using the rules applicable for the MaskedAccountString
common type.
type: string
apcaNumber:
@@ -5564,8 +5564,8 @@ components:
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 are otherwise sensitive, then it should be masked
- using the rules applicable for the MaskedAccountString common type.
+ If the contents are otherwise sensitive, then it should be masked using
+ the rules applicable for the MaskedAccountString common type.
type: string
billerName:
description: Name of the Biller
@@ -7075,7 +7075,7 @@ components:
$ref: '#/components/schemas/BankingProductDepositRate'
type: array
lendingRates:
- description: Fully described deposit rates for this account based on the
+ description: Fully described lending rates for this account based on the
equivalent structure in Product Reference
items:
$ref: '#/components/schemas/BankingProductLendingRateV2'
diff --git a/docs/includes/swagger/cds_common.json b/docs/includes/swagger/cds_common.json
index 60e3b20b..b8634f19 100644
--- a/docs/includes/swagger/cds_common.json
+++ b/docs/includes/swagger/cds_common.json
@@ -12,7 +12,7 @@
"url" : "https://opensource.org/licenses/MIT"
},
"title" : "CDR Common API",
- "version" : "1.23.0"
+ "version" : "1.24.0"
},
"servers" : [ {
"url" : "https://data.holder.com.au/cds-au/v1"
@@ -53,7 +53,7 @@
},
"style" : "simple"
}, {
- "description" : "The time when the customer last logged in to the Data Recipient Software Product. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.",
+ "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.",
"explode" : false,
"in" : "header",
"name" : "x-fapi-auth-date",
@@ -200,7 +200,7 @@
},
"style" : "simple"
}, {
- "description" : "The time when the customer last logged in to the Data Recipient Software Product. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.",
+ "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.",
"explode" : false,
"in" : "header",
"name" : "x-fapi-auth-date",
@@ -493,7 +493,7 @@
"style" : "simple"
},
"RequestHeader_x-fapi-auth-date" : {
- "description" : "The time when the customer last logged in to the Data Recipient Software Product. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.",
+ "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.",
"explode" : false,
"in" : "header",
"name" : "x-fapi-auth-date",
diff --git a/docs/includes/swagger/cds_common.yaml b/docs/includes/swagger/cds_common.yaml
index db1a051a..3aaf997e 100644
--- a/docs/includes/swagger/cds_common.yaml
+++ b/docs/includes/swagger/cds_common.yaml
@@ -11,7 +11,7 @@ info:
name: MIT License
url: https://opensource.org/licenses/MIT
title: CDR Common API
- version: 1.23.0
+ version: 1.24.0
servers:
- url: https://data.holder.com.au/cds-au/v1
paths:
@@ -72,9 +72,9 @@ paths:
type: string
style: simple
- description: The time when the customer last logged in to the Data Recipient
- Software Product. Required for all resource calls (customer present and
- unattended) if the customer is currently logged. Otherwise optional where
- the customer has not logged in. Not to be included for unauthenticated calls.
+ Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required
+ for all resource calls (customer present and unattended). Not required for
+ unauthenticated calls.
explode: false
in: header
name: x-fapi-auth-date
@@ -224,9 +224,9 @@ paths:
type: string
style: simple
- description: The time when the customer last logged in to the Data Recipient
- Software Product. Required for all resource calls (customer present and
- unattended) if the customer is currently logged. Otherwise optional where
- the customer has not logged in. Not to be included for unauthenticated calls.
+ Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required
+ for all resource calls (customer present and unattended). Not required for
+ unauthenticated calls.
explode: false
in: header
name: x-fapi-auth-date
@@ -504,9 +504,9 @@ components:
style: simple
RequestHeader_x-fapi-auth-date:
description: The time when the customer last logged in to the Data Recipient
- Software Product. Required for all resource calls (customer present and unattended)
- if the customer is currently logged. Otherwise optional where the customer
- has not logged in. Not to be included for unauthenticated calls.
+ Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required
+ for all resource calls (customer present and unattended). Not required for
+ unauthenticated calls.
explode: false
in: header
name: x-fapi-auth-date
diff --git a/docs/includes/swagger/cds_dcr.json b/docs/includes/swagger/cds_dcr.json
index 1d169a0d..208fd10e 100644
--- a/docs/includes/swagger/cds_dcr.json
+++ b/docs/includes/swagger/cds_dcr.json
@@ -3,7 +3,7 @@
"info" : {
"description" : "This specification defines the APIs for Data Holders exposing Dynamic Client Registration endpoints.",
"title" : "CDR Dynamic Client Registration API",
- "version" : "1.23.0"
+ "version" : "1.24.0"
},
"servers" : [ {
"url" : "https://data.holder.com.au/"
@@ -11,7 +11,7 @@
"paths" : {
"/register" : {
"post" : {
- "description" : "Register a client using a CDR Register issued Software Statement Assertion.",
+ "description" : "Register a client using a CDR Register issued Software Statement Assertion. \n\nThis endpoint does not require CORS.",
"operationId" : "PostDataRecipientRegistration",
"requestBody" : {
"content" : {
diff --git a/docs/includes/swagger/cds_dcr.yaml b/docs/includes/swagger/cds_dcr.yaml
index e0929cf3..177cc90f 100644
--- a/docs/includes/swagger/cds_dcr.yaml
+++ b/docs/includes/swagger/cds_dcr.yaml
@@ -3,14 +3,14 @@ info:
description: This specification defines the APIs for Data Holders exposing Dynamic
Client Registration endpoints.
title: CDR Dynamic Client Registration API
- version: 1.23.0
+ version: 1.24.0
servers:
- url: https://data.holder.com.au/
paths:
/register:
post:
- description: Register a client using a CDR Register issued Software Statement
- Assertion.
+ description: "Register a client using a CDR Register issued Software Statement\
+ \ Assertion. \n\nThis endpoint does not require CORS."
operationId: PostDataRecipientRegistration
requestBody:
content:
diff --git a/docs/includes/swagger/cds_energy.json b/docs/includes/swagger/cds_energy.json
index 0a0ec76f..39bc3b5a 100644
--- a/docs/includes/swagger/cds_energy.json
+++ b/docs/includes/swagger/cds_energy.json
@@ -3,7 +3,7 @@
"info" : {
"description" : "Consumer Data Right end points and payloads for the Energy sector",
"title" : "CDR Energy API",
- "version" : "1.23.0"
+ "version" : "1.24.0"
},
"servers" : [ {
"url" : "/"
@@ -142,17 +142,7 @@
}
}
},
- "description" : "The following error codes MUST be supported:[400 - Invalid Field](#error-400-field-invalid) [400 - Invalid Page Size](#error-400-field-invalid-page-size) [400 - Invalid Version](#error-400-header-invalid-version) ",
- "headers" : {
- "x-fapi-interaction-id" : {
- "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
- "explode" : false,
- "schema" : {
- "type" : "string"
- },
- "style" : "simple"
- }
- }
+ "description" : "The following error codes MUST be supported:[400 - Invalid Field](#error-400-field-invalid) [400 - Invalid Page Size](#error-400-field-invalid-page-size) [400 - Invalid Version](#error-400-header-invalid-version) "
},
"406" : {
"content" : {
@@ -162,17 +152,7 @@
}
}
},
- "description" : "The following error codes MUST be supported:[406 - Unsupported Version](#error-406-header-unsupported-version) ",
- "headers" : {
- "x-fapi-interaction-id" : {
- "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
- "explode" : false,
- "schema" : {
- "type" : "string"
- },
- "style" : "simple"
- }
- }
+ "description" : "The following error codes MUST be supported:[406 - Unsupported Version](#error-406-header-unsupported-version) "
},
"422" : {
"content" : {
@@ -182,17 +162,7 @@
}
}
},
- "description" : "The following error codes MUST be supported:[422 - Invalid Page](#error-422-field-invalid-page) ",
- "headers" : {
- "x-fapi-interaction-id" : {
- "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
- "explode" : false,
- "schema" : {
- "type" : "string"
- },
- "style" : "simple"
- }
- }
+ "description" : "The following error codes MUST be supported:[422 - Invalid Page](#error-422-field-invalid-page) "
}
},
"summary" : "Get Generic Plans",
@@ -202,7 +172,7 @@
},
"/energy/plans/{planId}" : {
"get" : {
- "description" : "Obtain detailed information on a single energy plan offered openly to the market",
+ "description" : "Obtain detailed information on a single energy plan offered openly to the market.\n\nOther Versions: [v1](includes/obsolete/get-generic-plan-detail-v1.html)",
"operationId" : "getPlan",
"parameters" : [ {
"description" : "ID of the specific plan requested",
@@ -240,7 +210,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/EnergyPlanResponse"
+ "$ref" : "#/components/schemas/EnergyPlanResponseV2"
}
}
},
@@ -264,17 +234,7 @@
}
}
},
- "description" : "The following error codes MUST be supported:[400 - Invalid Field](#error-400-field-invalid) [400 - Invalid Version](#error-400-header-invalid-version) ",
- "headers" : {
- "x-fapi-interaction-id" : {
- "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
- "explode" : false,
- "schema" : {
- "type" : "string"
- },
- "style" : "simple"
- }
- }
+ "description" : "The following error codes MUST be supported:[400 - Invalid Field](#error-400-field-invalid) [400 - Invalid Version](#error-400-header-invalid-version) "
},
"404" : {
"content" : {
@@ -284,17 +244,7 @@
}
}
},
- "description" : "The following error codes MUST be supported:[404 - Invalid Resource](#error-404-resource-invalid) ",
- "headers" : {
- "x-fapi-interaction-id" : {
- "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
- "explode" : false,
- "schema" : {
- "type" : "string"
- },
- "style" : "simple"
- }
- }
+ "description" : "The following error codes MUST be supported:[404 - Invalid Resource](#error-404-resource-invalid) "
},
"406" : {
"content" : {
@@ -304,22 +254,12 @@
}
}
},
- "description" : "The following error codes MUST be supported:[406 - Unsupported Version](#error-406-header-unsupported-version) ",
- "headers" : {
- "x-fapi-interaction-id" : {
- "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
- "explode" : false,
- "schema" : {
- "type" : "string"
- },
- "style" : "simple"
- }
- }
+ "description" : "The following error codes MUST be supported:[406 - Unsupported Version](#error-406-header-unsupported-version) "
}
},
"summary" : "Get Generic Plan Detail",
"tags" : [ "Energy", "Generic Tariffs" ],
- "x-version" : "1"
+ "x-version" : "2"
}
},
"/energy/electricity/servicepoints" : {
@@ -2120,7 +2060,7 @@
},
"/energy/accounts/{accountId}" : {
"get" : {
- "description" : "Obtain detailed information for a specific energy account\n\nOther Versions: [v1](includes/obsolete/get-energy-account-detail-v1.html)",
+ "description" : "Obtain detailed information for a specific energy account\n\nOther Versions: [v1](includes/obsolete/get-energy-account-detail-v1.html) [v2](includes/obsolete/get-energy-account-detail-v2.html)",
"operationId" : "getAccount",
"parameters" : [ {
"description" : "ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List end point.",
@@ -2201,7 +2141,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/EnergyAccountDetailResponseV2"
+ "$ref" : "#/components/schemas/EnergyAccountDetailResponseV3"
}
}
},
@@ -2289,7 +2229,7 @@
"summary" : "Get Energy Account Detail",
"tags" : [ "Energy", "Energy Accounts" ],
"x-scopes" : [ "energy:accounts.detail:read" ],
- "x-version" : "2"
+ "x-version" : "3"
}
},
"/energy/accounts/{accountId}/payment-schedule" : {
@@ -4801,7 +4741,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/EnergyPlanResponse"
+ "$ref" : "#/components/schemas/EnergyPlanResponseV2"
}
}
},
@@ -4985,11 +4925,11 @@
}
}
},
- "accountDetailV2" : {
+ "accountDetailV3" : {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/EnergyAccountDetailResponseV2"
+ "$ref" : "#/components/schemas/EnergyAccountDetailResponseV3"
}
}
},
@@ -5198,10 +5138,10 @@
"required" : [ "data", "links", "meta" ],
"type" : "object"
},
- "EnergyPlanResponse" : {
+ "EnergyPlanResponseV2" : {
"properties" : {
"data" : {
- "$ref" : "#/components/schemas/EnergyPlanDetail"
+ "$ref" : "#/components/schemas/EnergyPlanDetailV2"
},
"links" : {
"$ref" : "#/components/schemas/Links"
@@ -5303,10 +5243,10 @@
"required" : [ "data", "links", "meta" ],
"type" : "object"
},
- "EnergyAccountDetailResponseV2" : {
+ "EnergyAccountDetailResponseV3" : {
"properties" : {
"data" : {
- "$ref" : "#/components/schemas/EnergyAccountDetailV2"
+ "$ref" : "#/components/schemas/EnergyAccountDetailV3"
},
"links" : {
"$ref" : "#/components/schemas/Links"
@@ -5490,14 +5430,14 @@
"required" : [ "brand", "brandName", "fuelType", "lastUpdated", "planId", "type" ],
"type" : "object"
},
- "EnergyPlanDetail" : {
+ "EnergyPlanDetailV2" : {
"allOf" : [ {
"$ref" : "#/components/schemas/EnergyPlan"
}, {
- "$ref" : "#/components/schemas/EnergyPlanDetail_allOf"
+ "$ref" : "#/components/schemas/EnergyPlanDetailV2_allOf"
} ]
},
- "EnergyPlanContract" : {
+ "EnergyPlanContractV2" : {
"properties" : {
"additionalFeeInformation" : {
"description" : "Free text field containing additional information of the fees for this contract",
@@ -5534,7 +5474,7 @@
"type" : "array"
},
"intrinsicGreenPower" : {
- "$ref" : "#/components/schemas/EnergyPlanContract_intrinsicGreenPower"
+ "$ref" : "#/components/schemas/EnergyPlanContractV2_intrinsicGreenPower"
},
"controlledLoad" : {
"$ref" : "#/components/schemas/EnergyPlanControlledLoad"
@@ -5555,7 +5495,7 @@
"$ref" : "#/components/schemas/EnergyPlanFees"
},
"solarFeedInTariff" : {
- "$ref" : "#/components/schemas/EnergyPlanSolarFeedInTariff"
+ "$ref" : "#/components/schemas/EnergyPlanSolarFeedInTariffV2"
},
"tariffPeriod" : {
"$ref" : "#/components/schemas/EnergyPlanTariffPeriod"
@@ -5565,11 +5505,11 @@
"type" : "object",
"x-conditional" : [ "timeZone", "variation", "controlledLoad" ]
},
- "EnergyPlanContractFull" : {
+ "EnergyPlanContractFullV2" : {
"allOf" : [ {
- "$ref" : "#/components/schemas/EnergyPlanContract"
+ "$ref" : "#/components/schemas/EnergyPlanContractV2"
}, {
- "$ref" : "#/components/schemas/EnergyPlanContractFull_allOf"
+ "$ref" : "#/components/schemas/EnergyPlanContractFullV2_allOf"
} ]
},
"EnergyPlanControlledLoad" : {
@@ -5966,7 +5906,7 @@
},
"type" : "array"
},
- "EnergyPlanSolarFeedInTariff" : {
+ "EnergyPlanSolarFeedInTariffV2" : {
"description" : "Array of feed in tariffs for solar power",
"items" : {
"properties" : {
@@ -5978,6 +5918,16 @@
"description" : "A description of the tariff",
"type" : "string"
},
+ "startDate" : {
+ "description" : "The start date of the application of the feed in tariff",
+ "type" : "string",
+ "x-cds-type" : "DateString"
+ },
+ "endDate" : {
+ "description" : "The end date of the application of the feed in tariff",
+ "type" : "string",
+ "x-cds-type" : "DateString"
+ },
"scheme" : {
"description" : "The applicable scheme",
"enum" : [ "PREMIUM", "OTHER" ],
@@ -5996,13 +5946,32 @@
"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"
+ "rates" : {
+ "description" : "Array of feed in rates",
+ "items" : {
+ "properties" : {
+ "unitPrice" : {
+ "description" : "Unit price of usage per measure unit (exclusive of GST)",
+ "type" : "string",
+ "x-cds-type" : "AmountString"
+ },
+ "measureUnit" : {
+ "description" : "The measurement unit of rate. Assumed to be KWH if absent",
+ "enum" : [ "KWH", "KVA", "KVAR", "KVARH", "KW", "DAYS", "METER", "MONTH" ],
+ "type" : "string"
+ },
+ "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"
+ }
+ },
+ "required" : [ "unitPrice" ],
+ "type" : "object"
+ },
+ "type" : "array"
}
},
- "required" : [ "amount" ],
+ "required" : [ "rates" ],
"type" : "object"
},
"timeVaryingTariffs" : {
@@ -6013,10 +5982,29 @@
"enum" : [ "PEAK", "OFF_PEAK", "SHOULDER" ],
"type" : "string"
},
- "amount" : {
- "description" : "The tariff amount",
- "type" : "string",
- "x-cds-type" : "AmountString"
+ "rates" : {
+ "description" : "Array of feed in rates",
+ "items" : {
+ "properties" : {
+ "unitPrice" : {
+ "description" : "Unit price of usage per measure unit (exclusive of GST)",
+ "type" : "string",
+ "x-cds-type" : "AmountString"
+ },
+ "measureUnit" : {
+ "description" : "The measurement unit of rate. Assumed to be KWH if absent",
+ "enum" : [ "KWH", "KVA", "KVAR", "KVARH", "KW", "DAYS", "METER", "MONTH" ],
+ "type" : "string"
+ },
+ "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"
+ }
+ },
+ "required" : [ "unitPrice" ],
+ "type" : "object"
+ },
+ "type" : "array"
},
"timeVariations" : {
"description" : "Array of time periods for which this tariff is applicable",
@@ -6539,17 +6527,17 @@
"$ref" : "#/components/schemas/EnergyAccountV2_allOf"
} ]
},
- "EnergyAccountDetailV2" : {
+ "EnergyAccountDetailV3" : {
"allOf" : [ {
"$ref" : "#/components/schemas/EnergyAccountBaseV2"
}, {
- "$ref" : "#/components/schemas/EnergyAccountDetailV2_allOf"
+ "$ref" : "#/components/schemas/EnergyAccountDetailV3_allOf"
} ]
},
"EnergyPaymentSchedule" : {
"properties" : {
"amount" : {
- "description" : "Optional payment amount indicating that a constant payment amount is scheduled to be paid (used in bill smooting scenarios)",
+ "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"
},
@@ -7497,14 +7485,14 @@
"description" : "Describes the geographical area that the plan is available for. If absent then it is assumed the plan is not geographically limited",
"properties" : {
"excludedPostcodes" : {
- "description" : "Array of valid Australian post codes that are specifically excluded from the plan. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999)",
+ "description" : "Array of valid Australian postcodes that are specifically excluded from the plan. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999)",
"items" : {
"type" : "string"
},
"type" : "array"
},
"includedPostcodes" : {
- "description" : "Array of valid Australian post codes that are included from the plan. If absent defaults to all non-excluded post codes. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999)",
+ "description" : "Array of valid Australian postcodes that are included from the plan. If absent defaults to all non-excluded postcodes. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999)",
"items" : {
"type" : "string"
},
@@ -7521,7 +7509,7 @@
"required" : [ "distributors" ],
"type" : "object"
},
- "EnergyPlanDetail_allOf_meteringCharges" : {
+ "EnergyPlanDetailV2_allOf_meteringCharges" : {
"properties" : {
"displayName" : {
"description" : "Display name of the charge",
@@ -7550,26 +7538,26 @@
"required" : [ "displayName", "minimumValue" ],
"type" : "object"
},
- "EnergyPlanDetail_allOf" : {
+ "EnergyPlanDetailV2_allOf" : {
"properties" : {
"meteringCharges" : {
"description" : "Charges for metering included in the plan",
"items" : {
- "$ref" : "#/components/schemas/EnergyPlanDetail_allOf_meteringCharges"
+ "$ref" : "#/components/schemas/EnergyPlanDetailV2_allOf_meteringCharges"
},
"type" : "array"
},
"gasContract" : {
- "$ref" : "#/components/schemas/EnergyPlanContractFull"
+ "$ref" : "#/components/schemas/EnergyPlanContractFullV2"
},
"electricityContract" : {
- "$ref" : "#/components/schemas/EnergyPlanContractFull"
+ "$ref" : "#/components/schemas/EnergyPlanContractFullV2"
}
},
"type" : "object",
"x-conditional" : [ "gasContract", "electricityContract" ]
},
- "EnergyPlanContract_intrinsicGreenPower" : {
+ "EnergyPlanContractV2_intrinsicGreenPower" : {
"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" : {
@@ -7581,7 +7569,7 @@
"required" : [ "greenPercentage" ],
"type" : "object"
},
- "EnergyPlanContractFull_allOf" : {
+ "EnergyPlanContractFullV2_allOf" : {
"properties" : {
"termType" : {
"description" : "The term for the contract. If absent assumes no specified term",
@@ -8061,7 +8049,7 @@
"required" : [ "plans" ],
"type" : "object"
},
- "EnergyAccountDetailV2_allOf_planDetail" : {
+ "EnergyAccountDetailV3_allOf_planDetail" : {
"description" : "Detail on the plan applicable to this account. Mandatory if openStatus is OPEN",
"properties" : {
"fuelType" : {
@@ -8077,22 +8065,22 @@
"meteringCharges" : {
"description" : "Charges for metering included in the plan",
"items" : {
- "$ref" : "#/components/schemas/EnergyPlanDetail_allOf_meteringCharges"
+ "$ref" : "#/components/schemas/EnergyPlanDetailV2_allOf_meteringCharges"
},
"type" : "array"
},
"gasContract" : {
- "$ref" : "#/components/schemas/EnergyPlanContract"
+ "$ref" : "#/components/schemas/EnergyPlanContractV2"
},
"electricityContract" : {
- "$ref" : "#/components/schemas/EnergyPlanContract"
+ "$ref" : "#/components/schemas/EnergyPlanContractV2"
}
},
"required" : [ "fuelType" ],
"type" : "object",
"x-conditional" : [ "gasContract", "electricityContract" ]
},
- "EnergyAccountDetailV2_allOf_authorisedContacts" : {
+ "EnergyAccountDetailV3_allOf_authorisedContacts" : {
"properties" : {
"firstName" : {
"description" : "For people with single names this field need not be present. The single name should be in the lastName field",
@@ -8121,7 +8109,7 @@
"required" : [ "lastName" ],
"type" : "object"
},
- "EnergyAccountDetailV2_allOf_plans" : {
+ "EnergyAccountDetailV3_allOf_plans" : {
"properties" : {
"nickname" : {
"description" : "Optional display name for the plan provided by the customer to help differentiate multiple plans",
@@ -8138,12 +8126,12 @@
"$ref" : "#/components/schemas/EnergyAccountV2_allOf_planOverview"
},
"planDetail" : {
- "$ref" : "#/components/schemas/EnergyAccountDetailV2_allOf_planDetail"
+ "$ref" : "#/components/schemas/EnergyAccountDetailV3_allOf_planDetail"
},
"authorisedContacts" : {
"description" : "An array of additional contacts that are authorised to act on this account",
"items" : {
- "$ref" : "#/components/schemas/EnergyAccountDetailV2_allOf_authorisedContacts"
+ "$ref" : "#/components/schemas/EnergyAccountDetailV3_allOf_authorisedContacts"
},
"type" : "array"
}
@@ -8152,13 +8140,13 @@
"type" : "object",
"x-conditional" : [ "planOverview", "planDetail" ]
},
- "EnergyAccountDetailV2_allOf" : {
+ "EnergyAccountDetailV3_allOf" : {
"description" : "The array of plans containing service points and associated plan details",
"properties" : {
"plans" : {
"description" : "The array of plans containing service points and associated plan details",
"items" : {
- "$ref" : "#/components/schemas/EnergyAccountDetailV2_allOf_plans"
+ "$ref" : "#/components/schemas/EnergyAccountDetailV3_allOf_plans"
},
"type" : "array"
}
diff --git a/docs/includes/swagger/cds_energy.yaml b/docs/includes/swagger/cds_energy.yaml
index 9f5d2129..fa11e293 100644
--- a/docs/includes/swagger/cds_energy.yaml
+++ b/docs/includes/swagger/cds_energy.yaml
@@ -2,7 +2,7 @@ openapi: 3.0.3
info:
description: Consumer Data Right end points and payloads for the Energy sector
title: CDR Energy API
- version: 1.23.0
+ version: 1.24.0
servers:
- url: /
paths:
@@ -148,17 +148,6 @@ paths:
description: The following error codes MUST be supported:[400
- Invalid Field](#error-400-field-invalid) [400 - Invalid Page
Size](#error-400-field-invalid-page-size) [400 - Invalid Version](#error-400-header-invalid-version)
- headers:
- x-fapi-interaction-id:
- description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation
- id. If provided, the data holder must play back this value in the
- x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)**
- UUID value is required to be provided in the response header to track
- the interaction.
- explode: false
- schema:
- type: string
- style: simple
"406":
content:
application/json:
@@ -166,17 +155,6 @@ paths:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:[406
- Unsupported Version](#error-406-header-unsupported-version)
- headers:
- x-fapi-interaction-id:
- description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation
- id. If provided, the data holder must play back this value in the
- x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)**
- UUID value is required to be provided in the response header to track
- the interaction.
- explode: false
- schema:
- type: string
- style: simple
"422":
content:
application/json:
@@ -184,17 +162,6 @@ paths:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:[422
- Invalid Page](#error-422-field-invalid-page)
- headers:
- x-fapi-interaction-id:
- description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation
- id. If provided, the data holder must play back this value in the
- x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)**
- UUID value is required to be provided in the response header to track
- the interaction.
- explode: false
- schema:
- type: string
- style: simple
summary: Get Generic Plans
tags:
- Energy
@@ -202,8 +169,10 @@ paths:
x-version: "1"
/energy/plans/{planId}:
get:
- description: Obtain detailed information on a single energy plan offered openly
- to the market
+ description: |-
+ Obtain detailed information on a single energy plan offered openly to the market.
+
+ Other Versions: [v1](includes/obsolete/get-generic-plan-detail-v1.html)
operationId: getPlan
parameters:
- description: ID of the specific plan requested
@@ -245,7 +214,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/EnergyPlanResponse'
+ $ref: '#/components/schemas/EnergyPlanResponseV2'
description: Successful response
headers:
x-v:
@@ -262,17 +231,6 @@ paths:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:[400
- Invalid Field](#error-400-field-invalid) [400 - Invalid Version](#error-400-header-invalid-version)
- headers:
- x-fapi-interaction-id:
- description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation
- id. If provided, the data holder must play back this value in the
- x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)**
- UUID value is required to be provided in the response header to track
- the interaction.
- explode: false
- schema:
- type: string
- style: simple
"404":
content:
application/json:
@@ -280,17 +238,6 @@ paths:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:[404
- Invalid Resource](#error-404-resource-invalid)
- headers:
- x-fapi-interaction-id:
- description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation
- id. If provided, the data holder must play back this value in the
- x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)**
- UUID value is required to be provided in the response header to track
- the interaction.
- explode: false
- schema:
- type: string
- style: simple
"406":
content:
application/json:
@@ -298,22 +245,11 @@ paths:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:[406
- Unsupported Version](#error-406-header-unsupported-version)
- headers:
- x-fapi-interaction-id:
- description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation
- id. If provided, the data holder must play back this value in the
- x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)**
- UUID value is required to be provided in the response header to track
- the interaction.
- explode: false
- schema:
- type: string
- style: simple
summary: Get Generic Plan Detail
tags:
- Energy
- Generic Tariffs
- x-version: "1"
+ x-version: "2"
/energy/electricity/servicepoints:
get:
description: Obtain a list of service points owned by the customer that has
@@ -2114,7 +2050,7 @@ paths:
description: |-
Obtain detailed information for a specific energy account
- Other Versions: [v1](includes/obsolete/get-energy-account-detail-v1.html)
+ Other Versions: [v1](includes/obsolete/get-energy-account-detail-v1.html) [v2](includes/obsolete/get-energy-account-detail-v2.html)
operationId: getAccount
parameters:
- description: ID of a specific account to obtain data for. This is a tokenised
@@ -2204,7 +2140,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/EnergyAccountDetailResponseV2'
+ $ref: '#/components/schemas/EnergyAccountDetailResponseV3'
description: Successful response
headers:
x-v:
@@ -2285,7 +2221,7 @@ paths:
- Energy Accounts
x-scopes:
- energy:accounts.detail:read
- x-version: "2"
+ x-version: "3"
/energy/accounts/{accountId}/payment-schedule:
get:
description: "Obtain the agreed payment schedule and details, if any, for a\
@@ -4773,7 +4709,7 @@ components:
content:
application/json:
schema:
- $ref: '#/components/schemas/EnergyPlanResponse'
+ $ref: '#/components/schemas/EnergyPlanResponseV2'
description: Successful response
headers:
x-v:
@@ -4921,11 +4857,11 @@ components:
schema:
type: string
style: simple
- accountDetailV2:
+ accountDetailV3:
content:
application/json:
schema:
- $ref: '#/components/schemas/EnergyAccountDetailResponseV2'
+ $ref: '#/components/schemas/EnergyAccountDetailResponseV3'
description: Successful response
headers:
x-v:
@@ -5164,14 +5100,14 @@ components:
- links
- meta
type: object
- EnergyPlanResponse:
+ EnergyPlanResponseV2:
example:
meta: '{}'
links:
self: self
properties:
data:
- $ref: '#/components/schemas/EnergyPlanDetail'
+ $ref: '#/components/schemas/EnergyPlanDetailV2'
links:
$ref: '#/components/schemas/Links'
meta:
@@ -5738,14 +5674,14 @@ components:
- links
- meta
type: object
- EnergyAccountDetailResponseV2:
+ EnergyAccountDetailResponseV3:
example:
meta: '{}'
links:
self: self
properties:
data:
- $ref: '#/components/schemas/EnergyAccountDetailV2'
+ $ref: '#/components/schemas/EnergyAccountDetailV3'
links:
$ref: '#/components/schemas/Links'
meta:
@@ -6304,11 +6240,11 @@ components:
- planId
- type
type: object
- EnergyPlanDetail:
+ EnergyPlanDetailV2:
allOf:
- $ref: '#/components/schemas/EnergyPlan'
- - $ref: '#/components/schemas/EnergyPlanDetail_allOf'
- EnergyPlanContract:
+ - $ref: '#/components/schemas/EnergyPlanDetailV2_allOf'
+ EnergyPlanContractV2:
properties:
additionalFeeInformation:
description: Free text field containing additional information of the fees
@@ -6377,7 +6313,7 @@ components:
type: string
type: array
intrinsicGreenPower:
- $ref: '#/components/schemas/EnergyPlanContract_intrinsicGreenPower'
+ $ref: '#/components/schemas/EnergyPlanContractV2_intrinsicGreenPower'
controlledLoad:
description: Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD
or FLEXIBLE_CONT_LOAD
@@ -6870,6 +6806,14 @@ components:
description:
description: A description of the tariff
type: string
+ startDate:
+ description: The start date of the application of the feed in tariff
+ type: string
+ x-cds-type: DateString
+ endDate:
+ description: The end date of the application of the feed in tariff
+ type: string
+ x-cds-type: DateString
scheme:
description: The applicable scheme
enum:
@@ -6892,12 +6836,39 @@ components:
description: Represents a constant tariff. Mandatory if tariffUType
is set to singleTariff
properties:
- amount:
- description: The tariff amount
- type: string
- x-cds-type: AmountString
+ rates:
+ description: Array of feed in rates
+ items:
+ properties:
+ unitPrice:
+ description: Unit price of usage per measure unit (exclusive
+ of GST)
+ type: string
+ x-cds-type: AmountString
+ measureUnit:
+ description: The measurement unit of rate. Assumed to be
+ KWH if absent
+ enum:
+ - KWH
+ - KVA
+ - KVAR
+ - KVARH
+ - KW
+ - DAYS
+ - METER
+ - MONTH
+ type: string
+ 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
+ required:
+ - unitPrice
+ type: object
+ type: array
required:
- - amount
+ - rates
type: object
timeVaryingTariffs:
description: Represents a tariff based on time. Mandatory if tariffUType
@@ -6911,10 +6882,37 @@ components:
- OFF_PEAK
- SHOULDER
type: string
- amount:
- description: The tariff amount
- type: string
- x-cds-type: AmountString
+ rates:
+ description: Array of feed in rates
+ items:
+ properties:
+ unitPrice:
+ description: Unit price of usage per measure unit (exclusive
+ of GST)
+ type: string
+ x-cds-type: AmountString
+ measureUnit:
+ description: The measurement unit of rate. Assumed to be
+ KWH if absent
+ enum:
+ - KWH
+ - KVA
+ - KVAR
+ - KVARH
+ - KW
+ - DAYS
+ - METER
+ - MONTH
+ type: string
+ 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
+ required:
+ - unitPrice
+ type: object
+ type: array
timeVariations:
description: Array of time periods for which this tariff is applicable
items:
@@ -7267,10 +7265,10 @@ components:
- timeZone
- variation
- controlledLoad
- EnergyPlanContractFull:
+ EnergyPlanContractFullV2:
allOf:
- - $ref: '#/components/schemas/EnergyPlanContract'
- - $ref: '#/components/schemas/EnergyPlanContractFull_allOf'
+ - $ref: '#/components/schemas/EnergyPlanContractV2'
+ - $ref: '#/components/schemas/EnergyPlanContractFullV2_allOf'
EnergyPlanControlledLoad:
description: Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD
or FLEXIBLE_CONT_LOAD
@@ -7750,7 +7748,7 @@ components:
- amount
- rate
type: array
- EnergyPlanSolarFeedInTariff:
+ EnergyPlanSolarFeedInTariffV2:
description: Array of feed in tariffs for solar power
items:
properties:
@@ -7760,6 +7758,14 @@ components:
description:
description: A description of the tariff
type: string
+ startDate:
+ description: The start date of the application of the feed in tariff
+ type: string
+ x-cds-type: DateString
+ endDate:
+ description: The end date of the application of the feed in tariff
+ type: string
+ x-cds-type: DateString
scheme:
description: The applicable scheme
enum:
@@ -7782,12 +7788,39 @@ components:
description: Represents a constant tariff. Mandatory if tariffUType is
set to singleTariff
properties:
- amount:
- description: The tariff amount
- type: string
- x-cds-type: AmountString
+ rates:
+ description: Array of feed in rates
+ items:
+ properties:
+ unitPrice:
+ description: Unit price of usage per measure unit (exclusive
+ of GST)
+ type: string
+ x-cds-type: AmountString
+ measureUnit:
+ description: The measurement unit of rate. Assumed to be KWH
+ if absent
+ enum:
+ - KWH
+ - KVA
+ - KVAR
+ - KVARH
+ - KW
+ - DAYS
+ - METER
+ - MONTH
+ type: string
+ 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
+ required:
+ - unitPrice
+ type: object
+ type: array
required:
- - amount
+ - rates
type: object
timeVaryingTariffs:
description: Represents a tariff based on time. Mandatory if tariffUType
@@ -7801,10 +7834,37 @@ components:
- OFF_PEAK
- SHOULDER
type: string
- amount:
- description: The tariff amount
- type: string
- x-cds-type: AmountString
+ rates:
+ description: Array of feed in rates
+ items:
+ properties:
+ unitPrice:
+ description: Unit price of usage per measure unit (exclusive
+ of GST)
+ type: string
+ x-cds-type: AmountString
+ measureUnit:
+ description: The measurement unit of rate. Assumed to be KWH
+ if absent
+ enum:
+ - KWH
+ - KVA
+ - KVAR
+ - KVARH
+ - KW
+ - DAYS
+ - METER
+ - MONTH
+ type: string
+ 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
+ required:
+ - unitPrice
+ type: object
+ type: array
timeVariations:
description: Array of time periods for which this tariff is applicable
items:
@@ -8708,10 +8768,10 @@ components:
allOf:
- $ref: '#/components/schemas/EnergyAccountBaseV2'
- $ref: '#/components/schemas/EnergyAccountV2_allOf'
- EnergyAccountDetailV2:
+ EnergyAccountDetailV3:
allOf:
- $ref: '#/components/schemas/EnergyAccountBaseV2'
- - $ref: '#/components/schemas/EnergyAccountDetailV2_allOf'
+ - $ref: '#/components/schemas/EnergyAccountDetailV3_allOf'
EnergyPaymentSchedule:
example:
manualPayment:
@@ -8738,7 +8798,7 @@ components:
properties:
amount:
description: Optional payment amount indicating that a constant payment
- amount is scheduled to be paid (used in bill smooting scenarios)
+ amount is scheduled to be paid (used in bill smoothing scenarios)
type: string
x-cds-type: AmountString
paymentScheduleUType:
@@ -10622,16 +10682,16 @@ components:
- includedPostcodes
properties:
excludedPostcodes:
- description: Array of valid Australian post codes that are specifically
- excluded from the plan. Each element is a single four digit postcode
- (e.g. 3000) or a range of postcodes defined by two four digit postcodes
- and a hyphen (e.g. 3000-3999)
+ description: Array of valid Australian postcodes that are specifically excluded
+ from the plan. Each element is a single four digit postcode (e.g. 3000)
+ or a range of postcodes defined by two four digit postcodes and a hyphen
+ (e.g. 3000-3999)
items:
type: string
type: array
includedPostcodes:
- description: Array of valid Australian post codes that are included from
- the plan. If absent defaults to all non-excluded post codes. Each element
+ description: Array of valid Australian postcodes that are included from
+ the plan. If absent defaults to all non-excluded postcodes. Each element
is a single four digit postcode (e.g. 3000) or a range of postcodes defined
by two four digit postcodes and a hyphen (e.g. 3000-3999)
items:
@@ -10646,7 +10706,7 @@ components:
required:
- distributors
type: object
- EnergyPlanDetail_allOf_meteringCharges:
+ EnergyPlanDetailV2_allOf_meteringCharges:
properties:
displayName:
description: Display name of the charge
@@ -10674,22 +10734,22 @@ components:
- displayName
- minimumValue
type: object
- EnergyPlanDetail_allOf:
+ EnergyPlanDetailV2_allOf:
properties:
meteringCharges:
description: Charges for metering included in the plan
items:
- $ref: '#/components/schemas/EnergyPlanDetail_allOf_meteringCharges'
+ $ref: '#/components/schemas/EnergyPlanDetailV2_allOf_meteringCharges'
type: array
gasContract:
- $ref: '#/components/schemas/EnergyPlanContractFull'
+ $ref: '#/components/schemas/EnergyPlanContractFullV2'
electricityContract:
- $ref: '#/components/schemas/EnergyPlanContractFull'
+ $ref: '#/components/schemas/EnergyPlanContractFullV2'
type: object
x-conditional:
- gasContract
- electricityContract
- EnergyPlanContract_intrinsicGreenPower:
+ EnergyPlanContractV2_intrinsicGreenPower:
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
@@ -10701,7 +10761,7 @@ components:
required:
- greenPercentage
type: object
- EnergyPlanContractFull_allOf:
+ EnergyPlanContractFullV2_allOf:
properties:
termType:
description: The term for the contract. If absent assumes no specified
@@ -11417,7 +11477,7 @@ components:
required:
- plans
type: object
- EnergyAccountDetailV2_allOf_planDetail:
+ EnergyAccountDetailV3_allOf_planDetail:
description: Detail on the plan applicable to this account. Mandatory if openStatus
is OPEN
properties:
@@ -11439,19 +11499,19 @@ components:
meteringCharges:
description: Charges for metering included in the plan
items:
- $ref: '#/components/schemas/EnergyPlanDetail_allOf_meteringCharges'
+ $ref: '#/components/schemas/EnergyPlanDetailV2_allOf_meteringCharges'
type: array
gasContract:
- $ref: '#/components/schemas/EnergyPlanContract'
+ $ref: '#/components/schemas/EnergyPlanContractV2'
electricityContract:
- $ref: '#/components/schemas/EnergyPlanContract'
+ $ref: '#/components/schemas/EnergyPlanContractV2'
required:
- fuelType
type: object
x-conditional:
- gasContract
- electricityContract
- EnergyAccountDetailV2_allOf_authorisedContacts:
+ EnergyAccountDetailV3_allOf_authorisedContacts:
properties:
firstName:
description: For people with single names this field need not be present.
@@ -11476,7 +11536,7 @@ components:
required:
- lastName
type: object
- EnergyAccountDetailV2_allOf_plans:
+ EnergyAccountDetailV3_allOf_plans:
properties:
nickname:
description: Optional display name for the plan provided by the customer
@@ -11491,12 +11551,12 @@ components:
planOverview:
$ref: '#/components/schemas/EnergyAccountV2_allOf_planOverview'
planDetail:
- $ref: '#/components/schemas/EnergyAccountDetailV2_allOf_planDetail'
+ $ref: '#/components/schemas/EnergyAccountDetailV3_allOf_planDetail'
authorisedContacts:
description: An array of additional contacts that are authorised to act
on this account
items:
- $ref: '#/components/schemas/EnergyAccountDetailV2_allOf_authorisedContacts'
+ $ref: '#/components/schemas/EnergyAccountDetailV3_allOf_authorisedContacts'
type: array
required:
- servicePointIds
@@ -11504,7 +11564,7 @@ components:
x-conditional:
- planOverview
- planDetail
- EnergyAccountDetailV2_allOf:
+ EnergyAccountDetailV3_allOf:
description: The array of plans containing service points and associated plan
details
properties:
@@ -11512,7 +11572,7 @@ components:
description: The array of plans containing service points and associated
plan details
items:
- $ref: '#/components/schemas/EnergyAccountDetailV2_allOf_plans'
+ $ref: '#/components/schemas/EnergyAccountDetailV3_allOf_plans'
type: array
required:
- plans
diff --git a/docs/includes/swagger/cds_energy_sdh.json b/docs/includes/swagger/cds_energy_sdh.json
index d5fe0eb1..e4f0468d 100644
--- a/docs/includes/swagger/cds_energy_sdh.json
+++ b/docs/includes/swagger/cds_energy_sdh.json
@@ -3,7 +3,7 @@
"info" : {
"description" : "Consumer Data Right end points and payloads for Secondary Data Holder for the Energy sector",
"title" : "CDR Energy Secondary Data Holder API",
- "version" : "1.23.0"
+ "version" : "1.24.0"
},
"servers" : [ {
"url" : "/"
diff --git a/docs/includes/swagger/cds_energy_sdh.yaml b/docs/includes/swagger/cds_energy_sdh.yaml
index 8ac1e742..6bf26516 100644
--- a/docs/includes/swagger/cds_energy_sdh.yaml
+++ b/docs/includes/swagger/cds_energy_sdh.yaml
@@ -3,7 +3,7 @@ info:
description: Consumer Data Right end points and payloads for Secondary Data Holder
for the Energy sector
title: CDR Energy Secondary Data Holder API
- version: 1.23.0
+ version: 1.24.0
servers:
- url: /
paths:
diff --git a/docs/includes/swagger/cds_register.json b/docs/includes/swagger/cds_register.json
index 000a799e..507940ad 100644
--- a/docs/includes/swagger/cds_register.json
+++ b/docs/includes/swagger/cds_register.json
@@ -2,7 +2,7 @@
"openapi" : "3.0.3",
"info" : {
"title" : "CDR Participant Discovery API",
- "version" : "1.23.0"
+ "version" : "1.24.0"
},
"servers" : [ {
"url" : "https:///"
@@ -10,7 +10,7 @@
"paths" : {
"/.well-known/openid-configuration" : {
"get" : {
- "description" : "Endpoint used by participants to discover the CDR Register OpenID configuration and obtain information needed to interact with it, including its OAuth 2.0 endpoint locations.",
+ "description" : "Endpoint used by participants to discover the CDR Register OpenID configuration and obtain information needed to interact with it, including its OAuth 2.0 endpoint locations.\n\nThis endpoint does not require CORS.",
"operationId" : "GetOpenIdProviderConfig",
"responses" : {
"200" : {
@@ -30,7 +30,7 @@
},
"/jwks" : {
"get" : {
- "description" : "JWKS endpoint containing the public keys used by the CDR Register to validate the signature of issued SSAs and authenticate outbound calls to participants in the CDR.",
+ "description" : "JWKS endpoint containing the public keys used by the CDR Register to validate the signature of issued SSAs and authenticate outbound calls to participants in the CDR.\n\nThis endpoint does not require CORS.",
"operationId" : "Get JWKS",
"responses" : {
"200" : {
diff --git a/docs/includes/swagger/cds_register.yaml b/docs/includes/swagger/cds_register.yaml
index 49811476..c7eb05db 100644
--- a/docs/includes/swagger/cds_register.yaml
+++ b/docs/includes/swagger/cds_register.yaml
@@ -1,15 +1,16 @@
openapi: 3.0.3
info:
title: CDR Participant Discovery API
- version: 1.23.0
+ version: 1.24.0
servers:
- url: https:///
paths:
/.well-known/openid-configuration:
get:
- description: Endpoint used by participants to discover the CDR Register OpenID
- configuration and obtain information needed to interact with it, including
- its OAuth 2.0 endpoint locations.
+ description: |-
+ Endpoint used by participants to discover the CDR Register OpenID configuration and obtain information needed to interact with it, including its OAuth 2.0 endpoint locations.
+
+ This endpoint does not require CORS.
operationId: GetOpenIdProviderConfig
responses:
"200":
@@ -23,9 +24,10 @@ paths:
- Register
/jwks:
get:
- description: JWKS endpoint containing the public keys used by the CDR Register
- to validate the signature of issued SSAs and authenticate outbound calls to
- participants in the CDR.
+ description: |-
+ JWKS endpoint containing the public keys used by the CDR Register to validate the signature of issued SSAs and authenticate outbound calls to participants in the CDR.
+
+ This endpoint does not require CORS.
operationId: Get JWKS
responses:
"200":
diff --git a/docs/includes/swagger/cds_telco.json b/docs/includes/swagger/cds_telco.json
index 636c88ca..802a5175 100644
--- a/docs/includes/swagger/cds_telco.json
+++ b/docs/includes/swagger/cds_telco.json
@@ -12,7 +12,7 @@
"url" : "https://opensource.org/licenses/MIT"
},
"title" : "CDR Telco API",
- "version" : "1.23.0"
+ "version" : "1.24.0"
},
"servers" : [ {
"url" : "https://data.holder.com.au/cds-au/v1"
@@ -3904,7 +3904,7 @@
"TelcoPaymentSchedule" : {
"properties" : {
"amount" : {
- "description" : "Optional payment amount indicating that a constant payment amount is scheduled to be paid (used in bill smooting scenarios)",
+ "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"
},
diff --git a/docs/includes/swagger/cds_telco.yaml b/docs/includes/swagger/cds_telco.yaml
index 94e2f703..c75064dc 100644
--- a/docs/includes/swagger/cds_telco.yaml
+++ b/docs/includes/swagger/cds_telco.yaml
@@ -11,7 +11,7 @@ info:
name: MIT License
url: https://opensource.org/licenses/MIT
title: CDR Telco API
- version: 1.23.0
+ version: 1.24.0
servers:
- url: https://data.holder.com.au/cds-au/v1
paths:
@@ -4130,7 +4130,7 @@ components:
properties:
amount:
description: Optional payment amount indicating that a constant payment
- amount is scheduled to be paid (used in bill smooting scenarios)
+ amount is scheduled to be paid (used in bill smoothing scenarios)
type: string
x-cds-type: AmountString
paymentScheduleUType:
diff --git a/docs/index.html b/docs/index.html
index 6d281daa..91619c24 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -957,7 +957,7 @@
EnergyPlanListResponse
- EnergyPlanResponse
+ EnergyPlanResponseV2
EnergyServicePointListResponse
@@ -978,7 +978,7 @@
EnergyAccountListResponseV2
- EnergyAccountDetailResponseV2
+ EnergyAccountDetailResponseV3
EnergyPaymentScheduleResponse
@@ -1005,13 +1005,13 @@
EnergyPlan
- EnergyPlanDetail
+ EnergyPlanDetailV2
- EnergyPlanContract
+ EnergyPlanContractV2
- EnergyPlanContractFull
+ EnergyPlanContractFullV2
EnergyPlanControlledLoad
@@ -1032,7 +1032,7 @@
EnergyPlanFees
- EnergyPlanSolarFeedInTariff
+ EnergyPlanSolarFeedInTariffV2
EnergyPlanTariffPeriod
@@ -1056,7 +1056,7 @@
EnergyAccountV2
- EnergyAccountDetailV2
+ EnergyAccountDetailV3
EnergyPaymentSchedule
@@ -1757,6 +1757,8 @@ Introduction
This text is an example of text removed from the standards:
- Old text removed
Note: changes to request and response payloads are listed at the beginning of the relevant API section due to the documentation being auto generated from OpenAPI specification files.
+
+Additional note for v1.24.0: For this version only the delta statements from v1.23.0 have been retained in v1.24.0 as the release dates between the two versions were close together. The affected delta statements will be noted as being associated with v1.23.0
These standards have been developed as part of the Australian Government's introduction of the Consumer Data Right legislation to give Australians greater control over their data.
@@ -1776,14 +1778,14 @@ Introduction
Version
-These standards represent version 1.23.0 of the high level standards. See the versioning section for more information on how versions are managed in the standard.
+These standards represent version 1.24.0 of the high level standards. See the versioning section for more information on how versions are managed in the standard.
Interpretation
Note that, in these standards, the key words MUST , MUST NOT , REQUIRED , SHALL , SHALL NOT , SHOULD , SHOULD NOT , RECOMMENDED , MAY , and OPTIONAL are to be interpreted as described in [RFC2119] .
-Future Dated Obligations
-
+Future Dated Obligations Added Future Dated Obligation for Get Generic Plan Detail V2 and Get Energy Account Detail V3
+
The standards, as published from time to time, may include specific statements indicating that a specific section of the standards will not take effect until a future date or may cease to have effect on some future date.
The table below highlights these areas of the standards.
@@ -1891,6 +1893,21 @@ Future Dated Obligations
July 10th 2023
+Get Generic Plan Detail V2
+Data Holder MUST implement v2 of this endpoint by November 1st 2023 Data Holders MAY obsolete v1 of this endpoint from September 9th 2024
+November 1st 2023
+
+
+Get Energy Account Detail V3
+Data Holder MUST implement v3 of this endpoint by November 1st 2023 Data Holders MAY obsolete v2 of this endpoint from September 9th 2024
+November 1st 2023
+
+
+Private Key JWT Client Authentication
+Change to support [RFC7521] such that, until November 13th 2023, clients authenticating using Private Key JWT are recommended to provide the client_id
, but no longer required. From November 13th 2023, it is then optional to provide the client_id
. This applies to ADRs and the CDR Register authenticating with Data Holders and ADRs authenticating with the CDR Regsiter.
+November 13th 2023
+
+
Get Accounts V1
Data Holders MAY decommission v1 of this end point from March 11th 2024
March 11th 2024
@@ -1954,8 +1971,10 @@ Register Dependency Schedule
The actual release dates for the Register APIs are expected to occur prior to these dates and are not defined by the Standards.
-Endpoint Version Schedule
-
+Endpoint Version Schedule Updated version schedule for following Energy APIs:
+ Get Generic Plan Detail
+ Get Energy Account Detail
+
A table-view of all endpoint versioning is available here .
Normative References
@@ -2108,6 +2127,11 @@ Normative References
Aug 2013
+[RFC7521]
+Assertion Framework for OAuth 2.0 Client Authentication and Authorization Grants: https://tools.ietf.org/html/rfc7521
+May 2015
+
+
[RFC7523]
JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants: https://tools.ietf.org/html/rfc7523
May 2015
@@ -2935,7 +2959,8 @@ Normative references
The only exception to this, unless explicitly stated, is normative standards. The requirements for expressing arrays within those normative standards apply per the normative references.
-Common Field Types
+Common Field Types Added actual % values represented by examples for RateString field type
+
The following table outlines the common data types for fields used in the standard.
@@ -3018,7 +3043,7 @@ Common Field Types
RateString
A string representing a percentage (e.g. an interest rate). A rate of 100% would be represented by the value 1.0 and a rate of -100% by -1.0 - At least 1 and up to a total of 16 significant digits before decimal point - Up to 16 digits following the decimal point - No formatting, eg thousand separating commas
-“0.05” “-0.05” “12.3456789” “-99.123456789123”
+“0.05”(=5%)
“-0.05”(=-5%)
“12.3456789”(=1234.56789%)
“-99.123456789123”(=9912.3456789123%)
AmountString
@@ -3113,7 +3138,11 @@ ID Permanence
In payloads the field name of “id” should NEVER be used. Each ID field should be meaningfully named so that wherever that ID is used across multiple end points it always refers to the same ID set. For instance, the IDs for accounts would be represented in JSON in a field named “accountId”.
-Error Codes
+Error Codes Replaced following in description of 'Invalid Page Size':
+- page_size
+ with:
++ page-size
+
These standards define a standard list of error codes that Data Recipient Software Products and Data Holders SHOULD or MUST conform to. Further,
@@ -3294,7 +3323,7 @@ 400 Bad Request Errors
Invalid Page Size
urn:au-cds:error:cds-all: Field/InvalidPageSize
-The value provided in the page-size
pagination field is greater than the maximum allowed by the Consumer Data Standards (page_size > 1000
). This error code MUST be supported for unauthenticated and authenticated APIs.
+The value provided in the page-size
pagination field is greater than the maximum allowed by the Consumer Data Standards (page-size > 1000
). This error code MUST be supported for unauthenticated and authenticated APIs.
Invalid Version
@@ -4300,8 +4329,9 @@ Authentication Standards
-Authorisation Standards
-
+Authorisation Standards Added new Authorisation CX Standard:
++ Authorisation: Account selection functionality
+
Area
@@ -4313,6 +4343,10 @@ Authorisation Standards
Data holders MUST allow the consumer to select which of their accounts to share data from if the data request includes account-specific data and if there are multiple accounts available. The Data holder MAY omit this step if none of the data being requested is specific to an account (e.g. Saved Payees).
+Authorisation: Account selection functionality
+Data holders MAY include additional functionality to support account discovery and selection where further navigation or interaction is required to view all accounts. This may, for example, include search, sort, filter, scroll, grouping, and pagination, or other controls in line with existing consumer experiences. Any such functionality MUST NOT introduce unwarranted friction.
Note: Unwarranted friction should have regard to CDR Rule 4.24 and is considered to include the addition of any requirements beyond normal data holder practices for an equivalent account selection process.
+
+
Authorisation: Profile selection
Data holders MAY add a 'profile selection' step or equivalent prior to the account selection step if a single identifier provides access to different customer accounts. For example, one customer ID may give access to business customer and individual customer accounts.
The 'profile selection' step SHOULD only be considered if it is an existing customer experience, and SHOULD be as minimal as possible to avoid introducing unwarranted friction (having regard to CDR Rule 4.24).
@@ -4830,7 +4864,7 @@ Private Key JWT Client Authentica
Authorisation Servers MUST support the authentication of clients using the private_key_jwt
Client Authentication method specified at section 9 of [OIDC] .
The private_key_jwt
authentication method is enabled through the delivery of an encoded [JWT] signed using the Data Recipient Software Product's private key and thus facilitates non-repudiation.
Client public keys are obtained from the [JWKS] endpoints.
-For the client authentication assertion, the [JWT] represents an assertion that MUST contain the following REQUIRED Claim Values and MAY contain the following OPTIONAL Claim Values:
+For the client authentication assertion, the [JWT] represents an assertion that MUST contain the following REQUIRED Claim Values and MAY contain the following OPTIONAL Claim Values:
iss
- REQUIRED. Issuer Identifier for the Issuer of the response. The client ID of the bearer.
@@ -4840,11 +4874,22 @@ Private Key JWT Client Authentica
exp
- REQUIRED. Expiration time on or after which the ID Token MUST NOT be accepted for processing. Value is a JSON number representing the number of seconds from 1970-01-01T00:00:00Z to the UTC expiry time.
iat
- OPTIONAL. Time at which the JWT was issued. Value is a JSON number representing the number of seconds from 1970-01-01T00:00:00Z to the UTC issued at time.
-The aforementioned assertion MUST be sent to the Authorisation Server's Token endpoint with the POST
method and MUST include the following REQUIRED parameters and MAY contain the following OPTIONAL parameters:
+
+
+Updated the requirements for the client_id claim. It is now recommended the client_id be provided until November 13th 2023. After which it is optional for clients to provide this claim. It is then beholden on the CDR Register and Data Holders to permit client authentication where the client omits the client_id claim. This facilitates Data Holders seeking FAPI compliance by supporting Private Key JWT client authentication as per [RFC7521].
+
+
+
Get Software Statement Assertion API v1 & v2 has the scope claim explicitly defined.
-Registration Request using JWT Removed following requirement from id_token_encrypted_response_alg and id_token_encrypted_response_enc fields:
+Registration Request using JWT **v1.23.0 Change**
+Removed following requirement from id_token_encrypted_response_alg and id_token_encrypted_response_enc fields:
- Must be ignored for Authorization Code Flow
@@ -6126,7 +6172,8 @@ Hashing value for state
The c_hash
value MUST be generated according to section 3.3.2.11 of [OIDC] .
The s_hash
value MUST be generated according to section 5.1.1 of [FAPI-1.0-Advanced] .
-Authorization Code Flow requirements Authorization Code Flow requirements: Removed requirement stating ID tokens MUST NOT be encrypted
+Authorization Code Flow requirements **v1.23.0 Change**
+Authorization Code Flow requirements: Removed requirement stating ID tokens MUST NOT be encrypted
For response_type
code
, in accordance with [FAPI-1.0-Advanced] , ID Tokens MUST be signed when returned to a Data Recipient Software Product from the Token End Point.
Access Token
@@ -6351,7 +6398,16 @@ Ciphers
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
-Certificate Management Issued by the Register for Data Holders
+Certificate Management Made following changes to Certificate Signing Request Profile table:
++ Included additional fields that can be provided in a CSR
++ Changed 'Common Name' to 'Software Product Name' only for client certificate
++ Changed 'Organization' to include the Brand Name only
++ Added column indication which fields are mandatory
++ Included a statement noting that if optional fields are required then they will be validated to ensure correctness
+
+Replaced test enviroment details from Certificate Trust Model table with following:
++ Details provided to participants when they begin CTS process
+
Issued by the Register for Data Holders
Certificate
@@ -6365,7 +6421,13 @@ Certificate Management Issued by the Register CA for Data Recipients
+Fixed documentation issues in the Server Certificate(s) row of the `Issued by the Register CA for Data Recipients` table:
+Replaced following:
+-Revocation endpoint
+-CDR Arrangement Management endpoint
+ with:
++CDR Arrangement Revocation endpoint
+
Issued by the Register CA for Data Recipients
Certificate
@@ -6380,12 +6442,17 @@ Issued by the Register CA
Server Certificate(s)
-Certificate is issued to a FQDN. Secures the following:- Revocation endpoint - CDR Arrangement Management endpoint - JWKS endpoint
-ADRs may choose to secure their endpoints with an the Register CA issued certificate or a certificate issued by a public CA.
+Certificate is issued to a FQDN. Secures the following:- CDR Arrangement Revocation endpoint - JWKS endpoint
+ADRs may choose to secure their endpoints with the Register CA issued certificate or a certificate issued by a public CA.
-CDR Certificate Authority
-DigiCert acts as the certificate authority that issues and manages certificates to CDR participants as directed by the the Register in its capacity as the CDR Registrar.
+Corrected typo in description of `CDR Certificate Authority` section:
+Replaced:
+-the the Register
+ with:
++the ACCC Register
+
CDR Certificate Authority
+DigiCert acts as the certificate authority that issues and manages certificates to CDR participants as directed by the ACCC Register in its capacity as the CDR Registrar.
Certificate Trust Model
The CDR utilises a private certificate trust chain for all Register CA secured endpoints being hosted by Data Holders , Data Recipients and the Register .
@@ -6399,7 +6466,7 @@ Certificate Trust Model
Test Environment
-CA Root Test CA Intermediate Test
+Details provided to participants when they begin CTS process
@@ -6416,52 +6483,81 @@ Certificate Signing Request Profile
CSR Field
+Required
Server
Client
-Common Name
+Common Name (CN)
+Mandatory
Primary DNS Namee.g. api1.test.entity.com
-Software Product Name OR Brand Name
+Software Product Name
-SAN (Optional)
+SAN
+Optional
Secondary DNS Name(s) e.g. api2.test.entity.com
N/A
-Organization
-Brand Name (Legal Entity Name)
-Brand Name (Legal Entity Name)
+Organization (O)
+Mandatory
+Brand Name
+Brand Name
-Organizational Unit
+Organizational Unit (OU)
+Mandatory
Consumer Data Right
Consumer Data Right
-Country
+Country (C)
+Mandatory
Country of participante.g. AU
Country of participante.g. AU
+State (ST)
+Optional
+State of the Participante.g. New South Wales
+State of the Participante.g. New South Wales
+
+
+Locality (L)
+Optional
+Locality of the Participante.g. Sydney
+Locality of the Participante.g. Sydney
+
+
+Email Address
+Optional
+Participant's email address to be displayed in the issued certificate
+Participant's email address to be displayed in the issued certificate
+
+
Signature Algorithm
+Mandatory
SHA256
SHA256
Key Algorithm
+Mandatory
RSA
RSA
Key Size
+Mandatory
2048
2048
+Note: optional values, if provided, will be validated to be correct.
+
Please refer to the Register onboarding guide for further information on certificate issuance.
Certificate Usage
Further details on the Register CA issued certificates can be found in the ACCC Certificate Practice Statement V1.0 .
@@ -6662,9 +6758,12 @@ Data Recipient Software Products
Data Recipients Software Products MUST support [PKCE] ([RFC7636] ) and MUST use S256 as the code challenge method.
-Security Endpoints
-
-OpenID Provider Configuration End Point
+
Security Endpoints Added statements noting CORS is not required for the following:
+ * OpenID Provider Configuration End Point
+ * Authorisation End Point
+ * JSON Web Key Set End Point
+
+OpenID Provider Configuration End Point
Non-Normative Example
@@ -6737,6 +6836,8 @@ OpenID Provider Configuration E
Data Holders MUST make their OpenID Provider Metadata available via a configuration end point as outlined in Section 3 and 4 of the OpenID Connect Discovery standards [OIDD] .
+This endpoint does not require CORS .
+
At a minimum, the Data Holder metadata MUST include:
Added statement noting CORS is not required for the Register Data Recipient oAuth Client API
+
Register Data Recipient oAuth Client
@@ -7634,7 +7740,9 @@ Register Data Recipient oAuth Clie
POST /register
-Register a client using a CDR Register issued Software Statement Assertion.
+Register a client using a CDR Register issued Software Statement Assertion.
+
+This endpoint does not require CORS.
Body parameter
@@ -8822,7 +8930,10 @@ Enumerated Values
Register APIs
The following section provides an overview of the Register APIs for Data Holders and Data Recipients to collect participant metadata.
These endpoints are exposed by the Register and consumed by Data Holders and Data Recipients.
-
+Added statements noting CORS is not required for the following APIs:
+ * Get OpenId Provider Config
+ * Get JWKS
+
These endpoints are not implemented by Data Holders and Data Recipients. They are hosted by the Register for consumption by participants.
Data Holders and Data Recipient Software Products are required to call these endpoints to obtain metadata that enables connection and registration between participants as well as obtaining the status of participants in the CDR.
@@ -8968,6 +9079,8 @@ Get OpenId Provider Config
Endpoint used by participants to discover the CDR Register OpenID configuration and obtain information needed to interact with it, including its OAuth 2.0 endpoint locations.
+This endpoint does not require CORS.
+
Endpoint Version
@@ -9078,6 +9191,8 @@ Get JWKS
JWKS endpoint containing the public keys used by the CDR Register to validate the signature of issued SSAs and authenticate outbound calls to participants in the CDR.
+This endpoint does not require CORS.
+
Endpoint Version
@@ -12708,9 +12823,13 @@ Definitions
Large Payload : An API which is capable of returning a large data response that would reasonably impose higher data retrieval times on the resource server. Typically bulk request end points.
-Session Requirements
-
-A expiry time of a unique session should be set according to the statements included in the Security Profile .
+Session Requirements Corrected following typo:
+Replaced:
+- A expiry time of a unique...
+ with:
++ The expiry time of a unique...
+
+The expiry time of a unique session should be set according to the statements included in the Security Profile .
After a unique session is expired it is expected that the Data Recipient Software Product, for the same customer, may establish a new session as long as the authorisation is still valid.
@@ -12733,8 +12852,21 @@ Availability Requirements
The unavailability of a secondary data holder will mean that some requests cannot be fulfilled by a data holder making a Shared Responsibility Data Request. This will not be taken to mean that the data holder is unavailable.
-
-
+Listed specific APIs in the `Unattended` section
+
+Fixed incorrect Energy API names replacing:
+- Get Accounts
+- Get Account Detail
+- Get Balance For Account
+- Get Bulk Balances
+- Get Balances For Specific Accounts
+ with:
++ Get Energy Accounts
++ Get Energy Account Detail
++ Get Balance For Energy Account
++ Get Bulk Balances for Energy
++ Get Balances For Specific Energy Accounts
+
API end point performance will be measured in response time of individual API requests from receipt of request to delivery of response.
It is understood that different response times can be measured depending on which technical layer of an API implementation stack is instrumented and that not all of the technical layers between the Data Recipient Software Product and the Data Holder will be in the control of the Data Holder. As this is implementation specific it is expected that the Data Holder will ensure that the measurement of response time occurs as close to the Data Recipient Software Product as practicable.
@@ -12744,7 +12876,8 @@
95% of calls per hour responded to within a nominated threshold
The nominated threshold for each end point will be according to the following table:
-
+Corrected the requirement for the Large Payload tier to remove reference to unattended calls
+
Tier
@@ -12760,22 +12893,22 @@
High Priority
1000ms
-All calls to the following end points:All InfoSec end points including Dynamic Client Registration CDR Arrangement Revocation The following Unauthenticated end points:Common Get Status Get Outages Customer Present calls to the following end points:Banking Get Accounts Energy Get Accounts Get Account Detail Get Balance For Account Get Invoices For Account Common Get Customer Get Customer Detail
+All calls to the following end points:All InfoSec end points including Dynamic Client Registration CDR Arrangement Revocation The following unauthenticated end points:Common Get Status Get Outages Customer Present calls to the following end points:Banking Get Accounts Energy Get Energy Accounts Get Energy Account Detail Get Balance For Energy Account Get Invoices For Account Common Get Customer Get Customer Detail
Low Priority
1500ms
-Customer Present calls to the following end points:Banking Get Account Detail Get Account Balance Get Bulk Balances Get Balances For Specific Accounts Get Transactions For Account Get Transaction Detail Get Payees Get Payee Detail Get Direct Debits For Account Get Scheduled Payments For Account Get Scheduled Payments Bulk Get Scheduled Payments For Specific Accounts Energy Get Agreed Payment Schedule Get Concessions Get Bulk Balances Get Balances For Specific Accounts Get Bulk Invoices Get Invoices For Specific Accounts Get Billing For Account
+Customer Present calls to the following end points:Banking Get Account Detail Get Account Balance Get Bulk Balances Get Balances For Specific Accounts Get Transactions For Account Get Transaction Detail Get Payees Get Payee Detail Get Direct Debits For Account Get Scheduled Payments For Account Get Scheduled Payments Bulk Get Scheduled Payments For Specific Accounts Energy Get Agreed Payment Schedule Get Concessions Get Bulk Balances for Energy Get Balances For Specific Energy Accounts Get Bulk Invoices Get Invoices For Specific Accounts Get Billing For Account
Unattended
4000ms
-Unattended calls to the following end points that are not Large Payload end points:High Priority Authenticated end points Low Priority Authenticated end points All Admin end points.
+Unattended calls to the following end points:Banking Get Accounts Get Account Detail Get Account Balance Get Bulk Balances Get Balances For Specific Accounts Get Transactions For Account Get Transaction Detail Get Payees Get Payee Detail Get Direct Debits For Account Get Scheduled Payments For Account Get Scheduled Payments Bulk Get Scheduled Payments For Specific Accounts Energy Get Energy Accounts Get Energy Account Detail Get Balance For Energy Account Get Invoices For Account Get Agreed Payment Schedule Get Concessions Get Bulk Balances for Energy Get Balances For Specific Energy Accounts Get Bulk Invoices Get Invoices For Specific Accounts Get Billing For Account Common Get Customer Get Customer Detail Admin Metadata Update Get Metrics
Large Payload
6000ms
-Any Unattended calls to the following end points:Banking Get Bulk Direct Debits Get Direct Debits For Specific Accounts Energy Get Bulk Billing Get Billing For Specific Accounts
+Any calls to the following end points:Banking Get Bulk Direct Debits Get Direct Debits For Specific Accounts Energy Get Bulk Billing Get Billing For Specific Accounts
Secondary Request
@@ -12910,7 +13043,14 @@ Banking APIs
Banking OpenAPI Specification (JSON)
Banking OpenAPI Specification (YAML)
-
+Updated description of `BankingAccountDetailV3.lendingRates` field
+from:
+- Fully described deposit rates for this account based on the equivalent structure in Product Reference
+ to:
++ Fully described lending rates for this account based on the equivalent structure in Product Reference
+
+Corrected various spelling and grammatical mistakes
+
Get Accounts
@@ -14594,7 +14734,7 @@ Get Transactions For Account
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 accross the subsidiary transactions as possible, is required to be shared
+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
Endpoint Version
@@ -21408,7 +21548,7 @@ BankingAccountDetailV3» lendingRates
[BankingProductLendingRateV2 ]
optional
-Fully described deposit rates for this account based on the equivalent structure in Product Reference
+Fully described lending rates for this account based on the equivalent structure in Product Reference
» features
@@ -21970,7 +22110,7 @@ BankingTransaction
crn
string
conditional
-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 are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
+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.
apcaNumber
@@ -23077,7 +23217,7 @@ BankingBillerPayee
crn
string
conditional
-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 are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
+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.
billerName
@@ -25158,10 +25298,18 @@ Product Categories
-Product & Account Components
-
+
Product & Account Components Updated description of 'PENSION_RECIPIENT' value in
+'Product Eligibility Types' table from:
+- A recipient of a government pension may apply for the product
+ to:
++ Only a recipient of a government pension may apply for the product
+ and 'Product Discount Eligibility Types' table from:
+- A recipient of a government pension may receive the discount
+ to:
++ Only a recipient of a government pension may receive the discount
+
-
Product Feature Types
+Product Feature Types
Description of the usage of the featureType field as it applies to products.
@@ -25412,7 +25560,7 @@ Product Eligibility Types
PENSION_RECIPIENT
-A recipient of a government pension may apply for the product
+Only a recipient of a government pension may apply for the product
NA
@@ -25594,7 +25742,7 @@ Product Discount Eligibility Types
PENSION_RECIPIENT
-A recipient of a government pension may receive the discount
+Only a recipient of a government pension may receive the discount
Optional. Should contain a description of which pensions qualify
@@ -25757,7 +25905,40 @@ Energy APIs
Energy OpenAPI Specification (JSON)
Energy OpenAPI Specification (YAML)
-
+Bug Fix: Removed 'x-fapi-interaction-id' from response headers of Get Energy Plans and Get Energy Plan Details APIs
+
+Updated the versions of the following APIs:
++ Get Generic Plan Detail from v1 to v2
++ Get Energy Account Detail from v2 to v3
+
+Updated the following structures
+from:
+- EnergyPlanSolarFeedInTariff
+- EnergyPlanContract
+- EnergyAccountDetailV2
+- EnergyAccountDetailResponseV2
+- EnergyPlanContractFull
+- EnergyPlanDetail
+- EnergyPlanResponse
+
+to:
++ EnergyPlanSolarFeedInTariffV2
++ EnergyPlanContractV2
++ EnergyAccountDetailV3
++ EnergyAccountDetailResponseV3
++ EnergyPlanContractFullV2
++ EnergyPlanDetailV2
++ EnergyPlanResponseV2
+
+Added following to EnergyPlanSolarFeedInTariffV2:
++ rates object
++ startDate field
++ endDate field
+
+Standardised 'post codes' to 'postcodes'
+
+Corrected various spelling and grammatical mistakes
+
Get Generic Plans
@@ -26052,27 +26233,6 @@
The version of the API end point that the data holder has responded with.
-
-400
-x-fapi-interaction-id
-string
-
-An [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] UUID value is required to be provided in the response header to track the interaction.
-
-
-406
-x-fapi-interaction-id
-string
-
-An [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] UUID value is required to be provided in the response header to track the interaction.
-
-
-422
-x-fapi-interaction-id
-string
-
-An [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] UUID value is required to be provided in the response header to track the interaction.
-
@@ -26114,7 +26274,9 @@ Get Generic Plan Detail
GET /energy/plans/{planId}
-Obtain detailed information on a single energy plan offered openly to the market
+Obtain detailed information on a single energy plan offered openly to the market.
+
+Other Versions: v1
Endpoint Version
@@ -26126,7 +26288,7 @@ Endpoint Version
Version
-1
+2
@@ -26336,15 +26498,29 @@ Parameters
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [
@@ -26557,15 +26733,29 @@ Parameters
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [
@@ -26675,7 +26865,7 @@ Responses
200
OK
Successful response
-EnergyPlanResponse
+EnergyPlanResponseV2
400
@@ -26715,27 +26905,6 @@
The version of the API end point that the data holder has responded with.
-
-400
-x-fapi-interaction-id
-string
-
-An [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] UUID value is required to be provided in the response header to track the interaction.
-
-
-404
-x-fapi-interaction-id
-string
-
-An [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] UUID value is required to be provided in the response header to track the interaction.
-
-
-406
-x-fapi-interaction-id
-string
-
-An [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] UUID value is required to be provided in the response header to track the interaction.
-
@@ -29769,15 +29938,21 @@ Parameters
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {}
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {}
+ ],
"timeVariations" : [
{}
]
@@ -29934,15 +30109,21 @@ Parameters
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {}
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {}
+ ],
"timeVariations" : [
{}
]
@@ -30030,7 +30211,7 @@ Responses
200
OK
Successful response
-EnergyAccountDetailResponseV2
+EnergyAccountDetailResponseV3
400
@@ -33531,9 +33712,9 @@ EnergyPlanListResponse
-EnergyPlanResponse
+EnergyPlanResponseV2
-
+
{
"data" : {
"planId" : "string" ,
@@ -33700,15 +33881,29 @@ EnergyPlanResponse
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [
@@ -33921,15 +34116,29 @@ EnergyPlanResponse
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [
@@ -34035,7 +34244,7 @@ EnergyPlanResponse
data
-EnergyPlanDetail
+EnergyPlanDetailV2
mandatory
none
@@ -34609,9 +34818,9 @@ EnergyAccountListRes
-EnergyAccountDetailResponseV2
+EnergyAccountDetailResponseV3
-
+
{
"data" : {
"accountId" : "string" ,
@@ -34747,15 +34956,21 @@ EnergyAccountDetai
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {}
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {}
+ ],
"timeVariations" : [
{}
]
@@ -34912,15 +35127,21 @@ EnergyAccountDetai
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {}
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {}
+ ],
"timeVariations" : [
{}
]
@@ -35004,7 +35225,7 @@ EnergyAccountDetai
data
-EnergyAccountDetailV2
+EnergyAccountDetailV3
mandatory
none
@@ -35758,13 +35979,13 @@ EnergyPlan
» excludedPostcodes
[string]
optional
-Array of valid Australian post codes that are specifically excluded from the plan. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999)
+Array of valid Australian postcodes that are specifically excluded from the plan. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999)
» includedPostcodes
[string]
optional
-Array of valid Australian post codes that are included from the plan. If absent defaults to all non-excluded post codes. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999)
+Array of valid Australian postcodes that are included from the plan. If absent defaults to all non-excluded postcodes. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999)
» distributors
@@ -35814,9 +36035,9 @@ Enumerated Values
-EnergyPlanDetail
+EnergyPlanDetailV2
-
+
{
"planId" : "string" ,
"effectiveFrom" : "string" ,
@@ -35982,15 +36203,29 @@ EnergyPlanDetail
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [
@@ -36203,15 +36438,29 @@ EnergyPlanDetail
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [
@@ -36374,21 +36623,21 @@ EnergyPlanDetail
» gasContract
-EnergyPlanContractFull
+EnergyPlanContractFullV2
conditional
The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to GAS or DUAL
» electricityContract
-EnergyPlanContractFull
+EnergyPlanContractFullV2
conditional
The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to ELECTRICITY or DUAL
-EnergyPlanContract
+EnergyPlanContractV2
-
+
{
"additionalFeeInformation" : "string" ,
"pricingModel" : "SINGLE_RATE" ,
@@ -36514,15 +36763,29 @@ EnergyPlanContract
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [
@@ -36702,7 +36965,7 @@ EnergyPlanContract
solarFeedInTariff
-EnergyPlanSolarFeedInTariff
+EnergyPlanSolarFeedInTariffV2
optional
Array of feed in tariffs for solar power
@@ -36778,9 +37041,9 @@ Enumerated Values
-EnergyPlanContractFull
+EnergyPlanContractFullV2
-
+
{
"additionalFeeInformation" : "string" ,
"pricingModel" : "SINGLE_RATE" ,
@@ -36906,15 +37169,29 @@ EnergyPlanContractFull{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [
@@ -37016,7 +37293,7 @@ EnergyPlanContractFull
anonymous
-EnergyPlanContract
+EnergyPlanContractV2
mandatory
none
@@ -38185,23 +38462,37 @@ Enumerated Values
-EnergyPlanSolarFeedInTariff
+EnergyPlanSolarFeedInTariffV2
-
+
[
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [
@@ -38242,6 +38533,18 @@ Properties
A description of the tariff
+startDate
+DateString
+optional
+The start date of the application of the feed in tariff
+
+
+endDate
+DateString
+optional
+The end date of the application of the feed in tariff
+
+
scheme
string
mandatory
@@ -38266,49 +38569,85 @@ Properties
Represents a constant tariff. Mandatory if tariffUType is set to singleTariff
-» amount
+» rates
+[object]
+mandatory
+Array of feed in rates
+
+
+»» unitPrice
AmountString
mandatory
-The tariff amount
+Unit price of usage per measure unit (exclusive of GST)
-timeVaryingTariffs
+»» measureUnit
+string
+optional
+The measurement unit of rate. Assumed to be KWH if absent
+
+
+»» volume
+number
+optional
+Volume that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period
+
+
+» timeVaryingTariffs
object
conditional
Represents a tariff based on time. Mandatory if tariffUType is set to timeVaryingTariffs
-» type
+»» type
string
optional
The type of the charging time period. If absent applies to all periods
-» amount
+»» rates
+[object]
+optional
+Array of feed in rates
+
+
+»»» unitPrice
AmountString
mandatory
-The tariff amount
+Unit price of usage per measure unit (exclusive of GST)
+
+
+»»» measureUnit
+string
+optional
+The measurement unit of rate. Assumed to be KWH if absent
+
+
+»»» volume
+number
+optional
+Volume that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period
-» timeVariations
+»» timeVariations
[object]
mandatory
Array of time periods for which this tariff is applicable
-»» days
+»»» days
[string]
mandatory
The days that the tariff applies to. At least one entry required
-»» startTime
+»»» startTime
TimeString
optional
The beginning of the time period per day for which the tariff applies. If absent assumes start of day (ie. midnight)
-»» endTime
+»»» endTime
TimeString
optional
The end of the time period per day for which the tariff applies. If absent assumes end of day (ie. one second before midnight)
@@ -38348,6 +38687,38 @@ Enumerated Values
timeVaryingTariffs
+measureUnit
+KWH
+
+
+measureUnit
+KVA
+
+
+measureUnit
+KVAR
+
+
+measureUnit
+KVARH
+
+
+measureUnit
+KW
+
+
+measureUnit
+DAYS
+
+
+measureUnit
+METER
+
+
+measureUnit
+MONTH
+
+
type
PEAK
@@ -38360,6 +38731,38 @@ Enumerated Values
SHOULDER
+measureUnit
+KWH
+
+
+measureUnit
+KVA
+
+
+measureUnit
+KVAR
+
+
+measureUnit
+KVARH
+
+
+measureUnit
+KW
+
+
+measureUnit
+DAYS
+
+
+measureUnit
+METER
+
+
+measureUnit
+MONTH
+
+
days
SUN
@@ -40547,9 +40950,9 @@ EnergyAccountV2
-EnergyAccountDetailV2
+EnergyAccountDetailV3
-
+
{
"accountId" : "string" ,
"accountNumber" : "string" ,
@@ -40692,15 +41095,29 @@ EnergyAccountDetailV2
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [],
@@ -40879,15 +41296,29 @@ EnergyAccountDetailV2
{
"displayName" : "string" ,
"description" : "string" ,
+ "startDate" : "string" ,
+ "endDate" : "string" ,
"scheme" : "PREMIUM" ,
"payerType" : "GOVERNMENT" ,
"tariffUType" : "singleTariff" ,
"singleTariff" : {
- "amount" : "string"
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ]
},
"timeVaryingTariffs" : {
"type" : "PEAK" ,
- "amount" : "string" ,
+ "rates" : [
+ {
+ "unitPrice" : "string" ,
+ "measureUnit" : "KWH" ,
+ "volume" : 0
+ }
+ ],
"timeVariations" : [
{
"days" : [],
@@ -41102,13 +41533,13 @@ EnergyAccountDetailV2
»»» gasContract
-EnergyPlanContract
+EnergyPlanContractV2
conditional
The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to GAS or DUAL
»»» electricityContract
-EnergyPlanContract
+EnergyPlanContractV2
conditional
The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to ELECTRICITY or DUAL
@@ -41214,7 +41645,7 @@ EnergyPaymentSchedule
amount
AmountString
optional
-Optional payment amount indicating that a constant payment amount is scheduled to be paid (used in bill smooting scenarios)
+Optional payment amount indicating that a constant payment amount is scheduled to be paid (used in bill smoothing scenarios)
paymentScheduleUType
@@ -43373,7 +43804,8 @@ Telco APIs
Telco OpenAPI Specification (JSON)
Telco OpenAPI Specification (YAML)
-
+Corrected various spelling and grammatical mistakes
+
Get Telco Products
@@ -50883,7 +51315,7 @@ TelcoPaymentSchedule
amount
AmountString
optional
-Optional payment amount indicating that a constant payment amount is scheduled to be paid (used in bill smooting scenarios)
+Optional payment amount indicating that a constant payment amount is scheduled to be paid (used in bill smoothing scenarios)
paymentScheduleUType
@@ -56150,7 +56582,8 @@ Common APIs
Common OpenAPI Specification (JSON)
Common OpenAPI Specification (YAML)
-
+Updated x-fapi-auth-date definitions to be aligned to the HTTP Headers section and Banking APIs
+
Get Customer
@@ -56261,7 +56694,7 @@ Parameters
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-R-Draft] . Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address
@@ -56499,7 +56932,7 @@ Parameters
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-R-Draft] . Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address
@@ -58788,7 +59221,18 @@ Admin APIs
Admin OpenAPI Specification (JSON)
Admin OpenAPI Specification (YAML)
-
+Corrected spelling mistake in description of 'RejectionMetricsV2.unauthenticated' field:
+- Rejection counts for all uauthenticated end points
+ + Rejection counts for all unauthenticated end points
+
+Updated description of 'period' parameter of Get Metrics API:
+- Values can be CURRENT (meaning metrics for current day), HISTORIC (meaning metrics for previous days or months) or ALL...
+ + Values can be CURRENT (meaning metrics for current period, dependent on the metric type), HISTORIC (meaning metrics for previous period, depending on the metric type) or ALL...
+
+Updated description of 'SecondaryHolderMetrics.rejections':
+- Number of calls resulting in a rejection due to server execution over time
+ + Number of calls rejected due to traffic thresholds over time
+
@@ -59030,7 +59474,7 @@ Parameters
query
string
optional
-The period of metrics to be requested. Values can be CURRENT (meaning metrics for current day), HISTORIC (meaning metrics for previous days or months) or ALL. If absent the default is ALL.
+The period of metrics to be requested. Values can be CURRENT (meaning metrics for current period, dependent on the metric type), HISTORIC (meaning metrics for previous period, depending on the metric type) or ALL. If absent the default is ALL.
x-v
@@ -60397,7 +60841,7 @@ Properties
unauthenticated
object
mandatory
-Rejection counts for all uauthenticated end points
+Rejection counts for all unauthenticated end points
» currentDay
@@ -60468,7 +60912,7 @@ Properties
rejections
object
mandatory
-Number of calls resulting in a rejection due to server execution over time
+Number of calls rejected due to traffic thresholds over time
» currentDay
@@ -64988,6 +65432,12 @@ Change Log
+07/05/2023
+1.24.0
+Changes arising from Decision 281 (Maintenance iteration 14)
+See release notes and Decision 281 for details.
+
+
14/04/2023
1.23.0
Changes arising from Decision Proposal 298
@@ -65431,6 +65881,11 @@ Archives
+24/04/2023
+1.23.0
+Changes arising from Decision Proposal 298
+
+
22/03/2023
1.22.1
Changes arising from Change Request 576 (Maintenance iteration 14)
diff --git a/slate/source/includes/_admin.md.erb b/slate/source/includes/_admin.md.erb
index fa8f6812..4d531138 100644
--- a/slate/source/includes/_admin.md.erb
+++ b/slate/source/includes/_admin.md.erb
@@ -9,5 +9,17 @@ This provides an overview of CDS Administration Endpoints. Please note this API
Admin OpenAPI Specification (YAML)
+```diff
+Corrected spelling mistake in description of 'RejectionMetricsV2.unauthenticated' field:
+- Rejection counts for all uauthenticated end points
++ Rejection counts for all unauthenticated end points
+Updated description of 'period' parameter of Get Metrics API:
+- Values can be CURRENT (meaning metrics for current day), HISTORIC (meaning metrics for previous days or months) or ALL...
++ Values can be CURRENT (meaning metrics for current period, dependent on the metric type), HISTORIC (meaning metrics for previous period, depending on the metric type) or ALL...
+
+Updated description of 'SecondaryHolderMetrics.rejections':
+- Number of calls resulting in a rejection due to server execution over time
++ Number of calls rejected due to traffic thresholds over time
+```
<%= partial "includes/cds_admin.md" %>
diff --git a/slate/source/includes/_banking_apis.md.erb b/slate/source/includes/_banking_apis.md.erb
index 050faef2..d661b6f1 100644
--- a/slate/source/includes/_banking_apis.md.erb
+++ b/slate/source/includes/_banking_apis.md.erb
@@ -10,6 +10,15 @@ This specification defines the APIs for Data Holders exposing Banking endpoints.
Banking OpenAPI Specification (YAML)
+```diff
+Updated description of `BankingAccountDetailV3.lendingRates` field
+from:
+- Fully described deposit rates for this account based on the equivalent structure in Product Reference
+to:
++ Fully described lending rates for this account based on the equivalent structure in Product Reference
+
+Corrected various spelling and grammatical mistakes
+```
<%= partial "includes/cds_banking.md" %>
<%= partial "includes/banking/_product_categories.md" %>
diff --git a/slate/source/includes/_common_apis.md.erb b/slate/source/includes/_common_apis.md.erb
index a5dd1ed2..a5167f52 100644
--- a/slate/source/includes/_common_apis.md.erb
+++ b/slate/source/includes/_common_apis.md.erb
@@ -11,4 +11,8 @@ This specification defines the Common APIs that apply to Data Holders multiple s
+```diff
+Updated x-fapi-auth-date definitions to be aligned to the HTTP Headers section and Banking APIs
+```
+
<%= partial "includes/cds_common.md" %>
diff --git a/slate/source/includes/_dcr_apis.md.erb b/slate/source/includes/_dcr_apis.md.erb
index 27792602..a09fc702 100644
--- a/slate/source/includes/_dcr_apis.md.erb
+++ b/slate/source/includes/_dcr_apis.md.erb
@@ -10,4 +10,8 @@ This specification defines the APIs for Data Holders exposing Dynamic Client Reg
DCR OpenAPI Specification (YAML)
+```diff
+Added statement noting CORS is not required for the Register Data Recipient oAuth Client API
+```
+
<%= partial "includes/cds_dcr.md" %>
diff --git a/slate/source/includes/_energy_apis.md.erb b/slate/source/includes/_energy_apis.md.erb
index d46017cd..df22a478 100644
--- a/slate/source/includes/_energy_apis.md.erb
+++ b/slate/source/includes/_energy_apis.md.erb
@@ -9,5 +9,40 @@ This specification defines the APIs for Data Holders exposing Energy endpoints.
Energy OpenAPI Specification (YAML)
+```diff
+Bug Fix: Removed 'x-fapi-interaction-id' from response headers of Get Energy Plans and Get Energy Plan Details APIs
+
+Updated the versions of the following APIs:
++ Get Generic Plan Detail from v1 to v2
++ Get Energy Account Detail from v2 to v3
+
+Updated the following structures
+from:
+- EnergyPlanSolarFeedInTariff
+- EnergyPlanContract
+- EnergyAccountDetailV2
+- EnergyAccountDetailResponseV2
+- EnergyPlanContractFull
+- EnergyPlanDetail
+- EnergyPlanResponse
+
+to:
++ EnergyPlanSolarFeedInTariffV2
++ EnergyPlanContractV2
++ EnergyAccountDetailV3
++ EnergyAccountDetailResponseV3
++ EnergyPlanContractFullV2
++ EnergyPlanDetailV2
++ EnergyPlanResponseV2
+
+Added following to EnergyPlanSolarFeedInTariffV2:
++ rates object
++ startDate field
++ endDate field
+
+Standardised 'post codes' to 'postcodes'
+
+Corrected various spelling and grammatical mistakes
+```
<%= partial "includes/cds_energy.md" %>
diff --git a/slate/source/includes/_register.md.erb b/slate/source/includes/_register.md.erb
index 40131817..a4a19ddb 100644
--- a/slate/source/includes/_register.md.erb
+++ b/slate/source/includes/_register.md.erb
@@ -3,6 +3,12 @@
The following section provides an overview of the Register APIs for Data Holders and Data Recipients to collect participant metadata.
These endpoints are exposed by the Register and consumed by Data Holders and Data Recipients.
+```diff
+Added statements noting CORS is not required for the following APIs:
+ * Get OpenId Provider Config
+ * Get JWKS
+```
+