API Reference
Categories
EndUserDataSourceAccounts
EndUsers
- GETGet EndUser emails
- GETList EndUsers
- PUTUpdate EndUser
- POSTCreate EndUser
- GETList EndUsers with Summary Information
- 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
EndUserEnricherFields
EndUserEntity
- GETGet the definitions for all end user entities
- POSTCreate an end user entity
- PATCHSet the display order of end user entities
- POSTCreate an end user entity attribute
- PATCHSet the display order of end user entity attributes
- DELDelete an EndUserEntityAttribute
- PATCHUpdate an end user entity
- POSTCreate an end user entity attribute
- POSTCreate an end user entity attribute source
- DELDelete an EndUserEntityAttribute
- PATCHUpsert an end user entity
- DELDelete an EndUserEntity
- PATCHUpdate an end user entity
- GETGet the materialised end user entities for an end user
- POSTUpsert the attribute value for an end user entity attribute source
EndUserFiles
- GETAll EndUserFiles
- 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
FileClass
EndUserCalculations
- GETGet EndUser balance
- GETGet EndUser forecasts
- GETGet EndUser statistics
- GETRun industry classification on end user files
- 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 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
Enrich transactions (sync)
Enrich and categorize transactions and consume them in a sync response. For business lending and underwriting, please use “Create end user transactions” instead. Please send a maximum of 249 transactions per request.
curl --request POST \
--url https://app.herondata.io/api/transactions \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"transactions": [
{
"account_id": "checking_account_202348",
"amount": -42.42,
"balance": 423,
"categories_default": "shopping",
"currency": "USD",
"date": "2020-04-27",
"description": "GOOGLE *ADS12340929 [email protected] US",
"end_user_id": "my_best_customer_203948",
"mcc_code": "<string>",
"order": 123,
"reference_id": "my_favourite_transaction_231098",
"timestamp": "2021-11-12T10:38:05Z",
"transaction_code": "card"
}
]
}'{
"_summary": {
"request_id": "<string>"
},
"transactions": [
{
"account_id": "checking_account_202348",
"amount": -42.42,
"balance": 423,
"categories": [
{
"annotator": "predicted",
"confidence": 0.5,
"heron_id": "ctg_VGwt3NNpPzjYuHfNgjuXYg",
"label": "Rent",
"model_version": "c087134e-98a5-4522-99fd-9bfc7470eb70"
}
],
"currency": "USD",
"description": "GOOGLE *ADS12340929 [email protected] US",
"description_clean": "GOOGLE ADS",
"duplicate_of_id": "<any>",
"end_user_id": "my_best_customer_203948",
"has_matching_transaction": true,
"is_potential_duplicate": true,
"is_recurring": true,
"merchant": {
"categories": [
{
"code": "7311",
"description": "Advertising services",
"slug": "advertising_services"
}
],
"group_id": "Uber",
"heron_id": "mrc_ifF8pnLaH9W4i4ANqaF4z3",
"icon_url": "<string>",
"is_priority": true,
"logo_url": "<string>",
"name": "<string>",
"url": "<string>"
},
"payment_processor": {
"heron_id": "mrc_nRYdGU7nYuevb7qem65cEb",
"icon_url": "https://storage.googleapis.com/heron-merchant-assets/icons/mrc_nRYdGU7nYuevb7qem65cEb.svg",
"logo_url": "https://storage.googleapis.com/heron-merchant-assets/logos/mrc_nRYdGU7nYuevb7qem65cEb.svg",
"name": "Paypal",
"url": "https://www.paypal.com"
},
"reference_id": "my_favourite_transaction_231098",
"request_id": "req_nUKcqx7njuoVjKvghbF9je",
"timestamp": "2021-11-12T10:38:05Z",
"transaction_code": "card"
}
]
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
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.
-42.42
The text description for the transaction
"GOOGLE *ADS12340929 [email protected] US"
Your unique ID for account associated with transaction
400"checking_account_202348"
The running balance of the account after transaction ocurred
423
Category of transaction that you may have received from other sources
"shopping"
ISO 4217 currency code
3"USD"
The date of the transaction; 'timestamp' field takes priority over 'date'
"2020-04-27"
Your unique ID for end user associated with transaction
140"my_best_customer_203948"
Merchant category code associated with transaction that you may have received from other sources
If sending a batch of transactions, the order in which the transaction occurs, where a higher value is equivalent to a more recent transaction
Your unique ID for transaction
140"my_favourite_transaction_231098"
The ISO 8601 timezone aware timestamp of the transaction; takes precedence over 'date'
"2021-11-12T10:38:05Z"
Code associated with transaction to indicate the type of transaction
140"card"
Response
only returned for sync enrichment requests
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.
-42.42
The text description for the transaction
"GOOGLE *ADS12340929 [email protected] US"
Your unique ID for account associated with transaction
400"checking_account_202348"
The running balance of the account after transaction ocurred
423
The category associated with the transaction
Annotator type
"predicted"
The confidence associated with the category annotation
0.5
Unique ID of category; generated by Heron Data
"ctg_VGwt3NNpPzjYuHfNgjuXYg"
Label of category
"Rent"
The model version that produced the categorisation
"c087134e-98a5-4522-99fd-9bfc7470eb70"
ISO 4217 currency code
3"USD"
The cleaned description of the transaction
"GOOGLE ADS"
Indicates that the transaction is a duplicate and gives the heron_id of the original
Your unique ID for end user associated with transaction
140"my_best_customer_203948"
Whether the transaction is a transfer; requires end_user_id and timestamp to be present
Indicates whether the transaction has another transaction similar to it
Whether the transaction is recurring or not; requires end_user_id and timestamp to be present
The merchant associated with the transaction
Uber, Google, Intuit, debt.mca_or_rbf, debt.non_bank_business, debt.equipment_and_auto_leasing, debt.mortgage, debt.personal_non_mortgage, debt.collections "mrc_ifF8pnLaH9W4i4ANqaF4z3"
The payment processor associated with the transaction
"mrc_nRYdGU7nYuevb7qem65cEb"
"https://storage.googleapis.com/heron-merchant-assets/icons/mrc_nRYdGU7nYuevb7qem65cEb.svg"
"https://storage.googleapis.com/heron-merchant-assets/logos/mrc_nRYdGU7nYuevb7qem65cEb.svg"
"Paypal"
"https://www.paypal.com"
Your unique ID for transaction
140"my_favourite_transaction_231098"
ID associated with request, e.g., all transactions in same POST request will have same request_id
"req_nUKcqx7njuoVjKvghbF9je"
The ISO 8601 timezone aware timestamp of the transaction; takes precedence over 'date'
"2021-11-12T10:38:05Z"
Code associated with transaction to indicate the type of transaction
140"card"
Was this page helpful?
curl --request POST \
--url https://app.herondata.io/api/transactions \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"transactions": [
{
"account_id": "checking_account_202348",
"amount": -42.42,
"balance": 423,
"categories_default": "shopping",
"currency": "USD",
"date": "2020-04-27",
"description": "GOOGLE *ADS12340929 [email protected] US",
"end_user_id": "my_best_customer_203948",
"mcc_code": "<string>",
"order": 123,
"reference_id": "my_favourite_transaction_231098",
"timestamp": "2021-11-12T10:38:05Z",
"transaction_code": "card"
}
]
}'{
"_summary": {
"request_id": "<string>"
},
"transactions": [
{
"account_id": "checking_account_202348",
"amount": -42.42,
"balance": 423,
"categories": [
{
"annotator": "predicted",
"confidence": 0.5,
"heron_id": "ctg_VGwt3NNpPzjYuHfNgjuXYg",
"label": "Rent",
"model_version": "c087134e-98a5-4522-99fd-9bfc7470eb70"
}
],
"currency": "USD",
"description": "GOOGLE *ADS12340929 [email protected] US",
"description_clean": "GOOGLE ADS",
"duplicate_of_id": "<any>",
"end_user_id": "my_best_customer_203948",
"has_matching_transaction": true,
"is_potential_duplicate": true,
"is_recurring": true,
"merchant": {
"categories": [
{
"code": "7311",
"description": "Advertising services",
"slug": "advertising_services"
}
],
"group_id": "Uber",
"heron_id": "mrc_ifF8pnLaH9W4i4ANqaF4z3",
"icon_url": "<string>",
"is_priority": true,
"logo_url": "<string>",
"name": "<string>",
"url": "<string>"
},
"payment_processor": {
"heron_id": "mrc_nRYdGU7nYuevb7qem65cEb",
"icon_url": "https://storage.googleapis.com/heron-merchant-assets/icons/mrc_nRYdGU7nYuevb7qem65cEb.svg",
"logo_url": "https://storage.googleapis.com/heron-merchant-assets/logos/mrc_nRYdGU7nYuevb7qem65cEb.svg",
"name": "Paypal",
"url": "https://www.paypal.com"
},
"reference_id": "my_favourite_transaction_231098",
"request_id": "req_nUKcqx7njuoVjKvghbF9je",
"timestamp": "2021-11-12T10:38:05Z",
"transaction_code": "card"
}
]
}