--- schema_version: "1" id: e0a248e1530b703bc89e3da7fe95dfea1b8794c9157ce62070c798c64d6cf441 title: TMF637 v4 Resource Mappings collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/industries-integrations/comms/guides/Resource_mappings/tmf637_resource_mapping.md canonical_url: https://developer.salesforce.com/docs/industries/communications/guide/tmf637_resource_mapping.html source_site: developer.salesforce.com content_type: documentation content_hash: 62c5f39af9e337edc201332082487f787c728ec2e6b83d846def33920ca90b44 products: - Communications Cloud TM Forum API - Industries Integrations --- # TMF637 v4 Resource Mappings Before using the TMF637 resource mappings, refer to the following. ## Constraints and Limitations 1. Attribute selection is supported for: name, isBundle, isCustomerVisible, description, status, productSerialNumber. 2. The field terminationDate is supported only if the LifecycleManagement license is present. Specifically, the Addon License AssetLifecycleManagementAddon should be present. 3. Filtering is enabled for: status, name, productSerialNumber, description. 4. Recommendation for filtering for description. - Use full word search - Wildcard are only for suffix, e.g. to search ‘Sample’, use ?description=Sam or ?description=Sampl 5. Custom metadata to configure ProductInventory First level attributes as per TMF. These will override the default first level attributes. - key - FieldsToQuery - api - TMForumProduct - label - TMForumProductFieldsToQuery - default value - vlocity_cmt\_\_AssetReferenceId\_\_c (This is mandatory). - In case of more attributes please use csv of salesforce fields mapped as per the field mapping table. 6. The Product Characteristics are mapped to Asset.AttributeSelectedValues\_\_c if V2 attributes are enabled. These default mappings are supported for the TMF637 resources. | TMF Field
| Field Type
| TMF Description
| Salesforce Object
| Salesforce Mapping
| Salesforce Description
| Is mandatory by TMF?
| | ---------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------- | | billingAccount | Object | A BillingAccount is a detailed description of a bill structure. | Asset | Asset.vlocity_cmt\_\_BillingAccountId\_\_c | Billing Account associated with this product | No | | description
| String | Is the description of the product. It could be copied from the description of the Product Offering
| Asset | Asset.Description | Description of the Asset | No | | href
| NA | Reference of the product
| NA | NA | Reference URL of the asset | No | | id | String | Unique identifier of the product.
| Asset | vlocity_cmt\_\_AssetReferenceId\_\_c | Unique Identifier of the asset. Mapped to Asset Reference Id | No | | isBundle | boolean | If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering.
| Asset | Asset.Product2.vlocity_cmt\_\_specificationSubType\_\_c | If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering.
| No | | isCustomerVisible
| boolean | If true, the product is visible by the customer
| Asset | Asset.Product2.vlocity_cmt\_\_IsOrderable\_\_c | If true, the product is visible by the customer
| No | | name | String | Name of the product. It could be the same as the name of the product offering.
| Asset | Asset.name | Name of the Asset or Product | No | | orderDate
| Date | Date when the product was ordered.
| Asset | Asset.OrderProduct.Order.EffecitveDate | Date when the product was ordered
| No | | productCharacteristic
| List | A list of characteristics. Describes a given characteristic of an object or entity through a name/value pair.
| Asset | Asset.vlocity_cmt\_\_JSONAttribute\_\_c
OR
Asset.AttributeSelectedValues\_\_c | A list of characteristics. Describes a given characteristic of an object or entity through a name/value pair.
| No | | productOffering | Object | A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
| Product | Asset.Product2Id | A product offering represents entities that are orderable from the provider of the catalog. | No | | productOrderItem
| List | A list of related product order items. The product order item which triggered product creation/change/termination.
| Asset | Asset.vlocity_cmt\_\_OrderProductId\_\_c | A list of related product order items. The product order item which triggered product creation/change/termination.
| No | | productPrice
| List | An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product. The price is valid for a defined period of time.
| Asset | Refer comments | An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product.
| No | | productSerialNumber
| String | Serial number for the product. This is typically applicable to tangible products
| Asset | Asset.SerialNumber | Serial number for the product. This is typically applicable to tangible products
| No | | productSpecification
| Object | A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
| Product | Asset.produc2tId.prodSpecId | A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
| No | | relatedParty
| List | Related Entity reference. A related party defines party or party role linked to a specific entity
| Asset | Asset.Accountid | Related Entity reference. A related party defines party or party role linked to a specific entity
| No | | startDate | Date | The date from which the product starts.
| Asset | Asset.activationDate | The date from which the product starts
| No | | status | String | Lifecycle status of the product.
| Asset | Asset.vlocity_cmt\_\_ProvisioningStatus\_\_c | Provisioning Status of the Asset | Yes | | terminationDate
| DateTime | Date when the product was terminated.
| Asset | Asset.LifecycleEndDate | Date when the product was terminated
| No | ## ProductOrderItem | TMForum Field
| TMForum Description
| Salesforce Mapping
| Salesforce Description
| Is mandatory by TMForum?
| | -------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------- | ----------------------------------------------------- | ------------------------------------------------------- | | productOrderId | A string. Unique identifier of a related entity.
| Orderitem.Order.OrderNumber | unique identifier of the product | Yes | | orderItemId | A string. Identifier of the order item where the product was managed.
| Orderitem.OrderItemNumber | Unique identifier of orderItem | No | | orderItemAction | A string. Action of the order item for this product.
| OrderProduct.vlocity_cmt\_\_Action\_\_c | Action | No | ## RelatedParty | TMForum Field
| TMForum Description
| Salesforce Mapping
| Salesforce Description
| Is mandatory by TMForum?
| | -------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------- | ----------------------------------------------------- | ------------------------------------------------------- | | name | A string. Name of the related entity. | Account.Name | Name of the account | No | | id | A string. unique identifier. | Account.AccountNumber | External id for the given account | Yes | | @referredType | A string. The actual type of the target instance when needed for disambiguation. | Schema object name i.e "Account" | NA | Yes | ## BillingAccount | TMForum Field
| TMForum Description
| Salesforce Mapping
| Salesforce Description
| Is mandatory by TMForum?
| | -------------------------------------------- | -------------------------------------------------- | -------------------------------------------------------- | ----------------------------------------------------- | ------------------------------------------------------- | | name | A string. Name of the related entity. | Asset.vlocity_cmt\_\_BillingAccountId\_\_r.name | Name of the account. | No | | id | A string. unique identifier. | Asset.vlocity_cmt\_\_BillingAccountId\_\_r.AccountNumber | External id for the given account. | Yes | ## ProductOffering | TMForum Field
| TMForum Description
| Salesforce Mapping
| Salesforce Description
| Is mandatory by TMForum?
| | -------------------------------------------- | -------------------------------------------------- | ------------------------------------------------- | ----------------------------------------------------- | ------------------------------------------------------- | | name | A string. Name of the related entity. | Asset.Product2.name | Product offering name. | No | | id | A string. Unique identifier of a related entity. | Asset.Product2Id | Salesforce ID of the product offering. | Yes | ## ProductSpecification | TMForum Field
| TMForum Description
| Salesforce Mapping
| Salesforce Description
| Is mandatory by TMForum?
| | -------------------------------------------- | -------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ------------------------------------------------------- | | name | A string. Name of the related entity. | Asset.Product2.vlocity_cmt\_\_ProductSpecId\_\_r.Name | Product specification name. | No | | id | A string. Unique identifier of a related entity. | Asset.Product2.vlocity_cmt\_\_ProductSpecId\_\_r.Id | Salesforce ID of the product specification. | Yes | ## ProductPrice | TMForum Field
| TMForum Description
| Salesforce Mapping
| Salesforce Description
| Is mandatory by TMForum?
| | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | ------------------------------------------------------- | | name | A string. Short descriptive.
| vlocity_cmt\_\_PriceListEntry\_\_c.Name | Name of the price list entry. | No | | description | A string. A narrative that explains in detail the semantics of this product price. | vlocity_cmt\_\_PriceListEntry\_\_c.DisplayText\_\_c | Description of the price list entry. | No | | price.taxIncludedAmount.unit | A money (Money). The amount of money that characterizes the price. | vlocity_cmt\_\_PriceListEntry\_\_c.vlocity_cmt\_\_PricingElementId\_\_r.vlocity_cmt\_\_CurrencyCode\_\_c | Specifies currency code. | No | | price.taxIncludedAmount.value | A money (Money). The amount of money that characterizes the price. | vlocity_cmt\_\_PriceListEntry\_\_c.vlocity_cmt\_\_PricingElementId\_\_r.vlocity_cmt\_\_Amount\_\_c | Price of the product offer. | No | | priceType | A string. A category that describes the price, such as recurring, discount, allowance, penalty, and so forth. | vlocity_cmt\_\_PriceListEntry\_\_c.vlocity_cmt\_\_PricingElementId\_\_r.vlocity_cmt\_\_PricingVariableId\_\_r.vlocity_cmt\_\_ChargeType\_\_c | Describes the price, like one time or recurring. | Yes | | recurringChargePeriod | A string. The period to repeat the application of the price Could be month, week... | vlocity_cmt\_\_PriceListEntry\_\_c.vlocity_cmt\_\_PricingElementId\_\_r.vlocity_cmt\_\_PricingVariableId\_\_r.vlocity_cmt\_\_RecurringFrequency\_\_c | Frequency of the price type. | No | | unitOfMeasure | A string. Could be minutes, GB | vlocity_cmt\_\_PriceListEntry\_\_c.vlocity_cmt\_\_PricingElementId\_\_r.vlocity_cmt\_\_CurrencyCode\_\_c | Effective period in which the price list entry is valid. | No | | productPriceAlteration | A list of price alterations (PriceAlteration [\*]). Is an amount, usually of money, that modifies the price charged for an order item. | Asset.vlocity_cmt\_\_PricingLogData\_\_c | Specifies price adjustment. | No | ## ProductCharacteristic Salesforce Object : If V2 model is disabled, refer to the following mapping table and use Asset.vlocity_cmt\_\_JSONAttribute\_\_c. If V2 model is enabled then Asset.AttributeSelectedValues\_\_c is used. | TMForum Field
| TMForum Description
| Salesforce Mapping
| Salesforce Description
| Is mandatory by TMForum?
| | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ----------------------------------------------------- | ------------------------------------------------------- | | name | A list of characteristics (Characteristic [\*]). Describes a given characteristic of an object or entity through a name/value pair.

| Asset.vlocity_cmt\_\_JSONAttribute\_\_c.attributeuniquecode\_\_c | Attribute Unique code | No | | value | A list of characteristics (Characteristic [\*]). Describes a given characteristic of an object or entity through a name/value pair.

| Asset.vlocity_cmt\_\_JSONAttribute\_\_c.value\_\_c | Attribute Value | No | | valueType | A list of characteristics (Characteristic [\*]). Describes a given characteristic of an object or entity through a name/value pair. NOTE: Supported only for JSON attribute mapping.

| Asset.vlocity_cmt\_\_JSONAttribute\_\_c.valuedatatype\_\_c | Attribute Value. type | No |