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

query(), retrieve(), describeSObjects()

Special Access Rules

Customer Portal users cannot access this object.

Fields

Field	Field Type	Field Properties	Description
AccountFromId	reference	Filter	ID of the main Account in the partner relationship. For information on IDs, see ID Field Type.
AccountToId	reference	Filter	ID of the partner Account in the partner relationship.
IsDeleted	boolean	Defaulted on create Filter	Indicates whether the object has been moved to the Recycle Bin (`true`) or not (`false`). Label is Deleted.
IsPrimary	boolean	Defaulted on create Filter	Indicates whether the AccountPartner is the main account’s primary partner (`true`) or not (`false`).
Role	picklist	Filter Nillable	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.