Insurance Developer Guide
jConnectApi.InsuranceGenerateCensusInputRepresentation
Input representation of the census name and type, optional policy date, filters, and
generation options used to create a group census from the policies on a contract.
| Property | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| censusName | String | Name of the group census to create. | Optional | 67.0 |
| censusType | String | Type of group census to generate, such as Enrollment or Quote. | Required | 67.0 |
| filter | ConnectApi.InsuranceCensusFilterInputRepresentation | Filter criteria that indicate which policy records to include when generating the group census. You can filter by root contract group plan IDs, Person Accounts, and Contacts. | Optional | 67.0 |
| policyEffectiveDate | String | Date used to determine the policy version for generating the group census, in ISO 8601 yyyy-MM-dd format. The specified date must fall between the policy version's effectiveFromDate and effectiveToDate. | Optional | 67.0 |
| requestId | String | ID of the asynchronous request from a previous run. Use this value to regenerate a group census that failed in the previous run. | Required when you regenerate a group census that failed in the previous run. | 67.0 |
| shouldGenerateCsv | Boolean | Indicates whether to create a CSV file with all the census details (true) or not (false). | Optional | 67.0 |
| shouldIncludeMemberPlans | Boolean | Indicates whether to include insurance plan details for each member in the generated group census (true) or not (false). | Optional | 68.0 |