Describes changes to the principal on a FlexibleDeposit instrument as the result of a DepositRollEvent. Either the principal to be withdrawn or the principal increase must be specified (either as an amount or a percentage). More...

Inheritance diagram for Lusid.Sdk.Model.RollPrincipalUpdates:

[legend]

Public Member Functions
	RollPrincipalUpdates (decimal? withdrawPrincipalAmount=default(decimal?), decimal? withdrawPrincipalPercentage=default(decimal?), decimal? increasePrincipalAmount=default(decimal?), decimal? increasePrincipalPercentage=default(decimal?))
	Initializes a new instance of the RollPrincipalUpdates 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 (RollPrincipalUpdates input)
	Returns true if RollPrincipalUpdates instances are equal More...

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

Properties
decimal?	WithdrawPrincipalAmount `[get, set]`
	The amount of principal that should be withdrawn from the FlexibleDeposit. More...

decimal?	WithdrawPrincipalPercentage `[get, set]`
	The percentage of principal that should be withdrawn from the FlexibleDeposit. More...

decimal?	IncreasePrincipalAmount `[get, set]`
	The amount of principal that should be added to the FlexibleDeposit. More...

decimal?	IncreasePrincipalPercentage `[get, set]`
	The percentage of principal that should be added to the FlexibleDeposit. More...

Detailed Description

Describes changes to the principal on a FlexibleDeposit instrument as the result of a DepositRollEvent. Either the principal to be withdrawn or the principal increase must be specified (either as an amount or a percentage).

Constructor & Destructor Documentation

◆ RollPrincipalUpdates()

Lusid.Sdk.Model.RollPrincipalUpdates.RollPrincipalUpdates	(	decimal?	withdrawPrincipalAmount = `default(decimal?)`,
		decimal?	withdrawPrincipalPercentage = `default(decimal?)`,
		decimal?	increasePrincipalAmount = `default(decimal?)`,
		decimal?	increasePrincipalPercentage = `default(decimal?)`
	)

inline

Initializes a new instance of the RollPrincipalUpdates class.

Parameters

withdrawPrincipalAmount	The amount of principal that should be withdrawn from the FlexibleDeposit..
withdrawPrincipalPercentage	The percentage of principal that should be withdrawn from the FlexibleDeposit..
increasePrincipalAmount	The amount of principal that should be added to the FlexibleDeposit..
increasePrincipalPercentage	The percentage of principal that should be added to the FlexibleDeposit..

Member Function Documentation

◆ Equals() [1/2]

override bool Lusid.Sdk.Model.RollPrincipalUpdates.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.RollPrincipalUpdates.Equals ( RollPrincipalUpdates input )

inline

Returns true if RollPrincipalUpdates instances are equal

Parameters

input Instance of RollPrincipalUpdates to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ IncreasePrincipalAmount

decimal? Lusid.Sdk.Model.RollPrincipalUpdates.IncreasePrincipalAmount

getset

The amount of principal that should be added to the FlexibleDeposit.

◆ IncreasePrincipalPercentage

decimal? Lusid.Sdk.Model.RollPrincipalUpdates.IncreasePrincipalPercentage

getset

The percentage of principal that should be added to the FlexibleDeposit.

◆ WithdrawPrincipalAmount

decimal? Lusid.Sdk.Model.RollPrincipalUpdates.WithdrawPrincipalAmount

getset

The amount of principal that should be withdrawn from the FlexibleDeposit.

◆ WithdrawPrincipalPercentage

decimal? Lusid.Sdk.Model.RollPrincipalUpdates.WithdrawPrincipalPercentage

getset

The percentage of principal that should be withdrawn from the FlexibleDeposit.

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/RollPrincipalUpdates.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ RollPrincipalUpdates()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ IncreasePrincipalAmount

◆ IncreasePrincipalPercentage

◆ WithdrawPrincipalAmount

◆ WithdrawPrincipalPercentage