---
title: "Get expense stats"
method: GET
path: "/companies/{company}/purchase-invoices/stats"
tags: ["Purchase Invoices"]
---

# Get expense stats

`GET /companies/{company}/purchase-invoices/stats`

## Request

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

Aggregated KPIs for your expenses: total count and amount, counts per status, pending and overdue totals, and amounts by supplier. Returned as `{ "data": PurchaseInvoiceStats }`.

## Path parameters

- `company` string, uuid, required

## Headers

- `Factuarea-Version` string, date

## Response `200`

- object
  - `data` PurchaseInvoiceStats, required: Aggregated metrics (KPIs) of the expenses of the authenticated company: total, count by status and accumulated amounts. `overdue` is a derived condition (`pending` + past due date), not a persisted status.
    - `object` 'purchase_invoice_stats', required
    - `total_invoices` integer, required: Total number of expenses.
    - `by_status` object, required: Invoice count by status (key = status, value = number of invoices). Keys: `draft`, `pending`, `paid`, `cancelled` (persisted statuses) plus `overdue` (derived KPI: overdue subset of `pending`).
    - `pending` integer, required: Number of invoices pending payment.
    - `draft` integer, required: Number of draft invoices.
    - `paid` integer, required: Number of paid invoices.
    - `cancelled` integer, required: Number of cancelled invoices.
    - `overdue` integer, required: Number of overdue and unpaid invoices (subset of `pending` with a past due date).
    - `total_amount` string, required: Total aggregate amount of all expenses.
    - `pending_amount` string, required: Total amount pending payment.
    - `paid_amount` string, required: Total amount already paid.

## 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)