Sign in

v1

latestOpenAPI 3.1.02026-07-1342111193.6 KB
Utility Accounts

Get Utility Account

Returns a single UtilityAccount specified by ID.

get/utility_accounts/{utility_account_id}

Path parameters

utility_account_idinteger required

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Response

Success

idinteger required
client_user_idstring required
utility_namestring required

The list of supported Arcadia utilities can be found here.

utility_long_namestring required

Provides greater detail than utility_name. The list of supported Arcadia utilities can be found here.

utility_credential_idinteger required
account_numberstring nullable required

The account number used by the utility to identify this UtilityAccount

service_address_street_onestring nullable required
service_address_street_twostring nullable required
service_address_citystring nullable required
service_address_statestring nullable required
service_address_zipstring nullable required
service_customer_namestring nullable required
supplier_account_idstring nullable required

Utility specific account identifier for energy suppliers.

status'active' | 'closed' | 'incomplete' | 'locked' | 'unknown' nullable required
flagsstring[] required
servicesstring[] required
created_atstring date-time required
updated_atstring date-time required
sandboxedboolean required

Example response

{
  "id": 12345,
  "client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
  "utility_name": "AEP SWEPCO",
  "utility_long_name": "AEP SWEPCO AR",
  "utility_credential_id": 54321,
  "account_number": "7626177069",
  "service_address_street_one": "1060 W Addison",
  "service_address_street_two": "Apartment 1",
  "service_address_city": "Chicago",
  "service_address_state": "IL",
  "service_address_zip": "60613",
  "service_customer_name": "Joan Arcadia",
  "supplier_account_id": "123456789",
  "most_recent_tariff": {
    "main_tariff_id": "gen_mtid_3331108",
    "property_inputs": [
      {
        "id": "territoryId"
      }
    ],
    "supplier_name": "East Bay Community Energy",
    "tariff_code": "EV-2A-TOU",
    "tariff_name": "Residential - Time of Use - Plug-In Electric Vehicle 2",
    "utility_name": "Pacific Gas & Electric",
    "tariff_as_of_date": "2021-03-01"
  },
  "utility_meters": [
    {
      "id": 12345,
      "client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
      "utility_credential_id": 54321,
      "utility_account_id": 65432,
      "meter_number": "12300000045 67"
    }
  ]
}