Nue Knowledge Center

Nue Docs navigation

search
clear
/

Nue Object Model - Price Builder

Nue Price Builde offers a range of powerful capabilities to simplify the process of creating products, setting prices, bundling products, and implementing complex pricing strategies. With its intuitive user interface, Rev Ops users can effortlessly navigate through the platform, leveraging its user-friendly features to generate innovative and customized products and pricing structures.

 

One of the standout features of Nue Price Builder is its seamless integration with the Salesforce platform, enabling sales representatives to access and utilize the created products and pricing information in real time. This integration ensures that sales reps can promptly create quotes and orders, streamlining the sales process and enhancing overall efficiency. 

 

This article outlines the object model of Nue Price Builder.  All objects in Nue Price Builder have their mirrored objects in Salesforce. The products and pricing data created in Nue Price Builder are saved directly in Salesforce, if the Nue instance is connected with a Salesforce org.  

 


Object Model Overview

The following diagrams outlines the objects and relationships of all objects in Nue Price Builder.

 

As illustrated in this diagram, unlike introducing a brand new set of products and pricing objects, Nue Price Builder extends the functionality of the familiar Products and Price Book/Price Book Entry objects. This approach brings a "back to the basics" experience for users who are already well-acquainted with Salesforce's standard objects. By leveraging the existing infrastructure, Nue Price Builder allows users to quickly adapt to the system and take advantage of its capabilities without a steep learning curve. This familiarity not only saves time and effort but also ensures a smooth transition, making it easier for users to navigate, create, and manage their products and pricing structures within the Salesforce ecosystem. With Nue Price Builder, users can confidently return to the fundamentals they are comfortable with while enjoying the added benefits of an intuitive and enhanced pricing solution.

Price Builder Objects

Product

API NAMEProduct
DESCRIPTIONDefines a product or service that is manufactured or provisioned for sale.
SALESFORCE API NAMEProduct2

Fields

The following table outlines all fields of the Product object.  
LABELNUE API NAMESALESFORCE API NAMETYPEDESCRIPTION
Auto RenewautoRenewRuby__AutoRenew__cBooleanIndicates if the product is auto-renewed by default.
Billing PeriodbillingPeriodRuby__BillingPeriod__cPickListDetermines how often the product will be billed. If not selected, the billing period will default to to the Billing Period value set at the system level, or account level.
Billing TimingbillingTimingRuby__BillingTiming__cPickList

Determines whether customers are billed for the products or services before or after they are provided or consumed. 

 

Available values are: In Advance, In Arrears

Bundle TemplatebundleTemplateRuby__BundleTemplate__cPickList

The bundle template used for this product.  

 

Available values are: Advanced, Basic, Dynamic Options.  

 

Currently all bundles are built using Advanced bundle template.

ConfigurableconfigurableRuby__Configurable__cBooleanDetermines if the product is configurable, i.e., if this product is a bundle product.  
CostCost__cCost__cCurrencyThe cost of the product.
Created BycreatedByIdCreatedByIdLookup (UserProfile)The created-by user.
Created DatecreatedDateCreatedDateDate TimeThe created date.  
Credit Conversion IdcreditConversionIdRuby__CreditConversionId__cLookup (CreditConversion)References the credit conversion object, which stores the conversion between a UOM Quantity Dimension (e.g., ‘1K API Calls’) and a Credit. 
Default Renewal TermdefaultRenewalTermRuby__DefaultRenewalTerm__cDecimalThe default renewal term in the term dimension of the default UOM, e.g. 12 Month, 1 Year. 
Default Subscription TermdefaultSubscriptionTermRuby__DefaultSubscriptionTerm__cIntegerThe default subscription term in the term dimension of the default UOM, e.g. 12 Month, 1 Year. 
Default UOM IddefaultUomIdRuby__DefaultUom__cLookup (UOM)References the default UOM object.
DescriptiondescriptionDescriptionLong TextThe descriptin of the product.
End DateendDateRuby__EndDate__cDateThe effective end date of the product. 
Free Trial TypefreeTrialTypeRuby__FreeTrialType__cPickListFree Trial Type in Days, Months, or Years. 
Free Trial UnitfreeTrialUnitRuby__FreeTrialUnit__cIntegerThe length of the free trial.  
IdidIdIDThe record ID. 
Image UrlimageUrlRuby__ImageSignedUrl__cLong TextThe URL of the product image. 
Last Modified BylastModifiedByIdLastModifiedByIdLookup (UserProfile)The last modified by user.
Last Modified DatelastModifiedDateLastModifiedDateDate TimeThe last modified date.
Last Published BylastPublishedByIdRuby__LastPublishedBy__cLookup (UserProfile)The last published by user. 
Last Published DatelastPublishedDateRuby__LastPublishedDate__cDateThe last published date.
Long DescriptionlongDescriptionRuby__LongDescription__cRichTextThe long description of the product.
NamenameNameText (200)The product name. 
Price Book IdpriceBookIdRuby__PriceBook__cLookup (PriceBook)The price book reference.
Product CategoryproductCategoryFamilyPickList

