Guidance on Get Energy Account Detail and related schemas

Introduction

The notes below relate to the CDS Energy APIs and related schemas. They are gathered from Subject Matter Expert guidance and answers to participant questions. 

AmountString

Wherever it appears in a schema representing a currency value, AmountString should be presented as currency, in the form $$.cc, as defined in CDS, Common Field Types. It should not be presented as a number of cents.

AmountString is defined in CDS, Common Field Types as a currency amount. To suggest a change to the field type, participants can raise a Change Request (CR). See Creating a Change Request.

EnergyPlanTariffPeriod

rates, bandedDailySupplyCharges

In EnergyPlanTariffPeriod, rates, and bandedDailySupplyCharges, a stepped usage charge is represented by an array of items specifying volumes and associated prices.

The array elements are bands, listed in the order of stepped rates. Each band has a specified volume and the associated rate. The final band is for the remaining volume, so the volume is omitted.

In the example below, the first 1000 KWH are charged at 0.20 per KWH, the next 1200 KWH are charged at 0.25 per KWH, and any further volume is charged at 0.30 per KWH.

"rates": [
        {
          "unitPrice": "0.20",
          "measureUnit": "KWH",
          "volume": 1000
        },
        {
          "unitPrice": "0.25",
          "measureUnit": "KWH",
          "volume": 1200
        },
        {
          "unitPrice": "0.30",
          "measureUnit": "KWH",
        }
]