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' | 'refunds' | 'ads' | 'application_fees' | 'card_spend' | 'card_authorization_releases' | 'withdrawals' | 'withdrawal_markup' | 'platform_markup' | 'clawbacks' | 'disputes' | 'affiliate_earnings' | 'affiliate_payouts' | 'revenue_share' | 'swaps' | 'card_loads' 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.

fromstring date-time required

Start of the report window as an ISO 8601 timestamp.

tostring date-time required

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

group_by'hour' | 'day' | 'week' | 'month'

Period grouping used by the parent report.

timezonestring

IANA timezone used by the parent report to bucket periods. Defaults to UTC.

Headers

Api-Version-Datestring
Example:2026-09-25

Pins the request to a dated API version.

Response

breakdown returned

bucket'transfers' | 'payments' | 'refunds' | 'ads' | 'application_fees' | 'card_spend' | 'card_authorization_releases' | 'withdrawals' | 'withdrawal_markup' | 'platform_markup' | 'clawbacks' | 'disputes' | 'affiliate_earnings' | 'affiliate_payouts' | 'revenue_share' | 'swaps' | 'card_loads' required
currencystring required
direction'money_in' | 'money_out' required
other_namestring 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
      },
      "avatar": {
        "shape": "circle"
      },
      "object": "user"
    }
  ],
  "other_amount": {
    "amount": "-2.50",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "other_name": "Other"
}

Changes

Changed in 7 of the 74 revisions of this API.1129

  • ef86d14ef6911See the full diff
    • ○

      added the new enum value hour to the query request parameter group_by

      request-parameter-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 918ff9d965e16See the full diff
    • ●

      added the new affiliate_earnings enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new affiliate_payouts enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new clawbacks enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new disputes enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new platform_markup enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new revenue_share enum value to the response property for the response status

      response-property-enum-value-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2a25564a92d511See the full diff
    • ●

      added the new card_loads enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value card_loads to the query request parameter bucket

      request-parameter-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5fa504e7869511See the full diff
    • ●

      added the new withdrawal_markup enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value withdrawal_markup to the query request parameter bucket

      request-parameter-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 697924df40d122See the full diff
    • ●

      added the new application_fees enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new refunds enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value application_fees to the query request parameter bucket

      request-parameter-enum-value-added

    • ○

      added the new enum value refunds to the query request parameter bucket

      request-parameter-enum-value-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9b2baa68698c123See the full diff
    • ▲

      removed the enum value card_authorizations from the query request parameter bucket

      request-parameter-enum-value-removed

    • ●

      added the new ad_campaign enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new ads enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value ads to the query request parameter bucket

      request-parameter-enum-value-added

    • ○

      removed the card_authorizations enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

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

      response-required-property-added

  • 4da7133b2de71See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.