BizKitHub
DocsAPI ReferenceDashboard/bff/dashboard/unpaid-orders
getDashboardAdmin BFF

/bff/dashboard/unpaid-orders

Returns summary of orders awaiting payment. Critical for identifying revenue at risk and orders requiring follow-up.

DashboardgetBffDashboardUnpaid-orders

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200SuccessUnpaid orders summary with expiration breakdown.
totalAmountnumberRequired

Total value of all unpaid orders.

orderCountnumberRequired

Number of unpaid orders.

expiringWithin24hobjectRequired

Orders at imminent risk of expiration.

amountnumberRequired

Value of orders expiring within 24 hours.

countnumberRequired

Count of orders expiring within 24 hours.

expiringWithin7dobjectRequired

Orders expiring soon.

amountnumberRequired

Value of orders expiring within 7 days.

countnumberRequired

Count of orders expiring within 7 days.

oldestUnpaidDaysnumberOptional

Age of the oldest unpaid order in days. Undefined if no unpaid orders.

currencystringRequired

Currency code for all amounts (e.g., "CZK").

Response example

application/json
{
  "totalAmount": 0,
  "orderCount": 0,
  "expiringWithin24h": {
    "amount": 0,
    "count": 0
  },
  "expiringWithin7d": {
    "amount": 0,
    "count": 0
  },
  "oldestUnpaidDays": 0,
  "currency": "example_currency"
}

Request example

GET /bff/dashboard/unpaid-orders

get
curl -X GET "https://api.bizkithub.com/bff/dashboard/unpaid-orders" \
  -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