Cash Flow Report

Production

GET

/api2/reports/cash_flow

Cash flow for a period, as the account has configured it: sections (by default Operations, Investments, Finance), each with its rows and a section total, and a grand Total Change in Cash Flow.

Mirrors /owner/reports/cash_flow.

Sections and rows are the account's own settings, so key off key, never title -- titles are translated and can be renamed, and an account can add or hide rows. A hidden row is absent. Figures are raw numbers in the base currency; cash out is negative. There is no currency filter.

Not paginated. An account whose Cash Flow settings define more than 100 visible rows (a per-deployment ceiling) is answered 400 rather than truncated.

Requires the View all journals permission -- stricter than the report screen itself.

Request

Authorization

OAuth 2.0

Password

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://www.daftra.com/v2/oauth/token

API Key

Add parameter in header

apikey

Example:

apikey: ********************

API Key

Add parameter in cookie

OISystem

Example:

OISystem: ********************

Query Params

Header Params

Responses

🟢200

application/json

The report.

Bodyapplication/json

🟠400Error400

🟠401Error401

🟠403Error403

🟠404Error404

🟠405Error405

🔴500Error500

🔴503Error503

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api2/reports/cash_flow?date_from=2025-01-01&date_to=2025-12-31&branch_id=1' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--header 'apikey: ' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "result": "successful",
    "code": 200,
    "data": {
        "report": {
            "key": "cash_flow",
            "title": "Cash Flow Report",
            "currency": "SAR"
        },
        "filters": {
            "date_from": "2025-01-01",
            "date_to": "2025-12-31",
            "branch_id": [
                1
            ]
        },
        "sections": [
            {
                "key": "cash_flow_from_finance",
                "title": "Cash Flow From Finance",
                "total_title": "Total Cash Flow From Finance",
                "total": 50000,
                "rows": [
                    {
                        "key": "common_shares",
                        "title": "Increase in Common Shares",
                        "total": 50000
                    }
                ]
            }
        ],
        "totals": {
            "label": "Total Change in Cash Flow",
            "total_change_in_cash": 50000
        },
        "meta": {
            "section_count": 1,
            "row_count": 1
        }
    }
}

Income Statement Report

Financial Transactions Report