BizKitHub
DocsAPI ReferenceInvoice/bff/document/analytics-by-issuer-and-month
getInvoiceAdmin BFF

/bff/document/analytics-by-issuer-and-month

Per-currency rollups powering the invoice Analytics tab. Sums are NEVER cross-currency — an org can invoice in multiple currencies and adding them would be misleading, so the client renders one section per currency. Returns three parallel rollups over the same filtered set: byIssuer (aggregated across months), byMonth (aggregated across issuers), and byIssuerMonth (the full pivot for a matrix view).

InvoicegetBffDocumentAnalytics-by-issuer-and-month

Parameters

2 query

Query parameters

· 2
yearstringOptional

Calendar year (4-digit) to restrict to.

Example2026
issuerIdstringOptional

External issuer contact id to restrict to.

ExampleaB3xKm9pQ2wLn4Yz

Response schema

1 status code documented

200Success
yearnumber | nullRequired

The year that was applied, or null for "all history".

One of 2:
Variant 1
number
Variant 2
null
currenciesstring[]Required

Distinct currency codes present in the result. Sorted alphabetically.

byIssuerobject[]Required
Each array item:
issuerIdstringRequired
issuerNamestringRequired
currencystringRequired
countnumberRequired
totalAmountnumberRequired
byMonthobject[]Required
Each array item:
monthstringRequired

YYYY-MM.

currencystringRequired
countnumberRequired
totalAmountnumberRequired
byIssuerMonthobject[]Required
Each array item:
issuerIdstringRequired
monthstringRequired

YYYY-MM.

currencystringRequired
countnumberRequired
totalAmountnumberRequired

Response example

application/json
{
  "currencies": [
    "string"
  ],
  "byIssuer": [
    {
      "issuerId": "example_issuerId",
      "issuerName": "example_issuerName",
      "currency": "example_currency",
      "count": 0,
      "totalAmount": 0
    }
  ],
  "byMonth": [
    {
      "month": "example_month",
      "currency": "example_currency",
      "count": 0,
      "totalAmount": 0
    }
  ],
  "byIssuerMonth": [
    {
      "issuerId": "example_issuerId",
      "month": "example_month",
      "currency": "example_currency",
      "count": 0,
      "totalAmount": 0
    }
  ]
}

Request example

GET /bff/document/analytics-by-issuer-and-month

get
curl -X GET "https://api.bizkithub.com/bff/document/analytics-by-issuer-and-month?year=2026&issuerId=aB3xKm9pQ2wLn4Yz" \
  -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