> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# IRuleError

> IRuleError describes a rule, format, or merging error in a FlexiCapture document, exposing the message text, rule name, error type, and associated fields.

## What it does

Represents a rule error, format error or merging error in the document.

<a id="webverificationavailableinterface" />

<Note>
  Some methods and properties of this object are not available on the Web Verification Station for checking rules locally. The methods and properties that are not supported are marked with an asterisk (\*).
</Note>

## Methods

| **Definition**                                                   | **Description**                                           |
| ---------------------------------------------------------------- | --------------------------------------------------------- |
| GetFields() : [IFields](/flexi-capture/appendix/scripts/ifields) | Returns the fields associated with the given field error. |

## Properties

| **Name**                                          | **Type**                                                         | **Access** | **Description**                                                                                         |
| ------------------------------------------------- | ---------------------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------- |
| IsWarning                                         | bool                                                             | Read-only  | Specifies whether the message is a warning.                                                             |
| Message                                           | string                                                           | Read-only  | The text of the error message.                                                                          |
| RuleName                                          | string                                                           | Read-only  | The name of the rule that caused the error. For format and merging errors, an empty string is returned. |
| RuleTags [\*](#webverificationavailableinterface) | [IRuleTags](/flexi-capture/appendix/scripts/iruletags)           | Read-only  | Returns the [IRuleTags](/flexi-capture/appendix/scripts/iruletags) object with rule tags.               |
| Type                                              | [TRuleErrorType](/flexi-capture/appendix/scripts/truleerrortype) | Read-only  | The error type.                                                                                         |