diff --git a/docs/includes/cds_energy b/docs/includes/cds_energy index 01b4f5ca..c1febdd1 100644 --- a/docs/includes/cds_energy +++ b/docs/includes/cds_energy @@ -3700,13 +3700,6 @@ x-cds-client-headers: string ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List end point. -open-status -query -string -optional -Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed - - x-v header string @@ -3749,26 +3742,6 @@ x-cds-client-headers: string 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. -

Enumerated Values

- - - - - - - - - - - - - - - - - - -
ParameterValue
open-statusALL
open-statusCLOSED
open-statusOPEN

Example responses

@@ -9804,7 +9777,7 @@ To perform this operation, you must be authenticated and authorised with the fol Array of distributors for the plan. Must have at least one entry -

Enumerated Values

+

Enumerated Values

@@ -10744,7 +10717,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyArray of tariff periods
-

Enumerated Values

+

Enumerated Values

@@ -11106,7 +11079,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyAn array of the available billing schedules for this contract. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
-

Enumerated Values

+

Enumerated Values

@@ -11367,7 +11340,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyThe type of usage that the rate applies to
-

Enumerated Values

+

Enumerated Values

@@ -11544,7 +11517,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyA display message outlining an eligibility criteria that may apply
-

Enumerated Values

+

Enumerated Values

@@ -11694,7 +11667,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyThe usage amount threshold above which the discount applies
-

Enumerated Values

+

Enumerated Values

@@ -11826,7 +11799,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyThe amount of the charge if the type implies the application of a fixed amount
-

Enumerated Values

+

Enumerated Values

@@ -11908,7 +11881,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyA description of the eligibility restriction
-

Enumerated Values

+

Enumerated Values

@@ -12056,7 +12029,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyA description of the fee
-

Enumerated Values

+

Enumerated Values

@@ -12306,7 +12279,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyThe 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

+

Enumerated Values

@@ -12703,7 +12676,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyCharge period for the demand tariff
-

Enumerated Values

+

Enumerated Values

@@ -13058,7 +13031,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyA code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below:
  • LOW - Consumption is less than the ‘lower consumption threshold’ as defined in the National Energy Retail Regulations
  • MEDIUM - Consumption is equal to or greater than the ‘lower consumption threshold’, but less than the ‘upper consumption threshold’, as defined in the National Energy Retail Regulations
  • HIGH - Consumption is equal to or greater than the ‘upper consumption threshold’ as defined in the National Energy Retail Regulations
-

Enumerated Values

+

Enumerated Values

@@ -13508,7 +13481,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyActual/Subtractive Indicator. Note the details of enumeration values below:
  • ACTUAL implies volume of energy actually metered between two dates
  • CUMULATIVE indicates a meter reading for a specific date. A second Meter Reading is required to determine the consumption between those two Meter Reading dates
-

Enumerated Values

+

Enumerated Values

@@ -13930,7 +13903,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyThe quality of the read taken
-

Enumerated Values

+

Enumerated Values

@@ -14284,7 +14257,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyMaximum storage capacity in kVAh. This refers to the capacity of each storage module within the device group. Mandatory if type is equal to “STORAGE”
-

Enumerated Values

+

Enumerated Values

@@ -14408,7 +14381,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyThe date that the account was created or opened. Mandatory if openStatus is OPEN
-

Enumerated Values

+

Enumerated Values

@@ -15130,7 +15103,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyUsed for a trailing suffix to the name (e.g. Jr)
-

Enumerated Values

+

Enumerated Values

@@ -15318,7 +15291,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyThe frequency with which a bill will be issued. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
-

Enumerated Values

+

Enumerated Values

@@ -15511,7 +15484,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyArray of ENUM's to specify what the concession applies to. Multiple ENUM values can be provided. If absent, USAGE is assumed
-

Enumerated Values

+

Enumerated Values

@@ -15731,7 +15704,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyIndicator of the payment status for the invoice
-

Enumerated Values

+

Enumerated Values

@@ -15834,7 +15807,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyThe total GST for all electricity usage charges. If absent then zero is assumed
-

Enumerated Values

+

Enumerated Values

@@ -15953,7 +15926,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyThe total GST for all electricity usage charges. If absent then zero is assumed
-

Enumerated Values

+

Enumerated Values

@@ -16182,7 +16155,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyRepresents a payment to the account. Mandatory if transactionUType is equal to payment
-

Enumerated Values

+

Enumerated Values

@@ -16345,7 +16318,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyA free text description of the adjustment
-

Enumerated Values

+

Enumerated Values

@@ -16557,7 +16530,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyA free text description of the adjustment
-

Enumerated Values

+

Enumerated Values

@@ -16768,7 +16741,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyA free text description of the adjustment
-

Enumerated Values

+

Enumerated Values

@@ -16843,7 +16816,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyThe method of payment
-

Enumerated Values

+

Enumerated Values

@@ -16949,7 +16922,7 @@ To perform this operation, you must be authenticated and authorised with the fol
PropertyAustralian address formatted according to the file format defined by the PAF file format. Required if addressUType is set to paf
-

Enumerated Values

+

Enumerated Values

diff --git a/docs/index.html b/docs/index.html index 6b976f87..7cd30a69 100644 --- a/docs/index.html +++ b/docs/index.html @@ -28850,13 +28850,6 @@

Parameters

- - - - - - - @@ -28900,28 +28893,6 @@

Parameters

