---
title: "Retrieve recurring invoice stats"
method: GET
path: "/companies/{company}/recurring-invoices/stats"
tags: ["Recurring Invoices"]
---

# Retrieve recurring invoice stats

`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`

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.

## Path parameters

- `company` string, uuid, required

## Headers

- `Factuarea-Version` string, date

## Response `200`

- object
  - `data` RecurringInvoiceStats, required: Aggregated summary of the recurring invoices of the authenticated company: counters by status, upcoming due dates, current-month generation/failures, breakdown by frequency, upcoming runs and estimated revenue. Returned by `GET /v1/companies/{company}/recurring-invoices/stats`.
    - `object` 'recurring_invoice_stats', required
    - `total` integer, required: Total number of recurring invoices.
    - `active` integer, required: Active recurrences (generating invoices).
    - `paused` integer, required: Paused recurring invoices (they can be resumed).
    - `cancelled` integer, required: Cancelled recurring invoices (terminal, irreversible status).
    - `completed` integer, required: Completed recurrences (reached `max_occurrences`). Reported as `0` until the repository provides the dedicated count.
    - `due_today` integer, required: Recurrences whose next run is today.
    - `due_this_week` integer, required: Recurrences whose next run falls in the current week.
    - `generated_this_month` integer, required: Invoices generated by recurrences during the current month.
    - `failed_this_month` integer, required: Recurrence runs that failed during the current month.
    - `frequency_breakdown` object, required: Recurrence count by frequency. Keys: `weekly`, `monthly`, `quarterly`, `yearly`, etc.
    - `next_scheduled` object[], required: Upcoming recurrences to run, ordered by run date ascending.
      - `id` string, nullable, required: Public identifier (UUID v7) of the recurring invoice.
      - `name` string, nullable, required: Name of the recurrence.
      - `next_run_date` string, date, nullable, required: Date of the next run (ISO 8601).
    - `estimated_revenue_this_month` string, required: Remaining scheduled template estimate from today through month end (EUR); it is not issued revenue, collections, or guaranteed cash.

## Other responses

- `400`: `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company. `profile_not_found`: the company in the path does not exist, is not in the API key scope or belongs to the other environment (live or test).
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)