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

A Journal Entry line entity. More...

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

Public Member Functions

 JournalEntryLine (DateTimeOffset accountingDate=default(DateTimeOffset), DateTimeOffset activityDate=default(DateTimeOffset), ResourceId portfolioId=default(ResourceId), string instrumentId=default(string), string instrumentScope=default(string), Dictionary< string, PerpetualProperty > subHoldingKeys=default(Dictionary< string, PerpetualProperty >), string taxLotId=default(string), string generalLedgerAccountCode=default(string), CurrencyAndAmount local=default(CurrencyAndAmount), CurrencyAndAmount varBase=default(CurrencyAndAmount), decimal units=default(decimal), string postingModuleCode=default(string), string postingRule=default(string), DateTimeOffset asAtDate=default(DateTimeOffset), string activitiesDescription=default(string), string sourceType=default(string), string sourceId=default(string), Dictionary< string, Property > properties=default(Dictionary< string, Property >), string movementName=default(string), string holdingType=default(string), string economicBucket=default(string), string economicBucketComponent=default(string), string economicBucketVariant=default(string), List< string > levels=default(List< string >), List< string > sourceLevels=default(List< string >), string movementSign=default(string), string holdingSign=default(string), string ledgerColumn=default(string), string journalEntryLineType=default(string), List< Link > links=default(List< Link >))
 Initializes a new instance of the JournalEntryLine 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 (JournalEntryLine input)
 Returns true if JournalEntryLine instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 JournalEntryLine ()
 Initializes a new instance of the JournalEntryLine class. More...
 

Properties

DateTimeOffset AccountingDate [get, set]
 The Journal Entry Line accounting date. More...
 
DateTimeOffset ActivityDate [get, set]
 The actual date of the activity. Differs from the accounting date when creating journals that would occur in a closed period. More...
 
ResourceId PortfolioId [get, set]
 Gets or Sets PortfolioId More...
 
string InstrumentId [get, set]
 To indicate the instrument of the transaction that the Journal Entry Line posted for, if applicable. More...
 
string InstrumentScope [get, set]
 The scope in which the Journal Entry Line instrument is in. More...
 
Dictionary< string, PerpetualPropertySubHoldingKeys [get, set]
 The sub-holding properties which are part of the AccountingKey. More...
 
string TaxLotId [get, set]
 If the holding type is &#39;B&#39; (settled cash balance), this is 1. Otherwise, this is the ID of a tax lot if applicable, or the source ID of the original transaction if not. More...
 
string GeneralLedgerAccountCode [get, set]
 The code of the account in the general ledger the Journal Entry was posted to. More...
 
CurrencyAndAmount Local [get, set]
 Gets or Sets Local More...
 
CurrencyAndAmount Base [get, set]
 Gets or Sets Base More...
 
decimal Units [get, set]
 Units held for the Journal Entry Line. More...
 
string PostingModuleCode [get, set]
 The code of the posting module where the posting rules derived the Journal Entry lines. More...
 
string PostingRule [get, set]
 The rule generating the Journal Entry Line. More...
 
DateTimeOffset AsAtDate [get, set]
 The corresponding input date and time of the Transaction generating the Journal Entry Line. More...
 
string ActivitiesDescription [get, set]
 This would be the description of the business activities this Journal Entry Line is for. More...
 
string SourceType [get, set]
 The type of source for the Journal Entry Line. Available values: LusidTransaction, LusidValuation, Manual, External. More...
 
string SourceId [get, set]
 For the Lusid Source Type this will be the txn Id. For the rest will be what the user populates. More...
 
Dictionary< string, PropertyProperties [get, set]
 A set of properties for the Abor. More...
 
string MovementName [get, set]
 If the JE Line is generated from a transaction, the name of the side in the transaction type&#39;s movement. If from a valuation, this is &#39;MarkToMarket&#39;. More...
 
string HoldingType [get, set]
 One of the LUSID holding types such as &#39;P&#39; for position or &#39;B&#39; for settled cash balance. More...
 
