Interface ISplitTransaction
Inherited Members
Namespace: LemonEdge.API.Entities.FinancialServices.Transactions
Assembly: LemonEdge.API.Entities.FinancialServices.dll
Syntax
[EntityDefinition(EntityID.SplitTransaction, "dbo.LT_SplitTransactions", "SplitTransaction", LabelColumn = "Reference", IsStandingDataEntity = false)]
[DefaultEntityIcon(ImageType.Tax)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.Transaction, "ParentItemID", "ID", PartOfThisSet = true)]
public interface ISplitTransaction : IHeaderTransactionalEntity, ITransactionalEntity, ICanBeLocked, IBaseEntityWithPermissions, IHasReference, IHasSaveProcessingTask, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties
Properties
AllocateToID
The Transaction Code allocation to use to transfrom the transactions while being split.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.TransactionCodeAllocateToTransaction, "ID", SingleJoinType.ZeroToOne, "Allocate To Transaction Code", "Split By Transaction", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("The Transaction Code allocation to use to transfrom the transactions while being split.")]
Guid? AllocateToID { get; set; }
Property Value
Type | Description |
---|---|
Guid? |
DefaultLineAutoInstrument
Indicates the default auto instrument setting to use for new lines that dictate how the system should automatically use or create an instrument if InstrumentID is not separately specified
Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Indicates the default auto instrument setting to use for new lines that dictate how the system should automatically use or create an instrument if InstrumentID is not separately specified")]
[HardCodedDefaultValueOnNew("3")]
SplitTransactionLineNewInstrument DefaultLineAutoInstrument { get; set; }
Property Value
Type | Description |
---|---|
SplitTransactionLineNewInstrument |
SourceSplitRatio
Indicates the ratio to remain on the source transaction. In this scenario the system creates offsetting entries too that transfer the amounts from the source to target transaction lines
Declaration
[EntityProperty(SQLType.Decimal, 31, 18, true)]
[EntityDescription("Indicates the ratio to remain on the source transaction. In this scenario the system creates offsetting entries too that transfer the amounts from the source to target transaction lines")]
decimal? SourceSplitRatio { get; set; }
Property Value
Type | Description |
---|---|
decimal? |
SourceTransactionID
The source transaction that will be split. Splitting this transaction will cancel it.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.Transaction, "ID", SingleJoinType.One, "Transaction To Split", "Split By Transaction", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("The source transaction that will be split. Splitting this transaction will cancel it.")]
Guid SourceTransactionID { get; set; }
Property Value
Type | Description |
---|---|
Guid |
SplitRatioSQLWrapperID
Indicates a sql wrapper to use while processing a split transaction to dynamically determine the allocation split ratio. The columns must be called EntityID and SplitAmount, and can optionally take a parameter named @splitTransactionID.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.SQLWrapper, "ID", SingleJoinType.ZeroToOne, "SQL Wrapper", "Split Transaction", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("Indicates a sql wrapper to use while processing a split transaction to dynamically determine the allocation split ratio. The columns must be called EntityID and SplitAmount, can optionally take a parameter named @splitTransactionID, and can also include columns called PathID, InstrumentID and TransactionDate.")]
Guid? SplitRatioSQLWrapperID { get; set; }
Property Value
Type | Description |
---|---|
Guid? |
SplitRatioSQLWrapperParam
The parameters for running the sql wrapper source
Declaration
[EntityProperty(SQLType.VarBinary, true)]
[EntityDescription("The parameters for running the sql wrapper source.")]
byte[] SplitRatioSQLWrapperParam { get; set; }
Property Value
Type | Description |
---|---|
byte[] |
TransferAll
Indicates that the system creates offsetting entries that transfer the amounts from the source to target transaction lines removing 100% or partial from the source
Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Indicates that the system creates offsetting entries that transfer the amounts from the source to target transaction lines removing 100% or partial from the source")]
SplitTransactionTransferType TransferAll { get; set; }
Property Value
Type | Description |
---|---|
SplitTransactionTransferType |
UseUnitsInRatioAllocation
Indicates that rounded (where required) ratio allocations should be used as ratio allocation for values
Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates that rounded (where required) ratio allocations should be used as ratio allocation for values")]
bool UseUnitsInRatioAllocation { get; set; }
Property Value
Type | Description |
---|---|
bool |