DocsAPI ReferenceDashboard/bff/dashboard/cash-flow
getDashboardAdmin BFF

/bff/dashboard/cash-flow

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

DashboardgetBffDashboardCash-flow

Parameters

1 query

1 total
Query · 1
monthsnumber

Number of months to analyze. Defaults to 6.

Default: 6

Request

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"

Response

Cash flow analysis.

{
  "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"
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key