Insurance Developer Guide
jConnectApi.InsuranceRefreshCensusInputRepresentation
Input representation of the group census ID, date range, optional filters, and update
options used to refresh a group census from policy enrollments and endorsements on a
contract.
| Property | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| endDate | String | End date of the time period used to find policy enrollments and endorsements that update the group census and associated records, in ISO 8601 yyyy-MM-dd format. | Required | 68.0 |
| filter | ConnectApi.InsuranceCensusFilterInputRepresentation | Filter criteria that identify which policy records associated with the insurance contract to include when updating the group census. You can filter by root contract group plan IDs, Person Accounts, and Contacts. | Optional | 68.0 |
| groupCensusAdditionalFields | List<ConnectApi.InsuranceApexStringRepresentation> | Key-value pairs of additional group census member field values to update. Each entry contains a field API name and value. | Optional | 68.0 |
| groupCensusId | String | ID of the group census record to update. | Required | 68.0 |
| policyEffectiveDate | String | Date used to determine the policy version for updating member and plan configuration details, in ISO 8601 yyyy-MM-dd format. The specified date must fall between the policy version's effectiveFromDate and effectiveToDate. | Required | 68.0 |
| requestId | String | ID of the asynchronous request from a previous run. Use with groupCensusId to retry updating the records that failed in a previous run. | Required to rerun the asynchronous job to update a group census that failed in a previous run. | 68.0 |
| shouldGenerateCSV | Boolean | Indicates whether to create a CSV file with the updated group census details (true) or not (false). The default value is false. | Optional | 68.0 |
| shouldIncludeMemberPlans | Boolean | Indicates whether to include plan details for the members when updating the group census (true) or not (false). The default value is false. | Optional | 68.0 |
| startDate | String | Start date of the time period used to find policy enrollments and endorsements that update the group census and associated records, in ISO 8601 yyyy-MM-dd format. | Required | 68.0 |