---
title: "Get cash forecasting report"
method: GET
path: "/v3/reports/cash-forecasting"
tags: ["Reports"]
---

# Get cash forecasting report

`GET /v3/reports/cash-forecasting`

Retrieves a paginated cash forecasting report showing due and paid amounts per period for each customer

## Query parameters

- `page` number
- `limit` number
- `filter` string

## Response `200`

Successfully retrieved cash forecasting report

- object
  - `payload` object, required — Response payload, will be empty when success is false
    - `data` CashForecastingReportDto[]
      - `customerId` string, uuid, required — ID of the customer
      - `customerName` string, required — Name of the customer
      - `cashForecastingPerPeriod` CashForecastingPerPeriodDto[], required — Array of cash forecasting data per period
        - `period` string, required — The time period for the forecast
        - `dueTotal` number, required — Total amount due for the period
        - `paidTotal` number, required — Total amount paid for the period
        - `total` number, required — Total amount (due + paid) for the period
    - `limit` number
    - `totalItems` number
    - `currentPage` number
  - `success` boolean, required — Boolean with true=success, false=failure
  - `message` string, required — Plain-text description of the result
  - `error` IntegratorsApiError, required
    - `code` number, required — API response code
    - `message` string, required — API response message
    - `details` object — Additional details about the error

## Other responses

- `401` — Unauthorized - Invalid or missing API key

---

[API](https://skmtc.net/tabsplatform/apis/tabs-external-api.md) · [All operations](https://skmtc.net/tabsplatform/apis/tabs-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tabsplatform/tabs-external-api/revisions/7e8885517814/schema)