The product category.  

 

Available values include: 

  • Recurring Services
  • Physical Goods
  • Professional Services
  • Customer Support

In Nue, the Revenue Model, UOM, and Tax Code can be defaulted from the product category of a product.

Publish StatuspublishStatusRuby__PublishStatus__cPickList

Indicates the Publish Status of the product for self-service listing of the products.  

 

Available values include: 

  • Publised
  • Unpublished
  • Outdated
Record TyperecordTypeRuby__ProductRecordType__cPickList

The record type of the product.  

 

Available values include:

  • Product
  • Bundle
  • MultiAttributes
Reference Product IdreferenceProductIdRuby__ReferenceProduct__cLookup (Product)

The reference product of a bundle.  In Nue, a bundle product can be created from an existing bundle product.  If a bundle product references another bundle product, it inherits all the product options of the referencing product.  

 

For example, an "Enterprise Edition" bundle may reference a "Professional Edition" bundle so that it inherits all the product options from the "Professional Edition" bundle.

Revenue ModelpriceModelRuby__PriceModel__cPickList

The revenue model of the product.

 

Available values include: 

  • One Time
  • Recurring
  • Credit Burndown
  • Credit
  • Overage Usage

The revenue model value can be defaulted from the product category selection.

Revenue Rule External IdrevenueRuleExternalIdRuby__RevenueRuleExternalId__cText (200)The ID of the revenue rule associated with thid product.
Show Bundled ProductsshowIncludedProductOptionsRuby__ShowIncludedProductOptions__cBooleanDetermines if the bundled product options will be displayed when creating a quote or an order.
SkuskuStockKeepingUnitText (200)The Stock Keeping Unit.  SKUs must be unique across all products in the product catelog.
Sold IndependentlysoldIndependentlyRuby__SoldIndependently__cBooleanDetermines if the product can be sold independently. Only products that can be sold independently can be added to a quote or an order.
Start DatestartDateRuby__StartDate__cDateThe effective start date of the product.
StatusstatusRuby__Status__cPickList

The status of the product. 

 

Available values include: 

  • Active
  • Inactive
  • Draft
Tax CodetaxCodeRuby__TaxCode__cText (200)The tax code of the product.
Tax ModetaxModeRuby__TaxMode__cPickList

The tax mode of the product.

 

Available values include: 

  • Tax Inclusive
  • Tax Exclusive

Eligible to Include in Carves Allocation

carvesEligible

Ruby__CarvesEligible__c

Boolean

Determines if the product is eligible to include in carves allocation or not. Valid values are True / False .

Contract Liability Segment

contractLiabilitySegment

Ruby__ContractLiabilitySegment__c

Text(80)

Accounting code of the contract liability segment.

Contract Revenue Segment

contractRevenueSegment

Ruby__ContractRevenueSegment__c

Text(80)

Accounting code of the contract revenue segment.

Carves Liability Segment

carvesLiabilitySegment

Ruby__CarvesLiabilitySegment__c

Text(80)

Accounting code of the carves liability segment.

Carves Revenue Segment

carvesRevenueSegment

Ruby__CarvesRevenueSegment__c

Text(80)

Accounting code of the carves revenue segment.

Unit of Measure

API NAMEUOM
DESCRIPTIONRepresents a definite magnitude of a quantity.
SALESFORCE API NAMERuby__UOM__c

Fields

