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

import requests

url = "https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/bank_statement_summary"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/bank_statement_summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/bank_statement_summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/bank_statement_summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/bank_statement_summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "grouping": "<string>",
  "all_transactions_summary": {
    "grouping": "<string>",
    "average": {
      "actual_holdback_percentage": 123,
      "additional_no_od": 123,
      "average_balance": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "average_balance_to_revenue_ratio": 123,
      "business_day_average_balance": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "dd_reversals": 123,
      "ending_balance": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "expected_mca_debits": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "holdback_percentage": 123,
      "is_mtd": true,
      "is_unreconcilable": true,
      "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_mca_credits": 123,
      "no_mca_debits": 123,
      "no_nsf": 123,
      "no_od": 123,
      "no_od_nsf": 123,
      "no_overdraft_transactions": 123,
      "no_revenue": 123,
      "no_withdrawals": 123,
      "non_revenue": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "period_end_date": "2023-12-25",
      "period_start_date": "2023-12-25",
      "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_account": {},
    "by_month_by_data_source_account_heron_id": {},
    "rolling_30_days_from_last_txn": {},
    "rolling_30_days_from_today": {},
    "total": {
      "actual_holdback_percentage": 123,
      "additional_no_od": 123,
      "average_balance": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "average_balance_to_revenue_ratio": 123,
      "business_day_average_balance": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "dd_reversals": 123,
      "ending_balance": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "expected_mca_debits": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "holdback_percentage": 123,
      "is_mtd": true,
      "is_unreconcilable": true,
      "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_mca_credits": 123,
      "no_mca_debits": 123,
      "no_nsf": 123,
      "no_od": 123,
      "no_od_nsf": 123,
      "no_overdraft_transactions": 123,
      "no_revenue": 123,
      "no_withdrawals": 123,
      "non_revenue": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "period_end_date": "2023-12-25",
      "period_start_date": "2023-12-25",
      "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"
      }
    }
  },
  "average": {
    "actual_holdback_percentage": 123,
    "additional_no_od": 123,
    "average_balance": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "average_balance_to_revenue_ratio": 123,
    "business_day_average_balance": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "dd_reversals": 123,
    "ending_balance": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "expected_mca_debits": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "holdback_percentage": 123,
    "is_mtd": true,
    "is_unreconcilable": true,
    "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_mca_credits": 123,
    "no_mca_debits": 123,
    "no_nsf": 123,
    "no_od": 123,
    "no_od_nsf": 123,
    "no_overdraft_transactions": 123,
    "no_revenue": 123,
    "no_withdrawals": 123,
    "non_revenue": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "period_end_date": "2023-12-25",
    "period_start_date": "2023-12-25",
    "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_account": {},
  "by_month_by_data_source_account_heron_id": {},
  "rolling_30_days_from_last_txn": {},
  "rolling_30_days_from_today": {},
  "total": {
    "actual_holdback_percentage": 123,
    "additional_no_od": 123,
    "average_balance": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "average_balance_to_revenue_ratio": 123,
    "business_day_average_balance": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "dd_reversals": 123,
    "ending_balance": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "expected_mca_debits": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "holdback_percentage": 123,
    "is_mtd": true,
    "is_unreconcilable": true,
    "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_mca_credits": 123,
    "no_mca_debits": 123,
    "no_nsf": 123,
    "no_od": 123,
    "no_od_nsf": 123,
    "no_overdraft_transactions": 123,
    "no_revenue": 123,
    "no_withdrawals": 123,
    "non_revenue": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "period_end_date": "2023-12-25",
    "period_start_date": "2023-12-25",
    "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"
    }
  }
}

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

import requests

