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

TransactionConfigurationMovementData More...

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

Public Types

enum class  MovementTypesEnum {
  Settlement = 1 , Traded = 2 , StockMovement = 3 , FutureCash = 4 ,
  Commitment = 5 , Receivable = 6 , CashSettlement = 7 , CashForward = 8 ,
  CashCommitment = 9 , CashReceivable = 10 , Accrual = 11 , CashAccrual = 12 ,
  ForwardFx = 13 , CashFxForward = 14 , UnsettledCashTypes = 15 , Carry = 16 ,
  CarryAsPnl = 17 , VariationMargin = 18 , Capital = 19 , Fee = 20
}
 . The available values are: Settlement, Traded, StockMovement, FutureCash, Commitment, Receivable, CashSettlement, CashForward, CashCommitment, CashReceivable, Accrual, CashAccrual, ForwardFx, CashFxForward, UnsettledCashTypes, Carry, CarryAsPnl, VariationMargin, Capital, Fee More...
 

Public Member Functions

 TransactionConfigurationMovementData (MovementTypesEnum movementTypes=default(MovementTypesEnum), string side=default(string), int direction=default(int), Dictionary< string, PerpetualProperty > properties=default(Dictionary< string, PerpetualProperty >), List< TransactionPropertyMapping > mappings=default(List< TransactionPropertyMapping >), string name=default(string), List< string > movementOptions=default(List< string >))
 Initializes a new instance of the TransactionConfigurationMovementData 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 (TransactionConfigurationMovementData input)
 Returns true if TransactionConfigurationMovementData instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

MovementTypesEnum MovementTypes [get, set]
 . The available values are: Settlement, Traded, StockMovement, FutureCash, Commitment, Receivable, CashSettlement, CashForward, CashCommitment, CashReceivable, Accrual, CashAccrual, ForwardFx, CashFxForward, UnsettledCashTypes, Carry, CarryAsPnl, VariationMargin, Capital, Fee More...
 
string Side [get, set]
 The Side determines which of the fields from our transaction are used to generate the Movement. Side1 means the &#39;security&#39; side of the transaction, ie the Instrument and Units; Side2 means the &#39;cash&#39; 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, PerpetualPropertyProperties [get, set]
 The properties associated with the underlying Movement More...
 
