Supported transaction types

Transaction types classify the financial event a transaction represents. The type determines which fields are required, which ownership types the transaction can target, and how the transaction affects performance, cost basis, and cash.

There is no Transaction Types API endpoint. This page is a reference for valid type values when creating transactions via the Transactions API.

How transaction types work

When you create a transaction, the type field controls:

  1. Which positions accept it. Each type specifies compatible ownership types (share-based, value-based, percent-based, cash). Posting a buy to a value-based asset fails validation.
  2. Which fields are required. Share-based types need units. Value-based types need amount. Some types require additional fields like other_units or distribution breakdowns.
  3. How it affects the portfolio. The type determines impact on units, cash, cost basis, performance, and unfunded commitments.
  4. Negative value behavior. Some types silently convert negatives to positives. Others reject them. A few support true negative values.

Core transaction types

These types represent the most common operations across integrations.

TypeDescriptionCompatible withNegative values
buyIncreases units, decreases cash. Opens a tax lot.Share-based (except cash)Converted to positive
sellDecreases units, increases cash. Closes tax lots (FIFO).Share-based (except cash)Not supported
contributionIncreases adjusted value, decreases cash and unfunded commitment. Supports breakdown fields (contribution_investment, contribution_management_fee, contribution_expense, contribution_generic) and optional behavioral flags (affects_cost_basis, affects_unfunded_commitment).Value-basedConverted to positive
distributionDecreases adjusted value, increases cash. Requires breakdown fields (generic, return_of_capital, long_term, short_term, interest, ordinary, dividend, recallable).All except cashSupported
depositIncreases cash units. No performance impact.CashConverted to positive
withdrawalDecreases cash units. No performance impact.CashConverted to positive
transferMoves value between entities. Requires new_owner relationship.AllConverted to positive
transfer_inIncreases shares/cash/value from an external source.AllConverted to positive
transfer_outDecreases shares/cash/value to an external destination.AllConverted to positive
snapshotMarks ownership and value at a point in time. Cannot combine with other types except valuation.Share-basedSupported
valuationUpdates the value of a position. Cannot combine with other types except snapshot.Value-basedSupported

Fee and expense types

TypeDescriptionCompatible withNegative values
feeDecreases security performance and cash.All except cashConverted to positive
fee_reimbursementReturns a portion of a previously charged fee.All except cashConverted to positive
expenseDecreases security performance and cash. Does not affect cost basis by default.Share-based, value-based, percent-based, cashIn-app error
expense_allocatedAllocated expense for managed funds.Managed fundsIn-app error
account_feeFee charged at account level. Affects account performance, not security performance. Owned = account, owner relationship removed.All except cashConverted to positive
account_fee_advisorAdvisor fee. Identical behavior to account_fee.All except cashConverted to positive
account_fee_bankBank fee. Identical to account_fee.All except cashConverted to positive
account_fee_custodianCustodian fee. Identical to account_fee.All except cashConverted to positive
account_fee_managementManagement fee. Identical to account_fee.All except cashConverted to positive
account_fee_professionalProfessional services fee. Identical to account_fee.All except cashConverted to positive
account_fee_reimbursementReimbursement for an account-level fee.All except cashConverted to positive
account_fee_reimbursement_advisorRefund of advisor fee.All except cashConverted to positive
account_fee_reimbursement_bankRefund of bank fee.All except cashConverted to positive
account_fee_reimbursement_custodianRefund of custodian fee.All except cashConverted to positive
account_fee_reimbursement_managementRefund of management fee.All except cashConverted to positive
account_fee_reimbursement_professionalRefund of professional fee.All except cashConverted to positive
taxDecreases security performance and cash.All except cashConverted to positive
tax_refundIncreases performance (by decreasing expense) and cash.All except cashConverted to positive

Income types

TypeDescriptionCompatible withNegative values
incomeIncreases security performance and cash.AllIn-app error
income_allocatedAllocated income for managed funds.Managed fundsIn-app error
interest_incomeIncreases security performance and cash.AllConverted to positive
interest_expenseDecreases security performance and cash.AllConverted to positive
cash_dividendIncreases performance via income, increases cash. Requires dividend attribute. ex_date recommended for accrued income.All except cashPositive only
stock_dividendPayment of stock (units increase).Share-basedIn-app error
payment_received_in_lieu_of_dividendIncreases performance and cash.Share-based (except cash)Converted to positive
payment_made_in_lieu_of_dividendDecreases performance and cash.Share-based (except cash)Converted to positive

