Savings
GET
17 endpoints
/api/v3/savings/meter/{meterId}/baseline
GenerateBaselineGetV3
Executes the baseline processor with stored baseline settings for the provided meter
/api/v3/savings/meter/{meterId}/adjustment/othersavings
GetAllOtherSavingsV3
Get a other savings for a meter
/api/v3/savings/auc
GetAucRangesV3
Get the average unit cost "acceptable range" values for cost avoidance for each commodity
/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
Get one other savings for a meter
/api/v3/savings/adjustment/othersavings/category
GetOtherSavingsCategoriesV3
Get other savings categories
/api/v3/savings/adjustedCostType
GetSavingsAdjustedCostTypeListV3
Gets a list of the Adjusted Cost Types
/api/v3/savings/meter/{meterId}/bill/{billId}/daily
GetSavingsMeterBillDailyV3
Get cost avoidance savings by day for a meter and bill
/api/v3/savings/meter/{meterId}/bill
GetSavingsMeterBillListV3
Get Savings Details of usage and cost avoidance for a meter's bills
/api/v3/savings/meter/{meterId}/bill/{billId}
GetSavingsMeterBillV3
Get a single Savings Details record of usage and cost avoidance for a 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
Get Special Adjustment Methods
/api/v3/savings/meter/{meterId}/adjustment/special
GetSpecialAdjustmentsV3
Get all the special adjustments for the meter
/api/v3/savings/adjustment/special/type
GetSpecialAdjustmentTypesV3
Get Special Adjustment Types
/api/v3/savings/meter/{meterId}/adjustment/special/{specialAdjustmentId}
GetSpecialAdjustmentV3
Get a single special adjustment by its unique ID
POST
8 endpoints
/api/v3/savings/baseline/exec
BulkGenerateBaselineV3
Regenerate cost avoidance baseline for the meters that match the filter conditions and then reprocess their savings
/api/v3/savings/exec
CalculateSavingsV3
Calculate savings for the meters that match the filter conditions, using the provided settings
/api/v3/savings/adjustment/othersavings/category
CreateOtherSavingsCategoryV3
Create other savings category
/api/v3/savings/meter/{meterId}/adjustment/othersavings
CreateOtherSavingsV3
Create an other savings adjustment
Meter Cost Avoidance Savings will be re-calculated
/api/v3/savings/meter/{meterId}/adjustment/special
CreateSpecialAdjustmentV3
Create a new special adjustment
Meter Cost Avoidance Savings will be re-calculated
/api/v3/savings/meter/{meterId}/baseline
GenerateBaselineV3
Executes the baseline and cost avoidance processors with provided baseline and cost avoidance settings for the provided meter.
Results are not saved unless the "save" flag is set to true.
If "save" is true, MeterSavingsSettings-Manage permission is also required
/api/v3/savings/meter/count
GetCostAvoidanceMeterCountV3
Count the number of meters that match the filter conditions for cost avoidance bulk actions
/api/v3/savings/meter/{meterId}/bill/{billId}/manualadjustment
ManualAdjustmentV3
Creates or removes manual adjustments to savings for a provided meter and bill
PUT
5 endpoints
/api/v3/savings/meter
BulkEditMeterCostAvoidanceSettingsV3
Mass update certain cost avoidance settings for meters that match the filter conditions
Baseline and Savings will be reprocessed for affected meters
/api/v3/savings/auc
EditAucRangesV3
Edit the average unit cost "acceptable range" values for cost avoidance for one or more commodities
Cost Avoidance Savings will be re-calculated for all bills for meters having the affected commodities
/api/v3/savings/settings
EditCostAvoidanceSettingsV3
/api/v3/savings/meter/{meterId}/adjustment/othersavings/{otherSavingsId}
EditOtherSavingsV3
Edit an other savings adjustment
Meter Cost Avoidance Savings will be re-calculated
/api/v3/savings/meter/{meterId}/adjustment/special/{specialAdjustmentId}
EditSpecialAdjustmentV3
Edit a special adjustment
Meter Cost Avoidance Savings will be re-calculated
DELETE
2 endpoints
/api/v3/savings/meter/{meterId}/adjustment/othersavings/{otherSavingsId}
DeleteOtherSavingsV3
Delete an other savings adjustment
/api/v3/savings/meter/{meterId}/adjustment/special/{specialAdjustmentId}
DeleteSpecialAdjustmentByIdV3
Delete a special adjustment
Meter Cost Avoidance Savings will be re-calculated