Transactions

Data model

Account Interest Transaction

accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
commentstring: A brief text note or explanation related to the transaction.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date (end-of-day).
valueDatestringRequired: ISO 8601 representation of the transaction's value date (end-of-day).

Relationships

account: Account represents the bank account affected by the transaction.

Bond Coupon Transaction

accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
commentstring: A brief text note or explanation related to the transaction.
grossAmountnumberRequired: Total coupon amount. Denominated in instrument currency.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date (end-of-day).
valueDatestringRequired: ISO 8601 representation of the transaction's value date (end-of-day).

Relationships

account: Account represents the bank account affected by the transaction.
instrument: Instrument represents the instrument affected by the transaction.
depository: Depository represents the depository the instrument is held in.

Bond Redemption Transaction

accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
commentstring: A brief text note or explanation related to the transaction.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date (end-of-day).
unitPricenumberRequired: Price per instrument unit.
unitsnumberRequired: Number of units redeemed.
valueDatestringRequired: ISO 8601 representation of the transaction's value date (end-of-day).

Relationships

account: Account represents the bank account affected by the transaction.
instrument: Instrument represents the instrument affected by the transaction.
depository: Depository represents the depository affected by the transaction.

Bond Trade Transaction

accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
accruedInterestnumberRequired: Interest accumulated on the bond from the latest repayment date to the transaction date. Denominated in instrument currency.
commissionnumberRequired: Commission charged by the bank or custodian. Denominated in account currency. A positive number means commission paid.
commentstring: A brief text note or explanation related to the transaction.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date (end-of-day).
unitPricenumberRequired: Price per instrument unit.
unitsnumberRequired: Number of units bought or sold.
valueDatestringRequired: ISO 8601 representation of the transaction's value date (end-of-day).

Relationships

account: Account represents the bank account affected by the transaction.
instrument: Instrument represents the instrument affected by the transaction.
depository: Depository represents the depository affected by the transaction.

Cash Transfer Transaction

The cash transfer transaction type can be used for both external cash transfers to an outside account and internal cash transfers between accounts. This is done by assigning the counterparty-transaction relationships object with the ID of the related counterparty transaction. See example.

accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
commentstring: A brief text note or explanation related to the transaction.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date (end-of-day).
valueDatestringRequired: ISO 8601 representation of the transaction's value date (end-of-day).

Relationships

account: Account represents the bank account affected by the transaction.
counterparty-transaction: Counterparty transaction is the linked transaction associated with the transaction being displayed.

Dividend Transaction

accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
commentstring: A brief text note or explanation related to the transaction.
commissionnumber: Commission charged by the bank or custodian. Denominated in account currency. A positive number means commission paid. Defaults to zero if not specified.
grossAmountnumberRequired: Total dividend amount before any deductions. Denominated in instrument currency.
taxnumberRequired: Tax charged as part of the transaction. Denominated in instrument currency.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date (end-of-day).
valueDatestringRequired: ISO 8601 representation of the transaction's value date (end-of-day).

Relationships

account: Account represents the bank account affected by the transaction.
instrument: Instrument represents the instrument affected by the transaction.
depository: Depository represents the depository the instrument is held in.

Equity Trade Transaction

accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
commissionnumberRequired: Commission charged by the bank or custodian. Denominated in account currency. A positive number means commission paid.
commentstring: A brief text note or explanation related to the transaction.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date (end-of-day).
unitPricenumberRequired: Price per instrument unit.
unitsnumberRequired: Number of units bought or sold.
valueDatestringRequired: ISO 8601 representation of the transaction's value date (end-of-day).

Relationships

account: Account represents the bank account affected by the transaction.
instrument: Instrument represents the instrument affected by the transaction.
depository: Depository represents the depository affected by the transaction.

Fee Transaction

accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
commentstring: A brief text note or explanation related to the transaction.
categorystring: Type of fee. Possible values: "custody", "management", "other". Default is "other".
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date (end-of-day).
valueDatestringRequired: ISO 8601 representation of the transaction's value date (end-of-day).

Relationships

account: Account represents the bank account affected by the transaction.

Futures Trade Transaction

accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
commissionnumberRequired: Commission charged by the bank or custodian. Denominated in account currency. A positive number means commission paid.
commentstring: A brief text note or explanation related to the transaction.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date (end-of-day).
unitPricenumberRequired: Price per instrument unit.
unitsnumberRequired: Number of units bought or sold.
valueDatestringRequired: ISO 8601 representation of the transaction's value date (end-of-day).

Relationships

account: Account represents the bank account affected by the transaction.
instrument: Instrument represents the instrument affected by the transaction.
depository: Depository represents the depository affected by the transaction.

