---
title: "Get proforma stats"
method: GET
path: "/companies/{company}/proformas/stats"
tags: ["Proformas"]
---

# Get proforma stats

`GET /companies/{company}/proformas/stats`

## Request

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

Aggregated KPIs for the authenticated company: total proforma count and amount, count per status, expired count, and count converted to invoice. Returned as `{ "data": ProformaStats }`.

## Path parameters

- `company` string, uuid, required

## Headers

- `Factuarea-Version` string, date

## Response `200`

- object
  - `data` ProformaStats, required: Aggregated summary of the proformas of the authenticated company: total, accumulated amount, breakdown by status (with count and amount), conversion-to-invoice ratio, those about to expire and average value. Returned by `GET /v1/companies/{company}/proformas/stats`.
    - `total_count` integer, required: Total number of recorded proformas.
    - `total_amount` string, required: Aggregate amount of the proformas (EUR), as a 2-decimal string.
    - `by_status` object, required: Breakdown by status. Keys: `draft`, `accepted`, `rejected`, `cancelled`, `expired`, `converted`.
    - `conversion_rate` number, required: Conversion-to-invoice ratio (invoiced proformas / total), as a percentage from 0 to 100 with up to 2 decimals.
    - `expiring_soon` integer, required: Proformas whose `valid_until` date expires in the coming days.
    - `average_value` string, required: Average value of the proformas (EUR), as a 2-decimal string.

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