[EntityDefinition(EntityID.Transfer, "dbo.LT_Transfers", "Transfer", LabelColumn = "Reference", HelpURL = "help/financial-services-engine/financial/transfers/intro.html")]
[DefaultEntityIcon(ImageType.Transfer)]
[DatabaseClassValidation(typeof(Transfer), "ValidateTransfer")]
public interface ITransfer : IHeaderTransactionalEntity, IBaseEntityWithPermissions, ITransactionalEntity, ICanBeLocked, IHasReference, IHasSaveProcessingTask, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

EntitySetID

Links to IEntitySet. The Entity Set this Transfer is taking place within. All affected transactions/allocations within this entity set will be transferred according to the setup

Declaration

[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.EntitySet, "ID", SingleJoinType.One, "Owner", "Transfers", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false)]
[RequiredNoDefaultIDValidation]
[EntityDescription("The owner of this transfer.")]
Guid EntitySetID { get; set; }

Property Value

Type	Description
Guid

SourceEntityID

Links to IObjectEntity. The Entity that will have an amount transferred from them to other ultimate owning entities

Declaration

[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.ObjectEntity, "ID", SingleJoinType.One, "Source Entity", "Transfers As Source")]
[EntityDescription("The source entity for this transfer.")]
[RequiredNoDefaultIDValidation]
Guid SourceEntityID { get; set; }

Property Value

Type	Description
Guid

Timing

The timing the Transfer is to be effective from, can be

Declaration

[EntityProperty(SQLType.SmallInt, false)]
[Required]
[EntityDescription("Indicates if the transfer is effective from the start or end of day.")]
AllocationTiming Timing { get; set; }

Property Value

Type	Description
AllocationTiming

TransferCapitalUpToDate

The date any allocated transactions should be transferred up to. Normally the Transaction Date itself, but can be greater.

Declaration

[EntityProperty(SQLType.DateTimeOffset, false)]
[EntityDescription("Transfer all activity up to this date (same as transfer date by default). The capital account data will treat any activity transferred between TransferDate and TransferCapitalUpToDate as if it actually happened though, and isn't shown as partner transfer in/out. This allows you to continue with capital entries (on dates after the transfer) before finalizing a transfer, and the system will transfer those entries but show them as if they actually happened.")]
DateTimeOffset TransferCapitalUpToDate { get; set; }

Property Value

Type	Description
DateTimeOffset

TransferPercent

The amount to transfer from this Entity as a percentage.

100% would transfer all their interest and allocations to others.

Declaration

[EntityProperty(SQLType.Decimal, 31, 18, false)]
[Required]
[EntityDescription("Indicates the default percentage to transfer from this entity. This can be overridden for certain transaction types, or entities.")]
decimal TransferPercent { get; set; }