v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
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

Path parameters

end_user_id_or_heron_idstring required

Response

Ok

Example response

[
  {
    "data_source_account_summaries": [
      {
        "account": {
          "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_WMGNXUN2fgcGCmuYHykdgE",
          "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": {
            "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"
          }
        }
      }
    ],
    "end_user": {
      "end_user_id": "1b856eb2-8510-47d9-9025-c1bd7eb5eae4",
      "heron_id": "eus_WAcrEUnGkmMjYoRJBRbpwc",
      "name": "Company Name Inc."
    }
  }
]