EndUserAccounts
Get Missing Accounts (beta)
API Reference
Categories
EndUserDataSourceAccounts
EndUsers
- GETGet EndUser emails
- GETList EndUsers
- PUTUpdate EndUser
- POSTCreate EndUser
- GETGet EndUser by heron_id or end_user_id
- DELDelete EndUser by heron_id or end_user_id
- GETGet EndUser emails
- GETGet EndUser information
- PATCHPatch EndUser information
- POSTEnrich transactions of EndUser
- GETGet EndUser physical location
- GETRetrieve CRM sync events for an end user
- POSTTrigger a CRM Sync for an End User
EndUserEmails
EndUserEntity
EndUserFiles
- GETAll EndUserFiles
- GETGet all file classes
- GETGet recent files by file class
- GETGet file rename rules
- POSTCreate a file rename rule
- PATCHUpdate a file rename rule
- PATCHUpdate the end user file's class
- GETGet EndUserFile as a base64 string
- POSTTrigger async parsing of an end user file
- PATCHUpdate Parsed Results
- GETGet parsed results from uploaded files
- POSTTrigger file's rename rule
- POSTTrigger splitting a combined end user file into its child files based on its page_classes
- GETGet EndUserFiles
- POSTPost EndUserFile
- GETDownload EndUserFiles
- GETDownload xlsx of parsed results from uploaded files
EndUserCalculations
- GETGet EndUser balance
- GETGet EndUser forecasts
- GETGet EndUser statistics
- GETGet EndUser anomalies
- GETGet EndUser bank statement summary
- GETGet EndUser metric benchmarks
- GETExport as a spreadsheet
- GETGet EndUser transactions grouped by counterparty or merchant
- GETGet EndUser Heron Score (beta)
- GETGet EndUser industry
- GETGet EndUser merchant summary
- GETGet EndUser named dates
- GETGet EndUser cashflow P&L
- PUTUpdate EndUser P&L layout
- GETGet EndUser recurring transactions report
- GETGet EndUser scorecard
- POSTRequest EndUser scorecard
- GETGet EndUser transaction data coverage
EndUserAttributes
EnrichmentFeedback
EndUserFinancials
EndUserRules
Integrations
- POSTSend a Finicity Connect email to an end user
- POSTTrigger a cashflow report generation for an end user
- POSTTrigger a statement reports generation for an end user
- POSTTrigger a Finicity VOE transactions report generation for an end user
- PUTUpdate an Integration Link
- GETList Integrations
- POSTCreate an integration
- PUTUpdate Integration
- GETGet IntegrationLinks by Integration
- POSTCreate an integration Link
- DEL(Soft-)Delete an integration link
- POSTRefresh an IntegrationLink
EndUserIntegrations
- POSTUpload Inscribe
- GETGet Integration Links
- POSTUpload Ocrolus
- GETGet PDFs
- POSTParse all PDF
- POSTUpload PDF
- POSTUpload Plaid assets
- POSTUpload Plaid transactions
- POSTUpload Yodlee
- PUTUpdate PDF attributes including status
- PATCHSend patch transactions for a pdf statement
- POSTReloads transactions for a pdf
- POSTUnloads transactions for a pdf
ISOApplication
- POSTUpload an ISO application PDF for for an end user
- GETGet EndUser ISO Applications
- POSTUpload an ISO application PDF for automated scrubbing in under 15 seconds
- POSTUpload an ISO application PDF for automated scrubbing in under 15 seconds (base64)
- GETGet the scrubbed results and data validations of an uploaded ISO application by its heron_id (prefixed "iso_")
EndUserAccounts
EnrichedTransactions
Transactions
Merchants
ParsedEndUserSubmission
Users
EndUserAccounts
Get Missing Accounts (beta)
Get a list of possible missing accounts for a given End User. This endpoint is in beta and likely to change.
GET
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
missing_accounts
curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/missing_accounts \
--header 'Authorization: Basic <encoded-value>'{
"missing_accounts": [
{
"account_name": "Checking",
"account_number": "****4321",
"transactions": [
{
"account_id": "checking_account_202348",
"amount": -42.42,
"currency": "USD",
"description": "GOOGLE *ADS12340929 [email protected] US",
"heron_id": "txn_KjPQKaF6BdpSpR6ewTPXNE",
"timestamp": "2021-11-12T10:38:05Z"
}
]
}
]
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
The end_user_id or heron_id of EndUser
Response
200 - application/json
OK
An account name extracted from the transaction description
Example:
"Checking"
An account number extracted from the transaction description
Example:
"****4321"
Amount. Inflows to an account should be positive, and outflows from an account should be negative. If using Plaid, please flip the amount sign for all transactions.
Example:
-42.42
The text description for the transaction
Example:
"GOOGLE *ADS12340929 [email protected] US"
Your unique ID for account associated with transaction
Maximum length:
400Example:
"checking_account_202348"
ISO 4217 currency code
Required string length:
3Example:
"USD"
Unique ID of transaction; generated by Heron Data
Example:
"txn_KjPQKaF6BdpSpR6ewTPXNE"
The ISO 8601 timezone aware timestamp of the transaction; takes precedence over 'date'
Example:
"2021-11-12T10:38:05Z"
curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/missing_accounts \
--header 'Authorization: Basic <encoded-value>'{
"missing_accounts": [
{
"account_name": "Checking",
"account_number": "****4321",
"transactions": [
{
"account_id": "checking_account_202348",
"amount": -42.42,
"currency": "USD",
"description": "GOOGLE *ADS12340929 [email protected] US",
"heron_id": "txn_KjPQKaF6BdpSpR6ewTPXNE",
"timestamp": "2021-11-12T10:38:05Z"
}
]
}
]
}