> ## Documentation Index
> Fetch the complete documentation index at: https://docs.toku.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Quick Books Connection Status

> Reports the client's QuickBooks connection state, dry-run, sheet URLs, token expiry and a live company-info ping.

Not available to API keys yet. It will need `integrations:write`.

## OpenAPI

````yaml api-reference/openapi.json GET /platform/get-quick-books-connection-status
openapi: 3.1.0
info:
  title: Toku API
  version: 1.0.0
servers:
  - url: https://api.toku.com
security:
  - bearerAuth: []
paths:
  /platform/get-quick-books-connection-status:
    get:
      operationId: getQuickBooksConnectionStatus
      summary: Get Quick Books Connection Status
      description: >-
        Reports the client's QuickBooks connection state, dry-run, sheet URLs,
        token expiry and a live company-info ping.


        Not available to API keys yet. It will need `integrations:write`.
      parameters:
        - name: clientId
          in: query
          required: false
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetQuickBooksConnectionStatusResponse'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '409':
          description: Conflict
        '429':
          description: Response 429
components:
  schemas:
    GetQuickBooksConnectionStatusResponse:
      type: object
      properties:
        connectionId:
          type:
            - string
            - 'null'
        clientId:
          type: string
        connected:
          type: boolean
        status:
          type: string
          enum:
            - PENDING_PRECONDITION
            - ACTIVE
            - EXPIRED
            - DISCONNECTED
        dryRun:
          type: boolean
        journalEntryGroupingMode:
          type: string
        multiCurrencyEnabled:
          type:
            - boolean
            - 'null'
        eorPeoSheetUrl:
          type:
            - string
            - 'null'
        contractorSheetUrl:
          type:
            - string
            - 'null'
        livePingSucceeded:
          type: boolean
        tokenExpiresAt:
          type:
            - string
            - 'null'
        refreshTokenExpiresAt:
          type:
            - string
            - 'null'
        daysUntilRefreshTokenExpiry:
          type:
            - integer
            - 'null'
        connectionEnvironment:
          type:
            - string
            - 'null'
          enum:
            - SANDBOX
            - PRODUCTION
            - null
        oauthSetup:
          type:
            - object
            - 'null'
          additionalProperties: {}
        hrisPayrollEnabled:
          type: boolean
        hrisPayrollProvider:
          type:
            - string
            - 'null'
      required:
        - connectionId
        - clientId
        - connected
        - status
        - dryRun
        - journalEntryGroupingMode
        - multiCurrencyEnabled
        - eorPeoSheetUrl
        - contractorSheetUrl
        - livePingSucceeded
        - tokenExpiresAt
        - refreshTokenExpiresAt
        - daysUntilRefreshTokenExpiry
        - connectionEnvironment
        - oauthSetup
        - hrisPayrollEnabled
        - hrisPayrollProvider
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
````
