Skip to main content
POST
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
finicity
/
request_cashflow_report
Trigger a cashflow report generation for an end user
curl --request POST \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/finicity/request_cashflow_report \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "applicant_is_personal_guarantor": true,
  "for_cra_purpose": true
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.herondata.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
end_user_id_or_heron_id
string
required

Body

application/json
​
applicant_is_personal_guarantor
boolean
required
​
for_cra_purpose
boolean
required
​
user_type
enum<string>
required
Available options:
personal,
business

Response

202

OK