QuickBooks Customer Type API

openapi: 3.2.0
info:
  title: QuickBooks Online Accounting Customer Type 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: CustomerType
  description: Customer types allow categorizing customers in ways that are meaningful to the business. For example, one could set up customer types so that they indicate which industry a customer represents, a customer's geographic location, or how a customer first heard about the business. The categorization then can be used for reporting or mailings.
paths:
  /v3/company/{realmID}/query:
    get:
      operationId: query
      summary: Query an entity with a SELECT statement
      tags:
      - CustomerType
      x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/account
      x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      x-intuit-sample-query: '"select * from Account where Metadata.CreateTime > ''2014-12-31''"'
      parameters:
      - name: realmID
        in: path
        required: true
        schema:
          type: string
      - name: query
        in: query
        required: true
        schema:
          type: string
        description: Template value <selectStatement> in the provider's operation string.
      responses:
        '200':
          description: Returns the results of the query.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/accountresponse'
              example:
                QueryResponse:
                  startPosition: 1
                  Account:
                  - FullyQualifiedName: Canadian Accounts Receivable
                    domain: QBO
                    Name: Canadian Accounts Receivable
                    Classification: Asset
                    AccountSubType: AccountsReceivable
                    CurrencyRef:
                      name: United States Dollar
                      value: USD
                    CurrentBalanceWithSubAccounts: 0
                    sparse: false
                    MetaData:
                      CreateTime: '2015-06-23T09:38:18-07:00'
                      LastUpdatedTime: '2015-06-23T09:38:18-07:00'
                    AccountType: Accounts Receivable
                    CurrentBalance: 0
                    Active: true
                    SyncToken: '0'
                    Id: '92'
                    SubAccount: false
                  - FullyQualifiedName: MyClients
                    domain: QBO
                    Name: MyClients
                    Classification: Asset
                    AccountSubType: AccountsReceivable
                    CurrencyRef:
                      name: United States Dollar
                      value: USD
                    CurrentBalanceWithSubAccounts: 0
                    sparse: false
                    MetaData:
                      CreateTime: '2015-07-13T12:34:47-07:00'
                      LastUpdatedTime: '2015-07-13T12:34:47-07:00'
                    AccountType: Accounts Receivable
                    CurrentBalance: 0
                    Active: true
                    SyncToken: '0'
                    Id: '93'
                    SubAccount: false
                  - FullyQualifiedName: MyJobs
                    domain: QBO
                    Name: MyJobs
                    Classification: Asset
                    AccountSubType: AccountsReceivable
                    CurrencyRef:
                      name: United States Dollar
                      value: USD
                    CurrentBalanceWithSubAccounts: 0
                    sparse: false
                    MetaData:
                      CreateTime: '2015-01-13T10:29:27-08:00'
                      LastUpdatedTime: '2015-01-13T10:29:27-08:00'
                    AccountType: Accounts Receivable
                    CurrentBalance: 0
                    Active: true
                    SyncToken: '0'
                    Id: '91'
                    SubAccount: false
                  maxResults: 3
                time: '2015-07-13T12:35:57.651-07:00'
        '400':
          $ref: '#/components/responses/Fault'
        '401':
          $ref: '#/components/responses/Fault'
        '429':
          $ref: '#/components/responses/Throttled'
      security:
      - oauth2:
        - com.intuit.quickbooks.accounting
      x-intuit-variants:
      - name: Query an attachable
        operationId: queryAttachable
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/attachable
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
        description: 'The sample query on the right returns the attachable ids for all attachments linked to the purchase object whose Id is 611. To formulate this query, you must first know the type of object and its object Id using the query endpoint for that resource. Set AttachableRef.EntityRef.type with the specific type of the target object.  For this example, purchase is used.

          Set AttachableRef.EntityRef.value with the Id of the target object as returned in its response body when queried.  For this example, 611 is used.'
      - name: Query a bill
        operationId: queryBill
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/bill
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a billpayment
        operationId: queryBillpayment
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/billpayment
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a budget
        operationId: queryBudget
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/budget
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a class
        operationId: queryClass
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/class
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a companycurrency
        operationId: queryCompanycurrency
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/companycurrency
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query companyinfo
        operationId: queryCompanyinfo
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/companyinfo
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a creditcardpayment
        operationId: queryCreditcardpayment
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/creditcardpayment
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a credit memo
        operationId: queryCreditMemo
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/creditmemo
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a customer
        operationId: queryCustomer
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/customer
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a customertype
        operationId: queryCustomertype
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/customertype
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a department
        operationId: queryDepartment
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/department
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a deposit
        operationId: queryDeposit
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/deposit
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query an employee
        operationId: queryEmployee
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/employee
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query an estimate
        operationId: queryEstimate
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/estimate
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query exchangerate objects.
        operationId: queryExchangerateObjects
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/exchangerate
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query an invoice
        operationId: queryInvoice
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/invoice
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a bundle
        operationId: queryBundle
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/item
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a category
        operationId: queryCategory
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/item
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query an item
        operationId: queryItem
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/item
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a journalentry
        operationId: queryJournalentry
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/journalentry
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a payment
        operationId: queryPayment
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/payment
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a paymentmethod
        operationId: queryPaymentmethod
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/paymentmethod
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query preferences
        operationId: queryPreferences
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/preferences
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a purchase
        operationId: queryPurchase
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/purchase
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a purchase order
        operationId: queryPurchaseOrder
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/purchaseorder
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a recurring transaction
        operationId: queryRecurringTransaction
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/recurringtransaction
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a refund receipt
        operationId: queryRefundReceipt
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/refundreceipt
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a reimburse charge
        operationId: queryReimburseCharge
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/reimbursecharge
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a salesreceipt
        operationId: querySalesreceipt
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/salesreceipt
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a taxagency
        operationId: queryTaxagency
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/taxagency
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a taxcode
        operationId: queryTaxcode
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/taxcode
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query taxpayment
        operationId: queryTaxpayment
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/taxpayment
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a taxrate
        operationId: queryTaxrate
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/taxrate
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a term
        operationId: queryTerm
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/term
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a timeactivity object
        operationId: queryTimeactivityObject
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/timeactivity
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query an transfer
        operationId: queryTransfer
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/transfer
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a vendor
        operationId: queryVendor
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/vendor
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      - name: Query a vendorcredit
        operationId: queryVendorcredit
        x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/vendorcredit
        x-intuit-operation: GET /v3/company/<realmID>/query?query=<selectStatement>
      description: GET /v3/company/{realmID}/query?query=. One endpoint serves every queryable entity; the entity is named in the SELECT statement. Each entity's documented query is listed under x-intuit-variants.
  /v3/company/{realmID}/customertype/{Id}:
    get:
      operationId: readCustomerType
      summary: Read a customertype
      tags:
      - CustomerType
      x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/customertype
      x-intuit-operation: GET /v3/company/<realmID>/customertype/<Id>
      description: Retrieves the details of a Customertype object.
      parameters:
      - name: realmID
        in: path
        required: true
        schema:
          type: string
      - name: Id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the Customertype object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customertyperesponse'
        '400':
          $ref: '#/components/responses/Fault'
        '401':
          $ref: '#/components/responses/Fault'
        '429':
          $ref: '#/components/responses/Throttled'
      security:
      - oauth2:
        - com.intuit.quickbooks.accounting
