Interface IInstrumentBase

Any LemonEdge entity interface that inherits this, means it is acquires all the functionality of an Instrument

See https://help.lemonedge.com/instruments/ for more info

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
public interface IInstrumentBase : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

AllowUnmapped

This indicates that this Instrument itself does not need to be automatically mapped to an Allocation Path within the Entity Set. This could be because al the Transactions are being booked with the Allocations already specified, or a Path already selected, or that they are to be excluded from calculations or consolidated reporting.

Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("This indicates that this Instrument itself does not need to be automatically mapped to an Allocation Path within the Entity Set. This could be because al the Transactions are being booked with the Allocations already specified, or a Path already selected, or that they are to be excluded from calculations or consolidated reporting.")]
[Required]
bool AllowUnmapped { get; set; }
Property Value
Type Description
System.Boolean

CurrencyID

Links to IUser. Any Transaction operating against this instrument will use this Currency as the Local Currency of the Transaction itself. This currency will be translated into the Functional and Reporting currencies as entered.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.Currency, "ID", SingleJoinType.One, "Instrument", "Currency", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("Any Transaction operating against this instrument will use this Currency as the Local Currency of the Transaction itself. This currency will be translated into the Functional and Reporting currencies as entered.")]
Guid CurrencyID { get; set; }
Property Value
Type Description
System.Guid

Name

The unique name of this instrument.

Part of the key for this instrument

Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The unique name of this instrument.")]
[Required]
string Name { get; set; }
Property Value
Type Description
System.String

OwningEntityID

Links to IObjectEntity. This is the legal Entity within the Entity Set that owns this financial Instrument. It is this Entity that any Transactions against this instrument will be booked to.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.ObjectEntity, "ID", SingleJoinType.One, "Entity", "Instrument", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("This is the legal Entity within the Entity Set that owns this financial Instrument. It is this Entity that any Transactions against this instrument will be booked to.")]
Guid OwningEntityID { get; set; }
Property Value
Type Description
System.Guid

Extension Methods

See Also