Insurance Create Underwriting Rules Input

Create Underwriting Rule Input Representation

JSON Example 

1{
2       "name": "Automatically Approve Quote",
3       "apiName": "approveQuoteBasedonComprehensiveCoverageDeductibles",
4       "effectiveFromDate": "2024-05-30T10:30:00",
5       "effectiveToDate": "2024-11-01T10:30:00",
6       "status": "Draft",
7       "description": "Rule description”,
8       "underwritingRuleGroup": {
9       "underwritingRuleGroupId": "1KQ000000MKJIK", // Optional,
10       // if underwritingRuleGroupId exist, then use it as parent instead of create a new record.
11       "stageTransitionId": "0jjDR00000000VGAAA", // State Transition id.
12       "stageTransitionName": "Draft to Approved",
13       "objectType": "Quote",
14       "recordType": "--Master--",
15       "fromStage": "Draft",
16       "toStage": "Approved",
17       "rootProductId": "01tDR000000EMslYAG" // Auto Gold.
18       "ruleKey": "UW__autoSilver__DraftToApproved__VehicleValueLessThan200K"
19       "criteriaExpression": "1" // Exmple "(1 AND 2) OR 3" if more than 1 rules.
20       }
21       "productPath": "01tDR000000EMslYAG/11BDR00000000T72AI", // "Auto Gold/Auto Vehicle"
22       "sequence": 1,
23       "ruleCriteria": [
24       {
25       "conditions": [
26       {
27       "contextTagName": "SalesTransactionItemAttribute",
28       "operator": "LessThan",
29       "conditionIndex": 1,
30       "attributeName": "Annual Milage",
31       "attributePicklistValueId": null,
32       "type": "Attribute",
33       "attributeId": "0tjDR00000000VGYAY",
34       "dataType": "Number",
35       "values": [
36       "50000"
37       ]
38       }
39       ],
40       "rootObjectId": "01tDR000000EMslYAG", // Auto Gold.
41       "productRelatedComponent" : // Need More details on it.
42       "criteriaIndex": 1,
43       "sourceContextTagName": "ProductBasedOn",
44       "sourceOperator": "Equals",
45       "sourceDataType": "String",
46       "sourceValues": [
47       "11BDR00000000T72AI" // Auto Vehicle.
48       ]
49       },
50       {
51       "conditions": [
52       {
53       "contextTagName": "SalesTransactionItemAttribute",
54       "operator": "LessThan",
55       "conditionIndex": 1,
56       "attributeName": "Comprehensive Deductible",
57       "type": "Attribute",
58       "attributePicklistValueId": null,
59       "attributeId": "0tjDR00000000UaYAI",
60       "dataType": "Number",
61       "values": [
62       "$5000"
63       ]
64       }
65       ],
66       "rootObjectId": "01tDR000000EMslYAG", // Auto Bundle
67       "productRelatedComponent" : // Need More details on it.
68       "criteriaIndex": 2,
69       "sourceContextTagName": "Product",
70       "sourceOperator": "Equals",
71       "sourceDataType": "String",
72       "sourceValues": [
73       "01tDR000000EMsoYAG" // Comprehensive Product.
74       ]
75       }
76       ],
77       // EvaluationSuccessTaskGroup and EvaluationFailureTaskGroup are optional
78       // Fulfillment plan design time entities will be created.
79       "evaluationSuccessTaskGroup": // Create FulfillmentStepDefinitionGroup records
80       {
81       "name": "QuoteApproveSuccessTaskGroup",
82       "tasks": [ // create FulfillmentStepDefinition records
83       {
84       "name": "KYC check flow", // FulfillmentStepDefinition API Names
85       "type": "AutoTask",// FulfillmentStepDefinition type
86       "flowApiName": "KYC check flow", // Flow API Names
87       }
88       ]
89       },
90       "evaluationFailureTaskGroup": //Similar to EvaluationSuccessTaskGroup
91       {
92       "name": "QuoteApproveFailureTaskGroup",
93       "tasks": [
94       {
95       "name": "Vehicle ineligible",
96       "type": "AutoTask",
97       "flowApiName": "Mail Notification - Vehicle ineligible",
98       }
99       ]
100       }
101       }

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
apiNameStringUnique API name of the underwriting rule.Required63.0
descriptionStringDescription of the underwriting ruleOptional63.0
effectiveFromDateStringDate from which the underwriting rule is effective.Required63.0
effectiveToDateStringDate until which the underwriting rule is effective.Optional63.0
evaluationFailureTaskGroupEvaluation Task Group Input[]Input details for failed evaluation tasks.Optional63.0
evaluationSuccessTaskGroupEvaluation Task Group Input[]Input details for successful evaluation tasks.Optional63.0
nameStringName of the underwriting ruleRequired63.0
productPathStringName of the product path.Required63.0
ruleCriteriaInsurance Rule Criteria Input[]Rule criteria for the underwriting rule.Required63.0
ruleKeyStringUnique key for the variable defined in CML (Constraint Modeling Language) that represents the constraint for the insurance product clause. The format must be `UW__<productCode>__<stageTransitionName>__<ruleApiName>`.
If not specified, the API generates the rule key based on the defined product clause.
Optional67.0
statusStringStatus of the underwriting rule. Possible values are:
  • Active
  • Inactive
  • Draft
Optional63.0
underwritingRuleGroupInsurance Underwriting Rule Group Input[]The UnderwritingRuleGroup input data.Required63.0