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

Fee More...

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

Public Member Functions

 Fee (string href=default(string), string feeCode=default(string), ResourceId feeTypeId=default(ResourceId), string displayName=default(string), string description=default(string), string origin=default(string), string calculationBase=default(string), string accrualCurrency=default(string), string treatment=default(string), decimal? totalAnnualAccrualAmount=default(decimal?), decimal? feeRatePercentage=default(decimal?), string payableFrequency=default(string), string businessDayConvention=default(string), DateTimeOffset startDate=default(DateTimeOffset), DateTimeOffset endDate=default(DateTimeOffset), DayMonth anchorDate=default(DayMonth), Dictionary< string, Property > properties=default(Dictionary< string, Property >), ModelVersion varVersion=default(ModelVersion), ResourceId portfolioId=default(ResourceId), List< string > shareClasses=default(List< string >), string navTypeCode=default(string), List< Link > links=default(List< Link >))
 Initializes a new instance of the Fee 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 (Fee input)
 Returns true if Fee instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

string Href [get, set]
 The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime. More...
 
string FeeCode [get, set]
 The code of the Fee. More...
 
ResourceId FeeTypeId [get, set]
 Gets or Sets FeeTypeId More...
 
string DisplayName [get, set]
 The name of the Fee. More...
 
string Description [get, set]
 A description for the Fee. More...
 
string Origin [get, set]
 The origin or source of the Fee accrual. More...
 
string CalculationBase [get, set]
 The calculation base for a Fee that is calculated using a percentage (TotalAnnualAccrualAmount and CalculationBase cannot both be present). When the Fee is a ShareClass Fee (i.e: when ShareClasses contains at least one value), each of the following would be a valid CalculationBase: &quot;10000.00&quot;, &quot;ShareClass.GAV&quot;, &quot;ShareClass.GAV - ShareClass.Fees[ShareClassFeeCode1].Amount&quot;, &quot;ShareClass.Fees[ShareClassFeeCode1].CalculationBase&quot;. When the Fee is a NonShareClassSpecific Fee (i.e: when ShareClasses contains no values), each of the following would be a valid CalculationBase: &quot;10000.00&quot;, &quot;GAV&quot;, &quot;GAV - Fees[NonClassSpecificFeeCode1].Amount&quot;, &quot;Fees[NonClassSpecificFeeCode1].CalculationBase&quot;. More...
 
string AccrualCurrency [get, set]
 The accrual currency. More...
 
string Treatment [get, set]
 The accrual period of the Fee. Available values: Daily, Monthly. More...
 
decimal? TotalAnnualAccrualAmount [get, set]
 The total annual accrued amount for the Fee. (TotalAnnualAccrualAmount and CalculationBase cannot both be present) More...
 
decimal? FeeRatePercentage [get, set]
 The fee rate percentage. (Required when CalculationBase is present and not compatible with TotalAnnualAccrualAmount) More...
 
string PayableFrequency [get, set]
 The payable frequency for the Fee. Available values: Annually, Quarterly, Monthly. More...
 
string BusinessDayConvention [get, set]
 The business day convention to use for Fee calculations on weekends or holidays. Available values: None, P, Previous, F, Following. More...
 
DateTimeOffset StartDate [get, set]
 The start date of the Fee. More...
 
DateTimeOffset EndDate [get, set]
 The end date of the Fee. More...
 
DayMonth AnchorDate [get, set]
 Gets or Sets AnchorDate More...
 
Dictionary< string, PropertyProperties [get, set]
 The Fee properties. These will be from the &#39;Fee&#39; domain. More...
 
ModelVersion VarVersion [get, set]
 Gets or Sets VarVersion More...
 
ResourceId PortfolioId [get, set]
 Gets or Sets PortfolioId More...
 
List< string > ShareClasses [get, set]
 The short codes of the ShareClasses that the Fee should be applied to. Optional: if this is null or empty, then the Fee will be divided between all the ShareClasses of the Fund according to the capital ratio. More...
 
string NavTypeCode [get, set]
 When provided runs against the specified NAV Type, otherwise the Primary NAV Type will be used. More...
 
List< LinkLinks [get, set]
 Gets or Sets Links More...
 

Detailed Description

Fee

Constructor & Destructor Documentation

◆ Fee() [1/2]

Lusid.Sdk.Model.Fee.Fee ( )
inlineprotected

Initializes a new instance of the Fee class.

◆ Fee() [2/2]

