INPUT_OBJECT

OpportunityFilterInput

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

link GraphQL Schema definition

  • input OpportunityFilterInput {
  • # Matches records that meet at least one of the listed filters.
  • OR: [OpportunityFilterInput!]
  • # Matches records that meet all of the listed filters.
  • AND: [OpportunityFilterInput!]
  • # Matches records that do not meet this filter.
  • NOT: OpportunityFilterInput
  • # 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
  • # Id of the quote currently synchronized with this opportunity, or empty when no
  • # quote is active. A quote can be active on only one opportunity at a time.
  • activeQuoteId: EntityFilterStringField
  • # Id of the currency exchange rate list applied to this opportunity.
  • currencyExchangeRatesListId: EntityFilterStringField
  • # Free-form description of the opportunity.
  • description: EntityFilterStringField
  • # True when the opportunity has been archived (lost). Archived opportunities
  • # remain readable but are hidden from active lists and cannot be edited until
  • # reactivated.
  • isArchived: Boolean
  • # True when value is auto-calculated from the opportunity product line items.
  • # False when the user enters value directly.
  • isValueAutoCalculate: Boolean
  • # User-set colored flag used to highlight the opportunity in lists and reports.
  • labelFlag: LabelFlagEnumFilterInput
  • # Time when an AI-suggested buying center was last applied to this opportunity.
  • lastAiBuyingCenterApplied: EntityFilterDateTimeField
  • # Id of the lead source the opportunity originated from.
  • leadSourceId: EntityFilterStringField
  • # Name of the entity and its default text representation.
  • name: EntityFilterStringField
  • # Id of the opportunity type.
  • opptyTypeId: EntityFilterStringField
  • # Id of the opportunity owner.
  • ownerId: EntityFilterStringField
  • # Id of the currency used for product line-item prices on this opportunity.
  • productCurrencyId: EntityFilterStringField
  • # Id of the price list that supplies prices for product line items added to this
  • # opportunity, or empty to use catalog defaults.
  • productPriceListId: EntityFilterStringField
  • # Free-text company email captured at opportunity creation when no Account record
  • # has been linked yet.
  • quickAccountEmail: EntityFilterStringField
  • # Free-text company name captured at opportunity creation when no Account record
  • # has been linked yet.
  • quickAccountName: EntityFilterStringField
  • # Free-text company phone captured at opportunity creation when no Account record
  • # has been linked yet.
  • quickAccountPhone: EntityFilterStringField
  • # Free-text contact name captured at opportunity creation when no Contact record
  • # has been linked yet.
  • quickContactName: EntityFilterStringField
  • # Free-text contact email captured at opportunity creation when no Contact record
  • # has been linked yet.
  • quickEmail: EntityFilterStringField
  • # Free-text contact phone captured at opportunity creation when no Contact record
  • # has been linked yet.
  • quickPhone: EntityFilterStringField
  • # Qualitative ranking score (1-10) the user assigns to indicate the strength of
  • # the opportunity.
  • ranking: EntityFilterNumberField
  • # Free-form note explaining why the opportunity was archived (lost).
  • reasonOfCloseDescription: EntityFilterStringField
  • # Id of the reason of close option selected when the opportunity was archived
  • # (lost).
  • reasonOfCloseId: EntityFilterStringField
  • # Sharing model applied on top of the owner/unit visibility (e.g. shared with
  • # selected sales units or selected users). The matching sharingUnits /
  • # sharingClients lists control who is granted access.
  • shareMode: ShareModeEnumFilterInput
  • # Id of the pipeline step.
  • stepId: EntityFilterStringField
  • # Discriminator identifying the concrete record type — always "opportunity" for
  • # Opportunity records. Read-only; useful when consuming polymorphic LeadOppty
  • # results.
  • tableName: EntityFilterStringField
  • # Id of the sales unit.
  • unitId: EntityFilterStringField
  • # True when the opportunity has gone through the qualification step at least once.
  • wasQualified: Boolean
  • # Revision when entity was lastly changed.
  • revision: EntityFilterNumberField
  • # Number of email sequences this record is currently actively enrolled in
  • # (soft-deleted or ended enrollments are not counted).
  • enrolledEmailSequences: Int
  • # Id of the pipeline the opportunity runs in. Read-only; derived from the
  • # opportunity type. Useful as a filter when listing opportunities by pipeline.
  • pipelineId: EntityFilterStringField
  • # Current status of the opportunity (Open, Won, Lost). Read-only; derived from the
  • # current pipeline step and the archived flag.
  • status: OpptyStatusEnumFilterInput
  • # Matches records related to at least one of the listed records.
  • relatedEntities: [EntityFilterRelatedField]
  • # Conditions on custom fields, each identified by its api name. All listed
  • # conditions must match.
  • withCustom: [CustomField!]
  • # Quote currently used to drive the opportunity (e.g. for synchronisation of
  • # monetary fields). Empty when no quote is active. Matches records where a related
  • # record meets these conditions.
  • activeQuote: QuoteFilterInput
  • # Currency exchange rate list used to convert monetary fields linked to this
  • # opportunity. Empty to inherit the team space default. Matches records where a
  • # related record meets these conditions.
  • currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput
  • # How the opportunity originated (e.g. Website, Referral, Trade Show).
  • # Configurable per team space. Matches records where a related record meets these
  • # conditions.
  • leadSource: DataFilterInput
  • # Opportunity type that classifies this opportunity. Each type maps to one
  • # pipeline and drives which form, fields and stages apply. Matches records where a
  • # related record meets these conditions.
  • opptyType: OpportunityTypeFilterInput
  • # Sales user who owns this opportunity. Matches records where a related record
  • # meets these conditions.
  • owner: ClientFilterInput
  • # Currency used for product line-item prices on this opportunity. Matches records
  • # where a related record meets these conditions.
  • productCurrency: CurrencyFilterInput
  • # Product price list used to populate prices for product line items added to this
  • # opportunity. Empty to use catalog defaults. Matches records where a related
  • # record meets these conditions.
  • productPriceList: ProductPriceListFilterInput
  • # Configurable reason recorded when the opportunity is archived (lost). Required
  • # when the lost form mandates it. Matches records where a related record meets
  • # these conditions.
  • reasonOfClose: DataFilterInput
  • # Pipeline step the opportunity is currently sitting in. Reaching the last step in
  • # the pipeline marks the opportunity as won; archiving sets it to lost. Matches
  • # records where a related record meets these conditions.
  • step: StepFilterInput
  • # Sales unit this opportunity is assigned to. Determines which team members can
  • # see the record under unit-based sharing. Matches records where a related record
  • # meets these conditions.
  • unit: SalesUnitFilterInput
  • # Recurrence schedule generating periodic copies of this opportunity, or empty
  • # when no recurrence is set up. Matches records where a related record meets these
  • # conditions.
  • opptyRecurrence: OpptyRecurrenceFilterInput
  • # Revenue schedule splitting the opportunity value across periods, or empty when
  • # revenue scheduling is not enabled for this opportunity. Matches records where a
  • # related record meets these conditions.
  • revenueSchedule: OpptyRevenueScheduleFilterInput
  • # Product line items on this opportunity. Each entry holds the product, quantity,
  • # price and discount that contribute to the opportunity value when
  • # isValueAutoCalculate is true. Matches records where a related record meets these
  • # conditions.
  • productRelations: OpptyProductRelationFilterInput
  • # Primary contact of this opportunity. Set automatically from the contact relation
  • # marked as primary. Matches records where a related record meets these
  • # conditions.
  • primaryContact: ContactFilterInput
  • # Primary account of this opportunity. Set automatically from the account relation
  • # marked as primary. Matches records where a related record meets these
  • # conditions.
  • primaryAccount: AccountFilterInput
  • # Contacts linked to this opportunity, including their roles and org-chart
  • # positions. Matches records where a related record meets these conditions.
  • contactRelations: LeadOpptyContactRelationFilterInput
  • # Accounts linked to this opportunity, including the primary-account flag. Matches
  • # records where a related record meets these conditions.
  • accountRelations: LeadOpptyAccountRelationFilterInput
  • # Documents linked to this opportunity. Matches records where a related record
  • # meets these conditions.
  • documents: CloudObjectRelationFilterInput
  • # Quotes prepared for this opportunity. Matches records where a related record
  • # meets these conditions.
  • quoteRelations: QuoteFilterInput
  • # Sales units that have been granted shared access to this opportunity. Editable
  • # only when shareMode allows unit sharing. Matches records where a related record
  • # meets these conditions.
  • sharingUnits: LeadOpptySharingSalesUnitRelationFilterInput
  • # Users that have been granted shared access to this opportunity. Editable only
  • # when shareMode allows user sharing. Matches records where a related record meets
  • # these conditions.
  • sharingClients: LeadOpptySharingClientRelationFilterInput
  • # Tag labels applied to this opportunity. Matches records where a related record
  • # meets these conditions.
  • tags: TagRelationFilterInput
  • # Saved view profiles this opportunity currently matches. Matches records where a
  • # related record meets these conditions.
  • staticProfiles: ProfileRelationFilterInput
  • }

link Require by