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

A single row in a Fund Cash Statement report. Each row represents a settled cash movement with running balance, cost basis, average rate, and realised FX PnL. More...

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

Public Member Functions

 FundCashStatementRow (int groupById=default(int), int sequenceNumber=default(int), Dictionary< string, PerpetualProperty > subHoldingKeys=default(Dictionary< string, PerpetualProperty >), string sourceId=default(string), string cashStatementActionType=default(string), DateTimeOffset accountingDate=default(DateTimeOffset), DateTimeOffset activityDate=default(DateTimeOffset), string movementName=default(string), ResourceId portfolioId=default(ResourceId), string instructionType=default(string), string diaryEntryCode=default(string), string originDiaryEntryCode=default(string), CurrencyAndAmount cashflowLocal=default(CurrencyAndAmount), CurrencyAndAmount balanceLocal=default(CurrencyAndAmount), CurrencyAndAmount cashflowBase=default(CurrencyAndAmount), CurrencyAndAmount realisedFxPnl=default(CurrencyAndAmount), CurrencyAndAmount costBasisBase=default(CurrencyAndAmount), decimal? avgRate=default(decimal?), decimal? fxRateMovement=default(decimal?), List< Link > links=default(List< Link >))
 Initializes a new instance of the FundCashStatementRow 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 (FundCashStatementRow input)
 Returns true if FundCashStatementRow instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Properties

int GroupById [get, set]
 The groupBy subHoldings and currency. More...
 
int SequenceNumber [get, set]
 Sequence number determining the order of the cash flow records. More...
 
Dictionary< string, PerpetualPropertySubHoldingKeys [get, set]
 The sub-holding properties which identify the holding. Each property will be from the &#39;Transaction&#39; domain. These are configured on a transaction portfolio. More...
 
string SourceId [get, set]
 The transaction ID that sourced this cash movement. More...
 
string CashStatementActionType [get, set]
 The action type: Default, Reversal, TrueUp, AvgRateCorrection, Opening, or Closing. More...
 
DateTimeOffset AccountingDate [get, set]
 The accounting date of the cash movement. More...
 
DateTimeOffset ActivityDate [get, set]
 The activity date (trade/settlement date) of the cash movement. More...
 
string MovementName [get, set]
 The movement type (e.g. Receivable_Cash_Trade, Payable_Cash_Trade). More...
 
ResourceId PortfolioId [get, set]
 Gets or Sets PortfolioId More...
 
string InstructionType [get, set]
 The settlement instruction type: Automatic, Instructed_Complete, Instructed - Cancel Automatic. More...
 
string DiaryEntryCode [get, set]
 The diary entry code of the valuation point this row belongs to. More...
 
string OriginDiaryEntryCode [get, set]
 For Reversal/TrueUp rows: the diary entry code of the period the original row belonged to. More...
 
CurrencyAndAmount CashflowLocal [get, set]
 Gets or Sets CashflowLocal More...
 
CurrencyAndAmount BalanceLocal [get, set]
 Gets or Sets BalanceLocal More...
 
CurrencyAndAmount CashflowBase [get, set]
 Gets or Sets CashflowBase More...
 
CurrencyAndAmount RealisedFxPnl [get, set]
 Gets or Sets RealisedFxPnl More...
 
CurrencyAndAmount CostBasisBase [get, set]
 Gets or Sets CostBasisBase More...
 
decimal? AvgRate [get, set]
 Weighted average FX rate (costBasisBase / balanceLocal). Null when balance is zero. More...
 
decimal? FxRateMovement [get, set]
 FX rate for this specific movement (CashflowBase / CashFlowLocal). Null when localAmount is zero. More...
 
List< LinkLinks [get, set]
 Gets or Sets Links More...
 

Detailed Description

A single row in a Fund Cash Statement report. Each row represents a settled cash movement with running balance, cost basis, average rate, and realised FX PnL.

Constructor & Destructor Documentation

◆ FundCashStatementRow()

Lusid.Sdk.Model.FundCashStatementRow.FundCashStatementRow ( int  groupById = default(int),
int  sequenceNumber = default(int),
Dictionary< string, PerpetualProperty subHoldingKeys = default(Dictionary<string, PerpetualProperty>),
string  sourceId = default(string),
string  cashStatementActionType = default(string),
DateTimeOffset  accountingDate = default(DateTimeOffset),
DateTimeOffset  activityDate = default(DateTimeOffset),
string  movementName = default(string),
ResourceId  portfolioId = default(ResourceId),
string  instructionType = default(string),
string  diaryEntryCode = default(string),
string  originDiaryEntryCode = default(string),
CurrencyAndAmount  cashflowLocal = default(CurrencyAndAmount),
CurrencyAndAmount  balanceLocal = default(CurrencyAndAmount),
CurrencyAndAmount  cashflowBase = default(CurrencyAndAmount),
CurrencyAndAmount  realisedFxPnl = default(CurrencyAndAmount),
CurrencyAndAmount  costBasisBase = default(CurrencyAndAmount),
decimal?  avgRate = default(decimal?),
decimal?  fxRateMovement = default(decimal?),
List< Link links = default(List<Link>) 
)
inline

Initializes a new instance of the FundCashStatementRow class.

