Get data source account summary
curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/data_source_account_summary \
--header 'x-api-key: <api-key>'import requests
url = "https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/data_source_account_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}/data_source_account_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}/data_source_account_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}/data_source_account_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))
}HttpResponse<String> response = Unirest.get("https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/data_source_account_summary")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/data_source_account_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[
{
"data_source_account_summaries": [
{
"account": {
"is_enabled": true,
"account_id": "202348",
"anomaly_reasons": [
"Statement metadata changed",
"Manual review flagged suspicious edits"
],
"anomaly_score": 200,
"balances": [
{
"closing_amount": 25000.45,
"currency": "USD",
"date": "2022-01-01"
}
],
"currency": "USD",
"display_account_id": "7505",
"end_date": "2022-01-31",
"heron_id": "dso_L9qGiJcaYxCfaAYzC5PaM5",
"institution_name": "Chase",
"max_date": "2022-01-31",
"min_date": "2022-01-01",
"name": "Checking Account",
"num_transactions": 120,
"number": "123456789",
"owner_name": "John Doe",
"reference_id": "account-202348",
"start_date": "2022-01-01",
"transactions_match_balances": true,
"type": "Checking"
},
"summary": {
"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"
}
}
}
],
"end_user": {
"end_user_id": "2c098f79-9980-4d14-ab5c-0d0365acdb01",
"heron_id": "eus_4xsjLJRSaMXwecUyTNzJsG",
"name": "Company Name Inc."
}
}
]EndUserDataSources
Get data source account summary
Get a list of data sources accounts & their summarised information for a company
GET
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
data_source_account_summary
Get data source account summary
curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/data_source_account_summary \
--header 'x-api-key: <api-key>'import requests
url = "https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/data_source_account_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}/data_source_account_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}/data_source_account_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}/data_source_account_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))
}HttpResponse<String> response = Unirest.get("https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/data_source_account_summary")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/data_source_account_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[
{
"data_source_account_summaries": [
{
"account": {
"is_enabled": true,
"account_id": "202348",
"anomaly_reasons": [
"Statement metadata changed",
"Manual review flagged suspicious edits"
],
"anomaly_score": 200,
"balances": [
{
"closing_amount": 25000.45,
"currency": "USD",
"date": "2022-01-01"
}
],
"currency": "USD",
"display_account_id": "7505",
"end_date": "2022-01-31",
"heron_id": "dso_L9qGiJcaYxCfaAYzC5PaM5",
"institution_name": "Chase",
"max_date": "2022-01-31",
"min_date": "2022-01-01",
"name": "Checking Account",
"num_transactions": 120,
"number": "123456789",
"owner_name": "John Doe",
"reference_id": "account-202348",
"start_date": "2022-01-01",
"transactions_match_balances": true,
"type": "Checking"
},
"summary": {
"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"
}
}
}
],
"end_user": {
"end_user_id": "2c098f79-9980-4d14-ab5c-0d0365acdb01",
"heron_id": "eus_4xsjLJRSaMXwecUyTNzJsG",
"name": "Company Name Inc."
}
}
]Was this page helpful?
⌘I