---
title: "Read documents queue"
method: GET
path: "/accountant/documents/queue"
tags: ["Accountant Portal"]
---

# Read documents queue

`GET /accountant/documents/queue`

## Request

- Base URL: `https://api.medianfi.com/api/v1`
- URL: `https://api.medianfi.com/api/v1/accountant/documents/queue`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

One offset-paged page of the documents queue across every assigned customer, newest upload first by default (#2015). `data` is a bare array of at most `meta.limit` rows; page with `offset`.

## Query parameters

- `limit` integer
- `offset` integer
- `search` string
- `type` 'invoice' | 'bill' | 'receipt' | 'contract' | 'statement'
- `status` 'needs_review' | 'pending_payment' | 'reviewed' | 'paid' | 'processed' | 'archived'
- `sort` 'uploaded_desc' | 'uploaded_asc' | 'doc_desc' | 'doc_asc'
- `clientStatuses` string

## Response `200`

One page of the documents queue. `meta.total` is the row count AFTER the `status` filter; `meta.totalByStatus` and `meta.metrics` are counted BEFORE it, so the summary cards stay populated while a status is selected. The two denominators answer different questions and are expected to differ (#2015).

- object
  - `success` boolean
  - `data` object[]
    - `possibleDuplicateOf` object, nullable: The earlier document this one repeats: same type, counterparty (vendor, else customer), invoice number, document date and amount (#2738). Null when there is none, or when the earlier document is not listed in the queue. Informational; no status or count depends on it.
      - `id` string, uuid, required
      - `fileName` string, required: The earlier document's file name as the queue shows it for that row.
  - `meta` object
    - `total` integer: Rows matching every filter including `status`. This is the denominator the table pages through.
    - `limit` integer
    - `offset` integer
    - `hasMore` boolean
    - `totalByStatus` object: Per-status counts over the search/type-filtered queue, NOT narrowed by `status`.
    - `metrics` object: Summary-card totals derived from `totalByStatus`; likewise not narrowed by `status`.

## Other responses

- `401`: Authentication required
- `403`: Insufficient permissions or not a company member

---

[API](https://skmtc.dev/medianfi/apis/median-api.md) · [All operations](https://skmtc.dev/medianfi/apis/median-api/llms.txt) · [OpenAPI document](https://skmtc.dev/medianfi/apis/median-api/revisions/20090ea32b0d?raw)