The following table outlines all fields of the Unit of Measure object.  
LABELNAMESALESFORCE API NAMETYPEDESCRIPTION
ActiveactiveRuby__Active__cBooleanIndicates if the UOM is active.
Created BycreatedByIdCreatedByIdLookup (UserProfile)The created-by user.
Created DatecreatedDateCreatedDateDate TimeThe created date.
Decimal ScaledecimalScaleRuby__DecimalScale__cIntegerThe decimal scale of the UOM.
IdidIdIDThe record ID.
Last Modified BylastModifiedByIdLastModifiedByIdLookup (UserProfile)The last modified user.
Last Modified DatelastModifiedDateLastModifiedDateDate TimeThe last modified date.
NamenameNameText (200)The unique name of the UOM.
Quantity DimensionquantityDimensionRuby__QuantityDimension__cText (200)

ndicates the default quantity part in the UOM.  

 

Defaults to be the part parsed before ‘/’ character; otherwise, otherwise, default to the UOM name itself.

Rounding ModeroundingModeRuby__RoundingMode__cPickList

Specifies whether to round the UOM value up or down when the value exceeds the DecimalPlaces field value.

 

The default value is Up. 

Term DimensiontermDimensionRuby__TermDimension__cText (200)

Indicates the default term part in the UOM.

 

Defaults to the part parsed after ‘/’ character. 

Credit Conversion

API NAMECreditConversion
DESCRIPTIONCredit Conversion stores the conversion between a UOM Quantity Dimension (e.g., ‘1K API Calls’) and a Credit. For example, 1 Credit can be used to consume resource like 1K API Calls, 60 Computing Minutes, 100G Database Storage, etc.
SALESFORCE API NAMERuby__CreditConversion__c

Fields

The following table outlines all fields of the Credit Conversion object.  
LABELNAMESALESFORCE API NAMETYPEDESCRIPTION
Conversion RateconversionRateRuby__ConversionRate__cDecimalIndicates the Conversion Rate. 
Created BycreatedByIdCreatedByIdLookup (UserProfile)The created-by user.
Created DatecreatedDateCreatedDateDate TimeThe created date.
Credit QuantitycreditQuantityRuby__CreditQuantity__cDecimalThe quantity of the credits in the conversion. 
Credit Type IdcreditTypeIdRuby__CreditTypeExternalId__cIdThe credit type ID in Nue.
Decimal ScaledecimalScaleRuby__DecimalScale__cIntegerThe decimal scale. 
IdidIDIDThe record ID.
Last Modified BylastModifiedByIdLastModifiedByIdLookup (UserProfile)The last modified user.
Last Modified DatelastModifiedDateLastModifiedDateDate TimeThe last modified date.
NamenameNameTextThe name of the credit conversion.
Rounding ModeroundingModeRuby__RoundingMode__cPickList

The rounding mode.  

 

Available values include: Up, Down.

UOM QuantityuomQuantityRuby__UomQuantity__cDecimalThe UOM quantity in the conversion.
UOM Quantity DimensionuomQuantityDimensionRuby__UomQuantityDimension__cTextThe UOM quantity dimension.

Product Option

API NAME
ProductOption
 
DESCRIPTION
Defines the product optionality of a (child) product in a bundle product.
 

SALESFORCE API NAME

Ruby__ProductOption__c

Fields

The following table outlines all fields of the Product Option object.  
LABELNAMESALESFORCE API NAMETYPEDESCRIPTION
BundledbundledRuby__Bundled__cBoolean

Indicates this product option is bundled with the parent product.  If True, then the child product’s actual selling price is 0.

 

Note that when Bundled is checked, then Required must be checked; but when Bundled is not checked, Required may be checked to indicate a product option that is not bundled with the parent product price-wise, but must be required to be configured.  

Configured Product IdconfiguredProductIdRuby__ConfiguredProduct__cBMasterDetailReferences the configured product. (i.e.,Parent Product).
Created BycreatedByIdCreatedByIdLookup (UserProfile)The created by user.
Created DatecreatedDateCreatedDateDate TimeThe created date.
Default QuantitydefaultQuantityRuby__DefaultQuantity__cDecimalThe default quantity of the product option.
DescriptiondescriptionRuby__Description__cLong TextThe product option description.
IdidIdIDThe record ID.
Included QuantityincludedQuantityRuby__IncludedQuantity__cDecimal

Quantities that are included for this product option. 

 

For example, product ‘Number of API Calls’ can have Included Quantity as 1000 to indicate that when this product option is configured into the parent product, 1000 API calls are automatically included.

Independent PricingindependentPricingRuby__IndependentPricing__cBoolean

