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

Constructors

SplitTransaction()

Declaration

public SplitTransaction()

Properties

AllocateToID

The Transaction Code allocation to use to transfrom the transactions while being split.

Declaration

public Guid? AllocateToID { get; set; }

Property Value

Type	Description
Guid?

AllocateToID_Label

Declaration

public string AllocateToID_Label { get; set; }

Property Value

Type	Description
string

AllocateToID_Label_Silent

Declaration

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

Property Value

Type	Description
string

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

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

[EnumDataType(typeof(SplitTransactionLineNewInstrument))]
public SplitTransactionLineNewInstrument DefaultLineAutoInstrument { get; set; }

Property Value

Type	Description
SplitTransactionLineNewInstrument

Declaration

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

Property Value

Type	Description
string

Description

A short user friendly description of this transaction.

Declaration

[StringLength(200)]
public string Description { 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

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[]

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[]

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

public decimal? SourceSplitRatio { get; set; }

Property Value

Type	Description
decimal?

SourceTransactionID

The source transaction that will be split. Splitting this transaction will cancel it.

Declaration

public Guid SourceTransactionID { get; set; }

Property Value

Type	Description
Guid

SourceTransactionID_Label

Declaration

public string SourceTransactionID_Label { get; set; }

Property Value

Type	Description
string

SourceTransactionID_Label_Silent

Declaration

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

Property Value

Type	Description
string

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

public Guid? SplitRatioSQLWrapperID { get; set; }

Property Value

Type	Description
Guid?

SplitRatioSQLWrapperID_Label

Declaration

public string SplitRatioSQLWrapperID_Label { get; set; }

Property Value

Type	Description
string

SplitRatioSQLWrapperID_Label_Silent

Declaration

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

Property Value

Type	Description
string

SplitRatioSQLWrapperParam

The parameters for running the sql wrapper source

Declaration

public byte[] SplitRatioSQLWrapperParam { 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

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

[EnumDataType(typeof(SplitTransactionTransferType))]
public SplitTransactionTransferType TransferAll { get; set; }

Property Value

Type	Description
SplitTransactionTransferType

Declaration

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

Property Value

Type	Description
string

UseUnitsInRatioAllocation

Indicates that rounded (where required) ratio allocations should be used as ratio allocation for values

Declaration

public bool UseUnitsInRatioAllocation { get; set; }

Property Value

Type	Description
bool

Methods

CopyFromEntity(IBaseEntity)

Declaration

protected override void CopyFromEntity(IBaseEntity src)

Parameters

Type	Name	Description
IBaseEntity	src

Overrides

BaseEntity.CopyFromEntity(IBaseEntity)

CopyFromSource(ISplitTransaction)

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

Declaration

public void CopyFromSource(ISplitTransaction source)

Parameters

Type	Name	Description
ISplitTransaction	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