Tariffs API

tariffId

Long

M

Unique Arcadia ID (primary key) for this tariff

masterTariffId

Long

M

Unique Arcadia ID that persists across all revisions of this tariff

tariffCode

String

M

Shortcode that the LSE uses as an alternate name for the tariff

tariffName

String

M

Name of the tariff as used by the LSE

tariffBookName

String

E

Name of the tariff as it appears in the tariff document

lseId

Long

M

ID of load serving entity this tariff belongs to

lseName

String

M

Name of the load-serving entity

lseCode

String

E

Abbreviated name of the load-serving entity

serviceType

String

M

Type of service for the tariff. Current values include ELECTRICITY (grid power), SOLAR_PV (for a Solar PPA, Lease or similar) and GAS (Natural Gas)

priorTariffId

Long

Unique Arcadia ID that identifies the prior revision of the tariffId above

distributionLseId

Long

In states like Texas where the load-serving entity that sells the power is different than the load-serving entity that distributes the power, this will contain the ID of the distribution LSE. Otherwise, it will be null.

tariffType

String

Possible values are:
DEFAULT - tariff that is automatically given to this service class
ALTERNATIVE - opt-in alternate tariff for this service class
OPTIONAL_EXTRA - opt-in extra, such as green power or a smart thermostat program
RIDER - charge that can apply to multiple tariffs. Often a regulatory-mandated charge

customerClass

String

Possible values are:
RESIDENTIAL - homes, apartments etc.
GENERAL - commercial, industrial, and other business and organization service types (often have additional applicability criteria)
SPECIAL_USE - examples are government, agriculture, street lighting, transportation
PROPOSED - Utility rates that have been proposed by utilities and approved by utility commissions, but are not yet effective (requires product subscription)

customerCount

Integer

Number of customers that are on this master tariff

customerLikelihood

Decimal

The likelihood that a customer is on this tariff of all the tariffs in the search results. Only populated when getting more than one tariff.

customerCountSource

String

E

Where we got the customer count numbers from. Typically FERC (form 1 filings) or Arcadia (our own estimates).

territoryId

String

ID of the territory that this tariff applies to. This is typically the service area for the LSE in this regulatory region (i.e. a state in the USA)

effectiveDate

DateTime

Date on which the tariff was or will be effective

endDate

DateTime

Date on which this tariff is no longer effective. Can be null which means end date is not known or tariff is open-ended

closedDate

Date

E

Date on which a tariff became closed to new customers, but still available for customers who were on it at the time. Can be null which means that the tariff is not closed. All versions of a particular tariff (i.e. those that share a particular masterTariffId) will have the same closedDate value.

effectiveOnRule

String

Property of the tariff determining when the tariff takes effect. Possible values: TARIFF_EFFECTIVE_DATE, BILLING_PERIOD_START

timeZone

String

If populated (usually is), it's the timezone that this tariffs dates and times refer to

billingPeriod

String

How frequently bills are generated.

currency

String

ISO Currency code that the rates for this tariff refer to (e.g. USD for USA Dollar)

chargeTypes

String

A comma-separated list of all the different ChargeType rates on this tariff (see field on TariffRate below).

chargePeriod

String

The most fine-grained period for which charges are calculated.

minMonthlyConsumption

Decimal

E

When applicable, the minimum monthly consumption allowed to be eligible for this tariff.

maxMonthlyConsumption

Decimal

E

When applicable, the maximum monthly consumption allowed to be eligible for this tariff.

minMonthlyDemand

Decimal

E

When applicable, the minimum monthly demand allowed to be eligible for this tariff.

maxMonthlyDemand

Decimal

E

When applicable, the maximum monthly demand allowed to be eligible for this tariff.

hasTimeOfUseRates

Boolean

Indicates whether this tariff contains one or more Time of Use Rate.

hasTieredRates

Boolean

Indicates whether this tariff contains one or more Tiered Rate.

hasContractedRates

Boolean

Indicates whether this tariff contains one or more Rate that can be contracted (sometimes called by-passable or associated with a price to compare).

hasTariffApplicability

Boolean

E

Indicates that this tariff has additional eligibility criteria, as specified in the TariffProperty collection (below).

hasRateApplicability

Boolean

Indicates that one or more rates on this tariff are only applicable to customers with a particular circumstance. When true, this will be specified in the TariffProperty collection, and also on the TariffRate or rates in question.

hasNetMetering

Boolean

E

Indicates whether this tariff contains one or more net metered rates.

privacy

String

E

Privacy status of the tariff. Possible values are PUBLIC, UNLISTED, or PRIVATE.

properties

List of TariffProperty

The properties on this tariff. See below for the TariffProperty structure.

rates

List of TariffRate

The rates for this tariff. See below for TariffRate structure

documents

List of TariffDocument

The documents for this tariff. See below for TariffDocument structure

tariffRateId

Long

M

Unique Arcadia ID (primary key) for each tariff rate

tariffId

Long

M

Associates the rate with a tariff (foreign key)

riderTariffId

Long

E

Tariff ID of the rider attached to this tariff version. null otherwise

riderId

Long

M

Master Tariff ID of the rider linked to this tariff rate.

tariffSequenceNumber

Integer

M

