IPWorks OFX 2020 Python Edition

Questions / Feedback?

tx_total Property

Transaction amount.

Syntax

def get_tx_total(tx_index: int) -> str: ...

Default Value

""

Remarks

Transaction amount. For other than banking transactions (buys, sells, etc.) this is the transaction total: ((quantity * (price +/- markup/markdown)) +/- (commission + fees + load + taxes)).

Distributions, interest, margin interest, misc. expense, etc.: amount.

Return of cap: cost basis.

Banking transactions: this is the amount of money exchanged during a given transaction.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting.

This property is always returned with the transaction information if such an information is requested to be included (include_transactions was set to True) in the investment statement download request (when calling the on_get_statement method).

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks OFX 2020 Python Edition - Version 20.0 [Build 7941]