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>'[
{
"data_source_account_summaries": [
{
"account": {
"is_enabled": true,
"account_id": "202348",
"anomaly_score": 200,
"balances": [
{
"closing_amount": 25000.45,
"currency": "USD",
"date": "2022-01-01"
}
],
"currency": "USD",
"end_date": "2022-01-31",
"heron_id": "dso_8FZ5mu8gWQgyXVpi7urGDS",
"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": {
"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"
}
}
}
],
"end_user": {
"end_user_id": "392bb4b9-189b-4d26-9307-c8c59ddad61d",
"heron_id": "eus_7LXGsUNgVvLQBdN6AriatL",
"name": "Company Name Inc."
}
}
]Get a list of data sources accounts & their summarised information for a company
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>'[
{
"data_source_account_summaries": [
{
"account": {
"is_enabled": true,
"account_id": "202348",
"anomaly_score": 200,
"balances": [
{
"closing_amount": 25000.45,
"currency": "USD",
"date": "2022-01-01"
}
],
"currency": "USD",
"end_date": "2022-01-31",
"heron_id": "dso_8FZ5mu8gWQgyXVpi7urGDS",
"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": {
"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"
}
}
}
],
"end_user": {
"end_user_id": "392bb4b9-189b-4d26-9307-c8c59ddad61d",
"heron_id": "eus_7LXGsUNgVvLQBdN6AriatL",
"name": "Company Name Inc."
}
}
]Ok
Show child attributes
Show child attributes
Whether or not the account is enabled. If disabled, hides related transactions from analytics
true
Unique account id associated with the data source account
"202348"
For pdf bank statement account sources, where the value is between 0 and 1000, with 1000 being the most anomalous
200
List of balances associated with the account
Show child attributes
Currency of the balance
"USD"
Date of the balance
"2022-01-01"
[
{
"closing_amount": 25000.45,
"currency": "USD",
"date": "2022-01-01"
}
]Currency of the account
"USD"
End date of the account
"2022-01-31"
Unique ID for data source generated by Heron
"dso_8FZ5mu8gWQgyXVpi7urGDS"
Name of the institution
"Chase"
Latest date of transactions associated with the data source account
"2022-01-31"
Earliest date of transactions associated with the data source account
"2022-01-01"
Name of the account
"Checking Account"
Number of transactions associated with the data source account
120
Number of the account
"123456789"
Name of the account owner
"John Doe"
This is the account ID provided as part of the transaction
"account-202348"
Start date of the account
"2022-01-01"
For pdf bank statements, represents whether all transactions extracted match the balances extracted
true
Type of the account
"Checking"
Show child attributes
Average balance divided by total revenue
Number of DD Reversals
MCA debits to revenue as %
Number of days where end of day balance falls below low balance threshold
Number of days with negative balance
Number of deposit transactions
Number of overdraft or NSF transactions
Number of transactions where the resulting balance falls below 0
Number of revenue transactions
Number of withdrawals transactions
Show child attributes
id defined by user; links to the end_user_id for transactions
1 - 140"392bb4b9-189b-4d26-9307-c8c59ddad61d"
Unique id for end user generated by Heron
"eus_7LXGsUNgVvLQBdN6AriatL"
Name of end user; may help to improve categorisation accuracy
128"Company Name Inc."
Was this page helpful?