transactions

List Transactions

Changed on
get/api/transactions

Request

Query parameters

account_idstring uuid nullable
account_idsstring[] nullable
category_idstring uuid nullable
category_idsstring[] nullable
payee_idstring uuid nullable
fromstring date nullable
tostring date nullable
bill_idstring uuid nullable

Filter by credit-card bill (issue #92); takes precedence over from/to

group_idstring uuid nullable

Filter to transactions split through this group; widens visibility for linked members

unbilled_onlyboolean

Cycle-math fallback only: exclude txs already linked to any bill (used for in-progress CC cycles)

statement_viewboolean

Filter credit-card statement-cycle transactions by purchase date, independent of accounting mode

qstring nullable
uncategorizedboolean
typestring nullable
statusstring nullable

Filter by transaction status (posted|pending)

pageinteger
limitinteger
include_opening_balanceboolean
include_running_balanceboolean

Fill running_balance per row (issue #1202): one non-credit-card account, from set, include_opening_balance, no other filter, default order; null otherwise

exclude_transfersboolean
user_pnl_onlyboolean

Return only rows that count toward dashboard/user income/expense totals

exclude_ignoredboolean

Drop rows the user marked ignored, or whose category is ignored

tagsstring[] nullable
min_amountnumber nullable

Filter to transactions with absolute amount >= this value (primary currency).

max_amountnumber nullable

Filter to transactions with absolute amount <= this value (primary currency).

sort_bystring nullable

Column to sort by (date|amount|description|payee|category|account|type|status). Default: date desc.

sort_dirstring

Headers

X-Workspace-Idstring nullable

Response

Successful Response

totalinteger required
pageinteger required
limitinteger required

Changes

    • info

      added the new optional query request parameter exclude_ignored

    • info

      added the new optional query request parameter include_running_balance

    • info

      added the new optional query request parameter statement_view

    • info

      added the new optional query request parameter status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the // response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was removed for the status

    • info

      the /// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was removed for the status

    • info

      the //// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was removed for the status

    • info

      the ///// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was removed for the status

    • info

      the /// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was removed for the status