Link Search Menu Expand Document

Build apps around use cases

If you already know what you want to develop, create custom queries to build a bespoke experience. Head over too look at the schema defintions

If you need inspiration, we’ve got you covered. Here are common use cases and small business workflows. You can use these guides as a foundation for your app.

Here is the standard process for every use-case:

Step 1: Create your app in the Intuit Developer Portal

If you haven’t already, create your app on the developer portal.

Step 2: Set your app’s scopes

The Intuit Ecosystem API uses scopes to limit the type of data your app can access. You’ll set scopes when you create your app.

If you want your app to read or write data

To read QuickBooks Online Payroll data, and write in how much individual employees request for deductions, use the scopes associated with each use-case:

Step 3: Get your app’s credentials

  1. Sign in to your developer account.
  2. Select the Dashboard link on the toolbar.
  3. Select and open your app.
  4. In the Production section, select Keys & OAuth.
  5. Copy the Client ID and Client Secret.

Step 4: Authorize your app

If you haven’t already, use your Client ID, Client Secret, and scopes to set up OAuth 2.0.

Step 5: Create and execute queries for your app

Use the sample queries provided in the respective sections as guides. Introspection can also be very helpful to build queries, with the help of tools such as Insomnia. More information can be found on this page.

Endpoints

The endpoint for all queries are listed here : API endpoints

Step 6: Go live with your app

Follow these steps when you’re ready to publish your app.


Table of contents


© 2021 Intuit Inc. All rights reserved. Intuit and QuickBooks are registered trademarks of Intuit Inc. Terms and conditions, features, support, pricing, and service options subject to change without notice.