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
Create a CRM integration
Create a CRM integration, e.g., with Salesforce
curl --request POST \
--url https://app.herondata.io/api/crm_integrations \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"auth": {},
"config": {
"data_source_accounts_config": {
"description": "A company or person",
"external_lookup_config": {
"external_lookup_fields_and": [
"<string>"
],
"external_lookup_fields_or": [
"<string>"
],
"sort_field_name": "CreatedDate",
"sort_order": "ASC"
},
"external_name": "Account",
"field_mappings": [
{
"external_lookup_field_name": "<string>",
"external_object_name_for_id": "Account",
"field_name": "Name",
"heron_company_attribute_label": "owner_1_first_name",
"max_length": 255,
"overwrite_on_update": true,
"regex_remove": "pattern",
"required": true,
"static_value": "static value",
"static_value_key": "date_today",
"value_mapping_name": "state",
"value_type": "Text"
}
],
"is_optional": false,
"key": "Account",
"required_ids": [
{
"alias": "Company",
"external_name": "Account"
}
],
"static_data": [
{
"key": "status",
"value": "<any>"
}
]
},
"default_id": {
"alias": "Company",
"external_name": "Account"
},
"object_configs": [],
"policy_evaluation_config": {
"external_object_name": "Opportunity",
"failure_reason_external_name": "Failure_Reason__c",
"result_external_name": "Submission_Result_from_Heron__c"
},
"sync_file_classes": {},
"value_mappings": []
},
"failure_notification_channel": null,
"instance_url": "https://sandbox.salesforce.com",
"is_enabled": true,
"is_live": true,
"provider": "salesforce",
"secret": "<string>"
}'{
"crm_integration": {
"config": {
"data_source_accounts_config": {
"description": "A company or person",
"external_lookup_config": {
"external_lookup_fields_and": [
"<string>"
],
"external_lookup_fields_or": [
"<string>"
],
"sort_field_name": "CreatedDate",
"sort_order": "ASC"
},
"external_name": "Account",
"field_mappings": [
{
"external_lookup_field_name": "<string>",
"external_object_name_for_id": "Account",
"field_name": "Name",
"heron_company_attribute_label": "owner_1_first_name",
"max_length": 255,
"overwrite_on_update": true,
"regex_remove": "pattern",
"required": true,
"static_value": "static value",
"static_value_key": "date_today",
"value_mapping_name": "state",
"value_type": "Text"
}
],
"is_optional": false,
"key": "Account",
"required_ids": [
{
"alias": "Company",
"external_name": "Account"
}
],
"static_data": [
{
"key": "status",
"value": "<any>"
}
]
},
"default_id": {
"alias": "Company",
"external_name": "Account"
},
"object_configs": [],
"policy_evaluation_config": {
"external_object_name": "Opportunity",
"failure_reason_external_name": "Failure_Reason__c",
"result_external_name": "Submission_Result_from_Heron__c"
},
"sync_file_classes": {},
"value_mappings": []
},
"failure_notification_channel": null,
"heron_id": "<string>",
"instance_url": "https://sandbox.salesforce.com",
"is_enabled": true,
"is_live": true,
"provider": "salesforce"
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
Authentication details for the CRM integration
The configuration for the CRM integration
The data source accounts configuration for the CRM integration
The exact name of the object in the CRM
"Account"
key should be unique among objects within an integration
"Account"
Human-readable description of the object
"A company or person"
Configuration for external lookup
External lookup fields are what is used to try match potential new objects to existing objects in the CRM (i.e., for deduplication). Used in the and condition.
External lookup fields are what is used to try match potential new objects to existing objects in the CRM (i.e., for deduplication). Used in the or condition.
The field name to sort by when doing the external lookup
"CreatedDate"
The sort order when doing the external lookup
ASC, DESC Mapping for Heron fields to object fields in CRM
The name of the field in the CRM
"Name"
Override field name to use for external lookup instead of the field_name
The external object whose id we want to use populate the field value
"Account"
The label of the company attribute in Heron
"owner_1_first_name"
The max length of the crm field this should be mapped to. Used for string fields. If set, the string will be truncated.
255
Whether the field should be overwritten on update. True by default. When False, the field will only be set on creation
true
Any pattern that should be removed from the company attribute value
"pattern"
Whether the field is required
true
A static value for the field
"static value"
The value key of the static data
date_today Name of the value mapping to use for the field
"state"
The crm type of the field
"Text"
Whether the object is optional. Optional means that if object fails it will not stop execution of CRM sync
The object configurations for the CRM integration
The exact name of the object in the CRM
"Account"
key should be unique among objects within an integration
"Account"
Human-readable description of the object
"A company or person"
Configuration for external lookup
External lookup fields are what is used to try match potential new objects to existing objects in the CRM (i.e., for deduplication). Used in the and condition.
External lookup fields are what is used to try match potential new objects to existing objects in the CRM (i.e., for deduplication). Used in the or condition.
The field name to sort by when doing the external lookup
"CreatedDate"
The sort order when doing the external lookup
ASC, DESC Mapping for Heron fields to object fields in CRM
The name of the field in the CRM
"Name"
Override field name to use for external lookup instead of the field_name
The external object whose id we want to use populate the field value
"Account"
The label of the company attribute in Heron
"owner_1_first_name"
The max length of the crm field this should be mapped to. Used for string fields. If set, the string will be truncated.
255
Whether the field should be overwritten on update. True by default. When False, the field will only be set on creation
true
Any pattern that should be removed from the company attribute value
"pattern"
Whether the field is required
true
A static value for the field
"static value"
The value key of the static data
date_today Name of the value mapping to use for the field
"state"
The crm type of the field
"Text"
Whether the object is optional. Optional means that if object fails it will not stop execution of CRM sync
The policy evaluation configuration for the CRM integration
The object to write policy evaluation results to
"Opportunity"
The field to write policy evaluation failure reason to
"Failure_Reason__c"
The field to write policy evaluation results
"Submission_Result_from_Heron__c"
Whether to sync files of a given class, including emails
A list of value mappings for the CRM integration
The mapping of values
{ "CA": "California", "NY": "New York" }
The name of the value mapping
"Status"
The default value to use when no match is found
"Default"
A human-readable description of the value mapping
"The status of the company"
Whether to use partial match when mapping values
Base URL of the CRM integration
"https://sandbox.salesforce.com"
The CRM provider
salesforce, lendsmart, orgmeter, centrex, lendsaas, quickbase, zoho, origami, dynamics, nirvana, in_memory A secret key for the CRM integration
The channel to send failure notifications to
Whether the integration is enabled
true
Whether the integration is live
true
Response
The configuration for the CRM integration
The data source accounts configuration for the CRM integration
The exact name of the object in the CRM
"Account"
key should be unique among objects within an integration
"Account"
Human-readable description of the object
"A company or person"
Configuration for external lookup
External lookup fields are what is used to try match potential new objects to existing objects in the CRM (i.e., for deduplication). Used in the and condition.
External lookup fields are what is used to try match potential new objects to existing objects in the CRM (i.e., for deduplication). Used in the or condition.
The field name to sort by when doing the external lookup
"CreatedDate"
The sort order when doing the external lookup
ASC, DESC Mapping for Heron fields to object fields in CRM
The name of the field in the CRM
"Name"
Override field name to use for external lookup instead of the field_name
The external object whose id we want to use populate the field value
"Account"
The label of the company attribute in Heron
"owner_1_first_name"
The max length of the crm field this should be mapped to. Used for string fields. If set, the string will be truncated.
255
Whether the field should be overwritten on update. True by default. When False, the field will only be set on creation
true
Any pattern that should be removed from the company attribute value
"pattern"
Whether the field is required
true
A static value for the field
"static value"
The value key of the static data
date_today Name of the value mapping to use for the field
"state"
The crm type of the field
"Text"
Whether the object is optional. Optional means that if object fails it will not stop execution of CRM sync
List of object ids that new object needs
Stores static data used by the integration, for example status fields
The object configurations for the CRM integration
The exact name of the object in the CRM
"Account"
key should be unique among objects within an integration
"Account"
Human-readable description of the object
"A company or person"
Configuration for external lookup
External lookup fields are what is used to try match potential new objects to existing objects in the CRM (i.e., for deduplication). Used in the and condition.
External lookup fields are what is used to try match potential new objects to existing objects in the CRM (i.e., for deduplication). Used in the or condition.
The field name to sort by when doing the external lookup
"CreatedDate"
The sort order when doing the external lookup
ASC, DESC Mapping for Heron fields to object fields in CRM
The name of the field in the CRM
"Name"
Override field name to use for external lookup instead of the field_name
The external object whose id we want to use populate the field value
"Account"
The label of the company attribute in Heron
"owner_1_first_name"
The max length of the crm field this should be mapped to. Used for string fields. If set, the string will be truncated.
255
Whether the field should be overwritten on update. True by default. When False, the field will only be set on creation
true
Any pattern that should be removed from the company attribute value
"pattern"
Whether the field is required
true
A static value for the field
"static value"
The value key of the static data
date_today Name of the value mapping to use for the field
"state"
The crm type of the field
"Text"
Whether the object is optional. Optional means that if object fails it will not stop execution of CRM sync
List of object ids that new object needs
The policy evaluation configuration for the CRM integration
The object to write policy evaluation results to
"Opportunity"
The field to write policy evaluation failure reason to
"Failure_Reason__c"
The field to write policy evaluation results
"Submission_Result_from_Heron__c"
Whether to sync files of a given class, including emails
A list of value mappings for the CRM integration
The mapping of values
{ "CA": "California", "NY": "New York" }
The name of the value mapping
"Status"
The default value to use when no match is found
"Default"
A human-readable description of the value mapping
"The status of the company"
Whether to use partial match when mapping values
Base URL of the CRM integration
"https://sandbox.salesforce.com"
The CRM provider
salesforce, lendsmart, orgmeter, centrex, lendsaas, quickbase, zoho, origami, dynamics, nirvana, in_memory The channel to send failure notifications to
Whether the integration is enabled
true
Whether the integration is live
true
Was this page helpful?
curl --request POST \
--url https://app.herondata.io/api/crm_integrations \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"auth": {},
"config": {
"data_source_accounts_config": {
"description": "A company or person",
"external_lookup_config": {
"external_lookup_fields_and": [
"<string>"
],
"external_lookup_fields_or": [
"<string>"
],
"sort_field_name": "CreatedDate",
"sort_order": "ASC"
},
"external_name": "Account",
"field_mappings": [
{
"external_lookup_field_name": "<string>",
"external_object_name_for_id": "Account",
"field_name": "Name",
"heron_company_attribute_label": "owner_1_first_name",
"max_length": 255,
"overwrite_on_update": true,
"regex_remove": "pattern",
"required": true,
"static_value": "static value",
"static_value_key": "date_today",
"value_mapping_name": "state",
"value_type": "Text"
}
],
"is_optional": false,
"key": "Account",
"required_ids": [
{
"alias": "Company",
"external_name": "Account"
}
],
"static_data": [
{
"key": "status",
"value": "<any>"
}
]
},
"default_id": {
"alias": "Company",
"external_name": "Account"
},
"object_configs": [],
"policy_evaluation_config": {
"external_object_name": "Opportunity",
"failure_reason_external_name": "Failure_Reason__c",
"result_external_name": "Submission_Result_from_Heron__c"
},
"sync_file_classes": {},
"value_mappings": []
},
"failure_notification_channel": null,
"instance_url": "https://sandbox.salesforce.com",
"is_enabled": true,
"is_live": true,
"provider": "salesforce",
"secret": "<string>"
}'{
"crm_integration": {
"config": {
"data_source_accounts_config": {
"description": "A company or person",
"external_lookup_config": {
"external_lookup_fields_and": [
"<string>"
],
"external_lookup_fields_or": [
"<string>"
],
"sort_field_name": "CreatedDate",
"sort_order": "ASC"
},
"external_name": "Account",
"field_mappings": [
{
"external_lookup_field_name": "<string>",
"external_object_name_for_id": "Account",
"field_name": "Name",
"heron_company_attribute_label": "owner_1_first_name",
"max_length": 255,
"overwrite_on_update": true,
"regex_remove": "pattern",
"required": true,
"static_value": "static value",
"static_value_key": "date_today",
"value_mapping_name": "state",
"value_type": "Text"
}
],
"is_optional": false,
"key": "Account",
"required_ids": [
{
"alias": "Company",
"external_name": "Account"
}
],
"static_data": [
{
"key": "status",
"value": "<any>"
}
]
},
"default_id": {
"alias": "Company",
"external_name": "Account"
},
"object_configs": [],
"policy_evaluation_config": {
"external_object_name": "Opportunity",
"failure_reason_external_name": "Failure_Reason__c",
"result_external_name": "Submission_Result_from_Heron__c"
},
"sync_file_classes": {},
"value_mappings": []
},
"failure_notification_channel": null,
"heron_id": "<string>",
"instance_url": "https://sandbox.salesforce.com",
"is_enabled": true,
"is_live": true,
"provider": "salesforce"
}
}