Insurance Product Surcharge (PATCH)

Update or fetch a product surcharge for a root product.

Resource

1/connect/insurance/product-surcharges/productSurchargeId

Resource example

1https://yourInstance.salesforce.com/services/data/v66.0/connect/insurance/product-surcharges/productSurchargeId

Available version

63.0

HTTP methods

PATCH

Request body for PATCH

JSON example

1{
2       "name": "AutoVehicleTax",
3       "effectiveFromDate": "2024-05-30T10:30:00",
4       "effectiveToDate": "2024-11-01T10:30:00",
5       "isProrationEligible": true,
6       "isRefundEligible": true,
7       "isActive": true,
8       "productPath": "01tDR000000EMslYAG/11BDR00000000T72AI", // "Auto Gold/Auto Vehicle"
9       "ruleDefinition": [ // ruleDefinition will be replaced as a whole. Updating only one condition is not supported
10       {
11       "conditions": [
12       {
13       "contextTagName": "SalesTransactionItemAttribute",
14       "operator": "LessThan",
15       "conditionIndex": 1,
16       "attributeName": "Annual Milage",
17       "attributePicklistValueId": null,
18       "type": "Attribute",
19       "attributeId": "0tjDR00000000VGYAY",
20       "dataType": "Number",
21       "values": [
22       "50000"
23       ]
24       }
25       ],
26       "rootObjectId": "01tDR000000EMslYAG", // Auto Gold.
27       "productRelatedComponent" : "",
28       "criteriaIndex": 1,
29       "sourceContextTagName": "ProductBasedOn",
30       "sourceOperator": "Equals",
31       "sourceDataType": "String",
32       "sourceValues": [
33       "11BDR00000000T72AI" // Auto Vehicle.
34       ]
35       },
36       {
37       "conditions": [
38       {
39       "contextTagName": "SalesTransactionItemAttribute",
40       "operator": "LessThan",
41       "conditionIndex": 1,
42       "attributeName": "Comprehensive Deductible",
43       "type": "Attribute",
44       "attributePicklistValueId": null,
45       "attributeId": "0tjDR00000000UaYAI",
46       "dataType": "Number",
47       "values": [
48       "$5000"
49       ]
50       }
51       ],
52       "rootObjectId": "01tDR000000EMslYAG", // Auto Bundle
53       "productRelatedComponent" : "",
54       "criteriaIndex": 2,
55       "sourceContextTagName": "Product",
56       "sourceOperator": "Equals",
57       "sourceDataType": "String",
58       "sourceValues": [
59       "01tDR000000EMsoYAG" // Comprehensive Product.
60       ]
61       }
62       ]
63       }

Properties

Name	Type	Description	Required or Optional	Available Version
`effectiveFromDate`	String	Effective from date of the product surcharge.	Optional	63.0
`effectiveToDate`	String	Effective to date of the product surcharge.	Optional	63.0
`isActive`	Boolean	Indicates whether the product surcharge is active (`true`) or not (`false`). Currently, only active product surcharges are supported.	Optional	63.0
`isProrationAllowed`	Boolean	Indicates whether the product surcharge is allowed for proration (`true`) or not (`false`).	Optional	63.0
`isRefundAllowed`	Boolean	Indicates whether the product surcharge is allowed for refund (`true`) or not (`false`).	Optional	63.0
`name`	String	Name of the product surcharge.	Optional	63.0
`productPath`	String	A path containing the product IDs that roll up to the parent product.	Optional	63.0
`productRelatedComponentId`	String	Product related component associated with the product surcharge.	Optional	63.0
`ruleApiName`	String	Rule API name associated with product surcharge. You can set the ruleApiName with the POST or PATCH method. Once set, this parameter can’t be changed. If you set the ruleApiName in the request body, you must also set the ruleCriteria.	Optional	63.0
`ruleCriteria`		Rule criteria for the dynamic rule.	Optional	63.0

Response body for PATCH

Product Surcharge Patch

Insurance Developer Guide

Insurance Product Surcharge (PATCH)