Class TransactionCode
Inheritance
TransactionCode
Assembly: LemonEdge.API.Entities.FinancialServices.Auto.dll
Syntax
[DataContract]
public class TransactionCode : BaseEntityWithPermissions, ITransactionCode, IBaseEntityWithPermissions, ISetCopier, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<ITransactionCode>, ISetCopierCloneAlterer, ISetItemLoaderOverride
Constructors
TransactionCode()
Declaration
Properties
Allocation
Indicates if this transaction should have each amount allocated out to entities through the structure or not.
Declaration
[EnumDataType(typeof(TransactionCodeAllocation))]
public TransactionCodeAllocation Allocation { get; set; }
Property Value
AllocationLevel
Indicates if this allocation should follow the complete path, or only allocate to the first direct entities
Declaration
[EnumDataType(typeof(AllocateToLevel))]
public AllocateToLevel AllocationLevel { get; set; }
Property Value
Declaration
[NotMapped]
public string AllocationLevel_Tooltip { get; set; }
Property Value
Declaration
[NotMapped]
public string Allocation_Tooltip { get; set; }
Property Value
AllowAssociations
Declaration
public bool AllowAssociations { get; set; }
Property Value
AllowLocalCurrencyOverride
Declaration
public bool AllowLocalCurrencyOverride { get; set; }
Property Value
AllowNewValues
This indicates the User can add new Transaction Values as columns to the Transaction however they like.
Declaration
public bool AllowNewValues { get; set; }
Property Value
Indicates this transaction allows a related entity for this transaction to be marked against it
Declaration
[EnumDataType(typeof(TransactionCodeRelatedEntityOption))]
public TransactionCodeRelatedEntityOption AllowRelatedEntity { get; set; }
Property Value
Declaration
[NotMapped]
public string AllowRelatedEntity_Tooltip { get; set; }
Property Value
Indicates the formula to use to evaluate the CSE value.
Declaration
public string CSEValueFormula { get; set; }
Property Value
Code
A short unique code for this Transaction Code for reporting and display purposes
Declaration
[Required]
[StringLength(25)]
public string Code { get; set; }
Property Value
CopierCloneType
Declaration
public SetCopierCloneType CopierCloneType { get; set; }
Property Value
CustomValidationID
Custom validation to run in transaction processor when saving the transaction.
Declaration
public Guid? CustomValidationID { get; set; }
Property Value
CustomValidationID_Label
Declaration
public string CustomValidationID_Label { get; set; }
Property Value
CustomValidationID_Label_Silent
Declaration
[NotMapped]
public string CustomValidationID_Label_Silent { get; set; }
Property Value
DefualtGLSelectionToSubAccount
Indicates by default when selecting a new gl posting that you initially select a sub-account and it auto selects the gl account for you
Declaration
public bool DefualtGLSelectionToSubAccount { get; set; }
Property Value
Description
A user friendly description of this transaction code.
Declaration
[StringLength(2000)]
public string Description { get; set; }
Property Value
DisplayItemOnCopy
Indicates if the items should appear in the UI when copied from a grid. Typically child items shouldn't be added as
items in a grid or opened on copy, just the root item itself
Declaration
public bool DisplayItemOnCopy { get; }
Property Value
EnforceGLBalance
Indicates transactions using this code should have gl entries that balance
Declaration
public bool EnforceGLBalance { get; set; }
Property Value
ExchangeRateCategoryID
Links to IExchangeRateCategory. The category to use when retrieving exchange rates. Null to use the
default set of exchange rates with no category.
Declaration
public Guid? ExchangeRateCategoryID { get; set; }
Property Value
ExchangeRateCategoryID_Label
Declaration
public string ExchangeRateCategoryID_Label { get; set; }
Property Value
ExchangeRateCategoryID_Label_Silent
Declaration
[NotMapped]
public string ExchangeRateCategoryID_Label_Silent { get; set; }
Property Value
FolderID
The link to the folder this item is contained in
Declaration
public Guid? FolderID { get; set; }
Property Value
FolderID_Label
Declaration
public string FolderID_Label { get; set; }
Property Value
FolderID_Label_Silent
Declaration
[NotMapped]
public string FolderID_Label_Silent { get; set; }
Property Value
ForceNewItemOnCopy
Indicates if the specified item should always be created as a new item. For instance when copying sub transactions
are always created as new items
Declaration
public bool ForceNewItemOnCopy { get; }
Property Value
GL
Indicates how gl entries can be created with this transaction.
Declaration
[EnumDataType(typeof(TransactionCodeGL))]
public TransactionCodeGL GL { get; set; }
Property Value
Declaration
[NotMapped]
public string GL_Tooltip { get; set; }
Property Value
GenerateGLEntriesForInProgress
Indicates gl entries should automatically be generated for in progress transactions too
Declaration
public bool GenerateGLEntriesForInProgress { get; set; }
Property Value
IsInstrumentMandatory
Indicates an instrument selection for this transaction is mandatory
Declaration
public bool IsInstrumentMandatory { get; set; }
Property Value
LedgerID
Links to ILedger. The Ledger these Transaction Values are recorded against.
If blank the User will have to select a Ledger.
This Ledger is used for GL Postings that are automatically created and don't have a Ledger specified for
themselves.
Declaration
public Guid? LedgerID { get; set; }
Property Value
LedgerID_Label
Declaration
public string LedgerID_Label { get; set; }
Property Value
LedgerID_Label_Silent
Declaration
[NotMapped]
public string LedgerID_Label_Silent { get; set; }
Property Value
Name
[Key] The unique user friendly name of this Transaction Code
Declaration
[Unique]
[Required]
[StringLength(500)]
public string Name { get; set; }
Property Value
Path
Indicates the method in which the path for allocations is determined for this transaction.
Declaration
[EnumDataType(typeof(TransactionCodePath))]
public TransactionCodePath Path { get; set; }
Property Value
Declaration
[NotMapped]
public string Path_Tooltip { get; set; }
Property Value
PeriodEndStatus
Holds a status that can be used in period end reporting
Declaration
[EnumDataType(typeof(TransactionCodePeriodEndStatus))]
public TransactionCodePeriodEndStatus PeriodEndStatus { get; set; }
Property Value
Declaration
[NotMapped]
public string PeriodEndStatus_Tooltip { get; set; }
Property Value
Indicates the formula to use to evaluate the price value.
Declaration
public string PriceValueFormula { get; set; }
Property Value
SettingsTypeID
Indicates this Transaction has custom settings associated with it. This allows selection of any Custom Entity
(created through our Designers or API) that implements IHasTransactionSetting
.
These settings can be used in any of your custom processes or formulas for the Transaction.
Declaration
public Guid? SettingsTypeID { get; set; }
Property Value
ShowAllocationDate
This indicates the allocation date is visible or not
Declaration
public bool ShowAllocationDate { get; set; }
Property Value
ShowAllocationDateInGL
This indicates the allocation date is visible or not within the postings grid
Declaration
public bool ShowAllocationDateInGL { get; set; }
Property Value
ShowAllocationType
This indicates if allocation type is visible or not
Declaration
public bool ShowAllocationType { get; set; }
Property Value
ShowCSE
This indicates if CSE is visible or not
Declaration
public bool ShowCSE { get; set; }
Property Value
ShowCounterparty
This indicates if counter party is visible or not
Declaration
public bool ShowCounterparty { get; set; }
Property Value
ShowCurrency
This indicates if currency is visible or not
Declaration
public bool ShowCurrency { get; set; }
Property Value
ShowCurrencyInGL
This indicates if currency is visible or not within the postings grid
Declaration
public bool ShowCurrencyInGL { get; set; }
Property Value
ShowDescription
This indicates if document reference is visible or not
Declaration
public bool ShowDescription { get; set; }
Property Value
ShowDocumentReference
This indicates if document reference is visible or not
Declaration
public bool ShowDocumentReference { get; set; }
Property Value
ShowEffectiveDate
This indicates transaction effective date is visible or not
Declaration
public bool ShowEffectiveDate { get; set; }
Property Value
ShowEffectiveDateInGL
This indicates transaction effective date is visible or not within the postings grid
Declaration
public bool ShowEffectiveDateInGL { get; set; }
Property Value
ShowExchangeRateCategory
This indicates if exchange rate category is visible or not
Declaration
public bool ShowExchangeRateCategory { get; set; }
Property Value
ShowFinancialDate
This indicates transaction financial date is visible or not
Declaration
public bool ShowFinancialDate { get; set; }
Property Value
ShowFinancialDateInGL
This indicates transaction financial date is visible or not within the postings grid
Declaration
public bool ShowFinancialDateInGL { get; set; }
Property Value
ShowFuncNetAmount
This indicates if func net amount is visible or not
Declaration
public bool ShowFuncNetAmount { get; set; }
Property Value
ShowFxRate
This indicates if fx rate is visible or not
Declaration
public bool ShowFxRate { get; set; }
Property Value
ShowInstrument
This indicates if instrument is visible or not
Declaration
public bool ShowInstrument { get; set; }
Property Value
ShowInstrumentEntity
This indicates if deal is visible or not
Declaration
public bool ShowInstrumentEntity { get; set; }
Property Value
ShowInstrumentEntityInGL
This indicates if deal is visible or not within the postings grid
Declaration
public bool ShowInstrumentEntityInGL { get; set; }
Property Value
ShowInstrumentInGL
This indicates if instrument is visible or not within the postings grid
Declaration
public bool ShowInstrumentInGL { get; set; }
Property Value
ShowLedger
This indicates if ledger is visible or not
Declaration
public bool ShowLedger { get; set; }
Property Value
ShowLocalNetAmount
This indicates if local net amount is visible or not
Declaration
public bool ShowLocalNetAmount { get; set; }
Property Value
ShowOriginalEntity
This indicates if original entity is visible or not
Declaration
public bool ShowOriginalEntity { get; set; }
Property Value
ShowOriginalInstrument
This indicates if original instrument is visible or not
Declaration
public bool ShowOriginalInstrument { get; set; }
Property Value
ShowPath
This indicates if path is visible or not
Declaration
public bool ShowPath { get; set; }
Property Value
ShowPathInGL
This indicates if path is visible or not within the postings grid
Declaration
public bool ShowPathInGL { get; set; }
Property Value
ShowPrice
This indicates if price is visible or not
Declaration
public bool ShowPrice { get; set; }
Property Value
ShowReferenceDate
This indicates the reference date is visible or not
Declaration
public bool ShowReferenceDate { get; set; }
Property Value
This indicates if related entity is visible or not
Declaration
public bool ShowRelatedEntity { get; set; }
Property Value
This indicates if related entity is visible or not within the postings grid
Declaration
public bool ShowRelatedEntityInGL { get; set; }
Property Value
ShowReportingFxRate
This indicates if reporting fx rate is visible or not
Declaration
public bool ShowReportingFxRate { get; set; }
Property Value
ShowReportingNetAmount
This indicates if reporting net amount is visible or not
Declaration
public bool ShowReportingNetAmount { get; set; }
Property Value
ShowRounding
This indicates if rounding is visible or not
Declaration
public bool ShowRounding { get; set; }
Property Value
ShowSettlementDate
This indicates if transaction settlement date is visible or not
Declaration
public bool ShowSettlementDate { get; set; }
Property Value
ShowStatus
This indicates transaction status is visible or not
Declaration
public bool ShowStatus { get; set; }
Property Value
ShowTransactionDate
This indicates transaction date is visible or not
Declaration
public bool ShowTransactionDate { get; set; }
Property Value
ShowTransactionDateInGL
This indicates transaction date is visible or not within the postings grid
Declaration
public bool ShowTransactionDateInGL { get; set; }
Property Value
ShowTransactionsAndGL
This indicates if the transactions and gl view should be show - if false the transaction code must have a parameters view so that will show instead. Can be used for header transactions that have parameters only and create othe transactions.
Declaration
public bool ShowTransactionsAndGL { get; set; }
Property Value
ShowUnits
This indicates if units is visible or not
Declaration
public bool ShowUnits { get; set; }
Property Value
SubAccountMandatory
Indicates transactions using this code should have gl entries linked to gl sub accounts
Declaration
public bool SubAccountMandatory { get; set; }
Property Value
TransactionSettingLayoutID
Links to ILayout. Holds a custom transaction layout for entities that extend a transaction. Settings for custom transaction processing can be stored here.
Declaration
public Guid? TransactionSettingLayoutID { get; set; }
Property Value
TransactionSettingLayoutID_Label
Declaration
public string TransactionSettingLayoutID_Label { get; set; }
Property Value
TransactionSettingLayoutID_Label_Silent
Declaration
[NotMapped]
public string TransactionSettingLayoutID_Label_Silent { get; set; }
Property Value
Type
The Type of Transaction Types for this Transaction Code. Only Values that belong to this Type can be recorded
against Transactions that use this Code.
Declaration
[Required]
[EnumDataType(typeof(TransactionTypeEnum))]
public TransactionTypeEnum Type { get; set; }
Property Value
Declaration
[NotMapped]
public string Type_Tooltip { get; set; }
Property Value
Indicates the formula to use to evaluate the units value.
Declaration
public string UnitsValueFormula { get; set; }
Property Value
ValidInstruments
Indicates which instruments are valid for use with this code.
Declaration
[EnumDataType(typeof(ValidInstruments))]
public ValidInstruments ValidInstruments { get; set; }
Property Value
Declaration
[NotMapped]
public string ValidInstruments_Tooltip { get; set; }
Property Value
Methods
AlterCopiedItem(IEntityUpdater, UserInfo, IReadOnlyCache, IBaseEntity)
A custom ability to alter this item when it is was copied by the user in the UI, not when it is being imported
Declaration
public Task AlterCopiedItem(IEntityUpdater host, UserInfo user, IReadOnlyCache cache, IBaseEntity sourceItem)
Parameters
Returns
| Type |
Description |
| Task |
A task inidicating the finishing of this method
|
CopyFromEntity(IBaseEntity)
Declaration
protected override void CopyFromEntity(IBaseEntity src)
Parameters
Overrides
CopyFromSource(ITransactionCode)
Updates all properties in this item to have the same properties as the source object.
Declaration
public void CopyFromSource(ITransactionCode source)
Parameters
| Type |
Name |
Description |
| ITransactionCode |
source |
The source object to copy all values from.
|
Determines whether the source item should be copied based on the provided relationship
Declaration
public bool CopyRelatedItem(IBaseEntity sourceItem, EntityRelationship rel)
Parameters
| Type |
Name |
Description |
| IBaseEntity |
sourceItem |
The original source item this item was copied from
|
| EntityRelationship |
rel |
The particular relationship from the source item
|
Returns
ToString()
Declaration
public override string ToString()
Returns
Overrides
Implements
Extension Methods