AccountPartner

This read-only object represents a partner relationship between two Account objects. It is automatically created when a Partner object is created for a partner relationship between two accounts.

Note

This object is completely distinct and independent of Account records that have been enabled for the partner portal.

Supported Calls

describeSObjects(), query(), retrieve()

Special Access Rules

Customer Portal users can't access this object.

Fields

Field	Details
AccountFromId	Type reference Properties Filter, Group, Sort Description ID of the main Account in the partner relationship.
AccountToId	Type reference Properties Filter, Group, Nillable, Sort, Description ID of the partner Account in the partner relationship.
IsDeleted	Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (`true`) or not (`false`). Label is Deleted.
IsPrimary	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the AccountPartner is the main account’s primary partner (`true`) or not (`false`).
OpportunityId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the opportunity in a partner relationship with the related account.
Role	Type picklist Properties Filter, Group, Nillable, Sort Description The UserRole that the partner Account has on the main Account. For example, `Consultant` or `Distributor`.

Creating an Account-Account Partner Relationship

When you create a partner relationship between two accounts (when you create a Partner object and specify the AccountFromId), the API automatically creates two AccountPartner objects, one for the forward relationship and one for the reverse. For example, if you create a Partner object with “Acme, Inc.” as the AccountFromId and “Acme Consulting” as the AccountToId, the API automatically creates two AccountPartner objects:

The forward relationship AccountPartner with “Acme, Inc.” as the AccountFromId and “Acme Consulting” as the AccountToId.
The reverse relationship AccountPartner with “Acme Consulting” as the AccountFromId and “Acme, Inc.” as the AccountToId.
The value of the Role field in the reverse relationship AccountPartner is set to the PartnerRole object ReverseRole value associated with the value of the Role field in the forward relationship AccountPartner.

This mapping allows the API to manage the objects and their relationship efficiently.