Utility Account Updated

Webhook posted when any information changes on a utility account

Request Body Schema

Property nameData typeRequired?Description
typestringyesValue: "utility_account_updated"
created_atstring <date-time>yes
dataobject (UtilityAccount)yes

UtilityAccount

Property nameData typeRequired?Description
idintegeryes
client_user_idstringyes
utility_namestringyes
utility_credential_idintegeryes
account_numberstringyesThe account number used by the utility to identify this UtilityAccount
service_address_street_onenull or stringyes
service_address_street_twonull or stringyes
service_address_statenull or stringyes
service_address_zipnull or stringyes
service_address_street_twonull or stringyes
service_customer_namenull or stringyes
supplier_account_idnull or stringyesUtility specific account identifier for energy suppliers.
statusstringyesEnum: "active" "closed" "incomplete" "locked" "unknown"
most_recent_tariffobject (MostRecentTariff)yesInformation about a tariff.
flagsArray of stringsyesItems Value: "utility_statement_past_due"
servicesArray of stringsyesItems Enum: "electric" "gas" "water"
created_atstring <date-time>yes
updated_atstring <date-time>yes
feature_availabilityobject (FeatureAvailability)yes
utility_metersArray of objects (UtilityMeter)yes
sandboxedbooleanyes

MostRecentTariff

Property nameData typeRequired?Description
main_tariff_idstringyesThe Genability 'masterTariffId' unique identifier for this tariff. See Genability documentation for details.
supplier_namestring or nullnoThe 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_codestringyesAbbreviation code of the tariff used for this calculation.
tariff_namestringyesFull name of the tariff used for this calculation.
utility_namestringyesName of the utility associated with this tariff
tariff_as_of_datestring or null <date>yesThe statement date of the utility statement that reported use of this tariff

FeatureAvailability

Property nameData typeRequired?Description
charge_coststring (Availability)yesEnum: "AVAILABLE" "NOT_AVAILABLE" "NOT_READY"
smart_chargestring (Availability)yesEnum: "AVAILABLE" "NOT_AVAILABLE" "NOT_READY"
utility_intervalsstring (Availability)yesEnum: "AVAILABLE" "NOT_AVAILABLE" "NOT_READY"
utility_statementsstring (Availability)yesEnum: "AVAILABLE" "NOT_AVAILABLE" "NOT_READY"
hosted_paymentsstring (Availability)yesEnum: "AVAILABLE" "NOT_AVAILABLE" "NOT_READY"
utility_remittancestring (Availability)yesEnum: "AVAILABLE" "NOT_AVAILABLE" "NOT_READY"

UtilityMeter

Property nameData typeRequired?Description
idintegeryes
client_user_idstringyes
utility_credential_idintegeryes
utility_account_idintegeryes
meter_numberstringyes
service_typestringyesEnum: "electric" "gas" "water"
created_atstring yes
updated_atstring yes
sandboxedbooleanyes

Request sample

Content type: application/json

{
  "type": "utility_account_updated",
  "created_at": "2019-08-24T14:15:22Z",
  "data": {
    "client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
    "utility_credential_id": 1234,
    "utility_account": {
      "id": 12345,
      "client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
      "utility_name": "Pepco",
      "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": {
        "master_tariff_id": "gen_mtid_3331108",
        "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
    }
  }
}