Actions10
- Accounting Actions
- Data Actions
- Finance Actions
- Prediction Actions
- Report Actions
Prediction → Forecast Financial Metric
AI-generatedSummary
Forecasts future values of a specified financial metric over a requested horizon using AI predictive analytics on input time series data.
Inputs
- allowPredictiveOperations (required) — Enables predictive forecasting operations; must be explicitly allowed as it's off by default.
- forecastHorizon (required) — Specifies the number of future points to predict for the financial metric, minimum 1.
- maxForecastHorizon — Defines the maximum allowed forecast horizon; the requested horizon cannot exceed this limit.
- valueColumn (required) — Specifies the primary numeric column in the input data to forecast.
- currency — Optional currency metadata forwarded for contextual relevance in finance operations.
- advancedOptionsJson — Optional JSON object with additional domain-specific options forwarded to the underlying domain operation without evaluation or code execution.
- maxRows — Maximum number of input data rows accepted for the forecasting operation.
Output shape
a single record containing forecasted future values for the specified financial metric over the requested horizon
The forecast horizon is constrained by a maximum hard limit; input size is also limited to a maximum number of rows. Predictive operations require explicit enabling via the allowPredictiveOperations parameter, else forecasting will not run.
Examples
Example 1: Forecast 3 future months of a 'Revenue' metric in USD
Set 'valueColumn' to 'Revenue', 'currency' to 'USD', 'forecastHorizon' to 3, and enable 'allowPredictiveOperations'.