Group Input

Input representation of a party relationship group.

NameTypeDescriptionRequired or OptionalAvailable Version
categoryStringCategory of the party relationship group.Optional58.0
custom​FieldsMap<String, Object>Custom fields associated with the party relationship group.Optional58.0
descriptionStringDescription of the party relationship group.Optional58.0
endDateStringEnd date associated with the party relationship group.Optional58.0
group​IncomeStringTotal income of the party relationship group.Optional58.0
group​SizeStringNumber of active members associated with the party relationship group.Optional58.0
nameStringName of the party relationship group.Required58.0
party​Relation​GroupIdStringRecord ID of the party relationship group. Record ID is optional when creating a group and required when merging groups.Required58.0
primary​AddressAddress InputPrimary address of the party relationship group.Required58.0
start​DateStringStart date associated with the party relationship group.Optional58.0
statusStringStatus of the party relationship group. Valid values are:
  • Active
  • Inactive
Optional58.0
subtypeStringSubclassification of the party relationship group type.Optional58.0
typeStringType of the party relationship group. Valid values are:
  • Group
  • Household
Required58.0