wafeq_reports_cash_flow_list
Create a cash flow report for any date range, grouped by month or year, and in your preferred currency. Use optional branch, contact, or project filters to focus the analysis.
Instructions
๐ข READ-ONLY ยท Reports ยท GET /reports/cash-flow/
Cash Flow
Generate cash flow report in currency from date_after to date_before range and group it by group_by parameter.
PARAMETERS: date_after and date_before are both REQUIRED and are the range bounds. There is no date_from/date_to. The same whole-period rule as profit-and-loss applies and is checked before sending.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| currency | No | The currency of the report. Default: base currency of the organization. | |
| group_by | No | Group the report by this value. | month |
| branch__in | No | The unique identifier of the branch. Multiple values may be provided. The special value '__null__' may be provided to filter for null values. | |
| date_after | Yes | The period start date of the report. Must be the first day of the month/year. | |
| contact__in | No | The unique identifier of the contact. Multiple values may be provided. The special value '__null__' may be provided to filter for null values. | |
| date_before | Yes | The period end date of the report. Must be the last day of the month/year. | |
| project__in | No | The unique identifier of the project. Multiple values may be provided. The special value '__null__' may be provided to filter for null values. |