finov.ioDocumentationHome

Cash flow

API Documentation / Resources / Reports

Get a cash flow report

GET /v1/tenants/{tenant_id}/subsidiaries/{subsidiary_id}/reports/cash-flow

Required OAuth scope: reports:read

Returns direct-method cash movement for an inclusive period.

Classification Includes
operating Day-to-day trading and operating cash movement
investing Acquisition or disposal of long-lived assets
financing Borrowing, capital, and owner distribution movement

bank_account_id restricts the report to one bank account. Without it, all active bank accounts in the subsidiary are included. The three classifications reconcile to net_movement.

Parameters

Name In Required Type Description
tenant_id path Yes string (uuid) UUID of the authorized company group.
subsidiary_id path Yes string (uuid) UUID of the subsidiary whose ledger is reported.
from_date query Yes string (date)
to_date query Yes string (date)
bank_account_id query No string (uuid)

Request

GET /v1/tenants/{tenant_id}/subsidiaries/{subsidiary_id}/reports/cash-flow HTTP/1.1
Host: api.finov.io
Authorization: Bearer {access_token}

Responses

Status Description
200 Cash flow report.
401 Access token is missing, expired, revoked, or invalid.
403 Token lacks reports:read or the granted accounting context.
404 A requested subsidiary, account, contact, or bank account is not available in the grant.
422 One or more report parameters failed validation.

200 example

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "report": "cash_flow",
    "from_date": "2026-07-01",
    "to_date": "2026-07-31",
    "currency_code": "NZD",
    "rows": [
      {
        "classification": "operating",
        "amount": "28450.0000"
      },
      {
        "classification": "investing",
        "amount": "-4800.0000"
      },
      {
        "classification": "financing",
        "amount": "0.0000"
      }
    ],
    "net_movement": "23650.0000",
    "generated_at": "2026-08-10T17:30:00Z"
  }
}