INPUT_OBJECT

OpportunityOrderByInput

Sorting of Opportunity records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

link GraphQL Schema definition

  • input OpportunityOrderByInput {
  • # Unique identifier of entity.
  • id: OrderByEnum
  • # Specifies if the entity is considered deleted.
  • isDeleted: OrderByEnum
  • # Last modification time.
  • modified: OrderByEnum
  • # Creation time.
  • created: OrderByEnum
  • # Quote currently used to drive the opportunity (e.g. for synchronisation of
  • # monetary fields). Empty when no quote is active. Sorts by fields of the related
  • # record, listed in order of priority.
  • activeQuote: [QuoteOrderByNestedInput!]
  • # Currency exchange rate list used to convert monetary fields linked to this
  • # opportunity. Empty to inherit the team space default. Sorts by fields of the
  • # related record, listed in order of priority.
  • currencyExchangeRatesList: [CurrencyExchangeRatesListOrderByNestedInput!]
  • # How the opportunity originated (e.g. Website, Referral, Trade Show).
  • # Configurable per team space. Sorts by fields of the related record, listed in
  • # order of priority.
  • leadSource: [DataOrderByNestedInput!]
  • # Opportunity type that classifies this opportunity. Each type maps to one
  • # pipeline and drives which form, fields and stages apply. Sorts by fields of the
  • # related record, listed in order of priority.
  • opptyType: [OpportunityTypeOrderByNestedInput!]
  • # Sales user who owns this opportunity. Sorts by fields of the related record,
  • # listed in order of priority.
  • owner: [ClientOrderByNestedInput!]
  • # Product price list used to populate prices for product line items added to this
  • # opportunity. Empty to use catalog defaults. Sorts by fields of the related
  • # record, listed in order of priority.
  • productPriceList: [ProductPriceListOrderByNestedInput!]
  • # Configurable reason recorded when the opportunity is archived (lost). Required
  • # when the lost form mandates it. Sorts by fields of the related record, listed in
  • # order of priority.
  • reasonOfClose: [DataOrderByNestedInput!]
  • # 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. Sorts by
  • # fields of the related record, listed in order of priority.
  • step: [StepOrderByNestedInput!]
  • # Sales unit this opportunity is assigned to. Determines which team members can
  • # see the record under unit-based sharing. Sorts by fields of the related record,
  • # listed in order of priority.
  • unit: [SalesUnitOrderByNestedInput!]
  • # 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: OrderByEnum
  • # Expected or actual closing date of the opportunity.
  • closingDate: OrderByEnum
  • # Id of the currency exchange rate list applied to this opportunity.
  • currencyExchangeRatesListId: OrderByEnum
  • # Free-form description of the opportunity.
  • description: OrderByEnum
  • # 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: OrderByEnum
  • # True when value is auto-calculated from the opportunity product line items.
  • # False when the user enters value directly.
  • isValueAutoCalculate: OrderByEnum
  • # User-set colored flag used to highlight the opportunity in lists and reports.
  • labelFlag: OrderByEnum
  • # Id of the lead source the opportunity originated from.
  • leadSourceId: OrderByEnum
  • # Name of the entity and its default text representation.
  • name: OrderByEnum
  • # Id of the opportunity type.
  • opptyTypeId: OrderByEnum
  • # Id of the opportunity owner.
  • ownerId: OrderByEnum
  • # Id of the price list that supplies prices for product line items added to this
  • # opportunity, or empty to use catalog defaults.
  • productPriceListId: OrderByEnum
  • # Free-text company email captured at opportunity creation when no Account record
  • # has been linked yet.
  • quickAccountEmail: OrderByEnum
  • # Free-text company name captured at opportunity creation when no Account record
  • # has been linked yet.
  • quickAccountName: OrderByEnum
  • # Free-text company phone captured at opportunity creation when no Account record
  • # has been linked yet.
  • quickAccountPhone: OrderByEnum
  • # Free-text contact name captured at opportunity creation when no Contact record
  • # has been linked yet.
  • quickContactName: OrderByEnum
  • # Free-text contact email captured at opportunity creation when no Contact record
  • # has been linked yet.
  • quickEmail: OrderByEnum
  • # Free-text contact phone captured at opportunity creation when no Contact record
  • # has been linked yet.
  • quickPhone: OrderByEnum
  • # Qualitative ranking score (1-10) the user assigns to indicate the strength of
  • # the opportunity.
  • ranking: OrderByEnum
  • # Free-form note explaining why the opportunity was archived (lost).
  • reasonOfCloseDescription: OrderByEnum
  • # Id of the reason of close option selected when the opportunity was archived
  • # (lost).
  • reasonOfCloseId: OrderByEnum
  • # 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: OrderByEnum
  • # Id of the pipeline step.
  • stepId: OrderByEnum
  • # Id of the sales unit.
  • unitId: OrderByEnum
  • # True when the opportunity has gone through the qualification step at least once.
  • wasQualified: OrderByEnum
  • # Revision when entity was lastly changed.
  • revision: OrderByEnum
  • # Monetary value of the opportunity in the team space base currency, with the
  • # foreign value and currency code preserved alongside.
  • value: OrderByEnum
  • # Number of email sequences this record is currently actively enrolled in
  • # (soft-deleted or ended enrollments are not counted).
  • enrolledEmailSequences: OrderByEnum
  • # Recurrence schedule generating periodic copies of this opportunity, or empty
  • # when no recurrence is set up. Sorts by fields of the related record, listed in
  • # order of priority.
  • opptyRecurrence: [OpptyRecurrenceOrderByNestedInput!]
  • # Revenue schedule splitting the opportunity value across periods, or empty when
  • # revenue scheduling is not enabled for this opportunity. Sorts by fields of the
  • # related record, listed in order of priority.
  • revenueSchedule: [OpptyRevenueScheduleOrderByNestedInput!]
  • # Current status of the opportunity (Open, Won, Lost). Read-only; derived from the
  • # current pipeline step and the archived flag.
  • status: OrderByEnum
  • # Sorts records by whether they are related to the listed records.
  • relatedEntities: CommonEntityRepositoryOrderByEntityRelationField
  • # Sorts by a custom field.
  • withCustom: CommonEntityRepositoryOrderByCustomField
  • }