string EconomicBucket [get, set]
 LUSID automatically categorises a JE Line into a broad economic bucket such as &#39;NA_Cost&#39; or &#39;PL_RealPriceGL&#39;. More...
 
string EconomicBucketComponent [get, set]
 Sub bucket of the economic bucket. Available values: Undefined, Premium, OID, MarketDiscount, AcquisitionPremium, CoreMarket, CrossGainLoss, TradedInterest, Income, Expense. More...
 
string EconomicBucketVariant [get, set]
 Further categorisation of a journal entry line. LongTerm/ShortTerm: based on whether the ActivityDate is more than a year after the purchase trade date. TradeDateToSettlementDate: FX gain/loss between trade date and settlement date. InLieuSubstitution: FX gain/loss from settling in a different currency when the original settlement currency is the portfolio base currency. Available values: Undefined, ShortTerm, LongTerm, Bought, Sold, TradeDateToSettlementDate, Rounding, InLieuSubstitution. More...
 
List< string > Levels [get, set]
 Resolved data from the general ledger profile where the GeneralLedgerProfileCode is specified in the GetJournalEntryLines request body. More...
 
List< string > SourceLevels [get, set]
 Source data from the general ledger profile where the GeneralLedgerProfileCode is specified in the GetJournalEntryLines request body. More...
 
string MovementSign [get, set]
 Indicates if the Journal Entry Line corresponds to a Long or Short movement. Available values: NA, Long, Short. More...
 
string HoldingSign [get, set]
 Indicates if the Journal Entry Line is operating against a Long or Short holding. Available values: NA, Long, Short. More...
 
string LedgerColumn [get, set]
 Indicates if the Journal Entry Line is credit or debit. Available values: Debit, Credit. More...
 
string JournalEntryLineType [get, set]
 Indicates the Journal Entry Line type. Available values: Default, Reversal, TrueUp. More...
 
List< LinkLinks [get, set]
 Gets or Sets Links More...
 

Detailed Description

A Journal Entry line entity.

Constructor & Destructor Documentation

◆ JournalEntryLine() [1/2]

Lusid.Sdk.Model.JournalEntryLine.JournalEntryLine ( )
inlineprotected

Initializes a new instance of the JournalEntryLine class.

◆ JournalEntryLine() [2/2]

Lusid.Sdk.Model.JournalEntryLine.JournalEntryLine ( DateTimeOffset  accountingDate = default(DateTimeOffset),
DateTimeOffset  activityDate = default(DateTimeOffset),
ResourceId  portfolioId = default(ResourceId),
string  instrumentId = default(string),
string  instrumentScope = default(string),
Dictionary< string, PerpetualProperty subHoldingKeys = default(Dictionary<string, PerpetualProperty>),
string  taxLotId = default(string),
string  generalLedgerAccountCode = default(string),
CurrencyAndAmount  local = default(CurrencyAndAmount),
CurrencyAndAmount  varBase = default(CurrencyAndAmount),
decimal  units = default(decimal),
string  postingModuleCode = default(string),
string  postingRule = default(string),
DateTimeOffset  asAtDate = default(DateTimeOffset),
string  activitiesDescription = default(string),
string  sourceType = default(string),
string  sourceId = default(string),
Dictionary< string, Property properties = default(Dictionary<string, Property>),
string  movementName = default(string),
string  holdingType = default(string),
string  economicBucket = default(string),
string  economicBucketComponent = default(string),
string  economicBucketVariant = default(string),
List< string >  levels = default(List<string>),
List< string >  sourceLevels = default(List<string>),
string  movementSign = default(string),
string  holdingSign = default(string),
string  ledgerColumn = default(string),
string  journalEntryLineType = default(string),
List< Link links = default(List<Link>) 
)
inline

Initializes a new instance of the JournalEntryLine class.

