wafeq_reports_profit_and_loss_list
Generate a profit and loss report for a date range, currency, and grouping (month/year), with optional filters by branch, contact, project, or cost center to analyze financial performance.
Instructions
๐ข READ-ONLY ยท Reports ยท GET /reports/profit-and-loss/
Profit and Loss
Generate profit and loss 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 range must cover whole periods: with group_by=month (the default) it must run from the first day of a month to the last day of a month; with group_by=year it must run 1 January to 31 December. A partial year with group_by=year is rejected โ use group_by=month for a year-to-date figure. This server checks the range before sending and tells you the nearest valid one.
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. | |
| cost_center__in | No | The unique identifier of the cost center. Multiple values may be provided. The special value '__null__' may be provided to filter for null values. |