Interface ICustomFunctions
Namespace: LemonEdge.API.Core.FinancialServices
Assembly: LemonEdge.API.Core.FinancialServices.dll
Syntax
public interface ICustomFunctions
Methods
AggregateTransactionValue(Guid?, DateTimeOffset?, Guid, Guid?, Guid?, Guid?, bool, DateTimeOffset?, DateTimeOffset, DateTimeOffset)
Retrieves the results of aggregating the specified transaction value transactionTypeValueID
Declaration
Task<IEnumerable<ITransactionAggregateResult>> AggregateTransactionValue(Guid? canvasID, DateTimeOffset? lastUpdated, Guid transactionTypeValueID, Guid? instrumentSetID, Guid? ignoreParentTypeID, Guid? ignoreParentID, bool groupByInstrument, DateTimeOffset? startDate, DateTimeOffset effectiveDate, DateTimeOffset financialDate)
Parameters
Type | Name | Description |
---|---|---|
Guid? | canvasID | The id of any Canvas you want this query to run in. Null indicates the current main system |
DateTimeOffset? | lastUpdated | The as of date you want this query to run for. Null indicates the query should run on the latest current data. |
Guid | transactionTypeValueID | This specific value should be aggregated across all transactions |
Guid? | instrumentSetID | The set of instruments you would like the transactions for to be aggregated |
Guid? | ignoreParentTypeID | If you want to ignore transactions against a specified parent item, you need both this
type entity id and |
Guid? | ignoreParentID | If you want to ignore transactions against a specified parent item, you need both this
item id and |
bool | groupByInstrument | Indicates the results returned should be grouped by InstrumentID, or should be aggregated in total |
DateTimeOffset? | startDate | Optional - Indicates the aggregated transactions should all have a transaction date greater than or equal to this date |
DateTimeOffset | effectiveDate | Indicates the aggregated transactions should all have a transaction date less than or equal to this date |
DateTimeOffset | financialDate | Indicates the aggregated transactions, and gl postings, should have financial dates less than or equal to this date |
Returns
Type | Description |
---|---|
Task<IEnumerable<ITransactionAggregateResult>> | Returns a task holding a set of ITransactionAggregateResult containing the aggregate
transaction values specified, by instrument or in total depending on |
AggregateTransactionValues(Guid?, DateTimeOffset?, Guid, Guid, Guid?, Guid?, Guid?, bool, DateTimeOffset?, DateTimeOffset, DateTimeOffset)
Retrieves the results of aggregating the specified transaction values
Declaration
Task<IEnumerable<ITransactionAggregateResult>> AggregateTransactionValues(Guid? canvasID, DateTimeOffset? lastUpdated, Guid transactionMatcherID, Guid transactionAggregatorID, Guid? instrumentSetID, Guid? ignoreParentTypeID, Guid? ignoreParentID, bool groupByInstrument, DateTimeOffset? startDate, DateTimeOffset effectiveDate, DateTimeOffset financialDate)
Parameters
Type | Name | Description |
---|---|---|
Guid? | canvasID | The id of any Canvas you want this query to run in. Null indicates the current main system |
DateTimeOffset? | lastUpdated | The as of date you want this query to run for. Null indicates the query should run on the latest current data. |
Guid | transactionMatcherID | The ID of a ITransactionMatcher |
Guid | transactionAggregatorID | The ID a ITransactionAggregator |
Guid? | instrumentSetID | The set of instruments you would like the transactions for to be aggregated |
Guid? | ignoreParentTypeID | If you want to ignore transactions against a specified parent item, you need both this
type entity id and |
Guid? | ignoreParentID | If you want to ignore transactions against a specified parent item, you need both this
item id and |
bool | groupByInstrument | Indicates the results returned should be grouped by InstrumentID, or should be aggregated in total |
DateTimeOffset? | startDate | Optional - Indicates the aggregated transactions should all have a transaction date greater than or equal to this date |
DateTimeOffset | effectiveDate | Indicates the aggregated transactions should all have a transaction date less than or equal to this date |
DateTimeOffset | financialDate | Indicates the aggregated transactions, and gl postings, should have financial dates less than or equal to this date |
Returns
Type | Description |
---|---|
Task<IEnumerable<ITransactionAggregateResult>> | Returns a task holding a set of ITransactionAggregateResult containing the aggregate
transaction values specified, by instrument or in total depending on |
GetDuplicateMappedLots(Guid?, Guid)
Returns all instruments that are involved in more than one path through mappings against a specified
entitySetID
Declaration
Task<IEnumerable<IAllocationMapping>> GetDuplicateMappedLots(Guid? canvasID, Guid entitySetID)
Parameters
Type | Name | Description |
---|---|---|
Guid? | canvasID | The id of any Canvas you want this query to run in. Null indicates the current main system |
Guid | entitySetID | The id of the entity set you want to find a list of all instruments mapped to multiple paths |
Returns
Type | Description |
---|---|
Task<IEnumerable<IAllocationMapping>> | A task holding all instruments that are mapped to more than one path within the specified
|
Remarks
This is used in conjunction with IAllocationRule, IAllocationPath and IAllocationMapping
See https://help.lemonedge.com/financial-services-allocations/ for more information
GetUnmappedLots(Guid?, Guid)
Returns all unmapped instruments against a specified entitySetID
Declaration
Task<IEnumerable<IInstrument>> GetUnmappedLots(Guid? canvasID, Guid entitySetID)
Parameters
Type | Name | Description |
---|---|---|
Guid? | canvasID | The id of any Canvas you want this query to run in. Null indicates the current main system |
Guid | entitySetID | The id of the entity set you want to find a list of all instruments that are unmapped within this entity set |
Returns
Type | Description |
---|---|
Task<IEnumerable<IInstrument>> | A task holding all instruments that are not mapped to any path within the specified
|
Remarks
This is used in conjunction with IAllocationRule, IAllocationPath and IAllocationMapping
See https://help.lemonedge.com/financial-services-allocations/ for more information
RevertTransactionToInProgress(Guid, Guid)
Reverts the specified transaction from Finalized to InProgress
All associated records with this transaction are change to InProgress
Declaration
Task<bool> RevertTransactionToInProgress(Guid type, Guid id)
Parameters
Type | Name | Description |
---|---|---|
Guid | type | The type of the transaction object to revert |
Guid | id | The ID of the transaction object to revert |
Returns
Type | Description |
---|---|
Task<bool> | A task indicating the sucessfull completion of the operation |