OBJECT

QuoteEntity

link GraphQL Schema definition

  • type QuoteEntity {
  • # Arguments
  • # apiNames: Api names of custom fields to retrieve. All are
  • # returned if not set.
  • customFields(apiNames: [String!]): JSONString!
  • # Deferred property. Will return data only if called via get_by_id. Otherwise null
  • # or empty array is used.
  • pendingScheduledActions: Int
  • # Tells if the entity instance is protected against delete (Entities that need to
  • # be present in the system at any time). Delete action still may fail if entity is
  • # deletable, due some other additional validations.
  • 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
  • # Currency exchange rate list used to convert monetary fields linked to this
  • # quote. Empty to inherit the team space default.
  • currencyExchangeRatesList: CurrencyExchangeRatesListEntity
  • # Opportunity this quote was prepared for. Empty for standalone quotes.
  • oppty: OpportunityEntity
  • # Sales user who owns this quote.
  • owner: ClientEntity
  • # Currency used for product line-item prices on this quote.
  • productCurrency: CurrencyEntity
  • # Product price list used to populate prices for product line items added to this
  • # quote. Empty to use catalog defaults.
  • productPriceList: ProductPriceListEntity
  • # Quote type that classifies this quote. Each type maps to one quote process and
  • # drives which form, fields and stages apply.
  • quoteType: QuoteTypeEntity
  • # Configurable reason recorded when the quote is archived (lost). Required when
  • # the lost form mandates it.
  • reasonOfClose: DataEntity
  • # Quote-process step the quote is currently sitting in. Reaching the last step in
  • # the process marks the quote as accepted.
  • step: StepEntity
  • # Sales unit this quote is assigned to. Determines which team members can see the
  • # record under unit-based sharing.
  • unit: SalesUnitEntity
  • # Id of the currency exchange rate list applied to this quote.
  • currencyExchangeRatesListId: ID
  • # Free-form description of the quote.
  • description: String
  • # Date after which the quote is no longer considered valid.
  • expirationDate: Date
  • # True when the quote has been archived (lost). Archived quotes remain readable
  • # but are hidden from active lists and cannot be edited until reactivated.
  • isArchived: Boolean
  • # Name of the entity and its default text representation.
  • name: String!
  • # Id of the opportunity.
  • opptyId: ID
  • # Id of the quote owner.
  • ownerId: ID!
  • # Id of the product currency.
  • productCurrencyId: ID
  • # Id of the product price list.
  • productPriceListId: ID
  • productSections: [ProductSection!]
  • # Free-text company email captured at quote creation when no Account record has
  • # been linked yet.
  • quickAccountEmail: String
  • # Free-text company name captured at quote creation when no Account record has
  • # been linked yet.
  • quickAccountName: String
  • # Free-text company phone captured at quote creation when no Account record has
  • # been linked yet.
  • quickAccountPhone: String
  • # Free-text contact name captured at quote creation when no Contact record has
  • # been linked yet.
  • quickContactName: String
  • # Free-text contact email captured at quote creation when no Contact record has
  • # been linked yet.
  • quickEmail: String
  • # Free-text contact phone captured at quote creation when no Contact record has
  • # been linked yet.
  • quickPhone: String
  • # Auto-generated sequential identifier of the quote, used for human-readable
  • # reference.
  • quoteNumber: String
  • # Id of the quote type.
  • quoteTypeId: ID
  • # Free-form note explaining why the quote was archived (lost).
  • reasonOfCloseDescription: String
  • # Id of the reason-of-close value.
  • reasonOfCloseId: ID
  • # Sharing model applied on top of the owner/unit visibility (e.g. shared with
  • # selected sales units or selected users). The matching sharing_units /
  • # sharing_clients lists control who is granted access.
  • shareMode: ShareModeEnum
  • # Id of the quote-process step.
  • stepId: ID!
  • # Id of the sales unit.
  • unitId: ID
  • # Revision number of the quote, incremented when a new version of the same quote
  • # is created.
  • version: Int
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Total monetary value of the quote in the team space base currency, with the
  • # foreign value and currency code preserved alongside.
  • totalAmount: CurrencyForeignField
  • # Product line items on this quote. Each entry holds the product, quantity, price
  • # and discount that contribute to total_amount.
  • #
  • # 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 quote. Set automatically from the contact relation
  • # marked as primary.
  • primaryContact: ContactEntity
  • # Primary account of this quote. Set automatically from the account relation
  • # marked as primary.
  • primaryAccount: AccountEntity
  • # Contacts linked to this quote.
  • #
  • # Arguments
  • # filter: Filter Contact relations by target Contact attributes.
  • # filterEdge: Filter QuoteContactRelation relations by edge
  • # (relation) QuoteContactRelation 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: QuoteContactRelationFilterInput,
  • orderBy: [ContactOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): QuoteContactRelationEntityConnection
  • # Accounts linked to this quote, including the primary-account flag.
  • #
  • # Arguments
  • # filter: Filter Account relations by target Account attributes.
  • # filterEdge: Filter QuoteAccountRelation relations by edge
  • # (relation) QuoteAccountRelation 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: QuoteAccountRelationFilterInput,
  • orderBy: [AccountOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): QuoteAccountRelationEntityConnection
  • # Documents linked to this quote.
  • #
  • # 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
  • # Sales units that have been granted shared access to this quote. Editable only
  • # when share_mode allows unit sharing.
  • #
  • # Arguments
  • # filter: Filter SalesUnit relations by target SalesUnit
  • # attributes.
  • # filterEdge: Filter QuoteSharingSalesUnitRelation relations by
  • # edge (relation) QuoteSharingSalesUnitRelation 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: QuoteSharingSalesUnitRelationFilterInput,
  • orderBy: [SalesUnitOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): QuoteSharingSalesUnitRelationEntityConnection
  • # Users that have been granted shared access to this quote. Editable only when
  • # share_mode allows user sharing.
  • #
  • # Arguments
  • # filter: Filter Client relations by target Client attributes.
  • # filterEdge: Filter QuoteSharingClientRelation relations by edge
  • # (relation) QuoteSharingClientRelation 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: QuoteSharingClientRelationFilterInput,
  • orderBy: [ClientOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): QuoteSharingClientRelationEntityConnection
  • # Current status of the quote (Open, Lost, Accepted). Read-only; derived from the
  • # current step and the archived flag.
  • status: QuoteStatusEnum!
  • # Display version of the quote name, used in lists and references.
  • formattedName: String!
  • # True when the current authenticated user has marked this quote as favorite.
  • # Per-user.
  • isFavorite: Boolean!
  • # If quote is set as active in opportunity.
  • isActiveInOpportunity: Boolean
  • # Deferred property. Will return data only if called via get_by_id. Otherwise null
  • # or empty array is used.
  • viewerIdsPerSalesUnit: [UUID!]!
  • # Timestamp of the most recent modification made by an end user (excluding system
  • # changes). Read-only; computed by Coevera.
  • modifiedByUser: DateTime
  • # Saved view profiles this quote 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
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • # Arguments
  • # entityType: [Not documented]
  • relatedEntitiesDrilldown(entityType: EntityNameEnum!): CompactViewDrilldownModel!
  • # Arguments
  • # ids: [Not documented]
  • charts(ids: [UUID!]!): [DashboardChartData!]
  • # Arguments
  • # id: [Not documented]
  • # seriesIndex: [Not documented]
  • # itemIndex: [Not documented]
  • chartsDrilldown(id: UUID!, seriesIndex: Int, itemIndex: Int): CompactViewDrilldownModel!
  • # Arguments
  • # ids: Null to load all fields defined on InterfacePreview entity
  • # first: [Not documented]
  • fields(ids: [UUID!], first: Int): [InterfaceFieldData]!
  • # Arguments
  • # projectObjectiveId: [Not documented]
  • projectObjectiveActivitiesDrilldown(
  • projectObjectiveId: UUID
  • ): CompactViewDrilldownModel!
  • # Arguments
  • # stepChecklistIds: [Not documented]
  • stepChecklists(stepChecklistIds: [UUID]): [StepChecklistActivityItem]!
  • approval: ApprovalEntity
  • }