---
title: "Cash Flow"
method: GET
path: "/reports/cash-flow/"
tags: ["Reports"]
---

# Cash Flow

`GET /reports/cash-flow/`

Generate cash flow report in `currency` from `date_after` to `date_before` range and group it by `group_by` parameter.

## Query parameters

- `branch__in` string[]
- `contact__in` string[]
- `cost_center__in` string[]
- `currency` 'AED' | 'SAR' | 'USD' | 'EUR' | 'CAD' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BND' | 'BOB' | 'BRL' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'GBP' | 'GEL' | 'GHS' | 'GNF' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KZT' | 'LBP' | 'LKR' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SDG' | 'SEK' | 'SGD' | 'SOS' | 'SYP' | 'THB' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'XAF' | 'XOF' | 'YER' | 'ZAR' | 'ZMW'
- `date_after` string, date, required
- `date_before` string, date, required
- `group_by` 'month' | 'year'
- `project__in` string[]

## Response `200`

- ApiV1ExternalReportsCashFlowRead[]
  - `columns` ApiV1ExternalReportsCashFlowRowColumnRead[], required — The columns of the report
    - `id` string, required — The id of the column
    - `label` string, required — The label of the column
    - `metadata` object, required — The metadata of the column
  - `overview` ApiV1ExternalReportsCashFlowOverviewRead, required
    - `created_ts` string, date-time, required — The timestamp in UTC when the report was created
    - `currency` string, required — The currency of the report
    - `date_from` string, date, required — The start date of the report
    - `date_to` string, date, required — The end date of the report
    - `filters` object, required — The filters of the report
    - `group_by` string, required — The grouping of the report
    - `id` string, required — The id of the report
    - `label` string, required — The title of the report
  - `rows` ApiV1ExternalReportsCashFlowSectionRead[], required — The rows of the report
    - `children` ApiV1ExternalReportsCashFlowDataRead[], required — The children of the section
      - `children` object[], required — The children of the row. The value is the same as children of the section
      - `id` string, required — The id of the row
      - `label` string, required — The label of the row
      - `metadata` object, required — The metadata of the row
      - `summary` ApiV1ExternalReportsCashFlowRowSummaryRead, required
        - `id` string, required — The id of the summary
        - `label` string, required — The label of the summary
        - `metadata` object, required — The metadata of the summary
        - `sub_totals` number[], required — The sub totals of the row
      - `values` number[], required — The values of the row
    - `group` string, required — The group of the section
    - `id` string, required — The id of the section
    - `label` string, required — The label of the section
    - `metadata` object, required — The metadata of the section
    - `summary` ApiV1ExternalReportsCashFlowRowSummaryRead, required
      - `id` string, required — The id of the summary
      - `label` string, required — The label of the summary
      - `metadata` object, required — The metadata of the summary
      - `sub_totals` number[], required — The sub totals of the row

---

[API](https://skmtc.net/wafeq/apis/wafeq-public-api.md) · [All operations](https://skmtc.net/wafeq/apis/wafeq-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wafeq/wafeq-public-api/revisions/36816b4fce7f/schema)