OBJECT

BetterForecastSchema

link GraphQL Schema definition

  • type BetterForecastSchema implements QuickFilterInterface {
  • # Quick-filter conditions applied on top of the forecast, letting the user narrow
  • # the included opportunities without changing the saved filter.
  • quickFilter: QuickFilterTab!
  • # Currency used for all monetary values in the forecast.
  • currencyId: UUID!
  • # Time granularity of the forecast — Monthly, Quarterly or Yearly.
  • period: ForecastPeriodKind!
  • # First day of the forecast period.
  • startDate: Date!
  • # Last day of the forecast period.
  • endDate: Date!
  • # Breakdown dimension(s) the forecast is grouped by — Users, SalesUnits, Products,
  • # ProductCategories or Accounts.
  • type: [ForecastType!]!
  • # Forecast rows — one per entity in the breakdown, with per-period values and
  • # quotas.
  • items: [ForecastItem!]!
  • # Baseline that performance is compared against — PreviousPeriod,
  • # AveragePerformance or WeightedAveragePerformance.
  • quotaComparisonType: ForecastPerformanceComparisonType!
  • # Opportunity value field summed into the forecast.
  • fieldId: ID!
  • # Opportunity date field used to place each opportunity into a period.
  • dateFieldId: ID!
  • # Field-condition filter selecting which opportunities feed the forecast.
  • fieldFilter: FieldFilter!
  • # Saved opportunity filter tab further scoping the forecast.
  • filter: OpportunityFilterTab!
  • # Pipeline the forecast is computed over.
  • pipelineId: UUID!
  • # Value columns shown in the forecast (prediction, open, comparison, …).
  • columns: [ForecastColumn!]!
  • # Optional field the forecast values are additionally grouped by.
  • groupBy: UUID
  • # When true, rows with no values are hidden.
  • hideEmptyRows: Boolean!
  • # Display options for the list view of the forecast.
  • listViewOptions: ForecastListViewOptions!
  • # Display options for the trend view of the forecast.
  • trendViewOptions: ForecastTrendViewOptions!
  • # Display options for the pipeline view of the forecast.
  • pipelineViewOptions: ForecastPipelineViewOptions!
  • # When true, quotas are entered manually rather than derived from targets.
  • quotaCustomMode: Boolean!
  • # How a parent quota is split across child rows (e.g. evenly).
  • quotaSplitType: OpportunityForecastQuotaSplitType!
  • }

link Require by