--- title: "List Utility Statements" method: GET path: "/plug/utility_statements" tags: ["Plug"] --- # List Utility Statements `GET /plug/utility_statements` Returns a paginated list of UtilityStatements for all users, or filtered by `utility_account_id`. Default ordered by descending `updated_at`. ## Query parameters - `client_user_id` string - `utility_account_id` integer - `limit` integer - `updated_after` string, date-time - `updated_before` string, date-time - `order` 'asc' | 'desc' ## Headers - `Arcadia-Version` string, required ## Response `200` Success - PaginatedUtilityStatements - `data` UtilityStatement[], required - `id` integer, required - `client_user_id` string, required - `tariff` Tariff, required — Information about a tariff. - `main_tariff_id` string, required — The Genability 'masterTariffId' unique identifier for this tariff. See [Genability documentation](https://developer.genability.com/api-reference/tariff-api/tariff/) for details. - `property_inputs` object[] — Properties applied to this tariff which may affect the calculated cost of electricity. - `id` string, required - `value` union, required - boolean - number - string - `supplier_name` string, nullable — 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, required — Abbreviation code of the tariff used for this calculation. - `tariff_name` string, required — Full name of the tariff used for this calculation. - `utility_name` string, required — Name of the utility associated with this tariff - `utility_name` string, required — The list of supported Arcadia utilities can be found [here](https://arc.arcadia.com/coverage?first=25&page=1). - `utility_long_name` string, required — Provides greater detail than `utility_name`. The list of supported Arcadia utilities can be found [here](https://arc.arcadia.com/coverage?first=25&page=1). - `utility_account_id` integer, required - `statement_date` string, date, required - `due_date` string, date, nullable, required - `service_start_date` string, date, required - `service_end_date` string, date, required - `kwh` integer, required - `utility_charge` number, required — Total dollar amount billed by the utility on this statement. - `supplier_charge` number, nullable, required — Total dollar amount billed by the energy supplier. **Note**: Not available for all utilities. - `gas_charge` number, nullable, required — Total dollar amount billed by the utility for natural gas. **Note**: Not available for all utilities that provide gas service. - `past_due` boolean, nullable, required - `created_at` string, date-time, required - `updated_at` string, date-time, required - `sandboxed` boolean, required - `pdf_url` string, 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_bill` boolean, nullable, required — Indicates if this is the final bill that this account will receive before closing. - `service_window_inclusive_of_end_date` boolean, required — Indicates that the service window for this UtilityStatement includes the service_end_date. - `net_metering` object, nullable — Details on the customer's net metering credit data. Currently only supported for Versant. - `current_cycle_generated_kwh` number, nullable, required — The kwh generated during the current cycle - `virtual_net_metering` object, nullable, required — Details on the customer's virtual net metering credit data. Currently only supported for National Grid New York and Central Maine Power. - `current_cycle_generated_credits` number, nullable, required — The amount of credits generated during the current cycle, in dollars - `current_cycle_applied_credits` number, nullable, required — The amount of credits applied during the current cycle, in dollars - `last_cycle_carry_over_credits` number, nullable, required — The amount of credits carried over from the last cycle, in dollars - `next_cycle_carry_over_credits` number, nullable, required — The amount of credits carried over to the next cycle, in dollars - `current_cycle_generated_kwh` number, nullable, required — The kwh generated during the current cycle - `current_cycle_applied_kwh` number, nullable, required — The kwh applied during the current cycle - `last_cycle_carry_over_kwh` number, nullable, required — The kwh carried over to the next cycle - `next_cycle_carry_over_kwh` number, nullable, required — The kwh carried over to the next cycle - `current_cycle_expiring_kwh` number, nullable, required — the kwh that are expiring during the current cycle - `current_cycle_allocation_percentage` string, nullable, required — the fixed allocation percentage during the current cycle - `cdg_net_credit` number, nullable, required — The net credit from the community solar project, in dollars - `most_recent_payment_detail` object, nullable, required — Detail on the most recent payment. Currently only supported for National Grid Massachusetts and NYSEG. - `most_recent_payment_received_amount` number, nullable, required — Total dollar amount received on the most recent payment. - `most_recent_payment_received_date` string, date, nullable, required — The date of the most recent payment. - `commercial_line_items_detail` object, nullable, required — This field is in *beta*. Click [here](release-phases) for a description on Arcadia's release phases. -- Details on line items specific to commercial accounts. Currently only supported for the ConEd utility. - `supply_energy_kwh` number, nullable, required - `supply_energy_cost` number, nullable, required — The energy supply cost, in dollars. - `supply_demand_kw` number, nullable, required - `supply_demand_cost` number, nullable, required — The demand supply cost, in dollars. - `supply_customer_charge` number, nullable, required — The customer charge for energy supply, in dollars. - `supply_merchant_function_charge` number, nullable, required — The charge for merchant function in energy supply, in dollars. - `supply_taxes` number, nullable, required — Any other charges for taxes on energy supply, in dollars. - `supply_total_charge` number, nullable, required — The total cost of energy supply, in dollars. - `delivery_energy_kwh` number, nullable, required - `delivery_energy_cost` number, nullable, required — The energy delivery cost, in dollars. - `delivery_demand_kw` number, nullable, required - `delivery_demand_cost` number, nullable, required — The demand delivery cost, in dollars. - `delivery_customer_charge` number, nullable, required — The customer charge for energy delivery, in dollars. - `delivery_system_benefit_cost` number, nullable, required — The delivery system benefit cost, in dollars. - `delivery_processing_charge` number, nullable, required — The delivery processing charge, in dollars. - `delivery_taxes` number, nullable, required — Any other charges for taxes on energy delivery, in dollars. - `delivery_total_charge` number, nullable, required — The total cost of energy delivery, in dollars. - `sales_tax` number, nullable, required — Sales taxes applied to the total bill, in dollars. - `electric_charge` number, nullable, required — The total combined charge for this bill - supply, delivery, and taxes - in dollars. - `billing_flags` object[], required — These flags may be of interest if the corresponding Utility Account is enrolled in Bundle. - `type` 'possible_rebill' — The 'possible_rebill' flag indicates that this Utility Statement may be a duplicate or variation of a previous Utility Statement - `details` object - `conflicting_utility_statment_id` integer - `total_count` integer, required ## Other responses - `404` — Not Found - `422` — Unprocessable Entity --- [API](https://skmtc.dev/arcadia/apis/arcadia-api-reference.md) · [All operations](https://skmtc.dev/arcadia/apis/arcadia-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/arcadia/arcadia-api-reference/revisions/468f1c903722/schema)