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

SettlementActivityQuery More...

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

Public Member Functions

 SettlementActivityQuery (DateTimeOffset? asAt=default(DateTimeOffset?), List< PortfolioEntityId > portfolioEntityIds=default(List< PortfolioEntityId >), DateTimeOrCutLabel startActivityDate=default(DateTimeOrCutLabel), DateTimeOrCutLabel endActivityDate=default(DateTimeOrCutLabel), string filter=default(string), List< string > settlementInstructionPropertyKeys=default(List< string >), List< string > transactionPropertyKeys=default(List< string >), int? limit=default(int?), string page=default(string))
 Initializes a new instance of the SettlementActivityQuery 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 (SettlementActivityQuery input)
 Returns true if SettlementActivityQuery instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Properties

DateTimeOffset? AsAt [get, set]
 The asAt time at which to query settlement activity. Defaults to latest. More...
 
List< PortfolioEntityIdPortfolioEntityIds [get, set]
 The portfolios and / or portfolio groups to query. At least one entry is required. More...
 
DateTimeOrCutLabel StartActivityDate [get, set]
 Lower bound (inclusive) of the activity date range. If not set, no lower bound is applied. More...
 
DateTimeOrCutLabel EndActivityDate [get, set]
 Upper bound (inclusive) of the activity date range. Defaults to the current date and time. Treated as effectiveAt. More...
 
string Filter [get, set]
 A LUSID standard filter expression. Supports traversal into transaction and settlementInstruction. More...
 
List< string > SettlementInstructionPropertyKeys [get, set]
 Settlement instruction property keys to populate on the response. Behaviour matches BuildSettlementInstructions. More...
 
List< string > TransactionPropertyKeys [get, set]
 Transaction property keys to populate on the response. Behaviour matches BuildSettlementInstructions. More...
 
int? Limit [get, set]
 Page size limit; standard pagination control. Defaults to 5000. More...
 
string Page [get, set]
 Pagination cursor returned by a previous response. More...
 

Detailed Description

SettlementActivityQuery

Constructor & Destructor Documentation

◆ SettlementActivityQuery()

Lusid.Sdk.Model.SettlementActivityQuery.SettlementActivityQuery ( DateTimeOffset?  asAt = default(DateTimeOffset?),
List< PortfolioEntityId portfolioEntityIds = default(List<PortfolioEntityId>),
DateTimeOrCutLabel  startActivityDate = default(DateTimeOrCutLabel),
DateTimeOrCutLabel  endActivityDate = default(DateTimeOrCutLabel),
string  filter = default(string),
List< string >  settlementInstructionPropertyKeys = default(List<string>),
List< string >  transactionPropertyKeys = default(List<string>),
int?  limit = default(int?),
string  page = default(string) 
)
inline

Initializes a new instance of the SettlementActivityQuery class.

Parameters
asAtThe asAt time at which to query settlement activity. Defaults to latest..
portfolioEntityIdsThe portfolios and / or portfolio groups to query. At least one entry is required..
startActivityDateLower bound (inclusive) of the activity date range. If not set, no lower bound is applied..
endActivityDateUpper bound (inclusive) of the activity date range. Defaults to the current date and time. Treated as effectiveAt..
filterA LUSID standard filter expression. Supports traversal into transaction and settlementInstruction..
settlementInstructionPropertyKeysSettlement instruction property keys to populate on the response. Behaviour matches BuildSettlementInstructions..
transactionPropertyKeysTransaction property keys to populate on the response. Behaviour matches BuildSettlementInstructions..
limitPage size limit; standard pagination control. Defaults to 5000..
pagePagination cursor returned by a previous response..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if SettlementActivityQuery instances are equal

Parameters
inputInstance of SettlementActivityQuery to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AsAt

DateTimeOffset? Lusid.Sdk.Model.SettlementActivityQuery.AsAt
getset

The asAt time at which to query settlement activity. Defaults to latest.

The asAt time at which to query settlement activity. Defaults to latest.

◆ EndActivityDate

DateTimeOrCutLabel Lusid.Sdk.Model.SettlementActivityQuery.EndActivityDate
getset

Upper bound (inclusive) of the activity date range. Defaults to the current date and time. Treated as effectiveAt.

Upper bound (inclusive) of the activity date range. Defaults to the current date and time. Treated as effectiveAt.

◆ Filter

string Lusid.Sdk.Model.SettlementActivityQuery.Filter
getset

A LUSID standard filter expression. Supports traversal into transaction and settlementInstruction.

A LUSID standard filter expression. Supports traversal into transaction and settlementInstruction.

◆ Limit

int? Lusid.Sdk.Model.SettlementActivityQuery.Limit
getset

Page size limit; standard pagination control. Defaults to 5000.

Page size limit; standard pagination control. Defaults to 5000.

◆ Page

string Lusid.Sdk.Model.SettlementActivityQuery.Page
getset

Pagination cursor returned by a previous response.

Pagination cursor returned by a previous response.

◆ PortfolioEntityIds

List<PortfolioEntityId> Lusid.Sdk.Model.SettlementActivityQuery.PortfolioEntityIds
getset

The portfolios and / or portfolio groups to query. At least one entry is required.

The portfolios and / or portfolio groups to query. At least one entry is required.

◆ SettlementInstructionPropertyKeys

List<string> Lusid.Sdk.Model.SettlementActivityQuery.SettlementInstructionPropertyKeys
getset

Settlement instruction property keys to populate on the response. Behaviour matches BuildSettlementInstructions.

Settlement instruction property keys to populate on the response. Behaviour matches BuildSettlementInstructions.

◆ StartActivityDate

DateTimeOrCutLabel Lusid.Sdk.Model.SettlementActivityQuery.StartActivityDate
getset

Lower bound (inclusive) of the activity date range. If not set, no lower bound is applied.

Lower bound (inclusive) of the activity date range. If not set, no lower bound is applied.

◆ TransactionPropertyKeys

List<string> Lusid.Sdk.Model.SettlementActivityQuery.TransactionPropertyKeys
getset

Transaction property keys to populate on the response. Behaviour matches BuildSettlementInstructions.

Transaction property keys to populate on the response. Behaviour matches BuildSettlementInstructions.


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