Interface IAllocationPathRule

The system entity for an allocation path rule, which belongs to an allocation path

See https://web.lemonedge.com/help/allocation-path-rules-view/ for more information

Inherited Members
System.IEquatable<LemonEdge.API.Core.IBaseEntity>.Equals(LemonEdge.API.Core.IBaseEntity)
System.ComponentModel.INotifyPropertyChanged.PropertyChanged
System.ComponentModel.INotifyPropertyChanging.PropertyChanging
Namespace: LemonEdge.API.Entities
Assembly: API.dll
Syntax
[EntityDefinition(EntityID.AllocationPathRule, "dbo.LT_AllocationPathRules", "AllocationPathRule", IsStandingDataEntity = false)]
[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)]
[EntityRelationship(EntityID.AllocationPath, "ID", SingleJoinType.One, "AllocationPathRule", "AllocationPath", DeleteWithRelationship = true, PartOfParentSet = true, LinkToItemInSet = false, InheritPermissions = true)]
Guid AllocationPathID { get; set; }
Property Value
Type Description
System.Guid

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, "AllocationPathRule", "ObjectEntity", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false)]
[EntityDescription("The entity that is parth of this allocation path.")]
Guid EntityID { get; set; }
Property Value
Type Description
System.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
System.Boolean

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
System.Int16

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, false)]
[EntityRelationship(EntityID.AllocationRule, "ID", SingleJoinType.One, "AllocationPathRule", "AllocationRule", 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; }
Property Value
Type Description
System.Guid

Extension Methods

See Also