post
https://api.genability.com/rest/v1/ondemand/calculate/mass
Run multiple on-demand calculation scenarios in one request.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Use this endpoint to run multiple on-demand calculation scenarios in one request.
The Mass Calculation endpoint is only available under special circumstances to Enterprise customers using Signal.
When to use this endpoint
Use POST /rest/v1/ondemand/calculate/mass when you need to:
- Compare costs across multiple tariffs.
- Run multiple scenarios using the same date range and shared inputs.
- Compare tariff, property input, usage, or rate input changes across scenarios.
- Return calculation results keyed by scenario name.
Required inputs
| Parameter | Type | Description |
|---|---|---|
fromDateTime | DateTime | Starting date and time for the request. |
toDateTime | DateTime | Ending date and time for the request. |
scenarios | List of CalculationScenario | Individual calculation scenarios to run. |
Common optional inputs
| Parameter | Type | Description |
|---|---|---|
sharedScenario | CalculationScenario | Inputs shared across all calculations unless overridden in an individual scenario. |
detailLevel | Enumeration | Controls the level of detail returned in calculation results. Defaults to ALL. |
groupBy | Enumeration | Controls how calculation details are grouped. Defaults to the natural grouping for the rates. |
billingPeriod | Boolean | Set to true when the calculation dates represent an actual billing cycle. Defaults to true. |
applyUtilityTax | Boolean | Attempts to apply utility tax when an address is provided. |
address | Address | Specifies the location used to apply utility tax. Required when applyUtilityTax is true. |
minimums | Boolean | Enables enforcing minimum charges. |
excludeChargeClass | String | Excludes one or more charge classes from the calculation results. |
tariffEffectiveOn | DateTime | Uses the tariff version active on the specified date. |
Scenario inputs
| Parameter | Type | Description |
|---|---|---|
masterTariffId | Integer | Arcadia ID of the tariff used for this scenario. |
scenarioName | String | User-provided identifier for the scenario. Defaults to a simple index if omitted. |
propertyInputs | Array of PropertyData | Usage data, demand values, applicability criteria, or other calculation inputs for this scenario. |
rateInputs | Array of TariffRate | Custom rates supplied for this scenario. |