Parameters
accountingDateThe Journal Entry Line accounting date. (required).
activityDateThe actual date of the activity. Differs from the accounting date when creating journals that would occur in a closed period. (required).
portfolioIdportfolioId (required).
instrumentIdTo indicate the instrument of the transaction that the Journal Entry Line posted for, if applicable. (required).
instrumentScopeThe scope in which the Journal Entry Line instrument is in. (required).
subHoldingKeysThe sub-holding properties which are part of the AccountingKey..
taxLotIdIf the holding type is &#39;B&#39; (settled cash balance), this is 1. Otherwise, this is the ID of a tax lot if applicable, or the source ID of the original transaction if not..
generalLedgerAccountCodeThe code of the account in the general ledger the Journal Entry was posted to. (required).
locallocal (required).
varBasevarBase (required).
unitsUnits held for the Journal Entry Line. (required).
postingModuleCodeThe code of the posting module where the posting rules derived the Journal Entry lines..
postingRuleThe rule generating the Journal Entry Line. (required).
asAtDateThe corresponding input date and time of the Transaction generating the Journal Entry Line. (required).
activitiesDescriptionThis would be the description of the business activities this Journal Entry Line is for..
sourceTypeThe type of source for the Journal Entry Line. Available values: LusidTransaction, LusidValuation, Manual, External. (required).
sourceIdFor the Lusid Source Type this will be the txn Id. For the rest will be what the user populates. (required).
propertiesA set of properties for the Abor..
movementNameIf the JE Line is generated from a transaction, the name of the side in the transaction type&#39;s movement. If from a valuation, this is &#39;MarkToMarket&#39;..
holdingTypeOne of the LUSID holding types such as &#39;P&#39; for position or &#39;B&#39; for settled cash balance. (required).
economicBucketLUSID automatically categorises a JE Line into a broad economic bucket such as &#39;NA_Cost&#39; or &#39;PL_RealPriceGL&#39;. (required).
economicBucketComponentSub bucket of the economic bucket. Available values: Undefined, Premium, OID, MarketDiscount, AcquisitionPremium, CoreMarket, CrossGainLoss, TradedInterest, Income, Expense..
economicBucketVariantFurther categorisation of a journal entry line. LongTerm/ShortTerm: based on whether the ActivityDate is more than a year after the purchase trade date. TradeDateToSettlementDate: FX gain/loss between trade date and settlement date. InLieuSubstitution: FX gain/loss from settling in a different currency when the original settlement currency is the portfolio base currency. Available values: Undefined, ShortTerm, LongTerm, Bought, Sold, TradeDateToSettlementDate, Rounding, InLieuSubstitution..
levelsResolved data from the general ledger profile where the GeneralLedgerProfileCode is specified in the GetJournalEntryLines request body..
sourceLevelsSource data from the general ledger profile where the GeneralLedgerProfileCode is specified in the GetJournalEntryLines request body..
movementSignIndicates if the Journal Entry Line corresponds to a Long or Short movement. Available values: NA, Long, Short..
holdingSignIndicates if the Journal Entry Line is operating against a Long or Short holding. Available values: NA, Long, Short..
ledgerColumnIndicates if the Journal Entry Line is credit or debit. Available values: Debit, Credit..
journalEntryLineTypeIndicates the Journal Entry Line type. Available values: Default, Reversal, TrueUp..
linkslinks.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if JournalEntryLine instances are equal

Parameters
inputInstance of JournalEntryLine to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AccountingDate

DateTimeOffset Lusid.Sdk.Model.JournalEntryLine.AccountingDate
getset

The Journal Entry Line accounting date.

The Journal Entry Line accounting date.

◆ ActivitiesDescription

string Lusid.Sdk.Model.JournalEntryLine.ActivitiesDescription
getset

This would be the description of the business activities this Journal Entry Line is for.

This would be the description of the business activities this Journal Entry Line is for.

◆ ActivityDate

DateTimeOffset Lusid.Sdk.Model.JournalEntryLine.ActivityDate
getset

The actual date of the activity. Differs from the accounting date when creating journals that would occur in a closed period.

The actual date of the activity. Differs from the accounting date when creating journals that would occur in a closed period.

◆ AsAtDate

