SalesAgreementSettings

actualsCalculationMode

• Field Type: ActualsCalculationMode(enumeration of type string)
• Description: Required. Source from which the actual ordered quantity of a product in a sales agreement is calculated.
• Possible values:
  • DataProcessingEngine—Available in API version 63.0 and later.
  • Manual: Default
  • Orders
  • OrdersThroughContracts

arePredfndStatusValOveride

• Field Type: boolean
• Description: Indicates whether predefined status validations are overridden (true) or not (false) when the Override Predefined Status Validations feature is enabled. Available in API version 65.0 and later.
• Default value: false

decimalScale

• Field Type: int
• Description: Required. Number of decimal places applied to values in sales agreements. Available in API version 62.0 and later.

displayGroups

• Field Type: AdvAcctFrcstDisplayGroup
• Description: Represents information about the groups for the advanced account forecast set measures or dimensions. Available in API version 56.0 and later.

displayedAgreementTermsMetrics

• Field Type: string
• Description: Required. Metrics that are selected for display in the sales agreement terms in the specified sequence. There can be a maximum of 10 comma-separated metric names in this list.

futureActCalcSchedules

• Field Type: int
• Description: Required. Number of future schedules to include in actuals calculations in the sales agreement. Available in API version 63.0 and later.

measureDefinitions

• Field Type: AdvAcctForecastMeasureDef
• Description: Represents information about the measures to be displayed in the advanced account forecasts grid for the forecast set. Available in API version 56.0 and later.

objectMapping

• Field Type: ObjectMapping
• Description: Foreign key to ObjectMapping that maps fields from the input object of SalesAgreementSettings to fields in the output object of SalesAgreementSettings.

primaryNotifEmailAddress

• Field Type: string
• Description: The email address to which notifications are sent.

renewalPeriodDayCount

• Field Type: int
• Description: The number of days before the end date of a sales agreement from when the agreement can be renewed. Available in API version 50.0 and later.

secondaryNotifEmailAddress

• Field Type: string
• Description: The second email address to which notifications are sent.

Represents information about the groups for the advanced account forecast set measures or dimensions. Available in API version 56.0 and later.

advAcctFrcstDisplayGroupName

• Field Type: string
• Description: Required. Name of the advanced account forecast display group.

displayGroupItems

• Field Type: AdvAcctFrcstDplyGroupItem
• Description: Represents information about the items associated with a display group for an advanced account forecast set.

displayGroupType

• Field Type: AdvAcctFrcstDisplayGroupType(enumeration of type string)
• Description: Category for the display group.
• Possible values:
  • MEASURE

isDefault

• Field Type: boolean
• Description: Indicates whether the display group is the default group (true) or not (false).
• Default value: false

userProfileName

• Field Type: string
• Description: Profile for which the display group is applicable.

Represents information about the items associated with a display group for an advanced account forecast set. Available in API version 56.0 and later.

advAcctFrcstDplyGroupItemName

• Field Type: string
• Description: Required. Name of the advanced account forecast display group item.

displayOrder

• Field Type: string
• Description: Required. Display order of the display group item.

measureReferenceName

• Field Type: string
• Description: Name of the measure associated with the display group item.

Represents information about the measures to be displayed in the advanced account forecasts grid for the forecast set. Available in API version 56.0 and later.

advAcctForecastMeasureDefName

• Field Type: string
• Description: Required. Name for the measure.

aggregationType

• Field Type: AdvAcctFcstAggregationType(enumeration of type string)
• Description: Required. Type of aggregation used for calculating advanced account forecast values.
• Possible values:
  • AVERAGE
  • MAXIMUM
  • MINIMUM
  • SUM

computationMethod

• Field Type: AdvAcctFcstComputationMethodenumeration of type string)
• Description: Required. Method used for calculating advanced account forecast values.
• Possible values:
  • CUSTOM
  • DATA_PROCESSING_ENGINE_DEFINITION
  • FORMULA

forecastDataMeasureName

• Field Type: string
• Description: Required. Field of the facts object used for this measure.

forecastMeasureName

• Field Type: string
• Description: Required. Name for the measure to show on UI.

forecastMeasureType

• Field Type: AdvAcctFcstMeasureType(enumeration of type string)
• Description: Required. Measure type used for the generated advanced forecast values.
• Possible values:
  • QUANTITY
  • REVENUE

