Forecast
Forecast type definition
Forecast
Forecast type definition
Properties
id(string): Unique identifier for the forecast.name(string): Forecast name or label.status(string): Forecast status (draft, submitted, approved, closed).type(string): Forecast type (pipeline, commit, best-case, worst-case).period(string): Forecast period (weekly, monthly, quarterly, annual).startDate(number): Period start date (Unix timestamp).endDate(number): Period end date (Unix timestamp).owner([[User]]): Person who created the forecast.team([[Team]]): Sales team for this forecast.territory([[Territory]]): Territory being forecasted.quota(number): Sales quota target in cents.pipeline(number): Total pipeline value in cents.commit(number): Committed forecast amount in cents.bestCase(number): Best case forecast amount in cents.worstCase(number): Worst case forecast amount in cents.mostLikely(number): Most likely forecast amount in cents.weighted(number): Weighted forecast (probability-adjusted) in cents.closed(number): Actual closed revenue in cents.variance(number): Variance from forecast in cents.accuracy(number): Forecast accuracy percentage (0-100).opportunities([[Opportunity]][]): Opportunities included in forecast.deals([[Deal]][]): Deals closed in period.categories(object[]): Forecast categories (commit, upside, pipeline, omitted).assumptions(string): Forecast assumptions and methodology.risks(string[]): Identified risks to forecast.notes(string): Additional notes or comments.submittedDate(number): When forecast was submitted (Unix timestamp).approvedBy([[User]]): Person who approved forecast.approvedDate(number): When forecast was approved (Unix timestamp).created(number): Timestamp when the forecast was created (Unix timestamp).metadata(object): Set of key-value pairs for storing additional information.
Actions
create
Create a new forecast.
Input: [[Forecast]]
Output: [[Forecast]]
update
Modify forecast details.
Input: [[Forecast]]
Output: [[Forecast]]
delete
Delete forecast record.
Input: [[Forecast]]
Output: [[Forecast]]
submit
Submit forecast for approval.
Input: [[Forecast]]
Output: [[Forecast]]
approve
Approve submitted forecast.
Input: [[Forecast]]
Output: [[Forecast]]
categorize
Categorize opportunities in forecast.
Input: [[ForecastCategorization]]
Output: [[Forecast]]
adjust
Adjust forecast amounts.
Input: [[ForecastAdjustment]]
Output: [[Forecast]]
rollup
Roll up team forecasts to manager level.
Input: [[Forecast]][]
Output: [[Forecast]]
compare
Compare multiple forecasts.
Input: [[Forecast]][]
Output: [[ForecastComparison]]
analyze
Analyze forecast accuracy and trends.
Input: [[Forecast]]
Output: [[ForecastAnalysis]]
Events
created: Triggered when a new forecast is created.updated: Triggered when forecast is modified.deleted: Triggered when forecast is deleted.submitted: Triggered when forecast is submitted.approved: Triggered when forecast is approved.adjusted: Triggered when forecast is adjusted.Quota.exceeded: Triggered when forecast exceeds quota.Variance.detected: Triggered when variance is significant.Opportunity.added: Triggered when opportunity added to forecast.Deal.closed: Triggered when forecasted deal closes.