Savings
GET
17 endpoints
/api/v3/savings/meter/{meterId}/baseline
GenerateBaselineGetV3
Retrieves the current baseline calculation for a meter using its stored settings
/api/v3/savings/meter/{meterId}/adjustment/othersavings
GetAllOtherSavingsV3
Retrieves all "other savings" adjustments for a meter
/api/v3/savings/auc
GetAucRangesV3
Retrieves the average unit cost acceptable range values per commodity for cost avoidance
/api/v3/savings/filters
GetCostAvoidanceFiltersV3
Return available filters for Cost Avoidance processors
Filters:
- Commodity ID
- Commodity Name
- Meter Group Name
- Building Group Name
- Topmost Place Code
- Topmost Place Name
/api/v3/savings/settings
GetCostAvoidanceSettingsV3
/api/v3/savings/meter/{meterId}/adjustment/othersavings/{otherSavingsId}
GetOneOtherSavingsV3
Retrieves a single "other savings" adjustment by ID for a meter
/api/v3/savings/adjustment/othersavings/category
GetOtherSavingsCategoriesV3
Retrieves all available "other savings" categories
/api/v3/savings/adjustedCostType
GetSavingsAdjustedCostTypeListV3
Retrieves the available adjusted cost types for cost avoidance calculations
/api/v3/savings/meter/{meterId}/bill/{billId}/daily
GetSavingsMeterBillDailyV3
Retrieves daily cost avoidance savings breakdown for a specific meter and bill
/api/v3/savings/meter/{meterId}/bill
GetSavingsMeterBillListV3
Retrieves savings (cost avoidance) details for a meter's bills over a specified number of years
/api/v3/savings/meter/{meterId}/bill/{billId}
GetSavingsMeterBillV3
Retrieves a single savings detail record for a specific meter and bill
/api/v3/savings/task
GetSavingsTasksV3
Get a list of cost avoidance tasks
NOTE: does not include cost avoidance tasks created from prior versions of the software
/api/v3/savings/task/{taskId}
GetSavingsTaskV3
Get a single cost avoidance task by its unique ID
/api/v3/savings/adjustment/special/method
GetSpecialAdjustmentMethodsV3
Retrieves the list of available special adjustment methods (e.g., regression, degree-day)
/api/v3/savings/meter/{meterId}/adjustment/special
GetSpecialAdjustmentsV3
Retrieves all special adjustments configured for a meter
/api/v3/savings/adjustment/special/type
GetSpecialAdjustmentTypesV3
Retrieves the list of available special adjustment types (e.g., weather, production)
/api/v3/savings/meter/{meterId}/adjustment/special/{specialAdjustmentId}
GetSpecialAdjustmentV3
Retrieves a single special adjustment by its ID for a meter
POST
8 endpoints
/api/v3/savings/baseline/exec
BulkGenerateBaselineV3
Bulk-regenerates cost avoidance baselines and reprocesses savings for meters matching filter criteria
/api/v3/savings/exec
CalculateSavingsV3
Calculates cost avoidance savings for meters matching filter criteria
/api/v3/savings/adjustment/othersavings/category
CreateOtherSavingsCategoryV3
Creates a new "other savings" category
/api/v3/savings/meter/{meterId}/adjustment/othersavings
CreateOtherSavingsV3
Creates an "other savings" adjustment on a meter and reprocesses savings
/api/v3/savings/meter/{meterId}/adjustment/special
CreateSpecialAdjustmentV3
Creates a new special adjustment on a meter and reprocesses savings
/api/v3/savings/meter/{meterId}/baseline
GenerateBaselineV3
Generates or saves a cost avoidance baseline for a meter with provided settings
/api/v3/savings/meter/count
GetCostAvoidanceMeterCountV3
Counts meters matching filter criteria for cost avoidance bulk operations
/api/v3/savings/meter/{meterId}/bill/{billId}/manualadjustment
ManualAdjustmentV3
Creates or removes a manual savings adjustment (lock) for a meter and bill
PUT
5 endpoints
/api/v3/savings/meter
BulkEditMeterCostAvoidanceSettingsV3
Bulk-updates cost avoidance settings for meters matching filter criteria and reprocesses baselines/savings
/api/v3/savings/auc
EditAucRangesV3
Updates the average unit cost acceptable ranges for one or more commodities and reprocesses affected savings
/api/v3/savings/settings
EditCostAvoidanceSettingsV3
/api/v3/savings/meter/{meterId}/adjustment/othersavings/{otherSavingsId}
EditOtherSavingsV3
Updates an "other savings" adjustment on a meter and reprocesses savings
/api/v3/savings/meter/{meterId}/adjustment/special/{specialAdjustmentId}
EditSpecialAdjustmentV3
Updates a special adjustment on a meter and reprocesses savings
DELETE
2 endpoints
/api/v3/savings/meter/{meterId}/adjustment/othersavings/{otherSavingsId}
DeleteOtherSavingsV3
Deletes an "other savings" adjustment from a meter
/api/v3/savings/meter/{meterId}/adjustment/special/{specialAdjustmentId}
DeleteSpecialAdjustmentByIdV3
Deletes a special adjustment from a meter and reprocesses savings