BizKitHub
DocsAPI ReferenceDashboard/bff/dashboard/overdue-invoices
getDashboardAdmin BFF

/bff/dashboard/overdue-invoices

Returns invoices past their due date grouped by aging buckets. Critical for B2B businesses to manage cash flow and credit risk.

DashboardgetBffDashboardOverdue-invoices

Parameters

No parameters required

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

Response schema

1 status code documented

200SuccessOverdue invoices summary with aging analysis.
totalOverduenumberRequired

Total value of all overdue invoices.

invoiceCountnumberRequired

Number of overdue invoices.

agingBucketsobjectRequired

Aging buckets for receivables analysis.

days1to7objectRequired

Invoices 1-7 days past due date.

amountnumberRequired

Total amount 1-7 days overdue.

countnumberRequired

Number of invoices 1-7 days overdue.

days8to30objectRequired

Invoices 8-30 days past due date.

amountnumberRequired

Total amount 8-30 days overdue.

countnumberRequired

Number of invoices 8-30 days overdue.

days31to60objectRequired

Invoices 31-60 days past due date.

amountnumberRequired

Total amount 31-60 days overdue.

countnumberRequired

Number of invoices 31-60 days overdue.

days61plusobjectRequired

Invoices more than 60 days past due date (high risk).

amountnumberRequired

Total amount 61+ days overdue.

countnumberRequired

Number of invoices 61+ days overdue.

topDebtorsobject[]Required

Top 5 customers with highest overdue amounts.

Each array item:

Customer with overdue invoices.

customerIdstringRequired

Customer external ID.

customerNamestringRequired

Customer name or email.

amountnumberRequired

Total overdue amount for this customer.

invoiceCountnumberRequired

Number of overdue invoices.

oldestDueDaysnumberRequired

Days since the oldest invoice was due.

currencystringRequired

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

Response example

application/json
{
  "totalOverdue": 0,
  "invoiceCount": 0,
  "agingBuckets": {
    "days1to7": {
      "amount": 0,
      "count": 0
    },
    "days8to30": {
      "amount": 0,
      "count": 0
    },
    "days31to60": {
      "amount": 0,
      "count": 0
    },
    "days61plus": {
      "amount": 0,
      "count": 0
    }
  },
  "topDebtors": [
    {
      "customerId": "example_customerId",
      "customerName": "example_customerName",
      "amount": 0,
      "invoiceCount": 0,
      "oldestDueDays": 0
    }
  ],
  "currency": "example_currency"
}

Request example

GET /bff/dashboard/overdue-invoices

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