OBJECT

ProductPriceListEntity

Price list with product prices per currency, applied to opportunities and quotes while it is active.

link GraphQL Schema definition

  • type ProductPriceListEntity {
  • # 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
  • # Free-form description of the price list.
  • description: String
  • # Date when the price list expires. Empty means open-ended.
  • endDate: Date
  • # Master switch for the price list. Inactive price lists are not applied to
  • # opportunities or quotes regardless of dates.
  • isActive: Boolean
  • # Name of the entity and its default text representation.
  • name: String!
  • # Conditions that determine which opportunities or quotes the price list applies
  • # to (for example by sales unit, account or custom field).
  • rules: FieldFilter
  • # Date when the price list becomes active. Empty means immediately.
  • startDate: Date
  • # Kind of price list: a regular price list (Standard), or a price schedule with
  • # special prices that take precedence over standard price lists while active
  • # (Scheduled).
  • type: ProductPriceListTypeEnum
  • # Revision when entity was lastly changed.
  • revision: Int
  • # True for the team space default price list, which cannot be deleted. Read-only.
  • isDefault: Boolean!
  • # Effective status of the price list (Active, Inactive, Scheduled, Expired).
  • # Read-only; derived from isActive and the start/end dates.
  • status: ProductPriceListStatusEnum!
  • # Per-product, per-currency prices configured in the price list.
  • #
  • # Arguments
  • # filter: Filter Product relations by target Product attributes.
  • # filterEdge: Filter ProductPriceListPrice relations by edge
  • # (relation) ProductPriceListPrice 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.
  • productPriceListPrices(
  • filter: ProductFilterInput,
  • filterEdge: ProductPriceListPriceFilterInput,
  • orderBy: [ProductOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ProductPriceListPriceEntityConnection
  • # 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!]!
  • }