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": {
"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_XE47ABWHzvWdBJoqmcCDL7",
"institution_name": "Chase",
"is_enabled": true,
"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": "e4be922c-f69f-474c-8e3d-b20aafb38398",
"heron_id": "eus_82aJ3W55xESAbaF7mF5pZX",
"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": {
"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_XE47ABWHzvWdBJoqmcCDL7",
"institution_name": "Chase",
"is_enabled": true,
"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": "e4be922c-f69f-474c-8e3d-b20aafb38398",
"heron_id": "eus_82aJ3W55xESAbaF7mF5pZX",
"name": "Company Name Inc."
}
}
]
Ok
The response is of type object[]
.
Was this page helpful?