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.

TypeDescriptionCan be used withRequired fieldsSupports negative values?
account_feeA fee charged to an account that affects account-level performance Does not affect security-level fees.All but cashUnder 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_advisorA fee charged by a financial advisor. Identical to an account fee.All but cashSame as account_feeNo, negative values can be provided but are ignored and converted to positive.
account_fee_bankA fee charged by the bank. Identical to an account fee.All but cashSame as account_feeNo, negative values can be provided but are ignored and converted to positive.
account_fee_custodianA fee charged by a custodian. Identical to an account fee.All but cashSame as account_feeNo, negative values can be provided but are ignored and converted to positive.
account_fee_managementA fee charged by a manager. Identical to an account fee.All but cashSame as account_feeNo, negative values can be provided but are ignored and converted to positive.
account_fee_professionalA fee charged for professional services. Identical to an account fee.All but cashSame as account_feeNo, negative values can be provided but are ignored and converted to positive.
account_fee_reimbursementThe amount of cash returned to an investor as a reimbursement for an earlier account-level fee.All but cashSame as account_feeNo, negative values can be provided but are ignored and converted to positive.
account_fee_reimbursement_advisorA refund of an advisor fee.All but cashSame as account_feeNo, negative values can be provided but are ignored and converted to positive.
account_fee_reimbursement_bankA refund of a bank fee.All but cashSame as account_feeNo, negative values can be provided but are ignored and converted to positive.
account_fee_reimbursement_custodianA refund of a custodian fee.All but cashSame as account_feeNo, negative values can be provided but are ignored and converted to positive.
account_fee_reimbursement_managementA refund of a management fee.All but cashSame as account_feeNo, negative values can be provided but are ignored and converted to positive.
account_fee_reimbursement_professionalA refund of a professional fee.All but cashSame as account_feeNo, negative values can be provided but are ignored and converted to positive.
adjustmentCreates a gain/loss on cash directly, otherwise equivalent to a buy/sell with $0 amount.All share-basedn/aYes
buyIncreases 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 cashn/aNo, negative values can be provided but are ignored and converted to positive.
capital_callA legally-backed demand for a fund to collect a portion of commitment from a limited partner.Managed fundsUnits are not required and will be ignored if provided.No, negative values can be provided but are ignored and converted to positive.
cash_dividendBy default increases security performance via income and increases cash on the cash position.All but cashAdditional 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_lieuRemoves fractional shares and increases cash like a "sell".All share-based but cashn/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_gainIncreases or decreases the adjusted value without affecting net cash flow.Value-basedn/a

Units are not required and will be ignored if provided.
Yes
commitmentIncreases total commitment on a value-based asset. No effect on cash or performance.Value-basedn/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_reductionDecreases total commitment on a value-based asset. No effect on cash or performance.Value-basedUnits are not required and will be ignored if provided.No, negative values can be provided but are ignored and converted to positive.
contributionIncreases the adjusted value of a value-based asset, and decreases cash (and usually the unfunded commitment) by an equal amount.Value-basedUnits are not required and will be ignored if provided.No, negative values can be provided but are ignored and converted to positive.
conversionA 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-basedOne 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_actionA generic transaction that represents a corporate action occurring in the portfolioShare-basedOne 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_adjustmentIncreases or decreases the cost basis without affecting value or adjusted value.Value-basedUnits are not required and will be ignored if provided.Yes
cover_shortIdentical to a "buy".All share-Bbsed but cashn/aNo, negative values can be provided but are ignored and converted to positive.
depositIncreases cash units and doesn't affect performance.Cashn/aNo, negative values can be provided but are ignored and converted to positive.
distributionDecreases 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 cashAdditional 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_callDerivatives onlyn/aNo, negative values can be provided but are ignored and converted to positive.
exercise_putThe act of exercising one's right to sell the security underlying a Put Option at a given strike price.Derivatives onlyn/aNo
expenseDecreases security performance, and decreases cash. Does not affect cost basis/paid-in capital by default.Share-based, value-based, percent-based, cashn/aNo, negative values can be provided but result in an in-app error.
expense_allocatedManaged fundsn/a

Units are not required and will be ignored if provided.
No, negative values can be provided but result in an in-app error.
expirationEquivalent to a "transfer_out" valued at $0.Option, warrant, futures contract, forward contractn/aNo, 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 cashn/aNo, negative values can be provided but are ignored and converted to positive.
fee_reimbursement
(previouslyedge_fee_reimbursement)
Portions of this cost that are returned.All but cashn/aNo, negative values can be provided but are ignored and converted to positive.
fund_redemption
(previouslyDistribution.fund_redemption)
Identical to a "distribution."Value-basedn/aYes
gainA transaction marking the allocation of a Fund's gains or losses to its Limited Partners.Managed funds onlyn/a

Units are not required and will be ignored if provided.
Yes
generic_flowIncreases or decreases adjusted value without an adjusted performance effect.Value-basedn/aYes
inceptionPercent-basedn/a

