Newer Version Available

This content describes an older version of this product. View Latest

PartyRelationshipGroup

Represents a group of people living together such as a household, or a group of people affiliated with each other. This object is available in API version 56.0 and later.

Supported Calls

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

Fields

Field Details
AccountId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The parent account associated with the party relationship group.
This field is a relationship field.
Relationship Name
Account
Relationship Type
Lookup
Refers To
Account
Category
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the category of the party relationship group.
Possible values are:
  • Extended Family
  • 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 end date associated with the party relationship group.
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 active members associated with the party relationship group.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (<parmname>LastReferencedDate</parmname>) but not viewed it.
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 primary relationship group’s latitude and longitude coordinates.
Possible values are:
  • Address
  • Block
  • City
  • County
  • ExtendedZip
  • NearAddress
  • 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 start date associated with the party relationship group.
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 subclassification of the party relationship group type.
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.