# Transactions

Transactions represent financial events on accounts. Each transaction
debits or credits an account in a specific currency on a value date.

After posting a transaction, computed holdings reflect the change
near-instantly in most cases, with up to a few minutes of delay for
heavier portfolios.

Some transaction types are auto-created by the system and cannot be
POSTed directly:
  loan-transaction
  fx-forward-cash-settlement-transaction
  fx-forward-physical-delivery-transaction

## Endpoints

GET /v2/transactions
  List transactions for an account, depository, or instrument within
  a date range.
  Query params:
    accountId     (optional) — Account identifier
    depositoryId  (optional) — Depository identifier
    instrumentId  (optional) — Instrument identifier (filters to transactions involving the instrument)
    fromDate      (required) — First day in the period (inclusive, ISO 8601 date)
    toDate        (required) — Last day in the period (inclusive, ISO 8601 date)
  At least one of accountId / depositoryId / instrumentId must be supplied.

POST /v2/transactions
  Create a new transaction. Polymorphic — specify --type for the full schema.

DELETE /v2/transactions/:id
  Delete a specific transaction. For cash-transfer transactions with a
  counterparty, only the specified transaction is removed; the
  counterparty record is updated to drop the link.

## Common Attributes (most types)

  accountAmount (number, required) — Amount deposited/withdrawn, in account currency
  tradeDate     (string, required) — ISO 8601 trade date (end-of-day)
  valueDate     (string, required) — ISO 8601 value date (end-of-day)
  comment       (string, optional) — Brief note about the transaction

Several types add type-specific attributes (units, unitPrice,
commission, accruedInterest, grossAmount, etc.). Use the per-type
spec page to see them.

## Common Relationships

  account     — The bank account affected by the transaction.
  instrument  — The instrument the transaction trades or services (where applicable).
  depository  — The depository the instrument is held in (where applicable).

## Types (use `aleta api --spec POST /v2/transactions --type <type>`)

  account-interest-transaction
  bond-coupon-transaction
  bond-redemption-transaction
  bond-trade-transaction
  cash-transfer-transaction
  dividend-transaction
  equity-trade-transaction
  fee-transaction
  futures-trade-transaction
  futures-execution-transaction
  fx-spot-transaction
  index-linked-bond-coupon-transaction
  index-linked-bond-redemption-transaction
  index-linked-bond-trade-transaction
  private-market-fund-distribution-transaction
  private-market-fund-drawdown-transaction
  refund-transaction
  zero-coupon-bond-trade-transaction

## Auto-created types (returned by GET, cannot be POSTed)

  loan-transaction
  fx-forward-cash-settlement-transaction
  fx-forward-physical-delivery-transaction