components:
  schemas:
    accountresponse:
      type: object
      title: accountresponse
      properties:
        SyncToken:
          type: string
          description: Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online.
          x-intuit-required: Required for update
        SubAccount:
          type: boolean
          description: Specifies whether this object represents a parent (false) or subaccount (true). Please note that accounts of these types - OpeningBalanceEquity, UndepositedFunds, RetainedEarnings, CashReceiptIncome, CashExpenditureExpense, ExchangeGainOrLoss cannot have a sub account and cannot be a sub account of another account.
          x-intuit-filterable: true
          x-intuit-sortable: true
        Classification:
          type: string
          description: "The classification of an account. Not supported for non-posting accounts.\n Valid values include: Asset, Equity, Expense, Liability, Revenue"
          x-intuit-default: derived from AccountType and AccountSubtype
          x-intuit-filterable: true
        FullyQualifiedName:
          type: string
          description: 'Fully qualified name of the object; derived from Name and ParentRef. The fully qualified name prepends the topmost parent, followed by each subaccount separated by colons and takes the form of

            Parent:Account1:SubAccount1:SubAccount2. System generated. Limited to 5 levels.'
          x-intuit-filterable: true
          x-intuit-sortable: true
        AccountType:
          type: string
          description: A detailed account classification that specifies the use of this account. The type is based on the Classification.
          x-intuit-filterable: true
        CurrencyRef:
          allOf:
          - $ref: '#/components/schemas/currencyref'
          description: Reference to the currency in which this account holds amounts.
          x-intuit-required: Optional
        CurrentBalanceWithSubAccounts:
          type: number
          description: Specifies the cumulative balance amount for the current Account and all its sub-accounts.
          x-intuit-filterable: true
          x-intuit-sortable: true
        AcctNum:
          type: string
          description: "User-defined account number to help the user in identifying the account within the chart-of-accounts and in deciding what should be posted to the account. The Account.AcctNum attribute must not contain colon (:).Name must be unique.\n\n Max length for Account.AcctNum:AU & CA: 20 characters.\nUS, UK & IN: 7 characters"
          x-intuit-required: Conditionally required
        TaxCodeRef:
          allOf:
          - $ref: '#/components/schemas/referencetype'
          description: Reference to the default tax code used by this account. Tax codes are referenced by the TaxCode.Id in the TaxCode object. For global locales, only.
        ParentRef:
          allOf:
          - $ref: '#/components/schemas/referencetype'
          description: Specifies the Parent AccountId if this represents a SubAccount.
          x-intuit-required: Optional
          x-intuit-filterable: true
          x-intuit-sortable: true
        AccountSubType:
          type: string
          description: The account sub-type classification and is based on the AccountType value.
          x-intuit-filterable: true
        CurrentBalance:
          type: number
          description: Specifies the balance amount for the current Account. Valid for Balance Sheet accounts.
          x-intuit-filterable: true
          x-intuit-sortable: true
        Description:
          type: string
          description: User entered description for the account, which may include user entered information to guide bookkeepers/accountants in deciding what journal entries to post to the account.
          x-intuit-required: Optional
          x-intuit-filterable: true
          x-intuit-sortable: true
        Active:
          type: boolean
          description: Whether or not active inactive accounts may be hidden from most display purposes and may not be posted to.
          x-intuit-required: Optional
          x-intuit-default: 'true'
          x-intuit-filterable: true
        MetaData:
          allOf:
          - $ref: '#/components/schemas/modificationmetadata'
          description: Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
          x-intuit-required: Optional
        Id:
          type: string
          description: Unique identifier for this object.
          x-intuit-required: Required for update
          x-intuit-filterable: true
        Name:
          type: string
          description: 'User recognizable name for the Account.

            Account.Name attribute must not contain double quotes (") or colon (:).'
          x-intuit-required: Required
          x-intuit-filterable: true
          x-intuit-sortable: true
      required:
      - Name
    referencetype:
      type: object
      title: referencetype
      properties:
        name:
          type: string
          description: An identifying name for the object being referenced by value and is derived from the field that holds the common name of that object. This varies by context and specific type of object referenced. For example, references to a Customer object use Customer.DisplayName to populate this field. Optionally returned in responses, implementation dependent.
          x-intuit-required: Optional
        value:
          type: string
          description: The ID for the referenced object as found in the Id field of the object payload. The context is set by the type of reference and is specific to the QuickBooks company file.
          x-intuit-required: Required
      required:
      - value
    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
    customertyperesponse:
      type: object
      title: companytyperesponse
      properties:
        Active:
          type: boolean
          description: 'Indicates whether this customer type is active in the company or not.

            true--This customer type is active and enabled for use by QuickBooks.

            false—This customer type is inactive, is hidden from most display purposes, and is not availble for use with financial transactions.'
          x-intuit-required: Optional
          x-intuit-default: 'true'
          x-intuit-filterable: true
          x-intuit-sortable: true
        SyncToken:
          type: string
          description: Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online.
          x-intuit-required: Required for update
        MetaData:
          allOf:
          - $ref: '#/components/schemas/modificationmetadata'
          description: Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
          x-intuit-required: Optional
          x-intuit-filterable: true
          x-intuit-sortable: true
        Name:
          type: string
          description: The full name of the customer type.
          x-intuit-required: Required for update
        Id:
          type: string
          description: Unique identifier for this object.
          x-intuit-required: Required for update
          x-intuit-filterable: true
    modificationmetadata:
      type: object
      title: modificationmetadata
      properties:
        CreateTime:
          type: string
          format: date-time
          description: Time the entity was created in the source domain.
          x-intuit-filterable: true
          x-intuit-sortable: true
        LastUpdatedTime:
          type: string
          format: date-time
          description: Time the entity was last updated in the source domain.
          x-intuit-filterable: true
          x-intuit-sortable: true
    currencyref:
      type: object
      title: currencyref
      properties:
        name:
          type: string
          description: The full name of the currency.
          x-intuit-required: Optional
        value:
          type: string
          description: A three letter string representing the ISO 4217 code for the currency. For example, USD, AUD, EUR, and so on.
          x-intuit-required: Required
      required:
      - value
  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.