DateTimeOffset Lusid.Sdk.Model.JournalEntryLine.AsAtDate
getset

The corresponding input date and time of the Transaction generating the Journal Entry Line.

The corresponding input date and time of the Transaction generating the Journal Entry Line.

◆ Base

CurrencyAndAmount Lusid.Sdk.Model.JournalEntryLine.Base
getset

Gets or Sets Base

◆ EconomicBucket

string Lusid.Sdk.Model.JournalEntryLine.EconomicBucket
getset

LUSID automatically categorises a JE Line into a broad economic bucket such as &#39;NA_Cost&#39; or &#39;PL_RealPriceGL&#39;.

LUSID automatically categorises a JE Line into a broad economic bucket such as &#39;NA_Cost&#39; or &#39;PL_RealPriceGL&#39;.

◆ EconomicBucketComponent

string Lusid.Sdk.Model.JournalEntryLine.EconomicBucketComponent
getset

Sub bucket of the economic bucket. Available values: Undefined, Premium, OID, MarketDiscount, AcquisitionPremium, CoreMarket, CrossGainLoss, TradedInterest, Income, Expense.

Sub bucket of the economic bucket. Available values: Undefined, Premium, OID, MarketDiscount, AcquisitionPremium, CoreMarket, CrossGainLoss, TradedInterest, Income, Expense.

◆ EconomicBucketVariant

string Lusid.Sdk.Model.JournalEntryLine.EconomicBucketVariant
getset

Further categorisation of a journal entry line. LongTerm/ShortTerm: based on whether the ActivityDate is more than a year after the purchase trade date. TradeDateToSettlementDate: FX gain/loss between trade date and settlement date. InLieuSubstitution: FX gain/loss from settling in a different currency when the original settlement currency is the portfolio base currency. Available values: Undefined, ShortTerm, LongTerm, Bought, Sold, TradeDateToSettlementDate, Rounding, InLieuSubstitution.

Further categorisation of a journal entry line. LongTerm/ShortTerm: based on whether the ActivityDate is more than a year after the purchase trade date. TradeDateToSettlementDate: FX gain/loss between trade date and settlement date. InLieuSubstitution: FX gain/loss from settling in a different currency when the original settlement currency is the portfolio base currency. Available values: Undefined, ShortTerm, LongTerm, Bought, Sold, TradeDateToSettlementDate, Rounding, InLieuSubstitution.

◆ GeneralLedgerAccountCode

string Lusid.Sdk.Model.JournalEntryLine.GeneralLedgerAccountCode
getset

The code of the account in the general ledger the Journal Entry was posted to.

The code of the account in the general ledger the Journal Entry was posted to.

◆ HoldingSign

string Lusid.Sdk.Model.JournalEntryLine.HoldingSign
getset

Indicates if the Journal Entry Line is operating against a Long or Short holding. Available values: NA, Long, Short.

Indicates if the Journal Entry Line is operating against a Long or Short holding. Available values: NA, Long, Short.

◆ HoldingType

string Lusid.Sdk.Model.JournalEntryLine.HoldingType
getset

One of the LUSID holding types such as &#39;P&#39; for position or &#39;B&#39; for settled cash balance.

One of the LUSID holding types such as &#39;P&#39; for position or &#39;B&#39; for settled cash balance.

◆ InstrumentId

string Lusid.Sdk.Model.JournalEntryLine.InstrumentId
getset

To indicate the instrument of the transaction that the Journal Entry Line posted for, if applicable.

To indicate the instrument of the transaction that the Journal Entry Line posted for, if applicable.

◆ InstrumentScope

string Lusid.Sdk.Model.JournalEntryLine.InstrumentScope
getset

The scope in which the Journal Entry Line instrument is in.

The scope in which the Journal Entry Line instrument is in.

◆ JournalEntryLineType

string Lusid.Sdk.Model.JournalEntryLine.JournalEntryLineType
getset

Indicates the Journal Entry Line type. Available values: Default, Reversal, TrueUp.

