The request to create an instruction for an instrument event More...

Inheritance diagram for Lusid.Sdk.Model.InstrumentEventInstructionRequest:

Public Member Functions
	InstrumentEventInstructionRequest (string instrumentEventInstructionId=default(string), string instrumentEventId=default(string), string instructionType=default(string), string electionKey=default(string), long? holdingId=default(long?), DateTimeOffset? entitlementDateInstructed=default(DateTimeOffset?), QuantityInstructed quantityInstructed=default(QuantityInstructed), string taxLotId=default(string), bool ignoreCostImpact=default(bool))
	Initializes a new instance of the InstrumentEventInstructionRequest 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 (InstrumentEventInstructionRequest input)
	Returns true if InstrumentEventInstructionRequest instances are equal More...

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

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

Properties
string	InstrumentEventInstructionId `[get, set]`
	The unique identifier for this instruction More...

string	InstrumentEventId `[get, set]`
	The identifier of the instrument event being instructed More...

string	InstructionType `[get, set]`
	The type of instruction (Ignore, ElectForPortfolio, ElectForHolding, ElectForLoanFacilityHolding) More...

string	ElectionKey `[get, set]`
	For elected instructions, the key to be chosen More...

long?	HoldingId `[get, set]`
	For holding instructions, the id of the holding for which the instruction will apply More...

DateTimeOffset?	EntitlementDateInstructed `[get, set]`
	The instructed entitlement date for the event (where none is set on the event itself) More...

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

string	TaxLotId `[get, set]`
	For loan facility holding instructions, the tax lot id of the holding for which the instruction will apply More...

bool	IgnoreCostImpact `[get, set]`
	For loan facility holding instructions, set this flag to 'true' if you want the event to not impact cost. If you want to use this option, do not add multiple instructions to the same tax lot or you will get undefined behaviour. More...

Detailed Description

The request to create an instruction for an instrument event

Constructor & Destructor Documentation

◆ InstrumentEventInstructionRequest() [1/2]

Lusid.Sdk.Model.InstrumentEventInstructionRequest.InstrumentEventInstructionRequest ( )

inlineprotected

Initializes a new instance of the InstrumentEventInstructionRequest class.

◆ InstrumentEventInstructionRequest() [2/2]

Lusid.Sdk.Model.InstrumentEventInstructionRequest.InstrumentEventInstructionRequest	(	string	instrumentEventInstructionId = `default(string)`,
		string	instrumentEventId = `default(string)`,
		string	instructionType = `default(string)`,
		string	electionKey = `default(string)`,
		long?	holdingId = `default(long?)`,
		DateTimeOffset?	entitlementDateInstructed = `default(DateTimeOffset?)`,
		QuantityInstructed	quantityInstructed = `default(QuantityInstructed)`,
		string	taxLotId = `default(string)`,
		bool	ignoreCostImpact = `default(bool)`
	)

inline

Initializes a new instance of the InstrumentEventInstructionRequest class.

Parameters

instrumentEventInstructionId	The unique identifier for this instruction (required).
instrumentEventId	The identifier of the instrument event being instructed (required).
instructionType	The type of instruction (Ignore, ElectForPortfolio, ElectForHolding, ElectForLoanFacilityHolding) (required).
electionKey	For elected instructions, the key to be chosen.
holdingId	For holding instructions, the id of the holding for which the instruction will apply.
entitlementDateInstructed	The instructed entitlement date for the event (where none is set on the event itself).
quantityInstructed	quantityInstructed.
taxLotId	For loan facility holding instructions, the tax lot id of the holding for which the instruction will apply.
ignoreCostImpact	For loan facility holding instructions, set this flag to 'true' if you want the event to not impact cost. If you want to use this option, do not add multiple instructions to the same tax lot or you will get undefined behaviour..

Member Function Documentation

◆ Equals() [1/2]

bool Lusid.Sdk.Model.InstrumentEventInstructionRequest.Equals ( InstrumentEventInstructionRequest input )

inline

Returns true if InstrumentEventInstructionRequest instances are equal

Parameters

input Instance of InstrumentEventInstructionRequest to be compared

Returns: Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.InstrumentEventInstructionRequest.Equals ( object input )

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ ElectionKey

string Lusid.Sdk.Model.InstrumentEventInstructionRequest.ElectionKey

getset

For elected instructions, the key to be chosen

◆ EntitlementDateInstructed

DateTimeOffset? Lusid.Sdk.Model.InstrumentEventInstructionRequest.EntitlementDateInstructed

getset

The instructed entitlement date for the event (where none is set on the event itself)

◆ HoldingId

long? Lusid.Sdk.Model.InstrumentEventInstructionRequest.HoldingId

getset

For holding instructions, the id of the holding for which the instruction will apply

◆ IgnoreCostImpact

bool Lusid.Sdk.Model.InstrumentEventInstructionRequest.IgnoreCostImpact

getset

For loan facility holding instructions, set this flag to 'true' if you want the event to not impact cost. If you want to use this option, do not add multiple instructions to the same tax lot or you will get undefined behaviour.

◆ InstructionType

string Lusid.Sdk.Model.InstrumentEventInstructionRequest.InstructionType

getset

The type of instruction (Ignore, ElectForPortfolio, ElectForHolding, ElectForLoanFacilityHolding)

◆ InstrumentEventId

string Lusid.Sdk.Model.InstrumentEventInstructionRequest.InstrumentEventId

getset

The identifier of the instrument event being instructed

◆ InstrumentEventInstructionId

string Lusid.Sdk.Model.InstrumentEventInstructionRequest.InstrumentEventInstructionId

getset

The unique identifier for this instruction

◆ QuantityInstructed

QuantityInstructed Lusid.Sdk.Model.InstrumentEventInstructionRequest.QuantityInstructed

getset

Gets or Sets QuantityInstructed

◆ TaxLotId

string Lusid.Sdk.Model.InstrumentEventInstructionRequest.TaxLotId

getset

For loan facility holding instructions, the tax lot id of the holding for which the instruction will apply

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

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ InstrumentEventInstructionRequest() [1/2]

◆ InstrumentEventInstructionRequest() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ ElectionKey

◆ EntitlementDateInstructed

◆ HoldingId

◆ IgnoreCostImpact

◆ InstructionType

◆ InstrumentEventId

◆ InstrumentEventInstructionId

◆ QuantityInstructed

◆ TaxLotId