---
schema_version: "1"
id: 709973558ccb0bdfc4afe0f8c7721625d07f04d70b208a2d7f89b1d9a12317cb
title: UnderwritingRule
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/financial_services_cloud_object_reference/sforce_api_objects_underwritingrule.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_underwritingrule.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: d9e4cf6cd399d41ab129477126f09154c3d3e3015adea4e70647ec347e6f857a
description: Represents details of an underwriting rule for a product. This object is available in API version 63.0 and later.
---
# UnderwritingRule

Represents details of an underwriting rule for a product. This object is available in API version 63.0 and later.

## Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

## Fields

### ApiName

- **Type**: string
- **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update
- **Description**: The API name of the underwriting rule.

### Description

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The description about the underwriting rule.

### DynamicRuleDefinition

- **Type**: textarea
- **Properties**: Create, Nillable, Update
- **Description**: The scope and conditions specified for the dynamic rule.

### EffectiveFromDateTime

- **Type**: dateTime
- **Properties**: Filter, Nillable, Sort
- **Description**: The date and time from when the underwriting rule became active.

### EffectiveToDateTime

- **Type**: dateTime
- **Properties**: Filter, Nillable, Sort
- **Description**: The date and time after when the underwriting rules became inactive.

### EvaluationFailureTaskGroupId

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The group of tasks related to a fulfillment plan that’s executed when the rule evaluation fails.
    
    This field is a relationship field.
- **Relationship Name**: EvaluationFailureTaskGroup
- **Refers To**: FulfillmentStepDefinitionGroup

### EvaluationSuccessTaskGroupId

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The group of tasks related to a fulfillment plan that’s executed when the rule evaluation is successful.
    
    This field is a relationship field.
- **Relationship Name**: EvaluationSuccessTaskGroup
- **Refers To**: FulfillmentStepDefinitionGroup

### LastReferencedDate

- **Type**: dateTime
- **Properties**: Filter, Nillable, Sort
- **Description**: The timestamp for when the current user last viewed a record related to this record.

### LastViewedDate

- **Type**: dateTime
- **Properties**: Filter, Nillable, Sort
- **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.

### Name

- **Type**: string
- **Properties**: Create, Filter, Group, idLookup, Sort, Update
- **Description**: The name of the underwriting rule.

### ProductPath

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: A path containing the product IDs that roll up to the parent product.

### RuleKey

- **Type**: string
- **Properties**: Create, Filter, Nillable, Sort
- **Description**: The unique identifier for the CML definition of the underwriting rule in the constraint model. A null value indicates that the rule is defined in BRE.
    
    Available in API version 67.0 and later.

### Sequence

- **Type**: int
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The sequence in which the rule is executed.

### Status

- **Type**: picklist
- **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- **Description**: Specifies the status of the underwriting rule.
- **Default value**: Draft
- **Possible values**:
    - Active
    - Draft
    - Inactive

### UnderwritingRuleGroupId

- **Type**: reference
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: The underwriting rule group associated with this underwriting rule.
    
    This field is a relationship field.
- **Relationship Name**: UnderwritingRuleGroup
- **Relationship Type**: Master-detail
- **Refers To**: UnderwritingRuleGroup (the master object)

## Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

[UnderwritingRuleHistory](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.")

History is available for tracked fields of the object.