List< TransactionPropertyMappingMappings [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 &#39;DirectAdjustment&#39;. A movement type of &#39;StockMovement&#39; with an option of &#39;DirectAdjusment&#39; 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...
 

Detailed Description

TransactionConfigurationMovementData

Member Enumeration Documentation

◆ MovementTypesEnum

. The available values are: Settlement, Traded, StockMovement, FutureCash, Commitment, Receivable, CashSettlement, CashForward, CashCommitment, CashReceivable, Accrual, CashAccrual, ForwardFx, CashFxForward, UnsettledCashTypes, Carry, CarryAsPnl, VariationMargin, Capital, Fee

. The available values are: Settlement, Traded, StockMovement, FutureCash, Commitment, Receivable, CashSettlement, CashForward, CashCommitment, CashReceivable, Accrual, CashAccrual, ForwardFx, CashFxForward, UnsettledCashTypes, Carry, CarryAsPnl, VariationMargin, Capital, Fee

Enumerator
Settlement 

Enum Settlement for value: Settlement

Traded 

Enum Traded for value: Traded

StockMovement 

Enum StockMovement for value: StockMovement

FutureCash 

Enum FutureCash for value: FutureCash

Commitment 

Enum Commitment for value: Commitment

Receivable 

Enum Receivable for value: Receivable

CashSettlement 

Enum CashSettlement for value: CashSettlement

CashForward 

Enum CashForward for value: CashForward

CashCommitment 

Enum CashCommitment for value: CashCommitment

CashReceivable 

Enum CashReceivable for value: CashReceivable

Accrual 

Enum Accrual for value: Accrual

CashAccrual 

Enum CashAccrual for value: CashAccrual

ForwardFx 

Enum ForwardFx for value: ForwardFx

CashFxForward 

Enum CashFxForward for value: CashFxForward

UnsettledCashTypes 

Enum UnsettledCashTypes for value: UnsettledCashTypes

Carry 

Enum Carry for value: Carry

CarryAsPnl 

Enum CarryAsPnl for value: CarryAsPnl

VariationMargin 

Enum VariationMargin for value: VariationMargin

Capital 

Enum Capital for value: Capital

Fee 

Enum Fee for value: Fee

Constructor & Destructor Documentation

◆ TransactionConfigurationMovementData() [1/2]

Lusid.Sdk.Model.TransactionConfigurationMovementData.TransactionConfigurationMovementData ( )
inlineprotected

Initializes a new instance of the TransactionConfigurationMovementData class.

◆ TransactionConfigurationMovementData() [2/2]

Lusid.Sdk.Model.TransactionConfigurationMovementData.TransactionConfigurationMovementData ( MovementTypesEnum  movementTypes = default(MovementTypesEnum),
string  side = default(string),
int  direction = default(int),
Dictionary< string, PerpetualProperty properties = default(Dictionary<string, PerpetualProperty>),
List< TransactionPropertyMapping mappings = default(List<TransactionPropertyMapping>),
string  name = default(string),
List< string >  movementOptions = default(List<string>) 
)
inline

Initializes a new instance of the TransactionConfigurationMovementData class.

Parameters
movementTypes. The available values are: Settlement, Traded, StockMovement, FutureCash, Commitment, Receivable, CashSettlement, CashForward, CashCommitment, CashReceivable, Accrual, CashAccrual, ForwardFx, CashFxForward, UnsettledCashTypes, Carry, CarryAsPnl, VariationMargin, Capital, Fee (required).
sideThe Side determines which of the fields from our transaction are used to generate the Movement. Side1 means the &#39;security&#39; side of the transaction, ie the Instrument and Units; Side2 means the &#39;cash&#39; side, ie the Total Consideration (required).
directionA 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).
propertiesThe properties associated with the underlying Movement.
mappingsThis allows you to map a transaction property to a property on the underlying holding.
nameThe movement name (optional).
movementOptionsAllows extra specifications for the movement. The only option currently available is &#39;DirectAdjustment&#39;. A movement type of &#39;StockMovement&#39; with an option of &#39;DirectAdjusment&#39; 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..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if TransactionConfigurationMovementData instances are equal

Parameters
inputInstance of TransactionConfigurationMovementData to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Direction

int Lusid.Sdk.Model.TransactionConfigurationMovementData.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

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<TransactionPropertyMapping> Lusid.Sdk.Model.TransactionConfigurationMovementData.Mappings
getset

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

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

◆ MovementOptions

List<string> Lusid.Sdk.Model.TransactionConfigurationMovementData.MovementOptions
getset

Allows extra specifications for the movement. The only option currently available is &#39;DirectAdjustment&#39;. A movement type of &#39;StockMovement&#39; with an option of &#39;DirectAdjusment&#39; 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.

Allows extra specifications for the movement. The only option currently available is &#39;DirectAdjustment&#39;. A movement type of &#39;StockMovement&#39; with an option of &#39;DirectAdjusment&#39; 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

MovementTypesEnum Lusid.Sdk.Model.TransactionConfigurationMovementData.MovementTypes
getset

. The available values are: Settlement, Traded, StockMovement, FutureCash, Commitment, Receivable, CashSettlement, CashForward, CashCommitment, CashReceivable, Accrual, CashAccrual, ForwardFx, CashFxForward, UnsettledCashTypes, Carry, CarryAsPnl, VariationMargin, Capital, Fee

. The available values are: Settlement, Traded, StockMovement, FutureCash, Commitment, Receivable, CashSettlement, CashForward, CashCommitment, CashReceivable, Accrual, CashAccrual, ForwardFx, CashFxForward, UnsettledCashTypes, Carry, CarryAsPnl, VariationMargin, Capital, Fee

◆ Name

string Lusid.Sdk.Model.TransactionConfigurationMovementData.Name
getset

The movement name (optional)

The movement name (optional)

◆ Properties

Dictionary<string, PerpetualProperty> Lusid.Sdk.Model.TransactionConfigurationMovementData.Properties
getset

The properties associated with the underlying Movement

The properties associated with the underlying Movement

◆ Side

string Lusid.Sdk.Model.TransactionConfigurationMovementData.Side
getset

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

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


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