---
title: "Get active check-quarantine inventory"
method: GET
path: "/check-quarantine/inventory"
tags: ["Banking"]
---

# Get active check-quarantine inventory

`GET /check-quarantine/inventory`

## Request

- Base URL: `https://ledgerhq.pro/api/v1`
- URL: `https://ledgerhq.pro/api/v1/check-quarantine/inventory`
- Auth: one of:
  - HTTP bearer and API key in header `x-organization-id`
  - HTTP bearer and API key in header `x-organization-id`

Pure active-only inventory for one firm-managed company named by x-organization-id. Never prepares proposals or enqueues OCR. OAuth scope bank_transactions:read. Permission view:data. Firm owner/admin may target any active company; Staff Member/Advisor may target assigned companies only. Client-portal and cross-firm targets return 404 without leaking counts.

## Response `200`

Active check-quarantine inventory

- object
  - `data` CheckQuarantineInventory, required
    - `companyOrganizationId` string, uuid, required
    - `firmOrganizationId` string, uuid, required
    - `firmPackage` 'core' | 'tally', required
    - `generatedAt` string, date-time, required
    - `counts` object, required
      - `active` integer, required
      - `aged` integer, required
      - `waiting` integer, required
      - `machineActionable` integer, required
      - `humanInput` integer, required
      - `byBucket` object, required
    - `items` CheckQuarantineInventoryItem[], required
      - `bankTransactionId` string, uuid, required
      - `bankAccountId` string, uuid, required
      - `date` string, date, required
      - `amountCents` integer, required
      - `checkNumber` string, nullable, required
      - `bucket` 'awaiting_statement' | 'ocr_queued' | 'ocr_processing' | 'awaiting_check_image' | 'image_needs_review' | 'prepared_existing_entry' | 'prepared_card_transfer' | 'prepared_category_pattern' | 'prepared_category_payee_only' | 'special_accounting' | 'supervised_resolution', required
      - `aged` boolean, required
      - `evidenceId` string, uuid, nullable, required
      - `evidenceVersion` string, nullable, required
      - `proposal` CheckQuarantineProposal, nullable, required
        - `resolutionType` 'existing_entry' | 'transfer' | 'category', required
        - `targetId` string, uuid, required
        - `rationale` string, nullable, required
      - `action` CheckQuarantineAction, required
        - `kind` 'waiting' | 'humanInput' | 'machineActionable', required
        - `reason` 'tally_entitlement_inactive' | 'supervised_package' | 'null', nullable, required
        - `recheckAt` string, date-time, nullable, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Company not found
- `default`: Error response

---

[API](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api.md) · [All operations](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/revisions/9a8269f0a586?raw)
