|
1 | 1 | ---
|
2 |
| -title: Copy data from QuickBooks Online (Preview) |
| 2 | +title: Copy data from QuickBooks Online |
3 | 3 | description: Learn how to copy data from QuickBooks Online to supported sink data stores using a copy activity in an Azure Data Factory or Synapse Analytics pipeline.
|
4 | 4 | titleSuffix: Azure Data Factory & Azure Synapse
|
5 | 5 | author: jianleishen
|
6 | 6 | ms.author: jianleishen
|
7 | 7 | ms.subservice: data-movement
|
8 | 8 | ms.topic: conceptual
|
9 | 9 | ms.custom: synapse
|
10 |
| -ms.date: 10/20/2023 |
| 10 | +ms.date: 06/11/2025 |
11 | 11 | ---
|
12 | 12 |
|
13 |
| -# Copy data from QuickBooks Online using Azure Data Factory or Synapse Analytics (Preview) |
| 13 | +# Copy data from QuickBooks Online using Azure Data Factory or Synapse Analytics |
14 | 14 | [!INCLUDE[appliesto-adf-asa-md](includes/appliesto-adf-asa-md.md)]
|
15 | 15 |
|
16 | 16 | This article outlines how to use the Copy Activity in an Azure Data Factory or Synapse Analytics pipeline to copy data from QuickBooks Online. It builds on the [copy activity overview](copy-activity-overview.md) article that presents a general overview of copy activity.
|
@@ -66,7 +66,53 @@ The following sections provide details about properties that are used to define
|
66 | 66 |
|
67 | 67 | ## Linked service properties
|
68 | 68 |
|
69 |
| -The following properties are supported for QuickBooks linked service: |
| 69 | +The QuickBooks connector now supports version 2.0. Refer to this [section](#upgrade-the-quickbooks-connector-from-version-10-to-version-20) to upgrade your QuickBooks connector version from version 1.0 (Preview). For the property details, see the corresponding sections. |
| 70 | + |
| 71 | +- [Version 2.0](#version-20) |
| 72 | +- [Version 1.0 (Preview)](#version-10) |
| 73 | + |
| 74 | +### Version 2.0 |
| 75 | + |
| 76 | +The QuickBooks linked service supports the following properties when apply version 2.0: |
| 77 | + |
| 78 | +| Property | Description | Required | |
| 79 | +|:--- |:--- |:--- | |
| 80 | +| type | The type property must be set to: **QuickBooks** | Yes | |
| 81 | +| version | The version that you specify. The value is `2.0`. | Yes | |
| 82 | +| endpoint | The endpoint of the QuickBooks Online server. (that is, quickbooks.api.intuit.com) | Yes | |
| 83 | +| companyId | The company ID of the QuickBooks company to authorize. For info about how to find the company ID, see [How do I find my Company ID](https://quickbooks.intuit.com/community/Getting-Started/How-do-I-find-my-Company-ID/m-p/185551). | Yes | |
| 84 | +| consumerKey | The client ID of your QuickBooks Online application for OAuth 2.0 authentication. Learn more from [here](https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization/oauth-2.0#obtain-oauth2-credentials-for-your-app). | Yes | |
| 85 | +| consumerSecret | The client secret of your QuickBooks Online application for OAuth 2.0 authentication. Mark this field as a SecureString to store it securely, or [reference a secret stored in Azure Key Vault](store-credentials-in-key-vault.md). | Yes | |
| 86 | +| refreshToken | The OAuth 2.0 refresh token associated with the QuickBooks application. Learn more from [here](https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization/oauth-2.0#obtain-oauth2-credentials-for-your-app). Note refresh token will be expired after 180 days. Customer need to regularly update the refresh token. <br/>Mark this field as a SecureString to store it securely, or [reference a secret stored in Azure Key Vault](store-credentials-in-key-vault.md).| Yes | |
| 87 | + |
| 88 | +**Example:** |
| 89 | + |
| 90 | +```json |
| 91 | +{ |
| 92 | + "name": "QuickBooksLinkedService", |
| 93 | + "properties": { |
| 94 | + "type": "QuickBooks", |
| 95 | + "version": "2.0", |
| 96 | + "typeProperties": { |
| 97 | + "endpoint": "quickbooks.api.intuit.com", |
| 98 | + "companyId": "<company id>", |
| 99 | + "consumerKey": "<consumer key>", |
| 100 | + "consumerSecret": { |
| 101 | + "type": "SecureString", |
| 102 | + "value": "<clientSecret>" |
| 103 | + }, |
| 104 | + "refreshToken": { |
| 105 | + "type": "SecureString", |
| 106 | + "value": "<refresh token>" |
| 107 | + } |
| 108 | + } |
| 109 | + } |
| 110 | +} |
| 111 | +``` |
| 112 | + |
| 113 | +### <a name="version-10"></a> Version 1.0 (Preview) |
| 114 | + |
| 115 | +The following properties are supported for QuickBooks linked service when apply version 1.0 (Preview): |
70 | 116 |
|
71 | 117 | | Property | Description | Required |
|
72 | 118 | |:--- |:--- |:--- |
|
@@ -193,5 +239,18 @@ The Copy Activity in the service cannot copy data directly from Quickbooks Deskt
|
193 | 239 |
|
194 | 240 | To learn details about the properties, check [Lookup activity](control-flow-lookup-activity.md).
|
195 | 241 |
|
| 242 | +## Quickbooks connector lifecycle and upgrade |
| 243 | + |
| 244 | +The following table shows the release stage and change logs for different versions of the QuickBooks connector: |
| 245 | + |
| 246 | +| Version | Release stage | Change log | |
| 247 | +| :----------- | :------- |:------- | |
| 248 | +| Quickbooks version 1.0 (Preview) | End of support announced | / | |
| 249 | +| Quickbooks version 2.0 | GA version available | • `useEncryptedEndpoints` is not supported. <br><br>• `query` don’t support GROUP BY clauses, JOIN clauses and Aggregate Function (Avg, Max, Sum). For more information about query operations and syntax, see this [article](https://developer.intuit.com/app/developer/qbo/docs/learn/explore-the-quickbooks-online-api/data-queries). | |
| 250 | + |
| 251 | +### <a name="upgrade-the-quickbooks-connector-from-version-10-to-version-20"></a> Upgrade the Quickbooks connector from version 1.0 (Preview) to version 2.0 |
| 252 | + |
| 253 | +In **Edit linked service** page, select 2.0 for version. For more information, see [linked service version 2.0 properties](#version-20). |
| 254 | + |
196 | 255 | ## Related content
|
197 | 256 | For a list of data stores supported as sources and sinks by the copy activity, see [supported data stores](copy-activity-overview.md#supported-data-stores-and-formats).
|
0 commit comments