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  "shouldGenerateCSV": true,
3  "shouldIncludeMemberPlans": true,
4  "filter": {
5    "contractGroupPlanIds": {
6      "values": [
7        "0rgVW00000001tlYAA"
8      ]
9    },
10    "objectName": "Contact",
11    "recordIds": {
12      "values": [
13        "003VW00000BcBIfYAN"
14      ]
15    }
16  }
17}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
censusNameStringName of the group census to create.Optional68.0
censusTypeStringType of group census to generate, such as Enrollment or Quote.Required68.0
filterInsurance Census Filter InputFilter 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.Optional68.0
policyEffectiveDateStringDate 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.Optional68.0
requestIdStringID of the asynchronous request from a previous run.Required when you regenerate a group census that failed in the previous run.68.0
shouldGenerateCSVBooleanIndicates whether to create a CSV file with all the census details (true) or not (false).Optional68.0
shouldIncludeMemberPlansBooleanIndicates whether to include insurance plan details for each member in the generated group census (true) or not (false).Optional68.0