---
title: "QuickBooks read state, coverage, books state and gaps for an assigned customer (#2821)"
method: GET
path: "/accountant/companies/{customerId}/integrations/quickbooks/status"
tags: ["Accountants"]
---

# QuickBooks read state, coverage, books state and gaps for an assigned customer (#2821)

`GET /accountant/companies/{customerId}/integrations/quickbooks/status`

## Request

- Base URL: `https://api.medianfi.com/api/v1`
- URL: `https://api.medianfi.com/api/v1/accountant/companies/{customerId}/integrations/quickbooks/status`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

## Response `200`

The customer-facing QuickBooks status

- object
  - `success` true, required
  - `data` QuickBooksCustomerStatus, required
    - `readState` 'disabled' | 'connected_no_import' | 'importing' | 'source_ready' | 'failed' | 'stale', required
    - `lastSuccessfulReadAt` string, date-time, nullable, required
    - `latestAttemptAt` string, date-time, nullable, required
    - `readFailure` object, nullable, required
      - `code` string, required
      - `reason` string, required: Plain-language reason shown to the customer
    - `coverage` object, required
      - `byType` object[], required
        - `objectType` 'Account' | 'JournalEntry' | 'Purchase' | 'Deposit' | 'Transfer' | 'Payment' | 'BillPayment' | 'Bill' | 'Invoice' | 'SalesReceipt' | 'CreditMemo' | 'RefundReceipt' | 'VendorCredit' | 'Item' | 'TaxCode' | 'TaxRate' | 'TaxAgency', required
        - `count` integer, required
        - `earliestTxnDate` string, date, nullable, required
        - `latestTxnDate` string, date, nullable, required
      - `bankAndCardAccounts` integer, required: QuickBooks Bank and Credit Card accounts read
      - `bankFeedReviewQueue` object, required
        - `available` false, required
        - `note` string, required
    - `booksState` object, required
      - `state` 'not_started' | 'held_for_review' | 'posted_through', required: not_started - no posting cutoff; held_for_review - a batch awaits the accountant, a change review is open, items are blocked, or nothing is posted yet; posted_through - the latest posted batch's end date with nothing held.
      - `cutoffDate` string, date, nullable, required
      - `postedThrough` string, date, nullable, required
      - `pendingBatches` integer, required
      - `openChangeReviews` integer, required
    - `gaps` object, required
      - `blockedItems` integer, required
      - `byCode` object[], required
        - `code` string, required
        - `label` string, required
        - `count` integer, required

## Other responses

- `401`: Authentication required
- `403`: Insufficient permissions or not a company member
- `422`: QuickBooks is not connected or needs reauthorizing (QUICKBOOKS_LEDGER_NOT_CONNECTED, QUICKBOOKS_LEDGER_NEEDS_REAUTH), the connection changed, or source sync is switched off (QUICKBOOKS_SOURCE_SYNC_DISABLED, POST only)
- `503`: Source sync or the provider is unavailable

---

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