Insurance Issue Contract Input
Input representation of the details, such as the quote ID, contract dates, enrollment
window, and optional term and additional fields to use to synchronously issue a group benefits
contract from a quote.
- JSON example
-
1{ 2 "quoteId": "0Q0xx0000004C9OCAU", 3 "contractStartDate": "2026-01-11", 4 "contractEndDate": "2028-01-20", 5 "transactionDetailLevel": "COVERAGE_LEVEL", 6 "additionalFields": { 7 "insuranceContractItemList": [ 8 { 9 "entity": "Contract", 10 "fields": { 11 "data": [ 12 { 13 "key": "Description", 14 "value": "Renewed for FY2026" 15 } 16 ] 17 } 18 }, 19 { 20 "entity": "InsuranceContract", 21 "fields": { 22 "data": [ 23 { 24 "key": "myCustomPickList__c", 25 "value": "Alive" 26 }, 27 { 28 "key": "EnrollmentEndDate", 29 "value": "2022-01-20" 30 }, 31 { 32 "key": "EnrollmentStartDate", 33 "value": "2021-01-20" 34 } 35 ] 36 } 37 }, 38 { 39 "entity": "ContractGroupPlan", 40 "productPath": "dentalBasic", 41 "fields": { 42 "data": [ 43 { 44 "key": "EnrollmentEndDate", 45 "value": "2025-12-31" 46 } 47 ] 48 } 49 } 50 ] 51 } 52} - Properties
-
Name Type Description Required or Optional Available Version additionalFields Insurance Contract Item Input[] List of additional fields to add to contract items. Optional 68.0 contractEndDate String End date of the contract in ISO 8601 YYYY-MM-DD format. If specified, this value overrides the contract end date that’s derived from the quote. Required 68.0 contractStartDate String Start date of the contract in ISO 8601 YYYY-MM-DD format. If specified, this value overrides the contract start date that’s derived from the quote. Required 68.0 contractTerm Integer Duration of the contract in months. If specified, this value overrides the contract term derived from the quote. Optional 68.0 enrollmentEndDate String End date for plan enrollment in YYYY-MM-DD format. Optional 68.0 enrollmentStartDate String Start date for plan enrollment in YYYY-MM-DD format. Optional 68.0 quoteId String ID of the quote from which you want to issue the contract. Required 68.0 transactionDetailLevel String Level of transaction detail to include when issuing the contract. Valid values are: PLAN_LEVEL, COVERAGE_LEVEL, CHARGE_LEVEL. The default value is PLAN_LEVEL. Optional 68.0