Namespace LemonEdge.API.Entities

Classes

CustomObjectPropertyValidateLinks

Validates that the custom object class has the correct types for a defined relationship

Helper

A helper class for working with new entities in the lemonedge system

This ensures all configured processes, settings and workflow are applied to all new items when they are created either by a user or the system itself

IsBaseInterfaceAttribute

If an interface implements the base common properties of a base entity, it needs to be marked with this interface.

See IObjectEntityBase for an example. This interface is used by all entities inheriting an Object Entity, and by the base Object Entity itself.

Thus IObjectEntityBase is marked with this attribute to identify it as the interface that inheriting entities (see ICompany for an example), do not need to actually implement in the back-end. Those values come from the base entity itself.

SSRSReportExportFormatHelper

Helps with the various ssrs report file types

Interfaces

IAccountMaintenance

The entity for account maintenance.

This enables maintenance of the multi-tenanted accounts in the database. Can only be modified from the root account itself.

See https://web.lemonedge.com/help/account-maintenance/ for more information

IActionTrigger

The system entity for triggers

See https://web.lemonedge.com/help/triggers/ for more information

IActionTriggerGate

The system entity for triggers gates

See https://web.lemonedge.com/help/trigger-gates-view/ for more information

IAddIn

The system entity for addins

See https://web.lemonedge.com/help/addin-view/ for more information

IAddInModule

The system entity for addin modules, which are a collection of addins all contained within one module

See https://web.lemonedge.com/help/addin-modules/ for more information

IAllocationAmount

The system entity for allocation amounts modules, which belong to an allocation rule

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

IAllocationMapping

The system entity for allocation mappings, which dynamically associate paths and instruments

See https://web.lemonedge.com/help/allocation-mappings/ for more information

IAllocationPath

The system entity for an allocation path, which holds a collection of path rules

See https://web.lemonedge.com/help/allocation-paths/ for more information

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

IAllocationRule

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

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

IBaseObject

Any entity that has be inherited by other entities should also implement this interface.

The common properties should all be implemented in a common interface that the base and inheriting entities implement, for instance see IObjectEntityBase for the common object entity properties.

The base entity itself should implement the common interface, any additional properties, *and* this BaseObject interface. See IObjectEntity for the base object entity type.

The inheriting entity should implement the common interface, any additional properties, *and* the IInheritingObject interface. See ICompany for an entity that inherits object entity and has company specific properties.

This ensures that given an id of a IObjectEntity we can get the common information, and it will tell us the inheriting type is a company (InheritingObjectTypeID), and we can then get all the rest of the information from the company itself

IBlendingTran

The system entity for a blending transaction, which contains the configuration for creating a blended transaction

See https://web.lemonedge.com/help/blending-transactions/ for more information

IBlendingTranInstrumentValue

The system entity for a blending transaction instrument value, which contains belongs to the configuration of a blending transaction

See https://web.lemonedge.com/help/blending-transaction-values/ for more information

IBlendingTranNewValue

The system entity for a blending transaction new value, which contains belongs to the configuration of a blending transaction

See https://web.lemonedge.com/help/blending-transaction-new-values/ for more information

IBlendingTranNewValueAggregate

The system entity for a blending transaction new value aggregator, which contains belongs to the configuration of a blending transaction

See https://web.lemonedge.com/help/blending-transaction-new-value-aggregates/ for more information

IBlendingTranNewValueAllocation

The system entity for a blending transaction new value allocation, which belongs to the configuration of a blending transaction

See https://web.lemonedge.com/help/blending-transaction-new-value-allocations/ for more information

IBlendTransaction

The system entity for a blended transaction, which creates a set of transactions according to rules configured in a IBlendTransaction

See https://web.lemonedge.com/help/blend-transactions/ for more information

IBlendTransactionInstrumentSet

The system entity for a blended transaction instrument set, which belongs to a blended transaction

See https://web.lemonedge.com/help/blend-transaction-instrument-sets-view/ for more information

ICanvas

The system entity for a Canvas

See https://web.lemonedge.com/help/canvases/ for more information

ICanvasPromotion

The system entity for a Canvas promotion, which is part of a ICanvas

See https://web.lemonedge.com/help/team-promotable-canvases-view/ for more information

ICapitalAccountDataItem

The system entity for a Capital Account Data Item, which is part of a IPeriodEnd process

See https://web.lemonedge.com/help/team-promotable-canvases-view/ for more information

IChart

The system entity for a Chart, which is displays data from a IPivot and in turn a ISQLWrapper

See https://web.lemonedge.com/help/charts/ for more information

IComment

The system entity for a Comment, which can be related to any entity

See https://web.lemonedge.com/help/comments/ for more information

ICompany

The system entity for a Comment, which inherits from the base type IObjectEntityBase

See https://web.lemonedge.com/help/companies/ for more information

