Inheritance diagram for Lusid.Sdk.Model.TransactionQueryParameters:

Public Types
enum class	QueryModeEnum { TradeDate = 1 , SettleDate = 2 }
	The date to compare against the upper and lower bounds for the effective datetime or cut label. Default value: TradeDate. Available values: TradeDate, SettleDate. More...

Public Member Functions
	TransactionQueryParameters (DateTimeOrCutLabel startDate=default(DateTimeOrCutLabel), DateTimeOrCutLabel endDate=default(DateTimeOrCutLabel), QueryModeEnum ?queryMode=default(QueryModeEnum?), bool showCancelledTransactions=default(bool), string timelineScope=default(string), string timelineCode=default(string), bool includeEconomics=default(bool), bool includeSettlementStatus=default(bool), DateTimeOrCutLabel settlementStatusDate=default(DateTimeOrCutLabel))
	Initializes a new instance of the TransactionQueryParameters 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 (TransactionQueryParameters input)
	Returns true if TransactionQueryParameters instances are equal More...

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

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

Properties
QueryModeEnum?	QueryMode `[get, set]`
	The date to compare against the upper and lower bounds for the effective datetime or cut label. Default value: TradeDate. Available values: TradeDate, SettleDate. More...

DateTimeOrCutLabel	StartDate `[get, set]`
	The lower bound effective datetime or cut label (inclusive) from which to build the transactions. More...

DateTimeOrCutLabel	EndDate `[get, set]`
	The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. More...

bool	ShowCancelledTransactions `[get, set]`
	Option to specify whether or not to include cancelled transactions in the output. Defaults to False if not specified. More...

string	TimelineScope `[get, set]`
	Scope of the Timeline for the Portfolio. The Timeline to be used while building transactions More...

string	TimelineCode `[get, set]`
	Code of the Timeline for the Portfolio. The Timeline to be used while building transactions. This can optionally include a colon, followed by the Closed Period Id to use at the head of the timeline, for a timeline with unconfirmed periods. More...

bool	IncludeEconomics `[get, set]`
	By default is false. When set to true the Economics data would be populated in the response. More...

bool	IncludeSettlementStatus `[get, set]`
	By default is false. When set to true the Settlement Status data would be populated in the response. More...

DateTimeOrCutLabel	SettlementStatusDate `[get, set]`
	Optional date used to specify end of an extended window for settlement information. When provided, transactions will be returned between start and end date, but settlement information between start date and this date will be included. When provided, the value must be greater than or equal to end date. More...

Detailed Description

TransactionQueryParameters

Member Enumeration Documentation

◆ QueryModeEnum

enum Lusid.Sdk.Model.TransactionQueryParameters.QueryModeEnum

strong

The date to compare against the upper and lower bounds for the effective datetime or cut label. Default value: TradeDate. Available values: TradeDate, SettleDate.

Enumerator
TradeDate	Enum TradeDate for value: TradeDate
SettleDate	Enum SettleDate for value: SettleDate

Constructor & Destructor Documentation

◆ TransactionQueryParameters() [1/2]

Lusid.Sdk.Model.TransactionQueryParameters.TransactionQueryParameters ( )

inlineprotected

Initializes a new instance of the TransactionQueryParameters class.

◆ TransactionQueryParameters() [2/2]

Lusid.Sdk.Model.TransactionQueryParameters.TransactionQueryParameters	(	DateTimeOrCutLabel	startDate = `default(DateTimeOrCutLabel)`,
		DateTimeOrCutLabel	endDate = `default(DateTimeOrCutLabel)`,
		QueryModeEnum ?	queryMode = `default(QueryModeEnum?)`,
		bool	showCancelledTransactions = `default(bool)`,
		string	timelineScope = `default(string)`,
		string	timelineCode = `default(string)`,
		bool	includeEconomics = `default(bool)`,
		bool	includeSettlementStatus = `default(bool)`,
		DateTimeOrCutLabel	settlementStatusDate = `default(DateTimeOrCutLabel)`
	)

inline

Initializes a new instance of the TransactionQueryParameters class.

Parameters

startDate	The lower bound effective datetime or cut label (inclusive) from which to build the transactions. (required).
endDate	The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. (required).
queryMode	The date to compare against the upper and lower bounds for the effective datetime or cut label. Default value: TradeDate. Available values: TradeDate, SettleDate..
showCancelledTransactions	Option to specify whether or not to include cancelled transactions in the output. Defaults to False if not specified..
timelineScope	Scope of the Timeline for the Portfolio. The Timeline to be used while building transactions.
timelineCode	Code of the Timeline for the Portfolio. The Timeline to be used while building transactions. This can optionally include a colon, followed by the Closed Period Id to use at the head of the timeline, for a timeline with unconfirmed periods..
includeEconomics	By default is false. When set to true the Economics data would be populated in the response..
includeSettlementStatus	By default is false. When set to true the Settlement Status data would be populated in the response..
settlementStatusDate	Optional date used to specify end of an extended window for settlement information. When provided, transactions will be returned between start and end date, but settlement information between start date and this date will be included. When provided, the value must be greater than or equal to end date..

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if TransactionQueryParameters instances are equal

Parameters

input Instance of TransactionQueryParameters to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ EndDate

DateTimeOrCutLabel Lusid.Sdk.Model.TransactionQueryParameters.EndDate

getset

The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions.

◆ IncludeEconomics

bool Lusid.Sdk.Model.TransactionQueryParameters.IncludeEconomics

getset

By default is false. When set to true the Economics data would be populated in the response.

◆ IncludeSettlementStatus

bool Lusid.Sdk.Model.TransactionQueryParameters.IncludeSettlementStatus

getset

By default is false. When set to true the Settlement Status data would be populated in the response.

◆ QueryMode

QueryModeEnum? Lusid.Sdk.Model.TransactionQueryParameters.QueryMode

getset

The date to compare against the upper and lower bounds for the effective datetime or cut label. Default value: TradeDate. Available values: TradeDate, SettleDate.

◆ SettlementStatusDate

DateTimeOrCutLabel Lusid.Sdk.Model.TransactionQueryParameters.SettlementStatusDate

getset

Optional date used to specify end of an extended window for settlement information. When provided, transactions will be returned between start and end date, but settlement information between start date and this date will be included. When provided, the value must be greater than or equal to end date.

◆ ShowCancelledTransactions

bool Lusid.Sdk.Model.TransactionQueryParameters.ShowCancelledTransactions

getset

Option to specify whether or not to include cancelled transactions in the output. Defaults to False if not specified.

◆ StartDate

DateTimeOrCutLabel Lusid.Sdk.Model.TransactionQueryParameters.StartDate

getset

The lower bound effective datetime or cut label (inclusive) from which to build the transactions.

◆ TimelineCode

string Lusid.Sdk.Model.TransactionQueryParameters.TimelineCode

getset

Code of the Timeline for the Portfolio. The Timeline to be used while building transactions. This can optionally include a colon, followed by the Closed Period Id to use at the head of the timeline, for a timeline with unconfirmed periods.

◆ TimelineScope

string Lusid.Sdk.Model.TransactionQueryParameters.TimelineScope

getset

Scope of the Timeline for the Portfolio. The Timeline to be used while building transactions

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

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ QueryModeEnum

Constructor & Destructor Documentation

◆ TransactionQueryParameters() [1/2]

◆ TransactionQueryParameters() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ EndDate

◆ IncludeEconomics

◆ IncludeSettlementStatus

◆ QueryMode

◆ SettlementStatusDate

◆ ShowCancelledTransactions

◆ StartDate

◆ TimelineCode

◆ TimelineScope