Inheritance diagram for Lusid.Sdk.Model.TransactionTypeMovement:

Public Member Functions
	TransactionTypeMovement (string movementTypes=default(string), string side=default(string), int direction=default(int), Dictionary< string, PerpetualProperty > properties=default(Dictionary< string, PerpetualProperty >), List< TransactionTypePropertyMapping > mappings=default(List< TransactionTypePropertyMapping >), string name=default(string), List< string > movementOptions=default(List< string >), string settlementDateOverride=default(string))
	Initializes a new instance of the TransactionTypeMovement 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 (TransactionTypeMovement input)
	Returns true if TransactionTypeMovement instances are equal More...

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

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

Properties
string	MovementTypes `[get, set]`
	Movement types determine the impact of the movement on the holdings More...

string	Side `[get, set]`
	The Side determines which of the fields from our transaction are used to generate the Movement. Side1 means the 'security' side of the transaction, ie the Instrument and Units; Side2 means the 'cash' side, ie the Total Consideration More...

int	Direction `[get, set]`
	A multiplier to apply to Transaction amounts; the values are -1 to indicate to reverse the signs and 1 to indicate to use the signed values from the Transaction directly. For a typical Transaction with unsigned values, 1 means increase, -1 means decrease More...

Dictionary< string, PerpetualProperty >	Properties `[get, set]`
	The properties associated with the underlying Movement More...

List< TransactionTypePropertyMapping >	Mappings `[get, set]`
	This allows you to map a transaction property to a property on the underlying holding More...

string	Name `[get, set]`
	The movement name (optional) More...

List< string >	MovementOptions `[get, set]`
	Allows extra specifications for the movement. The only option currently available is 'DirectAdjustment'. A movement type of 'StockMovement' with an option of 'DirectAdjusment' will allow you to adjust the unitsof a holding without affecting its cost base. You will, therefore, be able to reflect the impact of a stock split by loading a Transaction. More...

string	SettlementDateOverride `[get, set]`
	Optional property key that must be in the Transaction domain when specified. When the movement is processed and the transaction has this property set to a valid date, then the property value will override the SettlementDate of the transaction. More...

Detailed Description

TransactionTypeMovement

Constructor & Destructor Documentation

◆ TransactionTypeMovement() [1/2]

Lusid.Sdk.Model.TransactionTypeMovement.TransactionTypeMovement ( )

inlineprotected

Initializes a new instance of the TransactionTypeMovement class.

◆ TransactionTypeMovement() [2/2]

Lusid.Sdk.Model.TransactionTypeMovement.TransactionTypeMovement	(	string	movementTypes = `default(string)`,
		string	side = `default(string)`,
		int	direction = `default(int)`,
		Dictionary< string, PerpetualProperty >	properties = `default(Dictionary<string, PerpetualProperty>)`,
		List< TransactionTypePropertyMapping >	mappings = `default(List<TransactionTypePropertyMapping>)`,
		string	name = `default(string)`,
		List< string >	movementOptions = `default(List<string>)`,
		string	settlementDateOverride = `default(string)`
	)

inline

Initializes a new instance of the TransactionTypeMovement class.

Parameters

movementTypes	Movement types determine the impact of the movement on the holdings (required).
side	The Side determines which of the fields from our transaction are used to generate the Movement. Side1 means the 'security' side of the transaction, ie the Instrument and Units; Side2 means the 'cash' side, ie the Total Consideration (required).
direction	A multiplier to apply to Transaction amounts; the values are -1 to indicate to reverse the signs and 1 to indicate to use the signed values from the Transaction directly. For a typical Transaction with unsigned values, 1 means increase, -1 means decrease (required).
properties	The properties associated with the underlying Movement.
mappings	This allows you to map a transaction property to a property on the underlying holding.
name	The movement name (optional).
movementOptions	Allows extra specifications for the movement. The only option currently available is 'DirectAdjustment'. A movement type of 'StockMovement' with an option of 'DirectAdjusment' will allow you to adjust the unitsof a holding without affecting its cost base. You will, therefore, be able to reflect the impact of a stock split by loading a Transaction..
settlementDateOverride	Optional property key that must be in the Transaction domain when specified. When the movement is processed and the transaction has this property set to a valid date, then the property value will override the SettlementDate of the transaction..

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if TransactionTypeMovement instances are equal

Parameters

input Instance of TransactionTypeMovement to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ Direction

int Lusid.Sdk.Model.TransactionTypeMovement.Direction

getset

A multiplier to apply to Transaction amounts; the values are -1 to indicate to reverse the signs and 1 to indicate to use the signed values from the Transaction directly. For a typical Transaction with unsigned values, 1 means increase, -1 means decrease

◆ Mappings

List<TransactionTypePropertyMapping> Lusid.Sdk.Model.TransactionTypeMovement.Mappings

getset

This allows you to map a transaction property to a property on the underlying holding

◆ MovementOptions

List<string> Lusid.Sdk.Model.TransactionTypeMovement.MovementOptions

getset

Allows extra specifications for the movement. The only option currently available is 'DirectAdjustment'. A movement type of 'StockMovement' with an option of 'DirectAdjusment' will allow you to adjust the unitsof a holding without affecting its cost base. You will, therefore, be able to reflect the impact of a stock split by loading a Transaction.

◆ MovementTypes

string Lusid.Sdk.Model.TransactionTypeMovement.MovementTypes

getset

Movement types determine the impact of the movement on the holdings

◆ Name

string Lusid.Sdk.Model.TransactionTypeMovement.Name

getset

The movement name (optional)

◆ Properties

Dictionary<string, PerpetualProperty> Lusid.Sdk.Model.TransactionTypeMovement.Properties

getset

The properties associated with the underlying Movement

◆ SettlementDateOverride

string Lusid.Sdk.Model.TransactionTypeMovement.SettlementDateOverride

getset

Optional property key that must be in the Transaction domain when specified. When the movement is processed and the transaction has this property set to a valid date, then the property value will override the SettlementDate of the transaction.

◆ Side

string Lusid.Sdk.Model.TransactionTypeMovement.Side

getset

The Side determines which of the fields from our transaction are used to generate the Movement. Side1 means the 'security' side of the transaction, ie the Instrument and Units; Side2 means the 'cash' side, ie the Total Consideration

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

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ TransactionTypeMovement() [1/2]

◆ TransactionTypeMovement() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ Direction

◆ Mappings

◆ MovementOptions

◆ MovementTypes

◆ Name

◆ Properties

◆ SettlementDateOverride

◆ Side