Class CreateCapitalAccountData
A helper class for executing the system default CreateCapitalAccountData procedure
See https://help.lemonedge.com/createcapitalaccountdata/ for more information.
Inheritance
Inherited Members
Namespace: LemonEdge.API.Entities.Helpers.Queries
Assembly: LemonEdge.API.dll
Syntax
public class CreateCapitalAccountData : SQLWrapperExecuterConstructors
CreateCapitalAccountData(IEntityRetriever, IReadOnlyCache)
Creates a new SQLWrapperExecuter for the CreateCapitalAccountData standard SQL Wrapper query
Declaration
public CreateCapitalAccountData(IEntityRetriever retriever, IReadOnlyCache cache)Parameters
| Type | Name | Description |
|---|---|---|
| IEntityRetriever | retriever | A IEntityRetriever context for querying the LemonEdge platform |
| IReadOnlyCache | cache | A local cache |
Fields
QUERYNAME
Global name of the SQLWrapper query
Declaration
public const string QUERYNAME = "CreateCapitalAccountData"Field Value
| Type | Description |
|---|---|
| string |
Methods
AddCommitted(bool)
Indicates if this process should include committed transactions or not
Declaration
public CreateCapitalAccountData AddCommitted(bool includeCommitted)Parameters
| Type | Name | Description |
|---|---|---|
| bool | includeCommitted | Indicates if this process should include committed transactions or not |
Returns
| Type | Description |
|---|---|
| CreateCapitalAccountData | This CreateCapitalAccountData instance for chaining commands |
AddIncludeUnderlying(bool)
Declaration
public CreateCapitalAccountData AddIncludeUnderlying(bool includeUnderlying)Parameters
| Type | Name | Description |
|---|---|---|
| bool | includeUnderlying |
Returns
| Type | Description |
|---|---|
| CreateCapitalAccountData |
AddPeriodEndID(Guid)
The period end parameter for the CreateCapitalAccountData sql wrapper
Declaration
public CreateCapitalAccountData AddPeriodEndID(Guid periodEndID)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | periodEndID | The period end id to run the CreateCapitalAccountData query with |
Returns
| Type | Description |
|---|---|
| CreateCapitalAccountData | This CreateCapitalAccountData instance for chaining commands |
AddRetainedEarnings(bool)
Declaration
public CreateCapitalAccountData AddRetainedEarnings(bool includeRetainedEarnings)Parameters
| Type | Name | Description |
|---|---|---|
| bool | includeRetainedEarnings |
Returns
| Type | Description |
|---|---|
| CreateCapitalAccountData |
Execute(IEntityRetriever, IReadOnlyCache, Guid, bool, bool, bool)
Executes the CreateCapitalAccountData system SQLWrapper using the specified parameters
Declaration
public static Task Execute(IEntityRetriever retriever, IReadOnlyCache cache, Guid periodEndID, bool includeCommitted, bool includeRetainedEarnings, bool includeUnderlying)Parameters
| Type | Name | Description |
|---|---|---|
| IEntityRetriever | retriever | A IEntityRetriever context for querying the LemonEdge platform |
| IReadOnlyCache | cache | A local cache |
| Guid | periodEndID | The period end parameter for the CreateCapitalAccountData sql wrapper |
| bool | includeCommitted | Indicates if this process should include committed transactions or not |
| bool | includeRetainedEarnings | |
| bool | includeUnderlying |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of running the CreateCapitalAccountData procedure |
Execute(Guid, bool, bool, bool)
Executes the CreateCapitalAccountData system SQLWrapper using the specified parameters
Declaration
public Task Execute(Guid periodEndID, bool includeCommitted, bool includeRetainedEarnings, bool includeUnderlying)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | periodEndID | The period end parameter for the CreateCapitalAccountData sql wrapper |
| bool | includeCommitted | Indicates if this process should include committed transactions or not |
| bool | includeRetainedEarnings | |
| bool | includeUnderlying |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of running the CreateCapitalAccountData procedure |
ParametersAreValid()
Indicates if the parameters are valid for executing the query
Declaration
protected override bool ParametersAreValid()Returns
| Type | Description |
|---|---|
| bool | True if the parameters contain a value for @periodEndID |