Product Surcharge Post Input

Input representation of product surcharge details.

JSON Example

1{
2  "name": "AutoVehicleTax",
3  "surchargeId": "01cLO000000EMslOKL",
4  "rootProductId": "01tDR000000EMslYAG",
5  "productPath": "01tDR000000EMslYAG/11BDR00000000T72AI",
6  "effectiveFromDate": "2024-05-30T10:30:00",
7  "effectiveToDate": "2024-11-01T10:30:00",
8  "isProrationEligible": true,
9  "isRefundEligible": true,
10  "isActive": true,
11  "ruleApiName": "autoVehicleTaxRule",
12  "ruleCriteria": [
13    {
14      "conditions": [
15        {
16          "contextTagName": "SalesTransactionItemAttribute",
17          "operator": "LessThan",
18          "conditionIndex": 1,
19          "attributeName": "Annual Milage",
20          "attributePicklistValueId": null,
21          "type": "Attribute",
22          "attributeId": "0tjDR00000000VGYAY",
23          "dataType": "Number",
24          "values": [
25            "50000"
26          ]
27        }
28      ],
29      "rootObjectId": "01tDR000000EMslYAG",
30      "productRelatedComponent": "",
31      "criteriaIndex": 1,
32      "sourceContextTagName": "ProductBasedOn",
33      "sourceOperator": "Equals",
34      "sourceDataType": "String",
35      "sourceValues": [
36        "11BDR00000000T72AI"
37      ]
38    }
39  ],
40  "sequenceNumber": 0
41}

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.	Required	63.0
`productPath`	String	A path containing the product IDs that roll up to the parent product.	Required	63.0
`productRelatedComponentId`	String	ID of the product related component associated with the product surcharge.	Optional	63.0
`rootProductId`	String	ID of the root product associated with the product surcharge.	Required	63.0
`ruleApiName`	String	Rule API name associated with product surcharge.	Optional	63.0
`ruleCriteria`	Insurance Rule Criteria Input[]	Rule criteria of the dynamic rule for the product surcharge.	Optional	63.0
`sequenceNumber`	Integer	Order in which surcharges are calculated when multiple surcharges are applied to a product.	Optional	67.0
`surchargeId`	String	ID of the surcharge associated with the product surcharge.	Required	63.0