SAP Cloud Platform Open Connectors

QuickBooks Online Querying

The Open Connectors Query Language (OCNQL) provides a standard way to search across all of our connectors. Many API providers support some form of searching in their APIs but each one approaches searching differently. Rather than having you research how to query each resource at a provider, we've normalized your search experience. SAP Cloud Platform Open Connectors translates your queries to the API provider's search syntax.

When querying in QuickBooks Online, keep the following in mind:

  • Wild card character searching is supported with the LIKE operator. You can use % as a wild card to represent one or more characters. For example for GET /products you can search using a where clause like name LIKE '%product' to search for products with names ending in product.
  • Using OR is not supported.
  • Most fields are searchable, but not all. If you attempt to search using a field that is not supported, you will get an error like: Invalid query - QueryValidationError: property 'Taxable' is not queryable.
  • Use CEQL to query the following endpoints:
    • GET /departments
    • GET /produces
    • GET /tax-codes
    • GET /credit-memos
    • GET /employees
    • GET /classes
    • GET /invoices
    • GET /{objectName}
    • GET /{objectName}/{objectId}/{childObjectName}
    • GET /ledger-accounts
    • GET /vendors
    • GET /payment-methods
    • GET /bills
    • GET /time-activities
    • GET /payments
    • GET /refund-receipts
    • GET /purchase-orders
    • GET /tax-rates
    • POST /bulk/query
    • GET /purchases
    • GET /credit-terms
    • GET /bill-payments
    • GET /customers
    • GET /vendor-credits
    • GET /journal-entries
    • GET /sales-receipts
    • GET /reports/{reportId}

For more information about OCNQL, see the API documentation for the connector or Querying with OCNQL.