diff --git a/docs/integrations/accounting/quickbooksonline/accounting-quickbooksonline.md b/docs/integrations/accounting/quickbooksonline/accounting-quickbooksonline.md index 289042a90..e4817f437 100644 --- a/docs/integrations/accounting/quickbooksonline/accounting-quickbooksonline.md +++ b/docs/integrations/accounting/quickbooksonline/accounting-quickbooksonline.md @@ -15,7 +15,48 @@ This integration supports the ability to include additional fields within our st See [Set up the QuickBooks Online integration](/integrations/accounting/quickbooksonline/accounting-quickbooksonline-new-setup) to learn how to set up and enable the integration. +## Intuit App Partner Program + +Intuit's [App Partner Program](https://blogs.intuit.com/2025/05/15/introducing-the-intuit-app-partner-program/) supports providers of applications built on Intuit's platform with higher security standards, early access to new features, and more reliable data synchronization. + +If you plan to publish an app in the QuickBooks ecosystem, you must register with the partner program and fill in the app assessment questionnnaire. We created an [App assessment questionnaire guide](/integrations/accounting/quickbooksonline/qbo-app-assessment-questionnaire) to help you answer its questions. + +#### Tiered usage model + +The Intuit App Partner Program operates a tiered usage model. Under this model, Intuit classifies API calls into two categories: + +- Core API calls - free and unlimited routine tasks, such as creating or updating invoices, bills, and customers +- CorePlus API calls - data-heavy tasks, such as running reports or retrieving deep historical data + +The [API classification for the Intuit App Partner Program](https://help.developer.intuit.com/s/article/API-classification-for-the-Intuit-App-Partner-Program) article explains how API calls are classified into Core and CorePlus. + +:::caution Track API call usage to avoid extra charges + +Each tier is allocated a monthly limit of CorePlus API calls, and exceeding this limit may result in additional charges. Track your app's usage of API calls to avoid this. + +::: + +#### Track usage + +To avoid unexpected costs, track your app's usage of API calls following these steps: + +1. Log in to the [Intuit Developer Portal](https://developer.intuit.com/dashboard?tab=apps). +2. Navigate to the _App dashboard_ and select the app you want to review. +3. In the left-hand menu, click **Analytics**. +4. In _Analytics_, toggle the environment to **Production**. You will see a chart detailing your Core and CorePlus usage. + +#### Optimize usage + +Optimizing your API call usage may reduce the overall fees owed to Intuit. We recommend the following: + +- Limit the number of data refresh requests built into your product. +- Adjust the frequency of data type syncs to our recommended levels. + +If you have questions about optimization, reach out to your Account Manager. + ## Additional information - [QuickBooks Online FAQ](/integrations/accounting/quickbooksonline/faq-quickbooks-online) - [QuickBooks Online integration reference](/integrations/accounting/quickbooksonline/quickbooks-online-integration-reference) +- [Intuit App Partner Program](https://blogs.intuit.com/2025/05/15/introducing-the-intuit-app-partner-program/) +- [App assessment questionnaire guide](/integrations/accounting/quickbooksonline/qbo-app-assessment-questionnaire) diff --git a/docs/integrations/accounting/quickbooksonline/qbo-app-assessment-questionnaire.md b/docs/integrations/accounting/quickbooksonline/qbo-app-assessment-questionnaire.md index 07f8af703..a5fd0a69d 100644 --- a/docs/integrations/accounting/quickbooksonline/qbo-app-assessment-questionnaire.md +++ b/docs/integrations/accounting/quickbooksonline/qbo-app-assessment-questionnaire.md @@ -11,11 +11,51 @@ However, some questions relate to Codat's integration with QuickBooks Online. We ## Questionnaire -### General questions +To access the questionnaire, navigate to **Keys and credentials** in your app's detailed view and toggle the environment to **Production**. Provide general app details in **App details**, then switch to the **Compliance** tab and click **Start questionnaire**. + + + +### App details + +This section has several questions related to Codat. We provided detailed answers to the highlighted the responses you should choose in **bold**. + +1. **Review your Intuit Developer Portal Profile and verify your email** + +This question should be answered by the app's developer. + +2. **Add your app's end-user license agreement and privacy policy** + +This question should be answered by the app's developer. + +3. **Add your app's host domain, launch URL, and disconnect URL** + +This question should be answered by the app's developer based on the guidelines provided below. + + - **Host domain**: the URL of the domain host of your website or app. + + - **Launch URL**: Initial URL for your app's authorization flow. If using [Hosted Link](/auth-flow/authorize-hosted-link), provide the generic Link URL from the [Codat Portal](https://app.codat.io). + + - **Disconnect URL**: Link to the process for deauthorizing the app's access to QBO. This can be the URL of the [Unlink connection](/platform-api#/operations/unlink-connection) endpoint or a link to your website or app instead. + +4. **Select at least one category for your app** + +This question should be answered by the app's developer. + +5. **Tell us about any regulated industries that use your app** + +This question should be answered by the app's developer. + +6. **Tell us where your app is hosted** + +As Codat interacts directly with QBO, the app's developer needs to include Codat's IPs and hosting locations as well as their own. Review our [QBO integration reference](/integrations/accounting/quickbooksonline/quickbooks-online-integration-reference#qbo-app-hosting) for Codat's hosting details. + +### Compliance + +#### General questions There are no questions related to Codat in this section. Developers can answer all questions according to their own circumstances. -### Lending +#### Lending This section will only appear in your questionnaire if you confirmed that you are a lender earlier in the process. If you are not a lender, skip this section. @@ -23,7 +63,7 @@ If you are a lender and don't see these questions in your questionnaire, go back There are no questions related to Codat in this section. Developers can answer all questions according to their own circumstances. -### App information +#### App information This section has several questions related to Codat. We highlighted the responses you should choose in **bold**. @@ -73,7 +113,7 @@ After selecting option **B**, provide an estimated number of QuickBooks Online u This question should be answered by the app's developer. -### Authorization and authentication +#### Authorization and authentication This section has several questions related to Codat. We highlighted the responses you should choose in **bold**. @@ -129,7 +169,7 @@ This question should be answered by the app's developer. Testing the app is a ma | a | Yes | | **b** | **No** | -### API usage +#### API usage This section has several questions related to Codat. We highlighted the responses you should choose in **bold**. @@ -147,7 +187,7 @@ Codat does not integrate with the Payments or Payroll APIs. This question should be answered by the app's developer. -### Accounting API +#### Accounting API This section will appear in the questionnaire once you select _Accounting API_ in the previous set of questions. @@ -226,7 +266,7 @@ After selecting option **E**, provide this additional information: **Adhoc on requests for new data.** -### Error handling +#### Error handling 1. **Have you tested if your app can handle API errors, including syntax and validation errors?** @@ -253,7 +293,7 @@ After selecting option **E**, provide this additional information: This question should be answered by the app's developer. -### Security +#### Security 1. **Has your company ever had a security breach that required notification to customers or government agencies/authorities?** diff --git a/static/img/integrations/accounting/quickbooksonline/qbo-app-details-questionnaire.png b/static/img/integrations/accounting/quickbooksonline/qbo-app-details-questionnaire.png new file mode 100644 index 000000000..046dcbb29 --- /dev/null +++ b/static/img/integrations/accounting/quickbooksonline/qbo-app-details-questionnaire.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:533844b3d6bbfe39a3c44a2756e19036e6f997df4d1bb2a4dfc7195cfae667e5 +size 80079