Interface IPeriodEnd

The system entity for a period end entity. This is used for processing period (such as month or quarter) end activity and burning it all into capital account data items for gl reporting

See https://help.lemonedge.com/help/financial-services-engine/financial/period-ends/intro.html for more information

Inherited Members
Namespace: LemonEdge.API.Entities.FinancialServices.Accounting
Assembly: LemonEdge.API.Entities.FinancialServices.dll
Syntax
[EntityDefinition(EntityID.PeriodEnd, "dbo.LT_PeriodEnds", "PeriodEnd", IsStandingDataEntity = false, LabelColumn = "Reference", HelpURL = "help/financial-services-engine/financial/period-ends/intro.html")]
[DefaultEntityIcon(ImageType.ScalesMoney)]
public interface IPeriodEnd : IHeaderTransactionalEntity, ITransactionalEntity, ICanBeLocked, IBaseEntityWithPermissions, IHasReference, IHasSaveProcessingTask, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

DataProcessingDate

Optional - A date to ensure the calculation runs [As Of] meaning certain transactions will be excluded from this Period End calculation if they were modified after this date/time.

This is incredibly useful when different teams are processing different processes at period end.You can exclude those changes from your calculation and pull them in by moving this date whenever you are ready.

Declaration
[EntityProperty(SQLType.DateTimeOffset, true)]
[EntityDescription("The as of date all data should be loading for processing this period end and calculating capital account data items.")]
DateTimeOffset? DataProcessingDate { get; set; }
Property Value
Type Description
DateTimeOffset?

EntitySetID

Links to IEntitySet. The entity set this period end is being processed against

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.EntitySet, "ID", SingleJoinType.One, "Entity Set", "Period Ends", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false)]
[RequiredNoDefaultIDValidation]
[EntityDescription("The entity set that this period end pertains to.")]
Guid EntitySetID { get; set; }
Property Value
Type Description
Guid

IncludeItemChildTransactionsID

Optional - If this Period End is part of another calculation routine it is often the case you will always want to include those latest transactions against that process in this calculation even if they are after the Data Processing Date.

This holds the type of item that is the parent.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityDescription("The item which holds a set of transaction to include in the period end capital account data calculation.")]
[EntityLinkToAnyParentRelationship("IncludeItemChildTransactionsIDTypeID", SingleJoinType.ZeroToOne, "Period End Transaction Parent Set To Include", false, new Type[] { typeof(ITransaction), typeof(ITransactionAllocated), typeof(IGLPosting), typeof(IGLPostingAllocated), typeof(IHasTransactionSetting), typeof(IPeriodEnd), typeof(IPeriodEndAdjustment), typeof(ICapitalAccountDataItem), typeof(ISQLTypeWrapper), typeof(IDatasetQueryableItem), typeof(ISQLFunction), typeof(IVennSetQueryableItem) }, OnlyWithLabels = true)]
Guid? IncludeItemChildTransactionsID { get; set; }
Property Value
Type Description
Guid?

IncludeItemChildTransactionsIDTypeID

Optional - If this Period End is part of another calculation routine it is often the case you will always want to include those latest transactions against that process in this calculation even if they are after the Data Processing Date.

This holds he actual parent item that this Period End calculation is a part of.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true, IsEntityTypeLink = true)]
[EntityDescription("The type of item that holds a set of transaction to include in the period end capital account data calculation..")]
Guid? IncludeItemChildTransactionsIDTypeID { get; set; }
Property Value
Type Description
Guid?

PeriodEndTransformationID

Links to IPeriodEndTransformation. The default period end transformation to use for processing this period end.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.PeriodEndTransformation, "ID", SingleJoinType.ZeroToOne, "Period End Transformation", "Default For Period Ends", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("The default period end transformation to use for processing this period end.")]
Guid? PeriodEndTransformationID { get; set; }
Property Value
Type Description
Guid?

PriorYearEndOverride

Optional - Overrides date to use as prior year end

If null by default this is the end of the prior year as defined by the year end date on the entity set. If you want to override and use a specific year end date instead you can do so here.

Declaration
[EntityProperty(SQLType.DateTimeOffset, true)]
[EntityDescription("If null by default this is the end of the prior year as defined by the year end date on the entity set. If you want to override and use a specific year end date instead you can do so here.")]
DateTimeOffset? PriorYearEndOverride { get; set; }
Property Value
Type Description
DateTimeOffset?

Type

Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Indicates the type of calculation for the period end: ITD/YTD/PTD, or just PTD where other values are found through aggregating across period ends.")]
PeriodEndType Type { get; set; }
Property Value
Type Description
PeriodEndType

Extension Methods

See Also