Product Offering Price Resource Mappings
Before using the TMF620 product offering price resource mappings, refer the following.
- The GlobalKey__c is sent as the
id
in the POST response. External Id field is left empty. - The
priceType
andrecurringChargePeriodType
are picklist values, which are already created in the org. - Default value of the
priceList
is B2C. Users can override the OOB value. - Correct price unit must be sent as per the org. Example if the org has dollar, then send USD.
- Pricing element and pricing variable are important to create a price list entry.
- Only mandatory TMF and Salesforce nodes are mapped.
- Linking the pricing with any product is not supported, as TMF does not have a node to identify product.
TMF Field | Type | Description | Salesforce Mapping | Salesforce Description | Prerequisite | Is mandatory? |
---|---|---|---|---|---|---|
name | string | Required. Specifies the name of the product offering price. | vlocity_cmt__PriceListEntry__c.Name | Specifies the reference number of the price list entry. | NA | Yes |
description | string | Specifies the description of the product offering price. | vlocity_cmt__PriceListEntry__c.vlocity_cmt__DisplayText__c | Describes the price list entry. | NA | No |
validFor | object | Specifies the period for which the product offering price is valid. | vlocity_cmt__PriceListEntry__c.vlocity_cmt__EffectiveUntilDate__c vlocity_cmt__PriceListEntry__c.vlocity_cmt__EffectiveFromDate__c | Specifies the effective dates when the price list entry is active. | NA | No |
priceType | string | Specifies a category that describes the price charge, such as recurring, discount, allowance, penalty, and so forth. | vlocity_cmt__PricingElementId__r.vlocity_cmt__PricingVariableId__r.vlocity_cmt__ChargeType__c | Specifies the price type such as one time, recurring, and so on. | NA | Yes |
recurringChargePeriodType | string | Specifies the charge period to apply the price again, which can be a month, week, and so on. | vlocity_cmt__PricingElementId__r.vlocity_cmt__PricingVariableId__r.vlocity_cmt__RecurringFrequency__c | Specifies the recurring frequency of the price list entry. | NA | Yes |
price | object | Specifies the amount of money that characterizes the price. | vlocity_cmt__PricingElementId__r.vlocity_cmt__Amount__c vlocity_cmt__PricingElementId__r.vlocity_cmt__CurrencyCode__c | Specifies the amount with the currency code. | NA | Yes |
productOfferingTerm | array | Specifies a condition with which a product offering is made available to customers. For instance, a product offering can be offered with multiple commitment periods. | vlocity_cmt__Promotion__c | Specifies the promotion associated with the price list entry. | NA | No |
lifecycleStatus | string | Specifies the lifecycle status of the product offering price. | vlocity_cmt__PriceListEntry__c.vlocity_cmt__IsActive__c | Specifies the lifecycle status of the price list entry. | NA | No |
lastUpdate | date time | Specfies the last modified date and time for the product offering price. | LastModifiedDate | Specifies the last modified date and time of the price list entry | NA | No |
priceList | string | Specifies the pricelist for the product offering price. | vlocity_cmt__PriceList__c | Specifies the price list. | A valid Pricelist name must be configured in the TMForumPriceList metadata. | Yes |