LUSID C# SDK
Public Member Functions | Protected Member Functions | Properties | List of all members
Lusid.Sdk.Model.FundDefinitionRequest Class Reference

The request used to create a Fund. More...

Inheritance diagram for Lusid.Sdk.Model.FundDefinitionRequest:
Inheritance graph
[legend]

Public Member Functions

 FundDefinitionRequest (string code=default(string), string displayName=default(string), string description=default(string), string baseCurrency=default(string), string investorStructure=default(string), List< PortfolioEntityId > portfolioIds=default(List< PortfolioEntityId >), ResourceId fundConfigurationId=default(ResourceId), List< string > shareClassInstrumentScopes=default(List< string >), List< InstrumentResolutionDetail > shareClassInstruments=default(List< InstrumentResolutionDetail >), string type=default(string), DateTimeOffset inceptionDate=default(DateTimeOffset), int? decimalPlaces=default(int?), NavTypeDefinition primaryNavType=default(NavTypeDefinition), List< NavTypeDefinition > additionalNavTypes=default(List< NavTypeDefinition >), Dictionary< string, Property > properties=default(Dictionary< string, Property >), bool createInstrument=default(bool), ApportionmentMethodProperty apportionmentMethodProperty=default(ApportionmentMethodProperty), List< ShareClassDefinition > shareClasses=default(List< ShareClassDefinition >))
 Initializes a new instance of the FundDefinitionRequest class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
virtual string ToJson ()
 Returns the JSON string presentation of the object More...
 
override bool Equals (object input)
 Returns true if objects are equal More...
 
bool Equals (FundDefinitionRequest input)
 Returns true if FundDefinitionRequest instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 FundDefinitionRequest ()
 Initializes a new instance of the FundDefinitionRequest class. More...
 

Properties

string Code [get, set]
 The code given for the Fund. More...
 
string DisplayName [get, set]
 The name of the Fund. More...
 
string Description [get, set]
 A description for the Fund. More...
 
string BaseCurrency [get, set]
 The base currency of the Fund in ISO 4217 currency code format. All portfolios must be of a matching base currency. More...
 
string InvestorStructure [get, set]
 The Investor structure to be used by the Fund. Available values: NonUnitised, Classes. More...
 
List< PortfolioEntityIdPortfolioIds [get, set]
 A list of the Portfolio IDs associated with the fund, which are part of the Fund. Note: These must all have the same base currency, which must also match the Fund Base Currency. More...
 
ResourceId FundConfigurationId [get, set]
 Gets or Sets FundConfigurationId More...
 
List< string > ShareClassInstrumentScopes [get, set]
 The scopes in which the instruments lie, currently limited to one. More...
 
List< InstrumentResolutionDetailShareClassInstruments [get, set]
 Details the user-provided instrument identifiers and the instrument resolved from them. These would be decommissioned in favour of the new AllocationGroups and ShareClasses structures. More...
 
string Type [get, set]
 The type of fund. Available values: Standalone, Master, Feeder. More...
 
DateTimeOffset InceptionDate [get, set]
 Inception date of the Fund More...
 
int? DecimalPlaces [get, set]
 Number of decimal places for reporting More...
 
NavTypeDefinition PrimaryNavType [get, set]
 Gets or Sets PrimaryNavType More...
 
List< NavTypeDefinitionAdditionalNavTypes [get, set]
 The definitions for any additional NAVs on the Fund. More...
 
Dictionary< string, PropertyProperties [get, set]
 A set of properties for the Fund. More...
 
bool CreateInstrument [get, set]
 Whether to create instruments for the Fund&#39;s share classes, series, or partner classes upon creation. Defaults to false. More...
 
ApportionmentMethodProperty ApportionmentMethodProperty [get, set]
 Gets or Sets ApportionmentMethodProperty More...
 
List< ShareClassDefinitionShareClasses [get, set]
 An optional list of Share Class definitions for the Fund. More...
 

