Arcadia · Schema
UtilityStatement
EnergyUtilitiesClean EnergyBilling DataInterval DataCarbonSolarTariff
Properties
| Name | Type | Description |
|---|---|---|
| id | integer | |
| client_user_id | string | |
| tariff | object | |
| utility_name | string | The list of supported Arcadia utilities can be found [here](https://arc.arcadia.com/coverage?first=25&page=1). |
| utility_long_name | string | 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 | |
| statement_date | string | |
| due_date | string | |
| service_start_date | string | |
| service_end_date | string | |
| kwh | integer | |
| utility_charge | number | Total dollar amount billed by the utility on this statement. |
| supplier_charge | number | Total dollar amount billed by the energy supplier. **Note**: Not available for all utilities. |
| gas_charge | number | Total dollar amount billed by the utility for natural gas. **Note**: Not available for all utilities that provide gas service. |
| past_due | boolean | |
| created_at | string | |
| updated_at | string | |
| sandboxed | boolean | |
| pdf_url | string | 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 | Indicates if this is the final bill that this account will receive before closing. |
| service_window_inclusive_of_end_date | boolean | Indicates that the service window for this UtilityStatement includes the service_end_date. |
| net_metering | object | |
| virtual_net_metering | object | |
| most_recent_payment_detail | object | |
| commercial_line_items_detail | object | |
| billing_flags | array | These flags may be of interest if the corresponding Utility Account is enrolled in Bundle. |
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://api.arcadia.com/schemas/UtilityStatement",
"title": "UtilityStatement",
"required": [
"client_user_id",
"created_at",
"due_date",
"final_bill",
"gas_charge",
"id",
"kwh",
"past_due",
"pdf_url",
"sandboxed",
"service_end_date",
"service_start_date",
"statement_date",
"supplier_charge",
"tariff",
"updated_at",
"utility_account_id",
"utility_charge",
"utility_name",
"utility_long_name",
"service_window_inclusive_of_end_date",
"commercial_line_items_detail",
"billing_flags",
"virtual_net_metering",
"most_recent_payment_detail"
],
"properties": {
"id": {
"type": "integer",
"example": 123
},
"client_user_id": {
"type": "string",
"example": "fff57dc7-3a2b-4395-8a62-e3486d46dabe"
},
"tariff": {
"anyOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Tariff"
}
]
},
"utility_name": {
"type": "string",
"example": "AEP SWEPCO",
"description": "The list of supported Arcadia utilities can be found [here](https://arc.arcadia.com/coverage?first=25&page=1)."
},
"utility_long_name": {
"type": "string",
"example": "AEP SWEPCO AR",
"description": "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": {
"type": "integer",
"example": 2243
},
"statement_date": {
"type": "string",
"format": "date",
"example": "2019-08-24"
},
"due_date": {
"type": "string",
"nullable": true,
"format": "date",
"example": "2019-09-24"
},
"service_start_date": {
"type": "string",
"format": "date",
"example": "2019-08-24"
},
"service_end_date": {
"type": "string",
"format": "date",
"example": "2019-09-24"
},
"kwh": {
"type": "integer",
"example": 100
},
"utility_charge": {
"type": "number",
"example": 90.33,
"description": "Total dollar amount billed by the utility on this statement."
},
"supplier_charge": {
"example": 41.54,
"description": "Total dollar amount billed by the energy supplier.\n\n**Note**: Not available for all utilities.\n",
"type": "number",
"nullable": true
},
"gas_charge": {
"example": 23.32,
"description": "Total dollar amount billed by the utility for natural gas.\n\n**Note**: Not available for all utilities that provide gas service.\n",
"type": "number",
"nullable": true
},
"past_due": {
"type": "boolean",
"nullable": true,
"example": false
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"sandboxed": {
"type": "boolean",
"example": false
},
"pdf_url": {
"format": "uri",
"description": "A url to the utility created PDF bill for this statement. Note that this url will only be valid for 600 seconds.",
"type": "string",
"nullable": true
},
"final_bill": {
"description": "Indicates if this is the final bill that this account will receive before closing.",
"example": false,
"type": "boolean",
"nullable": true
},
"service_window_inclusive_of_end_date": {
"type": "boolean",
"example": true,
"description": "Indicates that the service window for this UtilityStatement includes the service_end_date."
},
"net_metering": {
"anyOf": [
{
"type": "null"
},
{
"type": "object",
"description": "Details on the customer's net metering credit data. Currently only supported for Versant.",
"required": [
"current_cycle_generated_kwh"
],
"properties": {
"current_cycle_generated_kwh": {
"description": "The kwh generated during the current cycle",
"example": 40.57,
"type": "number",
"nullable": true
}
}
}
]
},
"virtual_net_metering": {
"anyOf": [
{
"type": "null"
},
{
"type": "object",
"description": "Details on the customer's virtual net metering credit data. Currently only supported for National Grid New York and Central Maine Power.",
"required": [
"current_cycle_generated_credits",
"current_cycle_applied_credits",
"last_cycle_carry_over_credits",
"next_cycle_carry_over_credits",
"current_cycle_generated_kwh",
"current_cycle_applied_kwh",
"last_cycle_carry_over_kwh",
"next_cycle_carry_over_kwh",
"current_cycle_expiring_kwh",
"current_cycle_allocation_percentage",
"cdg_net_credit"
],
"properties": {
"current_cycle_generated_credits": {
"description": "The amount of credits generated during the current cycle, in dollars",
"example": 100.15,
"type": "number",
"nullable": true
},
"current_cycle_applied_credits": {
"description": "The amount of credits applied during the current cycle, in dollars",
"example": 90.33,
"type": "number",
"nullable": true
},
"last_cycle_carry_over_credits": {
"description": "The amount of credits carried over from the last cycle, in dollars",
"example": 3.83,
"type": "number",
"nullable": true
},
"next_cycle_carry_over_credits": {
"description": "The amount of credits carried over to the next cycle, in dollars",
"example": 5.99,
"type": "number",
"nullable": true
},
"current_cycle_generated_kwh": {
"description": "The kwh generated during the current cycle",
"example": 40,
"type": "number",
"nullable": true
},
"current_cycle_applied_kwh": {
"description": "The kwh applied during the current cycle",
"example": 30,
"type": "number",
"nullable": true
},
"last_cycle_carry_over_kwh": {
"description": "The kwh carried over to the next cycle",
"example": 5,
"type": "number",
"nullable": true
},
"next_cycle_carry_over_kwh": {
"description": "The kwh carried over to the next cycle",
"example": 10,
"type": "number",
"nullable": true
},
"current_cycle_expiring_kwh": {
"description": "the kwh that are expiring during the current cycle",
"example": 5,
"type": "number",
"nullable": true
},
"current_cycle_allocation_percentage": {
"description": "the fixed allocation percentage during the current cycle",
"example": "0.05",
"type": "string",
"nullable": true
},
"cdg_net_credit": {
"description": "The net credit from the community solar project, in dollars",
"example": 10,
"type": "number",
"nullable": true
}
}
}
]
},
"most_recent_payment_detail": {
"anyOf": [
{
"type": "null"
},
{
"type": "object",
"description": "Detail on the most recent payment. Currently only supported for National Grid Massachusetts and NYSEG.",
"required": [
"most_recent_payment_received_amount",
"most_recent_payment_received_date"
],
"properties": {
"most_recent_payment_received_amount": {
"example": 50.5,
"description": "Total dollar amount received on the most recent payment.",
"type": "number",
"nullable": true
},
"most_recent_payment_received_date": {
"type": "string",
"nullable": true,
"format": "date",
"description": "The date of the most recent payment.",
"example": "2023-08-24"
}
}
}
]
},
"commercial_line_items_detail": {
"anyOf": [
{
"type": "null"
},
{
"type": "object",
"description": "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.",
"required": [
"supply_energy_kwh",
"supply_energy_cost",
"supply_demand_kw",
"supply_demand_cost",
"supply_customer_charge",
"supply_merchant_function_charge",
"supply_taxes",
"supply_total_charge",
"delivery_energy_kwh",
"delivery_energy_cost",
"delivery_demand_kw",
"delivery_demand_cost",
"delivery_customer_charge",
"delivery_system_benefit_cost",
"delivery_processing_charge",
"delivery_taxes",
"delivery_total_charge",
"sales_tax",
"electric_charge"
],
"properties": {
"supply_energy_kwh": {
"type": "number",
"nullable": true
},
"supply_energy_cost": {
"description": "The energy supply cost, in dollars.",
"type": "number",
"nullable": true
},
"supply_demand_kw": {
"type": "number",
"nullable": true
},
"supply_demand_cost": {
"description": "The demand supply cost, in dollars.",
"type": "number",
"nullable": true
},
"supply_customer_charge": {
"description": "The customer charge for energy supply, in dollars.",
"type": "number",
"nullable": true
},
"supply_merchant_function_charge": {
"description": "The charge for merchant function in energy supply, in dollars.",
"type": "number",
"nullable": true
},
"supply_taxes": {
"description": "Any other charges for taxes on energy supply, in dollars.",
"type": "number",
"nullable": true
},
"supply_total_charge": {
"description": "The total cost of energy supply, in dollars.",
"type": "number",
"nullable": true
},
"delivery_energy_kwh": {
"type": "number",
"nullable": true
},
"delivery_energy_cost": {
"description": "The energy delivery cost, in dollars.",
"type": "number",
"nullable": true
},
"delivery_demand_kw": {
"type": "number",
"nullable": true
},
"delivery_demand_cost": {
"description": "The demand delivery cost, in dollars.",
"type": "number",
"nullable": true
},
"delivery_customer_charge": {
"description": "The customer charge for energy delivery, in dollars.",
"type": "number",
"nullable": true
},
"delivery_system_benefit_cost": {
"description": "The delivery system benefit cost, in dollars.",
"type": "number",
"nullable": true
},
"delivery_processing_charge": {
"description": "The delivery processing charge, in dollars.",
"type": "number",
"nullable": true
},
"delivery_taxes": {
"description": "Any other charges for taxes on energy delivery, in dollars.",
"type": "number",
"nullable": true
},
"delivery_total_charge": {
"description": "The total cost of energy delivery, in dollars.",
"type": "number",
"nullable": true
},
"sales_tax": {
"description": "Sales taxes applied to the total bill, in dollars.",
"type": "number",
"nullable": true
},
"electric_charge": {
"description": "The total combined charge for this bill - supply, delivery, and taxes - in dollars.",
"type": "number",
"nullable": true
}
}
}
]
},
"billing_flags": {
"type": "array",
"description": "These flags may be of interest if the corresponding Utility Account is enrolled in Bundle.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The 'possible_rebill' flag indicates that this Utility Statement may be a duplicate or variation of a previous Utility Statement",
"enum": [
"possible_rebill"
]
},
"details": {
"type": "object",
"properties": {
"conflicting_utility_statment_id": {
"type": "integer"
}
}
}
}
}
}
},
"additionalProperties": false
}