PartyRelationshipGroup

Represents a group or household of related parties, such as the members of a household who share housing, income, and other resources. This object is available in API version 67.0 and later.

Use PartyRelationshipGroup to represent a household or other group of related parties and to capture the shared attributes of that group, such as its size, income, housing type, and primary address.

Supported Calls

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

Special Access Rules

This object is available if Relationship Groups is enabled in your org.

Fields

Field	Details
AccountId	Type reference Properties Create, Filter, Group, Sort Description The account that the party relationship group belongs to. This field is unique in your org. This field is a relationship field. Relationship Name Account Relationship Type Master-detail Refers To Account (the master object)
Category	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The category of resources or arrangements that the parties in the group share. Possible values are: `Meals together` `Staying under same roof`
Description	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the party relationship group.
EndDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the party relationship group ends.
GroupIncome	Type currency Properties Create, Filter, Nillable, Sort, Update Description The total income of the party relationship group.
GroupSize	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of members in the party relationship group.
HousingType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of housing that the party relationship group occupies.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the party relationship group.
PrimaryAddress	Type address Properties Filter, Nillable Description The primary address of the party relationship group.
PrimaryCity	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The primary city of the party relationship group.
PrimaryCountry	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The primary country of the party relationship group.
PrimaryGeocodeAccuracy	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of a location’s geographical coordinates compared with its physical address. A geocoding service typically provides this value based on the party relationship group’s latitude and longitude coordinates. Possible values are: `Address` `Block` `City` `County` `ExtendedZip`—Extended Zip `NearAddress`—Near Address `Neighborhood` `State` `Street` `Unknown` `Zip`
PrimaryLatitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the party relationship group. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
PrimaryLongitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the party relationship group. Acceptable values are numbers between –180 and 180 with up to 15 decimal places.
PrimaryPostalCode	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The primary postal code of the party relationship group.
PrimaryState	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The primary state of the party relationship group.
PrimaryStreet	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The primary street of the party relationship group.
StartDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the party relationship group starts.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the party relationship group. Possible values are: `Active` `Inactive` The default value is `Active`.
Subtype	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The subtype of the party relationship group. Possible values are: `Extension Household` `Nuclear Household` `Three Person Household`
Type	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of the party relationship group. Possible values are: `Group` `Household` The default value is `Group`.

Public Sector Developer Guide

PartyRelationshipGroup

Supported Calls

Special Access Rules

Fields