Request Body Schema

Property name	Data type	Required?	Description
`type`	string	yes	Value: `"utility_accounts_discovered"`
`created_at`	string <date-time>	yes
`data`	object (Data)	yes

Data

Property name	Data type	Required?
`client_user_id`	string	yes
`utility_credential_id`	integer	yes
`utility_accounts`	Array of objects (UtilityAccount)	yes

UtilityAccount

Property name	Data type	Required?	Description
`id`	integer	yes
`client_user_id`	string	yes
`utility_name`	string	yes	The list of supported Arcadia utilities can be found here.
`utility_long_name`	string	yes	Provides greater detail than `utility_name`. The list of supported Arcadia utilities can be found here.
`utility_credential_id`	integer	yes
`account_number`	null or string	yes	The account number used by the utility to identify this UtilityAccount
`service_address_street_one`	null or string	yes
`service_address_street_two`	null or string	yes
`service_address_state`	null or string	yes
`service_address_zip`	null or string	yes
`service_customer_name`	null or string	yes
`supplier_account_id`	null or string	yes	Utility specific account identifier for energy suppliers.
`status`	null or string	yes	Enum: `"active"` `"closed"` `"incomplete"` `"locked"` `"unknown"`
`most_recent_tariff`	object (MostRecentTariff)	yes	Information about a tariff.
`flags`	Array of strings	yes	Items Value: `"utility_statement_past_due"`
`services`	Array of strings	yes	Items Enum: `"electric"` `"gas"` `"water"`
`created_at`	string <date-time>	yes
`updated_at`	string <date-time>	yes
`feature_availability`	object (FeatureAvailability)	yes
`utility_meters`	Array of objects (UtilityMeter)	yes
`sandboxed`	boolean	yes

MostRecentTariff

Property name	Data type	Required?	Description
`main_tariff_id`	string	yes	The Genability 'masterTariffId' unique identifier for this tariff. See Genability documentation for details.
`supplier_name`	string or null	no	The name of the retail electricity supplier or the community choice aggregator. If there is no retail electricity supplier or community choice aggregator, this field is null.
`tariff_code`	string	yes	Abbreviation code of the tariff used for this calculation.
`tariff_name`	string	yes	Full name of the tariff used for this calculation.
`utility_name`	string	yes	Name of the utility associated with this tariff
`tariff_as_of_date`	string or null <date>	yes	The statement date of the utility statement that reported use of this tariff

FeatureAvailability

Property name	Data type	Required?	Description
`charge_cost`	string (Availability)	yes	Enum: `"AVAILABLE"` `"NOT_AVAILABLE"` `"NOT_READY"`
`smart_charge`	string (Availability)	yes	Enum: `"AVAILABLE"` `"NOT_AVAILABLE"` `"NOT_READY"`
`utility_intervals`	string (Availability)	yes	Enum: `"AVAILABLE"` `"NOT_AVAILABLE"` `"NOT_READY"`
`utility_statements`	string (Availability)	yes	Enum: `"AVAILABLE"` `"NOT_AVAILABLE"` `"NOT_READY"`
`hosted_payments`	string (Availability)	yes	Enum: `"AVAILABLE"` `"NOT_AVAILABLE"` `"NOT_READY"`
`utility_remittance`	string (Availability)	yes	Enum: `"AVAILABLE"` `"NOT_AVAILABLE"` `"NOT_READY"`

UtilityMeter

Property name	Data type	Required?	Description
`id`	integer	yes
`client_user_id`	string	yes
`utility_credential_id`	integer	yes
`utility_account_id`	integer	yes
`meter_number`	string	yes
`service_type`	string	yes	Enum: `"electric"` `"gas"` `"water"`
`created_at`	string <date-time>	yes
`updated_at`	string <date-time>	yes
`sandboxed`	boolean	yes

Request sample

Content type: application/json

{
  "type": "utility_accounts_discovered",
  "created_at": "2019-08-24T14:15:22Z",
  "data": {
    "client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
    "utility_credential_id": 1234,
    "utility_accounts": [
      {
        "id": 12345,
        "client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
        "utility_name": "Pepco",
        "utility_long_name": "Pepco DC",
        "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",
        "status": "active",
        "most_recent_tariff": {
          "main_tariff_id": "gen_mtid_3331108",
          "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"
        },
        "flags": [
          "utility_statement_past_due"
        ],
        "services": [
          "electric"
        ],
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "feature_availability": {
          "charge_cost": "AVAILABLE",
          "smart_charge": "AVAILABLE",
          "utility_intervals": "AVAILABLE",
          "utility_statements": "AVAILABLE",
          "hosted_payments": "AVAILABLE",
          "utility_remittance": "AVAILABLE"
        },
        "utility_meters": [
          {
            "id": 500,
            "client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
            "utility_credential_id": 1234,
            "utility_account_id": 12345,
            "meter_number": "12300000045 67",
            "service_type": "electric",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "sandboxed": false
          }
        ],
        "sandboxed": false
      }
    ]
  }
}