Series

Get series stats

Aggregated KPIs for your document numbering series: total series count, active and archived counts, and a breakdown by document type. Returned as { "data": SeriesStats }.

get/companies/{company}/series/stats

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/series/stats
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

Example response

{
  "data": {
    "total": 17,
    "invoice": 5,
    "quote": 2,
    "delivery_note": 3,
    "proforma": 4
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.