Sign in

v1

latestOpenAPI 3.1.02026-07-1342111193.6 KB
Plug

Get Utility Statement

Returns a single UtilityStatement specified by ID.

get/plug/utility_statements/{utility_statement_id}

Path parameters

utility_statement_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_account_idinteger required
statement_datestring date required
due_datestring date nullable required
service_start_datestring date required
service_end_datestring date required
kwhinteger required
utility_chargenumber required

Total dollar amount billed by the utility on this statement.

supplier_chargenumber nullable required

Total dollar amount billed by the energy supplier.

Note: Not available for all utilities.

gas_chargenumber nullable required

Total dollar amount billed by the utility for natural gas.

Note: Not available for all utilities that provide gas service.

past_dueboolean nullable required
created_atstring date-time required
updated_atstring date-time required
sandboxedboolean required
pdf_urlstring uri nullable required

A url to the utility created PDF bill for this statement. Note that this url will only be valid for 600 seconds.

final_billboolean nullable required

Indicates if this is the final bill that this account will receive before closing.

service_window_inclusive_of_end_dateboolean required

Indicates that the service window for this UtilityStatement includes the service_end_date.

Example response

{
  "id": 123,
  "client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
  "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"
  },
  "utility_name": "AEP SWEPCO",
  "utility_long_name": "AEP SWEPCO AR",
  "utility_account_id": 2243,
  "statement_date": "2019-08-24",
  "due_date": "2019-09-24",
  "service_start_date": "2019-08-24",
  "service_end_date": "2019-09-24",
  "kwh": 100,
  "utility_charge": 90.33,
  "supplier_charge": 41.54,
  "gas_charge": 23.32,
  "service_window_inclusive_of_end_date": true,
  "net_metering": {
    "current_cycle_generated_kwh": 40.57
  },
  "virtual_net_metering": {
    "current_cycle_generated_credits": 100.15,
    "current_cycle_applied_credits": 90.33,
    "last_cycle_carry_over_credits": 3.83,
    "next_cycle_carry_over_credits": 5.99,
    "current_cycle_generated_kwh": 40,
    "current_cycle_applied_kwh": 30,
    "last_cycle_carry_over_kwh": 5,
    "next_cycle_carry_over_kwh": 10,
    "current_cycle_expiring_kwh": 5,
    "current_cycle_allocation_percentage": "0.05",
    "cdg_net_credit": 10
  },
  "most_recent_payment_detail": {
    "most_recent_payment_received_amount": 50.5,
    "most_recent_payment_received_date": "2023-08-24"
  }
}