---
title: "Get purchase scanner stats"
method: GET
path: "/companies/{company}/purchase-scans/stats"
tags: ["Purchase Scans"]
---

# Get purchase scanner stats

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

## Request

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

Aggregated counters of the purchase scanner for your company: documents in progress, pending review and with incidents, plus per-status counts. Returned as `{ "data": PurchaseScanStats }`.

## Path parameters

- `company` string, uuid, required

## Query parameters

- `scope` 'inbox' | 'history'

## Headers

- `Factuarea-Version` string, date

## Response `200`

Successful scanner operation.

- object
  - `data` PurchaseScanStats, required
    - `processing` integer, required
    - `needs_review` integer, required
    - `incidents` integer, required
    - `received` integer, required
    - `queued` integer, required
    - `failed` integer, required
    - `duplicate` integer, required
    - `facets` object, required
      - `by_status` object, required
        - `received` integer, required
        - `queued` integer, required
        - `processing` integer, required
        - `needs_review` integer, required
        - `duplicate` integer, required
        - `failed` integer, required
        - `auto_created` integer, required
        - `created` integer, required
        - `archived` integer, required
      - `by_source` object, required
        - `upload` integer, required
        - `email` integer, required
        - `api` integer, required
      - `by_document_kind` object, required
        - `invoice` integer, required
        - `simplified_qualified` integer, required
        - `ticket` integer, required
        - `delivery_note` integer, required
        - `other` integer, required
        - `undetermined` integer, required
      - `by_file_kind` object, required
        - `pdf` integer, required
        - `image` integer, required
      - `by_supplier_link_state` object, required
        - `linked` integer, required
        - `pending_link` integer, required
        - `unidentified` integer, required
      - `by_supplier` object[], required: Suppliers with at least one linked scan in scope, ordered by count desc then name asc, capped at 100.
        - `id` string, uuid, required
        - `name` string, required
        - `count` integer, required
      - `with_issues` integer, required

## Other responses

- `400`: The operation failed. Possible `error.code` values: `parameter_unknown` — the query contains a parameter this operation does not accept.
- `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`). `company_inactive`: the company in the path is deactivated; reactivate it to operate.
- `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).
- `422`: The request could not be validated. Possible `error.code` values: `invalid_param_value` — a recognized query parameter has an invalid value.
- `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)