Use Account APIs to create accounts, manage account-level tariff and property data, retrieve account rates, and calculate account energy costs.
Use Account APIs to create accounts, manage account-level tariff and property data, retrieve account rates, and calculate account energy costs.
An account represents a home, facility, or site for your customer. Account data provides the foundation for usage profiles, tariff assignments, account properties, account rates, cost calculations, and savings analyses.
Start with Accounts API to create or retrieve an account, then add properties and tariffs before retrieving rates or running calculations. If you are choosing between API families, see Getting Started.
Create, retrieve, update, and delete accounts that represent customer homes, facilities, or sites.
Store account-specific values used by calculations and tariff applicability checks.
Manage current and historical tariff rate plans associated with an account.
Retrieve rates associated with an account's current and historical tariffs.
Calculate historical bills, month-to-date cost projections, and what-if cost scenarios.
Data Definitions
Account
An Account stores the customer, site, address, tariff, property, and status data used by account-level APIs. Use the account's Arcadia-generated accountId or your own providerAccountId to retrieve and operate on account data.
| Field | Type | Description |
|---|---|---|
accountId | String | Arcadia-generated unique ID for the account. |
providerAccountId | String | Your unique account identifier, when provided. |
accountName | String | Human-readable name for the customer, facility, site, or location. |
address | Object | Address and geolocation data for the account. |
properties | Object | Account-specific values used by calculations and tariff applicability checks. |
tariffs | Array | Tariff assignments, contracted rates, tax rates, and historical tariff changes associated with the account. |
status | String | Account status, such as ACTIVE, INACTIVE, or DELETED. |
How these APIs fit together
- Use Accounts API to create or retrieve the customer home, facility, or site.
- Use Account Properties API to store account-specific values needed for tariff applicability and calculations.
- Use Account Tariffs API to set the account's utility tariff, contracted supply rates, tax rates, or historical tariff changes.
- Use Account Rates API to inspect the tariff rates currently associated with the account.
- Use Account Cost Calculation to calculate bills, projections, or what-if scenarios from the account data.