App settings

This section briefly describes how to customize all aspects of the app, including the name, image, and various URLs necessary for obtaining your production keys and releasing the app. The settings are categorized into sections outlined below :


Modify these settings prior to attempting to publish your app and click save when finished.

About your app
Navigate to Production tab on the app.
  • App Icon: Click the icon box to upload a new image. This will be the icon used for your app on the QuickBooks app store.
  • App Name: A descriptive name that helps users understand what your app does.
  • Terms of Service Links: Provide the EULA and Privacy Policy URL’s.
  • Countries you accept connections from: Select countries where businesses will use your app. For each country you select, your integration with QuickBooks must meet local tax, currency, language, and other requirements. More on reaching multiple countries.
  • Scope for the API: Check these boxes to specify the APIs your app uses.
Terms of service
You must provide URLs for your app’s EULA and Privacy Policy before you can get production keys.
  • End User License Agreement URL: The URL to your end user license agreement for your users.
  • Privacy Policy URL: The URL to your policy telling users how your app uses their data.​
Intuit Single Sign-On settings
These settings impact how your app interacts with the QuickBooks app store and how users sign into your app. Refer to the section below that corresponds to your app’s authentication model.
  • Permalink: Enter a string to customize your app’s URL on the QuickBooks app store. For example, entering “AccountingApp” sets your app listing’s URL to https://apps.intuit.com/AccountingApp.
  • Intuit Single Sign-On?: Specify whether your app uses Intuit Single Sign-On. If not, you must provide a URL that users can click to learn more details about your app (see Learn more URL below).
  • Category: To improve searchability as users browse for apps, select the category that your app belongs to.
For apps using Intuit Single Sign-On
  • Connect Request URI: For apps that implement OAuth 2.0, the location in your app to which users are directed upon clicking the Get App Now button. This location initiates the OAuth 2.0 workflow. Upon completion of the OAuth 2.0 workflow, the user is redirected to your app’s dashboard,fully connected to the QuickBooks company.

View Screenshot

qbo/docs/list-on-the-app-store/app_settings_sso.png

  • Host Domain: Your app site domain name. Since your production environment may be different than your development environment, you must provide URLs for both.
  • Launch URL: This is a placeholder for your app’s Launch link.For apps planning to publish on the QuickBooks App Store, this will be the link to the page that implements single sign-on. When Launch is clicked from Quickbooks company, Intuit will call this URL and your app should start the OpenIdConnect (OAuth2) process with OpenId+Email etc. scopes(Do not send accounting). You’ll get back the authorization code & realmId in the callback url and you should be able to obtain the id token and email to determine which user this is and take them to your app’s dashboard page.
  • Disconnect URL: This is a placeholder for your app’s Disconnect link.When Disconnect is clicked from Quickbooks company, Intuit will revoke the token internally and Your user lands on this page after the app disconnects from your user’s QuickBooks company. This url should again perform an OpenIdConnect (OAuth2) process as shown for Launch above, by sending scope as only OpenId+Email etc. (Do not send accounting). Implement the Connect to QuickBooks button and single sign-on on this page using API related scopes like for Accounting, Payments etc so that users can reconnect immediately. So, through this link, when a customer disconnects, Intuit passes your app an OpenID assertion about the user that just disconnected from your app. You can use that assertion to look up the user and mark them as disconnected or send them a message.

Note

Note

OAuth 1.0 will be disabled as of December 17, 2019. If you are currently using OAuth 1.0 for your apps (including apps still under development), be sure you migrate to OAuth 2.0 and (if applicable) OpenID Connect by December 17, 2019.

Intuit Non Single Sign-On settings
Refer to the section below that corresponds to your app’s authentication model.

For apps not using Intuit Single Sign-On

When you have selected No for the Intuit Single Sign-On field, these options will be available.

  • Learn more URL: This is the URL that the Learn More button uses. It redirects users to this link; ideally, the link should contain more information about your app, including pricing, demo/trial information (if available), and details on how to get or install the app. This page should also discuss how the app is used and how it integrates with QuickBooks.
  • Host Domain: Your app site domain name. Since your production environment may be different than your development environment, you must provide domains for both. Note, this is domain only, no protocol.
  • Launch URL: This is a placeholder for your app’s Launch link. The launch URL should be set to your app’s login page.
  • Disconnect URL: This is a placeholder for your app’s Disconnect link.The Disconnect URL should be a static page which informs the user that their QuickBooks connection has been terminated and provide instructions on how to reconnect to QuickBooks from within your app.