Inheritance diagram for Lusid.Sdk.Model.SettlementActivity:

Public Member Functions
	SettlementActivity (string activityId=default(string), ResourceId portfolioId=default(ResourceId), string activityType=default(string), string activityBasis=default(string), DateTimeOffset activityDate=default(DateTimeOffset), string settlementCategory=default(string), string transactionId=default(string), string settlementInstructionId=default(string), List< long > holdingIds=default(List< long >), string lusidInstrumentId=default(string), string instrumentScope=default(string), DateTimeOffset contractualSettlementDate=default(DateTimeOffset), ResourceId custodianAccountId=default(ResourceId), string custodianAccountNumber=default(string), string custodianAccountName=default(string), decimal units=default(decimal), string direction=default(string), decimal? daysOverdue=default(decimal?), OutputTransaction transaction=default(OutputTransaction), TransactionSettlementInstruction settlementInstruction=default(TransactionSettlementInstruction))
	Initializes a new instance of the SettlementActivity 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 (SettlementActivity input)
	Returns true if SettlementActivity instances are equal More...

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

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

Properties
string	ActivityId `[get, set]`
	A unique identifier for the settlement activity row, composed from the portfolio, activity type and the underlying transaction or settlement instruction. More...

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

string	ActivityType `[get, set]`
	The type of settlement activity: Expected for outstanding units that are due or overdue, or Settled for units that have settled. Available values: Expected, Settled. More...

string	ActivityBasis `[get, set]`
	The basis on which the settlement activity arose: Inferred for outstanding units, Automatic for units settled per the portfolio's settlement configuration, or Instruction for units settled by a settlement instruction. Available values: Inferred, Automatic, Instruction. More...

DateTimeOffset	ActivityDate `[get, set]`
	The date of the settlement activity. For Expected activity this is the query's end activity date; for Automatic settlement it is the contractual settlement date; for Instruction settlement it is the instruction's actual settlement date. More...

string	SettlementCategory `[get, set]`
	The settlement category of the underlying movements. Available values: StockSettlement, CashSettlement, DeferredCashReceipt, NotApplicable. More...

string	TransactionId `[get, set]`
	The identifier of the transaction that gave rise to this settlement activity. Always populated for Expected and Settled activity. More...

string	SettlementInstructionId `[get, set]`
	The identifier of the settlement instruction that settled the activity. Populated only for Instruction settlement; null for Inferred and Automatic activity. More...

List< long >	HoldingIds `[get, set]`
	The identifiers of the holdings whose movements contributed to this settlement activity. More...

string	LusidInstrumentId `[get, set]`
	The LUSID instrument identifier (LUID) of the instrument being settled. More...

string	InstrumentScope `[get, set]`
	The scope in which the instrument is defined. More...

DateTimeOffset	ContractualSettlementDate `[get, set]`
	The contractual settlement date of the underlying movements. More...

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

string	CustodianAccountNumber `[get, set]`
	The account number of the associated custodian account, if any. More...

string	CustodianAccountName `[get, set]`
	The name of the associated custodian account, if any. More...

decimal	Units `[get, set]`
	The signed number of units settled or expected to settle for this activity. More...

string	Direction `[get, set]`
	The direction of the settlement from the portfolio's perspective. Available values: Debit, Credit. More...

decimal?	DaysOverdue `[get, set]`
	The number of days the activity is overdue, calculated as the activity date minus the contractual settlement date. Zero for settled activity. More...

OutputTransaction	Transaction `[get, set]`
	Gets or Sets Transaction More...

TransactionSettlementInstruction	SettlementInstruction `[get, set]`
	Gets or Sets SettlementInstruction More...

Detailed Description

SettlementActivity

Constructor & Destructor Documentation

◆ SettlementActivity() [1/2]

Lusid.Sdk.Model.SettlementActivity.SettlementActivity ( )

inlineprotected

Initializes a new instance of the SettlementActivity class.

◆ SettlementActivity() [2/2]