Lusid.Sdk.Model.Fee.Fee ( string  href = default(string),
string  feeCode = default(string),
ResourceId  feeTypeId = default(ResourceId),
string  displayName = default(string),
string  description = default(string),
string  origin = default(string),
string  calculationBase = default(string),
string  accrualCurrency = default(string),
string  treatment = default(string),
decimal?  totalAnnualAccrualAmount = default(decimal?),
decimal?  feeRatePercentage = default(decimal?),
string  payableFrequency = default(string),
string  businessDayConvention = default(string),
DateTimeOffset  startDate = default(DateTimeOffset),
DateTimeOffset  endDate = default(DateTimeOffset),
DayMonth  anchorDate = default(DayMonth),
Dictionary< string, Property properties = default(Dictionary<string, Property>),
ModelVersion  varVersion = default(ModelVersion),
ResourceId  portfolioId = default(ResourceId),
List< string >  shareClasses = default(List<string>),
string  navTypeCode = default(string),
List< Link links = default(List<Link>) 
)
inline

Initializes a new instance of the Fee class.

Parameters
hrefThe specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime..
feeCodeThe code of the Fee..
feeTypeIdfeeTypeId (required).
displayNameThe name of the Fee. (required).
descriptionA description for the Fee..
originThe origin or source of the Fee accrual..
calculationBaseThe calculation base for a Fee that is calculated using a percentage (TotalAnnualAccrualAmount and CalculationBase cannot both be present). When the Fee is a ShareClass Fee (i.e: when ShareClasses contains at least one value), each of the following would be a valid CalculationBase: &quot;10000.00&quot;, &quot;ShareClass.GAV&quot;, &quot;ShareClass.GAV - ShareClass.Fees[ShareClassFeeCode1].Amount&quot;, &quot;ShareClass.Fees[ShareClassFeeCode1].CalculationBase&quot;. When the Fee is a NonShareClassSpecific Fee (i.e: when ShareClasses contains no values), each of the following would be a valid CalculationBase: &quot;10000.00&quot;, &quot;GAV&quot;, &quot;GAV - Fees[NonClassSpecificFeeCode1].Amount&quot;, &quot;Fees[NonClassSpecificFeeCode1].CalculationBase&quot;. .
accrualCurrencyThe accrual currency. (required).
treatmentThe accrual period of the Fee. Available values: Daily, Monthly. (required).
totalAnnualAccrualAmountThe total annual accrued amount for the Fee. (TotalAnnualAccrualAmount and CalculationBase cannot both be present).
feeRatePercentageThe fee rate percentage. (Required when CalculationBase is present and not compatible with TotalAnnualAccrualAmount).
payableFrequencyThe payable frequency for the Fee. Available values: Annually, Quarterly, Monthly. (required).
businessDayConventionThe business day convention to use for Fee calculations on weekends or holidays. Available values: None, P, Previous, F, Following. (required).
startDateThe start date of the Fee. (required).
endDateThe end date of the Fee..
anchorDateanchorDate.
propertiesThe Fee properties. These will be from the &#39;Fee&#39; domain..
varVersionvarVersion.
portfolioIdportfolioId.
shareClassesThe short codes of the ShareClasses that the Fee should be applied to. Optional: if this is null or empty, then the Fee will be divided between all the ShareClasses of the Fund according to the capital ratio..
navTypeCodeWhen provided runs against the specified NAV Type, otherwise the Primary NAV Type will be used..
linkslinks.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if Fee instances are equal

Parameters
inputInstance of Fee to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AccrualCurrency

string Lusid.Sdk.Model.Fee.AccrualCurrency
getset

The accrual currency.

The accrual currency.

◆ AnchorDate

DayMonth Lusid.Sdk.Model.Fee.AnchorDate
getset

Gets or Sets AnchorDate

◆ BusinessDayConvention

string Lusid.Sdk.Model.Fee.BusinessDayConvention
getset

The business day convention to use for Fee calculations on weekends or holidays. Available values: None, P, Previous, F, Following.

The business day convention to use for Fee calculations on weekends or holidays. Available values: None, P, Previous, F, Following.

◆ CalculationBase

string Lusid.Sdk.Model.Fee.CalculationBase
getset

The calculation base for a Fee that is calculated using a percentage (TotalAnnualAccrualAmount and CalculationBase cannot both be present). When the Fee is a ShareClass Fee (i.e: when ShareClasses contains at least one value), each of the following would be a valid CalculationBase: &quot;10000.00&quot;, &quot;ShareClass.GAV&quot;, &quot;ShareClass.GAV - ShareClass.Fees[ShareClassFeeCode1].Amount&quot;, &quot;ShareClass.Fees[ShareClassFeeCode1].CalculationBase&quot;. When the Fee is a NonShareClassSpecific Fee (i.e: when ShareClasses contains no values), each of the following would be a valid CalculationBase: &quot;10000.00&quot;, &quot;GAV&quot;, &quot;GAV - Fees[NonClassSpecificFeeCode1].Amount&quot;, &quot;Fees[NonClassSpecificFeeCode1].CalculationBase&quot;.

