EndUserDataSourceAccounts

Update a data source account

Changed on

Update a data source account

put/api/data_source_accounts/{heron_id}

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/data_source_accounts/{heron_id}
  • Auth
    API key in header x-api-key

Path parameters

heron_idstring required

Request body

is_enabledboolean

Whether or not the account is enabled. If disabled, hides related transactions from analytics

Example request

{
  "is_enabled": true
}

Response

Ok

account_idstring nullable

PDF statement account identifier. Null for non-PDF sources.

account_type'business_checking' | 'business_savings' | 'personal' | 'escrow' | 'credit_loan' | 'null' nullable

Heron's full account type, the same for every source: business_checking, business_savings, personal, escrow or credit_loan. Open-banking accounts get it only for checking and savings whose owner is known. Null when Heron can't tell.

anomaly_reasonsstring[] nullable

Reasons associated with anomaly_score for pdf bank statement account sources

anomaly_scoreinteger

For pdf bank statement account sources, where the value is between 0 and 1000, with 1000 being the most anomalous

currencystring

Currency of the account

dbastring nullable

Doing Business As name printed on the bank statement

disabled_reason'excluded_account_type' | 'excluded_personal_account' | 'excluded_business_savings_account' | 'excluded_escrow_account' | 'excluded_credit_loan_account' | 'loan_account' | 'reviewer_excluded' | 'not_an_account' | 'excluded_bank' | 'account_id_mismatch' | 'failed_checks' | 'unverifiable_statement' | 'null' nullable

Why we never processed this account, so it was created disabled with no transactions: excluded_account_type (legacy or unknown account-type exclusion), excluded_personal_account, excluded_business_savings_account, excluded_escrow_account, excluded_credit_loan_account, loan_account, reviewer_excluded, not_an_account (an empty section of the document that is not an account, such as a summary box), excluded_bank (a bank or service provider the workflow skips), account_id_mismatch (the account number does not match the account_id sent on upload), or failed_checks (the statement was parsed but failed our checks, so the file was rejected). Null for every other account, including ones disabled later.

disabled_reason_descriptionstring nullable

Customer-facing explanation of why Heron did not process the account.

display_account_idstring nullable

Human-readable account label for display: the last four digits of the account number without heron_account_suffix (falling back to the account title). Not unique and not a key; join heron_id to data_source_account_heron_id on transactions.

end_datestring date

End date of the account

heron_account_suffixstring nullable

Added by Heron to tell apart accounts that print the same account number, such as a checking account and its reserve line. Not printed by the bank. A 3-digit suffix is the order the accounts appear in one file, so the same account can get a different one in another file. Null when the printed number needed no suffix.

heron_idstring

Unique ID for data source generated by Heron

institution_namestring

Name of the institution

is_enabledboolean required

Whether or not the account is enabled. If disabled, hides related transactions from analytics

max_datestring date

Latest date of transactions associated with the data source account

min_datestring date

Earliest date of transactions associated with the data source account

namestring

Name of the account

num_transactionsinteger

Number of transactions associated with the data source account

numberstring

Number of the account

owner_namestring

Name of the account owner

printed_account_numberstring nullable

The account number without heron_account_suffix: the number and any sub-account the bank printed. Same as number when there is no suffix.

reference_idstring

This is the account ID provided as part of the transaction

start_datestring date

Start date of the account

transactions_match_balancesboolean

For pdf bank statements, represents whether all transactions extracted match the balances extracted

typestring

Raw account type. Bank statements: business, personal or unknown. Open banking: the provider's own value, e.g. CHECKING, SAVINGS or Plaid's depository. Not the same across sources; use account_type to tell business checking from other accounts.

Example response

{
  "account_id": "202348",
  "account_type": "business_checking",
  "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",
  "dba": "Chickys",
  "disabled_reason": "excluded_account_type",
  "disabled_reason_description": "Heron didn't load transactions because this workflow excludes business savings accounts.",
  "display_account_id": "7505",
  "end_date": "2022-01-31",
  "heron_account_suffix": "001",
  "heron_id": "dso_35o5KymvL3VqRXDwNY7xxv",
  "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",
  "printed_account_number": "1-458-1824-4066",
  "reference_id": "account-202348",
  "start_date": "2022-01-01",
  "transactions_match_balances": true,
  "type": "business"
}

Changes

    • breaking

      the response property became nullable for the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status