> For the complete documentation index, see [llms.txt](https://docs.shortcutco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shortcutco.com/developers/api-reference/reference/objects/quickbooks-status.md).

# The QuickBooks status object

The quickbooks status object in the Shortcut API - every field, an example, and the endpoints that return it.

Whether QuickBooks is connected and how its sync is going.

## Fields

| Field                  | Type                                                                                                                                                                | Description                                                                                      |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| `object`               | `"quickbooks_status"`                                                                                                                                               | Always `quickbooks_status`.                                                                      |
| `connected`            | boolean                                                                                                                                                             | Whether QuickBooks is connected and syncing.                                                     |
| `status`               | `not_connected`, `setup_incomplete`, `active`, `paused_reconnect_required`, `paused_rate_limited`, `paused_repeated_failures`, `temporarily_paused`, `disconnected` | Where the connection stands. A `paused_*` status needs a company admin in Settings > QuickBooks. |
| `companyName`          | string or null                                                                                                                                                      | The QuickBooks company it syncs with.                                                            |
| `lastSuccessfulSyncAt` | timestamp or null                                                                                                                                                   | When a record last synced.                                                                       |
| `waiting`              | integer                                                                                                                                                             | Records queued to sync.                                                                          |
| `needsReview`          | integer                                                                                                                                                             | Records that need a person in Settings > QuickBooks before they can sync.                        |
| `failed`               | integer                                                                                                                                                             | Records that failed to sync.                                                                     |

## Example

```json
{
  "object": "quickbooks_status",
  "connected": true,
  "status": "not_connected",
  "companyName": null,
  "lastSuccessfulSyncAt": null,
  "waiting": 1,
  "needsReview": 1,
  "failed": 1
}
```

## Endpoints

| Endpoint                          | What it does               |
| --------------------------------- | -------------------------- |
| `GET /v1/integrations/quickbooks` | Get QuickBooks sync status |
