# CreateDerivedPropertyDefinitionRequest

## Properties

| Name | Type | Required | Description |
|------|------|----------|-------------|
| **domain** | **str** | Required | The domain that the property exists in. Not all available values are currently supported, please check the documentation: https://support.lusid.com/knowledgebase/article/KA-01719/. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType. |
| **scope** | **str** | Required | The scope that the property exists in. |
| **code** | **str** | Required | The code of the property. Together with the domain and scope this uniquely identifies the property. |
| **display_name** | **str** | Required | The display name of the property. |
| **data_type_id** | [ResourceId](ResourceId.md) | Required | *No description available.* |
| **property_description** | **str** | Optional | Describes the property |
| **derivation_formula** | **str** | Required | The rule that defines how data is composed for a derived property. |
| **is_filterable** | **bool** | Required | Bool indicating whether the values of this property are fitlerable, this is true for all non-derived property defintions.  For a derived definition this must be set true to enable filtering. |
| **value_format** | **str** | Optional | The format in which values for this property definition should be represented. Available values: Text, Html. |
| **custom_entity_type** | **str** | Optional | The custom entity type that this derived property definition can be applied to. |


## Usage

### Creating from keyword arguments

```python
from finbourne.sdk.services.lusid.models.CreateDerivedPropertyDefinitionRequest import CreateDerivedPropertyDefinitionRequest

instance = CreateDerivedPropertyDefinitionRequest(
    domain="...",  # required — The domain that the property exists in. Not all available values are currently supported, please check the documentation: https://support.lusid.com/knowledgebase/article/KA-01719/. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType.
    scope="...",  # required — The scope that the property exists in.
    code="...",  # required — The code of the property. Together with the domain and scope this uniquely identifies the property.
    display_name="...",  # required — The display name of the property.
    data_type_id=ResourceId(...),  # required
    property_description="...",  # optional — Describes the property
    derivation_formula="...",  # required — The rule that defines how data is composed for a derived property.
    is_filterable=True,  # required — Bool indicating whether the values of this property are fitlerable, this is true for all non-derived property defintions.  For a derived definition this must be set true to enable filtering.
    value_format="...",  # optional — The format in which values for this property definition should be represented. Available values: Text, Html.
    custom_entity_type="..."  # optional — The custom entity type that this derived property definition can be applied to.
)
```

- [ResourceId](ResourceId.md)


[Back to top](#) · [Back to API list](../../api_endpoints.md) · [Back to Model list](../../models.md) · [Back to README](../../../../../README.md)