Indicates if this product option will be independently priced by the product option quantity, instead of the total quantity of the chidlren products.  

 

The use case for ‘Independent Pricing’ is almost always with usage. For example:

 

In a VROOM bundle of ‘Webinar’, the first 60 minutes for each user license is free. For additional minutes, it is 0.10 / Minute.

 

If a user subscribes to 100 Webinar bundles:

1. If ‘Independent Pricing = true’ for the ‘Service Usage’ product option, then every user license will have 60 minutes for free. So if I subscribe to 10 users, I’ll have 600 minutes free.

2. If ‘Independent Pricing = false’ for the ‘Service Usage’ product option, then regardless how many total minutes I subscribe, the user only has 60 minutes for free.

Last Modified BylastModifiedByIdLastModifiedByIdLookup (UserProfile)The last modified by user. 
Last Modified DatelastModifiedDateLastModifiedDateDate TimeThe last modified date.
Maximum QuantitymaxQuantityRuby__MaxQuantity__cDecimalThe maximum quantity that can be selected for this option.
Minimum QuantityminQuantityRuby__MinQuantity__cDecimalThe mininum quantity that must be selected for this option.
NamenameNameAutoNumberThe product option number.
Option NameoptionNameRuby__OptionName__cTextThe name of the product option.  By default it is the product name, but it can be changed by the end user.
Option OrderoptionOrderRuby__OptionOrder__cIntegerThe product option serial number, e.g., 10, 20, 30... , which determines the order of the product options under a product or a feature.  
Option Product IdoptionProductIdRuby__OptionProduct__cLookup (Product)References the option product (i.e., Child Product)
Option TypeoptionTypeRuby__OptionType__cPickList

The type of the product option. 

 

Available values are: 

LInk to Bundle Quantity

When a product option type is ‘LinkToBundleQuantity’, its quantity always changes with the quantity of the parent product at runtime

 

Related Product

When a product option type is ‘Related Product’, its quantity is independent from that of the parent product at operational time.

PriceBookEntry IdpriceBookEntryIdRuby__PriceBookEntryId__cLookup (PriceBookEntry) 
Product Feature IdproductFeatureIdRuby__ProductFeature__cLookup (ProductFeature)References a product feature, if this product option can be grouped into a product feature.
Quantity EditablequantityEditableRuby__QuantityEditable__cBooleanIndicates if the quantity of the product option can be editable at operational time.
RecommendedrecommendedRuby__Recommended__cBooleanIndicates if this product option is by default recommended to be configured for the parent product.
RequiredrequiredRuby__Required__cBooleanIndicates if this product option is required to be selected in the bundle.

Product Group (a.k.a. Feature)

API NAMEFeature
DESCRIPTIONDefines a set of product functionalities.  A feature can be associated with multiple products, while a product may contain multiple features.
SALESFORCE API NAMERuby__Feature__c

Fields

The following table outlines all fields of the Product Group (Feature) object.  
LABELNAMESALESFORCE API NAMETYPEDESCRIPTION
Created BycreatedByIdCreatedByIdLookup (UserProfile)The created-by user.
Created DatecreatedDateCreatedDateDate TimeThe created date.
DescriptiondescriptionRuby__Description__cLong TextThe feature description.
IdidIdIDThe record ID.
Image UrlimageUrlRuby__ImageSignedUrl__cLong TextThe feature's image URL.
Last Modified BylastModifiedByIdLastModifiedByIdLookup (UserProfile)The last modified by.
Last Modified DatelastModifiedDateLastModifiedDateDate TimeThe last modified date.
NamenameNameText (255)The feature name
StatusstatusRuby__Status__cPickList

The active status of the feature.  Available values include: 

  • Draft

  • Active

  • Inactive

Product Feature

API NAMEProductFeature
DESCRIPTIONA product feature defines the relationship between a product and a feature.  A product can have one or more features.  
SALESFORCE API NAMERuby__ProductFeature__c

Fields

