---
title: "Lusid.CleardownModule.Rule"
slug: "lusidcleardownmodulerule"
updated: 2024-08-21T08:16:38Z
published: 2024-08-21T08:16:38Z
canonical: "support.lusid.com/lusidcleardownmodulerule"
---

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

# Lusid.CleardownModule.Rule

| **Type** | **Read/write** | **Author** | **Availability** |
| --- | --- | --- | --- |
| [Data provider](/v1/docs/what-are-a-data-provider-and-a-direct-provider) | Read | FINBOURNE | Provided with LUSID |

Providing you have sufficient [access control permissions](/v1/docs/creating-policies-to-control-access-to-providers-for-different-luminesce-end-users), the `Lusid.CleardownModule.Rule` provider enables you to write a [Luminesce SQL query](/v1/docs/understanding-the-luminesce-sql-query-syntax) that retrieves [cleardown rules](/v1/docs/how-do-i-add-a-cleardown-module-with-cleardown-rules-to-a-chart-of-accounts) for one or more cleardown modules.

`Lusid.CleardownModule.Rule` returns one record per cleardown rule. The `RulePriority` field reports the order of the cleardown rule in the set belonging to a particular cleardown module; lower numbers take precedence and are evaluated earlier.

**See also**: [Lusid.CleardownModule.Rule.Writer](/v1/docs/lusidcleardownmodulerulewriter)

## Basic usage

```sql
select * from Lusid.CleardownModule.Rule where <filter-expression>;
```

## Query parameters

`Lusid.CleardownModule.Rule` has parameters that enable you to filter or refine a query.

To list available parameters, their data types, default values, and an explanation for each, run the following query using a [suitable tool](/v1/docs/what-tools-are-available-to-write-luminesce-queries):

```sql
select FieldName, DataType, ParamDefaultValue, Description from Sys.Field where TableName = 'Lusid.CleardownModule.Rule' and FieldType = 'Parameter';
```

## Data fields

By default, `Lusid.CleardownModule.Rule` returns a table of data populated with particular fields (columns). You can return a subset of these fields.

To list fields available to return, their data types, whether fields are considered 'main', and an explanation for each, run the following query using a [suitable tool](/v1/docs/what-tools-are-available-to-write-luminesce-queries):

```sql
select FieldName, DataType, IsMain, IsPrimaryKey, SampleValues, Description from Sys.Field where TableName = 'Lusid.CleardownModule.Rule' and FieldType = 'Column';
```

> **Note:** Fields marked 'main' are returned by queries that select a caret character, for example `select ^ from Lusid.CleardownModule.Rule`.

## Examples

> **Note:** For more example Luminesce SQL queries, visit our [Github repo](https://github.com/finbourne/luminesce-examples/tree/master/examples/lusid/abor).

### Example 1: Retrieve every cleardown module rule

```sql
select * from Lusid.CleardownModule.Rule;
```

### Example 2: Retrieve cleardown rules for a particular cleardown module

```sql
select * from Lusid.CleardownModule.Rule where CleardownModuleCode = 'Standard';
```