Tariff Rate Summary

Overview

Given a start date and time, Tariff Rate Summary returns summarized rates of a specified Tariff as well as all the changes in rates over the course of the given week. Optional parameters allow you to retrieve more specific pricing based on Territory and Consumption and Demand usage. Tariff Rate Summary is a more detailed version of Price as Price returns only the prices of consumption based rates.

Note that the Tariff Cloud APIs are deprecated. If you are a Switch or Conduct product customer, you should migrate to those APIs instead. If you are new to Genability, do not start to use these. Ask us if you have any questions.

Data Definitions

One Tariff Rate Summary is returned for each charge type (Fixed, Consumption based, Demand based) that comprises the Tariff. In turn each Tariff Rate Summary contains one Price Change for each change in price during the requested date range.

Tariff Rate Summary

The TariffRateSummary object has the following data structure.

Name Type Description
tariffId Long Unique Genability ID (primary key) for this tariff
chargeType String Possible values:
"FIXED_PRICE" - a fixed charge for the period
"CONSUMPTION_BASED" - based on quantity used (e.g. kW/h),
"DEMAND_BASED" - based on the peak demand (e.g. kW)
"QUANTITY" - a rate per number of items (e.g. $5 per street light)
"FORMULA" - a rate that has a specific or custom formula
"MINIMUM" - a minimum amount that the LSE will charge you, regardless of the other charges
quantityKey String When not null, the property that defines the type of quantity this rate applies to.
fromDateTime DateTime The starting date and time for this rate summary.
toDateTime DateTime The ending date and time for this rate summary.
rateAmount Decimal The charge amount in dollars for this tariff at the time passed in.
relativePriceIndex Decimal The relative price of this rateAmount compared to other rate amounts in this summary. This is useful for change in price notifications. The highest price will have an RPI of 1.0.
currency String Currently all prices are returned in USD.
priceChanges List of Tariff Rate Change List of all the price changes within the specified time period

Tariff Rate Change

The TariffRateChange object has the following data structure.

Name Type Description
changeName String Name of this change. For display purposes only.
changeDateTime DateTime Date and time when this change occurs. In ISO 8601 format.
rateAmount Decimal Charge amount in dollars for this rate change
relativePriceIndex Decimal The relative price of this rateAmount compared to other rate amounts in this summary. This is useful for change in price notifications. The highest price will have an RPI of 1.0.
accuracy Decimal Defines the accuracy of the rate amount from a scale of 0.0 to 1.0, with the higher indicating a more accurate price.

Operations

Get the Price of a Tariff

This returns the price of the specified tariff for the passed in date and time, and also the changes in price for this tariff for the next week.

Resource URI

GET /rest/public/prices/{masterTariffId}

Request Parameters

Along with the standard pagination parameters, searching and sorting parameters, and the required security parameters, the following parameters are available as part of the request:

Name Type Description
fromDateTime DateTime Date and time of the requested start of the price. In ISO 8601 format. (Required)
toDateTime DateTime Date and time of the requested start of the Price. In ISO 8601 format. (Optional)
territoryId Long When specified, rate changes returned will be for the specified Territory. (Optional)
consumptionAmount Decimal A monthly consumption in kWh. This is used for banded consumption to determine which pricing to use for the request. By default, the rate amount calculation assumes the highest banded level of consumption. (Optional)
demandAmount Decimal A monthly demand in kW. This is used for banded demand to determine which pricing to use for the request. By default, the rate amount calculation assumes the highest banded level of demand. (Optional)
accountId String The Genability ID for an account. You can use accounts to store applicability values as well as load profiles, territoryId and other properties that can help in deriving a very accurate price. Read more about accounts here. Note, while you may store a masterTariffId on an account, the masterTariffId in the URI will be the one the price is retrieved for. (Optional)

Example

GET /rest/public/prices/520?fromDateTime=2011-06-13T00:00:00.0-0700&consumptionAmount=500
{
    "tariffId":520,
    "chargeType":"CONSUMPTION_BASED",
    "quantityKey":"consumption",
    "fromDateTime":"2011-06-13T00:00:00.000-0700",
    "toDateTime":"2011-06-20T00:00:00.000-0700",
    "rateAmount":0.089610,
    "relativePriceIndex":0.29,
    "currency":USD,
    "priceChanges":[
    {
       "changeName":"Summer Partial Peak",
       "changeDateTime":"2011-06-13T10:00:00.000-0700",
       "rateAmount":0.153110,
       "relativePriceIndex":0.49,
       "accuracy":1
    },
    {
       "changeName":"Summer Peak",
       "changeDateTime":"2011-06-13T13:00:00.000-0700",
       "rateAmount":0.310460,
       "relativePriceIndex":1.00,
       "accuracy":1
    },
    {
       "changeName":"CONSUMPTION_BASED rate change",
       "changeDateTime":"2011-06-13T19:00:00.000-0700",
       "rateAmount":0.050780,
       "relativePriceIndex":0.16,
       "accuracy":1
    },
}

Example - Get a Price for an Account

GET /rest/public/prices?accountId=abc123
GET /rest/public/prices?accountId=abc123&fromDateTime=2011-06-13T00:00:00.0-0700&consumptionAmount=500

Note that the masterTariffId is not needed on the URI when the accountId is specified.

History

  • Formatting updates - 3/10/2015
  • Update - 6/9/2011 - Initial Version
  • Update - 5/25/2012 - Renamed from Price to Tariff Rate Summary with publication of new Price endpoint