ICompanyOwnership

The system entity for a COmpany Ownership link, part of a ICompany record

See https://web.lemonedge.com/help/company-ownerships-view/ for more information

ICompanyStructure

The system entity for a Company Structure, which inherits from the base type IEntitySetBase

See https://web.lemonedge.com/help/company-structures/ for more information

IContactInfo

The system entity for a Contact Info, always a child of a IObjectEntity (by extending object entity IsTypeExtender)

See https://web.lemonedge.com/help/contact-info-view/ for more information

ICurrency

The system entity for a Currency

See https://web.lemonedge.com/help/currencies/ for more information

ICustomGrid

The system entity for a Custom Grid, which holds the design for a grid

See https://web.lemonedge.com/help/custom-grids/ for more information

ICustomGridColumn

The system entity for a Custom Grid Column, which belongs to a ICustomGrid holding the design for a grid

See https://web.lemonedge.com/help/custom-grid-columns-view/ for more information

ICustomImage

The system entity for a Custom Image, which holds images that can be configured to be used throughout the application

See https://web.lemonedge.com/help/custom-images/ for more information

ICustomObject

The system entity for a Custom Object, which holds the design of an entity within the lemonedge platform

See https://web.lemonedge.com/help/custom-entities/ for more information

ICustomObjectProperty

The system entity for a Custom Object Property, which belongs to a ICustomObject

See https://web.lemonedge.com/help/custom-entity-properties/ for more information

ICustomView

The system entity for a Custom View, which holds the design for a view in the UI

See https://web.lemonedge.com/help/custom-views/ for more information

ICustomViewControl

The system entity for a Custom View Control, which belongs to a ICustomView holding the design for a view

See https://web.lemonedge.com/help/custom-view-controls-view/ for more information

IDataMapping

The system entity for a Data Mapping, which belongs to a IDataMapping holding the design for a data maping

See https://web.lemonedge.com/help/data-mappings/ for more information

IDataMappingBase

A common interface that a data mapping implements. The system entity IDataMapping implements this functionality

See https://web.lemonedge.com/help/data-mappings/ for more information

IDataMappingProperty

The system entity for a Data Mapping Property, which belongs to a IDataMapping holding the design for a data maping

See https://web.lemonedge.com/help/data-mapping-properties-view/ for more information

IDataMappingPropertyBase

A common interface that a data mapping property implements. The system entity IDataMappingProperty implements this functionality

See https://web.lemonedge.com/help/data-mapping-properties-view/ for more information

IDataset

The system entity for a DataSet, which is used for dynamically creating reports for use throughout the system

See https://web.lemonedge.com/help/datasets/ for more information

IDatasetQueryableItem

The system entity for a DataSet Queryable Item, which belongs to a IDataset

See https://web.lemonedge.com/help/dataset-queryable-items-view/ for more information

IDatasetQueryableItemFieldInfo

The system entity for a DataSet Queryable Item field, which belongs to a IDataset and IDatasetQueryableItem

This ties a field from a queryable item to its definition in a ISQLTypeWrapper against the SQL Wrapper for this dataset. This way the system knows which queryable item field should be described by which result column in the sql

See https://web.lemonedge.com/help/dataset-sql-type-wrappers/ for more information

IDatasetQueryableItemJoin

The system entity for a DataSet Queryable Item Join, which belongs to a IDataset and IDatasetQueryableItem

See https://web.lemonedge.com/help/dataset-queryable-items-view/ for more information

IDataSource

The system entity for a DataSource, which is used for ensuring any entity in the system can also have associated 3rd party data source ids

See https://web.lemonedge.com/help/data-sources/ for more information

IDataSourceType

The system entity for a DataSource Type, which is used for storing all the associated ids for a type of third party system

See https://web.lemonedge.com/help/data-source-types/ for more information

IDataTemplate

The system entity for data templates which can be used when exporting data into excel

See https://web.lemonedge.com/help/excel-templates/ for more information

IDataTemplateAttachment

The system entity for a Template Attachment, which holds the file to use as a template for the exported data

See https://web.lemonedge.com/help/excel-templates/ for more information

IDefaultValue

The system entity for a Default Value, which is used for dynamically ensuring items have a certain value whenever they are created by the system or a user

See https://web.lemonedge.com/help/default-values/ for more information

IDefaultWatcher

The system entity for a Default Watcher, which automatically creates configured watchers against specified new items

See https://web.lemonedge.com/help/default-watchers/ for more information

IDocument

The system entity for a Document, which allows for storing documents against any entities in the system

See https://web.lemonedge.com/help/documents/ for more information

IDocumentAttachment

The system entity for a Document Attachment, which holds the version of a file against a parent document

See https://web.lemonedge.com/help/documents/ for more information

IDomicile

The system entity for a Domicile

