Input representation of the details to renew an insurance policy.
JSON Example
{
"contextId": "54920265842e1b61496c38b7e2202f6f0aff8123ad2f19fe17ac68f7fc1c60b3",
"insurancePolicy": {
"policyName": "Demo Test Policy 9",
"policyNumber": "test renew policy",
"effectiveFromDate": "2025-03-15",
"effectiveToDate": "2026-03-15"
},
"transactionRecord":{
"name": "Renew Payment"
},
"billingRecord": {
"billDayOfMonth": 15,
"billToContact": "003xx000000001aEAA"
},
"additionalFields":{
"additionalFieldsList":[
{
"additionalFieldsMapValue":{
"instanceKey":"autoRoot",
"fields":{
"Checkbox__c":"true",
"Currency__c":123456,
"Date__c":"2024-11-30",
"DateTime__c":"2024-12-31T01:34:00.000Z",
"Email__c":"testuser@sf.com"
}
}
}
{
"additionalFieldsMapValue":{
"instanceKey":"autoDriver",
"fields":{
"TextEncr__c":"233345675676",
"Url__c":"https://thisistest.com",
"Time__c":"12:05:00.000Z"
}
}
}
]
}
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| additionalFields | Additional Fields Map Value[] | JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalFields take precedence over the context or the insurancePolicy JSON. This is applicable only for the endorsed policy version. Address and Geolocation field types are not supported as additional fields. | Optional | 63.0 |
| billingRecord | Insurance Policy Billing Details | Billing details to calculate billing when renewing the policy. | Optional | 67.0 |
| contextId | String | Priced context ID of the policy or quote that's used to renew the policy. | Required | 63.0 |
| insurancePolicy | Insurance Policy Input[] | JSON structure that’s used to renew the policy. It contains fields and values from the Insurance Policy object. | Optional | 63.0 |
| transactionRecord | Insurance Policy Transaction Input[] | JSON structure that's used to override the transaction information. | Optional | 63.0 |