TransactionSettlementInstruction More...

Inheritance diagram for Lusid.Sdk.Model.TransactionSettlementInstruction:

Public Member Functions
	TransactionSettlementInstruction (string settlementInstructionId=default(string), string instructionType=default(string), DateTimeOffset actualSettlementDate=default(DateTimeOffset), decimal units=default(decimal), string transactionId=default(string), string settlementCategory=default(string), string lusidInstrumentId=default(string), DateTimeOffset? contractualSettlementDate=default(DateTimeOffset?), Dictionary< string, PerpetualProperty > subHoldingKeyOverrides=default(Dictionary< string, PerpetualProperty >), ResourceId custodianAccountOverride=default(ResourceId), Dictionary< string, string > instrumentIdentifiers=default(Dictionary< string, string >), string status=default(string), decimal? instructionToPortfolioRate=default(decimal?), SettlementInLieu settlementInLieu=default(SettlementInLieu), bool isActive=default(bool), Dictionary< string, PerpetualProperty > properties=default(Dictionary< string, PerpetualProperty >), ModelVersion varVersion=default(ModelVersion))
	Initializes a new instance of the TransactionSettlementInstruction 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 (TransactionSettlementInstruction input)
	Returns true if TransactionSettlementInstruction instances are equal More...

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

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

Properties
string	SettlementInstructionId `[get, set]`
	The instruction identifier. Unique within the portfolio. More...

string	InstructionType `[get, set]`
	The type of instruction which can be Complete or CancelAutomatic. Complete means that the instruction is intended to completely settle a settlement bucket. CancelAutomatic means that it is intended to cancel Automatic settlement. Available values: Complete, CancelAutomatic, Partial. More...

DateTimeOffset	ActualSettlementDate `[get, set]`
	The date that settlement takes place. More...

decimal	Units `[get, set]`
	The number of units for the instruction. More...

string	TransactionId `[get, set]`
	The ID for the transaction being instructed. More...

string	SettlementCategory `[get, set]`
	A category representing the set of movement types that this instruction applies to. Available values: StockSettlement, CashSettlement, DeferredCashReceipt, NotApplicable. More...

string	LusidInstrumentId `[get, set]`
	The LusidInstrumentId 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...

Dictionary< string, PerpetualProperty >	SubHoldingKeyOverrides `[get, set]`
	Allows one or more sub-holding keys to be overridden for any movement being settled by an instruction. Providing a key and value will set the sub-holding key to the specified value; Providing a key only will nullify the sub-holding key. Not referenced sub-holding keys will not be impacted. More...

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

Dictionary< string, string >	InstrumentIdentifiers `[get, set]`
	A set of instrument identifiers that can resolve the settlement instruction to a unique instrument. More...

string	Status `[get, set]`
	The status of the settlement instruction. Available values: Applied, Inactive, Invalid, Orphan, Rejected. Available values: Invalid, Rejected, Applied, Orphan. More...

decimal?	InstructionToPortfolioRate `[get, set]`
	The exchange rate between the Settlement Instruction and Portfolio. More...

SettlementInLieu	SettlementInLieu `[get, set]`
	Gets or Sets SettlementInLieu More...

bool	IsActive `[get, set]`
	Indicates whether the settlement instruction is active. When false, the instruction has no impact on settlement positions, but remains visible. Defaults to true. More...

Dictionary< string, PerpetualProperty >	Properties `[get, set]`
	The properties which have been requested to be decorated onto the settlement instruction. These will be from the 'SettlementInstruction', 'Portfolio', or 'Instrument' domains. More...

ModelVersion	VarVersion `[get, set]`
	Gets or Sets VarVersion More...

Detailed Description

TransactionSettlementInstruction

Constructor & Destructor Documentation

◆ TransactionSettlementInstruction() [1/2]

Lusid.Sdk.Model.TransactionSettlementInstruction.TransactionSettlementInstruction ( )

inlineprotected

Initializes a new instance of the TransactionSettlementInstruction class.

◆ TransactionSettlementInstruction() [2/2]

Lusid.Sdk.Model.TransactionSettlementInstruction.TransactionSettlementInstruction	(	string	settlementInstructionId = `default(string)`,
		string	instructionType = `default(string)`,
		DateTimeOffset	actualSettlementDate = `default(DateTimeOffset)`,
		decimal	units = `default(decimal)`,
		string	transactionId = `default(string)`,
		string	settlementCategory = `default(string)`,
		string	lusidInstrumentId = `default(string)`,
		DateTimeOffset?	contractualSettlementDate = `default(DateTimeOffset?)`,
		Dictionary< string, PerpetualProperty >	subHoldingKeyOverrides = `default(Dictionary<string, PerpetualProperty>)`,
		ResourceId	custodianAccountOverride = `default(ResourceId)`,
		Dictionary< string, string >	instrumentIdentifiers = `default(Dictionary<string, string>)`,
		string	status = `default(string)`,
		decimal?	instructionToPortfolioRate = `default(decimal?)`,
		SettlementInLieu	settlementInLieu = `default(SettlementInLieu)`,
		bool	isActive = `default(bool)`,
		Dictionary< string, PerpetualProperty >	properties = `default(Dictionary<string, PerpetualProperty>)`,
		ModelVersion	varVersion = `default(ModelVersion)`
	)

inline

Initializes a new instance of the TransactionSettlementInstruction class.

Parameters