The following table outlines all fields of the BundleSuite object.  
LABELNAMESALESFORCE API NAMETYPEDESCRIPTION
Configured Product IdconfiguredProductIdRuby__ConfiguredProduct__cBMasterDetail 
Created BycreatedByIdCreatedByIdLookup (UserProfile)The created-by user.
Created DatecreatedDateCreatedDateDate TimeThe created date.
Feature DescriptionfeatureDescriptionRuby__FeatureDescription__cLong TextThe product feature description.
Feature IdfeatureIdRuby__Feature__cLookup (Feature)References the feature (or Product Group) object.
Feature NamefeatureNameRuby__FeatureName__cTextThe product feature name.
Feature OrderfeatureOrderRuby__FeatureOrder__cIntegerThe order of the product feature when displayed in a product.
IdidIdIDThe record ID.
Last Modified BylastModifiedByIdLastModifiedByIdLookup(UserProfile)The last modified user.
Last Modified DatelastModifiedDateLastModifiedDateDate TimeThe last modified date.
Maximum OptionsmaxOptionsRuby__MaxOptions__cIntegerThe minimum number of product options that must be selected for this product feature at operational time.
Minimum OptionsminOptionsRuby__MinOptions__cIntegerThe maximum number of product options that can be selected for this product feature at operational time.
NamenameNameAutoNumberThe product feature name.

Bundle Suite

API NAMEBundleSuite
DESCRIPTION
Represents a list of active bundle products, ranging from bundles with basic product offering to bundles with more advanced product offerings.
SALESFORCE API NAMERuby__BundleSuite__c

Fields

The following table outlines all fields of the Bundle Suite object.  
LABELNAMESALESFORCE API NAMETYPEDESCRIPTION
Created BycreatedByIdCreatedByIdLookup (UserProfile)The created-by user.
Created DatecreatedDateCreatedDateDate TimeThe created date.
End DateendDateRuby__EndDate__cDateThe bundle suite’s active end date.
IdidIdIDThe record ID.
Last Modified BylastModifiedByIdLastModifiedByIdLookup (UserProfile)The last modified user.
Last Modified DatelastModifiedDateLastModifiedDateDate TimeThe last modified date.
Last Published BylastPublishedByIdRuby__LastPublishedBy__cLookup (UserProfile)The last published by user.
Last Published DatelastPublishedDateRuby__LastPublishedDate__cDateThe last published date.
NamenameNameText (255)The auto-numbered unique ID of the bundle suite.
Price Book IdpriceBookIdRuby__PriceBook__cLookup (PriceBook) 
Publish StatuspublishStatusRuby__PublishStatus__cPickList 
Start DatestartDateRuby__StartDate__cDateThe bundle suite’s active start date.
StatusstatusRuby__Status__cPickList

The bundle suite status.  Available values are: 

  • Design

  • Active

  • Expired

UOM IduomIdRuby__Uom__cLookup (UOM) 

Bundle Suite Bundle

API NAMEBundleSuiteBundle
DESCRIPTIONDefines the relationship between a bundle suite and a bundle product.
SALESFORCE API NAMERuby__BundleSuiteBundle__c

Fields

The following table outlines all fields of the Bundle Suite Bundle object.  
LABELNAMESALESFORCE API NAMETYPEDESCRIPTION
Bundle IdbundleIdRuby__Bundle__cBMasterDetailReferences the bundle product included in this bundle suite. 
Bundle Suite IdbundleSuiteIdRuby__BundleSuite__cBMasterDetailReferences the bundle suite.
Created BycreatedByIdCreatedByIdLookup (UserProfile)The created-by user.
Created DatecreatedDateCreatedDateDate TimeThe created date.
IdidIdIDThe record ID.
Last Modified BylastModifiedByIdLastModifiedByIdLookup (UserProfile)The last modified user.
Last Modified DatelastModifiedDateLastModifiedDateDate TimeThe last modified date.
NamenameNameTextThe name of the bundle in the bundle suite.
PopularpopularRuby__Popular__cBooleanIndicates if this bundle is the most popular in the bundle suite.
Sort OrdersortOrderRuby__SortOrder__cIntegerThe sort order of the bundle displayed in the bundle suite.

Price Book

API NAMEPriceBook
DESCRIPTIONRepresents a list of sellable products and their prices.
SALESFORCE API NAMEPricebook2

Fields

