HOW TO: Pass Contracted Supplier Rates to the Calculate API

In 16 states, electricity customers can choose a electric supplier that is not their local utility.  Genability makes it easy to integrate these contracted rates into your calculations. If you are using our API, here’s how.

To run a calculation with an overridden supplier rate you simply pass in a ‘RateInput’.  This will swap out any rate on your tariff that is flagged as contractable (often called By-passable or Price To Compare) with the rate or rates you passed in.  Here are some examples:

Example 1. A Single Contracted Rate of 8.6¢/kWh

This is the most typically straightforward case; your customer has a contracted price per kWh.

Request Url:
Request Body:

{
   "fromDateTime":"2012-11-01",
   "toDateTime":"2012-12-01",
   "groupBy":"MONTH",
   "detailLevel":"RATE",
   "tariffInputs":[
      {
         "keyName":"consumption",
         "fromDateTime":"2012-11-01",
         "toDateTime":"2012-12-01",
         "dataValue":"1010",
         "unit":"kwh"
      }
   ],
   "rateInputs":[
      {
         "chargeClass":"CONTRACTED",
         "rateBands":[
                     {
               "rateAmount":0.086
            }
         ]
      }
   ]
}
Response Body:
...
 {
      "tariffRateId" : 16998646,
      "tariffRateBandId" : 10197630,
      "rateGroupName" : "Contracted Rate",
      "rateName" : "Contracted Rate",
      "fromDateTime" : "2012-11-01T00:00:00-07:00",
      "toDateTime" : "2012-12-01T00:00:00-08:00",
      "rateType" : "COST_PER_UNIT",
      "chargeClass" : "SUPPLY,CONTRACTED",
      "quantityKey" : "consumption",
      "itemQuantity" : 3600.0,
      "rateAmount" : 0.086,
      "cost" : 309.6
    },
...

Example 2. A 10% Discount on the Utility Rate

Sometimes rather than a given price per kWh, your customer is given a discount over the price to compare. The calculator handles that too, using a rate factor.

"rateInputs":[
      {
         "chargeClass":"CONTRACTED",
         "rateBands":[
            {
               "calculationFactor":0.9
            }
         ]
      }
   ]

Example 3. Price Blocks – 8.6¢ for the first 100,000 kWh, then 9.2¢

For larger commercial and industrial customers, there might be block prices. For that we can support banded rates.

...
  "rateInputs":[
      {
         "chargeClass":"CONTRACTED",
         "rateBands":[
            {
               "consumptionUpperLimit":100000,
               "rateAmount":.086
            },
            {
               "consumptionUpperLimit":null,
               "rateAmount":.092
            }            

         ]
      }
   ]

Above are the 3 most common scenarios. Our calculator can also handle even more complex supply contracts too. Drop us a line with questions.

This entry was posted in API, Developers, Info and tagged , , , , . Bookmark the permalink. Both comments and trackbacks are currently closed.
  • Categories

  • Archives