Skip to main content
GET
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
bank_statement_summary
Get EndUser bank statement summary
curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/bank_statement_summary \
  --header 'x-api-key: <api-key>'
{
  "grouping": "<string>",
  "average": {
    "average_balance": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "average_balance_to_revenue_ratio": 123,
    "dd_reversals": 123,
    "ending_balance": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "holdback_percentage": 123,
    "low_balance_days": 123,
    "mca_credits": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "mca_debits": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "negative_balance_days": 123,
    "no_deposits": 123,
    "no_od_nsf": 123,
    "no_overdraft_transactions": 123,
    "no_revenue": 123,
    "no_withdrawals": 123,
    "non_revenue": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "starting_balance": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "total_deposits": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "total_revenue": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "total_withdrawals": {
      "amount": "1234.56",
      "currency": "USD"
    }
  },
  "by_data_source_account_heron_id": {},
  "by_month": {},
  "by_month_by_data_source_account_heron_id": {},
  "rolling_30_days_from_last_txn": {},
  "rolling_30_days_from_today": {},
  "total": {
    "average_balance": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "average_balance_to_revenue_ratio": 123,
    "dd_reversals": 123,
    "ending_balance": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "holdback_percentage": 123,
    "low_balance_days": 123,
    "mca_credits": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "mca_debits": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "negative_balance_days": 123,
    "no_deposits": 123,
    "no_od_nsf": 123,
    "no_overdraft_transactions": 123,
    "no_revenue": 123,
    "no_withdrawals": 123,
    "non_revenue": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "starting_balance": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "total_deposits": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "total_revenue": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "total_withdrawals": {
      "amount": "1234.56",
      "currency": "USD"
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
end_user_id_or_heron_id
string
required

Query Parameters

​
num_full_calendar_months
integer | null

Number of full calendar months to show in the summary

Required range: x >= 1
​
grouping
enum<string>
default:by_month

Determines how to group transactions. It supports calendar month (by_month) or rolling 30-day period (from last txns with rolling_30_days_from_last_txn or from today with rolling_30_days_from_today)

Available options:
by_month,
by_data_source_account_heron_id,
rolling_30_days_from_last_txn,
rolling_30_days_from_today,
by_month_by_data_source_account_heron_id
​
account_ids
string[] | null

Account ids to include in the summary, if not provided, all accounts are included

Response

200 - application/json

OK

​
grouping
string
required

Describes how the report was grouped. It supports either by calendar month or rolling 30-day period

​
average
object
​
by_data_source_account_heron_id
object

Summary of bank statement by data source account. Keys are heron ids of the data source account

​
by_month
object

Summary of bank statement by month (only populated when grouping is calendar_month))

​
by_month_by_data_source_account_heron_id
object

Summary of bank statement by month and data source account. Keys are the start date of the month and heron ids of the data source account

​
rolling_30_days_from_last_txn
object

Summary of bank statement by rolling 30 days (only populated when grouping is rolling_30_days). Keys are the start date of the 30-day period using latest transaction date date as the end date

​
rolling_30_days_from_today
object

Summary of bank statement by rolling 30 days (only populated when grouping is rolling_30_days_from_today). Keys are the start date of the 30-day period using today as the end date

​
total
object