Partner

---

Represents the association between two particular Accounts or between a particular Opportunity and an Account.

Supported API Calls

create, delete, query, getDeleted, retrieve, describeSObject

Fields

For a complete list of fields in this object, see the Enterprise WSDL file for your organization and the salesforce.com online help.

Partner Fields 

Field	Data Type	Description
OpportunityId	ID	ID of the Opportunity in a partner relationship between an Account and an Opportunity. Specifying this field when calling create creates an Opportunity Partner. If you specify the AccountFromId field, you cannot specify this field as well.
AccountFromId	ID	ID of the main Account in a partner relationship between two accounts. Specifying this field when calling create creates an Account Partner. If you specify the OpportunityId field, you cannot specify this field as well.
AccountToId	ID	ID of the Partner Account related to either an Opportunity or an Account. You must specify this field when creating an Opportunity Partner or an Account Partner.
Primary	boolean	Valid for Opportunity Partners only. Indicates that the Account is the primary Partner for the Opportunity. Only one Account can be marked as "primary" for an Opportunity. If you set the Primary flag to `1' upon insert of a new Opportunity Partner, any other existing primary partners for that Opportunity will automatically have their Primary flag set to False.
Role	string	UserRole that the Account has towards the related Opportunity or Account (e.g., "Consultant" or "Distributor").

Usage

All of the Partner fields are accessible in the describeSObject and query calls; see Fields. You must have the "View All Data" permission to access Partners via the API.

Each Account in the relationship is assigned a Role (e.g., "Consultant" or "Distributor") designating that Account's Role towards the related Account or Opportunity. A relationship between two Accounts is referred to as an Account Partner, and a relationship between an Opportunity and an Account is referred to as an Opportunity Partner.

Using the create call, you can insert the OpportunityId or AccountFromId, AccountToId, Primary, and Role fields. You cannot update Partners via the sforce API.

Using the create call, you can insert the OpportunityId or AccountFromId, AccountToId, Primary, and Role fields. When creating a Partner object, you must specify either the OpportunityId field or the AccountFromId field. Specifying the OpportunityId field creates an Opportunity Partner, and the AccountFromId field creates an Account Partner. You must always specify a value for the AccountToId field.

When you create an Account Partner, i.e., a relationship between two Accounts, the sforce API automatically creates a reverse partner relationship between those two Accounts. For example, if you create an Account Partner with "Acme, Inc." as the AccountFromId and "Acme Consulting" as the AccountToId, the API automatically creates a reverse partner with "Acme Consulting" as the AccountFromId and "Acme, Inc." as the AccountToId. In the reverse partner, the value of the Role field is set to the designated reverse Role value associated with the value of the Role field in the original Account Partner. In the salesforce.com user interface, system administrators can set up the valid Role values and their corresponding reverse Role values.

If you set the Primary flag to `1' upon insert of a new Opportunity Partner, any other existing primary partners for that Opportunity will automatically have their Primary flag set to False.

See Also

Concepts