Sign in
Ledgers

Get Financial Report Breakdown

Returns the top entities behind one high-level financial report bucket and an aggregate remainder.

get/financial_reports/breakdown

Query parameters

account_idstring required

The owning account ID (a biz_ identifier).

bucket'transfers' | 'payments' | 'card_spend' | 'withdrawals' | 'swaps' required

The high-level report bucket to explain.

direction'money_in' | 'money_out' required

Whether to explain money received or money sent.

currencystring required

The report currency to explain.

from_datestring required

Start of the report window as an ISO 8601 timestamp.

to_datestring required

Exclusive end of the report window as an ISO 8601 timestamp.

Headers

Api-Version-Datestring
Example:2026-08-25-2

Pins the request to a dated API version.

Response

breakdown returned

bucket'transfers' | 'payments' | 'card_spend' | 'withdrawals' | 'swaps' required
currencystring required
direction'money_in' | 'money_out' required

Example response

{
  "activity_filters": {
    "direction": "money_out",
    "line_types": [
      "platform_balance_transfer_outgoing"
    ]
  },
  "bucket": "transfers",
  "currency": "usd",
  "direction": "money_out",
  "items": [
    {
      "amount": {
        "amount": "-2.50",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "object": "user"
    }
  ],
  "other_amount": {
    "amount": "-2.50",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  }
}

Changes

Changed in 1 of the 41 revisions of this API.1