Skip to main content
GET
Get cash flow statement

Authorizations

Authorization
string
header
required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

business_id
string<uuid>
required

Business UUID

Query Parameters

detail_level
enum<string>
default:summary

Level of detail: 'summary' or 'detailed'

Available options:
detailed,
summary
end_date
string<date>
required

Report period end date (YYYY-MM-DD)

start_date
string<date>
required

Report period start date (YYYY-MM-DD)

Response

business_id
string<uuid>
required

Business UUID

start_date
string<date>
required

Report period start date

end_date
string<date>
required

Report period end date

currency
string
required

Business base currency (ISO 4217)

detail_level
enum<string>
required

'summary' or 'detailed'

  • summary - summary
  • detailed - detailed
Available options:
summary,
detailed
summary
object
required

Cash flow summary metrics

cash_reconciliation
object
required

Cash reconciliation check (Opening + Change = Closing)

operating_activities
object

Operating activities breakdown (detailed view only)

investing_activities
object

Investing activities by account (detailed view only)

financing_activities
object

Financing activities by account (detailed view only)