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

TransactionSettlementBucket More...

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

Public Member Functions

 TransactionSettlementBucket (string settlementCategory=default(string), string lusidInstrumentId=default(string), string instrumentScope=default(string), DateTimeOffset? contractualSettlementDate=default(DateTimeOffset?), decimal contractedUnits=default(decimal), decimal settledUnits=default(decimal), decimal unsettledUnits=default(decimal), decimal overdueUnits=default(decimal), string configuredSettlement=default(string), string status=default(string), List< TransactionSettlementInstruction > settlementInstructions=default(List< TransactionSettlementInstruction >), List< TransactionSettlementMovement > movements=default(List< TransactionSettlementMovement >))
 Initializes a new instance of the TransactionSettlementBucket 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 (TransactionSettlementBucket input)
 Returns true if TransactionSettlementBucket instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

string SettlementCategory [get, set]
 A category representing the set of movement types that this instruction applies to. Available values: StockSettlement, CashSettlement, DeferredCashReceipt. More...
 
string LusidInstrumentId [get, set]
 The LusidInstrumentId of the instrument being settled. More...
 
string InstrumentScope [get, set]
 The Scope of the instrument being settled. More...
 
DateTimeOffset? ContractualSettlementDate [get, set]
 The contractual settlement date. Used to match the instruction to the correct settlement bucket. More...
 
decimal ContractedUnits [get, set]
 The contracted units. More...
 
decimal SettledUnits [get, set]
 The settled units. More...
 
decimal UnsettledUnits [get, set]
 The unsettled units. More...
 
decimal OverdueUnits [get, set]
 The overdue units. More...
 
string ConfiguredSettlement [get, set]
 The effective method of settlement for the settlement bucket. This reflects any transaction-level settlement method overrides, falling back to the portfolio&#39;s SettlementConfiguration if no override applies. Available values: Automatic, Instructed, NotApplicable. More...
 
string Status [get, set]
 The Status of the settlement bucket - &#39;Settled&#39;, &#39;Part Settled&#39; or &#39;Unsettled&#39;. Available values: Unsettled, PartSettled, Settled, None. More...
 
List< TransactionSettlementInstructionSettlementInstructions [get, set]
 The settlement instructions received for this settlement bucket. More...
 
List< TransactionSettlementMovementMovements [get, set]
 The movements for the settlement bucket. More...
 

Detailed Description

TransactionSettlementBucket

Constructor & Destructor Documentation

◆ TransactionSettlementBucket() [1/2]

Lusid.Sdk.Model.TransactionSettlementBucket.TransactionSettlementBucket ( )
inlineprotected

Initializes a new instance of the TransactionSettlementBucket class.

◆ TransactionSettlementBucket() [2/2]

Lusid.Sdk.Model.TransactionSettlementBucket.TransactionSettlementBucket ( string  settlementCategory = default(string),
string  lusidInstrumentId = default(string),
string  instrumentScope = default(string),
DateTimeOffset?  contractualSettlementDate = default(DateTimeOffset?),
decimal  contractedUnits = default(decimal),
decimal  settledUnits = default(decimal),
decimal  unsettledUnits = default(decimal),
decimal  overdueUnits = default(decimal),
string  configuredSettlement = default(string),
string  status = default(string),
List< TransactionSettlementInstruction settlementInstructions = default(List<TransactionSettlementInstruction>),
List< TransactionSettlementMovement movements = default(List<TransactionSettlementMovement>) 
)
inline

Initializes a new instance of the TransactionSettlementBucket class.

