BizKitHub
DocsAPI ReferenceInvoice/bff/document/stats
getInvoiceAdmin BFF

/bff/document/stats

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

InvoicegetBffDocumentStats

Parameters

2 query

Query parameters

· 2
dateFromstringOptional

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

Example2026-01-01
dateTostringOptional

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

Example2026-03-31

Response schema

1 status code documented

200SuccessInvoice statistics.
summaryobjectRequired

Summary statistics.

totalCountnumberRequired

Total number of invoices.

paidCountnumberRequired

Number of paid invoices.

unpaidCountnumberRequired

Number of unpaid invoices.

overdueCountnumberRequired

Number of overdue invoices.

totalAmountnumberRequired

Total invoiced amount.

paidAmountnumberRequired

Paid amount.

unpaidAmountnumberRequired

Unpaid amount.

overdueAmountnumberRequired

Overdue amount.

byTypeobject[]Required

Statistics by document type.

Each array item:
typestringRequired

Document type.

countnumberRequired

Count.

amountnumberRequired

Total amount.

byStatusobject[]Required

Statistics by status.

Each array item:
statusstringRequired

Status.

countnumberRequired

Count.

amountnumberRequired

Total amount.

Response example

application/json
{
  "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
    }
  ]
}

Request example

GET /bff/document/stats

get
curl -X GET "https://api.bizkithub.com/bff/document/stats?dateFrom=2026-01-01&dateTo=2026-03-31" \
  -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