Parameters
groupByIdThe groupBy subHoldings and currency..
sequenceNumberSequence number determining the order of the cash flow records..
subHoldingKeysThe sub-holding properties which identify the holding. Each property will be from the &#39;Transaction&#39; domain. These are configured on a transaction portfolio..
sourceIdThe transaction ID that sourced this cash movement..
cashStatementActionTypeThe action type: Default, Reversal, TrueUp, AvgRateCorrection, Opening, or Closing..
accountingDateThe accounting date of the cash movement..
activityDateThe activity date (trade/settlement date) of the cash movement..
movementNameThe movement type (e.g. Receivable_Cash_Trade, Payable_Cash_Trade)..
portfolioIdportfolioId.
instructionTypeThe settlement instruction type: Automatic, Instructed_Complete, Instructed - Cancel Automatic..
diaryEntryCodeThe diary entry code of the valuation point this row belongs to..
originDiaryEntryCodeFor Reversal/TrueUp rows: the diary entry code of the period the original row belonged to..
cashflowLocalcashflowLocal.
balanceLocalbalanceLocal.
cashflowBasecashflowBase.
realisedFxPnlrealisedFxPnl.
costBasisBasecostBasisBase.
avgRateWeighted average FX rate (costBasisBase / balanceLocal). Null when balance is zero..
fxRateMovementFX rate for this specific movement (CashflowBase / CashFlowLocal). Null when localAmount is zero..
linkslinks.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if FundCashStatementRow instances are equal

Parameters
inputInstance of FundCashStatementRow to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AccountingDate

DateTimeOffset Lusid.Sdk.Model.FundCashStatementRow.AccountingDate
getset

The accounting date of the cash movement.

The accounting date of the cash movement.

◆ ActivityDate

DateTimeOffset Lusid.Sdk.Model.FundCashStatementRow.ActivityDate
getset

The activity date (trade/settlement date) of the cash movement.

The activity date (trade/settlement date) of the cash movement.

◆ AvgRate

decimal? Lusid.Sdk.Model.FundCashStatementRow.AvgRate
getset

Weighted average FX rate (costBasisBase / balanceLocal). Null when balance is zero.

Weighted average FX rate (costBasisBase / balanceLocal). Null when balance is zero.

◆ BalanceLocal

CurrencyAndAmount Lusid.Sdk.Model.FundCashStatementRow.BalanceLocal
getset

Gets or Sets BalanceLocal

◆ CashflowBase

CurrencyAndAmount Lusid.Sdk.Model.FundCashStatementRow.CashflowBase
getset

Gets or Sets CashflowBase

◆ CashflowLocal

CurrencyAndAmount Lusid.Sdk.Model.FundCashStatementRow.CashflowLocal
getset

Gets or Sets CashflowLocal

◆ CashStatementActionType

string Lusid.Sdk.Model.FundCashStatementRow.CashStatementActionType
getset

The action type: Default, Reversal, TrueUp, AvgRateCorrection, Opening, or Closing.

The action type: Default, Reversal, TrueUp, AvgRateCorrection, Opening, or Closing.

◆ CostBasisBase

CurrencyAndAmount Lusid.Sdk.Model.FundCashStatementRow.CostBasisBase
getset

Gets or Sets CostBasisBase

◆ DiaryEntryCode

string Lusid.Sdk.Model.FundCashStatementRow.DiaryEntryCode
getset

The diary entry code of the valuation point this row belongs to.

The diary entry code of the valuation point this row belongs to.

◆ FxRateMovement

decimal? Lusid.Sdk.Model.FundCashStatementRow.FxRateMovement
getset

FX rate for this specific movement (CashflowBase / CashFlowLocal). Null when localAmount is zero.

FX rate for this specific movement (CashflowBase / CashFlowLocal). Null when localAmount is zero.

◆ GroupById

int Lusid.Sdk.Model.FundCashStatementRow.GroupById
getset

The groupBy subHoldings and currency.

The groupBy subHoldings and currency.

◆ InstructionType

string Lusid.Sdk.Model.FundCashStatementRow.InstructionType
getset

The settlement instruction type: Automatic, Instructed_Complete, Instructed - Cancel Automatic.

The settlement instruction type: Automatic, Instructed_Complete, Instructed - Cancel Automatic.

◆ Links

List<Link> Lusid.Sdk.Model.FundCashStatementRow.Links
getset

Gets or Sets Links

◆ MovementName

string Lusid.Sdk.Model.FundCashStatementRow.MovementName
getset

The movement type (e.g. Receivable_Cash_Trade, Payable_Cash_Trade).

The movement type (e.g. Receivable_Cash_Trade, Payable_Cash_Trade).

◆ OriginDiaryEntryCode

string Lusid.Sdk.Model.FundCashStatementRow.OriginDiaryEntryCode
getset

For Reversal/TrueUp rows: the diary entry code of the period the original row belonged to.

For Reversal/TrueUp rows: the diary entry code of the period the original row belonged to.

◆ PortfolioId

ResourceId Lusid.Sdk.Model.FundCashStatementRow.PortfolioId
getset

Gets or Sets PortfolioId

◆ RealisedFxPnl

CurrencyAndAmount Lusid.Sdk.Model.FundCashStatementRow.RealisedFxPnl
getset

Gets or Sets RealisedFxPnl

◆ SequenceNumber

int Lusid.Sdk.Model.FundCashStatementRow.SequenceNumber
getset

Sequence number determining the order of the cash flow records.

Sequence number determining the order of the cash flow records.

◆ SourceId

string Lusid.Sdk.Model.FundCashStatementRow.SourceId
getset

The transaction ID that sourced this cash movement.

The transaction ID that sourced this cash movement.

◆ SubHoldingKeys

Dictionary<string, PerpetualProperty> Lusid.Sdk.Model.FundCashStatementRow.SubHoldingKeys
getset

The sub-holding properties which identify the holding. Each property will be from the &#39;Transaction&#39; domain. These are configured on a transaction portfolio.

The sub-holding properties which identify the holding. Each property will be from the &#39;Transaction&#39; domain. These are configured on a transaction portfolio.


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