The following table outlines all fields of the Price Book object.  
LABELNAMESALESFORCE API NAMETYPEDESCRIPTION
ActiveactiveIsActiveBooleanIIndicates whether the price book is active (true) or not (false). Inactive price books are hidden in many areas in the user interface. You can change this field’s value as often as necessary. Label is Active.
ArchivedarchivedRuby__Archived__cBooleanIndicates whether the price book has been archived (true) or not (false). This field is read only.
Created BycreatedByIdCreatedByIdLookup (UserProfile)The created by user.
Created DatecreatedDateCreatedDateDate TimeThe created date.
DescriptiondescriptionDescriptionLong TextThe description.
IdidIdIDThe record ID.
IsSelfServiceEnabledisSelfServiceEnabledRuby__IsSelfServiceEnabled__cBooleanIndicates if the price book is available for self-service access.
Last Modified BylastModifiedByIdLastModifiedByIdLookup (UserProfile)The last modified user.
Last Modified DatelastModifiedDateLastModifiedDateDate TimeThe last modified date.
NamenameNameText (200)The price book name.
Pricing AttributespriceAttributesRuby__PriceAttributes__cMultiPickListA list of pricing attributes.  Nue provides up to 10 placeholders for pricing attributes to support multi-attribute pricing capability.
StandardstandardIsStandardBooleanIndicates whether the price book is the standard price book for the org (true) or not (false). Every Nue isntance has one and only one standard price book—all other price books are custom price books.

Price Book Entry

API NAMEPriceBookEntry
DESCRIPTIONRepresents a sellable product with its price listed in a price book.
SALESFORCE API NAMEPriceBookEntry

The price book entry object is central to the Multi-attribute Pricing capability.  Please reference Multi-Attribute Pricing for more information.  

Fields

The following table outlines all fields of the Price Book Entry object.  
LABELNAMESALESFORCE API NAMETYPEDESCRIPTION
ActiveactiveIsActiveBoolean

Indicates whether the price book entry is active (true) or not (false).

Although you can’t delete price book entry records, you can set this field to false. Inactive price book entry records are hidden in many areas in the user interface. You can change this value on a price book entry record as often as necessary.

Billing TimingbillingTimingRuby__BillingTiming__cPickListIndicates the billing timing of the price book entry.  If not null, it overrides the biling timing value at the product level or system level.
Created BycreatedByIdCreatedByIdLookup (UserProfile)The created by user.
Created DatecreatedDateCreatedDateDate TimeThe created date.
Custom Pricing Attribute 1pricingAttribute_1Ruby__PricingAttribute_1__cTextThe place holder #1 of custom pricing attribute.  
Custom Pricing Attribute 10pricingAttribute_10Ruby__PricingAttribute_10__cTextThe place holder #10 of custom pricing attribute.  
Custom Pricing Attribute 2pricingAttribute_2Ruby__PricingAttribute_2__cTextThe place holder #2 of custom pricing attribute.  
Custom Pricing Attribute 3pricingAttribute_3Ruby__PricingAttribute_3__cTextThe place holder #3 of custom pricing attribute.  
Custom Pricing Attribute 4pricingAttribute_4Ruby__PricingAttribute_4__cTextThe place holder #4 of custom pricing attribute.  
Custom Pricing Attribute 5pricingAttribute_5Ruby__PricingAttribute_5__cTextThe place holder #5 of custom pricing attribute.  
Custom Pricing Attribute 6pricingAttribute_6Ruby__PricingAttribute_6__cTextThe place holder #6 of custom pricing attribute.  
Custom Pricing Attribute 7pricingAttribute_7Ruby__PricingAttribute_7__cTextThe place holder #7 of custom pricing attribute.  
Custom Pricing Attribute 8pricingAttribute_8Ruby__PricingAttribute_8__cTextThe place holder #8 of custom pricing attribute.  
Custom Pricing Attribute 9pricingAttribute_9Ruby__PricingAttribute_9__cTextThe place holder #9 of custom pricing attribute.  
IdidIdIDThe record ID.
Last Modified BylastModifiedByIdLastModifiedByIdLookup (UserProfile)The last modified user.
Last Modified DatelastModifiedDateLastModifiedDateDate TimeThe last modified date.
List PricelistPriceUnitPriceCurrencyThe unit price for the price book entry. You can specify a value only if UseStandardPrice is set to false.
NamenameRuby__Name__cAutoNumberThe auto-numbered name of the price book entry.
Price Book IdpriceBookIdPricebook2IdBMasterDetailReferences the price book.
Product IdproductIdRuby__RealProduct__cBMasterDetailReferences the product.  If there exists multi-attribute (record-type) products, this field references the actual product record.  
RecommendedrecommendedRuby__Recommended__cBooleanIndicates if this is the recommended price of the product.
UOM IduomIdRuby__Uom__cLookup (UOM)References the UOM.
Use Standard PriceuseStandardPriceUseStandardPriceBoolean

