VUZDevelopers

Generate Cash Flow Statement (דוח תזרים מזומנים)

GET
/reports/cash-flow

Generate a Cash Flow Statement (indirect method) for the requested period, showing operating/investing/financing activities, opening/closing cash, and net change in cash. Computed from dated JournalEntry movements (never from the stale Account.currentBalance snapshot) — two calls with different date ranges return different figures.

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Query Parameters

startDate?string

Period start date (ISO 8601). Defaults to Jan 1 of current year.

endDate?string

Period end date (ISO 8601). Defaults to today.

fiscalYear?number

Fiscal year (alternative to date range)

hideZeroBalances?boolean

Hide accounts with zero balance and zero movements

variant?string

Trial Balance variant: combined (3-column), balances, or movements

Value in

  • "combined"
  • "balances"
  • "movements"
accountCategory?string

Filter by account category

Value in

  • "ASSET"
  • "LIABILITY"
  • "EQUITY"
  • "REVENUE"
  • "EXPENSE"
locale?string

Display locale for report line labels (Cash Flow section item names). Defaults to Hebrew.

Value in

  • "he"
  • "en"

Header Parameters

X-Business-Id*string

Response Body

application/json

curl -X GET "https://example.com/reports/cash-flow" \  -H "X-Business-Id: string"
{  "businessId": "123e4567-e89b-12d3-a456-426614174000",  "startDate": "2026-01-01",  "endDate": "2026-12-31",  "openingCash": 50000,  "operatingActivities": {    "sectionName": "Operating Activities",    "items": [      {        "item": "Net Income",        "amount": 45000,        "accountCode": "4000"      }    ],    "total": 32000  },  "investingActivities": {    "sectionName": "Operating Activities",    "items": [      {        "item": "Net Income",        "amount": 45000,        "accountCode": "4000"      }    ],    "total": 32000  },  "financingActivities": {    "sectionName": "Operating Activities",    "items": [      {        "item": "Net Income",        "amount": 45000,        "accountCode": "4000"      }    ],    "total": 32000  },  "netChangeInCash": 32000,  "closingCash": 82000,  "isReconciled": true,  "generatedAt": "2026-12-31T23:59:59.000Z"}