[EntityDefinition(EntityID.AllocationAmount, "dbo.LT_AllocationAmounts", "AllocationAmount", IsStandingDataEntity = false)]
[DefaultEntityIcon(ImageType.AmountAllocation)]
[EntityIndex(Name = "Transfer", ColumnNames = new string[] { "TransferID" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending }, IsClustered = false, IsUnique = false)]
[EntityIndex(Name = "TransferEntity", ColumnNames = new string[] { "EntityID", "AllocationRuleID", "EffectiveDate", "AccountID", "CanvasID" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending, IndexOrder.Ascending, IndexOrder.Ascending, IndexOrder.Ascending, IndexOrder.Ascending }, IsClustered = false, IsUnique = false)]
[EntityIndex(Name = "Amounts", ColumnNames = new string[] { "AllocationRuleID" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending }, IsClustered = false, IsUnique = false)]
public interface IAllocationAmount : ICanBeTransferred, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

AllocationRuleID

[Key] Links to IAllocationRule. The parent rule this amount belongs to

Declaration

[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityKeyProperty]
[EntityRelationship(EntityID.AllocationRule, "ID", SingleJoinType.One, "Allocation Rule", "Amounts", DeleteWithRelationship = true, PartOfParentSet = true, LinkToItemInSet = false, InheritPermissions = true)]
[RequiredNoDefaultIDValidation]
Guid AllocationRuleID { get; set; }

Property Value

Type	Description
Guid

Amount

The amount to be used to allocate to this entity

Declaration

[EntityProperty(SQLType.Decimal, 31, 18, false)]
[Required]
[EntityDescription("Indicates the amount to allocate to this entity. Overall this is converted into a percentage for allocating transactions.")]
[UpdateOnTransfer(TransferUpdateType.AutoTransfer)]
decimal Amount { get; set; }

Property Value

Type	Description
decimal

AmountB

An alternative amount to be used to allocate to this entity

Declaration

[EntityProperty(SQLType.Decimal, 31, 18, false)]
[Required]
[EntityDescription("A secondary allocation mechanism. Can be used for specific transaction allocations or custom processes.")]
[UpdateOnTransfer(TransferUpdateType.AutoTransfer)]
decimal AmountB { get; set; }

Property Value

Type	Description
decimal

Description

A user friendly description of this allocation amount.

Declaration

[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("A user friendly description of this allocation amount.")]
string Description { get; set; }

Property Value

Type	Description
string

DynamicRuleAllocationPathEntityID

Links to IObjectEntity. The entity that this amount is for, and is allocating from

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.ObjectEntity, "ID", SingleJoinType.ZeroToOne, "Entity", "Allocation Amount Allocated To", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false)]
[EntityDescription("The entity this allocation amount belongs to.")]
Guid? DynamicRuleAllocationPathEntityID { get; set; }

Property Value

Type	Description
Guid?

DynamicRuleAllocationPathID

Links to IAllocationPath. The path this amount is for

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.AllocationPath, "ID", SingleJoinType.ZeroToOne, "Entity", "Allocation Amount Allocated To", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false)]
[EntityDescription("The path this allocation amount belongs to.")]
Guid? DynamicRuleAllocationPathID { get; set; }

Property Value

Type	Description
Guid?

PathSplitId

The id of property that is setup in IAllocationPath - SplitByProperty used to create this allocation amount

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityDescription("The path split used to create this allocation amount")]
Guid? PathSplitId { get; set; }

Property Value

Type	Description
Guid?

StepChangeDate

Indicate the amount on this date is a step change to the overall amount and should be calculated as such.

Declaration

[EntityProperty(SQLType.DateTimeOffset, true, IsDate = true)]
[EntityDescription("Indicate the amount on this date is a step change to the overall amount and should be calculated as such.")]
DateTimeOffset? StepChangeDate { get; set; }

Property Value

Type	Description
DateTimeOffset?

Timing

Indicates if the allocation amount is effective from the start or end of day.

Declaration

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