Newer Version Available

This content describes an older version of this product. View Latest

SalesAgreement

Represents a long-term agreement between a buyer and a seller to negotiate price and volume of products.This object is available in API version 47.0 and later.

You can update an approved sales agreement by changing its status from Approved to Draft.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
AccountId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
ID of the referenced account.
ActivatedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Date and time on which the sales agreement is activated.
ActualsCalculationMode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The mode used by the application to calculate actual quantities for a sales agreement.
AgreementType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Type of the sales agreement. Currently, a sales agreement is always volume-based.
ApprovedById
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the user who approves the sales agreement.
ApprovedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Date and time on which the sales agreement was approved.
CancellationDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Date and time on which the sales agreement was canceled.
CancellationReason
Type
picklist
Properties
Filter, Group, Nillable, Sort, Update
Description
Reason for canceling the sales agreement. Values can be customized. Examples include low profit, unavailability of products, and so on.
ContactId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of a contact associated with the sales agreement account.
Description
Type
textarea
Properties
Create, Nillable, Update
Description
User-defined context and information about the sales agreement.
EndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Date and time on which the sales agreement expires.
LastActualsCalculatedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Date and time on which actuals were last calculated either by the automated daily job or by the ad-hoc action performed by an individual user.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which this record was referenced.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which this record was viewed.
Name
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
User-defined name of the sales agreement.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the user who owns this record.
PricebookId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
ID of the associated price book.
ProductLevel
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Level of the products associated with the sales agreement.
Possible values are:
  • Product
  • ProductCategory—Category
RenewedFromAgreementId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the immediate parent from which the sales agreement is renewed.
This field is a relationship field.
Relationship Name
RenewedFromAgreement
Relationship Type
Lookup
Refers To
SalesAgreement
RenewedToAgreementId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the renewed sales agreement.
This field is a relationship field.
Relationship Name
RenewedToAgreement
Relationship Type
Lookup
Refers To
SalesAgreement
ScheduleCount
Type
int
Properties
Create, Filter, Group, Sort, Update
Description
Number of schedules in the sales agreement.
ScheduleFrequency
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Frequency at which schedules occur in the sales agreement. Values include One-Time, Monthly, Quarterly, and Yearly.
StartDate
Type
date
Properties
Create, Filter, Group, Sort, Update
Description
Date on which the sales agreement must get activated.
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Status of the sales agreement. The values can be customized but must map to at least one of the predefined status codes.
StatusCode
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Sort
Description
Set of five predefined status codes that determine at which stage is the sales agreement in . Values include In Process, Approved, Activated, Expired, and Canceled.
TotalAgreementAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Total value of the sales agreement.
TotalProposedAgreementAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Total value of the sales agreement when the sales agreement is under revision.
This field is a calculated field.