Lusid.Sdk.Model.SettlementActivity.SettlementActivity	(	string	activityId = `default(string)`,
		ResourceId	portfolioId = `default(ResourceId)`,
		string	activityType = `default(string)`,
		string	activityBasis = `default(string)`,
		DateTimeOffset	activityDate = `default(DateTimeOffset)`,
		string	settlementCategory = `default(string)`,
		string	transactionId = `default(string)`,
		string	settlementInstructionId = `default(string)`,
		List< long >	holdingIds = `default(List<long>)`,
		string	lusidInstrumentId = `default(string)`,
		string	instrumentScope = `default(string)`,
		DateTimeOffset	contractualSettlementDate = `default(DateTimeOffset)`,
		ResourceId	custodianAccountId = `default(ResourceId)`,
		string	custodianAccountNumber = `default(string)`,
		string	custodianAccountName = `default(string)`,
		decimal	units = `default(decimal)`,
		string	direction = `default(string)`,
		decimal?	daysOverdue = `default(decimal?)`,
		OutputTransaction	transaction = `default(OutputTransaction)`,
		TransactionSettlementInstruction	settlementInstruction = `default(TransactionSettlementInstruction)`
	)

inline

Initializes a new instance of the SettlementActivity class.

Parameters

activityId	A unique identifier for the settlement activity row, composed from the portfolio, activity type and the underlying transaction or settlement instruction. (required).
portfolioId	portfolioId (required).
activityType	The type of settlement activity: Expected for outstanding units that are due or overdue, or Settled for units that have settled. Available values: Expected, Settled. (required).
activityBasis	The basis on which the settlement activity arose: Inferred for outstanding units, Automatic for units settled per the portfolio's settlement configuration, or Instruction for units settled by a settlement instruction. Available values: Inferred, Automatic, Instruction. (required).
activityDate	The date of the settlement activity. For Expected activity this is the query's end activity date; for Automatic settlement it is the contractual settlement date; for Instruction settlement it is the instruction's actual settlement date. (required).
settlementCategory	The settlement category of the underlying movements. Available values: StockSettlement, CashSettlement, DeferredCashReceipt, NotApplicable. (required).
transactionId	The identifier of the transaction that gave rise to this settlement activity. Always populated for Expected and Settled activity..
settlementInstructionId	The identifier of the settlement instruction that settled the activity. Populated only for Instruction settlement; null for Inferred and Automatic activity..
holdingIds	The identifiers of the holdings whose movements contributed to this settlement activity..
lusidInstrumentId	The LUSID instrument identifier (LUID) of the instrument being settled. (required).
instrumentScope	The scope in which the instrument is defined. (required).
contractualSettlementDate	The contractual settlement date of the underlying movements. (required).
custodianAccountId	custodianAccountId.
custodianAccountNumber	The account number of the associated custodian account, if any..
custodianAccountName	The name of the associated custodian account, if any..
units	The signed number of units settled or expected to settle for this activity. (required).
direction	The direction of the settlement from the portfolio's perspective. Available values: Debit, Credit. (required).
daysOverdue	The number of days the activity is overdue, calculated as the activity date minus the contractual settlement date. Zero for settled activity..
transaction	transaction.
settlementInstruction	settlementInstruction.

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if SettlementActivity instances are equal

Parameters

input Instance of SettlementActivity to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ ActivityBasis

string Lusid.Sdk.Model.SettlementActivity.ActivityBasis

getset

The basis on which the settlement activity arose: Inferred for outstanding units, Automatic for units settled per the portfolio's settlement configuration, or Instruction for units settled by a settlement instruction. Available values: Inferred, Automatic, Instruction.

◆ ActivityDate

DateTimeOffset Lusid.Sdk.Model.SettlementActivity.ActivityDate

getset

The date of the settlement activity. For Expected activity this is the query's end activity date; for Automatic settlement it is the contractual settlement date; for Instruction settlement it is the instruction's actual settlement date.