Amount not required and ignored if provided.
Yes
incomeIncreases security performance and increases cash.Alln/aNo, negative values can be provided but result in an in-app error.
income_allocatedManaged fundsn/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_expenseDecreases security performance, and decreases cash on the cash position.Alln/aNo, negative values can be provided but are ignored and converted to positive.
interest_incomeIncreases security performance increases cash on the cash position.Alln/aNo, negative values can be provided but are ignored and converted to positive.
journal_inIdentical to a “deposit”.Cashn/aNo, negative values can be provided but are ignored and converted to positive.
journal_outIdentical to a “withdrawal”Cashn/aNo, negative values can be provided but are ignored and converted to positive.
loan_issuedRecords the amount issued by a loan lender.Loansn/aNo
loan_takenRecords the amount of a loan taken by a borrower.Loansn/aNo
lookthrough_adjustmentManaged fundsUnits = percent change in ownership

Amount is not required and will be ignored if provided.
Yes
mark_to_marketIncreases or decreases the performance of the security, and, increases or decreases cash. Positive mark to market corresponds to a cash increase.Futures contract, forward contractUnits are not required and ignored if provided.Yes
payment_made_in_lieu_of_dividendDecreases security performance and decreases cash on the cash position.All share-based but cashn/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_dividendIncreases performance on the security position, and increases cash on the cash position.All share-based but cashn/a

Units are not required and ignored if provided.
No, negative values can be provided but are ignored and converted to positive.
proceeds_adjustmentIncreases the proceeds from a sell or decreases the proceeds from a buy, increasing cash.All share-based but cashn/a

Units are not required and ignored if provided.
Yes
recalled_contributionDecreases the adjusted value of a value-based asset, and increases cash (and usually the unfunded commitment) by an equal amount.Value-basedn/aNo, negative values can be provided but are ignored and converted to positive.
redemptionIdentical to a "sell", but only available on fixed income securities.Preferred stock, CMO, bond, certificate of depositn/aNo
reinvestmentIdentical to a "buy".All share-based but cashn/aNo, negative values can be provided but are ignored and converted to positive.
sellDecreases 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 cashn/aNo
sell_shortIdentical to a "sell", but the resulting position will have negative units and value.All share-based but cashn/aNo
snapshotA 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-basedn/aYes
spinoffThe creation of a brand new company via the breakout of a division or team from a parent companyShare-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_dividendA payment of stock made by a corporation to its shareholders.Share-basedn/aNo, negative values can be provided but result in an in-app error.
stock_reverse_splitDecreases shares. Tax lot units are decreased on a prorated basis.All share-based but cashn/aNo, negative values can be provided but result in an in-app error.
stock_splitAn 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-basedn/aNo, negative values can be provided but result in an in-app error.
taxDecreases security performance, and decreases cash on the cash position.All but cashUnits are not required and ignored if provided.No, negative values can be provided but are ignored and converted to positive.
tax_refundIncreases security performance be decreasing expense, and increases cash on the cash position.All but cashUnits are not required and ignored if provided.No, negative values can be provided but are ignored and converted to positive.
tax_withholding
(previouslyWithdrawal.tax_withholding)
Identical to a “withdrawal”.Cashn/aNo, negative values can be provided but are ignored and converted to positive.
tax_withholding_refund (previously Deposit.tax_withholding_refund)Identical to a “deposit”.Cashn/aNo, negative values can be provided but are ignored and converted to positive.
transferThe movement of value (e.g. cash, stocks, etc.) from one asset, account, or legal entity to another asset, account, or legal entity.AllUnder relationships:
"new_owner": {
"data": {
"type":"entities",
"id": 21526369
}
}
No, negative values can be provided but are ignored and converted to positive.
transfer_inIncreases shares/cash/value. For transfers of shares, the amount field specifies the value flow into the account.Alln/aNo, negative values can be provided but are ignored and converted to positive.
transfer_outIncreases shares/cash/value. For transfers of shares, the amount field specifies the value flow out of the account.Alln/aNo, negative values can be provided but are ignored and converted to positive.
unfunded_adjustmentIncreases or decreases the unfunded commitment on a value-based asset. No effect on cash or performance.Value-basedn/a

Units are not required and ignored if provided.
Yes
valuationAn update to the value of an asset. Valuations can be combined with snapshots, but otherwise valuations cannot be requested with other transaction types.Value-basedn/a

Units are not required and ignored if provided.
Yes
withdrawalDecreases cash units and doesn't affect performance.Cashn/aNo, negative values can be provided but are ignored and converted to positive.
write_optionFunctions like a "sell_short", but specifically for Options.Optionn/aNo
written_exercise_callThe 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 onlyn/aNo
written_exercise_putThe 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 onlyn/aNo, negative values can be provided but are ignored and converted to positive.
written_expirationEquivalent to a "transfer_in" valued at $0.Option, futures contract, forward contractn/aNo, negative values can be provided but are ignored and converted to positive.