The calculation base for a Fee that is calculated using a percentage (TotalAnnualAccrualAmount and CalculationBase cannot both be present). When the Fee is a ShareClass Fee (i.e: when ShareClasses contains at least one value), each of the following would be a valid CalculationBase: &quot;10000.00&quot;, &quot;ShareClass.GAV&quot;, &quot;ShareClass.GAV - ShareClass.Fees[ShareClassFeeCode1].Amount&quot;, &quot;ShareClass.Fees[ShareClassFeeCode1].CalculationBase&quot;. When the Fee is a NonShareClassSpecific Fee (i.e: when ShareClasses contains no values), each of the following would be a valid CalculationBase: &quot;10000.00&quot;, &quot;GAV&quot;, &quot;GAV - Fees[NonClassSpecificFeeCode1].Amount&quot;, &quot;Fees[NonClassSpecificFeeCode1].CalculationBase&quot;.

◆ Description

string Lusid.Sdk.Model.Fee.Description
getset

A description for the Fee.

A description for the Fee.

◆ DisplayName

string Lusid.Sdk.Model.Fee.DisplayName
getset

The name of the Fee.

The name of the Fee.

◆ EndDate

DateTimeOffset Lusid.Sdk.Model.Fee.EndDate
getset

The end date of the Fee.

The end date of the Fee.

◆ FeeCode

string Lusid.Sdk.Model.Fee.FeeCode
getset

The code of the Fee.

The code of the Fee.

◆ FeeRatePercentage

decimal? Lusid.Sdk.Model.Fee.FeeRatePercentage
getset

The fee rate percentage. (Required when CalculationBase is present and not compatible with TotalAnnualAccrualAmount)

The fee rate percentage. (Required when CalculationBase is present and not compatible with TotalAnnualAccrualAmount)

◆ FeeTypeId

ResourceId Lusid.Sdk.Model.Fee.FeeTypeId
getset

Gets or Sets FeeTypeId

◆ Href

string Lusid.Sdk.Model.Fee.Href
getset

The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.

The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.

◆ Links

List<Link> Lusid.Sdk.Model.Fee.Links
getset

Gets or Sets Links

◆ NavTypeCode

string Lusid.Sdk.Model.Fee.NavTypeCode
getset

When provided runs against the specified NAV Type, otherwise the Primary NAV Type will be used.

When provided runs against the specified NAV Type, otherwise the Primary NAV Type will be used.

◆ Origin

string Lusid.Sdk.Model.Fee.Origin
getset

The origin or source of the Fee accrual.

The origin or source of the Fee accrual.

◆ PayableFrequency

string Lusid.Sdk.Model.Fee.PayableFrequency
getset

The payable frequency for the Fee. Available values: Annually, Quarterly, Monthly.

The payable frequency for the Fee. Available values: Annually, Quarterly, Monthly.

◆ PortfolioId

ResourceId Lusid.Sdk.Model.Fee.PortfolioId
getset

Gets or Sets PortfolioId

◆ Properties

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

The Fee properties. These will be from the &#39;Fee&#39; domain.

The Fee properties. These will be from the &#39;Fee&#39; domain.

◆ ShareClasses

List<string> Lusid.Sdk.Model.Fee.ShareClasses
getset

The short codes of the ShareClasses that the Fee should be applied to. Optional: if this is null or empty, then the Fee will be divided between all the ShareClasses of the Fund according to the capital ratio.

The short codes of the ShareClasses that the Fee should be applied to. Optional: if this is null or empty, then the Fee will be divided between all the ShareClasses of the Fund according to the capital ratio.

◆ StartDate

DateTimeOffset Lusid.Sdk.Model.Fee.StartDate
getset

The start date of the Fee.

The start date of the Fee.

◆ TotalAnnualAccrualAmount

decimal? Lusid.Sdk.Model.Fee.TotalAnnualAccrualAmount
getset

The total annual accrued amount for the Fee. (TotalAnnualAccrualAmount and CalculationBase cannot both be present)

The total annual accrued amount for the Fee. (TotalAnnualAccrualAmount and CalculationBase cannot both be present)

◆ Treatment

string Lusid.Sdk.Model.Fee.Treatment
getset

The accrual period of the Fee. Available values: Daily, Monthly.

The accrual period of the Fee. Available values: Daily, Monthly.

◆ VarVersion

ModelVersion Lusid.Sdk.Model.Fee.VarVersion
getset

Gets or Sets VarVersion


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