OBJECT
OpportunityEntity

Potential deal with a value and closing date that moves through the steps of a sales pipeline until it is won or lost.
GraphQL Schema definition

type OpportunityEntity {
# Values of the record's custom fields as a JSON object keyed by custom field 
# apiName (camelCase).
# 
# Arguments
# apiNames: Api names of custom fields to retrieve. All are 
# returned if not set.
customFields(apiNames: [String!]): JSONString! 
# Filled only when a single record is read by its id; otherwise null or an empty 
# list.
pendingScheduledActions: Int 
# True when the record is protected against deletion because it must always exist 
# in the space. Deleting a record that is not protected can still fail on other 
# checks. Read-only.
isDeleteProtected: Boolean! 
# Unique identifier of entity.
id: ID! 
# Specifies if the entity is considered deleted.
isDeleted: Boolean 
# Last modification time.
modified: DateTime 
# Creation time.
created: DateTime 
# Quote currently used to drive the opportunity (e.g. for synchronisation of 
# monetary fields). Empty when no quote is active.
activeQuote: QuoteEntity 
# Currency exchange rate list used to convert monetary fields linked to this 
# opportunity. Empty to inherit the team space default.
currencyExchangeRatesList: CurrencyExchangeRatesListEntity 
# How the opportunity originated (e.g. Website, Referral, Trade Show). 
# Configurable per team space.
leadSource: DataEntity 
# Opportunity type that classifies this opportunity. Each type maps to one 
# pipeline and drives which form, fields and stages apply.
opptyType: OpportunityTypeEntity 
# Sales user who owns this opportunity.
owner: ClientEntity 
# Currency used for product line-item prices on this opportunity.
productCurrency: CurrencyEntity 
# Product price list used to populate prices for product line items added to this 
# opportunity. Empty to use catalog defaults.
productPriceList: ProductPriceListEntity 
# Configurable reason recorded when the opportunity is archived (lost). Required 
# when the lost form mandates it.
reasonOfClose: DataEntity 
# 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.
step: StepEntity 
# Sales unit this opportunity is assigned to. Determines which team members can 
# see the record under unit-based sharing.
unit: SalesUnitEntity 
# 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: ID 
# Expected or actual closing date of the opportunity.
closingDate: Date! 
# Id of the currency exchange rate list applied to this opportunity.
currencyExchangeRatesListId: ID 
# Free-form description of the opportunity.
description: String 
# 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: Int 
# Time when an AI-suggested buying center was last applied to this opportunity.
lastAiBuyingCenterApplied: DateTime 
# Id of the lead source the opportunity originated from.
leadSourceId: ID 
# Name of the entity and its default text representation.
name: String! 
# Id of the opportunity type.
opptyTypeId: ID 
# Id of the opportunity owner.
ownerId: ID! 
# Id of the currency used for product line-item prices on this opportunity.
productCurrencyId: ID 
# Id of the price list that supplies prices for product line items added to this 
# opportunity, or empty to use catalog defaults.
productPriceListId: ID 
# Product sections grouping the record's line items, as a JSON array of {"id": 
# , "name": } objects. Validated on write. Full structure: 
# https://api-doc.coevera.com/latest/graphql/space/productsection.doc.html This 
# payload conforms to the `ProductSection` JSON Schema: 
# https://api-doc.coevera.com/schemas/ProductSection.json
productSections: [ProductSection!] 
# Free-text company email captured at opportunity creation when no Account record 
# has been linked yet.
quickAccountEmail: String 
# Free-text company name captured at opportunity creation when no Account record 
# has been linked yet.
quickAccountName: String 
# Free-text company phone captured at opportunity creation when no Account record 
# has been linked yet.
quickAccountPhone: String 
# Free-text contact name captured at opportunity creation when no Contact record 
# has been linked yet.
quickContactName: String 
# Free-text contact email captured at opportunity creation when no Contact record 
# has been linked yet.
quickEmail: String 
# Free-text contact phone captured at opportunity creation when no Contact record 
# has been linked yet.
quickPhone: String 
# Qualitative ranking score (1-10) the user assigns to indicate the strength of 
# the opportunity.
ranking: Int 
# Free-form note explaining why the opportunity was archived (lost).
reasonOfCloseDescription: String 
# Id of the reason of close option selected when the opportunity was archived 
# (lost).
reasonOfCloseId: ID 
# 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: ShareModeEnum 
# Id of the pipeline step.
stepId: ID! 
# Discriminator identifying the concrete record type — always "opportunity" for 
# Opportunity records. Read-only; useful when consuming polymorphic LeadOppty 
# results.
tableName: String! 
# Id of the sales unit.
unitId: ID 
# True when the opportunity has gone through the qualification step at least once.
wasQualified: Boolean 
# Revision when entity was lastly changed.
revision: Int 
# Monetary value of the opportunity in the team space base currency, with the 
# foreign value and currency code preserved alongside.
value: CurrencyForeignField 
# Number of email sequences this record is currently actively enrolled in 
# (soft-deleted or ended enrollments are not counted).
enrolledEmailSequences: Int! 
# Recurrence schedule generating periodic copies of this opportunity, or empty 
# when no recurrence is set up.
opptyRecurrence: OpptyRecurrenceEntity 
# Revenue schedule splitting the opportunity value across periods, or empty when 
# revenue scheduling is not enabled for this opportunity.
revenueSchedule: OpptyRevenueScheduleEntity 
# 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.
# 
# Arguments
# filter: Filter Product relations by target Product attributes.
# filterEdge: Filter OpptyProductRelation relations by edge 
# (relation) OpptyProductRelation attributes.
# orderBy: Order Product relations by target Product attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
productRelations(
filter: ProductFilterInput,
filterEdge: OpptyProductRelationFilterInput,
orderBy: [ProductOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): OpptyProductRelationEntityConnection 
# Primary contact of this opportunity. Set automatically from the contact relation 
# marked as primary.
primaryContact: ContactEntity 
# Primary account of this opportunity. Set automatically from the account relation 
# marked as primary.
primaryAccount: AccountEntity 
# Contacts linked to this opportunity, including their roles and org-chart 
# positions.
# 
# Arguments
# filter: Filter Contact relations by target Contact attributes.
# filterEdge: Filter LeadOpptyContactRelation relations by edge 
# (relation) LeadOpptyContactRelation attributes.
# orderBy: Order Contact relations by target Contact attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
contactRelations(
filter: ContactFilterInput,
filterEdge: LeadOpptyContactRelationFilterInput,
orderBy: [ContactOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): LeadOpptyContactRelationEntityConnection 
# Accounts linked to this opportunity, including the primary-account flag.
# 
# Arguments
# filter: Filter Account relations by target Account attributes.
# filterEdge: Filter LeadOpptyAccountRelation relations by edge 
# (relation) LeadOpptyAccountRelation attributes.
# orderBy: Order Account relations by target Account attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
accountRelations(
filter: AccountFilterInput,
filterEdge: LeadOpptyAccountRelationFilterInput,
orderBy: [AccountOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): LeadOpptyAccountRelationEntityConnection 
# Documents linked to this opportunity.
# 
# Arguments
# filter: Filter CloudObject relations by target CloudObject 
# attributes.
# filterEdge: Filter CloudObjectRelation relations by edge 
# (relation) CloudObjectRelation attributes.
# orderBy: Order CloudObject relations by target CloudObject 
# attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
documents(
filter: CloudObjectFilterInput,
filterEdge: CloudObjectRelationFilterInput,
orderBy: [CloudObjectOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): CloudObjectRelationEntityConnection 
# Quotes prepared for this opportunity.
# 
# Arguments
# filter: Filter Quote relations by target Quote attributes.
# orderBy: Order Quote relations by target Quote attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
quoteRelations(
filter: QuoteFilterInput,
orderBy: [QuoteOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): QuoteEntityConnection 
# Current status of the opportunity (Open, Won, Lost). Read-only; derived from the 
# current pipeline step and the archived flag.
status: OpptyStatusEnum! 
# Timestamp of when the opportunity was qualified, taken from the matching KPI 
# event. Empty for opportunities that have not been qualified. Read-only.
qualifyDate: DateTime 
# Timestamp of when the opportunity was won. Setting it adjusts the underlying win 
# event; empty for opportunities that have not been won.
wonDate: DateTime 
# Timestamp of when the opportunity was archived (lost). Setting it adjusts the 
# underlying loss event; empty for opportunities that have not been archived.
lostDate: DateTime 
# Number of days the opportunity has been sitting in its current pipeline step. 
# Read-only; computed by Coevera from the most recent move event and per-step 
# timeframe history.
daysInStep: Int! 
# True when the current authenticated user has marked this opportunity as 
# favorite. Per-user.
isFavorite: Boolean! 
# Sales units that have been granted shared access to this opportunity. Editable 
# only when shareMode allows unit sharing.
# 
# Arguments
# filter: Filter SalesUnit relations by target SalesUnit 
# attributes.
# filterEdge: Filter LeadOpptySharingSalesUnitRelation relations 
# by edge (relation) LeadOpptySharingSalesUnitRelation attributes.
# orderBy: Order SalesUnit relations by target SalesUnit 
# attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
sharingUnits(
filter: SalesUnitFilterInput,
filterEdge: LeadOpptySharingSalesUnitRelationFilterInput,
orderBy: [SalesUnitOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): LeadOpptySharingSalesUnitRelationEntityConnection 
# Users that have been granted shared access to this opportunity. Editable only 
# when shareMode allows user sharing.
# 
# Arguments
# filter: Filter Client relations by target Client attributes.
# filterEdge: Filter LeadOpptySharingClientRelation relations by 
# edge (relation) LeadOpptySharingClientRelation attributes.
# orderBy: Order Client relations by target Client attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
sharingClients(
filter: ClientFilterInput,
filterEdge: LeadOpptySharingClientRelationFilterInput,
orderBy: [ClientOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): LeadOpptySharingClientRelationEntityConnection 
# Tag labels applied to this opportunity.
# 
# Arguments
# filter: Filter Tag relations by target Tag attributes.
# filterEdge: Filter TagRelation relations by edge (relation) 
# TagRelation attributes.
# orderBy: Order Tag relations by target Tag attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
tags(
filter: TagFilterInput,
filterEdge: TagRelationFilterInput,
orderBy: [TagOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): TagRelationEntityConnection 
# Saved view profiles this opportunity currently matches.
# 
# Arguments
# filter: Filter Profile relations by target Profile attributes.
# filterEdge: Filter ProfileRelation relations by edge (relation) 
# ProfileRelation attributes.
# orderBy: Order Profile relations by target Profile attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
staticProfiles(
filter: ProfileFilterInput,
filterEdge: ProfileRelationFilterInput,
orderBy: [ProfileOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ProfileRelationEntityConnection 
# Filled only when a single record is read by its id; otherwise null or an empty 
# list.
fitness: WarningLevelEnum 
# Filled only when a single record is read by its id; otherwise null or an empty 
# list.
fitnessDescription: FitnessDescription 
# Display version of the opportunity name, used in lists and references.
formattedName: String! 
# Filled only when a single record is read by its id; otherwise null or an empty 
# list.
viewerIdsPerSalesUnit: [UUID!]! 
# Timestamp of the most recent modification made by an end user (excluding system 
# changes). Read-only; computed by Coevera.
modifiedByUser: DateTime 
# Permissions the current user has on this record, out of the requested ones.
# 
# Arguments
# permissions: Permissions to check; the result lists those the 
# current user has.
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
# Records of the given entity type that are related to this record, as a drilldown 
# list.
# 
# Arguments
# entityType: Entity type of the related records to list.
relatedEntitiesDrilldown(entityType: EntityNameEnum!): CompactViewDrilldownModel! 
# Data of the given preview pane charts and lists, computed for this record.
# 
# Arguments
# ids: Ids of the charts to compute, taken from the charts of the 
# record type's interface preview. Comment charts are not supported.
charts(ids: [UUID!]!): [DashboardChartData!] 
# Records behind one preview pane chart of this record: all records of a list 
# chart, or the records of a single data point of a report chart.
# 
# Arguments
# id: Id of the chart, taken from the charts of the record type's 
# interface preview.
# seriesIndex: Index of the series of the drilled-down data 
# point. Required for report charts; must not be set for list charts.
# itemIndex: Index of the drilled-down data point within its 
# series. Required for report charts; must not be set for list charts.
chartsDrilldown(id: UUID!, seriesIndex: Int, itemIndex: Int): CompactViewDrilldownModel! 
# Values of the fields shown in the record's preview pane, as configured for the 
# record's type.
# 
# Arguments
# ids: Ids of the fields to return. When not set, the fields 
# configured for the preview pane of the record's type are returned.
# first: Maximum number of preview pane fields to return when ids 
# is not set; fields pinned by the current user come first.
fields(ids: [UUID!], first: Int): [InterfaceFieldData]! 
# Checklist items of the steps of the record's pipeline, with the completion state 
# of each item for this record.
# 
# Arguments
# stepChecklistIds: Ids of the step checklist items to return. 
# When not set, the items of all steps of the record's pipeline are returned.
stepChecklists(stepChecklistIds: [UUID]): [StepChecklistActivityItem]! 
# Approval request of this record that is pending or was rejected; null when there 
# is none or it was approved.
approval: ApprovalEntity 
}
OpportunityEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
