v1
latestOpenAPI 3.1.02026-07-1342111193.6 KBPlug
List Utility Statements
Returns a paginated list of UtilityStatements for all users, or filtered by utility_account_id. Default ordered by descending updated_at.
get/plug/utility_statements
Query parameters
client_user_idstring
A client_user_id to filter the list of returned items by. This field is deprecated, prefer to use utility_account_id instead.
utility_account_idinteger
A utility account id to filter the list of returned items by.
limitinteger
updated_afterstring date-time
ISO8601 datetime, used to traverse paginated responses. Use of this parameter is mutually exclusive with updated_before.
updated_beforestring date-time
ISO8601 datetime, used to traverse paginated responses. Use of this parameter is mutually exclusive with updated_after.
order'asc' | 'desc'
Used to specify the order in which records should be returned. Currently ordered by updated_at timestamp.
Headers
Arcadia-Versionstring required
The Arcadia-Version for the request
Response
Success
Example response
{
"data": [
{
"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"
}
}
],
"total_count": 1
}