SalesAgreementSettings
Represents settings that control the display of agreement
terms metrics in sales agreements and the calculation of the actual quantity of products in
sales agreements. These settings also control the approval of sales agreements. Available in
API version 57.0 and later.
Supported SOAP Calls
create(), describeSObjects(), query(), retrieve(),update(), upsert()
Supported REST HTTP Methods
GET, POST, PATCH, PUT
Fields
ActualsCalculationMode
- Type: picklist
- Properties: Filter, Group, Restricted picklist, Sort
- Description: Source from which the actual ordered quantity of a product in a sales agreement is calculated.
- Default value: Manual
-
Possible values:
- DataProcessingEngine—Using a Data Processing Engine Definition—Available in API version 63.0 and later.
- Manual—Manually using API upload
- Orders—Automatically from direct orders
- OrdersThroughContracts—Automatically from orders through contracts.
AdvAcctFrcstDisplayGroupForecastSet
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The forecast set associated with the sales agreement
group.
This is a relationship field.
DeveloperName
- Type: string
- Properties: Filter, Group, Sort
- Description: The developer name for SalesAgreementSettings.
DisplayedAgreementTermsMetrics
- Type: textarea
- Properties: Filter, Sort
- Description: Metrics that are selected for display in Agreement Terms in a specified sequence. There can be a maximum of 10 comma-separated metric names in this list.
FullName
- Type: string
- Properties: Create, Group, Nillable
-
Description: The full name of the associated metadata object in
Metadata API.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
IsOnlyApprovalProcessUsed
- Type: boolean
- Properties: Default on Create, Filter, Group, Sort
- Description: Indicates whether both self-approval and approval of sales agreements are allowed (true) or only approval of sales agreements is allowed false) through the Approval Flow.
- Default value: false
Language
- Type: picklist
- Properties: Defaulted on Create, Filter, Group, Nillable, Restricted picklist, Sort
- Description: The language of the sales agreement settings.
MasterLabel
- Type: string
- Properties: Filter, Group, Sort
- Description: Master label for SalesAgreementSettings. This internal label doesn’t get translated.
PrimaryNotifEmailAddress
- Type: email
- Properties: Filter, Group, Nillable, Sort
- Description: The email address to which notifications are sent.
RenewalPeriodDayCount
- Type: int
- Properties: Filter, Group, Nillable, Sort
- 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
- Type: string
- Properties: Filter, Group, Nillable, Sort
- Description: The second email address to which notifications are sent.