AccountContactRelation

Standard and custom fields extend the standard Account object for use in Public Sector Solutions to represent information of members in a household. This object is available in API version 56.0 and later.

For more information, see AccountContactRelation.

Supported Calls

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

Special Access Rules

Fields

AccountId

Type: reference
Properties: Create, Filter, Group, Sort
Description: Lookup to the Account object.

This field is a relationship field.
Relationship Name: Account
Relationship Type: Lookup
Refers To: Account

ContactId

Type: reference
Properties: Create, Filter, Group, Sort
Description: Lookup to the Contact object.

This field is a relationship field.
Relationship Name: Contact
Relationship Type: Lookup
Refers To: Contact

DataRollupCategories

Type: multipicklist
Properties: Create, Filter, Nillable, Update
Description: Specifies the categories in which the data associated with a group is aggregated.

EndDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date a relationship between a contact and account ended. Use with the Start Date to keep a history of the relationship.

HouseholdAutoNamingSequence

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The sequence of household members, if there are more than two, included in the household naming. The primary household member is always listed first.

This field is available in API version 68.0 and later.

This field is available only if the Automatic Household Creation and Naming add-on license is enabled.

IsActive

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether relationship is active (true) or not (false).
Default value: false

IsDirect

Type: boolean
Properties: Defaulted on create, Filter, Group, Sort
Description: Indicates whether relationship is direct (true) or not (false).
Default value: false

IsExclFrHshldAutoNaming

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the related person account is excluded (true) within automatic naming and greetings, or not (false).

This field is available in API version 68.0 and later.

This field is available only if the Automatic Household Creation and Naming add-on license is enabled.
Default value: false

IsIncludedInGroup

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the data of a group or a business account is included in the Household (true) or not (false).
Default value: false

IsPrimaryGroup

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the group is a primary group for the member (yes) or not (no).
Default value: false

IsPrimaryMember

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the member is a primary contact of a group (true) or not (false).
Default value: false

Roles

Type: multipicklist
Properties: Create, Filter, Nillable, Update
Description: The contact’s participating role in the account.
Possible values:
- Daughter
- Father
- Husband
- Mother
- Other
- Son
- Wife

StartDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date a relationship between a contact and account began. Use with the End Date to keep a history of the relationship

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

AccountContactRelationChangeEvent (API Version 59.0): Change events are available for the object.