Insurance Generate Census Input

Input representation of the details to generate a group census from the policies on an existing group benefits contract.
JSON example
1{
2  "censusName": "Acme Enrollment Census 2026",
3  "censusType": "Enrollment",
4  "policyEffectiveDate": "2026-01-01",
5  "shouldGenerateCsv": true,
6  "shouldIncludeMemberPlans": true,
7  "filter": {
8    "contractGroupPlanIds": [
9      "0gpxx0000000001AAA"
10    ],
11    "objectName": "Contact",
12    "recordIds": [
13      "003xx000004WhKhAAK"
14    ]
15  }
16}
Properties
Name Type Description Required or Optional Available Version
censusName String Name of the group census to create. Optional 68.0
censusType String Type of group census to generate, such as Enrollment or Quote. Required 68.0
filter Insurance Census Filter Input 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 68.0
policyEffectiveDate String Date used to determine the policy version for generating the group census, in YYYY-MM-DD format. The specified date must fall between the policy version's effectiveFromDate and effectiveToDate. Optional 68.0
requestId String ID of the asynchronous request from a previous run. Required when you regenerate a group census that failed in the previous run. 68.0
shouldGenerateCsv Boolean Indicates whether to create a CSV file with all the census details (true) or not (false). Optional 68.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