Returns entity, used for configuring the calculation of aggregated returns. More...

Inheritance diagram for Lusid.Sdk.Model.ReturnsEntity:

Public Member Functions
	ReturnsEntity (ResourceId id=default(ResourceId), ResourceId recipeId=default(ResourceId), string recipeEntity=default(string), string feeHandling=default(string), string flowHandling=default(string), string businessCalendar=default(string), string handleFlowDiscrepancy=default(string))
	Initializes a new instance of the ReturnsEntity 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 (ReturnsEntity input)
	Returns true if ReturnsEntity instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

Protected Member Functions
	ReturnsEntity ()
	Initializes a new instance of the ReturnsEntity class. More...

Properties
ResourceId	Id `[get, set]`
	Gets or Sets Id More...

ResourceId	RecipeId `[get, set]`
	Gets or Sets RecipeId More...

string	RecipeEntity `[get, set]`
	Entity a recipe is retrieved from for use in the aggregated returns calculation. Either RecipeId or RecipeEntity must be specified. Available values: Portfolio, PortfolioGroup, ABOR. More...

string	FeeHandling `[get, set]`
	Configures how fees are handled in the aggregated returns calculation. Available values: Net, Gross. More...

string	FlowHandling `[get, set]`
	Configures how flows are handled in the aggregated returns calculation. Available values: BeginningOfDay, EndOfDay. More...

string	BusinessCalendar `[get, set]`
	Calendar used in the aggregated returns calculation. More...

string	HandleFlowDiscrepancy `[get, set]`
	Configures handling for the case where net flows do not match the sum of tagged flows. Available values: TreatAsFlow, TreatAsGainloss, Error. More...

Detailed Description

Returns entity, used for configuring the calculation of aggregated returns.

Constructor & Destructor Documentation

◆ ReturnsEntity() [1/2]

Lusid.Sdk.Model.ReturnsEntity.ReturnsEntity ( )

inlineprotected

Initializes a new instance of the ReturnsEntity class.

◆ ReturnsEntity() [2/2]

Lusid.Sdk.Model.ReturnsEntity.ReturnsEntity	(	ResourceId	id = `default(ResourceId)`,
		ResourceId	recipeId = `default(ResourceId)`,
		string	recipeEntity = `default(string)`,
		string	feeHandling = `default(string)`,
		string	flowHandling = `default(string)`,
		string	businessCalendar = `default(string)`,
		string	handleFlowDiscrepancy = `default(string)`
	)

inline

Initializes a new instance of the ReturnsEntity class.

Parameters

id	id (required).
recipeId	recipeId.
recipeEntity	Entity a recipe is retrieved from for use in the aggregated returns calculation. Either RecipeId or RecipeEntity must be specified. Available values: Portfolio, PortfolioGroup, ABOR..
feeHandling	Configures how fees are handled in the aggregated returns calculation. Available values: Net, Gross..
flowHandling	Configures how flows are handled in the aggregated returns calculation. Available values: BeginningOfDay, EndOfDay..
businessCalendar	Calendar used in the aggregated returns calculation..
handleFlowDiscrepancy	Configures handling for the case where net flows do not match the sum of tagged flows. Available values: TreatAsFlow, TreatAsGainloss, Error..

Member Function Documentation

◆ Equals() [1/2]

override bool Lusid.Sdk.Model.ReturnsEntity.Equals ( object input )

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ Equals() [2/2]

bool Lusid.Sdk.Model.ReturnsEntity.Equals ( ReturnsEntity input )

inline

Returns true if ReturnsEntity instances are equal

Parameters

input Instance of ReturnsEntity to be compared

Returns: Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.ReturnsEntity.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.ReturnsEntity.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.ReturnsEntity.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ BusinessCalendar

string Lusid.Sdk.Model.ReturnsEntity.BusinessCalendar

getset

Calendar used in the aggregated returns calculation.

◆ FeeHandling

string Lusid.Sdk.Model.ReturnsEntity.FeeHandling

getset

Configures how fees are handled in the aggregated returns calculation. Available values: Net, Gross.

◆ FlowHandling

string Lusid.Sdk.Model.ReturnsEntity.FlowHandling

getset

Configures how flows are handled in the aggregated returns calculation. Available values: BeginningOfDay, EndOfDay.

◆ HandleFlowDiscrepancy

string Lusid.Sdk.Model.ReturnsEntity.HandleFlowDiscrepancy

getset

Configures handling for the case where net flows do not match the sum of tagged flows. Available values: TreatAsFlow, TreatAsGainloss, Error.

◆ Id

ResourceId Lusid.Sdk.Model.ReturnsEntity.Id

getset

Gets or Sets Id

◆ RecipeEntity

string Lusid.Sdk.Model.ReturnsEntity.RecipeEntity

getset

Entity a recipe is retrieved from for use in the aggregated returns calculation. Either RecipeId or RecipeEntity must be specified. Available values: Portfolio, PortfolioGroup, ABOR.

◆ RecipeId

ResourceId Lusid.Sdk.Model.ReturnsEntity.RecipeId

getset

Gets or Sets RecipeId

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Model/ReturnsEntity.cs

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ReturnsEntity() [1/2]

◆ ReturnsEntity() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ BusinessCalendar

◆ FeeHandling

◆ FlowHandling

◆ HandleFlowDiscrepancy

◆ Id

◆ RecipeEntity

◆ RecipeId