v1
latestOpenAPI 3.1.02026-07-24111224223.3 KBReports
Retrieves cash flow statement report
Returns a cash flow statement report for the specified date range.
get/reports/cash-flow-statement
Query parameters
from_datestring date required
Start date for the report period. Uses ISO-8601 format (YYYY-MM-DD).
to_datestring date required
End date for the report period. Uses ISO-8601 format (YYYY-MM-DD).
subsidiary_idstring uuid
Subsidiary to be used when filtering data
breakdown_by'SUBSIDIARY' | 'CUSTOM_FIELD'
How to break down the report columns. If not specified, returns a single total column.
How to break down the report columns. If not specified, returns a single total column.
custom_field_idstring uuid
The ID of the custom field to break down by. Required when breakdown_by is CUSTOM_FIELD.
Response
OK
Example response
{
"period": {
"from_date": "2024-01-01",
"to_date": "2024-01-31"
},
"currency": "USD",
"breakdowns": [
{
"name": "Acme Corp US"
}
],
"sections": [
{
"name": "Operating Cash Flow",
"totals": [
{
"amount": {
"amount": "1.01",
"currency": "USD"
}
}
],
"items": [
{
"name": "Net Income",
"amounts": [
{
"amount": {
"amount": "1.01",
"currency": "USD"
}
}
]
}
]
}
],
"summaries": [
{
"name": "Net Income",
"amounts": [
{
"amount": {
"amount": "1.01",
"currency": "USD"
}
}
]
}
]
}