/bff/dashboard/cash-flow

Compares invoiced amounts vs actual cash received. Essential for financial planning - invoices ≠ cash in hand.

DashboardgetBffDashboardCash-flow

Parameters

1 query

Query parameters

· 1

monthsnumberOptional

Number of months to analyze. Defaults to 6.

Default: 6

Example6

Response schema

1 status code documented

200SuccessCash flow analysis.

currentMonthobjectRequired

invoicednumberRequired

Total invoiced this month.

receivednumberRequired

Total cash received this month.

gapnumberRequired

Difference between invoiced and received.

collectionRatenumberRequired

Collection rate (0-100%).

pendingInvoicesnumberRequired

Total value of unpaid invoices.

pendingOrdersnumberRequired

Total value of unpaid orders.

monthlyTrendobject[]Required

Monthly cash flow trend.

Each array item:

monthstringRequired

Month (YYYY-MM).

invoicednumberRequired

Amount invoiced.

receivednumberRequired

Amount received.

gapnumberRequired

Cash flow gap.

currencystringRequired

Currency code.

Response example

application/json

{
  "currentMonth": {
    "invoiced": 0,
    "received": 0,
    "gap": 0,
    "collectionRate": 0
  },
  "pendingInvoices": 0,
  "pendingOrders": 0,
  "monthlyTrend": [
    {
      "month": "example_month",
      "invoiced": 0,
      "received": 0,
      "gap": 0
    }
  ],
  "currency": "example_currency"
}

Request example

GET /bff/dashboard/cash-flow

get

curl -X GET "https://api.bizkithub.com/bff/dashboard/cash-flow?months=6" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key