Recurring Invoices

Retrieve recurring invoice stats

Aggregate KPIs for your recurring invoices: counts by status, due today / this week, generated and failed this month, breakdown by frequency, next scheduled runs and estimated revenue this month.

get/companies/{company}/recurring-invoices/stats

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/recurring-invoices/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": {
    "object": "recurring_invoice_stats",
    "total": 24,
    "active": 18,
    "paused": 3,
    "cancelled": 2,
    "completed": 1,
    "due_today": 1,
    "due_this_week": 4,
    "generated_this_month": 11,
    "frequency_breakdown": {
      "monthly": 15,
      "quarterly": 5,
      "yearly": 4
    },
    "next_scheduled": [
      {
        "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a08",
        "name": "Cuota mantenimiento mensual Acme",
        "next_run_date": "2026-02-01"
      }
    ],
    "estimated_revenue_this_month": "5324.00"
  }
}

Changes

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