Types: O
Each type links to the repository page that documents it; the types several repositories share are documented below, with their fields.
A B C D E F G H I J L M N O P Q R S T U V W X Y
OnlineForm OnlineFormActivityLogLineEntity OnlineFormActivityLogLineEntityConnection OnlineFormActivityLogLineEntityEdge OnlineFormActivityLogLineFilterInput OnlineFormActivityLogLineOrderByInput OnlineFormActivityLogLineRepository OnlineFormButtonPositionEnum OnlineFormCheckboxField OnlineFormColumn OnlineFormConfirmationPageType OnlineFormContainer OnlineFormDataExRelationEntity OnlineFormDataExRelationEntityConnection OnlineFormDataExRelationEntityEdge OnlineFormDataExRelationFilterInput OnlineFormDataExRelationOrderByInput OnlineFormDataExRelationRepository OnlineFormDateField OnlineFormDateTimeField OnlineFormDropdownField OnlineFormEmailField OnlineFormEntity OnlineFormEntityConnection OnlineFormEntityEdge OnlineFormFieldAnswer OnlineFormFieldInterface OnlineFormFileUploadField OnlineFormFilterInput OnlineFormFloatField OnlineFormFooter OnlineFormHeader OnlineFormInputField OnlineFormIntegerField OnlineFormItem OnlineFormMultiselectCheckboxField OnlineFormNotificationRecipientType OnlineFormOrderByInput OnlineFormOrderByNestedInput OnlineFormPhoneField OnlineFormPrefillTypeEnum OnlineFormProductServicesProperty OnlineFormProductsResponseLimit OnlineFormProductsServicesField OnlineFormRadioField OnlineFormRatingField OnlineFormRelatedRecordSettings OnlineFormRelationEntity OnlineFormRelationEntityConnection OnlineFormRelationEntityEdge OnlineFormRelationFilterInput OnlineFormRelationOrderByInput OnlineFormRelationRepository OnlineFormRepository OnlineFormResponse OnlineFormResponseItemConnection OnlineFormResponseItemEdge OnlineFormResponseSummary OnlineFormResponseSummaryItemConnection OnlineFormResponseSummaryItemEdge OnlineFormSection OnlineFormSettings OnlineFormsNotificationSettings OnlineFormsNotificationSettingsParams OnlineFormStyleEntity OnlineFormStyleEntityConnection OnlineFormStyleEntityEdge OnlineFormStyleFilterInput OnlineFormStyleOrderByInput OnlineFormStyleOrderByNestedInput OnlineFormStyleRepository OnlineFormStyleSettings OnlineFormTextAreaField OnlineFormTheme OnlineFormTypeDetailGridSortBy OnlineFormTypeDetailResponseGridSortBy OnlineFormTypeEmailRelationEntity OnlineFormTypeEmailRelationEntityConnection OnlineFormTypeEmailRelationEntityEdge OnlineFormTypeEmailRelationFilterInput OnlineFormTypeEmailRelationOrderByInput OnlineFormTypeEmailRelationRepository OnlineFormTypeEntity OnlineFormTypeEntityConnection OnlineFormTypeEntityEdge OnlineFormTypeFilterInput OnlineFormTypeOrderByInput OnlineFormTypeOrderByNestedInput OnlineFormTypeRepository OnlineFormTypeTabDataGridViewOptionsParams OnlineFormUploadedFiles OnlineFormValueOverride OpportunityAutoPrefill OpportunityDashboardProfile OpportunityDashboardProfileTab OpportunityDashboardProfileView OpportunityEntity OpportunityEntityConnection OpportunityEntityEdge OpportunityFilterInput OpportunityFilterTab OpportunityForecastProfile OpportunityForecastProfileTab OpportunityForecastProperties OpportunityForecastQuota OpportunityForecastQuotaItem OpportunityForecastQuotaItemValue OpportunityForecastQuotaSplitType OpportunityForecastView OpportunityGroupBy OpportunityKPIFilterTab OpportunityOrderByInput OpportunityOrderByNestedInput OpportunityProfileInterface OpportunityReportTargetTab OpportunityRepository OpportunityRoleTab OpportunityTypeEntity OpportunityTypeEntityConnection OpportunityTypeEntityEdge OpportunityTypeFilterInput OpportunityTypeOrderByInput OpportunityTypeOrderByNestedInput OpportunityTypeRepository OpptyCardProperty OpptyProductRelationDataExRelationEntity OpptyProductRelationDataExRelationEntityConnection OpptyProductRelationDataExRelationEntityEdge OpptyProductRelationDataExRelationFilterInput OpptyProductRelationDataExRelationOrderByInput OpptyProductRelationDataExRelationRepository OpptyProductRelationEntity OpptyProductRelationEntityConnection OpptyProductRelationEntityEdge OpptyProductRelationFilterInput OpptyProductRelationOrderByInput OpptyProductRelationOrderByNestedInput OpptyProductRelationRepository OpptyProductRelationRevenueScheduleEntity OpptyProductRelationRevenueScheduleEntityConnection OpptyProductRelationRevenueScheduleEntityEdge OpptyProductRelationRevenueScheduleFilterInput OpptyProductRelationRevenueScheduleOrderByInput OpptyProductRelationRevenueScheduleOrderByNestedInput OpptyProductRelationRevenueSchedulePeriodEntity OpptyProductRelationRevenueSchedulePeriodEntityConnection OpptyProductRelationRevenueSchedulePeriodEntityEdge OpptyProductRelationRevenueSchedulePeriodFilterInput OpptyProductRelationRevenueSchedulePeriodOrderByInput OpptyProductRelationRevenueSchedulePeriodRepository OpptyProductRelationRevenueScheduleRepository OpptyProductRelationTypeEntity OpptyProductRelationTypeEntityConnection OpptyProductRelationTypeEntityEdge OpptyProductRelationTypeFilterInput OpptyProductRelationTypeOrderByInput OpptyProductRelationTypeOrderByNestedInput OpptyProductRelationTypeRepository OpptyRecurrenceEntity OpptyRecurrenceEntityConnection OpptyRecurrenceEntityEdge OpptyRecurrenceFilterInput OpptyRecurrenceOrderByInput OpptyRecurrenceOrderByNestedInput OpptyRecurrenceRepository OpptyRevenueScheduleEntity OpptyRevenueScheduleEntityConnection OpptyRevenueScheduleEntityEdge OpptyRevenueScheduleFilterInput OpptyRevenueScheduleOrderByInput OpptyRevenueScheduleOrderByNestedInput OpptyRevenueSchedulePeriodEntity OpptyRevenueSchedulePeriodEntityConnection OpptyRevenueSchedulePeriodEntityEdge OpptyRevenueSchedulePeriodFilterInput OpptyRevenueSchedulePeriodOrderByInput OpptyRevenueSchedulePeriodRepository OpptyRevenueScheduleRepository OpptyStatusEnum OpptyStatusEnumFilterInput OrderByEnum OrgRelationshipTypeEnum OrgRelationshipTypeEnumFilterInput OverdueTaskOverview OverdueTaskOverviewAgenda OverdueTaskOverviewAgendaConnection OverdueTaskOverviewAgendaEdge OverdueTasks
Shared types: O
Types several repositories use, or none does, with their fields and their descriptions.
OnlineFormActivityLogLineRepository object 5 fields: getById, getByIds, getAll, …
Read operations for OnlineFormActivityLogLine records.
| Field | Type | Description |
|---|---|---|
getById | OnlineFormActivityLogLineEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [OnlineFormActivityLogLineEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [OnlineFormActivityLogLineEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | OnlineFormActivityLogLineEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
OnlineFormDataExRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for OnlineFormDataExRelation records.
| Field | Type | Description |
|---|---|---|
getById | OnlineFormDataExRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [OnlineFormDataExRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [OnlineFormDataExRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | OnlineFormDataExRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
OnlineFormOrderByNestedInput input 12 fields: id, isDeleted, modified, …
Sorting by a field of the related OnlineForm record. Set exactly one field in each item.
| Input field | Type | Description |
|---|---|---|
id | OrderByEnum | Unique identifier of entity. |
isDeleted | OrderByEnum | Specifies if the entity is considered deleted. |
modified | OrderByEnum | Last modification time. |
created | OrderByEnum | Creation time. |
currencyExchangeRatesListId | OrderByEnum | Id of the currency exchange rate list applied to product line items at submission time. |
emailId | OrderByEnum | Id of the linked email record, when available. |
onlineFormTypeId | OrderByEnum | Id of the online form definition. |
productPriceListId | OrderByEnum | Id of the selected price list. |
status | OrderByEnum | Overall result of processing the submission: the most severe status among its activity log lines, Error when a step failed. |
revision | OrderByEnum | Revision when entity was lastly changed. |
recordName | OrderByEnum | Display name of the record that submitted (or is associated with) this form response, formatted according to the calling user's preferred name format. |
withCustom | CommonEntityRepositoryOrderByCustomField | Sorts by a custom field. |
OnlineFormRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for OnlineFormRelation records.
| Field | Type | Description |
|---|---|---|
getById | OnlineFormRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [OnlineFormRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [OnlineFormRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | OnlineFormRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
OnlineFormRepository object 8 fields: getById, getByIds, getAll, …
Read operations for OnlineForm records.
| Field | Type | Description |
|---|---|---|
getById | OnlineFormEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [OnlineFormEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [OnlineFormEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | OnlineFormEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
getBySession | OnlineFormEntityConnection (7 args) | Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. |
getByIdFormatted | JSONString (2 args) | Returns the values of a record's fields formatted for display, keyed by field id. |
getDownloadUrl | String! (4 args) | Exports the submission log of an online form to a zipped text file and returns a URL to download it. |
OnlineFormStyleRepository object 5 fields: getById, getByIds, getAll, …
Read operations for OnlineFormStyle records.
| Field | Type | Description |
|---|---|---|
getById | OnlineFormStyleEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [OnlineFormStyleEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [OnlineFormStyleEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | OnlineFormStyleEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
OnlineFormTypeEmailRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for OnlineFormTypeEmailRelation records.
| Field | Type | Description |
|---|---|---|
getById | OnlineFormTypeEmailRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [OnlineFormTypeEmailRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [OnlineFormTypeEmailRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | OnlineFormTypeEmailRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
OnlineFormTypeOrderByNestedInput input 24 fields: id, isDeleted, modified, …
Sorting by a field of the related OnlineFormType record. Set exactly one field in each item.
| Input field | Type | Description |
|---|---|---|
id | OrderByEnum | Unique identifier of entity. |
isDeleted | OrderByEnum | Specifies if the entity is considered deleted. |
modified | OrderByEnum | Last modification time. |
created | OrderByEnum | Creation time. |
autoPrefillWithJavascript | OrderByEnum | When true, the embedded form JavaScript pre-fills fields from URL query parameters on load. |
description | OrderByEnum | Free-text description shown alongside the form definition in the UI. |
entityApiName | OrderByEnum | API name of the custom entity the form targets. Set only when entityType is CustomEntity; otherwise empty. |
isEnabled | OrderByEnum | When true, the form is published and accepts new submissions; when false, the form returns an error to respondents. |
isReadonly | OrderByEnum | True when the form is system-managed and its schema cannot be edited by users. |
lastSchemaChange | OrderByEnum | Timestamp of the most recent change to formEdit (form schema). |
lastStatusChange | OrderByEnum | Timestamp of the most recent change to isEnabled. |
name | OrderByEnum | Name of the entity and its default text representation. |
ownerId | OrderByEnum | Id of the owning user. |
styleId | OrderByEnum | Id of the form style. |
revision | OrderByEnum | Revision when entity was lastly changed. |
responseAcceptanceThreshold | OrderByEnum | Minimum response count required for the form to be considered "responsive" in reports and notifications. Empty when no threshold is configured. |
sentCount | OrderByEnum | Total number of times the form link has been delivered to recipients. |
sentUniqueCount | OrderByEnum | Number of distinct recipients the form link has been delivered to. |
responseCount | OrderByEnum | Total number of submissions (responses) recorded for the form. |
responseRate | OrderByEnum | Fraction (0–1) of unique recipients who submitted a response. |
lastResponseDate | OrderByEnum | Timestamp of the most recent submission. Empty when the form has no responses. |
lastResponseBy | OrderByEnum | Name or email address of the respondent on the most recent submission. Empty when the form has no responses or the respondent could not be identified. |
solutions | OrderByEnum | Names of the solutions whose canvas contains this form, in name order. Empty when the form is on no solution canvas. |
status | OrderByEnum | Overall state of the form: Inactive while it has no active configuration, Active while accepting responses, Completed once the configured end condition is met. |
OnlineFormTypeRepository object 6 fields: getById, getByIds, getAll, …
Read operations for OnlineFormType records.
| Field | Type | Description |
|---|---|---|
getById | OnlineFormTypeEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [OnlineFormTypeEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [OnlineFormTypeEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | OnlineFormTypeEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
getByOnlineFormTypeCriteria | OnlineFormTypeEntityConnection (7 args) | Returns a page of online forms filtered by owner, enabled state and status, in addition to the regular filter. |
OpportunityDashboardProfile object 6 fields: filter, salesPipeline, role, …
Saved opportunity dashboard: the filter, sales pipelines, lead processes and ownership scope of the records it covers, its target and the graphs it shows.
| Field | Type | Description |
|---|---|---|
filter | LeadOpportunityFilterTab! | Filter tab restricting which leads and opportunities the profile shows. |
salesPipeline | [ID!] | Identifiers of the sales pipelines the dashboard is restricted to. Null includes all pipelines. |
role | OpportunityRoleTab! | Ownership scope of the records shown (own, shared, or managing-unit items). |
target | OpportunityReportTargetTab! | Target tab defining the goal, measured period and comparison for the dashboard. |
leadProcess | [UUID!] | Identifiers of the lead processes the profile is restricted to. Null includes all lead processes. |
view | OpportunityDashboardProfileView! | View settings of the dashboard, including which graphs are shown. |
OpportunityDashboardProfileView object drilldownFields: [ID!]!, graphs: [DashboardGraphOpportunityNameType]!
View settings of the opportunity dashboard: the graphs it shows and the fields listed when a graph value is drilled into.
| Field | Type | Description |
|---|---|---|
drilldownFields | [ID!]! | Identifiers of the fields shown as columns when a dashboard graph value is drilled down into. |
graphs | [DashboardGraphOpportunityNameType]! | Graphs shown on the opportunity dashboard, each identified by its graph type. |
OpportunityForecastProfile object 5 fields: filter, salesPipeline, leadProcess, …
Saved opportunity forecast of a forecast report: the filter, sales pipelines, lead processes, the dimension it is broken down by and the forecast view.
| Field | Type | Description |
|---|---|---|
filter | OpportunityFilterTab! | Filter tab restricting which opportunities the profile shows. |
salesPipeline | [ID!] | Identifiers of the sales pipelines the forecast is restricted to. Null includes all pipelines. |
leadProcess | [UUID!] | Identifiers of the lead processes the profile is restricted to. Null includes all lead processes. |
view | OpportunityForecastView! | View settings of the forecast: value field, period, owners, columns, grouping and quota. |
properties | OpportunityForecastProperties! | Forecast properties, including the dimension the forecast is built on. |
OpportunityForecastProperties object type: ForecastType!
General properties of an opportunity forecast, such as the dimension it is broken down by (users, sales units, products, product categories or accounts).
| Field | Type | Description |
|---|---|---|
type | ForecastType! | Dimension the forecast is built on: Users, SalesUnits, Products, ProductCategories, or Accounts. |
OpportunityForecastQuota object isEnabled: Boolean!, value: Float!, comparisonType: ForecastPerformanceComparisonType!, items: [OpportunityForecastQuotaItem!]!
Quota of an opportunity forecast: the total amount, the baseline performance is compared with and its allocation to the owners.
| Field | Type | Description |
|---|---|---|
isEnabled | Boolean! | Whether a quota is set for the forecast. |
value | Float! | Total quota amount for the forecast. |
comparisonType | ForecastPerformanceComparisonType! | Baseline the forecast is compared against: PreviousPeriod, AveragePerformance, or WeightedAveragePerformance. |
items | [OpportunityForecastQuotaItem!]! | Per-owner quota allocations making up the total quota. |
OpportunityForecastQuotaItem object id: ID!, values: [OpportunityForecastQuotaItemValue!]!, splitType: OpportunityForecastQuotaSplitType!
Quota allocated to one owner of an opportunity forecast, split across the forecast periods.
| Field | Type | Description |
|---|---|---|
id | ID! | Identifier of the owner the quota is allocated to. |
values | [OpportunityForecastQuotaItemValue!]! | Quota amounts split across the forecast periods. |
splitType | OpportunityForecastQuotaSplitType! | How the total quota is distributed across periods: Evenly, HistoricalPerformance, or Custom. |
OpportunityForecastQuotaItemValue object date: Date!, value: Float!
Quota amount of one owner for a single forecast period.
| Field | Type | Description |
|---|---|---|
date | Date! | Period this quota value applies to. |
value | Float! | Quota amount allocated to the period. |
OpportunityForecastView object 12 fields: field, period, owner, …
View settings of an opportunity forecast: the value field, period, owners, columns, grouping, drilldown and quota.
| Field | Type | Description |
|---|---|---|
field | ID! | Identifier of the value field the forecast amounts are calculated from. |
period | ForecastPeriodOption! | Period range and granularity the forecast is calculated over. |
owner | [ForecastOwner]! | Owners (users) included in the forecast, with their performance series. |
column | [ForecastColumnsType!]! | Value columns shown in the forecast table (for example WonValueCurrentPeriod, OpenValueWeighted, WonVsForecast). |
groupBy | ID | Identifier of the field rows are grouped by. Null applies no grouping. |
isDrilldownEnabled | Boolean! | When true, rows can be expanded into a drilldown table of contributing records. |
drilldownFields | [ID!]! | List of fields id to display as drilldown table |
quota | OpportunityForecastQuota! | Quota configuration the forecast values are measured against. |
showGraph | Boolean! | When true, displays the forecast graph above the table. |
rollUpPeriod | ForecastPeriodKind | Coarser period the forecast rows are rolled up into (Monthly, Quarterly, or Yearly). Null keeps the base period granularity. |
hideEmptyRows | Boolean! | When true, rows with no forecast values are hidden. |
graphHeight | Int | Height of the forecast graph, in pixels. |
OpportunityKPIFilterTab object 6 fields: isEnabled, filterMainBox, filterSiblingBoxes, …
Filter conditions that select which leads and opportunities the sales KPIs of a saved profile are calculated from.
| Field | Type | Description |
|---|---|---|
isEnabled | Boolean! | Whether the filter is applied. When false, the filter conditions are ignored. |
filterMainBox | MainFilterBox! | Primary group of filter conditions evaluated on the main record type. |
filterSiblingBoxes | [FilterBox!]! | Additional groups of filter conditions evaluated on related record types. |
isCustom | Boolean! | True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. |
operator | FilterGroupOperator! | How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. |
formula | String | Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. |
OpportunityOrderByNestedInput input 35 fields: id, isDeleted, modified, …
Sorting by a field of the related Opportunity record. Set exactly one field in each item.
| Input field | Type | Description |
|---|---|---|
id | OrderByEnum | Unique identifier of entity. |
isDeleted | OrderByEnum | Specifies if the entity is considered deleted. |
modified | OrderByEnum | Last modification time. |
created | OrderByEnum | Creation time. |
activeQuoteId | OrderByEnum | 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. |
closingDate | OrderByEnum | Expected or actual closing date of the opportunity. |
currencyExchangeRatesListId | OrderByEnum | Id of the currency exchange rate list applied to this opportunity. |
description | OrderByEnum | Free-form description of the opportunity. |
isArchived | 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. |
isValueAutoCalculate | OrderByEnum | True when value is auto-calculated from the opportunity product line items. False when the user enters value directly. |
labelFlag | OrderByEnum | User-set colored flag used to highlight the opportunity in lists and reports. |
leadSourceId | OrderByEnum | Id of the lead source the opportunity originated from. |
name | OrderByEnum | Name of the entity and its default text representation. |
opptyTypeId | OrderByEnum | Id of the opportunity type. |
ownerId | OrderByEnum | Id of the opportunity owner. |
productPriceListId | OrderByEnum | Id of the price list that supplies prices for product line items added to this opportunity, or empty to use catalog defaults. |
quickAccountEmail | OrderByEnum | Free-text company email captured at opportunity creation when no Account record has been linked yet. |
quickAccountName | OrderByEnum | Free-text company name captured at opportunity creation when no Account record has been linked yet. |
quickAccountPhone | OrderByEnum | Free-text company phone captured at opportunity creation when no Account record has been linked yet. |
quickContactName | OrderByEnum | Free-text contact name captured at opportunity creation when no Contact record has been linked yet. |
quickEmail | OrderByEnum | Free-text contact email captured at opportunity creation when no Contact record has been linked yet. |
quickPhone | OrderByEnum | Free-text contact phone captured at opportunity creation when no Contact record has been linked yet. |
ranking | OrderByEnum | Qualitative ranking score (1-10) the user assigns to indicate the strength of the opportunity. |
reasonOfCloseDescription | OrderByEnum | Free-form note explaining why the opportunity was archived (lost). |
reasonOfCloseId | OrderByEnum | Id of the reason of close option selected when the opportunity was archived (lost). |
shareMode | 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. |
stepId | OrderByEnum | Id of the pipeline step. |
unitId | OrderByEnum | Id of the sales unit. |
wasQualified | OrderByEnum | True when the opportunity has gone through the qualification step at least once. |
revision | OrderByEnum | Revision when entity was lastly changed. |
value | OrderByEnum | Monetary value of the opportunity in the team space base currency, with the foreign value and currency code preserved alongside. |
enrolledEmailSequences | OrderByEnum | Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). |
status | OrderByEnum | Current status of the opportunity (Open, Won, Lost). Read-only; derived from the current pipeline step and the archived flag. |
relatedEntities | CommonEntityRepositoryOrderByEntityRelationField | Sorts records by whether they are related to the listed records. |
withCustom | CommonEntityRepositoryOrderByCustomField | Sorts by a custom field. |
OpportunityProfileInterface interface filter: OpportunityFilterTab!, salesPipeline: [ID!]
Settings shared by the saved opportunity profiles and forecasts: the filter and the sales pipelines the opportunities belong to.
| Field | Type | Description |
|---|---|---|
filter | OpportunityFilterTab! | Filter tab restricting which opportunities the profile shows. |
salesPipeline | [ID!] | Identifiers of the sales pipelines the profile is restricted to. Null includes all pipelines. |
OpportunityRepository object 9 fields: getById, getByIds, getAll, …
Read operations for Opportunity records.
| Field | Type | Description |
|---|---|---|
getById | OpportunityEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [OpportunityEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [OpportunityEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | OpportunityEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
getBySession | OpportunityEntityConnection (7 args) | Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. |
getByIdFormatted | JSONString (2 args) | Returns the values of a record's fields formatted for display, keyed by field id. |
autoPrefill | OpportunityEntity! (3 args) | Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create. |
aiAutoPrefill | OpportunityAutoPrefill! (1 args) | Returns an unsaved record pre-filled with the values proposed by an AI record suggestion, together with the fields the suggestion filled in. Nothing is saved; the caller can review the values and create or update the record. |
OpportunityTypeOrderByNestedInput input 9 fields: id, isDeleted, modified, …
Sorting by a field of the related OpportunityType record. Set exactly one field in each item.
| Input field | Type | Description |
|---|---|---|
id | OrderByEnum | Unique identifier of entity. |
isDeleted | OrderByEnum | Specifies if the entity is considered deleted. |
modified | OrderByEnum | Last modification time. |
created | OrderByEnum | Creation time. |
isReadonly | OrderByEnum | True when the opportunity type is system-managed and cannot be edited or deleted by users. |
name | OrderByEnum | Name of the entity and its default text representation. |
pipelineId | OrderByEnum | Id of the pipeline this opportunity type drives. |
isPublished | OrderByEnum | True when the entity configuration is published; false while it exists only as an unpublished draft. |
revision | OrderByEnum | Revision when entity was lastly changed. |
OpportunityTypeRepository object 8 fields: getById, getByIds, getAll, …
Read operations for OpportunityType records.
| Field | Type | Description |
|---|---|---|
getById | OpportunityTypeEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [OpportunityTypeEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [OpportunityTypeEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | OpportunityTypeEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getPublished | [OpportunityTypeEntity!]! (5 args) | Returns the published records that match the filter, paged with limit and offset. |
getDrafts | [OpportunityTypeEntity!]! (2 args) | Returns the records that match the filter, with pending unpublished changes applied where a draft exists. |
getDraftById | OpportunityTypeEntity! (1 args) | Returns the record with the given id, with its pending unpublished changes applied when a draft exists. |
getByPipeline | OpportunityTypeEntity (1 args) | Returns the opportunity type that uses the given pipeline, or null when none does. |
OpptyProductRelationDataExRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for OpptyProductRelationDataExRelation records.
| Field | Type | Description |
|---|---|---|
getById | OpptyProductRelationDataExRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [OpptyProductRelationDataExRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [OpptyProductRelationDataExRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | OpptyProductRelationDataExRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
OpptyProductRelationOrderByNestedInput input 21 fields: id, isDeleted, modified, …
Sorting by a field of the related OpptyProductRelation record. Set exactly one field in each item.
| Input field | Type | Description |
|---|---|---|
id | OrderByEnum | Unique identifier of entity. |
isDeleted | OrderByEnum | Specifies if the entity is considered deleted. |
modified | OrderByEnum | Last modification time. |
created | OrderByEnum | Creation time. |
amount | OrderByEnum | Total amount of the line item (price * quantity, with discounts applied). |
comment | OrderByEnum | Free-form note describing this line item. |
currencyExchangeRatesListId | OrderByEnum | Id of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote. |
onlineFormFieldId | OrderByEnum | Id of the online form field in which the respondent selected this product, or empty when the line item did not come from a form submission. |
onlineFormId | OrderByEnum | Id of the online form submission this line item came from, or empty when it was not created through a form. |
opptyId | OrderByEnum | Id of the opportunity. |
opptyProductRelationTypeId | OrderByEnum | Id of the line-item type. |
pairedOpptyProductRelationId | OrderByEnum | Id of the paired line item. |
price | OrderByEnum | Per-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly. |
productId | OrderByEnum | Id of the product on this line item. Set on create; cannot be changed afterwards. |
quantity | OrderByEnum | Number of product units on this line item. |
quoteId | OrderByEnum | Id of the quote this line item belongs to. Mutually exclusive with opptyId. |
sortOrder | OrderByEnum | Display order of the line item within its section. Maintained automatically when lines are added or moved. |
revision | OrderByEnum | Revision when entity was lastly changed. |
discountValue | OrderByEnum | Absolute monetary discount applied to this line item versus the price-list price. Read-only; computed by Coevera. |
discountPercentage | OrderByEnum | Percentage discount applied to this line item versus the price-list price. Read-only; computed by Coevera. |
withCustom | CommonEntityRepositoryOrderByCustomField | Sorts by a custom field. |
OpptyProductRelationRepository object 7 fields: getById, getByIds, getAll, …
Read operations for OpptyProductRelation records.
| Field | Type | Description |
|---|---|---|
getById | OpptyProductRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [OpptyProductRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [OpptyProductRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | OpptyProductRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
getBySession | OpptyProductRelationEntityConnection (7 args) | Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. |
getByIdFormatted | JSONString (2 args) | Returns the values of a record's fields formatted for display, keyed by field id. |
OpptyProductRelationRevenueScheduleOrderByNestedInput input 8 fields: id, isDeleted, modified, …
Sorting by a field of the related OpptyProductRelationRevenueSchedule record. Set exactly one field in each item.
| Input field | Type | Description |
|---|---|---|
id | OrderByEnum | Unique identifier of entity. Must match with OpptyProductRelation id. |
isDeleted | OrderByEnum | Specifies if the entity is considered deleted. |
modified | OrderByEnum | Last modification time. |
created | OrderByEnum | Creation time. |
cancelationDate | OrderByEnum | Date when the revenue schedule was cancelled. Empty for active schedules. |
periodCount | OrderByEnum | Number of periods the line-item amount is split into. |
startDate | OrderByEnum | Date when revenue recognition for this product line begins. |
revision | OrderByEnum | Revision when entity was lastly changed. |
OpptyProductRelationRevenueSchedulePeriodRepository object 5 fields: getById, getByIds, getAll, …
Read operations for OpptyProductRelationRevenueSchedulePeriod records.
| Field | Type | Description |
|---|---|---|
getById | OpptyProductRelationRevenueSchedulePeriodEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [OpptyProductRelationRevenueSchedulePeriodEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [OpptyProductRelationRevenueSchedulePeriodEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | OpptyProductRelationRevenueSchedulePeriodEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
OpptyProductRelationRevenueScheduleRepository object 5 fields: getById, getByIds, getAll, …
Read operations for OpptyProductRelationRevenueSchedule records.
| Field | Type | Description |
|---|---|---|
getById | OpptyProductRelationRevenueScheduleEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [OpptyProductRelationRevenueScheduleEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [OpptyProductRelationRevenueScheduleEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | OpptyProductRelationRevenueScheduleEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
OpptyProductRelationTypeOrderByNestedInput input 8 fields: id, isDeleted, modified, …
Sorting by a field of the related OpptyProductRelationType record. Set exactly one field in each item.
| Input field | Type | Description |
|---|---|---|
id | OrderByEnum | Unique identifier of entity. |
isDeleted | OrderByEnum | Specifies if the entity is considered deleted. |
modified | OrderByEnum | Last modification time. |
created | OrderByEnum | Creation time. |
isReadonly | OrderByEnum | True when the line-item type is system-managed and cannot be edited or deleted by users. |
name | OrderByEnum | Name of the entity and its default text representation. |
isPublished | OrderByEnum | True when the entity configuration is published; false while it exists only as an unpublished draft. |
revision | OrderByEnum | Revision when entity was lastly changed. |
OpptyProductRelationTypeRepository object 7 fields: getById, getByIds, getAll, …
Read operations for OpptyProductRelationType records.
| Field | Type | Description |
|---|---|---|
getById | OpptyProductRelationTypeEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [OpptyProductRelationTypeEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [OpptyProductRelationTypeEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | OpptyProductRelationTypeEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getPublished | [OpptyProductRelationTypeEntity!]! (5 args) | Returns the published records that match the filter, paged with limit and offset. |
getDrafts | [OpptyProductRelationTypeEntity!]! (2 args) | Returns the records that match the filter, with pending unpublished changes applied where a draft exists. |
getDraftById | OpptyProductRelationTypeEntity! (1 args) | Returns the record with the given id, with its pending unpublished changes applied when a draft exists. |
OpptyRecurrenceRepository object 5 fields: getById, getByIds, getAll, …
Read operations for OpptyRecurrence records.
| Field | Type | Description |
|---|---|---|
getById | OpptyRecurrenceEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [OpptyRecurrenceEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [OpptyRecurrenceEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | OpptyRecurrenceEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
OpptyRevenueScheduleOrderByNestedInput input 8 fields: id, isDeleted, modified, …
Sorting by a field of the related OpptyRevenueSchedule record. Set exactly one field in each item.
| Input field | Type | Description |
|---|---|---|
id | OrderByEnum | Unique identifier of entity. Must match with Opportunity id. |
isDeleted | OrderByEnum | Specifies if the entity is considered deleted. |
modified | OrderByEnum | Last modification time. |
created | OrderByEnum | Creation time. |
cancelationDate | OrderByEnum | Date when the revenue schedule was cancelled. Empty for active schedules. |
periodCount | OrderByEnum | Number of periods the opportunity value is split into. |
startDate | OrderByEnum | Date when revenue recognition for the opportunity begins. |
revision | OrderByEnum | Revision when entity was lastly changed. |
OpptyRevenueSchedulePeriodRepository object 5 fields: getById, getByIds, getAll, …
Read operations for OpptyRevenueSchedulePeriod records.
| Field | Type | Description |
|---|---|---|
getById | OpptyRevenueSchedulePeriodEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [OpptyRevenueSchedulePeriodEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [OpptyRevenueSchedulePeriodEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | OpptyRevenueSchedulePeriodEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
OpptyRevenueScheduleRepository object 5 fields: getById, getByIds, getAll, …
Read operations for OpptyRevenueSchedule records.
| Field | Type | Description |
|---|---|---|
getById | OpptyRevenueScheduleEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [OpptyRevenueScheduleEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [OpptyRevenueScheduleEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | OpptyRevenueScheduleEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
OrderByEnum enum Asc, Desc
Direction in which results are ordered by a field.
| Value | Description |
|---|---|
Asc | Ascending order. |
Desc | Descending order. |
OrgRelationshipTypeEnum enum NoRelationship, Weak, Moderate, Strong
Strength of a contact's relationship within an account or lead/opportunity org chart.
| Value | Description |
|---|---|
NoRelationship | No relationship is recorded. |
Weak | The relationship is weak. |
Moderate | The relationship is of moderate strength. |
Strong | The relationship is strong. |
OrgRelationshipTypeEnumFilterInput input eq: [OrgRelationshipTypeEnum!], NOT: OrgRelationshipTypeEnumFilterInput
Conditions on an enumeration field. Several conditions given together must all match.
| Input field | Type | Description |
|---|---|---|
eq | [OrgRelationshipTypeEnum!] | Matches any of the listed values. |
NOT | OrgRelationshipTypeEnumFilterInput | Matches values that do not meet this condition. |
OverdueTaskOverview interface id: ID!, subject: String!, dueDate: Date
Task in the dashboard agenda that is past its due date.
| Field | Type | Description |
|---|---|---|
id | ID! | Id of the task. |
subject | String! | Subject of the task. |
dueDate | Date | Due date the task has passed. |
OverdueTaskOverviewAgenda object 7 fields: id, subject, dueDate, …
Overdue task listed in an agenda, with its type, priority, reminder and owner.
| Field | Type | Description |
|---|---|---|
id | ID! | Id of the task. |
subject | String! | Subject of the task. |
dueDate | Date | Due date the task has passed. |
taskType | ActivityTypeIconEnum! | Icon of the task type. |
priority | PriorityEnum! | Priority of the task. |
reminder | DateTime | Reminder date and time of the task; null when no reminder is set. |
ownerName | String! | Name of the task owner. |
OverdueTaskOverviewAgendaConnection object pageInfo: PageInfo!, edges: [OverdueTaskOverviewAgendaEdge]!
Paginated list of OverdueTaskOverviewAgenda items.
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [OverdueTaskOverviewAgendaEdge]! | Contains the nodes in this connection. |
OverdueTaskOverviewAgendaEdge object node: OverdueTaskOverviewAgenda, cursor: String!
A Relay edge containing a OverdueTaskOverviewAgenda and its cursor.
| Field | Type | Description |
|---|---|---|
node | OverdueTaskOverviewAgenda | The item at the end of the edge |
cursor | String! | A cursor for use in pagination |
OverdueTasks object overdueTasksCount: Int!, overdueTasksList: OverdueTaskOverviewAgendaConnection
Overdue tasks shown in the dashboard agenda, with their count.
| Field | Type | Description |
|---|---|---|
overdueTasksCount | Int! | Number of overdue tasks. |
overdueTasksList | OverdueTaskOverviewAgendaConnection (4 args) | Overdue tasks, earliest due date first. |