[EntityDefinition(EntityID.AllocationPathRule, "dbo.LT_AllocationPathRules", "AllocationPathRule", IsStandingDataEntity = false, CustomToString = true)]
[DefaultEntityIcon(ImageType.MapPin)]
public interface IAllocationPathRule : IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

AllocationPathID

[Key] Links to IAllocationPath. The parent allocation path this belongs to

Declaration

[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityKeyProperty]
[EntityRelationship(EntityID.AllocationPath, "ID", SingleJoinType.One, "Allocation Path", "Allocation Path Rules", DeleteWithRelationship = true, PartOfParentSet = true, LinkToItemInSet = false, InheritPermissions = true)]
[RequiredNoDefaultIDValidation]
Guid AllocationPathID { get; set; }

Property Value

Type	Description
Guid

DynamicLastUpdatedDate

Holds the last date the path rule was updated effective from

Declaration

[EntityProperty(SQLType.DateTimeOffset, true, IsDate = true)]
[EntityDescription("Holds the last date the path was updated effective from.")]
DateTimeOffset? DynamicLastUpdatedDate { get; set; }

Property Value

Type	Description
DateTimeOffset?

EntityID

Links to IObjectEntity. The entity within the structure that is part of this Path

Declaration

[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.ObjectEntity, "ID", SingleJoinType.One, "Entity", "Allocation Path Rules", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false)]
[RequiredNoDefaultIDValidation]
[EntityKeyProperty]
[EntityDescription("The entity that is parth of this allocation path.")]
Guid EntityID { get; set; }

Property Value

Type	Description
Guid

IncludeEntityInAllocation

Indicates that this Entity should be included in the final allocation percentages. Required for entities sitting above the Root Entity for tax purposes.

Declaration

[EntityProperty(SQLType.Bit, false)]
[Required]
[EntityDescription("Indicates if the entity should be included, as default, in flattened allocation calculations.")]
bool IncludeEntityInAllocation { get; set; }

Property Value

Type	Description
bool

Level

Indicates the level of this rule in the path. 0 being the lowest level. Internally maintained by the system

Declaration

[EntityProperty(SQLType.SmallInt, false)]
[Required]
[EntityDescription("Indicates the level of this rule in the path. 0 being the lowest level.")]
short Level { get; set; }

Property Value

Type	Description
short

RuleID

Links to IAllocationRule. A rule belonging to this Entity that indicates how to allocate from this entity to ultimate owners and/or other entities within the structure itself (continuing the path upwards)

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityKeyProperty]
[EntityRelationship(EntityID.AllocationRule, "ID", SingleJoinType.ZeroToOne, "Allocation Rule", "Allocation Path Rules", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false)]
[EntityDescription("The rule for this entity that dictates how this path allocates to remaining entities and/or to entities 'above' it in the path.")]
Guid? RuleID { get; set; }