Input representation of endorse policy details.
JSON Example
{
"contextId": "54920265842e1b61496c38b7e2202f6f0aff8123ad2f19fe17ac68f7fc1c60b3",
"effectiveDate": "2024-01-01",
"insurancePolicy": {
"policyName": "p2_endorse_name",
"policyNumber": "p2_endorse_number"
},
"transactionRecord": {
"name": "New Endorsement"
},
"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 endorsing the policy. | Optional | 67.0 |
| contextId | String | Context ID of the quote that’s used for endorsement. | Required | 63.0 |
| effectiveDate | String | Date from when the endorsed policy version is effective. | Required | 63.0 |
| insurancePolicy | Insurance Policy Input[] | JSON structure that overrides the name and policy number of the endorsed policy version. | Optional | 63.0 |
| transactionRecord | Insurance Policy Transaction Input[] | JSON structure that overrides the transaction information. | Optional | 63.0 |