◆ ActivityId

string Lusid.Sdk.Model.SettlementActivity.ActivityId

getset

A unique identifier for the settlement activity row, composed from the portfolio, activity type and the underlying transaction or settlement instruction.

◆ ActivityType

string Lusid.Sdk.Model.SettlementActivity.ActivityType

getset

The type of settlement activity: Expected for outstanding units that are due or overdue, or Settled for units that have settled. Available values: Expected, Settled.

◆ ContractualSettlementDate

DateTimeOffset Lusid.Sdk.Model.SettlementActivity.ContractualSettlementDate

getset

The contractual settlement date of the underlying movements.

◆ CustodianAccountId

ResourceId Lusid.Sdk.Model.SettlementActivity.CustodianAccountId

getset

Gets or Sets CustodianAccountId

◆ CustodianAccountName

string Lusid.Sdk.Model.SettlementActivity.CustodianAccountName

getset

The name of the associated custodian account, if any.

◆ CustodianAccountNumber

string Lusid.Sdk.Model.SettlementActivity.CustodianAccountNumber

getset

The account number of the associated custodian account, if any.

◆ DaysOverdue

decimal? Lusid.Sdk.Model.SettlementActivity.DaysOverdue

getset

The number of days the activity is overdue, calculated as the activity date minus the contractual settlement date. Zero for settled activity.

◆ Direction

string Lusid.Sdk.Model.SettlementActivity.Direction

getset

The direction of the settlement from the portfolio's perspective. Available values: Debit, Credit.

◆ HoldingIds

List<long> Lusid.Sdk.Model.SettlementActivity.HoldingIds

getset

The identifiers of the holdings whose movements contributed to this settlement activity.

◆ InstrumentScope

string Lusid.Sdk.Model.SettlementActivity.InstrumentScope

getset

The scope in which the instrument is defined.

◆ LusidInstrumentId

string Lusid.Sdk.Model.SettlementActivity.LusidInstrumentId

getset

The LUSID instrument identifier (LUID) of the instrument being settled.

◆ PortfolioId

ResourceId Lusid.Sdk.Model.SettlementActivity.PortfolioId

getset

Gets or Sets PortfolioId

◆ SettlementCategory

string Lusid.Sdk.Model.SettlementActivity.SettlementCategory

getset

The settlement category of the underlying movements. Available values: StockSettlement, CashSettlement, DeferredCashReceipt, NotApplicable.

◆ SettlementInstruction

TransactionSettlementInstruction Lusid.Sdk.Model.SettlementActivity.SettlementInstruction

getset

Gets or Sets SettlementInstruction

◆ SettlementInstructionId

string Lusid.Sdk.Model.SettlementActivity.SettlementInstructionId

getset

The identifier of the settlement instruction that settled the activity. Populated only for Instruction settlement; null for Inferred and Automatic activity.

◆ Transaction

OutputTransaction Lusid.Sdk.Model.SettlementActivity.Transaction

getset

Gets or Sets Transaction

◆ TransactionId

string Lusid.Sdk.Model.SettlementActivity.TransactionId

getset

The identifier of the transaction that gave rise to this settlement activity. Always populated for Expected and Settled activity.

◆ Units

decimal Lusid.Sdk.Model.SettlementActivity.Units

getset

The signed number of units settled or expected to settle for this activity.

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

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ SettlementActivity() [1/2]

◆ SettlementActivity() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ ActivityBasis

◆ ActivityDate

◆ ActivityId

◆ ActivityType

◆ ContractualSettlementDate

◆ CustodianAccountId

◆ CustodianAccountName

◆ CustodianAccountNumber

◆ DaysOverdue

◆ Direction

◆ HoldingIds

◆ InstrumentScope

◆ LusidInstrumentId

◆ PortfolioId

◆ SettlementCategory

◆ SettlementInstruction

◆ SettlementInstructionId

◆ Transaction

◆ TransactionId

◆ Units