Types: Q
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
QualifyLeadInput QualifyLeadPayload Query QuickFilterInterface QuickFilterTab QuoteAccountRelationEntity QuoteAccountRelationEntityConnection QuoteAccountRelationEntityEdge QuoteAccountRelationFilterInput QuoteAccountRelationOrderByInput QuoteAccountRelationRepository QuoteContactRelationEntity QuoteContactRelationEntityConnection QuoteContactRelationEntityEdge QuoteContactRelationFilterInput QuoteContactRelationOrderByInput QuoteContactRelationRepository QuoteDataExRelationEntity QuoteDataExRelationEntityConnection QuoteDataExRelationEntityEdge QuoteDataExRelationFilterInput QuoteDataExRelationOrderByInput QuoteDataExRelationRepository QuoteEntity QuoteEntityConnection QuoteEntityEdge QuoteFilterInput QuoteFilterTab QuoteKPIEntity QuoteKPIEntityConnection QuoteKPIEntityEdge QuoteKpiEnum QuoteKpiEnumFilterInput QuoteKPIFilterInput QuoteKPIOrderByInput QuoteKPIRepository QuoteOrderByInput QuoteOrderByNestedInput QuotePivotReportProfile QuoteProcessEntity QuoteProcessEntityConnection QuoteProcessEntityEdge QuoteProcessFilterInput QuoteProcessOrderByInput QuoteProcessOrderByNestedInput QuoteProcessRepository QuoteProfileInterface QuoteReportProfileInterface QuoteRepository QuoteRoleTab QuoteSharingClientRelationEntity QuoteSharingClientRelationEntityConnection QuoteSharingClientRelationEntityEdge QuoteSharingClientRelationFilterInput QuoteSharingClientRelationOrderByInput QuoteSharingClientRelationRepository QuoteSharingSalesUnitRelationEntity QuoteSharingSalesUnitRelationEntityConnection QuoteSharingSalesUnitRelationEntityEdge QuoteSharingSalesUnitRelationFilterInput QuoteSharingSalesUnitRelationOrderByInput QuoteSharingSalesUnitRelationRepository QuotesNotificationSettings QuotesNotificationSettingsParams QuoteStatusEnum QuoteStatusEnumFilterInput QuoteTableReportProfile QuoteTypeEntity QuoteTypeEntityConnection QuoteTypeEntityEdge QuoteTypeFilterInput QuoteTypeOrderByInput QuoteTypeOrderByNestedInput QuoteTypeRepository
Shared types: Q
Types several repositories use, or none does, with their fields and their descriptions.
Query object entities: EntityRepositoryRegistry!
QuoteAccountRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for QuoteAccountRelation records.
| Field | Type | Description |
|---|---|---|
getById | QuoteAccountRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [QuoteAccountRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [QuoteAccountRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | QuoteAccountRelationEntityConnection (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. |
QuoteContactRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for QuoteContactRelation records.
| Field | Type | Description |
|---|---|---|
getById | QuoteContactRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [QuoteContactRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [QuoteContactRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | QuoteContactRelationEntityConnection (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. |
QuoteDataExRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for QuoteDataExRelation records.
| Field | Type | Description |
|---|---|---|
getById | QuoteDataExRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [QuoteDataExRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [QuoteDataExRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | QuoteDataExRelationEntityConnection (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. |
QuoteKPIRepository object 5 fields: getById, getByIds, getAll, …
Read operations for QuoteKPI records.
| Field | Type | Description |
|---|---|---|
getById | QuoteKPIEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [QuoteKPIEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [QuoteKPIEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | QuoteKPIEntityConnection (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. |
QuoteOrderByNestedInput input 30 fields: id, isDeleted, modified, …
Sorting by a field of the related Quote 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 this quote. |
description | OrderByEnum | Free-form description of the quote. |
expirationDate | OrderByEnum | Date after which the quote is no longer considered valid. |
isArchived | OrderByEnum | True when the quote has been archived (lost). Archived quotes remain readable but are hidden from active lists and cannot be edited until reactivated. |
name | OrderByEnum | Name of the entity and its default text representation. |
opptyId | OrderByEnum | Id of the opportunity. |
ownerId | OrderByEnum | Id of the quote owner. |
productPriceListId | OrderByEnum | Id of the price list that supplies prices for product line items added to this quote, or empty to use catalog defaults. |
quickAccountEmail | OrderByEnum | Free-text company email captured at quote creation when no Account record has been linked yet. |
quickAccountName | OrderByEnum | Free-text company name captured at quote creation when no Account record has been linked yet. |
quickAccountPhone | OrderByEnum | Free-text company phone captured at quote creation when no Account record has been linked yet. |
quickContactName | OrderByEnum | Free-text contact name captured at quote creation when no Contact record has been linked yet. |
quickEmail | OrderByEnum | Free-text contact email captured at quote creation when no Contact record has been linked yet. |
quickPhone | OrderByEnum | Free-text contact phone captured at quote creation when no Contact record has been linked yet. |
quoteNumber | OrderByEnum | Auto-generated sequential identifier of the quote, used for human-readable reference. |
quoteTypeId | OrderByEnum | Id of the quote type that classifies this quote. |
reasonOfCloseDescription | OrderByEnum | Free-form note explaining why the quote was archived (lost). |
reasonOfCloseId | OrderByEnum | Id of the reason of close option selected when the quote 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 quote-process step. |
unitId | OrderByEnum | Id of the sales unit. |
version | OrderByEnum | Revision number of the quote, incremented when a new version of the same quote is created. |
revision | OrderByEnum | Revision when entity was lastly changed. |
totalAmount | OrderByEnum | Total monetary value of the quote in the team space base currency, with the foreign value and currency code preserved alongside. |
status | OrderByEnum | Current status of the quote (Open, Lost, Accepted). Read-only; derived from the current step and the archived flag. |
withCustom | CommonEntityRepositoryOrderByCustomField | Sorts by a custom field. |
QuoteProcessOrderByNestedInput input 7 fields: id, isDeleted, modified, …
Sorting by a field of the related QuoteProcess 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. |
color | OrderByEnum | Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. |
name | OrderByEnum | Name of the entity and its default text representation. |
revision | OrderByEnum | Revision when entity was lastly changed. |
QuoteProcessRepository object 5 fields: getById, getByIds, getAll, …
Read operations for QuoteProcess records.
| Field | Type | Description |
|---|---|---|
getById | QuoteProcessEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [QuoteProcessEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [QuoteProcessEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | QuoteProcessEntityConnection (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. |
QuoteRepository object 8 fields: getById, getByIds, getAll, …
Read operations for Quote records.
| Field | Type | Description |
|---|---|---|
getById | QuoteEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [QuoteEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [QuoteEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | QuoteEntityConnection (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 | QuoteEntityConnection (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 | QuoteEntity! (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. |
QuoteSharingClientRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for QuoteSharingClientRelation records.
| Field | Type | Description |
|---|---|---|
getById | QuoteSharingClientRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [QuoteSharingClientRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [QuoteSharingClientRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | QuoteSharingClientRelationEntityConnection (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. |
QuoteSharingSalesUnitRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for QuoteSharingSalesUnitRelation records.
| Field | Type | Description |
|---|---|---|
getById | QuoteSharingSalesUnitRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [QuoteSharingSalesUnitRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [QuoteSharingSalesUnitRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | QuoteSharingSalesUnitRelationEntityConnection (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. |
QuoteTypeOrderByNestedInput input 10 fields: id, isDeleted, modified, …
Sorting by a field of the related QuoteType 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. |
formLostEnabled | OrderByEnum | True when the lost form is required on archiving quotes of this type. |
isReadonly | OrderByEnum | True when the quote type is system-managed and cannot be edited or deleted by users. |
name | OrderByEnum | Name of the entity and its default text representation. |
quoteProcessId | OrderByEnum | Id of the quote process that quotes of this type follow. |
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. |
QuoteTypeRepository object 8 fields: getById, getByIds, getAll, …
Read operations for QuoteType records.
| Field | Type | Description |
|---|---|---|
getById | QuoteTypeEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [QuoteTypeEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [QuoteTypeEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | QuoteTypeEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getPublished | [QuoteTypeEntity!]! (5 args) | Returns the published records that match the filter, paged with limit and offset. |
getDrafts | [QuoteTypeEntity!]! (2 args) | Returns the records that match the filter, with pending unpublished changes applied where a draft exists. |
getDraftById | QuoteTypeEntity! (1 args) | Returns the record with the given id, with its pending unpublished changes applied when a draft exists. |
getByQuoteProcess | QuoteTypeEntity (1 args) | Returns the quote type that uses the given quote process, or null when none does. |