Interface IPeriodEndProcessor
The processor responsible for processing a period end operation.
See https://web.lemonedge.com/help/period-ends/ for more information.
Inherited Members
Namespace: LemonEdge.API.Processors.Transactional
Assembly: API.dll
Syntax
public interface IPeriodEndProcessor : ITaskProcessor, IBaseDataSetProcessorWithDBSave, IBaseDataSetProcessor, IProcessor, IDisposable, ILockable
Properties
Adjustments
Any manual adjustment records manually added to the period end, loaded from the PeriodEnd entity for this operation
Declaration
IEnumerable<IPeriodEndAdjustment> Adjustments { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<IPeriodEndAdjustment> |
CapitalAccountDataItems
All the capital account data item records generated by the process, to burn in all records for this period end for consistent, secure and fast reporting
Declaration
IEnumerable<ICapitalAccountDataItem> CapitalAccountDataItems { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ICapitalAccountDataItem> |
PeriodEnd
The root period end record this processor is responsible for
Declaration
IPeriodEnd PeriodEnd { get; }
Property Value
Type | Description |
---|---|
IPeriodEnd |
Methods
AddAdjustment(ICapitalAccountDataItem)
Adds a manual capital account data item to the process linked to an IPeriodEndAdjustment
Declaration
void AddAdjustment(ICapitalAccountDataItem adj)
Parameters
Type | Name | Description |
---|---|---|
ICapitalAccountDataItem | adj | The capital account data item record to add to the process |
AddAdjustment(IPeriodEndAdjustment)
Adds an adjustment manually to the processor
Declaration
void AddAdjustment(IPeriodEndAdjustment adj)
Parameters
Type | Name | Description |
---|---|---|
IPeriodEndAdjustment | adj | The period end adjustment record to add to the process |
Calculate()
Calculates the period end process generating all the capital account data item entries
Declaration
Task Calculate()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A task indicating the completion of this operation |
RemoveAdjustment(ICapitalAccountDataItem)
Removes a manually added capital account data item from the processor
Declaration
void RemoveAdjustment(ICapitalAccountDataItem adj)
Parameters
Type | Name | Description |
---|---|---|
ICapitalAccountDataItem | adj | The capital account data item record to remove from the process |
RemoveAdjustment(IPeriodEndAdjustment)
Removes an adjustment from the processor
Declaration
void RemoveAdjustment(IPeriodEndAdjustment adj)
Parameters
Type | Name | Description |
---|---|---|
IPeriodEndAdjustment | adj | The period end adjustment record to remove from the process |