Detailed Description

The request used to create a Fund.

Constructor & Destructor Documentation

◆ FundDefinitionRequest() [1/2]

Lusid.Sdk.Model.FundDefinitionRequest.FundDefinitionRequest ( )
inlineprotected

Initializes a new instance of the FundDefinitionRequest class.

◆ FundDefinitionRequest() [2/2]

Lusid.Sdk.Model.FundDefinitionRequest.FundDefinitionRequest ( string  code = default(string),
string  displayName = default(string),
string  description = default(string),
string  baseCurrency = default(string),
string  investorStructure = default(string),
List< PortfolioEntityId portfolioIds = default(List<PortfolioEntityId>),
ResourceId  fundConfigurationId = default(ResourceId),
List< string >  shareClassInstrumentScopes = default(List<string>),
List< InstrumentResolutionDetail shareClassInstruments = default(List<InstrumentResolutionDetail>),
string  type = default(string),
DateTimeOffset  inceptionDate = default(DateTimeOffset),
int?  decimalPlaces = default(int?),
NavTypeDefinition  primaryNavType = default(NavTypeDefinition),
List< NavTypeDefinition additionalNavTypes = default(List<NavTypeDefinition>),
Dictionary< string, Property properties = default(Dictionary<string, Property>),
bool  createInstrument = default(bool),
ApportionmentMethodProperty  apportionmentMethodProperty = default(ApportionmentMethodProperty),
List< ShareClassDefinition shareClasses = default(List<ShareClassDefinition>) 
)
inline

Initializes a new instance of the FundDefinitionRequest class.

Parameters
codeThe code given for the Fund. (required).
displayNameThe name of the Fund. (required).
descriptionA description for the Fund..
baseCurrencyThe base currency of the Fund in ISO 4217 currency code format. All portfolios must be of a matching base currency. (required).
investorStructureThe Investor structure to be used by the Fund. Available values: NonUnitised, Classes..
portfolioIdsA list of the Portfolio IDs associated with the fund, which are part of the Fund. Note: These must all have the same base currency, which must also match the Fund Base Currency. (required).
fundConfigurationIdfundConfigurationId (required).
shareClassInstrumentScopesThe scopes in which the instruments lie, currently limited to one..
shareClassInstrumentsDetails the user-provided instrument identifiers and the instrument resolved from them. These would be decommissioned in favour of the new AllocationGroups and ShareClasses structures..
typeThe type of fund. Available values: Standalone, Master, Feeder..
inceptionDateInception date of the Fund (required).
decimalPlacesNumber of decimal places for reporting.
primaryNavTypeprimaryNavType (required).
additionalNavTypesThe definitions for any additional NAVs on the Fund..
propertiesA set of properties for the Fund..
createInstrumentWhether to create instruments for the Fund&#39;s share classes, series, or partner classes upon creation. Defaults to false..
apportionmentMethodPropertyapportionmentMethodProperty.
shareClassesAn optional list of Share Class definitions for the Fund..

Member Function Documentation

◆ Equals() [1/2]

bool Lusid.Sdk.Model.FundDefinitionRequest.Equals ( FundDefinitionRequest  input)
inline

Returns true if FundDefinitionRequest instances are equal

Parameters
inputInstance of FundDefinitionRequest to be compared
Returns
Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.FundDefinitionRequest.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.FundDefinitionRequest.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.FundDefinitionRequest.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.FundDefinitionRequest.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AdditionalNavTypes

List<NavTypeDefinition> Lusid.Sdk.Model.FundDefinitionRequest.AdditionalNavTypes
getset

The definitions for any additional NAVs on the Fund.

The definitions for any additional NAVs on the Fund.

◆ ApportionmentMethodProperty

ApportionmentMethodProperty Lusid.Sdk.Model.FundDefinitionRequest.ApportionmentMethodProperty
getset

◆ BaseCurrency