url = "https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/bank_statement_summary"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/bank_statement_summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/bank_statement_summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/bank_statement_summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/bank_statement_summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "grouping": "<string>",
  "all_transactions_summary": {
    "grouping": "<string>",
    "average": {
      "actual_holdback_percentage": 123,
      "additional_no_od": 123,
      "average_balance": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "average_balance_to_revenue_ratio": 123,
      "business_day_average_balance": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "dd_reversals": 123,
      "ending_balance": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "expected_mca_debits": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "holdback_percentage": 123,
      "is_mtd": true,
      "is_unreconcilable": true,
      "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_mca_credits": 123,
      "no_mca_debits": 123,
      "no_nsf": 123,
      "no_od": 123,
      "no_od_nsf": 123,
      "no_overdraft_transactions": 123,
      "no_revenue": 123,
      "no_withdrawals": 123,
      "non_revenue": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "period_end_date": "2023-12-25",
      "period_start_date": "2023-12-25",
      "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_account": {},
    "by_month_by_data_source_account_heron_id": {},
    "rolling_30_days_from_last_txn": {},
    "rolling_30_days_from_today": {},
    "total": {
      "actual_holdback_percentage": 123,
      "additional_no_od": 123,
      "average_balance": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "average_balance_to_revenue_ratio": 123,
      "business_day_average_balance": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "dd_reversals": 123,
      "ending_balance": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "expected_mca_debits": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "holdback_percentage": 123,
      "is_mtd": true,
      "is_unreconcilable": true,
      "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_mca_credits": 123,
      "no_mca_debits": 123,
      "no_nsf": 123,
      "no_od": 123,
      "no_od_nsf": 123,
      "no_overdraft_transactions": 123,
      "no_revenue": 123,
      "no_withdrawals": 123,
      "non_revenue": {
        "amount": "1234.56",
        "currency": "USD"
      },
      "period_end_date": "2023-12-25",
      "period_start_date": "2023-12-25",
      "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"
      }
    }
  },
  "average": {
    "actual_holdback_percentage": 123,
    "additional_no_od": 123,
    "average_balance": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "average_balance_to_revenue_ratio": 123,
    "business_day_average_balance": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "dd_reversals": 123,
    "ending_balance": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "expected_mca_debits": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "holdback_percentage": 123,
    "is_mtd": true,
    "is_unreconcilable": true,
    "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_mca_credits": 123,
    "no_mca_debits": 123,
    "no_nsf": 123,
    "no_od": 123,
    "no_od_nsf": 123,
    "no_overdraft_transactions": 123,
    "no_revenue": 123,
    "no_withdrawals": 123,
    "non_revenue": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "period_end_date": "2023-12-25",
    "period_start_date": "2023-12-25",
    "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_account": {},
  "by_month_by_data_source_account_heron_id": {},
  "rolling_30_days_from_last_txn": {},
  "rolling_30_days_from_today": {},
  "total": {
    "actual_holdback_percentage": 123,
    "additional_no_od": 123,
    "average_balance": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "average_balance_to_revenue_ratio": 123,
    "business_day_average_balance": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "dd_reversals": 123,
    "ending_balance": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "expected_mca_debits": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "holdback_percentage": 123,
    "is_mtd": true,
    "is_unreconcilable": true,
    "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_mca_credits": 123,
    "no_mca_debits": 123,
    "no_nsf": 123,
    "no_od": 123,
    "no_od_nsf": 123,
    "no_overdraft_transactions": 123,
    "no_revenue": 123,
    "no_withdrawals": 123,
    "non_revenue": {
      "amount": "1234.56",
      "currency": "USD"
    },
    "period_end_date": "2023-12-25",
    "period_start_date": "2023-12-25",
    "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

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,

by_month_by_account,

by_data_source_account_by_monthly_intervals

num_full_calendar_months

integer | null

Number of full calendar months to show in the summary

Required range: x >= 1

account_ids

string[] | null

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

Response

200 - application/json

grouping

string

required

read-only

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

all_transactions_summary

object | null

The same summary over every loaded transaction, month-to-date statements included, where the fields above narrow to bank-statement files. Bank connections and other non-file sources are in both, so a deal with no files reports the same figures twice. Grouped the same way as the request asked for. When the end user does not load unreconciled transactions the two views are identical, and this mirrors the summary.

Show child attributes

average

object

Show child attributes

by_data_source_account_heron_id

object

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

Show child attributes

by_month

object

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

Show child attributes

by_month_by_account

object

Summary of bank statement by month and account id. Keys are the start date of the month and account ids, which may span multiple data source accounts

Show child attributes

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

Show child attributes

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

Show child attributes

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

Show child attributes

total

object

Show child attributes