Supported transaction types
The table below contains the currently supported transaction types. Supported transactions will be expanded with general availability. Note: This list is for reference only. We do not support a transaction type API at this time.
If the cash position for an account fee transaction is unknown, enter a null owner ID and don't specify a cash position in the relationship.
| Type | Description | Can be used with | Required fields | Supports negative values? |
|---|---|---|---|---|
account_fee | A fee charged to an account that affects account-level performance Does not affect security-level fees. | All but cash | Under relationships Owned should correspond to the account and the Owner dictionary should be removed. Units are not required and will be ignored if provided. | No, negative values can be provided but are ignored and converted to positive. |
account_fee_advisor | A fee charged by a financial advisor. Identical to an account fee. | All but cash | Same as account_fee | No, negative values can be provided but are ignored and converted to positive. |
account_fee_bank | A fee charged by the bank. Identical to an account fee. | All but cash | Same as account_fee | No, negative values can be provided but are ignored and converted to positive. |
account_fee_custodian | A fee charged by a custodian. Identical to an account fee. | All but cash | Same as account_fee | No, negative values can be provided but are ignored and converted to positive. |
account_fee_management | A fee charged by a manager. Identical to an account fee. | All but cash | Same as account_fee | No, negative values can be provided but are ignored and converted to positive. |
account_fee_professional | A fee charged for professional services. Identical to an account fee. | All but cash | Same as account_fee | No, negative values can be provided but are ignored and converted to positive. |
account_fee_reimbursement | The amount of cash returned to an investor as a reimbursement for an earlier account-level fee. | All but cash | Same as account_fee | No, negative values can be provided but are ignored and converted to positive. |
account_fee_reimbursement_advisor | A refund of an advisor fee. | All but cash | Same as account_fee | No, negative values can be provided but are ignored and converted to positive. |
account_fee_reimbursement_bank | A refund of a bank fee. | All but cash | Same as account_fee | No, negative values can be provided but are ignored and converted to positive. |
account_fee_reimbursement_custodian | A refund of a custodian fee. | All but cash | Same as account_fee | No, negative values can be provided but are ignored and converted to positive. |
account_fee_reimbursement_management | A refund of a management fee. | All but cash | Same as account_fee | No, negative values can be provided but are ignored and converted to positive. |
account_fee_reimbursement_professional | A refund of a professional fee. | All but cash | Same as account_fee | No, negative values can be provided but are ignored and converted to positive. |
adjustment | Creates a gain/loss on cash directly, otherwise equivalent to a buy/sell with $0 amount. | All share-based | n/a | Yes |
buy | Increases units of the security position and decreases cash on the cash position. Opens a tax lot with cost equaling the net amount of principal and fees. For fixed income securities, accrued interest can be included. It is not included in the cost basis and will be considered an expense. | All share-cased but cash | n/a | No, negative values can be provided but are ignored and converted to positive. |
capital_call | A legally-backed demand for a fund to collect a portion of commitment from a limited partner. | Managed funds | Units are not required and will be ignored if provided. | No, negative values can be provided but are ignored and converted to positive. |
cash_dividend | By default increases security performance via income and increases cash on the cash position. | All but cash | Additional field for “dividend” under attributes. The value corresponds to the dividend amount. "dividend": 1000.0 Units are not required and will be ignored if provided. ex_date is not required, but should be provided in order to calculate accrued income correctly. | No, only positive values are supported. |
cash_in_lieu | Removes fractional shares and increases cash like a "sell". | All share-based but cash | n/a Amount corresponds to the amount of cash received and Units refers to the units that were not received in lieu of cash. | No, negative values can be provided but are ignored and converted to positive. |
change_in_unrealized_gain | Increases or decreases the adjusted value without affecting net cash flow. | Value-based | n/a Units are not required and will be ignored if provided. | Yes |
commitment | Increases total commitment on a value-based asset. No effect on cash or performance. | Value-based | n/a Units are not required and will be ignored if provided. | No, negative values can be provided but are ignored and converted to positive. |
commitment_reduction | Decreases total commitment on a value-based asset. No effect on cash or performance. | Value-based | Units are not required and will be ignored if provided. | No, negative values can be provided but are ignored and converted to positive. |
contribution | Increases the adjusted value of a value-based asset, and decreases cash (and usually the unfunded commitment) by an equal amount. | Value-based | Units are not required and will be ignored if provided. | No, negative values can be provided but are ignored and converted to positive. |
conversion | A conversion of shares of one company's stock into shares of another company's stock. This transaction may also be used to convert a convertible note into share of stock. | Share-based | One additional field is required under attributes, “other_units”. Units = shares received, other_units = shares removed., "other_units": 10.0, In addition, under relationships new_owned signifies the asset being received. "new_owned": { "data": { "type": "entities", "id": "21608215" } } | Yes, but in practice negative values should not be used and instead “units” and “other_units” should be used to represent received/removed units, respectively |
corporate_action | A generic transaction that represents a corporate action occurring in the portfolio | Share-based | One additional field is required under attributes, “other_units”. Units = shares received, other_units = shares removed., "other_units": 10.0, In addition, under relationships new_owned signifies the asset being received. "new_owned": { "data": { "type": "entities", "id": "21608215" } } | Yes, but in practice negative values should not be used and instead “units” and “other_units” should be used to represent received/removed units, respectively. |
cost_adjustment | Increases or decreases the cost basis without affecting value or adjusted value. | Value-based | Units are not required and will be ignored if provided. | Yes |
cover_short | Identical to a "buy". | All share-Bbsed but cash | n/a | No, negative values can be provided but are ignored and converted to positive. |
deposit | Increases cash units and doesn't affect performance. | Cash | n/a | No, negative values can be provided but are ignored and converted to positive. |
distribution | Decreases adjusted value of the asset and increases cash .The amount must be allotted to a combination of the following attribute values: "generic" "return_of_capital" "long_term" "short_term" "interest" "ordinary" "dividend" "recallable" | All but cash | Additional field(s) for the sub distribution type(s) should be provided under attributes. The sum of sub distribution values should equal the amount. "generic": 1000.0 Units are not required and will be ignored if provided. | Yes |
exercise_call | Derivatives only | n/a | No, negative values can be provided but are ignored and converted to positive. | |
exercise_put | The act of exercising one's right to sell the security underlying a Put Option at a given strike price. | Derivatives only | n/a | No |
expense | Decreases security performance, and decreases cash. Does not affect cost basis/paid-in capital by default. | Share-based, value-based, percent-based, cash | n/a | No, negative values can be provided but result in an in-app error. |
expense_allocated | Managed funds | n/a Units are not required and will be ignored if provided. | No, negative values can be provided but result in an in-app error. | |
expiration | Equivalent to a "transfer_out" valued at $0. | Option, warrant, futures contract, forward contract | n/a | No, negative values can be provided but are ignored and converted to positive. |
fee (previouslyedge_fee) | Decreases performance on the security position, and decreases cash on the cash position. | All but cash | n/a | No, negative values can be provided but are ignored and converted to positive. |
fee_reimbursement(previously edge_fee_reimbursement) | Portions of this cost that are returned. | All but cash | n/a | No, negative values can be provided but are ignored and converted to positive. |
fund_redemption(previously Distribution.fund_redemption) | Identical to a "distribution." | Value-based | n/a | Yes |
gain | A transaction marking the allocation of a Fund's gains or losses to its Limited Partners. | Managed funds only | n/a Units are not required and will be ignored if provided. | Yes |
generic_flow | Increases or decreases adjusted value without an adjusted performance effect. | Value-based | n/a | Yes |
inception | Percent-based | n/a Amount not required and ignored if provided. | Yes | |
income | Increases security performance and increases cash. | All | n/a | No, negative values can be provided but result in an in-app error. |
income_allocated | Managed funds | n/a Units are not required and will be ignored if provided. | No, negative values can be provided but result in an in-app error. | |
interest_expense | Decreases security performance, and decreases cash on the cash position. | All | n/a | No, negative values can be provided but are ignored and converted to positive. |
interest_income | Increases security performance increases cash on the cash position. | All | n/a | No, negative values can be provided but are ignored and converted to positive. |
journal_in | Identical to a “deposit”. | Cash | n/a | No, negative values can be provided but are ignored and converted to positive. |
journal_out | Identical to a “withdrawal” | Cash | n/a | No, negative values can be provided but are ignored and converted to positive. |
loan_issued | Records the amount issued by a loan lender. | Loans | n/a | No |
loan_taken | Records the amount of a loan taken by a borrower. | Loans | n/a | No |
lookthrough_adjustment | Managed funds | Units = percent change in ownership Amount is not required and will be ignored if provided. | Yes | |
mark_to_market | Increases or decreases the performance of the security, and, increases or decreases cash. Positive mark to market corresponds to a cash increase. | Futures contract, forward contract | Units are not required and ignored if provided. | Yes |
payment_made_in_lieu_of_dividend | Decreases security performance and decreases cash on the cash position. | All share-based but cash | n/a Units are not required and ignored if provided. | No, negative values can be provided but are ignored and converted to positive. |
payment_received_in_lieu_of_dividend | Increases performance on the security position, and increases cash on the cash position. | All share-based but cash | n/a Units are not required and ignored if provided. | No, negative values can be provided but are ignored and converted to positive. |
proceeds_adjustment | Increases the proceeds from a sell or decreases the proceeds from a buy, increasing cash. | All share-based but cash | n/a Units are not required and ignored if provided. | Yes |
recalled_contribution | Decreases the adjusted value of a value-based asset, and increases cash (and usually the unfunded commitment) by an equal amount. | Value-based | n/a | No, negative values can be provided but are ignored and converted to positive. |
redemption | Identical to a "sell", but only available on fixed income securities. | Preferred stock, CMO, bond, certificate of deposit | n/a | No |
reinvestment | Identical to a "buy". | All share-based but cash | n/a | No, negative values can be provided but are ignored and converted to positive. |
sell | Decreases units of the security position and increases cash on the cash position. Generally closes tax lots using FIFO. For Fixed Income securities, accrued interest can be included and will hit be considered an Income. | All share-based but cash | n/a | No |
sell_short | Identical to a "sell", but the resulting position will have negative units and value. | All share-based but cash | n/a | No |
snapshot | A marker of ownership and value of a position at a specific point in time. Snapshots can be combined with valuations, but otherwise snapshots cannot be requested with other transaction types. | Share-based | n/a | Yes |
spinoff | The creation of a brand new company via the breakout of a division or team from a parent company | Share-based | “other_units”. Units = shares received, other_units = shares removed., "other_units": 10.0, In addition, under relationships new_owned signifies the asset being received. "new_owned": { "data": { "type": "entities", "id": "21608215" } } Units = | Yes, but in practice negative values should not be used and instead “units” and “other_units” should be used to represent received/removed units, respectively |
stock_dividend | A payment of stock made by a corporation to its shareholders. | Share-based | n/a | No, negative values can be provided but result in an in-app error. |
stock_reverse_split | Decreases shares. Tax lot units are decreased on a prorated basis. | All share-based but cash | n/a | No, negative values can be provided but result in an in-app error. |
stock_split | An increase in a company's total number of shares that occurs without changing the company's market capitalization and without dilution. A split transaction changes the number of shares represented in a particular position, according to the ratio of the split. | Share-based | n/a | No, negative values can be provided but result in an in-app error. |
tax | Decreases security performance, and decreases cash on the cash position. | All but cash | Units are not required and ignored if provided. | No, negative values can be provided but are ignored and converted to positive. |
tax_refund | Increases security performance be decreasing expense, and increases cash on the cash position. | All but cash | Units are not required and ignored if provided. | No, negative values can be provided but are ignored and converted to positive. |
tax_withholding(previously Withdrawal.tax_withholding) | Identical to a “withdrawal”. | Cash | n/a | No, negative values can be provided but are ignored and converted to positive. |
tax_withholding_refund (previously Deposit.tax_withholding_refund) | Identical to a “deposit”. | Cash | n/a | No, negative values can be provided but are ignored and converted to positive. |
transfer | The movement of value (e.g. cash, stocks, etc.) from one asset, account, or legal entity to another asset, account, or legal entity. | All | Under relationships: "new_owner": { "data": { "type":"entities", "id": 21526369 } } | No, negative values can be provided but are ignored and converted to positive. |
transfer_in | Increases shares/cash/value. For transfers of shares, the amount field specifies the value flow into the account. | All | n/a | No, negative values can be provided but are ignored and converted to positive. |
transfer_out | Increases shares/cash/value. For transfers of shares, the amount field specifies the value flow out of the account. | All | n/a | No, negative values can be provided but are ignored and converted to positive. |
unfunded_adjustment | Increases or decreases the unfunded commitment on a value-based asset. No effect on cash or performance. | Value-based | n/a Units are not required and ignored if provided. | Yes |
valuation | An update to the value of an asset. Valuations can be combined with snapshots, but otherwise valuations cannot be requested with other transaction types. | Value-based | n/a Units are not required and ignored if provided. | Yes |
withdrawal | Decreases cash units and doesn't affect performance. | Cash | n/a | No, negative values can be provided but are ignored and converted to positive. |
write_option | Functions like a "sell_short", but specifically for Options. | Option | n/a | No |
written_exercise_call | The exercise of a call option by a party opposite to your client; in other words, the sale of stock by your client to another party who has exercised an option to purchase stock from you at a particular strike price. | Derivatives only | n/a | No |
written_exercise_put | The exercise of a put option by a party opposite to your client; in other words, the purchase of stock by your client to another party who has exercised an option to sell stock to you at a particular strike price. | Derivatives only | n/a | No, negative values can be provided but are ignored and converted to positive. |
written_expiration | Equivalent to a "transfer_in" valued at $0. | Option, futures contract, forward contract | n/a | No, negative values can be provided but are ignored and converted to positive. |
Updated 10 days ago