Overview - Functional Scope and Limitations - m3ter Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

The m3ter Connector for Salesforce supports two main sync flows from Salesforce to m3ter:

Account Sync. Salesforce Customer Account to m3ter Account.
Sales Agreement Sync. New sales agreements in Salesforce into m3ter.

The Connector ships with predefined mappings for the Opportunity (and Opportunity products) objects in Salesforce. However, it also supports other configurations and we can provide example mappings on request. This topic provides a series of lookup references tables and listings to help you quickly check on the current scope and limitations of the sync flows you can implement using the m3ter Connector for Salesforce. Prerequisites for these flows in terms of your sales agreement set up in Salesforce and required mappings to m3ter Objects and Fields are also given:

Note: Use Case not Supported? If you have use cases that are not currently supported, please contact your m3ter representative to discuss.

Note: Sample Mappings! The m3ter Connector - Sample Mappings sub-section provides sample mappings.

Supported Operations for Connector Syncs Flows

The following table sets out the operations supported by the m3ter Connector for different sync flow types:

Sync Type	m3ter Object	Supported Operations	Notes
Account Sync	Account	Create, Update
Sales agreement Sync	Account	Create, Update	Where the sales agreement in Salesforce is based on related objects, such as an Opportunity and Opportunity Products, or Orders and Order Items, and so on.
	Contract	Create, Update
	Commitment	Create Only
	Account Plan	Create Only	Only prepaid Commitments supported currently or Commitments set up to be billed with Plan.
	Plan	Create Only
	Pricing	Create Only
Amendments Sync	End Date Contract	Available	End dates selected m3ter billing Objects linked to a Contract.
	End Date all Account Billing Objects	Available	End dates selected m3ter billing Objects linked to the m3ter Account.

Sync Limitations and Exclusions

Here is a summary of the current sync limitations and exclusions for the m3ter Connector for Salesforce managed package:

Balance and Balance Transactions. We expect to support Balance and Balance Transaction creation starting from version 0.6 or above of the m3ter Connector.
Segmented Pricing. Not yet available.
Plan Groups. Existing and mapped Plan Groups can be synced.
Custom Billing Schedule for Commitments. Not yet available - Commitment/Prepayment sync is currently only supported for Commitments where any unpaid amount is billed with a Plan.
Creation of Compound Aggregations. Syncing of existing and mapped Compound Aggregations in m3ter is only supported in version 0.5.1 and above of the Connector managed package.
Price Overrides when using Plan Templates. Supported for single Aggregation pricing.

Expected Salesforce Sales Agreement Structure

The m3ter Connector for Salesforce can work with almost any sales flow within Salesforce. This is achieved by mapping the Salesforce objects used in your sales process to the m3ter billing configuration. For the Connector to work properly, the data for mappings must be made to a related set of objects in your Salesforce Org set up - that is, objects in Master/Detail relationships. This will allow you to pull data from each related source for use within the mapping configuration. Mapped fields must be available on the Salesforce object (or via the related object) in order to be able to create mappings between m3ter and Salesforce. A typical sales object in Salesforce structure will have this general structure:

Header (Master) - Lines (Details) - Pricing (pricing can be at the same level as the order line or in a related object)

Where the sales agreements objects can be:

Opportunity (Master) - Opportunity products (Details)
Quote (Master) - Quote Lines (Details)
Order (Master) - Order Items or Order Products (Details)
Contract (Master) - Subscriptions (Details) - Subscription Consumption Schedule
Custom Object (header) - Custom Object (lines) - Custom Object (pricing)

Tip: Are Multiple Sales Flows Mapping possible? Yes. You can also configure mappings for multiple sales flows in your CRM by creating new sets of metadata mappings for each set of objects on which the sync flow is based. For example, one flow for Opportunities and another flow for Contracts.

Account Sync

The following illustrates the Account Sync flow:

Sales Agreement Sync

Here are two examples illustrating the sales agreement Sync flow:

Contract
Opportunity

m3ter Object and Fields - Mandatory Mappings

In order to successfully create agreements from a source sales agreement in Salesforce, m3ter requires certain Objects and Fields to be mapped. The following table sets out these mandatory mappings:

m3ter Object	m3ter Field	Mandatory	Notes
Account	Name	Yes
	Code	Yes
	Email	Yes
	Address Line 1
	Address Line 2
	Post Code
	Region
	Locality
	Country
Contract	Name	Yes
	Code	Yes
	Start Date	Yes
	End Date	Yes
	PO Number
	Description
Commitment	Billing Plan	Yes
	Start Date	Yes
	End Date	Yes
	Currency	Yes
	Amount	Yes
	Amount Prepaid
	Amount First Bill
	Overage Surcharge Percent
	Billing Interval
	Billing Offset
	Commitment Fees Description
	Commitment Usage Description
	Overage Description
	Hardcoded
Account Plan	Plan ID	Conditional	Requires just one of either Plan ID or Plan Group ID but not both.
	Plan Group ID	Conditional
	Contract ID
	Start Date	Yes
	End Date
	Code	Yes
	Bill Epoch
Plan	Plan Template ID	Yes
	Code	Yes
	Name	Yes
	Minimum Spend
	Minimum Spend Bill in Advance
	Minimum Spend Description
	Standing Charge
	Standing Charge Bill in Advance
	Standing Charge Description
	Ordinal	Yes
	Bespoke	Yes
Pricing	Plan Template ID
	Plan ID
	Aggregation ID
	Compound Aggregation ID
	Code	Yes
	Cumulative
	Description
	Type	Yes
	Minimum Spend
	Minimum Spend Description
	Minimum Spend Bill in Advance	Yes
	Start Date	Yes
	End Date
Pricing Bands	Fixed Price	Conditional
	Unit Price	Conditional
	Lower Limit	Yes