string Lusid.Sdk.Model.FundDefinitionRequest.BaseCurrency
getset

The base currency of the Fund in ISO 4217 currency code format. All portfolios must be of a matching base currency.

The base currency of the Fund in ISO 4217 currency code format. All portfolios must be of a matching base currency.

◆ Code

string Lusid.Sdk.Model.FundDefinitionRequest.Code
getset

The code given for the Fund.

The code given for the Fund.

◆ CreateInstrument

bool Lusid.Sdk.Model.FundDefinitionRequest.CreateInstrument
getset

Whether to create instruments for the Fund&#39;s share classes, series, or partner classes upon creation. Defaults to false.

Whether to create instruments for the Fund&#39;s share classes, series, or partner classes upon creation. Defaults to false.

◆ DecimalPlaces

int? Lusid.Sdk.Model.FundDefinitionRequest.DecimalPlaces
getset

Number of decimal places for reporting

Number of decimal places for reporting

◆ Description

string Lusid.Sdk.Model.FundDefinitionRequest.Description
getset

A description for the Fund.

A description for the Fund.

◆ DisplayName

string Lusid.Sdk.Model.FundDefinitionRequest.DisplayName
getset

The name of the Fund.

The name of the Fund.

◆ FundConfigurationId

ResourceId Lusid.Sdk.Model.FundDefinitionRequest.FundConfigurationId
getset

Gets or Sets FundConfigurationId

◆ InceptionDate

DateTimeOffset Lusid.Sdk.Model.FundDefinitionRequest.InceptionDate
getset

Inception date of the Fund

Inception date of the Fund

◆ InvestorStructure

string Lusid.Sdk.Model.FundDefinitionRequest.InvestorStructure
getset

The Investor structure to be used by the Fund. Available values: NonUnitised, Classes.

The Investor structure to be used by the Fund. Available values: NonUnitised, Classes.

◆ PortfolioIds

List<PortfolioEntityId> Lusid.Sdk.Model.FundDefinitionRequest.PortfolioIds
getset

A list of the Portfolio IDs associated with the fund, which are part of the Fund. Note: These must all have the same base currency, which must also match the Fund Base Currency.

A list of the Portfolio IDs associated with the fund, which are part of the Fund. Note: These must all have the same base currency, which must also match the Fund Base Currency.

◆ PrimaryNavType

NavTypeDefinition Lusid.Sdk.Model.FundDefinitionRequest.PrimaryNavType
getset

Gets or Sets PrimaryNavType

◆ Properties

Dictionary<string, Property> Lusid.Sdk.Model.FundDefinitionRequest.Properties
getset

A set of properties for the Fund.

A set of properties for the Fund.

◆ ShareClasses

List<ShareClassDefinition> Lusid.Sdk.Model.FundDefinitionRequest.ShareClasses
getset

An optional list of Share Class definitions for the Fund.

An optional list of Share Class definitions for the Fund.

◆ ShareClassInstruments

List<InstrumentResolutionDetail> Lusid.Sdk.Model.FundDefinitionRequest.ShareClassInstruments
getset

Details the user-provided instrument identifiers and the instrument resolved from them. These would be decommissioned in favour of the new AllocationGroups and ShareClasses structures.

Details the user-provided instrument identifiers and the instrument resolved from them. These would be decommissioned in favour of the new AllocationGroups and ShareClasses structures.

◆ ShareClassInstrumentScopes

List<string> Lusid.Sdk.Model.FundDefinitionRequest.ShareClassInstrumentScopes
getset

The scopes in which the instruments lie, currently limited to one.

The scopes in which the instruments lie, currently limited to one.

◆ Type

string Lusid.Sdk.Model.FundDefinitionRequest.Type
getset

The type of fund. Available values: Standalone, Master, Feeder.

The type of fund. Available values: Standalone, Master, Feeder.


The documentation for this class was generated from the following file: