Insurance Developer Guide
jConnectApi.MemberWithPlansInputRepresentation
Input representation for the details of a group census member and the insurance plans to
add, update, or remove for that member.
| Property | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| accountId | String | ID of the person account record of the member. | Optional | 68.0 |
| addedPlans | List<ConnectApi.MemberPlanInputRepresentation> | Insurance plans to add to an existing member. | Required to add members. | 68.0 |
| additionalFields | Map<String, Object> | Values for custom fields on the GroupCensusMember record, keyed by field API name. | Optional | 68.0 |
| annualEligibleSalary | Double | Annual salary of the member that's eligible for benefits calculations. | Optional | 68.0 |
| associationWithPrimaryMbr | String | For a dependent, the association to the primary member, such as Spouse or Child. | Optional | 68.0 |
| birthdate | String | Date of birth of the member, in YYYY-MM-DD format. | Optional | 68.0 |
| city | String | City in the member's address. | Optional | 68.0 |
| contactId | String | ID of the contact record of the member. | Optional | 68.0 |
| country | String | Country in the member's address. | Optional | 68.0 |
| deletedPlans | List<String> | IDs of the GroupCensusMemberPlan records to remove for this member. | Optional. Use this property only when you update a member. | 68.0 |
| dependentCount | Integer | Number of dependents that are associated with the member. | Optional | 68.0 |
| String | Email address of the member. | Optional | 68.0 | |
| firstName | String | First name of the member. | Optional | 68.0 |
| fullTimeEquivalent | Double | Work capacity of the member, where 1.0 indicates a full-time employee. | Optional | 68.0 |
| gender | String | Gender of the member. | Optional | 68.0 |
| groupCensusId | String | ID of the GroupCensus record that the member belongs to. | Optional | 68.0 |
| groupCensusMemberPlans | List<ConnectApi.MemberPlanInputRepresentation> | Insurance plans to associate with the member. | Optional. Use this property only when you add a member. | 68.0 |
| groupClassId | String | ID of the class or category within the group that the member belongs to. | Optional | 68.0 |
| groupClassName | String | Name of the group class. | Optional | 68.0 |
| grpCensusGrpClassSummaryId | String | ID of the related GroupCensusGroupClassSummary record. | Optional | 68.0 |
| id | String | ID of the GroupCensusMember record to update along with its associated insurance plans. | Required when you update a member. Don't specify this ID when you add a member. | 68.0 |
| isOptOutAllPlans | Boolean | Indicates whether the member has opted out of all available insurance plans (true) or not (false). | Optional | 68.0 |
| isPortalUser | Boolean | Indicates whether a community portal user is created for this member (true) or not (false). | Optional | 68.0 |
| joinDate | String | Date that the member joined the group or company. | Optional | 68.0 |
| lastname | String | Last name of the member. | Optional | 68.0 |
| memberKey | String | Externally defined key that uniquely identifies the member and prevents duplicates. This key is often a concatenation of several field values. | Optional | 68.0 |
| memberType | String | Type of member, such as Primary or Dependent. | Optional | 68.0 |
| name | String | Full name of the member. This value is saved to the Name field of the GroupCensusMember record. | Required | 68.0 |
| optOutPlanTypes | String | Types of plans that the member has opted out of. | Optional | 68.0 |
| overrideTypeConfiguration | String | Configuration that governs which plan overrides are permitted for the member, such as Default, Override Attributes, or Override Plans and Attributes. | Optional | 68.0 |
| phoneNumber | String | Phone number of the member. | Optional | 68.0 |
| policyStartDate | String | Date that the member's policy coverage begins. | Optional | 68.0 |
| postalCode | String | Postal code or ZIP code in the member's address. | Optional | 68.0 |
| primaryGroupCensusMemberId | String | ID of the primary GroupCensusMember record that the dependents are associated with. | Optional | 68.0 |
| primaryMemberCategory | String | Category of the primary member. | Optional | 68.0 |
| primaryMemberSource | String | System or source that the member's data originated from. | Optional | 68.0 |
| relationshipToPrimaryMember | String | Member's relationship to the primary insured. | Optional | 68.0 |
| smokerStatus | String | Smoking status of the member, such as Smoker or Non-smoker. | Optional | 68.0 |
| sourceSystemIdentifier | String | ID of the member in an external source system. Use this ID for integration purposes. | Optional | 68.0 |
| state | String | State or province in the member's address. | Optional | 68.0 |
| status | String | Current status of the member, such as Active or Inactive. | Optional | 68.0 |
| street | String | Street in the member's address. | Optional | 68.0 |
| upsertedPlans | List<ConnectApi.MemberPlanInputRepresentation> | Insurance plans to add or update for an existing member. | Optional. Use this property only when you update a member. | 68.0 |