Webhook posted when a new utility statement is discovered.
Request Body Schema
Property name | Data type | Required? | Description |
---|---|---|---|
type | string | yes | Value: "new_utility_statement_available" |
created_at | string <date-time> | yes | |
data | object (UtilityStatement) | yes |
UtilityStatement
Property name | Data type | Required? | Description |
---|---|---|---|
| integer | yes | |
| string | yes | |
| null or object (Tariff) | yes | Information about a tariff. |
| string | yes | The list of supported Arcadia utilities can be found here. |
| string | yes | Provides greater detail than |
| integer | yes | |
| string <date> | yes | |
| null or string <date> | yes | |
| string <date> | yes | |
| string <date> | yes | |
| integer | yes | |
| number | yes | Total dollar amount billed by the utility on this statement. |
| null or number | yes | Total dollar amount billed by the energy supplier. Note: Not available for all utilities yet. |
| null or number | yes | Total dollar amount billed by the utility for natural gas. Note: Not available for all utilities that provide gas service yet. |
| null or boolean | yes | |
| string <date-time> | yes | |
| string <date-time> | yes | |
| boolean | yes | |
| null or string <uri> | yes | A url to the utility created PDF bill for this statement. Note that this url will only be valid for 600 seconds. |
| boolean or null | yes | Indicates if this is the final bill that this account will receive before closing. |
| array of objects (BillingFlags) | yes | Not applicable for historical Utility Statements. |
| null or object (VirtualNetMetering) | yes | Details on the customer's virtual net metering credit data. Currently only supported for National Grid New York and Central Maine Power |
| null or object (MostRecentPaymentDetail) | yes | Detail on the most recent payment. Currently only supported for National Grid Massachusetts and NYSEG. |
| boolean | yes | Indicates that the service window for this UtilityStatement includes the service_end_date. |
| null or object (CommercialLineItemsDetail) | yes | This field is in beta. Click here for a description on Arcadia's release phases. -- Details on line items specific to commercial accounts. Currently only supported for the ConEd utility. |
Tariff
Property name | Data type | Required? | Description |
---|---|---|---|
main_tariff_id | string | yes | The Genability 'masterTariffId' unique identifier for this tariff. See Genability documentation for details. |
supplier_name | string or null | yes | 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 | yes | Abbreviation code of the tariff used for this calculation. |
tariff_name | string | yes | Full name of the tariff used for this calculation. |
utility_name | string | yes | Name of the utility associated with this tari |
property_inputs | array | yes | Properties applied to this tariff which may affect the calculated cost of electricity. |
CommercialLineItemsDetail
Property name | Data type | Required? | Description |
---|---|---|---|
supply_energy_kwh | number or null | yes | The energy supply cost, in dollars. |
supply_demand_kw | number or null | yes | |
supply_demand_cost | number or null | yes | The demand supply cost, in dollars. |
supply_customer_charge | number or null | yes | The customer charge for energy supply, in dollars. |
supply_merchant_function_charge | number or null | yes | The charge for merchant function in energy supply, in dollars. |
supply_taxes | number or null | yes | Any other charges for taxes on energy supply, in dollars. |
supply_total_charge | number or null | yes | The total cost of energy supply, in dollars. |
delivery_energy_kwh | number or null | yes | The energy delivery cost, in dollars. |
delivery_energy_cost | number or null | yes | The energy delivery cost, in dollars. |
delivery_demand_kw | number or null | yes | |
delivery_demand_cost | number or null | yes | The demand delivery cost, in dollars. |
delivery_customer_charge | number or null | yes | The customer charge for energy delivery, in dollars. |
delivery_system_benefit_cost | number or null | yes | The delivery system benefit cost, in dollars. |
delivery_processing_charge | number or null | yes | The delivery processing charge, in dollars. |
delivery_taxes | number or null | yes | Any other charges for taxes on energy delivery, in dollars. |
delivery_total_charge | number or null | yes | The total cost of energy delivery, in dollars. |
sales_tax | number or null | yes | Sales taxes applied to the total bill, in dollars. |
electric_charge | number or null | yes | The total combined charge for this bill - supply, delivery, and taxes - in dollars. |
BillingFlags
Property name | Data type | Required? | Description |
---|---|---|---|
type | string | yes | Enum: "possible_rebill" |
details | object | yes | { conflicting_utility_statement_id: integer} |
MostRecentPaymentDetail
Property name | Data type | Required? | Description |
---|---|---|---|
most_recent_payment_received_amount | number | yes | Total dollar amount received on the most recent payment. |
most_recent_payment_received_date | string | yes | The date of the most recent payment. |
VirtualNetMetering
Property name | Data type | Required? | Description |
---|---|---|---|
current_cycle_generated_credits | number or null | yes | The amount of credits generated during the current cycle, in dollars |
current_cycle_applied_credits | number or null | yes | The amount of credits applied during the current cycle, in dollars |
last_cycle_carry_over_credits | number or null | yes | The amount of credits carried over from the last cycle, in dollars |
next_cycle_carry_over_credits | number or null | yes | The amount of credits carried over to the next cycle, in dollars |
current_cycle_generated_kwh | number or null | yes | The kwh generated during the current cycle |
current_cycle_applied_kwh | number or null | yes | The kwh applied during the current cycle |
last_cycle_carry_over_kwh | number or null | yes | The kwh carried over to the next cycle |
next_cycle_carry_over_kwh | number or null | yes | The kwh carried over to the next cycle |
current_cycle_expiring_kwh | number or null | yes | The kwh that are expiring during the current cycle |
Request sample
Content type: application/json
{
"type": "new_utility_statement_available",
"created_at": "2019-08-24T14:15:22Z",
"data": {
"id": 123,
"client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
"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"
},
"utility_name": "PG&E",
"utility_long_name": "Pacific Gas & Electric",
"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,
"past_due": false,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"sandboxed": false,
"pdf_url": null,
"final_bill": false,
"virtual_net_metering": null,
"service_window_inclusive_of_end_date": true,
"most_recent_payment_detail": null,
"commercial_line_items_detail": null
}
}