Sign in

v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
EndUserCalculations

Get EndUser bank statement summary

Get the bank statement summary by month for an end user

get/api/end_users/{end_user_id_or_heron_id}/bank_statement_summary

Path parameters

end_user_id_or_heron_idstring required

Query parameters

grouping'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'

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)

num_full_calendar_monthsinteger nullable

Number of full calendar months to show in the summary

account_idsstring[] nullable

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

[
  "1234"
]

Response

OK

by_data_source_account_heron_idobject

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

by_monthobject

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

by_month_by_data_source_account_heron_idobject

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

groupingstring required

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

rolling_30_days_from_last_txnobject

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_todayobject

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

Example response

{
  "average": {
    "average_balance": {
      "currency": "USD"
    },
    "business_day_average_balance": {
      "currency": "USD"
    },
    "ending_balance": {
      "currency": "USD"
    },
    "expected_mca_debits": {
      "currency": "USD"
    },
    "mca_credits": {
      "currency": "USD"
    },
    "mca_debits": {
      "currency": "USD"
    },
    "non_revenue": {
      "currency": "USD"
    },
    "starting_balance": {
      "currency": "USD"
    },
    "total_deposits": {
      "currency": "USD"
    },
    "total_revenue": {
      "currency": "USD"
    },
    "total_withdrawals": {
      "currency": "USD"
    }
  },
  "total": {
    "average_balance": {
      "currency": "USD"
    },
    "business_day_average_balance": {
      "currency": "USD"
    },
    "ending_balance": {
      "currency": "USD"
    },
    "expected_mca_debits": {
      "currency": "USD"
    },
    "mca_credits": {
      "currency": "USD"
    },
    "mca_debits": {
      "currency": "USD"
    },
    "non_revenue": {
      "currency": "USD"
    },
    "starting_balance": {
      "currency": "USD"
    },
    "total_deposits": {
      "currency": "USD"
    },
    "total_revenue": {
      "currency": "USD"
    },
    "total_withdrawals": {
      "currency": "USD"
    }
  }
}