INPUT_OBJECT

ForecastFilterInput

Filter conditions for Forecast records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

link GraphQL Schema definition

  • input ForecastFilterInput {
  • # Matches records that meet at least one of the listed filters.
  • OR: [ForecastFilterInput!]
  • # Matches records that meet all of the listed filters.
  • AND: [ForecastFilterInput!]
  • # Matches records that do not meet this filter.
  • NOT: ForecastFilterInput
  • # Search term matched against the fields that the global search covers for this
  • # entity.
  • globalSearchQuery: String
  • # Unique identifier of entity.
  • id: EntityFilterStringField
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: EntityFilterDateTimeField
  • # Creation time.
  • created: EntityFilterDateTimeField
  • # Free-text description shown alongside the forecast.
  • description: EntityFilterStringField
  • # Id of the aggregation field.
  • fieldId: EntityFilterStringField
  • # Name of the entity and its default text representation.
  • name: EntityFilterStringField
  • # Id of the owning user.
  • ownerId: EntityFilterStringField
  • # Id of the pipeline whose opportunities the forecast aggregates.
  • pipelineId: EntityFilterStringField
  • # Who besides the owner can access the forecast. Updating it to AllEdit shares the
  • # forecast with the users and sales units it covers (see sharedClients and
  • # sharedUnits) and stores the mode as Standard.
  • shareMode: ShareModeEnumFilterInput
  • # Legacy additional sharing options; kept with the record but no longer applied.
  • shareModeParams: ShareModeParamsEnumFilterInput
  • # Revision when entity was lastly changed.
  • revision: EntityFilterNumberField
  • # For multi-level forecasts (a "type" path like Pipeline/Step/Owner), the last
  • # element of the path identifying the current breakdown axis.
  • lastType: ForecastType
  • # Field whose value is summed when computing forecast amounts (typically a
  • # currency field on Opportunity). Matches records where a related record meets
  • # these conditions.
  • field: FieldFilterInput
  • # User who owns the forecast. Matches records where a related record meets these
  • # conditions.
  • owner: ClientFilterInput
  • # Pipeline whose opportunities the forecast aggregates. Matches records where a
  • # related record meets these conditions.
  • pipeline: PipelineFilterInput
  • }

link Require by