OBJECT

OpptyProductRelationEntity

link GraphQL Schema definition

  • type OpptyProductRelationEntity {
  • # Arguments
  • # apiNames: Api names of custom fields to retrieve. All are
  • # returned if not set.
  • customFields(apiNames: [String!]): JSONString!
  • # 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 this line item, inherited from the
  • # parent opportunity or quote.
  • currencyExchangeRatesList: CurrencyExchangeRatesListEntity
  • # Online form field that produced this line item, or empty when not applicable.
  • onlineFormField: FieldEntity
  • # Online form this line item came from when the related opportunity was created
  • # through a form submission, or empty otherwise.
  • onlineForm: OnlineFormEntity
  • # Opportunity this line item belongs to. Set on create; mutually exclusive with
  • # quote.
  • oppty: OpportunityEntity
  • # Line-item type that drives the form layout for this product line. Resolved from
  • # the product type on create.
  • opptyProductRelationType: OpptyProductRelationTypeEntity
  • # Counterpart line item on the paired record (e.g. matching line on the active
  • # quote when this line is on the opportunity, or vice versa). Empty when there is
  • # no pairing.
  • pairedOpptyProductRelation: OpptyProductRelationEntity
  • # Product on this line item. Set on create; cannot be changed afterwards.
  • product: ProductEntity
  • # Quote this line item belongs to. Mutually exclusive with oppty.
  • quote: QuoteEntity
  • # Total amount of the line item (price * quantity, with discounts applied).
  • amount: Float
  • # Free-form note describing this line item.
  • comment: String
  • # Id of the currency exchange rate list.
  • currencyExchangeRatesListId: ID
  • # Id of the online form field.
  • onlineFormFieldId: ID
  • # Id of the online form.
  • onlineFormId: ID
  • # Id of the opportunity.
  • opptyId: ID
  • # Id of the line-item type.
  • opptyProductRelationTypeId: ID
  • # Id of the paired line item.
  • pairedOpptyProductRelationId: ID
  • # Per-unit price of the line item. Defaults to the product price from the price
  • # list when not supplied explicitly.
  • price: Float
  • # Id of the product.
  • productId: ID!
  • # Number of product units on this line item.
  • quantity: Float
  • # Id of the quote.
  • quoteId: ID
  • # Identifier of the product section this line belongs to (see the product_sections
  • # JSON layout on the parent opportunity or quote).
  • sectionId: ID
  • # Display order of the line item within its section. Maintained automatically when
  • # lines are added or moved.
  • sortOrder: Int
  • # Revision when entity was lastly changed.
  • revision: Int
  • revenueSchedule: OpptyProductRelationRevenueScheduleEntity
  • # Absolute monetary discount applied to this line item versus the price-list
  • # price. Read-only; computed by Coevera.
  • discountValue: Float
  • # Percentage discount applied to this line item versus the price-list price.
  • # Read-only; computed by Coevera.
  • discountPercentage: Float
  • # Timestamp of the most recent modification made by an end user (excluding system
  • # changes). Read-only; computed by Coevera.
  • modifiedByUser: DateTime
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }