QuickBooks Entitlements API

openapi: 3.2.0
info:
  title: QuickBooks Online Accounting Entitlements API
  version: '2026-11-05'
  description: QuickBooks Online Accounting API (v3). Entities, reports, query, batch and change-data-capture operations for a QuickBooks Online company (realmId). Generated from the JSON Intuit's API Explorer renders; Intuit publishes no OpenAPI document.
  termsOfService: https://developer.intuit.com/app/developer/qbo/docs/legal-agreements/intuit-terms-of-service-for-intuit-developer-services
  contact:
    name: Intuit Developer Support
    url: https://help.developer.intuit.com/s/
  x-generated-from: documentation
  x-generator: convert-intuit-api-explorer.py (deterministic conversion of the provider's API Explorer JSON; no model)
  x-source:
  - https://static.developer.intuit.com/JSONObjects/EntityJsonObject_v1.json
  - https://static.developer.intuit.com/JSONObjects/CodesModelsJsonObjects_v2.json
  - https://static.developer.intuit.com/JSONObjects/TocJsonObject_v1.json
  x-generated: '2026-11-05'
servers:
- url: https://quickbooks.api.intuit.com
  description: Production
- url: https://sandbox-quickbooks.api.intuit.com
  description: Sandbox
security:
- oauth2:
  - com.intuit.quickbooks.accounting
tags:
- name: Entitlements
  description: 'The Entitlements resource retrieves the features available to a company, identified by the company''s realmID. The features available are determined by the type of company established during QuickBooks Online setup. These features are a super set of those enabled for the company by preferences and those enabled for a user by permissions.


    Note: This resource does not accept an application/json header. Use application/xml as the accept header.'
paths:
  /entitlements/v3/{realmID}:
    get:
      operationId: readEntitlements
      summary: Read entitlements
      tags:
      - Entitlements
      x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/entitlements
      x-intuit-operation: GET /entitlements/v3/<realmID>
      description: Retrieves the entitlements details.
      parameters:
      - name: realmID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/entitlementsresponse'
              example: "<EntitlementsResponse>\n  <QboCompany>true</QboCompany>\n  <PlanName>QBWEBPLUSPAYROLLMONTHLY</PlanName>\n  <MaxUsers>10</MaxUsers>\n  <CurrentUsers>4</CurrentUsers>\n  <DaysRemainingTrial>0</DaysRemainingTrial>\n  <Entitlement id=\"7\">\n    <name>PayPal</name>\n    <term>Off</term>\n  </Entitlement>\n  <Entitlement id=\"8\">\n    <name>Merchant Service</name>\n    <term>Off</term>\n  </Entitlement>\n  <Entitlement id=\"1\">\n    <name>Class Tracking</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"3\">\n    <name>Expense Tracking by Customer</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"4\">\n    <name>Time Tracking</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"5\">\n    <name>Budgets</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"6\">\n    <name>Custom Invoice Styles</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"9\">\n    <name>1099 Forms for Vendors</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"10\">\n    <name>Managing Bills to Pay Later</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"11\">\n    <name>Complete Set of Reports</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"12\">\n    <name>Enhanced Reporting</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"13\">\n    <name>Exporting to Excel</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"15\">\n    <name>Delayed Charges</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"16\">\n    <name>Custom Sales Fields</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"17\">\n    <name>More Users -- up to 20</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"19\">\n    <name>Recurring Transactions</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"20\">\n    <name>Closing the Books</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"21\">\n    <name>Location Tracking</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"22\">\n    <name>More Names</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"25\">\n    <name>Custom Home Page</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"26\">\n    <name>Do-it-yourself Payroll</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"28\">\n    <name>Online Banking</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"29\">\n    <name>Basic Sales</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"30\">\n    <name>Basic Banking</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"31\">\n    <name>Accounting</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"33\">\n    <name>Reports Only User</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"35\">\n    <name>Estimates</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"41\">\n    <name>Company Snapshot</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"42\">\n    <name>Purchase Order</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"43\">\n    <name>Inventory</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"44\">\n    <name>Do-it-yourself Payroll (Paycycle)</name>\n    <term>Off</term>\n  </Entitlement>\n  <Entitlement id=\"45\">\n    <name>Multi-Currency</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"46\">\n    <name>Trends</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"47\">\n    <name>Hide Employee List</name>\n    <term>Off</term>\n  </Entitlement>\n  <Entitlement id=\"48\">\n    <name>Simple Report List</name>\n    <term>Off</term>\n  </Entitlement>\n  <Entitlement id=\"49\">\n    <name>Global Tax Model</name>\n    <term>On</term>\n  </Entitlement>\n  <Entitlement id=\"52\">\n    <name>Accountant Menu</name>\n    <term>On</term>\n  </Entitlement>\n  <Thresholds>\n    <threshold>\n      <name>CLASSES_AND_DEPARTMENTS</name>\n      <limit>40</limit>\n      <enforced>true</enforced>\n      <currentCount>19</currentCount>\n      <aboveThreshold>false</aboveThreshold>\n    </threshold>\n    <threshold>\n      <name>ACCOUNTS</name>\n      <limit>250</limit>\n      <enforced>true</enforced>\n      <currentCount>7</currentCount>\n      <aboveThreshold>false</aboveThreshold>\n    </threshold>\n    <threshold>\n      <name>USERS</name>\n      <limit>5</limit>\n      <enforced>true</enforced>\n      <currentCount>1</currentCount>\n      <aboveThreshold>false</aboveThreshold>\n    </threshold>\n    <threshold>\n      <name>ACCOUTANTS</name>\n      <limit>2</limit>\n      <enforced>false</enforced>\n      <currentCount>-2</currentCount>\n      <aboveThreshold>false</aboveThreshold>\n    </threshold>\n    <threshold>\n      <name>CUSTOMFIELD_ALL</name>\n      <limit>6</limit>\n      <enforced>false</enforced>\n      <currentCount>0</currentCount>\n      <aboveThreshold>false</aboveThreshold>\n    </threshold>\n    <threshold>\n      <name>CUSTOMFIELD_PO</name>\n      <limit>3</limit>\n      <enforced>false</enforced>\n      <currentCount>0</currentCount>\n      <aboveThreshold>false</aboveThreshold>\n    </threshold>\n    <threshold>\n      <name>CUSTOMFIELD_SALES</name>\n      <limit>3</limit>\n      <enforced>false</enforced>\n      <currentCount>0</currentCount>\n      <aboveThreshold>false</aboveThreshold>\n    </threshold>\n   </Thresholds>\n</EntitlementsResponse>\n"
        '400':
          $ref: '#/components/responses/Fault'
        '401':
          $ref: '#/components/responses/Fault'
        '429':
          $ref: '#/components/responses/Throttled'
      security:
      - oauth2:
        - com.intuit.quickbooks.accounting
components:
  schemas:
    entitlementsresponse:
      type: object
      title: entitlementsresponse
      properties:
        PlanName:
          type: string
          description: Billing plan associated with this company.
        Entitlement:
          allOf:
          - $ref: '#/components/schemas/telephonenumber'
          description: Primary phone number.
        SupportedLanguages:
          type: string
          description: Comma separated list of languages.
        CompanyStartDate:
          type: string
          format: date-time
          description: DateTime when company file was created. This field and Metadata.CreateTime contain the same value.
        EmployerId:
          type: string
          description: Employer identifier (EIN).
        QboCompany:
          type: boolean
          description: Check if the company is a QuickBooks Online company. false is returned if not a QuickBooks Online company, the company exists in the Intuit ecosystem, but is not a QuickBooks Online company, or the company is a QuickBooks Online company, but the current user does not belong to the company.
        Email:
          allOf:
          - $ref: '#/components/schemas/emailaddress'
          description: Default email address.
        WebAddr:
          allOf:
          - $ref: '#/components/schemas/websiteaddress'
          description: Website address.
        FiscalYearStartMonth:
          type: string
          description: The start month of fiscal year.
        Thresholds:
          type: array
          items:
            $ref: '#/components/schemas/threshold'
          description: The threshold for this company.
        DaysRemainingTrial:
          type: integer
          description: Remaining trial period days.
        MaxUsers:
          type: integer
          description: Maximum billable users allowed in the company.
        CurrentUsers:
          type: integer
          description: Billable users currently in the company.
    IntuitFault:
      type: object
      properties:
        Fault:
          type: object
          properties:
            type:
              type: string
              enum:
              - ValidationFault
              - SystemFault
              - AuthenticationFault
              - AuthorizationFault
            Error:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  element:
                    type: string
                  Message:
                    type: string
                  Detail:
                    type: string
        time:
          type: string
          format: date-time
    emailaddress:
      type: object
      title: emailaddress
      properties:
        Address:
          type: string
          description: An email address. The address format must follow the RFC 822 standard.
          x-intuit-required: Optional
    threshold:
      type: object
      title: threshold
      properties:
        currentCount:
          type: string
          description: Indicates current value of attribute.
        aboveThreshold:
          type: string
          description: Indicate whether the current count of the attribute has reached its limit.
        enforced:
          type: string
          description: Whether the threshold is enforced.
        limit:
          type: string
          description: The upper limit for the threshold.
        name:
          type: string
          description: The name of the threshold.
    telephonenumber:
      type: object
      title: telephonenumber
      properties:
        FreeFormNumber:
          type: string
          description: Specifies the telephone number in free form.
          x-intuit-required: Optional
    websiteaddress:
      type: object
      title: websiteaddress
      properties:
        URI:
          type: string
          description: Uniform Resource Identifier for the web site.
          x-intuit-required: Optional
  responses:
    Fault:
      description: Error. The body carries a Fault element (type ValidationFault, SystemFault, AuthenticationFault or AuthorizationFault) with one or more Error entries (code, element, Message, Detail).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/IntuitFault'
    Throttled:
      description: 'HTTP 429: the request was throttled. Wait 60 seconds before retrying.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/IntuitFault'
  securitySchemes:
    oauth2:
      type: oauth2
      description: 'Intuit OAuth 2.0 (authorization code). Discovery: https://developer.api.intuit.com/.well-known/openid_configuration'
      flows:
        authorizationCode:
          authorizationUrl: https://appcenter.intuit.com/connect/oauth2
          tokenUrl: https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer
          refreshUrl: https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer
          scopes:
            com.intuit.quickbooks.accounting: Grants access to the QuickBooks Online Accounting API, which focuses on accounting data.
            com.intuit.quickbooks.payment: Grants access to the QuickBooks Payments API, which focuses on payments processing.
            openid: Grants access to OpenID Connect features.
            profile: User's given and family names info
            email: User's email address
            phone: User's phone number
            address: User's physical address
x-generated-from: documentation
x-provenance:
  method: generated
  generated: '2026-11-05'
  source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/account
  note: Converted from the JSON the developer.intuit.com API Explorer loads (static.developer.intuit.com/JSONObjects). Intuit publishes no OpenAPI document; this is a faithful machine transformation of its own reference data, graded as generated.