Property name Data type Required? Description typestring yes Value: "utility_accounts_discovered" created_atstring yes dataobject (Data ) yes
Property name Data type Required? Description client_user_idstring yes utility_credential_idinteger yes utility_accountsArray of objects (UtilityAccount ) yes
Property name Data type Required? Description idinteger yes client_user_idstring yes utility_namestring yes The list of supported Arc utilities can be found here . utility_long_namestring yes Provides greater detail than utility_name. The list of supported Arc utilities can be found here . utility_credential_idinteger yes account_numbernull or string yes The account number used by the utility to identify this UtilityAccount service_address_street_onenull or string yes service_address_street_twonull or string yes service_address_statenull or string yes service_address_zipnull or string yes service_customer_namenull or string yes supplier_account_idnull or string yes Utility specific account identifier for energy suppliers. statusnull or string yes Enum: "active" "closed" "incomplete" "locked" "unknown" most_recent_tariffobject (MostRecentTariff ) yes Information about a tariff. flagsArray of strings yes Items Value: "utility_statement_past_due" servicesArray of strings yes Items Enum: "electric" "gas" "water" created_atstring <date-time> yes updated_atstring <date-time> yes feature_availabilityobject (FeatureAvailability ) yes utility_metersArray of objects (UtilityMeter ) yes sandboxedboolean yes
Property name Data type Required? Description main_tariff_idstring yes The Genability 'masterTariffId' unique identifier for this tariff. See Genability documentation for details. supplier_namestring 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_codestring yes Abbreviation code of the tariff used for this calculation. tariff_namestring yes Full name of the tariff used for this calculation. utility_namestring yes Name of the utility associated with this tariff tariff_as_of_datestring or null <date> yes The statement date of the utility statement that reported use of this tariff
Property name Data type Required? Description charge_coststring (Availability) yes Enum: "AVAILABLE" "NOT_AVAILABLE" "NOT_READY" smart_chargestring (Availability) yes Enum: "AVAILABLE" "NOT_AVAILABLE" "NOT_READY" utility_intervalsstring (Availability) yes Enum: "AVAILABLE" "NOT_AVAILABLE" "NOT_READY" utility_statementsstring (Availability) yes Enum: "AVAILABLE" "NOT_AVAILABLE" "NOT_READY" hosted_paymentsstring (Availability) yes Enum: "AVAILABLE" "NOT_AVAILABLE" "NOT_READY" utility_remittancestring (Availability) yes Enum: "AVAILABLE" "NOT_AVAILABLE" "NOT_READY"
Property name Data type Required? Description idinteger yes client_user_idstring yes utility_credential_idinteger yes utility_account_idinteger yes meter_numberstring yes service_typestring yes Enum: "electric" "gas" "water" created_atstring yes updated_atstring yes sandboxedboolean yes
Content type: application/json
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 Arc",
"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
}
]
}
}
