You are here:
InsContractServiceStd:createUpdateContract
Use this service to create or update a contract for the given quote.
Name, SourceQuote, SourceOpportunity and Pricebook fields of Contract entity. Class: InsContractServiceStd
Method: createUpdateContract
How It Works
-
This service looks for the
inputKeyvalue in the product JSON of a quote, which contains theproductConfigurationDetailmap,additionalFields,QuoteId, and AccountId. -
The
productConfigurationDetail contains the data of quote line items of given Quote, which the service uses to create contract group plans. -
quoteId is ID of the Quote for which the service creates the contract. AccountIdis the ID of Account which is linked to the contract. -
Based on
QuoteId,AccountIdand additionalFields, the service creates the Contract and populate its fields. Corresponding to this Contract, the service creates an Insurance Contract and populates its fields usingadditionalFieldsdata. -
If a
contractIdis specified, the service updates the contract. -
If a
contractIdis not specified, the service creates a newcontractId.
Remote Options
Options |
Description |
|---|---|
|
Optional Id of the contract. |
|
Optional Name of the pricebook. |
|
Required. Input JSON of the contract and contract group plans to be created. It has |
Service Behavior
Understand how different inputs affect the service outputs.
Input |
Output |
|---|---|
No contractId and no inputJson
|
The service creates no contract. |
No contractId and inputJson
|
The service creates a new Contract, Insurance Contract, and Contract Group Plans. |
contractId and no inputJson |
The service updates no contract. |
contractId and inputJson
|
The service updates existing Contract, Insurance Contract, and Contract Group Plans. |
Input JSON
This
sample shows a new contract input JSON, where contractJson is the
input key and productConfigurationDetail contains the product JSON:
{
"productConfigurationDetail": {
"records": [
{
"displaySequence": 0,
"currencySymbol": "$",
"currencyCode": "USD",
"Id": "0QLRO0000009kbn4AA",
"productId": "01tRO000000QnqrYAC",
"Product2Id": "01tRO000000QnqrYAC",
"LineNumber": "00000019",
"CreatedDate": "2022-04-14T08:32:35.000+0000",
"QuoteId": "0Q0RO0000000vtw0AA",
"Price": 1,
"UnitPrice": 1,
"vlocityins6__RecordTypeName__c": "Product",
"vlocityins6__Type__c": "Dental",
"TotalPrice": 1,
"LastModifiedDate": "2022-04-14T08:32:35.000+0000",
"vlocityins6__PricingSource__c": "TotalPremium",
"vlocityins6__ProductName__c": "Dental Standard",
"vlocityins6__TotalAmount__c": 1,
"vlocityins6__ProductChildItemSequence__c": 0,
"needReprice": false,
"vlocityins6__NeedReprice__c": false,
"vlocityins6__RelationshipType__c": "Child",
"quoteLineItemId": "0QLRO0000009kbn4AA",
"productName": "Dental Standard",
"ProductCode": "dentalStandard",
"recordType": "Product",
"lineRecordType": "Product",
"Name": "Dental Standard",
"hasAttributes": true,
"coverageCount": 0,
"hasCoverages": false
},
{
"displaySequence": 0,
"currencySymbol": "$",
"currencyCode": "USD",
"Id": "0QLRO0000009kbs4AA",
"productId": "01tRO000000QnWnYAK",
"Product2Id": "01tRO000000QnWnYAK",
"LineNumber": "00000018",
"CreatedDate": "2022-04-14T08:30:59.000+0000",
"QuoteId": "0Q0RO0000000vtw0AA",
"Price": 7425,
"UnitPrice": 7425,
"vlocityins6__RecordTypeName__c": "Product",
"vlocityins6__Type__c": "Dental",
"TotalPrice": 7425,
"LastModifiedDate": "2022-05-31T02:35:56.000+0000",
"vlocityins6__PricingSource__c": "TotalPremium",
"vlocityins6__ProductName__c": "Dental Premium",
"vlocityins6__TotalAmount__c": 7425,
"vlocityins6__ProductChildItemSequence__c": 0,
"needReprice": false,
"vlocityins6__NeedReprice__c": false,
"vlocityins6__RelationshipType__c": "Child",
"quoteLineItemId": "0QLRO0000009kbs4AA",
"productName": "Dental Premium",
"ProductCode": "dentalPremium",
"recordType": "Product",
"lineRecordType": "Product",
"Name": "Dental Premium",
"hasAttributes": true,
"coverageCount": 0,
"hasCoverages": false
}],
"totalSize": 1
},
"additionalFields" : {
"EnrollmentWaitingPeriod": "30",
"Name": "contractAcc-Group Contract",
"ContractTerm": 12,
"EnrollmentCensusId": "0rfRO00000000WRYAY"
},
"AccountId" : "001RO000003fLhQYAU",
"QuoteId" : "0Q0RO0000001DlH0AU"
}Output JSON (when service creates a contract)
When creating a new contract, the contractId of the new contract is returned in the output JSON. When updating an existing contract, no output JSON is returned.
{
"contractId: "0rfRN0000000014YAA",
"errorCode": "INVOKE-200",
"error": "OK"
}Output JSON (when service returns an error)
The service returns an empty string if it encounters any exceptions. Also, it returns a list of members with errors. Each list item consists of input member data and errors.
{
"contractId: "",
"errors" : "List of errors, if any",
"errorCode": "INVOKE-200",
"error": "OK"
}