Futures Execution Transaction

accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
commissionnumberRequired: Commission charged by the bank or custodian. Denominated in account currency. A positive number means commission paid.
commentstring: A brief text note or explanation related to the transaction.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date (end-of-day).
unitPricenumberRequired: Price per instrument unit.
unitsnumberRequired: Number of units bought or sold.
valueDatestringRequired: ISO 8601 representation of the transaction's value date (end-of-day).

Relationships

account: Account represents the bank account affected by the transaction.
instrument: Instrument represents the instrument affected by the transaction.
openingTransaction: Opening transaction is the futures trade transaction associated with the transaction being displayed.
depository: Depository represents the depository affected by the transaction.

FX Forward Cash Settlement Transaction

accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date (end-of-day).
valueDatestringRequired: ISO 8601 representation of the transaction's value date (end-of-day).

Relationships

account: Account represents the bank account affected by the transaction.
fxForward: The FX Forward agreement that is being settled.

FX Forward Physical Delivery Transaction

primaryAccountAmountnumberRequired: Amount deposited or withdrawn from the related account primaryAccount. Denominated in the currency of the primary account.
secondaryAccountAmountnumberRequired: Amount deposited or withdrawn from the related account secondaryAccount. Denominated in the currency of the secondary account.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date.
valueDatestringRequired: ISO 8601 representation of the transaction's value date.

Relationships

primaryAccount: Represents the bank account affected by the primary currency of the FX pair.
secondaryAccount: Represents the bank account affected by the secondary currency of the FX pair.
fxForward: The FX Forward agreement that is being settled.

FX Spot Transaction

commentstring: A brief text note or explanation related to the transaction.
inflowAccountAmountnumberRequired: Amount deposited to the related account inflowAccount. The amount must be positive and is denominated in the currency of the inflow account.
outflowAccountAmountnumberRequired: Amount withdrawn from the related account outflowAccount. The amount must be negative and is denominated in the currency of the outflow account.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date.
valueDatestringRequired: ISO 8601 representation of the transaction's value date.

Relationships

inflowAccount: Account to which the inflow currency of the FX pair is deposited.
outflowAccount: Account from which the outflow currency of the FX pair is withdrawn.

Index-Linked Bond Coupon Transaction

accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
commentstring: A brief text note or explanation related to the transaction.
grossAmountnumberRequired: Total coupon amount. Denominated in instrument currency.
indexFactornumberRequired: The index factor to use for the transaction.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date (end-of-day).
valueDatestringRequired: ISO 8601 representation of the transaction's value date (end-of-day).

Relationships

account: Account represents the bank account affected by the transaction.
instrument: Instrument represents the instrument affected by the transaction.
depository: Depository represents the depository the instrument is held in.

Index-Linked Bond Redemption Transaction

accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
commentstring: A brief text note or explanation related to the transaction.
indexFactornumberRequired: The index factor to use for the transaction.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date (end-of-day).
unitPricenumberRequired: Price per instrument unit.
unitsnumberRequired: Number of units redeemed.
valueDatestringRequired: ISO 8601 representation of the transaction's value date (end-of-day).

Relationships

account: Account represents the bank account affected by the transaction.
instrument: Instrument represents the instrument affected by the transaction.
depository: Depository represents the depository affected by the transaction.

Index-Linked Bond Trade Transaction

accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
accruedInterestnumberRequired: Interest accumulated on the bond from the latest repayment date to the transaction date. Denominated in instrument currency.
commissionnumberRequired: Commission charged by the bank or custodian. Denominated in account currency. A positive number means commission paid.
commentstring: A brief text note or explanation related to the transaction.
indexFactornumber: The index factor to use for the transaction.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date (end-of-day).
unitPricenumberRequired: Price per instrument unit.
unitsnumberRequired: Number of units bought or sold.
valueDatestringRequired: ISO 8601 representation of the transaction's value date (end-of-day).

Relationships

account: Account represents the bank account affected by the transaction.
instrument: Instrument represents the instrument affected by the transaction.
depository: Depository represents the depository affected by the transaction.

Loan Transaction

accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
interestnumber: Interest amount related to the loan. Denominated in account currency.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date.
valueDatestringRequired: ISO 8601 representation of the transaction's value date.

Relationships

account: Account represents the bank account affected by the transaction.
loan: The loan instrument that the transaction belongs to.

Other Transaction

A transaction whose kind has none of the types above (for example a correction) is returned with type other-transaction.

accountAmountnumber: Amount deposited or withdrawn from the account. Denominated in account currency.
commentstring: A brief text note or explanation related to the transaction. null when not set.
tradeDatestring: The transaction's trade date (yyyy-MM-dd).
valueDatestring: The transaction's value date (yyyy-MM-dd).
assetstring: ID of the instrument the transaction relates to, or null.

