Interface IRate
The system entity for rates
Inherited Members
Namespace: LemonEdge.API.Entities.FinancialServices.Products
Assembly: LemonEdge.API.Entities.FinancialServices.dll
Syntax
[EntityDefinition(EntityID.Rate, "dbo.LT_Rates", "Rate", IsStandingDataEntity = false)]
[DefaultEntityIcon(ImageType.Rate)]
[EntityIndex(Name = "RateRelated", ColumnNames = new string[] { "RelatedItemID" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending }, IsClustered = false, IsUnique = false)]
[EntityIndex(Name = "Dt", ColumnNames = new string[] { "EffectiveDate", "RelatedItemID" }, IndexOrder = new IndexOrder[] { IndexOrder.Descending, IndexOrder.Ascending }, IsClustered = false, IsUnique = false)]
public interface IRate : IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties
Properties
EffectiveDate
[Key] The date the rate is effective from
Declaration
[EntityProperty(SQLType.DateTimeOffset, true, IsDate = true)]
[EntityDescription("The date the rate is effective from.")]
[EntityKeyProperty]
DateTimeOffset? EffectiveDate { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
RateTypeID
[Key] Links to IRateType. The type this rate is under.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.RateType, "ID", SingleJoinType.One, "Type", "Rates", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = true)]
[EntityKeyProperty]
[EntityDescription("The type this rate is under.")]
Guid RateTypeID { get; set; }
Property Value
Type | Description |
---|---|
Guid |
RateValue
The rate value from this effective date
Declaration
[EntityProperty(SQLType.Decimal, 18, 12, false)]
[EntityDescription("The rate value from this effective date.")]
[Required]
decimal RateValue { get; set; }
Property Value
Type | Description |
---|---|
decimal |
RelatedItemID
The globally unique id of the entity (of type ItemTypeID) that is related within this grouping
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityDescription("The globally unique id of the entity (ItemTypeID) that is related within this rate.")]
[EntityLinkToAnyParentRelationship("RelatedItemTypeID", SingleJoinType.One, "Rate Related Items", false, new Type[] { typeof(ISQLFunction), typeof(IVennSetQueryableItem), typeof(ISQLTypeWrapper), typeof(IDatasetQueryableItem) }, DeleteWithRelationship = false, OnlyWithLabels = true)]
Guid? RelatedItemID { get; set; }
Property Value
Type | Description |
---|---|
Guid? |
RelatedItemTypeID
The type of related item
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true, IsEntityTypeLink = true)]
[EntityDescription("The type of related item.")]
Guid? RelatedItemTypeID { get; set; }
Property Value
Type | Description |
---|---|
Guid? |
UpToStartDays
[Key] The date this rate is effective from the start date up to this many years/months/days
Declaration
[EntityProperty(SQLType.SmallInt, true)]
[EntityDescription("The date this rate is effective from the start date up to this many years/months/days.")]
[EntityKeyProperty]
short? UpToStartDays { get; set; }
Property Value
Type | Description |
---|---|
short? |
UpToStartMonths
[Key] The date this rate is effective from the start date up to this many years/months/days
Declaration
[EntityProperty(SQLType.SmallInt, true)]
[EntityDescription("The date this rate is effective from the start date up to this many years/months/days.")]
[EntityKeyProperty]
short? UpToStartMonths { get; set; }
Property Value
Type | Description |
---|---|
short? |
UpToStartYears
[Key] The date this rate is effective from the start date up to this many years/months/days
Declaration
[EntityProperty(SQLType.SmallInt, true)]
[EntityDescription("The date this rate is effective from the start date up to this many years/months/days.")]
[EntityKeyProperty]
short? UpToStartYears { get; set; }
Property Value
Type | Description |
---|---|
short? |
UpToValue
[Key] The amount this rate is effective from up to the specified amount
Declaration
[EntityProperty(SQLType.Decimal, 21, 3, true)]
[EntityDescription("The amount this rate is effective from up to the specified amount.")]
[EntityKeyProperty]
decimal? UpToValue { get; set; }
Property Value
Type | Description |
---|---|
decimal? |