Mass Calculate API

Time	Status	User Agent
Retrieving recent requests…

fromDateTime

date

required

Defaults to 2022-07-13T00:00:00-07:00

Starting date and time for this request.

toDateTime

date

required

Defaults to 2022-08-11T00:00:00-07:00

End date and time for this request.

detailLevel

string

enum

Defaults to ALL

Toggles the level of details for the calculation result.

Allowed:

scenarios

array of objects

required

A list of the scenarios to calculate. A user-provided identifier for this calculation. If provided, it will be used to identify the scenario in the calculation results. Defaults to a simple index. Format example: "scenarios": [{ "scenarioName": "E-1", "masterTariffId": 522 }, { "scenarioName": "E-6-TOU", "masterTariffId": 525 }, { "scenarioName": "E-6-TOU-SmartRate", "masterTariffId": 525, "propertyInputs": [{ "keyName": "isSmartRateCustomer", "dataValue": true }]

scenarios*

sharedScenario

object

A single scenario, the values for which will be shared among all calculations. Example: "sharedScenario": { "propertyInputs": [{ "keyName": "consumption", "dataValue": 1000 }]

groupBy

string

enum

This controls how the calculation details are grouped. Examples (Defaults to the natural grouping for the rates)

Allowed:

address

object

Specifies the location in which to apply a utility tax. (Required if applyUtilityTax = true)

billingPeriod

boolean

Defaults to true

A true or false flag. If the dates of the calculation represent an actual billing cycle, then you should set this to true. This will give you precise values for items like fixed charges. When it’s not set, or set to false, these charges will be prorated across the number of days in the calculation.

applyUtilityTax

boolean

When true, the calculation attempts to apply a utility tax to the provided address. (Default = true when address provided, else false)

minimums

boolean

This field enables enforcing minimum charges on this calculation.

excludeChargeClass

array of strings

Specifies a charge class to exclude from the calculation results. Available options are TRANSMISSION, DISTRIBUTION, SUPPLY, TAX, CONTRACTED, USER_ADJUSTED, AFTER_TAX, and OTHER.

excludeChargeClass

tariffEffectiveOn

date

Use the version of the tariff that was active on the given date. By default the calculation uses the tariff version(s) effective between fromDateTime and toDateTime.

200200

400400