Interface ICapitalAccountDataItem
The system entity for a Capital Account Data Item, which is part of a IPeriodEnd process
See https://help.lemonedge.com/help/open-architecture/admin/teams/canvases-view.html for more information
Inherited Members
Namespace: LemonEdge.API.Entities.FinancialServices.Accounting
Assembly: LemonEdge.API.Entities.FinancialServices.dll
Syntax
[EntityDefinition(EntityID.CapitalAccountDataItem, "dbo.LT_CapitalAccountDataItems", "CapitalAccountDataItem", IsStandingDataEntity = false, SelectWithNoLock = true, HasClusteredPrimaryKey = true)]
[DefaultEntityIcon(ImageType.ScalesMoney)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.DataSourceIDs, "EntityID", "ID", ExcludeFromRelationship = true)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.Transaction, "ParentItemID", "ID", ExcludeFromRelationship = true)]
[EntityIndex(Name = "PeriodEnd", ColumnNames = new string[] { "PeriodEndID", "PeriodEndAdjustmentID", "EntityID" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending, IndexOrder.Ascending, IndexOrder.Ascending }, IncludeColumns = new string[] { "Status", "RootEntityID", "EntitySetEntityID", "OriginalEntityID", "LedgerID", "TransactionCodeID", "TransactionTypeValueID", "InstrumentID", "GLAccountID", "SubGLAccountID", "RelatedEntityID" }, IsClustered = false, IsUnique = false)]
public interface ICapitalAccountDataItem : ITransactionalEntity, ICanBeLocked, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties
Properties
EffectiveDate
The effective date this amount is effective from
Declaration
[EntityProperty(SQLType.DateTimeOffset, false, IsDate = true)]
[EntityKeyProperty]
[Required]
[EntityDescription("The effective date this amount is effective from.")]
DateTimeOffset EffectiveDate { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset |
EntityID
[Key] Links to IObjectEntity. The ultimate owning Entity this GL Posting amount was allocated to directly or through an Allocation Path
The entity for this record. If null there is likely an error inallocaion, and it should be resolved and re-run
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.ObjectEntity, "ID", SingleJoinType.ZeroToOne, "Allocated To Entity", "Period End Data Items Allocated To", PreventAutoConstraint = true)]
[EntityDescription("The entity for this record. If null there is likely an error inallocaion, and it should be resolved and re-run.")]
[EntityKeyProperty]
Guid? EntityID { get; set; }
Property Value
Type | Description |
---|---|
Guid? |
EntitySetEntityID
[Key] Links to IObjectEntity. The actual legal entity within the entity set these GL Postings entries were against.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.ObjectEntity, "ID", SingleJoinType.One, "Allocated Entity", "Period End Data Items As Entity Set Entity", PreventAutoConstraint = true)]
[EntityDescription("The entity in the entity set these amounts originate from.")]
[RequiredNoDefaultIDValidation]
[EntityKeyProperty]
Guid EntitySetEntityID { get; set; }
Property Value
Type | Description |
---|---|
Guid |
FromUnderlyingEntitySetID
[Key] Indicates if these amounts come from an underlying fund and have been allocated up via chained allocations
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.EntitySet, "ID", SingleJoinType.ZeroToOne, "From Underlying Entity Set", "Period End Data Items", PreventAutoConstraint = true)]
[EntityKeyProperty]
[EntityDescription("Indicates if these amounts come from an underlying fund and have been allocated up via chained allocations.")]
Guid? FromUnderlyingEntitySetID { get; set; }
Property Value
Type | Description |
---|---|
Guid? |
GLAccountID
[Key] Links to IGLAccount. The GL Account this amount (In reporting currency) debited or credited
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.GLAccount, "ID", SingleJoinType.ZeroToOne, "GL Account", "Period End Data Items", PreventAutoConstraint = true)]
[EntityDescription("The gl account (if not rounding, opening balance, aggregates, etc) this data relates to.")]
[EntityKeyProperty]
Guid? GLAccountID { get; set; }
Property Value
Type | Description |
---|---|
Guid? |
ITDCSE
The Inception To Date movement in CSE for this entity
Declaration
[EntityProperty(SQLType.Decimal, 31, 18, true)]
[EntityDescription("The Inception To Date movement in CSE for this entity.")]
decimal? ITDCSE { get; set; }
Property Value
Type | Description |
---|---|
decimal? |
ITDFuncAmount
The Inception To Date debit/credit amount in total for this gl account in functional currency
Declaration
[EntityProperty(SQLType.Decimal, 21, 3, false, "0")]
[EntityDescription("The Inception To Date debit/credit amount in total for this gl account in reporting currency.")]
decimal ITDFuncAmount { get; set; }
Property Value
Type | Description |
---|---|
decimal |
ITDLocalAmount
The Inception To Date debit/credit amount in total for this gl account in local currency
Declaration
[EntityProperty(SQLType.Decimal, 21, 3, false, "0")]
[EntityDescription("The Inception To Date debit/credit amount in total for this gl account in local currency.")]
decimal ITDLocalAmount { get; set; }
Property Value
Type | Description |
---|---|
decimal |
ITDReportingAmount
The Inception To Date debit/credit amount in total for this gl account in reporting currency
Declaration
[EntityProperty(SQLType.Decimal, 21, 3, false, "0")]
[EntityDescription("The Inception To Date debit/credit amount in total for this gl account in reporting currency.")]
decimal ITDReportingAmount { get; set; }
Property Value
Type | Description |
---|---|
decimal |
ITDUnits
The Inception To Date movement in units for this entity
Declaration
[EntityProperty(SQLType.Decimal, 31, 18, true)]
[EntityDescription("The Inception To Date movement in units for this entity.")]
decimal? ITDUnits { get; set; }
Property Value
Type | Description |
---|---|
decimal? |
InstrumentID
[Key] Links to IInstrument. The Instrument (if any) for the Transaction this GL Posting was booked against
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.Instrument, "ID", SingleJoinType.ZeroToOne, "Instrument", "Period End Data Items", PreventAutoConstraint = true)]
[EntityDescription("The instrument these portfolio entries are allocated from.")]
[EntityKeyProperty]
Guid? InstrumentID { get; set; }
Property Value
Type | Description |
---|---|
Guid? |
IsCommitted
[Key] Represents if this amount was derived from a committed transaction
Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Represents if this amount was derived from a committed transaction.")]
[EntityKeyProperty]
bool IsCommitted { get; set; }
Property Value
Type | Description |
---|---|
bool |
IsDynamicallyAllocated
[Key] Indicates this amount was allocated from an underlying transaction dynamically through a path during the period end process
Declaration
[EntityProperty(SQLType.Bit, false, "(case when OriginalEntityID <> EntitySetEntityID or InstrumentID is not null then 1 else 0 end)")]
[EntityDescription("Indicates this amount was allocated from an underlying transaction dynamically through a path during the period end process.")]
[EntityKeyProperty]
bool IsDynamicallyAllocated { get; set; }
Property Value
Type | Description |
---|---|
bool |
IsRounding
[Key] Represents if this amount was added by the calculation for rounding purposes
Declaration
[EntityProperty(SQLType.Bit, false)]
[EntityDescription("Indicates this record is used for rounding amounts.")]
[EntityKeyProperty]
bool IsRounding { get; set; }
Property Value
Type | Description |
---|---|
bool |
LedgerID
[Key] Links to ILedger. The Ledger this GL Posting amount was booked to
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.Ledger, "ID", SingleJoinType.One, "Ledger", "Period End Data Items", PreventAutoConstraint = true)]
[EntityDescription("The ledger matching amounts roll up for.")]
[RequiredNoDefaultIDValidation]
[EntityKeyProperty]
Guid LedgerID { get; set; }
Property Value
Type | Description |
---|---|
Guid |
LocalCurrencyID
Links to ICurrency. The currency id
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false, "IsNull(case when instrumentid is not null then (select top 1 i.CurrencyID from LT_Instruments i where i.ID = InstrumentID and i.AccountID = AccountID) else (select top 1 o.CurrencyID from LT_ObjectEntities o where o.ID = OriginalEntityID and o.AccountID = AccountID) end, '00000000-0000-0000-0000-000000000000')")]
[EntityRelationship(EntityID.Currency, "ID", SingleJoinType.One, "Local Currency", "Period End Data Items Local Currency", PreventAutoConstraint = true)]
[EntityDescription("The local currency for these values.")]
[RequiredNoDefaultIDValidation]
[EntityKeyProperty]
Guid LocalCurrencyID { get; set; }
Property Value
Type | Description |
---|---|
Guid |
OriginalEntityID
[Key] Links to IObjectEntity. The actual original entity this amount was allocated through a path from
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false, "EntitySetEntityID")]
[EntityRelationship(EntityID.ObjectEntity, "ID", SingleJoinType.One, "Original Entity", "Period End Data Items As Original Entity", PreventAutoConstraint = true)]
[EntityDescription("The actual original entity this amount was allocated through a path from.")]
[RequiredNoDefaultIDValidation]
[EntityKeyProperty]
Guid OriginalEntityID { get; set; }
Property Value
Type | Description |
---|---|
Guid |
PTDCSE
The Period To Date movement in CSE for this entity
Declaration
[EntityProperty(SQLType.Decimal, 31, 18, true)]
[EntityDescription("The Period To Date movement in CSE for this entity.")]
decimal? PTDCSE { get; set; }
Property Value
Type | Description |
---|---|
decimal? |
PTDFuncAmount
The Period To Date debit/credit amount in total for this gl account in functional currency
Declaration
[EntityProperty(SQLType.Decimal, 21, 3, false, "0")]
[EntityDescription("The Period To Date debit/credit amount in total for this gl account in reporting currency.")]
decimal PTDFuncAmount { get; set; }
Property Value
Type | Description |
---|---|
decimal |
PTDLocalAmount
The Period To Date debit/credit amount in total for this gl account in local currency
Declaration
[EntityProperty(SQLType.Decimal, 21, 3, false, "0")]
[EntityDescription("The Period To Date debit/credit amount in total for this gl account in local currency.")]
decimal PTDLocalAmount { get; set; }
Property Value
Type | Description |
---|---|
decimal |
PTDReportingAmount
The Period To Date debit/credit amount in total for this gl account in reporting currency
Declaration
[EntityProperty(SQLType.Decimal, 21, 3, false, "0")]
[EntityDescription("The Period To Date debit/credit amount in total for this gl account in reporting currency.")]
decimal PTDReportingAmount { get; set; }
Property Value
Type | Description |
---|---|
decimal |
PTDUnits
The Period To Date movement in units for this entity
Declaration
[EntityProperty(SQLType.Decimal, 31, 18, true)]
[EntityDescription("The Period To Date movement in units for this entity.")]
decimal? PTDUnits { get; set; }
Property Value
Type | Description |
---|---|
decimal? |
PeriodEndAdjustmentID
[Key] Links to IPeriodEndAdjustment. If this record was manually made this will hold the parent adjustment it is a part of
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityKeyProperty]
[EntityRelationship(EntityID.PeriodEndAdjustment, "ID", SingleJoinType.ZeroToOne, "Period End Adjustment", "Data Items", DeleteWithRelationship = true, PartOfParentSet = true, PreventAutoConstraint = true)]
Guid? PeriodEndAdjustmentID { get; set; }
Property Value
Type | Description |
---|---|
Guid? |
PeriodEndID
[Key] Links to IPeriodEnd. The parent period end this is a part of
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityKeyProperty]
[EntityRelationship(EntityID.PeriodEnd, "ID", SingleJoinType.One, "Perio End", "Data Items", DeleteWithRelationship = true, PartOfParentSet = true, LinkToItemInSet = false, InheritPermissions = true)]
[RequiredNoDefaultIDValidation]
Guid PeriodEndID { get; set; }
Property Value
Type | Description |
---|---|
Guid |
RelatedEntityID
[Key] Links to IObjectEntity. The Related Entity (if any) for the GL Posting this was booked against
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.ObjectEntity, "ID", SingleJoinType.ZeroToOne, "Related Entity", "Period End Data Items", PreventAutoConstraint = true)]
[EntityDescription("The related entity (if any) these gl posting entries were booked against.")]
[EntityKeyProperty]
Guid? RelatedEntityID { get; set; }
Property Value
Type | Description |
---|---|
Guid? |
RootEntityID
Links to IObjectEntity. The Root Entity these GL Postings are allocated to ultimate owners through.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.ObjectEntity, "ID", SingleJoinType.ZeroToOne, "Root Entity", "Period End Data Items As Root", PreventAutoConstraint = true)]
[EntityDescription("The root entity in the allocation path, these data items are rolled up to.")]
Guid? RootEntityID { get; set; }
Property Value
Type | Description |
---|---|
Guid? |
SubGLAccountID
[Key] Links to IGLAccount. The Sub GL Account this amount (In reporting currency) debited or credited
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.GLAccount, "ID", SingleJoinType.ZeroToOne, "Sub GL Account", "Period End Data Items From Sub Account", PreventAutoConstraint = true)]
[EntityDescription("The sub gl account (if not rounding, opening balance, aggregates, etc) this data relates to.")]
[EntityKeyProperty]
Guid? SubGLAccountID { get; set; }
Property Value
Type | Description |
---|---|
Guid? |
TransactionCodeID
[Key] Links to ITransactionCode. Only roll up gl accounts with a matching classification name that came from this transaction code.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.TransactionCode, "ID", SingleJoinType.One, "Transaction Code", "Period End Data Items", PreventAutoConstraint = true)]
[EntityDescription("Only roll up gl accounts with a matching classification name that came from this transaction code.")]
[EntityKeyProperty]
[RequiredNoDefaultIDValidation]
Guid TransactionCodeID { get; set; }
Property Value
Type | Description |
---|---|
Guid |
TransactionTypeValueID
[Key] Links to ITransactionTypeValue. The Transaction Type Value (if any) this GL Amount was automatically populated from
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.TransactionTypeValue, "ID", SingleJoinType.ZeroToOne, "Transaction Type Value", "Period End Data Items", PreventAutoConstraint = true)]
[EntityDescription("Only roll up gl accounts with a matching classification name that came from this transaction type value.")]
[EntityKeyProperty]
Guid? TransactionTypeValueID { get; set; }
Property Value
Type | Description |
---|---|
Guid? |
TransformedGLAccountID
[Key] Links to IGLAccount. The Transformed (via period end transformations) GL Account this amount (In reporting currency) debited or credited
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true, "GLAccountID")]
[EntityRelationship(EntityID.GLAccount, "ID", SingleJoinType.ZeroToOne, "GL Account", "Transformed Period End Data Items", PreventAutoConstraint = true)]
[EntityDescription("The transformed (via period end transformations) gl account this data relates to.")]
Guid? TransformedGLAccountID { get; set; }
Property Value
Type | Description |
---|---|
Guid? |
TransformedSubGLAccountID
[Key] Links to IGLAccount. The Transformed (via period end transformations) Sub GL Account this amount (In reporting currency) debited or credited
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true, "SubGLAccountID")]
[EntityRelationship(EntityID.GLAccount, "ID", SingleJoinType.ZeroToOne, "Sub GL Account", "Period End Data Items From Transformed Sub Account", PreventAutoConstraint = true)]
[EntityDescription("The Transformed (via period end transformations) sub gl account (if not rounding, opening balance, aggregates, etc) this data relates to.")]
Guid? TransformedSubGLAccountID { get; set; }
Property Value
Type | Description |
---|---|
Guid? |
Type
[Key] Indicates the type of capital account data item record.
Declaration
[EntityProperty(SQLType.SmallInt, false)]
[Required]
[EntityKeyProperty]
[EntityDescription("Indicates the type of capital account data item record.")]
CapitalAccountDataItemType Type { get; set; }
Property Value
Type | Description |
---|---|
CapitalAccountDataItemType |
YTDCSE
The Year To Date movement in CSE for this entity
Declaration
[EntityProperty(SQLType.Decimal, 31, 18, true)]
[EntityDescription("The Year To Date movement in CSE for this entity.")]
decimal? YTDCSE { get; set; }
Property Value
Type | Description |
---|---|
decimal? |
YTDFuncAmount
The Year To Date debit/credit amount in total for this gl account in functional currency
Declaration
[EntityProperty(SQLType.Decimal, 21, 3, false, "0")]
[EntityDescription("The Year To Date debit/credit amount in total for this gl account in reporting currency.")]
decimal YTDFuncAmount { get; set; }
Property Value
Type | Description |
---|---|
decimal |
YTDLocalAmount
The Year To Date debit/credit amount in total for this gl account in local currency
Declaration
[EntityProperty(SQLType.Decimal, 21, 3, false, "0")]
[EntityDescription("The Year To Date debit/credit amount in total for this gl account in local currency.")]
decimal YTDLocalAmount { get; set; }
Property Value
Type | Description |
---|---|
decimal |
YTDReportingAmount
The Year To Date debit/credit amount in total for this gl account in reporting currency
Declaration
[EntityProperty(SQLType.Decimal, 21, 3, false, "0")]
[EntityDescription("The Year To Date debit/credit amount in total for this gl account in reporting currency.")]
decimal YTDReportingAmount { get; set; }
Property Value
Type | Description |
---|---|
decimal |
YTDUnits
The Year To Date movement in units for this entity
Declaration
[EntityProperty(SQLType.Decimal, 31, 18, true)]
[EntityDescription("The Year To Date movement in units for this entity.")]
decimal? YTDUnits { get; set; }
Property Value
Type | Description |
---|---|
decimal? |