Indicates whether the price book entry uses the standard price defined in the standard price book record (true) or not (false).

If set to true, the List Price field is read only, and the value is the same as the list price value in the corresponding price book entry in the standard price book.

 

Price Tag

API NAMEPriceDimension
DESCRIPTIONDefines a tiered pricing or discounting scheme, which can be a quantity-based tiering, or term-based tiering.
SALESFORCE API NAMERuby__PriceDimension__c

Fields

The following table outlines all fields of the Price Tag object.  
LABELNAMESALESFORCE API NAMETYPEDESCRIPTION
ActiveactiveRuby__Active__cBooleanIndicates if this price tag is active. 
CodecodeRuby__Code__cTextPromotion or Coupon Code. 
Created BycreatedByIdCreatedByIdLookup (UserProfile)The created by user.
Created DatecreatedDateCreatedDateDate TimeThe created date.
DescriptiondescriptionRuby__Description__cLong TextThe price tag description.
End TimeendTimeRuby__EndTime__cDate TimeThe effective end time of the price tag.
IdidIdIDThe record ID
Last Modified BylastModifiedByIdLastModifiedByIdLookup (UserProfile)The last modified user.
Last Modified DatelastModifiedDateLastModifiedDateDate TimeThe last modified date.
NamenameNameTextThe name of the price tag.  
Object IdobjectIdRuby__ObjectId__cText

The object ID that this price tag is associated with.

 

If the value is null, the price tag is applicable for any objects.  Otherwise it is only available for the specific object.

Object typeobjectTypeRuby__ObjectType__cText

The object type that this price tag is associated with.

 

If the value is null, the price tag is applicable for any objects.  Otherwise it is only available for the specified object type.

 

Available values include: Product Option, Quote Line Item, Order Product, etc.

Price Book IdpriceBookIdRuby__PriceBook__cLookup (PriceBook)References the price book.  
Price ModelpriceTypeRuby__PriceType__cPickList

Defines the pricing model of the price tag.  

 

Available values include: 

  • Volume
  • Tiered
  • Ramp
Price Tag TyperecordTypeRuby__RecordType__cPickList

Defines the type of the price tag.  

 

Available values include

  • Discount Tag (DiscountDimension)
  • Price Tag (PriceDimension)
Start TimestartTimeRuby__StartTime__cDate TimeThe effective start time of the price tag.  
UOM DimensionuomDimensionRuby__UomDimension__cText

Defines the actual Quantity or Term dimension value, for example, Each or Month.

UOM Dimension TypepriceDimensionTypeRuby__PriceDimensionType__cPickList

Defines the price tag of the price tiers.  Available values are: 

  • Quantity
  • Term
UOM IduomIdRuby__Uom__cLookup (UOM)References the UOM record.

Price Tier

API NAMEPriceTier
DESCRIPTIONDefines a price tier or discount tier, which can be either a Flat Fee tier, or a Per Unit tier.
SALESFORCE API NAMERuby__PriceTier__c

Fields

The following table outlines all fields of the Price Tier object.  
LABELNAMESALESFORCE API NAMETYPEDESCRIPTION
AmountamountRuby__Amount__cDecimalThe dollar value of this price tier.
Charge ModelchargeModelRuby__ChargeModel__cPickList

he charge model applicable to this tier.  Available values are: 

  • Per Unit

  • Flat Fee

Created BycreatedByIdCreatedByIdLookup (UserProfile)The created by user.
Created DatecreatedDateCreatedDateDate TimeThe created date.
Discount PercentagediscountPercentageRuby__DiscountPercentage__cPercentThe discount percentage of this price tier.  Only applicable to price tags.  A price tier cannot have both Amount and Discount Percentage. Amount takes precedence.
End UnitendUnitRuby__EndUnit__cDecimalThe ending unit of the tier.
IdidIdIDThe record ID.
Last Modified BylastModifiedByIdLastModifiedByIdLookup (UserProfile)The last modified user.
Last Modified DatelastModifiedDateLastModifiedDateDate TimeThe last modified date.
NamenameNameAutoNumberThe auto-numbered ID of the price tier.
Price Tag IdpriceDimensionIdRuby__PriceDimension__cBMasterDetailReferences to the price tag.  Price tag and price tiers have master/detail relationships.
Start UnitstartUnitRuby__StartUnit__cDecimalThe starting unit of the tier.
Tier NumbertierNumberRuby__TierNumber__cIntegerThe tier number used to sort the price tiers in a price tag.

