Savings APIs

Get /api/v3/savings/meter/{meterId}/bill

Operation: GetSavingsMeterBillListV3 Permissions: Meters (View)

Get Savings Details of usage and cost avoidance for a meter’s bills

---

Get /api/v3/savings/meter/{meterId}/bill/{billId}

Operation: GetSavingsMeterBillV3 Permissions: Meters (View)

Get a single Savings Details record of usage and cost avoidance for a meter and bill

---

Get /api/v3/savings/meter/{meterId}/bill/{billId}/daily

Operation: GetSavingsMeterBillDailyV3 Permissions: Meters (View)

Get cost avoidance savings by day for a meter and bill

---

Get /api/v3/savings/adjustment/special/type

Operation: GetSpecialAdjustmentTypesV3 Permissions: Meters (View)

Get Special Adjustment Types

---

Get /api/v3/savings/adjustment/special/method

Operation: GetSpecialAdjustmentMethodsV3 Permissions: Meters (View)

Get Special Adjustment Methods

---

Get /api/v3/savings/adjustedCostType

Operation: GetSavingsAdjustedCostTypeListV3 Permissions: Meters (View)

Gets a list of the Adjusted Cost Types

---

Post /api/v3/savings/meter/{meterId}/baseline

Operation: GenerateBaselineV3 Permissions: MeterSavingsSettings (View)

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

---

Get /api/v3/savings/meter/{meterId}/baseline

Operation: GenerateBaselineGetV3 Permissions: MeterSavingsSettings (View)

Executes the baseline processor with stored baseline settings for the provided meter

---

Post /api/v3/savings/baseline/exec

Operation: BulkGenerateBaselineV3 Permissions: BaselineEngine (Run)

Regenerate cost avoidance baseline for the meters that match the filter conditions and then reprocess their savings

---

Post /api/v3/savings/exec

Operation: CalculateSavingsV3 Permissions: SavingsEngine (Run)

Calculate savings for the meters that match the filter conditions, using the provided settings

---

Post /api/v3/savings/meter/{meterId}/bill/{billId}/manualadjustment

Operation: ManualAdjustmentV3 Permissions: ManuallyAdjustSavings (Manage)

Creates or removes manual adjustments to savings for a provided meter and bill

---

Get /api/v3/savings/meter/{meterId}/adjustment/special

Operation: GetSpecialAdjustmentsV3 Permissions: SavingsAdjustments (View)

Get all the special adjustments for the meter

---

Post /api/v3/savings/meter/{meterId}/adjustment/special

Operation: CreateSpecialAdjustmentV3 Permissions: SavingsAdjustments (Manage)

Create a new special adjustment
Meter Cost Avoidance Savings will be re-calculated

---

Get /api/v3/savings/meter/{meterId}/adjustment/special/{specialAdjustmentId}

Operation: GetSpecialAdjustmentV3 Permissions: SavingsAdjustments (View)

Get a single special adjustment by its unique ID

---

Delete /api/v3/savings/meter/{meterId}/adjustment/special/{specialAdjustmentId}

Operation: DeleteSpecialAdjustmentByIdV3 Permissions: SavingsAdjustments (Manage)

Delete a special adjustment
Meter Cost Avoidance Savings will be re-calculated

---

Put /api/v3/savings/meter/{meterId}/adjustment/special/{specialAdjustmentId}

Operation: EditSpecialAdjustmentV3 Permissions: SavingsAdjustments (Manage)

Edit a special adjustment
Meter Cost Avoidance Savings will be re-calculated

---

Post /api/v3/savings/meter/{meterId}/adjustment/othersavings

Operation: CreateOtherSavingsV3 Permissions: SavingsAdjustments (Manage)

Create an other savings adjustment
Meter Cost Avoidance Savings will be re-calculated

---

Get /api/v3/savings/meter/{meterId}/adjustment/othersavings

Operation: GetAllOtherSavingsV3 Permissions: SavingsAdjustments (View)

Get a other savings for a meter

---

Put /api/v3/savings/meter/{meterId}/adjustment/othersavings/{otherSavingsId}

Operation: EditOtherSavingsV3 Permissions: SavingsAdjustments (Manage)

Edit an other savings adjustment
Meter Cost Avoidance Savings will be re-calculated

---

Get /api/v3/savings/meter/{meterId}/adjustment/othersavings/{otherSavingsId}

Operation: GetOneOtherSavingsV3 Permissions: SavingsAdjustments (View)

Get one other savings for a meter

---

Delete /api/v3/savings/meter/{meterId}/adjustment/othersavings/{otherSavingsId}

Operation: DeleteOtherSavingsV3 Permissions: SavingsAdjustments (Manage)

Delete an other savings adjustment

---

Get /api/v3/savings/adjustment/othersavings/category

Operation: GetOtherSavingsCategoriesV3 Permissions: SavingsAdjustments (View)

Get other savings categories

---

Post /api/v3/savings/adjustment/othersavings/category

Operation: CreateOtherSavingsCategoryV3 Permissions: SavingsAdjustments (Manage)

Create other savings category

---

Put /api/v3/savings/meter

Operation: BulkEditMeterCostAvoidanceSettingsV3 Permissions: MeterSavingsSettings (Manage)

Mass update certain cost avoidance settings for meters that match the filter conditions
Baseline and Savings will be reprocessed for affected meters

---

Post /api/v3/savings/meter/count

Operation: GetCostAvoidanceMeterCountV3 Permissions: GlobalCostAvoidanceSettings (View)

Count the number of meters that match the filter conditions for cost avoidance bulk actions

---

Get /api/v3/savings/auc

Operation: GetAucRangesV3 Permissions: GlobalCostAvoidanceSettings (View)

Get the average unit cost “acceptable range” values for cost avoidance for each commodity

---

Put /api/v3/savings/auc

Operation: EditAucRangesV3 Permissions: GlobalCostAvoidanceSettings (Manage)

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

---

Get /api/v3/savings/task

Operation: GetSavingsTasksV3 Permissions: Meters (View) Paginated

Get a list of cost avoidance tasks
NOTE: does not include cost avoidance tasks created from prior versions of the software

---

Get /api/v3/savings/task/{taskId}

Operation: GetSavingsTaskV3 Permissions: Meters (View)

Get a single cost avoidance task by its unique ID

---

Get /api/v3/savings/settings

Operation: GetCostAvoidanceSettingsV3

---

Put /api/v3/savings/settings

Operation: EditCostAvoidanceSettingsV3

---

Get /api/v3/savings/filters

Operation: GetCostAvoidanceFiltersV3 Permissions: SavingsEngine (Run)

Return available filters for Cost Avoidance processors
Filters:
- Commodity ID
- Commodity Name
- Meter Group Name
- Building Group Name
- Topmost Place Code
- Topmost Place Name

---