Parameters
settlementCategoryA category representing the set of movement types that this instruction applies to. Available values: StockSettlement, CashSettlement, DeferredCashReceipt. (required).
lusidInstrumentIdThe LusidInstrumentId of the instrument being settled. (required).
instrumentScopeThe Scope of the instrument being settled. (required).
contractualSettlementDateThe contractual settlement date. Used to match the instruction to the correct settlement bucket..
contractedUnitsThe contracted units..
settledUnitsThe settled units..
unsettledUnitsThe unsettled units..
overdueUnitsThe overdue units..
configuredSettlementThe effective method of settlement for the settlement bucket. This reflects any transaction-level settlement method overrides, falling back to the portfolio&#39;s SettlementConfiguration if no override applies. Available values: Automatic, Instructed, NotApplicable..
statusThe Status of the settlement bucket - &#39;Settled&#39;, &#39;Part Settled&#39; or &#39;Unsettled&#39;. Available values: Unsettled, PartSettled, Settled, None. (required).
settlementInstructionsThe settlement instructions received for this settlement bucket..
movementsThe movements for the settlement bucket..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if TransactionSettlementBucket instances are equal

Parameters
inputInstance of TransactionSettlementBucket to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ ConfiguredSettlement

string Lusid.Sdk.Model.TransactionSettlementBucket.ConfiguredSettlement
getset

The effective method of settlement for the settlement bucket. This reflects any transaction-level settlement method overrides, falling back to the portfolio&#39;s SettlementConfiguration if no override applies. Available values: Automatic, Instructed, NotApplicable.

The effective method of settlement for the settlement bucket. This reflects any transaction-level settlement method overrides, falling back to the portfolio&#39;s SettlementConfiguration if no override applies. Available values: Automatic, Instructed, NotApplicable.

◆ ContractedUnits

decimal Lusid.Sdk.Model.TransactionSettlementBucket.ContractedUnits
getset

The contracted units.

The contracted units.

◆ ContractualSettlementDate

DateTimeOffset? Lusid.Sdk.Model.TransactionSettlementBucket.ContractualSettlementDate
getset

The contractual settlement date. Used to match the instruction to the correct settlement bucket.

The contractual settlement date. Used to match the instruction to the correct settlement bucket.

◆ InstrumentScope

string Lusid.Sdk.Model.TransactionSettlementBucket.InstrumentScope
getset

The Scope of the instrument being settled.

The Scope of the instrument being settled.

◆ LusidInstrumentId

string Lusid.Sdk.Model.TransactionSettlementBucket.LusidInstrumentId
getset

The LusidInstrumentId of the instrument being settled.

The LusidInstrumentId of the instrument being settled.

◆ Movements

List<TransactionSettlementMovement> Lusid.Sdk.Model.TransactionSettlementBucket.Movements
getset

The movements for the settlement bucket.

The movements for the settlement bucket.

◆ OverdueUnits

decimal Lusid.Sdk.Model.TransactionSettlementBucket.OverdueUnits
getset

The overdue units.

The overdue units.

◆ SettledUnits

decimal Lusid.Sdk.Model.TransactionSettlementBucket.SettledUnits
getset

The settled units.

The settled units.

◆ SettlementCategory

string Lusid.Sdk.Model.TransactionSettlementBucket.SettlementCategory
getset

A category representing the set of movement types that this instruction applies to. Available values: StockSettlement, CashSettlement, DeferredCashReceipt.

A category representing the set of movement types that this instruction applies to. Available values: StockSettlement, CashSettlement, DeferredCashReceipt.

◆ SettlementInstructions

List<TransactionSettlementInstruction> Lusid.Sdk.Model.TransactionSettlementBucket.SettlementInstructions
getset

The settlement instructions received for this settlement bucket.

The settlement instructions received for this settlement bucket.

◆ Status

string Lusid.Sdk.Model.TransactionSettlementBucket.Status
getset

The Status of the settlement bucket - &#39;Settled&#39;, &#39;Part Settled&#39; or &#39;Unsettled&#39;. Available values: Unsettled, PartSettled, Settled, None.

The Status of the settlement bucket - &#39;Settled&#39;, &#39;Part Settled&#39; or &#39;Unsettled&#39;. Available values: Unsettled, PartSettled, Settled, None.

◆ UnsettledUnits

decimal Lusid.Sdk.Model.TransactionSettlementBucket.UnsettledUnits
getset

The unsettled units.

The unsettled units.


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