Corporate action types

These types require other_units (shares removed) and new_owned relationship (asset received).

TypeDescriptionCompatible withNegative values
conversionConverts shares of one security into another. units = received, other_units = removed.Share-basedUse units/other_units instead
corporate_actionGeneric corporate action with share exchange.Share-basedUse units/other_units instead
spinoffNew company created from parent.Share-basedUse units/other_units instead
stock_splitIncreases shares without changing market cap. Prorated across tax lots.Share-basedIn-app error
stock_reverse_splitDecreases shares. Tax lot units decreased on prorated basis.Share-basedIn-app error
cash_in_lieuRemoves fractional shares, increases cash (like a sell). amount = cash received, units = shares not received.Share-based (except cash)Converted to positive

Value-based types

TypeDescriptionCompatible withNegative values
capital_callDemand for fund commitment from limited partner.Managed fundsConverted to positive
commitmentIncreases total commitment. No cash or performance effect.Value-basedConverted to positive
commitment_reductionDecreases total commitment. No cash or performance effect.Value-basedConverted to positive
recalled_contributionReverses a contribution. Decreases adjusted value, increases cash and unfunded commitment. Supports breakdown fields (contribution_investment, contribution_management_fee, contribution_expense, contribution_generic) and optional behavioral flags (affects_cost_basis, affects_unfunded_commitment).Value-basedConverted to positive
change_in_unrealized_gainAdjusts value without affecting cash flow.Value-basedSupported
cost_adjustmentAdjusts cost basis without affecting value or adjusted value.Value-basedSupported
generic_flowAdjusts value without performance effect.Value-basedSupported
unfunded_adjustmentAdjusts unfunded commitment. No cash or performance effect.Value-basedSupported
fund_redemptionIdentical to distribution.Value-basedSupported
gainAllocates fund gains/losses to limited partners.Managed fundsSupported

Short selling and options

TypeDescriptionCompatible withNegative values
sell_shortLike a sell, but resulting position has negative units and value.Share-based (except cash)Not supported
cover_shortIdentical to buy. Closes short position.Share-based (except cash)Converted to positive
write_optionLike sell_short, for options.OptionNot supported
exercise_callExercise right to buy underlying security.DerivativesConverted to positive
exercise_putExercise right to sell underlying security.DerivativesNot supported
written_exercise_callCounterparty exercises call against your client.DerivativesNot supported
written_exercise_putCounterparty exercises put against your client.DerivativesConverted to positive
expirationEquivalent to transfer_out at $0 value.Option, warrant, futures, forwardConverted to positive
written_expirationEquivalent to transfer_in at $0 value.Option, futures, forwardConverted to positive
mark_to_marketAdjusts performance and cash. Positive = cash increase.Futures, forwardSupported

Other types

TypeDescriptionCompatible withNegative values
adjustmentCreates gain/loss on cash directly. Otherwise like buy/sell at $0.Share-basedSupported
reinvestmentIdentical to buy.Share-based (except cash)Converted to positive
redemptionIdentical to sell. Fixed income only.Preferred stock, CMO, bond, CDNot supported
proceeds_adjustmentIncreases sell proceeds or decreases buy proceeds, increasing cash.Share-based (except cash)Supported
journal_inIdentical to deposit.CashConverted to positive
journal_outIdentical to withdrawal.CashConverted to positive
tax_withholdingIdentical to withdrawal.CashConverted to positive
tax_withholding_refundIdentical to deposit.CashConverted to positive
loan_issuedRecords amount issued by lender.LoansNot supported
loan_takenRecords amount borrowed.LoansNot supported
inceptionCreates a percent-based position. amount ignored.Percent-basedSupported
lookthrough_adjustmentAdjusts percent ownership. units = percent change. amount ignored.Managed fundsSupported

Account fee relationship rules

For all account_fee* types, the relationship structure differs from standard transactions:

  • owned should reference the account entity (the entity being charged)
  • The owner relationship should be omitted (removed from the request body)
  • units are not required and ignored if provided
  • If the cash position is unknown, pass null for the owner ID and omit cash_position

📘

Related


Did this page help you?