Relationships

account: Account represents the bank account affected by the transaction.
instrument: Instrument represents the instrument affected by the transaction, when there is one.
depository: Depository represents the depository affected by the transaction, when there is one.

Private Market Fund Distribution Transaction

categorystringRequired: Type of distribution transaction. Possible values: "distribution", "capital-gain", "dividend", "return-of-capital", "carried-interest", "withholding-tax", "redemption", "management-fee-rebate", "other-fee-rebate", "reallocation-premium", "rebalancing-adjustment", "reimbursement".
amountnumberRequired: The distributed amount from the fund. Denominated in the fund's currency. The distributed amount should be a negative value, with accountAmount positive (a positive value reverses a distribution).
recallableAmountnumberRequired: The part of the amount that is recallable. Use 0 for a non-recallable distribution. Use the amount value for a fully recallable distribution. Or use a number between 0 and amount for a partially recallable distribution.
affectsEstimatedNavboolRequired: Whether this transaction should impact the instrument’s estimated NAV at the transaction date. Set to true to include or false to exclude.
affectsMultiplesboolRequired: Whether this cash flow is included in private‑markets multiples calculations (e.g., TVPI, DPI, RVPI). Set to true to include or false to exclude. Recommended value is true for most transactions.
affectsIrrboolRequired: Whether this cash flow is included in IRR calculations. Set to true to include or false to exclude. Recommended value is true for most transactions.
affectsCostBaseboolRequired: Whether this transaction adjusts the investor’s cost basis. Set to true to adjust cost basis (e.g., capital calls or certain fees) or false if it should not affect cost basis. Recommended value is true for most transactions.
accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
commentstring: A brief text note or explanation related to the transaction.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date (end-of-day).
valueDatestringRequired: ISO 8601 representation of the transaction's value date (end-of-day).

Relationships

account: Account represents the bank account affected by the transaction.
instrument: Instrument represents the fund affected by the transaction.

Private Market Fund Drawdown Transaction

categorystringRequired: Type of drawdown transaction. Possible values: "capital-call", "management-fee", "interest-received", "other-fee".
amountnumberRequired: The called amount from the fund. Denominated in the fund's currency. The drawdown amount should have postive sign (negative values are allowed for corrections).
effectOnUnfundedCommitmentnumberRequired: Signed change to the remaining unfunded commitment caused by this drawdown. Use a negative value to reduce the unfunded commitment (typical for capital calls), a positive value to increase it (e.g., corrections), or "0" for no change.
affectsEstimatedNavboolRequired: Whether this transaction should impact the instrument’s estimated NAV at the transaction date. Set to true to include or false to exclude. Recommended value is true for most transactions.
affectsMultiplesboolRequired: Whether this cash flow is included in private‑markets multiples calculations (e.g., TVPI, DPI, RVPI). Set to true to include or false to exclude. Recommended value is true for most transactions.
affectsIrrboolRequired: Whether this cash flow is included in IRR calculations. Set to true to include or false to exclude. Recommended value is true for most transactions.
affectsCostBaseboolRequired: Whether this transaction adjusts the investor’s cost basis. Set to true to adjust cost basis (e.g., capital calls or certain fees) or false if it should not affect cost basis. Recommended value is true for most transactions.
accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
commentstring: A brief text note or explanation related to the transaction.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date (end-of-day).
valueDatestringRequired: ISO 8601 representation of the transaction's value date (end-of-day).

Relationships

account: Account represents the bank account affected by the transaction.
instrument: Instrument represents the fund affected by the transaction.

Refund Transaction

accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
commentstring: A brief text note or explanation related to the transaction.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date (end-of-day).
valueDatestringRequired: ISO 8601 representation of the transaction's value date (end-of-day).

Relationships

account: Account represents the bank account affected by the transaction.

Zero Coupon Bond Trade Transaction

accountAmountnumberRequired: Amount deposited or withdrawn from the account. Denominated in account currency.
commissionnumberRequired: Commission charged by the bank or custodian. Denominated in account currency. A positive number means commission paid.
commentstring: A brief text note or explanation related to the transaction.
tradeDatestringRequired: ISO 8601 representation of the transaction's trade date (end-of-day).
unitPricenumberRequired: Price per instrument unit.
unitsnumberRequired: Number of units bought or sold.
valueDatestringRequired: ISO 8601 representation of the transaction's value date (end-of-day).

Relationships

account: Account represents the bank account affected by the transaction.
instrument: Instrument represents the instrument affected by the transaction.
depository: Depository represents the depository affected by the transaction.