See https://web.lemonedge.com/help/domiciles/ for more information

IEmployee

The system entity for an Employee, which defines a relationship between a ICompany and IPerson

See https://web.lemonedge.com/help/employees-view/ for more information

IEntityPeriodClosing

The system entity for a period closing, which ensures any transactions booked to this entity will occur in the gl after the latest closed period

See https://web.lemonedge.com/help/period-closings-view/ for more information

IEntitySet

The system entity for an entity set, which is the base class for ICompanyStructure and any other entity that encapsulates a set of IObjectEntity that can hold transactions and allocations

See https://web.lemonedge.com/help/company-structures/ for more information

IEntitySetBase

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

See https://web.lemonedge.com/help/company-structures/ for more info

IEntityTag

The system entity for a tag, which can be marked against any entity record in the system

See https://web.lemonedge.com/help/tags-tool-window/ for more information

IExchangeRate

The system entity for exchange rates

See https://web.lemonedge.com/help/exchange-rates/ for more information

IExchangeRateCategory

The system entity for exchange rate categories

See https://web.lemonedge.com/help/exchange-rates/ for more information

IFavourite

The system entity for favourites

IFilterDescriptor

The system entity for filter descriptors, which is used in IDataset filters, and other system filters

See https://web.lemonedge.com/help/dataset-where-filters/ for more information

IGLAccount

The system entity for gl accounts. Uses pivots to allow modification of IGLAccountName for each gl account at the same time

See https://web.lemonedge.com/help/gl-accounts/ for more information

IGLAccountName

The system entity for gl accounts names, which hold the IGLClassificationName category to use for a IGLAccount

See https://web.lemonedge.com/help/gl-accounts-with-classifications-view/ for more information

IGLClassification

The system entity for gl classifications, which hold the IGLClassificationName category to use for a IGLAccount

See https://web.lemonedge.com/help/gl-classifications/ for more information

IGLClassificationName

The system entity for gl classification names, which are used as a category to use for a IGLAccount

See https://web.lemonedge.com/help/gl-classification-names/ for more information

IGLPosting

The system entity for a gl posting

See https://web.lemonedge.com/help/transaction-gl-postings-view/ for more information

IGLPostingAllocated

The system entity for a gl posting allocated, which holds the individual breakdown values of a parent IGLPosting for the ultimate owning entities. This is instead of a dynamic allocation.

See https://web.lemonedge.com/help/transaction-gl-posting-allocated-view/ for more information

IGLRollup

The system entity for a gl rollup, which allows reporting across the whole gl for a given IEntitySet

See https://web.lemonedge.com/help/gl-rollups/ for more information

IGLRollupClassification

The system entity for a gl rollup classification, which belongs to a IGLRollup definition

See https://web.lemonedge.com/help/gl-rollup-classifications-view/ for more information

IGLRollupHeader

The system entity for a gl rollup header, which belongs to a IGLRollup definition

See https://web.lemonedge.com/help/gl-rollup-header-view/ for more information

IHasTransactionSetting

The base interface for any entity that has settings for a transaction.

IHasVersion

Indicates this entity has versioning capability provided by the system. Typically implemented by an entity that also implements ISetCopier.

When the entity (and sub items) are exported to xml, and imported back in the system will only import if the item does not already exist or has a lower version.

IImportDefinition

The system entity for an import defintion, which describes steps of imports to process

See https://web.lemonedge.com/help/import-definitions/ for more information

IImportDefinitionStep

The system entity for an import defintion step, which belongs to an import definition

See https://web.lemonedge.com/help/import-definitions/ for more information

IIndustry

The system entity for an industry

See https://web.lemonedge.com/help/industries/ for more information

IInheritingObject

Any entity that inherits other entities should also implement this interface.

The common properties should all be implemented in a common interface that the base and inheriting entities implement, for instance see IObjectEntityBase for the common object entity properties.

The base entity itself should implement the common interface, any additional properties, *and* the IBaseObject interface. See IObjectEntity for the base object entity type.

The inheriting entity should implement the common interface, any additional properties, *and* this InheritingObject interface. See ICompany for an entity that inherits object entity and has company specific properties.

IInstrument

The system entity for an instrument

See https://web.lemonedge.com/help/instruments/ for more information

IInstrumentBase

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

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

IInstrumentCapitalAccountDataSetting

The system entity for an instrument capital account data setting

See https://web.lemonedge.com/help/instrument-capital-account-data-settings/ for more information

IInstrumentSet

The system entity for an instrument set, which contains definitions for loading a dynamic set of IInstrument

See https://web.lemonedge.com/help/instrument-sets/ for more information

IInstrumentSetBase

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

See https://web.lemonedge.com/help/instrument-sets/ for more info

IInstrumentSetItem

The system entity for an instrument set item, which belongs to an instrument set definition

