Copy data from QuickBooks using Azure Data Factory (Beta)

This article outlines how to use the Copy Activity in Azure Data Factory to copy data from QuickBooks. It builds on the copy activity overview article that presents a general overview of copy activity.

Note

This article applies to version 2 of Data Factory, which is currently in preview. If you are using version 1 of the Data Factory service, which is generally available (GA), see Copy Activity in V1.

Important

This connector is currently in Beta. You can try it out and give us feedback. Do not use it in production environments.

Supported capabilities

You can copy data from QuickBooks to any supported sink data store. For a list of data stores that are supported as sources/sinks by the copy activity, see the Supported data stores table.

Azure Data Factory provides a built-in driver to enable connectivity, therefore you don't need to manually install any driver using this connector.

Currently this connector only support 1.0a, which means you need to have a developer account with apps created before July 17, 2017.

Getting started

You can create a pipeline with copy activity by using one of the following tools/SDKs: Click a link to navigate to a tutorial with step-by-step instructions to create a pipeline with a copy activity.

The following sections provide details about properties that are used to define Data Factory entities specific to QuickBooks connector.

Linked service properties

The following properties are supported for QuickBooks linked service:

Property Description Required
type The type property must be set to: QuickBooks Yes
endpoint The endpoint of the QuickBooks server. (that is, quickbooks.api.intuit.com) Yes
companyId The company ID of the QuickBooks company to authorize. Yes
accessToken The access token for OAuth 1.0 authentication. Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. Yes
accessTokenSecret The access token secret for OAuth 1.0 authentication. Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. Yes
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. No

Example:

{
    "name": "QuickBooksLinkedService",
    "properties": {
        "type": "QuickBooks",
        "typeProperties": {
            "endpoint" : "quickbooks.api.intuit.com",
            "companyId" : "<companyId>",
            "accessToken": {
                 "type": "SecureString",
                 "value": "<accessToken>"
            },
            "accessTokenSecret": {
                 "type": "SecureString",
                 "value": "<accessTokenSecret>"
            },
            "useEncryptedEndpoints" : true
        }
    }
}

Dataset properties

For a full list of sections and properties available for defining datasets, see the datasets article. This section provides a list of properties supported by QuickBooks dataset.

To copy data from QuickBooks, set the type property of the dataset to QuickBooksObject. There is no additional type-specific property in this type of dataset.

Example

{
    "name": "QuickBooksDataset",
    "properties": {
        "type": "QuickBooksObject",
        "linkedServiceName": {
            "referenceName": "<QuickBooks linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

Copy activity properties

For a full list of sections and properties available for defining activities, see the Pipelines article. This section provides a list of properties supported by QuickBooks source.

QuickBooksSource as source

To copy data from QuickBooks, set the source type in the copy activity to QuickBooksSource. The following properties are supported in the copy activity source section:

Property Description Required
type The type property of the copy activity source must be set to: QuickBooksSource Yes
query Use the custom SQL query to read data. For example: "SELECT * FROM "Bill" WHERE Id = '123'". Yes

Example:

"activities":[
    {
        "name": "CopyFromQuickBooks",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<QuickBooks input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "QuickBooksSource",
                "query": "SELECT * FROM \"Bill\" WHERE Id = '123' "
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Next steps

For a list of data stores supported as sources and sinks by the copy activity in Azure Data Factory, see supported data stores.