QuickBooks Customer Balance Detail API

openapi: 3.2.0
info:
  title: QuickBooks Online Accounting Customer Balance Detail 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: CustomerBalanceDetail
  description: The information below provides a reference on how to access the Customer Balance Detail report from the QuickBooks Online Report Service.
paths:
  /v3/company/{realmID}/reports/CustomerBalanceDetail:
    get:
      operationId: queryCustomerBalanceDetail
      summary: Query a report
      tags:
      - CustomerBalanceDetail
      x-source: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/customerbalancedetail
      x-intuit-operation: GET /v3/company/<realmID>/reports/CustomerBalanceDetail?<name>=<value>[&...]
      x-intuit-parameters-note:
      - 'Query Parameters: Customize the information returned in the report by specifying query parameters with the query. Listed below are query parameters available for this report.'
      parameters:
      - name: realmID
        in: path
        required: true
        schema:
          type: string
      - name: customer
        in: query
        schema:
          type: string
        description: 'Filters report contents to include information for specified customers.

          Supported Values: One or more comma separated customer IDs as returned in the attribute, Customer.Id, of the Customer object response code.'
      - name: shipvia
        in: query
        schema:
          type: string
        description: 'Filter by the shipping method as stored in Invoice.ShipMethodRef.Name.

          Supported Values: Any shipping method as sent in the Invoice.ShipMethodRef.Name attribute at Invoice create- or update-time.'
      - name: term
        in: query
        schema:
          type: string
        description: 'Filters report contents based on term or terms supplied.

          Supported Values: One or more comma separated term IDs as returned in the attribute, Term.Id of the Term object response code.'
      - name: end_duedate
        in: query
        schema:
          type: string
        description: The range of dates over which receivables are due, in the format YYYY-MM-DD. start_duedate must be less than end_duedate. If not specified, all data is returned.
      - name: start_duedate
        in: query
        schema:
          type: string
        description: The range of dates over which receivables are due, in the format YYYY-MM-DD. start_duedate must be less than end_duedate. If not specified, all data is returned.
      - name: custom1
        in: query
        schema:
          type: string
        description: 'Filter by the specified custom field as defined by the CustomField attribute in transaction entities where supported.

          Supported Values: Name of custom field.'
      - name: sort_by
        in: query
        schema:
          type: string
        description: The column type used in sorting report rows. Specify a column type as defined with the columns query parameter.
      - name: arpaid
        in: query
        schema:
          type: string
        description: Supported Values:All, Paid, Unpaid
      - name: report_date
        in: query
        schema:
          type: string
        description: Start date to use for the report, in the format YYYY-MM-DD.
      - name: sort_order
        in: query
        schema:
          type: string
        description: 'The sort order.

          Supported Values: ascend, descend'
      - name: aging_method
        in: query
        schema:
          type: string
        description: 'The date upon which aging is determined.

          Supported Values:Report_Date, Current'
      - name: department
        in: query
        schema:
          type: string
        description: 'Filters report contents to include information for specified departments if so configured in the company file.

          Supported Values: One or more comma separated department IDs as returned in the attribute, Department.Id of the Department object response code.'
      - name: columns
        in: query
        schema:
          type: string
        description: "Column types to be shown in the report.\nSupported Values: bill_addr, create_by, create_date, cust_bill_email, cust_comp_name, cust_msg, cust_phone_other, cust_tel, cust_name, deliv_addr, doc_num*, due_date*, last_mod_by, last_mod_date, memo*, sale_sent_state, ship_addr, ship_date, ship_via, term_name, tracking_num, tx_date*, txn_type*\n Additional columns with custom fields enabled: sales_cust1, sales_cust2, sales_cust3 \n Additional columns with location tracking enabled: dept_name*"
      responses:
        '200':
          description: Returns the report object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/reporttoplevel'
        '400':
          $ref: '#/components/responses/Fault'
        '401':
          $ref: '#/components/responses/Fault'
        '429':
          $ref: '#/components/responses/Throttled'
      security:
      - oauth2:
        - com.intuit.quickbooks.accounting
components:
  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'
  schemas:
    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
    reporttoplevel:
      type: object
      title: reporttoplevel
      properties:
        Header:
          description: The report header.
        Rows:
          description: Top level container holding information for report rows.
        Columns:
          description: Top level container holding information for report columns or subcolumns.
  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.