Functions on transactions
In principle, all components of a transaction are contained in one data record per transaction (BookEntry). There is no (longer) a division into bookings and orders. Accrued interest and interim profits are also no longer held in separate orders and postings, but are specified in the transaction.
BookEntry.AccruedInterestAmount→Number
Result: The AccruedInterestAmount
function returns the accrued interest booked with the transaction in trading currency.
BookEntry.Aggregate→Combitransaction
Result: The Aggregate
function returns the combined transaction.
BookEntry.AggregateSequenceID→number
Result: The AggregateSequenceID
function returns the (internal) sequence number of the combined transaction.
BookEntry.AggregateType→Combined transaction type
Result: The AggregateType
function returns the combined transaction type - e.g. securities account transfer, foreign exchange transaction, forward exchange transaction.
BookEntry.AMLComment→String
Result: The AMLComment
function provides the Money Laundering Act comment entered for the transaction.
Module "Portfolio Service Extended Portfolio Analysis"
BookEntry.AMLComplianceComment→String
Result: The AMLComplianceComment
function provides the Money Laundering Act compliance comment entered for the transaction.
Module "Portfolio Service Extended Portfolio Analysis"
BookEntry.AMLComplianceDate→DateWithTime
Result: The AMLComplianceDate
function provides the date and time of the Money Laundering Act compliance comment for the transaction.
Module "Portfolio Service Extended Portfolio Analysis"
BookEntry.AMLComplianceStatus→IndexString
Result: The AMLComplianceStatus
function provides the anti-money laundering compliance status of the transaction.
Module "Portfolio Service Extended Portfolio Analysis"
BookEntry.AMLComplianceUser→User
Result: The AMLComplianceUser
function returns the Infront Portfolio Manager user who entered the Money Laundering Act compliance comment for the transaction.
Module "Portfolio Service Extended Portfolio Analysis"
BookEntry.AMLDate→DatewithTime
Result: The AMLDate
function provides the date and time for the Money Laundering Act comment of the transaction.
Module "Portfolio Service Extended Portfolio Analysis"
BookEntry.AMLUser→User
Result: The AMLUser
function returns the Infront Portfolio Manager user who entered the Money Laundering Act comment for the transaction.
Module "Portfolio Service Extended Portfolio Analysis"
BookEntry.AmountFEX→Number
Result: The AmountFEX
function returns the earmarked amount of the booking for forward exchange transactions.
BookEntry.AverageHoldingTime→number
Result: The AverageHoldingTime
function returns the average holding time in days, weighted by nominal value.
BookEntry.Base→Number
Result: The Base
function provides the assessment basis of the transaction, i.e. the profit or income relevant for the withholding tax before loss offsetting and before tax deduction in tax currency.
BookEntry.Batch→Batch
Result: The Batch
function returns the batch to which this transaction is assigned.
BookEntry.BookEntryPrice→number
Result: The BookEntryPrice
function returns the price of the transaction.
BookEntry.BookEntryVolume→Number
Result: The BookEntryVolume
function returns the nominal value * price / price factor * exchange rate.
BookEntry.BrokersCommission
[currency]→number
Currency (Currency [account currency]).
Result: The BrokersCommission
function returns the brokerage fee incurred or booked for the transaction.
BookEntry.Cancelation→Boolean
Result: The Cancelation
function provides an indication of whether the transaction has been canceled or not.
BookEntry.CashAccount→Account
Result: The CashAccount
function returns the account of the transaction.
BookEntry.CashAmount→Number
Result: The CashAmount
function returns the amount of the transaction in account currency.
BookEntry.Charges
[currency]→number
Currency (Currency [account currency]).
Result: The Charges
function returns the charges incurred or booked for the transaction.
BookEntry.CloseCountOther→Number
Result: The CloseCountOther
function returns the number of securities sold subject to withholding tax (excluding shares).
BookEntry.CloseCountShares→Number
Result: The CloseCountShares
function returns the number of shares sold subject to withholding tax.
BookEntry.ClosingPrice
[take expenses into account]→number
Consider expenses (Boolean[True]).
Result: The ClosingPrice
function returns the closing price of the transaction.
BookEntry.Comment→String
Result: The Comment
function provides the comment on the transaction.
BookEntry.ContractStartDate→Date
Result: The ContractStartDate
function returns the investment date for fixed-term deposits.
BookEntry.CostElementCurrency→Currency
Result: The CostElementCurrency
function returns the currency of the cost element of the transaction.
Cost service" module
BookEntry.CostElementValue
[CostSchemePosition;CostCategory;CostType;CostElement]→Number
CostSchemePosition (CostSchemePosition).
CostCategory (String): The cost category of the cost item, e.g. "Entry costs".
CostType (String): The cost type of the cost item, e.g. "Internal costs" or "External costs".
CostElement (String): The individual cost item, e.g. "brokerage fee" or "bank charges".
Result: The CostElementValue
function returns the value of the cost element of the transaction.
Cost service" module
BookEntry.CostPositions→List
(CostSchemePosition)
Result: The CostPositions
function returns the assigned CostSchemePosition. Any costs recorded without cost service are also output.
Cost service" module
BookEntry.CurrencyFees→Currency
Result: The CurrencyFees
function returns the currency of the charges and fees for the transaction.
BookEntry.CurrencyTax→Currency
Result: The CurrencyTax
function returns the currency in which the taxes for the transaction are specified.
BookEntry.DateChanged→Date
Result: The DateChanged
function returns the date of the last change to the transaction.
BookEntry.DateCreated→Date
Result: The DateCreated
function returns the date on which the transaction was entered.
BookEntry.DealAmount→Number
Result: The DealAmount
function returns the market value of the transaction in trading currency. This market value has a trading-side sign and is calculated without interim profits and accrued interest. The market value does not contain any account-side components - i.e. no parts that are only effective on the account without having trading-side counterparts (fees, taxes, etc.).
BookEntry.Depository→Storage location
Result: The Depository
function returns the depository of the transaction.
BookEntry.EntryDate→Date
Result: The EntryDate
function returns the posting date of the transaction.
BookEntry.ExchangeRateTax→Number
Result: The function returns The exchange rate of the transaction from tax currency to account currency.
BookEntry.ExchangeRateTo
[from-currency;to-currency]→number
From currency (currency).
Post-currency (currency).
Result: The ExchangeRateTo
function returns the exchange rate of the "From currency" to "To currency". The "from currency" must be the same as the transaction, account, tax or "to currency".
BookEntry.ExchangeRateTradeCurrency→Number
Result: The ExchangeRateTradeCurrency
function returns the exchange rate of the transaction from trading currency to account currency.
BookEntry.EXDate→Date
Result: The EXDate
function returns the ex-date of the transaction.
BookEntry.Exogen→Boolean
Result: The Exogen
function provides an indication of whether or not the "Exogen" property is activated for this transaction (in particular inbound or outbound delivery).
BookEntry.ExternalSysDate→Date
Result: The ExternalSysDate
function returns the external transaction date from a backend (Portfolio Sync Interface only).
BookEntry.Fees
[currency]→number
Currency (Currency [account currency]).
Result: The Fees
function returns the bank charges entered for the transaction.
BookEntry.FeeSum
[currency]→number
Currency (Currency [account currency]).
Result: The FeeSum
function returns the sum of the cash flow-effective parts of the fees for a transaction.
BookEntry.FutureOpeningPrice→number
Result: The FutureOpeningPrice
function returns the opening price of a future transaction.
BookEntry.HasSecurity→Boolean
Result: The HasSecurity
function provides an indication of whether the transaction contains a security or not.
BookEntry.HistDate→Date
Result: The HistDate
function provides the historical (entry) date of the posting, which you enter on the "Historical values" mini-tab on the second page of the "Posting" dialog window when entering a posting.
BookEntry.HistExchangeRate→Number
Result: The HistExchangeRate
function returns the historical exchange rate of the transaction (delivery).
BookEntry.HistInterimProfit→Number
Result: The HistInterimProfit
function provides the historical interim profit of a (fund) deposit.
BookEntry.HistPrice→Number
Result: The HistPrice
function returns the historical price of the transaction.
BookEntry.Holding→Number
Result: The Holding
function supplies the stock.
BookEntry.HoldingNotConservedOther→Number
Result: The HoldingNotConservedOther
function returns the portfolio of securities (except shares) that are not subject to grandfathering and are therefore subject to withholding tax.
BookEntry.HoldingNotConservedShares→Number
Result: The HoldingNotConservedShares
function returns the number of shares that are not protected and are therefore subject to withholding tax.
BookEntry.ID→Number
Result: The ID
function returns the unique database ID of the transaction.
BookEntry.IndexRatio→number
Result: The IndexRatio
function returns the index ratio for transactions on index-linked bonds.
BookEntry.InterestRate→Number
Result: The InterestRate
function provides the interest rate of the transaction - e.g. when investing fixed-term deposits or taking out loans.
BookEntry.InterestType→Number
Result: The function returns The interest calculation method (period formula type).
BookEntry.InterfaceName→String
Result: The InterestType
function returns the name of the interface (Portfolio Sync Interface) that has been imported.
BookEntry.InterimProfit→Number
Result: The InterimProfit
function returns the interim profit of the (fund) transaction booked with the transaction in trading currency.
BookEntry.InverseInterestLogic→Boolean
Result: The InverseInterestLogic
function specifies whether the logic should be evaluated in reverse. Concerns, for example, interim profits, accrued interest or income-related expenses.
BookEntry.IsClosing→Boolean
Result: The IsClosing
function provides an indication of whether the transaction is a closing or not. It provides "truth" for closings.
BookEntry.ISKupon→Boolean
Result: The ISKupon
function provides an indication of whether the transaction is a coupon or not. It delivers "true" for coupons.
BookEntry.KESt→Number
Result: The KESt
function returns the capital gains tax in tax currency.
BookEntry.kickback
[currency]→number
Currency (Currency [account currency]).
Result: The Kickback
function provides information on the reimbursement incurred during the transaction or entered under "Charges and fees".
BookEntry.KickbackCashflowEffective
[currency]→number
Currency (Currency [account currency]).
Result: The KickbackCashflowEffective
function provides the cashflow-effective refund incurred in the transaction or entered under "Expenses and fees".
BookEntry.KiSt→number
Result: The KiSt
function provides the church tax in tax currency.
BookEntry.KiStPartner→Number
Result: The KiStPartner
function provides the church tax of the spouse in tax currency.
BookEntry.KoSt→Number
Result: The KoSt
function provides the corporation tax in tax currency.
BookEntry.LastOpening→Date
Result: The LastOpening
function returns the date of the last purchase.
BookEntry.Lock→Lock
Result: The Lock
function returns the lock assigned to this transaction.
BookEntry.LongShort→Boolean
Result: The LongShort
function provides the long (short) flag for options and futures transactions.
BookEntry.MaturityDate→Date
Result: The MaturityDate
function returns the maturity date of the transaction.
BookEntry.MMUser→String
Result: The MMUser
function returns the user who made the last change to the transaction.
BookEntry.OpeningBookEntries→List
(Collection(BookEntry;SoldPieces:Number))
Result: The OpeningBookEntries
function provides the openings for this transaction.
BookEntry.OrderBookEntry→OrderBookOrder
Result: The OrderBookEntry
function returns the order book entry associated with the transaction.
BookEntry.PAIReferenceDate
[PAIMetrik;Date]→Date
PAIMetric (PAIMetric|String).
Date (date [evaluation date]).
Result: The PAIReferenceDate
function returns the PAI reference date.
BookEntry.PAIValue
[PAIMetrik;Date]→(String|Boolean|Number)
PAIMetric (PAIMetric|String).
Date (date [evaluation date]).
Result: The PAIValue
function returns the most recent value of the PAI indicator for the security on the date.
BookEntry.PoolingFactor→Number
Result: The PoolingFactor
function returns the pool factor of the (pool factor bond) transaction.
BookEntry.PriceLoad
[currency]→number
Currency (Currency [account currency]).
Result: The PriceLoad
function returns the issue premium for the transaction.
BookEntry.Profit
[Consider expense;Position currency;Reference currency;Since;Historical;Cost calculation type]→Number
Consider expenses (Boolean[True]).
Position currency (currency [trading currency]): The position currency in which the calculation is made.
Reference currency (currency [account currency]): The reference currency in which the profit is stated.
Since (date): If a date is specified via this parameter, the profit is not determined in relation to the cost price, but according to a "since" valuation.
Historical (Boolean [False]): If this parameter is set to "True", the "historical" price information is taken into account for deliveries.
Cost calculation type (cost calculation type [average]): This parameter changes the way in which the purchase prices are calculated ("average" or "FIFO").
Result: The Profit
function returns the profit (price gain + foreign exchange gain) calculated for the transaction depending on the parameter "Cost calculation type" ("FIFO" or "Average").
BookEntry.ProfitExchange
[Consider expense;Position currency;Reference currency;Since;Historical;Cost calculation type]→Number
Consider expenses (Boolean[True]).
Position currency (currency [trading currency]): The position currency in which the calculation is made.
Reference currency (currency [account currency]): The reference currency in which the profit is stated.
Since (date): If a date is specified via this parameter, the profit is not determined in relation to the cost price, but according to a "since" valuation.
Historical (Boolean [False]): If this parameter is set to "True", the "historical" price information is taken into account for deliveries.
Cost calculation type (cost calculation type [average]): This parameter changes the way in which the purchase prices are calculated ("average" or "FIFO").
Result: The ProfitExchange
function returns the foreign exchange profit of the transaction.
BookEntry.ProfitOther
[Consider expenses;Position currency;Reference currency;Since]→Number
Consider expenses (Boolean[True]).
Position currency (currency [trading currency]): The position currency in which the calculation is made.
Reference currency (currency [account currency]): The reference currency in which the profit is stated.
Since (date): If a date is specified via this parameter, the profit is not determined in relation to the cost price, but according to a "since" valuation.
Result: The ProfitOther
function returns the profit after withholding tax (securities other than shares) of the transaction.
BookEntry.ProfitPercentage
[Consider expense;Position currency;Reference currency;Since;Historical;Cost calculation type]→Number
Consider expenses (Boolean[True]).
Position currency (currency [trading currency]): The position currency in which the calculation is made.
Reference currency (currency [account currency]): The reference currency in which the profit is stated.
Since (date): If a date is specified via this parameter, the profit is not determined in relation to the cost price, but according to a "since" valuation.
Historical (Boolean [False]): If this parameter is set to "True", the "historical" price information is taken into account for deliveries.
Cost calculation type (cost calculation type [average]): This parameter changes the way in which the purchase prices are calculated ("average" or "FIFO").
Result: The ProfitPercentage
function returns the percentage profit of the transaction.
BookEntry.ProfitPrice
[Consider expense;Position currency;Reference currency;Since;Historical;Cost calculation type]→Number
Consider expenses (Boolean[True]).
Position currency (currency [trading currency]): The position currency in which the calculation is made.
Reference currency (currency [account currency]): The reference currency in which the profit is stated.
Since (date): If a date is specified via this parameter, the profit is not determined in relation to the cost price, but according to a "since" valuation.
Historical (Boolean [False]): If this parameter is set to "True", the "historical" price information is taken into account for deliveries.
Cost calculation type (cost calculation type [average]): This parameter changes the way in which the purchase prices are calculated ("average" or "FIFO").
Result: The ProfitPrice
function returns the price profit of the transaction.
BookEntry.ProfitShares
[Consider expenses;Position currency;Reference currency;Since]→Number
Consider expenses (Boolean[True]).
Position currency (currency [trading currency]): The position currency in which the calculation is made.
Reference currency (currency [account currency]): The reference currency in which the profit is stated.
Since (date): If a date is specified via this parameter, the profit is not determined in relation to the cost price, but according to a "since" valuation.
Result: The ProfitShares
function returns the profit after withholding tax (shares) of the transaction.
BookEntry.PurchasePrice
[Consider expense;Position currency;Reference currency;Since;Historical;Purchase price calculation type]→Number
Consider expenses (Boolean[True]).
Position currency (currency [trading currency]): The position currency in which the calculation is made.
Reference currency (currency [account currency]): The reference currency in which the profit is stated.
Since (date): If a date is specified via this parameter, the profit is not determined in relation to the cost price, but according to a "since" valuation.
Historical (Boolean [False]): If this parameter is set to "True", the "historical" price information is taken into account for deliveries.
Cost calculation type (cost calculation type [average]): This parameter changes the way in which the purchase prices are calculated ("average" or "FIFO").
Result: The PurchasePrice
function returns:
For transactions that are not a closing: the purchase price, which is calculated according to the selected "cost price calculation method".
For closings: the buy price associated with this closing. With "FIFO", the price and foreign exchange gain is not calculated against the average purchase price (as with "average"), but against the oldest units in the portfolio. The function returns the purchase price of these pieces.
BookEntry.PurchasePriceAfter
[Consider expense;Position currency;Reference currency;Since;Historical;Purchase price calculation type]→Number
Consider expenses (Boolean[True]).
Position currency (currency [trading currency]): The position currency in which the calculation is made.
Reference currency (currency [account currency]): The reference currency in which the profit is stated.
Since (date): If a date is specified via this parameter, the profit is not determined in relation to the cost price, but according to a "since" valuation.
Historical (Boolean [False]): If this parameter is set to "True", the "historical" price information is taken into account for deliveries.
Cost calculation type (cost calculation type [average]): This parameter changes the way in which the purchase prices are calculated ("average" or "FIFO").
Result: The PurchasePriceAfter
function returns the purchase price after the transaction. In the case of closings, the buy price of the non-closed partial position is delivered.
BookEntry.PurchasePriceBefore
[Consider expense;Position currency;Reference currency;Since;Historical;Purchase price calculation type]→Number
Consider expenses (Boolean[True]).
Position currency (currency [trading currency]): The position currency in which the calculation is made.
Reference currency (currency [account currency]): The reference currency in which the profit is stated.
Since (date): If a date is specified via this parameter, the profit is not determined in relation to the cost price, but according to a "since" valuation.
Historical (Boolean [False]): If this parameter is set to "True", the "historical" price information is taken into account for deliveries.
Cost calculation type (cost calculation type [average]): This parameter changes the way in which the purchase prices are calculated ("average" or "FIFO").
Result: The PurchasePriceBefore
function returns the purchase price calculated before the transaction, depending on the parameter "Purchase price calculation type" ("FIFO" or "Average").
BookEntry.Quantity→Number
Result: The Quantity
function returns the number of securities in the transaction as a quantity or nominal value.
BookEntry.RedemptionFee
[currency]→number
Currency (Currency [account currency]).
Result: The RedemptionFee
function provides the amount of the redemption fee entered for a sale transaction in account currency.
BookEntry.royalties
[currency]→number
Currency (Currency [account currency]).
Result: The Royalties
function returns the foreign charges or the foreign charges of the transaction in account currency.
BookEntry.SafeKeepingAccount→Depot
Result: The SafeKeepingAccount
function provides the securities account of the (securities) transaction.
BookEntry.SalesDiscount
[currency]→number
Currency (Currency [account currency]).
Result: The SalesDiscount
function returns the bonus entered for the transaction.
BookEntry.Security→Securities
Result: The Security
function provides the security affected by the transaction.
BookEntry.SolZ→Number
Result: The SolZ
function provides the solidarity surcharge in tax currency.
BookEntry.SpecialAsset→SpecialAsset
Result: The SpecialAsset
function provides the special asset (time deposit, loan, forward exchange transaction or margin) assigned to the transaction, if applicable.
BookEntry.StampTax
[currency]→number
Currency (Currency [account currency]).
Result: The StampTax
function returns the stamp duty for the transaction.
BookEntry.Subrogation→Boolean
Result: The subrogation
function indicates whether the profit is taxable when it is delivered.
BookEntry.TaxLiquidity→Number
Result: The TaxLiquidity
function provides the tax liquidity of a security income (for accumulating funds).
BookEntry.TaxSum
[currency]→number
Currency (currency [tax currency]).
Result: The TaxSum
function returns the sum of the cash flow-effective parts of the taxes of a transaction. The purely informative taxes are not included.
BookEntry.TaxTranches→List
(TaxTranche)
Result: The TaxTranches
function provides the tax tranches of the transaction.
BookEntry.TradeCurrency→Currency
Result: The TradeCurrency
function returns the trading currency of the transaction.
BookEntry.TradingPlace→Place
Result: The TradingPlace
function provides the trading place for the transaction.
BookEntry.TransactionNumber→String
Result: The TransactionNumber
function provides the unique external transaction number of the transaction (e.g. from a PSI Transaction Data).
BookEntry.TransactionType→TransactionType
Result: The TransactionType
function returns the transaction type of the transaction - e.g. purchase, cash deposit, delivery...
TransactionWPs→List
(security)
Result: The TransactionWPs
function provides the list of all securities booked as part of the transaction data.
BookEntry.ValueDate→Date
Result: The ValueDate
function returns the value date of the transaction.
BookEntry.VAT
[currency]→number
Currency (Currency [account currency]).
Result: The VAT
function returns the VAT of the transaction.
BookEntry.WITF→number
Result: The WITF
function returns the sum of creditable and refundable withholding tax in tax currency.
BookEntry.WITR→number
Result: The WITR
function returns the refundable withholding tax in tax currency.
BookEntry.WITV→number
Result: The WITV
function supplies the notional withholding tax in tax currency.
BookEntry.WrittenByInterface→Boolean
Result: The WrittenByInterface
function provides an indication of whether this transaction was entered via a Portfolio Sync Interface or not.
BookEntry.ZASt→number
Result: The ZASt
function supplies the interest income tax in tax currency.