Interface ITransactionCodeAllocateToTransaction

The system entity for a transaction code allocate to transaction entity, which holds settings for automatically creating a new transaction for entites that are being allocated to

See https://help.lemonedge.com/transaction-codes/ for more information

Inherited Members
Namespace: LemonEdge.API.Entities.FinancialServices.Transactions
Assembly: LemonEdge.API.Entities.FinancialServices.dll
Syntax
[EntityDefinition(EntityID.TransactionCodeAllocateToTransaction, "dbo.LT_TransactionCodeAllocateToTransactions", "TransactionCodeAllocateToTransaction", IsStandingDataEntity = true, LabelColumn = "Name")]
[DefaultEntityIcon(ImageType.TransactionCode)]
public interface ITransactionCodeAllocateToTransaction : IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

AllowUIEditing

Indicates if the user should be allowed to edit the generated transaction via the UI. Useful for automated offsets in the same batch to prevent the user modifying them.

Declaration
[EntityProperty(SQLType.Bit, false, "1")]
[HardCodedDefaultValueOnNew("true")]
[EntityDescription("Indicates if the user should be allowed to edit the generated transaction via the UI. Useful for automated offsets in the same batch to prevent the user modifying them.")]
bool AllowUIEditing { get; set; }
Property Value
Type Description
bool

AutomaticSubTransaction

Indicates if the offset should automatically be generated as a sub-transaction or not. Requires the transaction code to allow sub transactions.

Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Indicates if the offset should automatically be generated as a sub-transaction or not. Requires the transaction code to allow sub transactions.")]
[DatabasePropertyValidation("MyItem.AutomaticSubTransaction != LemonEdge.API.Entities.FinancialServices.Transactions.TransactionCodeOffsetType.None", "await LemonEdge.API.Entities.FinancialServices.Transactions.TransactionCodeOffsetValidate.AllowsSubTransactions(MyItem, Data)", "Offsets can only be automatic if the transaction code allows sub transactions.")]
TransactionCodeOffsetType AutomaticSubTransaction { get; set; }
Property Value
Type Description
TransactionCodeOffsetType

CreateTransactionForEachAllocation

Indicates a transaction should be created for each allocation

Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates a transaction should be created for each allocation")]
bool CreateTransactionForEachAllocation { get; set; }
Property Value
Type Description
bool

FormulaForAllocationGuard

A formula that returns true or false indicating if an offset should be created for the allocation

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("A formula that returns true or false indicating if an offset should be created for the allocation.")]
string FormulaForAllocationGuard { get; set; }
Property Value
Type Description
string

FormulaForAutomaticSubTransactionGuard

A formula that returns true or false indicating if an offset should be automatically created as a sub-transaction when the AutomaticSubTransaction type of this offset is not None

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("A formula that returns true or false indicating if an offset should be automatically created as a sub-transaction when the AutomaticSubTransaction type of this offset is not None.")]
string FormulaForAutomaticSubTransactionGuard { get; set; }
Property Value
Type Description
string

FormulaForCounterpartyID

This is the formula to use to get the counterparty id for the offset transaction

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("This is the formula to use to get the counterparty id for the offset transaction")]
string FormulaForCounterpartyID { get; set; }
Property Value
Type Description
string

FormulaForEntityID

This is the formula to use to get the entity id for the offset transaction

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("This is the formula to use to get the entity id for the offset transaction.")]
string FormulaForEntityID { get; set; }
Property Value
Type Description
string

FormulaForInstrumentID

This is the formula to use to get the instrument id for the offset transaction

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("This is the formula to use to get the instrument id for the offset transaction")]
string FormulaForInstrumentID { get; set; }
Property Value
Type Description
string

FormulaForLedgerID

This is the formula to use to get the ledger id for the offset transaction. The hardcoded Ledger option for an offset takes precedence over this - leave null for this to be evaluated.

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("This is the formula to use to get the ledger id for the offset transaction. The hardcoded Ledger option for an offset takes precedence over this - leave null for this to be evaluated.")]
string FormulaForLedgerID { get; set; }
Property Value
Type Description
string

FormulaForLocalCurrencyOverride