isAdjustmentTracked

• Field Type: boolean
• Description: Indicates whether the adjustments made to the advanced account forecast values for this metric are tracked (true) or not (false).
• Default value: false

Represents a map of fields in the input object of SalesAgreementSettings to fields in the output object of SalesAgreementSettings. The input object is SalesAgreementProductSchedule. The output object is SalesAgreementProduct.

inputObject

• Field Type: string
• Description: Required. The input object for the SalesAgreementSettings. SalesAgreementProductSchedule is the input object for the SalesAgreementSettings.

mappingFields

• Field Type: ObjectMappingField
• Description: The mapping of source object fields to target object fields for SalesAgreementSettings.

outputObject

• Field Type: string
• Description: Required. The output object for the SalesAgreementSettings. SalesAgreementProduct is the output object for the SalesAgreementSettings.

A field name in the SalesAgreementProductSchedule object and the corresponding field name in the SalesAgreementProduct object.

For example, you can create a field named Revenue on the SalesAgreementProductSchedule object and a field named Total Revenue on the SalesAgreementProduct object. To view these field values in the agreement terms of a sales agreement, select the input object as SalesAgreementProductSchedule and the output object as SalesAgreementProduct. In this case, the input field is Revenue and the output field is Total Revenue.

inputField

• Field Type: string
• Description: Required. Field in the object specified by the inputObject field in ObjectMapping. This field is mapped to the field in outputField, which is a field in the object specified by the outputObject field in ObjectMapping.

outputField

• Field Type: string
• Description: Required. Field in the object specified by the outputObject field in ObjectMapping. This field is mapped to the field name in inputField, which is a field in the object specified by the inputObject field in ObjectMapping.

The following is an example of SalesAgreementSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<SalesAgreementSettings
3	xmlns="http://soap.sforce.com/2006/04/metadata"
4	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
5	<actualsCalculationMode>Orders</actualsCalculationMode>
6	<arePredfndStatusValOveride>false</arePredfndStatusValOveride>
7      <decimalScale>0.2</decimalScale>
8	<displayGroups>
9		<advAcctFrcstDisplayGroupName>Test Measure Group</advAcctFrcstDisplayGroupName>
10		<displayGroupItems>
11			<advAcctFrcstDplyGroupItemName>PlannedQuantity</advAcctFrcstDplyGroupItemName>
12			<displayOrder>1</displayOrder>
13			<measureReferenceName>PlannedQuantity</measureReferenceName>
14		</displayGroupItems>
15		<displayGroupType>MEASURE</displayGroupType>
16		<isDefault>false</isDefault>
17		<userProfileName xsi:nil="true"/>
18	</displayGroups>
19	<displayedAgreementTermsMetrics>PlannedQuantity,ActualQuantity,SalesPrice,DiscountPercentage,DerivedPlannedAmount</displayedAgreementTermsMetrics>
20      <futureActCalcSchedules>10</futureActCalcSchedules>
21	<isOnlyApprovalProcessUsed>false</isOnlyApprovalProcessUsed>
22	<measureDefinitions>
23		<advAcctForecastMeasureDefName>PlannedQuantity</advAcctForecastMeasureDefName>
24		<aggregationType>MINIMUM</aggregationType>
25		<computationMethod>DATA_PROCESSING_ENGINE_DEFINITION</computationMethod>
26		<forecastDataMeasureName>PlannedQuantity</forecastDataMeasureName>
27		<forecastMeasureName>PlannedQuantity</forecastMeasureName>
28		<forecastMeasureType>QUANTITY</forecastMeasureType>
29		<isAdjustmentTracked>true</isAdjustmentTracked>
30	</measureDefinitions>
31	<secondaryNotifEmailAddress>abc@salesforce.com</secondaryNotifEmailAddress>
32	<primaryNotifEmailAddress>abc@salesforce.com</primaryNotifEmailAddress>
33	<renewalPeriodDayCount>50</renewalPeriodDayCount>
34	<objectMapping>
35		<inputObject>SalesAgreementProductSchedule</inputObject>
36		<mappingFields>
37			<inputField>SAPS1__c</inputField>
38			<outputField>SAP1__c</outputField>
39		</mappingFields>
40		<outputObject>SalesAgreementProduct</outputObject>
41	</objectMapping>
42</SalesAgreementSettings>

The following is an example package.xml that references the previous definition.

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.