Property ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List end point.
open-statusquerystringoptionalUsed to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
x-v header string
-

Enumerated Values

- - - - - - - - - - - - - - - - - - - -
ParameterValue
open-statusALL
open-statusCLOSED
open-statusOPEN
-

Example responses

@@ -35065,7 +35036,7 @@

EnergyPlan

Array of distributors for the plan. Must have at least one entry -

Enumerated Values

+

Enumerated Values

@@ -36005,7 +35976,7 @@

EnergyPlanContract

Property Array of tariff periods
-

Enumerated Values

+

Enumerated Values

@@ -36367,7 +36338,7 @@

EnergyPlanContractFullAn array of the available billing schedules for this contract. Formatted according to ISO 8601 Durations (excludes recurrence syntax)

Property
-

Enumerated Values

+

Enumerated Values

@@ -36632,7 +36603,7 @@

Properties

Property
-

Enumerated Values

+

Enumerated Values

@@ -36815,7 +36786,7 @@

Properties

-

Enumerated Values

+

Enumerated Values

@@ -36971,7 +36942,7 @@

Properties

-

Enumerated Values

+

Enumerated Values

@@ -37109,7 +37080,7 @@

Properties

-

Enumerated Values

+

Enumerated Values

@@ -37197,7 +37168,7 @@

Properties

-

Enumerated Values

+

Enumerated Values

@@ -37351,7 +37322,7 @@

Properties

-

Enumerated Values

+

Enumerated Values

@@ -37607,7 +37578,7 @@

Properties

-

Enumerated Values

+

Enumerated Values

@@ -38010,7 +37981,7 @@

Properties

-

Enumerated Values

+

Enumerated Values

@@ -38367,7 +38338,7 @@

EnergyServicePoint

A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below:
  • LOW - Consumption is less than the ‘lower consumption threshold’ as defined in the National Energy Retail Regulations
  • MEDIUM - Consumption is equal to or greater than the ‘lower consumption threshold’, but less than the ‘upper consumption threshold’, as defined in the National Energy Retail Regulations
  • HIGH - Consumption is equal to or greater than the ‘upper consumption threshold’ as defined in the National Energy Retail Regulations
-

Enumerated Values

+

Enumerated Values

@@ -38817,7 +38788,7 @@

EnergyServicePointDetai

PropertyActual/Subtractive Indicator. Note the details of enumeration values below:
  • ACTUAL implies volume of energy actually metered between two dates
  • CUMULATIVE indicates a meter reading for a specific date. A second Meter Reading is required to determine the consumption between those two Meter Reading dates
-

Enumerated Values

+

Enumerated Values

@@ -39239,7 +39210,7 @@

EnergyUsageRead

Property The quality of the read taken
-

Enumerated Values

+

Enumerated Values

@@ -39593,7 +39564,7 @@

EnergyDerRecord

Property Maximum storage capacity in kVAh. This refers to the capacity of each storage module within the device group. Mandatory if type is equal to “STORAGE”
-

Enumerated Values

+

Enumerated Values

@@ -39717,7 +39688,7 @@

EnergyAccountBaseV2

Property The date that the account was created or opened. Mandatory if openStatus is OPEN
-

Enumerated Values

+

Enumerated Values

@@ -40439,7 +40410,7 @@

EnergyAccountDetailV2

Property Used for a trailing suffix to the name (e.g. Jr)
-

Enumerated Values

+

Enumerated Values

@@ -40627,7 +40598,7 @@

EnergyPaymentSchedule

Property The frequency with which a bill will be issued. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
-

Enumerated Values

+

Enumerated Values

@@ -40820,7 +40791,7 @@

EnergyConcession

Property Array of ENUM's to specify what the concession applies to. Multiple ENUM values can be provided. If absent, USAGE is assumed
-

Enumerated Values

+

Enumerated Values

@@ -41040,7 +41011,7 @@

EnergyInvoice

Property Indicator of the payment status for the invoice
-

Enumerated Values

+

Enumerated Values

@@ -41143,7 +41114,7 @@

EnergyInvoiceGasUsa

PropertyThe total GST for all electricity usage charges. If absent then zero is assumed
-

Enumerated Values

+

Enumerated Values

@@ -41262,7 +41233,7 @@

EnergyInvoi

PropertyThe total GST for all electricity usage charges. If absent then zero is assumed
-

Enumerated Values

+

Enumerated Values

@@ -41495,7 +41466,7 @@

EnergyBillingTransactio

PropertyRepresents a payment to the account. Mandatory if transactionUType is equal to payment
-

Enumerated Values

+

Enumerated Values

@@ -41658,7 +41629,7 @@

EnergyBillingUsage

PropertyA free text description of the adjustment
-

Enumerated Values

+

Enumerated Values

@@ -41870,7 +41841,7 @@

EnergyBillingDema

PropertyA free text description of the adjustment
-

Enumerated Values

+

Enumerated Values

@@ -42081,7 +42052,7 @@

EnergyBillingOther

PropertyA free text description of the adjustment
-

Enumerated Values

+

Enumerated Values

@@ -42156,7 +42127,7 @@

EnergyBillingPay

PropertyThe method of payment
-

Enumerated Values

+

Enumerated Values

@@ -42262,7 +42233,7 @@

CommonPhysicalAddress

Property Australian address formatted according to the file format defined by the PAF file format. Required if addressUType is set to paf
-

Enumerated Values

+

Enumerated Values

Property