Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

InsPlcyLimitConsumptionRule

Represents configuration for how policy limit consumption rule applies to an insurance policy product, including consumption mode and product binding.

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

InsPlcyLimitConsumptionRule components have the suffix .insPlcyLimitConsumptionRule and are stored in the InsPlcyLimitConsumptionRules folder.

Version

InsPlcyLimitConsumptionRule components are available in API version 67.0 and later.

Special Access Rules

There are no additional access requirements that are specific to this type.

Fields

Field Name	Description
consumptionMode	Field Type PolicyLimitConsumptionMode (enumeration of type string) Description Required. Specifies how the nested limits in the insurance policy are consumed when a claim is paid out. Valid value is: `Full`
isEnabled	Field Type boolean Description Indicates whether the policy limit consumption configuration is enabled (`true`) or not (`false`). The default value is `false`.
masterLabel	Field Type string Description Required. A user-friendly name for InsPlcyLimitConsumptionRule, which is defined when the InsPlcyLimitConsumptionRule is created.
policyProduct	Field Type string Description Required. ID of the root product for the insurance policy that this configuration applies to.

Declarative Metadata Sample Definition

The following is an example of a InsPlcyLimitConsumptionRule component.

1<?xml version="1.0" encoding="UTF-8"?>
2<InsPlcyLimitConsumptionRule xmlns="http://soap.sforce.com/2006/04/metadata">
3    <policyProduct>AutoPolicyCoverageProduct</policyProduct>
4    <consumptionMode>Full</consumptionMode>
5    <isEnabled>false</isEnabled>
6    <masterLabel>Insurance Policy Limit Consumption Rule</masterLabel>
7</InsPlcyLimitConsumptionRule>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>InsPlcyLimitConsumptionRule</name>
6    </types>
7    <version>68.0</version>
8</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide