[DataContract]
public class PeriodEnd : BaseEntityWithPermissions, IPeriodEnd, IHeaderTransactionalEntity, ITransactionalEntity, ICanBeLocked, IBaseEntityWithPermissions, IHasReference, IHasSaveProcessingTask, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<IPeriodEnd>

Constructors

PeriodEnd()

Declaration

public PeriodEnd()

Properties

CancelledID

Holds the original transactional entity record this record is cancelling.

Declaration

public Guid? CancelledID { get; set; }

Property Value

Type	Description
Guid?

CancelledID_Label

Declaration

public string CancelledID_Label { get; set; }

Property Value

Type	Description
string

CancelledID_Label_Silent

Declaration

[NotMapped]
public string CancelledID_Label_Silent { get; set; }

Property Value

Type	Description
string

CorrectedByID

Holds the new transactional entity record this record is corrected by, if any.

Declaration

public Guid? CorrectedByID { get; set; }

Property Value

Type	Description
Guid?

CorrectedByID_Label

Declaration

public string CorrectedByID_Label { get; set; }

Property Value

Type	Description
string

CorrectedByID_Label_Silent

Declaration

[NotMapped]
public string CorrectedByID_Label_Silent { get; set; }

Property Value

Type	Description
string

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

public DateTimeOffset? DataProcessingDate { get; set; }

Property Value

Type	Description
DateTimeOffset?

Description

A short user friendly description of this transaction.

Declaration

[StringLength(200)]
public string Description { get; set; }

Property Value

Type	Description
string

EntitySetID

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

Declaration

[RequiredNoDefaultIDValidation]
public Guid EntitySetID { get; set; }

Property Value

Type	Description
Guid

EntitySetID_Label

Declaration

public string EntitySetID_Label { get; set; }

Property Value

Type	Description
string

EntitySetID_Label_Silent

Declaration

[NotMapped]
public string EntitySetID_Label_Silent { get; set; }

Property Value

Type	Description
string

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

public Guid? IncludeItemChildTransactionsID { get; set; }

Property Value

Type	Description
Guid?

IncludeItemChildTransactionsIDTypeID

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

Declaration

public Guid? IncludeItemChildTransactionsIDTypeID { get; set; }

Property Value

Type	Description
Guid?

IncludeItemChildTransactionsID_Label

Declaration

public string IncludeItemChildTransactionsID_Label { get; set; }

Property Value

Type	Description
string

IncludeItemChildTransactionsID_Label_Silent

Declaration

[NotMapped]
public string IncludeItemChildTransactionsID_Label_Silent { get; set; }

Property Value

Type	Description
string

Locked

Indicates the current record is locked and can not be modified until it is unlocked.

Declaration

[Required]
public bool Locked { get; set; }

Property Value

Type	Description
bool

PeriodEndTransformationID

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

Declaration

public Guid? PeriodEndTransformationID { get; set; }

Property Value

Type	Description
Guid?

PeriodEndTransformationID_Label

Declaration

public string PeriodEndTransformationID_Label { get; set; }

Property Value

Type	Description
string

PeriodEndTransformationID_Label_Silent

Declaration

[NotMapped]
public string PeriodEndTransformationID_Label_Silent { get; set; }

Property Value

Type	Description
string

PriorRunTaskParam

Holds the task parameters used when this was previously run. SavedTaskParam is cleared after processing to distinguish between imports and other operations.

Declaration

public byte[] PriorRunTaskParam { get; set; }

Property Value

Type	Description
byte[]

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

public DateTimeOffset? PriorYearEndOverride { get; set; }

Property Value

Type	Description
DateTimeOffset?

Reference

The auto-increment unique reference for this entity

Declaration

public int Reference { get; set; }

Property Value

Type	Description
int

SavedTaskID

Links to IServerTask. Indicates the task that has been automatically created during the save process for completing any further processing

Declaration

public Guid? SavedTaskID { get; set; }

Property Value

Type	Description
Guid?

SavedTaskID_Label

Declaration

public string SavedTaskID_Label { get; set; }

Property Value

Type	Description
string

SavedTaskID_Label_Silent

Declaration

[NotMapped]
public string SavedTaskID_Label_Silent { get; set; }

Property Value

Type	Description
string

SavedTaskParam

Holds the associated parameters for the task SavedTaskID

Declaration

public byte[] SavedTaskParam { get; set; }

Property Value

Type	Description
byte[]

Status

Indicates the current status of this transactional object.

By default GL entries aren't processed until an entity has a status >= Committed.

Finalazied transactions can only be modified through cancel/correct logic

Declaration

[EnumDataType(typeof(TransactionStatus))]
public TransactionStatus Status { get; set; }

Property Value

Type	Description
TransactionStatus

Declaration

[NotMapped]
public string Status_Tooltip { get; set; }

Property Value

Type	Description
string

TransactionDate

The transaction date of this transaction.

Declaration

[RequiredNoDefaultIDValidation]
public DateTimeOffset TransactionDate { get; set; }

Property Value

Type	Description
DateTimeOffset

Type

Declaration

[EnumDataType(typeof(PeriodEndType))]
public PeriodEndType Type { get; set; }

Property Value

Type	Description
PeriodEndType

Declaration

[NotMapped]
public string Type_Tooltip { get; set; }

Property Value

Type	Description
string

Methods

CopyFromEntity(IBaseEntity)

Declaration

protected override void CopyFromEntity(IBaseEntity src)

Parameters

Type	Name	Description
IBaseEntity	src

Overrides

BaseEntity.CopyFromEntity(IBaseEntity)

CopyFromSource(IPeriodEnd)

Updates all properties in this item to have the same properties as the source object.

Declaration

public void CopyFromSource(IPeriodEnd source)

Parameters

Type	Name	Description
IPeriodEnd	source	The source object to copy all values from.

GetShouldAutoGenerateTaskOnSave()

Indicates if the task should automatically be generated on save

Only runs on the service, or directly connected to db. Defaults to true

So ensure processors that implement IBaseDataSetProcessorWithDBSave correctly set this for the task to be auto created or not on save

Declaration

public bool GetShouldAutoGenerateTaskOnSave()

Returns

Type	Description
bool	If the task should automatically be generated on save

SetAutoGenerateOnSave(bool)

Sets if thie task should be generated for this item on save or not

Declaration

public void SetAutoGenerateOnSave(bool value)

Parameters

Type	Name	Description
bool	value	Indicates if the task should be generated on save or not

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string