/bff/invoice/stats

Returns aggregate invoice statistics - counts and amounts by payment status, document type, and status. Useful for dashboards and reports.

InvoicegetBffInvoiceStats

Parameters

2 query

2 total

Query · 2

dateFromstring

Date from (ISO format: YYYY-MM-DD).

dateTostring

Date to (ISO format: YYYY-MM-DD).

Request

GET /bff/invoice/stats

get

curl -X GET "https://api.bizkithub.com/bff/invoice/stats?dateFrom=2026-01-01&dateTo=2026-03-31" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Invoice statistics.

{
  "summary": {
    "totalCount": 0,
    "paidCount": 0,
    "unpaidCount": 0,
    "overdueCount": 0,
    "totalAmount": 0,
    "paidAmount": 0,
    "unpaidAmount": 0,
    "overdueAmount": 0
  },
  "byType": [
    {
      "type": "example_type",
      "count": 0,
      "amount": 0
    }
  ],
  "byStatus": [
    {
      "status": "example_status",
      "count": 0,
      "amount": 0
    }
  ]
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key