Product Price Tag

API NAMEProductPriceDimension
DESCRIPTIONRepresents a price tag's association with a product's price book entry.  
SALESFORCE API NAMERuby__ProductPriceDimension__c

Fields

The following table outlines all fields of the object.  
LABELNAMESALESFORCE API NAMETYPEDESCRIPTION
ActiveactiveRuby__Active__cBooleanIndicates if the product price tag is active.
Created BycreatedByIdCreatedByIdLookup (UserProfile)The created by user.
Created DatecreatedDateCreatedDateDate TimeThe created date.
IdidIdIDThe record ID.
Last Modified BylastModifiedByIdLastModifiedByIdLookup (UserProfile)The last modified user.
Last Modified DatelastModifiedDateLastModifiedDateDate TimeThe last modified date.
NamenameNameAutoNumberThe auto-numbered name.
Price Book Entry IdpriceBookEntryIdRuby__PriceBookEntryId__cBMasterDetailReferences the price book entry. 
Price Tag IdpriceDimensionIdRuby__PriceDimension__cBMasterDetailReferences the price tag.  
Product IdproductIdRuby__Product__cLookup (Product)References the product.
Serial NumberserialNumberRuby__SerialNumber__cIntegerThe serial number of the product price tag.  If there are more than one price tags available for a product's price book entry, the pricing engine applies the price tags associated to a product's price book entry in the order of the serial number.  

Product Option Price Tag

API NAMEProductOptionPriceDimension
DESCRIPTIONRuby__ProductOptionPriceDimension__c
SALESFORCE API NAMERepresents a price tag's association with a product option in a bundle product.

Fields

The following table outlines all fields of the object.  
LABELNAMESALESFORCE API NAMETYPEDESCRIPTION
ActiveactiveRuby__Active__cBooleanIndicates the active status. 
Created BycreatedByIdCreatedByIdLookup (UserProfile)The created by user.
Created DatecreatedDateCreatedDateDate TimeThe created date.
IdidIdIDThe record ID.
Last Modified BylastModifiedByIdLastModifiedByIdLookup (UserProfile)The last modified user.
Last Modified DatelastModifiedDateLastModifiedDateDate TimeThe last modified date.
NamenameNameAutoNumberThe auto-numbered name. 
Price Tag IdpriceDimensionIdRuby__PriceDimension__cBMasterDetailReferences the price tag. 
Product Option IdproductOptionIdRuby__ProductOption__cBMasterDetailReferences the product option.
Serial NumberserialNumberRuby__SerialNumber__cIntegerThe serial number of the referenced product option for the price tag.  If there are more than one price tags available for a product option, the pricing engine applies the price tags associated to a product option in the order of the serial number.  

Feature Price Tag

API NAMEFeaturePriceDimension
DESCRIPTIONRepresents a price tag's association with a product group or feature.
SALESFORCE API NAMERuby__FeaturePriceDimension__c

Fields

The following table outlines all fields of the object.  
LABELNAMESALESFORCE API NAMETYPEDESCRIPTION
ActiveactiveRuby__Active__cBooleanIndicates the active status. 
Created BycreatedByIdCreatedByIdLookup (UserProfile)The created by user.
Created DatecreatedDateCreatedDateDate TimeThe created date.
IdidIdIDThe record ID.
Last Modified BylastModifiedByIdLastModifiedByIdLookup (UserProfile)The last modified user.
Last Modified DatelastModifiedDateLastModifiedDateDate TimeThe last modified date.
NamenameNameAutoNumberThe auto-numbered name. 
Feature IDfeatureIdRuby__Feature__cBMasterDetailReferences the product group (or feature).
Price Tag IDpriceDimensionIdRuby__PriceDimension__cBMasterDetailReferences the price tag.
Serial NumberserialNumberRuby__SerialNumber__cIntegerThe serial number of the referenced feature for the price tag.  If there are more than one price tags available for a feature, the pricing engine applies the price tags associated to a product group (or feature) in the order of the serial number.