A formula that returns the id of a local currency to use for the offset instead of the current local currency. The Transaction Code must be setup to allow local currency override for this to work.

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("A formula that returns the id of a local currency to use for the offset instead of the current local currency. The Transaction Code must be setup to allow local currency override for this to work.")]
string FormulaForLocalCurrencyOverride { get; set; }
Property Value
Type Description
string

FormulaForOriginalEntityID

A formula that returns the id of the original entity to use for the offset instead of the source original entity. The Transaction Code must be setup to allow original entity override for this to work.

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("A formula that returns the id of the original entity to use for the offset instead of the source original entity. The Transaction Code must be setup to allow original entity override for this to work.")]
string FormulaForOriginalEntityID { get; set; }
Property Value
Type Description
string

FormulaForOriginalInstrumentID

A formula that returns the id of an original instrument to use for the offset instead of the source original instrument. The Transaction Code must be setup to allow original instrument override for this to work.

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("A formula that returns the id of an original instrument to use for the offset instead of the source original instrument. The Transaction Code must be setup to allow original instrument override for this to work.")]
string FormulaForOriginalInstrumentID { get; set; }
Property Value
Type Description
string

FormulaForPathID

This is the formula to use to get the entity id for the offset transaction

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("This is the formula to use to get the path id for the offset transaction")]
string FormulaForPathID { get; set; }
Property Value
Type Description
string

FormulaForProcessingPostCreation

A formula for processing the final offset transaction after it is created from the offset process

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("A formula for processing the final offset transaction after it is created from the offset process.")]
string FormulaForProcessingPostCreation { get; set; }
Property Value
Type Description
string

FormulaForRelatedEntityID

This is the formula to use to get the related entity id for the offset transaction

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("This is the formula to use to get the related entity id for the offset transaction")]
string FormulaForRelatedEntityID { get; set; }
Property Value
Type Description
string

FormulaForTransactionDate

This is the formula to use to get the transaction date for the offset transaction

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("This is the formula to use to get the transaction date for the offset transaction.")]
string FormulaForTransactionDate { get; set; }
Property Value
Type Description
string

FormulaForUnderlyingEntityID

This is the formula to use to get the underlying entity id for the offset transaction

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("This is the formula to use to get the underlying entity id for the offset transaction")]
string FormulaForUnderlyingEntityID { get; set; }
Property Value
Type Description
string

LedgerID

Links to ILedger. The ledger to use when creating a new transaction for this transaction, if null it uses the ledger setup in the transaction code or the one specified through the Ledger Formula.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.Ledger, "ID", SingleJoinType.ZeroToOne, "Ledger", "Transaction Code Allocations To", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = true, InheritPermissions = false)]
[EntityDescription("The ledger to use when creating a new transaction for this transaction, if null it uses the ledger setup in the transaction code or the one specified through the Ledger Formula.")]
Guid? LedgerID { get; set; }
Property Value
Type Description
Guid?

Name

Declaration
[EntityProperty(SQLType.NVarChar, 500, false, "''")]
[RequiredNoDefaultIDValidation]
[EntityKeyProperty]
string Name { get; set; }
Property Value
Type Description
string

TargetTransactionCodeID

[Key] Links to ITransactionCode. The target transaction code to create a transaction with

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.TransactionCode, "ID", SingleJoinType.One, "Target Transaction Code", "Allocate To As Target", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = true, InheritPermissions = false)]
[RequiredNoDefaultIDValidation]
Guid TargetTransactionCodeID { get; set; }
Property Value
Type Description
Guid

TransactionCodeID

[Key] Links to ITransactionCode. The parent transaction code this processor is a member of

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.TransactionCode, "ID", SingleJoinType.One, "Transaction Code", "Allocate To", DeleteWithRelationship = true, PartOfParentSet = true, LinkToItemInSet = true, InheritPermissions = true)]
[RequiredNoDefaultIDValidation]
[EntityKeyProperty]
Guid TransactionCodeID { get; set; }
Property Value
Type Description
Guid

TransactionFields

Fields to be offset during the transaction too

Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Fields to be offset during the transaction too.")]
OffsetFields TransactionFields { get; set; }
Property Value
Type Description
OffsetFields

Extension Methods

See Also