settlementInstructionId	The instruction identifier. Unique within the portfolio. (required).
instructionType	The type of instruction which can be Complete or CancelAutomatic. Complete means that the instruction is intended to completely settle a settlement bucket. CancelAutomatic means that it is intended to cancel Automatic settlement. Available values: Complete, CancelAutomatic, Partial. (required).
actualSettlementDate	The date that settlement takes place. (required).
units	The number of units for the instruction. (required).
transactionId	The ID for the transaction being instructed. (required).
settlementCategory	A category representing the set of movement types that this instruction applies to. Available values: StockSettlement, CashSettlement, DeferredCashReceipt, NotApplicable. (required).
lusidInstrumentId	The LusidInstrumentId of the instrument being settled. (required).
contractualSettlementDate	The contractual settlement date. Used to match the instruction to the correct settlement bucket..
subHoldingKeyOverrides	Allows one or more sub-holding keys to be overridden for any movement being settled by an instruction. Providing a key and value will set the sub-holding key to the specified value; Providing a key only will nullify the sub-holding key. Not referenced sub-holding keys will not be impacted. .
custodianAccountOverride	custodianAccountOverride.
instrumentIdentifiers	A set of instrument identifiers that can resolve the settlement instruction to a unique instrument. (required).
status	The status of the settlement instruction. Available values: Applied, Inactive, Invalid, Orphan, Rejected. Available values: Invalid, Rejected, Applied, Orphan..
instructionToPortfolioRate	The exchange rate between the Settlement Instruction and Portfolio..
settlementInLieu	settlementInLieu.
isActive	Indicates whether the settlement instruction is active. When false, the instruction has no impact on settlement positions, but remains visible. Defaults to true..
properties	The properties which have been requested to be decorated onto the settlement instruction. These will be from the 'SettlementInstruction', 'Portfolio', or 'Instrument' domains..
varVersion	varVersion.

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if TransactionSettlementInstruction instances are equal

Parameters

input Instance of TransactionSettlementInstruction to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ ActualSettlementDate

DateTimeOffset Lusid.Sdk.Model.TransactionSettlementInstruction.ActualSettlementDate

getset

The date that settlement takes place.

◆ ContractualSettlementDate

DateTimeOffset? Lusid.Sdk.Model.TransactionSettlementInstruction.ContractualSettlementDate

getset

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

◆ CustodianAccountOverride

ResourceId Lusid.Sdk.Model.TransactionSettlementInstruction.CustodianAccountOverride

getset

Gets or Sets CustodianAccountOverride

◆ InstructionToPortfolioRate

decimal? Lusid.Sdk.Model.TransactionSettlementInstruction.InstructionToPortfolioRate

getset

The exchange rate between the Settlement Instruction and Portfolio.

◆ InstructionType

string Lusid.Sdk.Model.TransactionSettlementInstruction.InstructionType

getset

The type of instruction which can be Complete or CancelAutomatic. Complete means that the instruction is intended to completely settle a settlement bucket. CancelAutomatic means that it is intended to cancel Automatic settlement. Available values: Complete, CancelAutomatic, Partial.

◆ InstrumentIdentifiers

Dictionary<string, string> Lusid.Sdk.Model.TransactionSettlementInstruction.InstrumentIdentifiers

getset

A set of instrument identifiers that can resolve the settlement instruction to a unique instrument.

◆ IsActive

bool Lusid.Sdk.Model.TransactionSettlementInstruction.IsActive

getset

Indicates whether the settlement instruction is active. When false, the instruction has no impact on settlement positions, but remains visible. Defaults to true.

◆ LusidInstrumentId

string Lusid.Sdk.Model.TransactionSettlementInstruction.LusidInstrumentId

getset

The LusidInstrumentId of the instrument being settled.

◆ Properties

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

getset

The properties which have been requested to be decorated onto the settlement instruction. These will be from the 'SettlementInstruction', 'Portfolio', or 'Instrument' domains.

◆ SettlementCategory

string Lusid.Sdk.Model.TransactionSettlementInstruction.SettlementCategory

getset

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

◆ SettlementInLieu

SettlementInLieu Lusid.Sdk.Model.TransactionSettlementInstruction.SettlementInLieu

getset

Gets or Sets SettlementInLieu

◆ SettlementInstructionId

string Lusid.Sdk.Model.TransactionSettlementInstruction.SettlementInstructionId

getset

The instruction identifier. Unique within the portfolio.

◆ Status

string Lusid.Sdk.Model.TransactionSettlementInstruction.Status

getset

The status of the settlement instruction. Available values: Applied, Inactive, Invalid, Orphan, Rejected. Available values: Invalid, Rejected, Applied, Orphan.

◆ SubHoldingKeyOverrides

Dictionary<string, PerpetualProperty> Lusid.Sdk.Model.TransactionSettlementInstruction.SubHoldingKeyOverrides

getset

Allows one or more sub-holding keys to be overridden for any movement being settled by an instruction. Providing a key and value will set the sub-holding key to the specified value; Providing a key only will nullify the sub-holding key. Not referenced sub-holding keys will not be impacted.

◆ TransactionId

string Lusid.Sdk.Model.TransactionSettlementInstruction.TransactionId

getset

The ID for the transaction being instructed.

◆ Units

decimal Lusid.Sdk.Model.TransactionSettlementInstruction.Units

getset

The number of units for the instruction.

◆ VarVersion

ModelVersion Lusid.Sdk.Model.TransactionSettlementInstruction.VarVersion

getset

Gets or Sets VarVersion

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

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ TransactionSettlementInstruction() [1/2]

◆ TransactionSettlementInstruction() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ ActualSettlementDate

◆ ContractualSettlementDate

◆ CustodianAccountOverride

◆ InstructionToPortfolioRate

◆ InstructionType

◆ InstrumentIdentifiers

◆ IsActive

◆ LusidInstrumentId

◆ Properties

◆ SettlementCategory

◆ SettlementInLieu

◆ SettlementInstructionId

◆ Status

◆ SubHoldingKeyOverrides

◆ TransactionId

◆ Units

◆ VarVersion