Calculate API

Time	Status	User Agent
Retrieving recent requests…

masterTariffId

int64

required

Unique Arcadia ID for the master tariff of this tariff version.

fromDateTime

date

required

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

Starting date and time for this calculation.

toDateTime

date

required

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

End date and time for this calculation.

propertyInputs

array of objects

required

Specify the usage data and applicabilities for the calculation as an Array of PropertyData

propertyInputs*

detailLevel

string

enum

Defaults to ALL

Toggles the level of details for the calculation result.

Allowed:

groupBy

string

enum

Defaults to MONTH

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

Allowed:

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

zipCode

string

See examples for the cases when you need location data. When populating this field you should also populate country too. (Optional and usually not needed)

country

string

Use this when passing in a zipCode or postCode, and set it to the ISO Country Code of your zipCode since some countries use the same format (Use with zipCode)

address

object

An alternative to using zipCode and country. (Optional and usually not needed)

tariffEffectiveOn

date

This field enables doing a calculation with a single, specified version of a given tariff. For example, if the user specifies that they want to use the 2016-01-01 version of PG&E’s E-1 tariff, any calculation, regardless of it's time range, would use the rate data from that version and only that version of the tariff.

rateInputs

array of objects

The rate input values are used to override existing rates on the tariff during the calculation. This enables modeling and/or setting customer specific rates during a calculation.

rateInputs

minimums

boolean

Defaults to true

This field enables enforcing minimum charges on this calculation.

billingPeriod

boolean

Defaults to false

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 location. (Optional, Default = true when zipCode and country, or address provided, false otherwise)

200200

400400