Stats API

An at-a-glance summary of your account: resource counts, a breakdown of documents by status, and your most recent documents. It gives integrations a cheap overview without paging through every collection.

Get Stats

GET /api/v1/stats

Returns counts, the document status breakdown, and up to the 10 most recent documents (newest first), all scoped to the authenticated account.

Response:

{
  "data": {
    "counts": {
      "invoices": 128,
      "customers": 42,
      "business_profiles": 3
    },
    "invoice_status_counts": {
      "draft": 12,
      "finalized": 8,
      "sent": 30,
      "paid": 70,
      "void": 5,
      "archived": 3
    },
    "recent_invoices": [
      {
        "id": "doc_01XYZ",
        "invoice_number": "INV-1042",
        "document_type": "invoice",
        "status": "paid",
        "currency": "USD",
        "total_amount": "1240.00",
        "issue_date": "2026-07-28"
      }
    ]
  }
}

counts

Total number of each resource in your account.

Field	Description
invoices	Total number of documents (invoices)
customers	Total number of customers
business_profiles	Total number of business profiles

invoice_status_counts

Number of documents in each status. Every status is always present; a status with no documents reports 0.

Status	Description
draft	Editable, not yet finalized
finalized	Finalized and immutable
sent	Delivered to the customer
paid	Marked as paid
void	Voided
archived	Archived

recent_invoices

The 10 most recently created documents, newest first.

Field	Description
id	Document ID
invoice_number	Document number
document_type	Document type (e.g. invoice, credit_note)
status	Current status
currency	ISO 4217 currency code
total_amount	Document total, as a string
issue_date	Issue date (ISO 8601, e.g. 2026-07-28)

Try it