Models

TransactionStore

object

error_if_duplicate_hashboolean

Break if the submitted transaction exists already.

Example

false

apply_rulesboolean

Whether or not to apply rules when submitting transaction.

Example

false

fire_webhooksbooleantrue

Whether or not to fire the webhooks that are related to this event.

Example

true

group_titlestring | null

Title of the transaction if it has been split in more than one piece. Empty otherwise.

Example

Split transaction title.

transactionsArray<TransactionSplitStore>required

Show child attributes

typeTransactionTypePropertywithdrawaldeposittransferreconciliationopening balancerequired

Example

withdrawal

datestring<date-time>required

Date of the transaction

Example

2026-10-01T00:00:00+00:00

amountstring<amount>required

Amount of the transaction.

Example

123.45

descriptionstringrequired

Description of the transaction.

Example

Vegetables

orderinteger<int32> | null

Order of this entry in the list of transactions.

Example

currency_idstring | null

Currency ID. Default is the source account's currency, or the user's financial administration's currency. The value you submit may be overruled by the source or destination account.

Example

currency_codestring | null

Currency code. Default is the source account's currency, or the user's financial administration's primary currency. The value you submit may be overruled by the source or destination account.

Example

EUR

foreign_amountstring<amount> | null

The amount in a foreign currency.

Example

123.45

foreign_currency_idstring | null

Currency ID of the foreign currency. Default is null. Is required when you submit a foreign amount.

Example

foreign_currency_codestring | null

Currency code of the foreign currency. Default is NULL. Can be used instead of the foreign_currency_id, but this or the ID is required when submitting a foreign amount.

Example

USD

budget_idstring | null

The budget ID for this transaction.

Example

budget_namestring | null

The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored.

Example

Groceries

category_idstring | null

The category ID for this transaction.

Example

category_namestring | null

The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name.

Example

Groceries

source_idstring | null

ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account.

Example

source_namestring | null

Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name.

Example

Checking account

destination_idstring | null

ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account.

Example

destination_namestring | null

Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough.

Example

Buy and Large

reconciledboolean

If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user.

Example

false

piggy_bank_idinteger<int32> | nullwrite only

Optional. Use either this or the piggy_bank_name

piggy_bank_namestring | nullwrite only

Optional. Use either this or the piggy_bank_id

bill_idstring | null

Optional. Use either this or the bill_name

Example

bill_namestring | null

Optional. Use either this or the bill_id

Example

Monthly rent

tagsArray<string> | null

Array of tags.

Example

null

notesstring | null

Example

Some example notes

internal_referencestring | null

Reference to internal reference of other systems.

external_idstring | null

Reference to external ID in other systems.

external_urlstring | null

External, custom URL for this transaction.

sepa_ccstring | null

SEPA Clearing Code

sepa_ct_opstring | null

SEPA Opposing Account Identifier

sepa_ct_idstring | null

SEPA end-to-end Identifier

sepa_dbstring | null

SEPA mandate identifier

sepa_countrystring | null

SEPA Country

sepa_epstring | null

SEPA External Purpose indicator

sepa_cistring | null

SEPA Creditor Identifier

sepa_batch_idstring | null

SEPA Batch ID

interest_datestring<date-time> | null

book_datestring<date-time> | null

process_datestring<date-time> | null

due_datestring<date-time> | null

payment_datestring<date-time> | null

invoice_datestring<date-time> | null

Example

{
  "error_if_duplicate_hash": false,
  "apply_rules": false,
  "fire_webhooks": true,
  "group_title": "Split transaction title.",
  "transactions": [
    {
      "type": "withdrawal",
      "date": "2026-10-01T00:00:00+00:00",
      "amount": "123.45",
      "description": "Vegetables",
      "order": 0,
      "currency_id": "12",
      "currency_code": "EUR",
      "foreign_amount": "123.45",
      "foreign_currency_id": "17",
      "foreign_currency_code": "USD",
      "budget_id": "4",
      "budget_name": "Groceries",
      "category_id": "43",
      "category_name": "Groceries",
      "source_id": "2",
      "source_name": "Checking account",
      "destination_id": "2",
      "destination_name": "Buy and Large",
      "reconciled": false,
      "piggy_bank_id": 0,
      "piggy_bank_name": "string",
      "bill_id": "112",
      "bill_name": "Monthly rent",
      "tags": null,
      "notes": "Some example notes",
      "internal_reference": "string",
      "external_id": "string",
      "external_url": "string",
      "sepa_cc": "string",
      "sepa_ct_op": "string",
      "sepa_ct_id": "string",
      "sepa_db": "string",
      "sepa_country": "string",
      "sepa_ep": "string",
      "sepa_ci": "string",
      "sepa_batch_id": "string",
      "interest_date": "2024-01-15T09:30:00Z",
      "book_date": "2024-01-15T09:30:00Z",
      "process_date": "2024-01-15T09:30:00Z",
      "due_date": "2024-01-15T09:30:00Z",
      "payment_date": "2024-01-15T09:30:00Z",
      "invoice_date": "2024-01-15T09:30:00Z"
    }
  ]
}