Sequence of this rate in the tariff, for display purposes only (e.g. this is the order on the bill)

tariffBookSequenceNumber

Integer

E

Sequence of this rate in the tariff source document, if it differs from tariffSequenceNumber

rateGroupName

String

M

Name of the group this rate belongs to

tariffBookRateGroupName

String

E

Name of the group this rate belongs to in the tariff source document, if it differs from rateGroupName

rateName

String

M

Name of this rate. Can be null (in which case use the group name)

tariffBookRateName

String

E

Name of this rate in the tariff source document, if it differs from rateName

fromDateTime

DateTime

If populated, this indicates the rate's effective date is not the same as that of its tariff

toDateTime

DateTime

If populated, this indicates the rates end date is not the same as that of its tariff

territory

Territory

Only populated when this rate applies to a different region than the whole tariff (e.g. California Baseline Regions). This how-to has more.

season

Season

The season this rate applies to. Only used for seasonal rates (null otherwise)

timeOfUse

TimeOfUse

The time period this rate applies to. Only used for TOU rates (null otherwise)

chargeType

String

Possible values are:
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, overriding lower pre-tax charges
MAXIMUM - a maximum amount that the LSE will charge you, overriding higher pre-tax charges
TAX - a percentage tax rate which is applied to the sum of all of the other charges on a bill

chargeClass

String

A comma-separated string that indicates what class(es) of charges this rate is for. Values include:
SUPPLY - Energy-related charges.
TRANSMISSION - Transmission level delivery charges.
DISTRIBUTION - Distribution level (last mile) delivery charges of moving electricity into your home or business.
TAX - Tax surcharges that appear in the utility tariff document.
CONTRACTED - Charges that get replaced or overridden when you pass the retail (contracted) energy supply rate in the calculation.
USER_ADJUSTED - Additional or custom rates you can add to a public or private tariff. An example would be a local tax rate which Arcadia does not model but you would want included.
AFTER_TAX - Charges which apply post utility and other taxes. A good example would be the California Climate credit which is applied to the bill after the taxes are applied to the bill subtotal.
OTHER - Charges which cannot be classified in any of the above buckets. This is very rare. NON_BYPASSABLE - Charges which cannot be offset by credits (usually Net Metering)

chargePeriod

String

Indicates what period this charge is calculated for. This is usually the same as the billing period (and is usually monthly) but can be other intervals. Possible values are:
MONTHLY - each calendar month
DAILY - calculated for each day
QUARTERLY - every 3 months
ANNUALLY - every year

transactionType

String

E

Indicates whether this rate is BUY (charge when importing from the grid, no credit when exporting), SELL (credit when exporting to the grid, no charge when importing), or NET (charge when importing, credit when exporting) with imports and exports resolved according to the chargePeriod. BUY_IMPORT (charge only when importing) and SELL_EXPORT (credit only when exporting) indicates that imports and exports are resolved in real-time (instantaneous netting).

quantityKey

String

When not null, the property that defines the type of quantity this rate applies to. (e.g. billingMeter : property which defines the number of billing meters the rate will apply to)

applicabilityKey

String

When not null, the property that defines the eligibility criteria for this rate. (e.g. connectionType : property which defines how the service is connected to the grid)

variableLimitKey

String

When populated this defines the variable which determines the upper limit(s) of this rate. (e.g. demandMultiplierTierswithkWhTiers2416: property which uses the demand value to drive the consumption limits)

variableRateKey

String

When not null, this is the name of the property that defines the variable rate. In this case, the rate field is null, or can (rarely) be used as an input to the determination of the variable rate. (e.g massachusettsResidentialRetailPrevailingRates : property which provides the regional prevailing residential supply rate for Massachusetts )

variableFactorKey

String

When not null, this is the name of the property that defines the variable factor to apply to this rate. (e.g billingPeriodProrationFactor: property which defines a prorated number of billing days)

rateBands

List of TariffRateBand

See the data definition below

tariffRateBandId

Long

Unique Arcadia ID (primary key) for each Band

tariffRateId

Long

ID of the rate this band belongs to (foreign key)

rateSequenceNumber

Integer

This bands position in the bands for its rate

hasConsumptionLimit

Boolean

true indicates that this has banded consumption

consumptionUpperLimit

Decimal

When hasConsumptionLimit is true, this indicates the upper consumption limit of this band. null means no upper limit

hasDemandLimit

Boolean

true indicates that this has banded demand

demandUpperLimit

Decimal

When hasDemandLimit is true, this indicates the upper demand limit of this band. null means no upper limit

hasPropertyLimit

Boolean

true indicates that this has a limit based on a property

propertyUpperLimit

Decimal

When hasPropertyLimit is true, this indicates the upper limit of this band. null means no upper limit

prevUpperLimit

Integer

The upper limit of the previous rate band for this rate

applicabilityValue

String

When not null, this indicates the value of applicability property that qualifies for this rate.

calculationFactor

Decimal

A factor to be applied to the cost of the rate.

rateAmount

Decimal

Charge amount for this band

rateUnit

String

Possible values are:
COST_PER_UNIT - rate amount multiplied by the number of units
PERCENTAGE - percentage of a value (e.g. percentage of overall bill)

isCredit

Boolean

When true this band is a credit amount (reduces the bill)