Indicates the Journal Entry Line type. Available values: Default, Reversal, TrueUp.

◆ LedgerColumn

string Lusid.Sdk.Model.JournalEntryLine.LedgerColumn
getset

Indicates if the Journal Entry Line is credit or debit. Available values: Debit, Credit.

Indicates if the Journal Entry Line is credit or debit. Available values: Debit, Credit.

◆ Levels

List<string> Lusid.Sdk.Model.JournalEntryLine.Levels
getset

Resolved data from the general ledger profile where the GeneralLedgerProfileCode is specified in the GetJournalEntryLines request body.

Resolved data from the general ledger profile where the GeneralLedgerProfileCode is specified in the GetJournalEntryLines request body.

◆ Links

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

Gets or Sets Links

◆ Local

CurrencyAndAmount Lusid.Sdk.Model.JournalEntryLine.Local
getset

Gets or Sets Local

◆ MovementName

string Lusid.Sdk.Model.JournalEntryLine.MovementName
getset

If the JE Line is generated from a transaction, the name of the side in the transaction type&#39;s movement. If from a valuation, this is &#39;MarkToMarket&#39;.

If the JE Line is generated from a transaction, the name of the side in the transaction type&#39;s movement. If from a valuation, this is &#39;MarkToMarket&#39;.

◆ MovementSign

string Lusid.Sdk.Model.JournalEntryLine.MovementSign
getset

Indicates if the Journal Entry Line corresponds to a Long or Short movement. Available values: NA, Long, Short.

Indicates if the Journal Entry Line corresponds to a Long or Short movement. Available values: NA, Long, Short.

◆ PortfolioId

ResourceId Lusid.Sdk.Model.JournalEntryLine.PortfolioId
getset

Gets or Sets PortfolioId

◆ PostingModuleCode

string Lusid.Sdk.Model.JournalEntryLine.PostingModuleCode
getset

The code of the posting module where the posting rules derived the Journal Entry lines.

The code of the posting module where the posting rules derived the Journal Entry lines.

◆ PostingRule

string Lusid.Sdk.Model.JournalEntryLine.PostingRule
getset

The rule generating the Journal Entry Line.

The rule generating the Journal Entry Line.

◆ Properties

Dictionary<string, Property> Lusid.Sdk.Model.JournalEntryLine.Properties
getset

A set of properties for the Abor.

A set of properties for the Abor.

◆ SourceId

string Lusid.Sdk.Model.JournalEntryLine.SourceId
getset

For the Lusid Source Type this will be the txn Id. For the rest will be what the user populates.

For the Lusid Source Type this will be the txn Id. For the rest will be what the user populates.

◆ SourceLevels

List<string> Lusid.Sdk.Model.JournalEntryLine.SourceLevels
getset

Source data from the general ledger profile where the GeneralLedgerProfileCode is specified in the GetJournalEntryLines request body.

Source data from the general ledger profile where the GeneralLedgerProfileCode is specified in the GetJournalEntryLines request body.

◆ SourceType

string Lusid.Sdk.Model.JournalEntryLine.SourceType
getset

The type of source for the Journal Entry Line. Available values: LusidTransaction, LusidValuation, Manual, External.

The type of source for the Journal Entry Line. Available values: LusidTransaction, LusidValuation, Manual, External.

◆ SubHoldingKeys

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

The sub-holding properties which are part of the AccountingKey.

The sub-holding properties which are part of the AccountingKey.

◆ TaxLotId

string Lusid.Sdk.Model.JournalEntryLine.TaxLotId
getset

If the holding type is &#39;B&#39; (settled cash balance), this is 1. Otherwise, this is the ID of a tax lot if applicable, or the source ID of the original transaction if not.

If the holding type is &#39;B&#39; (settled cash balance), this is 1. Otherwise, this is the ID of a tax lot if applicable, or the source ID of the original transaction if not.

◆ Units

decimal Lusid.Sdk.Model.JournalEntryLine.Units
getset

Units held for the Journal Entry Line.

Units held for the Journal Entry Line.


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