See https://web.lemonedge.com/help/instrument-set-items-view/ for more information

IInstrumentSetType

The system entity for an instrument set type, which is a grouping category for IInstrumentSet

See https://web.lemonedge.com/help/instrument-set-types/ for more information

IItemTask

The system entity for a task, which can be associated with any entity in the system

See https://web.lemonedge.com/help/tasks/ for more information

ILayout

The system entity for a custom layout, which holds custom layouts for displaying views against entities in the ui

See https://web.lemonedge.com/help/layouts/ for more information

ILayoutRole

The system entity for a layout role, which indicates which custom layouts a role can use

See https://web.lemonedge.com/help/layout-roles-view/ for more information

ILedger

The system entity for a ledger, which gl postings and transactions can be entered against

See https://web.lemonedge.com/help/ledgers/ for more information

IMenuItem

The system entity for a menu item, which holds the commands that are available on the main menu in the ui for users to interact with

See https://web.lemonedge.com/help/role-menu-view/ for more information

IObjectEntity

The system entity for a base object entity. This is the main entity that can be part of an IEntitySet, be an owning entity on a ITransaction, and be allocated to in IAllocationRule

See https://web.lemonedge.com/help/companies/ for more information

IObjectEntityBase

Any LemonEdge entity interface that inherits this, means it is acquires all the functionality of an Object Entity which can belong as part of a IEntitySetBase or as entities that can be allocated to in IAllocationRule

See https://web.lemonedge.com/help/companies/ for more info

IPeriodEnd

The system entity for a period end entity. This is used for processing period (such as month or quarter) end activity and burning it all into capital account data items for gl reporting

See https://web.lemonedge.com/help/period-ends/ for more information

IPeriodEndAdjustment

The system entity for a period end adjustment entity, which is a part of a period end that the user can add adjustments to

See https://web.lemonedge.com/help/period-end-adjustments-view/ for more information

IPermission

The system entity for a period end adjustment entity, which is a part of a period end that the user can add adjustments to

See https://web.lemonedge.com/help/permissions-tool-window/ for more information

IPermissionChecker

A base interface that any entity that provides permissions implements. This is IPermission, and ITeamDefaultPermission

See https://web.lemonedge.com/help/permissions-tool-window/ for more information

IPerson

The system entity for a person entity

See https://web.lemonedge.com/help/people/ for more information

IPivot

The system entity for a pivot entity, which is capable of taking any sql wrapper of data and pivotting it dynamically

See https://web.lemonedge.com/help/pivots/ for more information

IPivotFieldInfo

The system entity for a pivot field info entity, which belongs to a pivot definition

See https://web.lemonedge.com/help/pivot-design-view/ for more information

IQueryRunner

The system entity for a Query Runner, which allows each result of a query to be run against a QueryRunHandler

See https://web.lemonedge.com/help/query-runners/ for more information

IQueryRunnerStep

The system entity for a Query Runner Step, which takes the result of a IQueryRunner and processes it

See https://web.lemonedge.com/help/query-runners/ for more information

IQueryRunnerStepParameter

The system entity for a Query Runner Step Parameter, which provides the parameter value for the IQueryRunnerStep

See https://web.lemonedge.com/help/query-runners/ for more information

IReport

The system entity for a base report. This is the main report base. All report entities inherit from this

See https://web.lemonedge.com/help/reports/ for more information

IReportBase

Any LemonEdge entity interface that inherits this, means it is acquires all the functionality of a report and can be used in IQueryRunner

See https://web.lemonedge.com/help/reports/ for more info

IReportSSRS

The system entity for a ssrs report

See https://web.lemonedge.com/help/ssrs-reports/ for more information

IRole

The system entity for a role

See https://web.lemonedge.com/help/roles/ for more information

IServerTask

The system entity for a server task, which can be offloaded and run on the task services rather than locally

See https://web.lemonedge.com/help/server-tasks/ for more information

IServerTaskData

The system entity for a server task data, which holds the parameters and results for a given task

See https://web.lemonedge.com/help/server-tasks/ for more information

IServerTaskStatus

The system entity for a server task, which can be offloaded and run on the task services rather than locally

See https://web.lemonedge.com/help/server-tasks/ for more information

ISetEntity

The system entity for a set entity, which indicates which IObjectEntity belongs to which IEntitySet

See https://web.lemonedge.com/help/company-structure-set-entities-view/ for more information

ISQLFunction

The system entity for clr sql functions which can be used in IDataset and ISQLWrapper sql

See https://web.lemonedge.com/help/sql-functions/ for more information

See https://docs.microsoft.com/en-us/sql/relational-databases/clr-integration-database-objects-user-defined-functions/clr-user-defined-aggregate-invoking-functions?view=sql-server-ver15 for information about sql clr functions

See https://web.lemonedge.com/help/venn-set-sql-type-wrappers/ for more information