GET/api/v3/transactions

List transactions

Fetch all transactions within a specified period. At least one of accountId, depositoryId, or instrumentId must be specified.

Query parameters

accountIdquery: Account identifier. Can be repeated to include several accounts.
depositoryIdquery: Depository identifier. Can be repeated to include several depositories.
instrumentIdquery: Instrument identifier (24 hexadecimal characters). Filters transactions to those involving the given instrument. An unknown instrument answers 404.
fromDatequeryRequired: First day in the time period (yyyy-MM-dd).
toDatequeryRequired: Last day in the time period (yyyy-MM-dd).

Request

GET/api/v3/transactions

curl -G https://api.aleta.ai/api/v3/transactions \
  -H "Accept: application/vnd.api+json" \
  -H "Authorization: Bearer {access_token}" \
  -d accountId=6698ffbdda04cf5d2d55a265 \
  -d fromDate=2024-07-01 \
  -d toDate=2024-07-01

Response: 200 OK

{
  "data": [
    {
      "id": "66990014c5dc848e8f97c1bb",
      "type": "account-interest-transaction",
      "attributes": {
        "accountAmount": 1594.87,
        "comment": "Account Interest Q2",
        "tradeDate": "2024-07-01",
        "valueDate": "2024-07-01"
      },
      "relationships": {
        "account": {
          "data": {
            "type": "account",
            "id": "6698ffbdda04cf5d2d55a265"
          }
        }
      }
    }
  ]
}

POST/api/v3/transactions

Create a transaction

Create a new transaction for an account. The created transaction is returned with status 201.

The accepted type values are account-interest-transaction, bond-coupon-transaction, bond-redemption-transaction, bond-trade-transaction, cash-transfer-transaction, dividend-transaction, equity-trade-transaction, fee-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 and zero-coupon-bond-trade-transaction. Other types are not accepted.

tradeDate and valueDate must use the format yyyy-MM-dd, and amounts must be JSON numbers; otherwise the request answers 400 with Cannot parse request body.

Internal cash transfer

For an internal cash transfer, you will need to create each leg of the transaction separately.

For the first leg, create a transaction in the same way as an external cash transfer (the External Cash Transfer example).
For the second leg, include the counterparty-transaction object in the relationships section and set it to the ID of the transaction created as the first leg.

When you send the POST request for the second leg, the transaction referenced in the counterparty-transaction will be automatically updated, and a counterparty-transaction object will also be added to that initial transaction.

The second leg must have the same tradeDate and valueDate and the same account currency as the first leg, and the two accountAmount values must offset each other to within 0.005. Otherwise the request answers 400.

Private market fund transactions

For private-market-fund-drawdown-transaction and private-market-fund-distribution-transaction, the instrument must be a private market fund. accountAmount must equal amount with the opposite sign: no exchange rate is applied between the two. The fund must belong to the account's portfolio, and tradeDate must not be before the fund's entry date. Otherwise the request answers 400 with the reason, for example Contract with ID '{id}' not found. when the instrument is not a private market fund.

Request

POST/api/v3/transactions

curl -X POST https://api.aleta.ai/api/v3/transactions \
  -H "Accept: application/vnd.api+json" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/vnd.api+json" \
  -d '{
    "data": {
      "type": "bond-coupon-transaction",
      "attributes": {
        "accountAmount": 7500.00,
        "comment": "Bond Coupon",
        "grossAmount": 7500.00,
        "tradeDate": "2024-07-01",
        "valueDate": "2024-07-01"
      },
      "relationships": {
        "account": {
          "data": {
            "type": "account",
            "id": "6698ffbdda04cf5d2d55a265"
          }
        },
        "instrument": {
          "data": {
            "type": "instrument",
            "id": "b5afc699f5e3a15556d2a00c"
          }
        },
        "depository": {
          "data": {
            "type": "depository",
            "id": "6698ffae47a5a2c8b2554ee8"
          }
        }
      }
    }
  }'

Response: 201 Created

{
  "data": {
    "id": "66990014c5dc848e8f97c1bb",
    "type": "bond-coupon-transaction",
    "attributes": {
      "accountAmount": 7500.00,
      "comment": "Bond Coupon",
      "grossAmount": 7500.00,
      "tradeDate": "2024-07-01",
      "valueDate": "2024-07-01"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "6698ffbdda04cf5d2d55a265"
        }
      },
      "instrument": {
        "data": {
          "type": "instrument",
          "id": "b5afc699f5e3a15556d2a00c"
        }
      },
      "depository": {
        "data": {
          "type": "depository",
          "id": "6698ffae47a5a2c8b2554ee8"
        }
      }
    }
  }
}