Ready to get started?

Learn more about the QuickBooks Online PowerShell Cmdlets or download a free trial:

Download Now

PowerShell Scripting to Replicate QuickBooks Online Data to MySQL

Write a simple PowerShell script to replicate QuickBooks Online data to a MySQL database.

The CData Cmdlets for QuickBooks Online offer live access to QuickBooks Online data from within PowerShell. Using PowerShell scripts, you can easily automate regular tasks like data replication. This article will walk through using the CData Cmdlets for QuickBooks Online and the CData Cmdlets for MySQL in PowerShell to replicate QuickBooks Online data to a MySQL database.

After obtaining the needed connection properties, accessing QuickBooks Online data in PowerShell and preparing for replication consists of four basic steps.

QuickBooks Online uses the OAuth authentication standard. OAuth requires the authenticating user to log in through the browser. To authenticate using OAuth, you can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL or you can obtain your own by registering an app with Intuit. Additionally, if you want to connect to sandbox data, set UseSandbox to true.

See the Getting Started chapter of the help documentation for a guide to using OAuth.

Collecting QuickBooks Online Data

  1. Install the module:

    Install-Module QuickBooksOnlineCmdlets
  2. Connect to QuickBooks Online:

    $quickbooksonline = Connect-QBOnline
  3. Retrieve the data from a specific resource:

    $data = Select-QBOnline -Connection $quickbooksonline -Table "Customers"

    You can also use the Invoke-QBOnline cmdlet to execute pure SQL-92 statements:

    $data = Invoke-QBOnline -Connection $quickbooksonline -Query 'SELECT * FROM Customers WHERE FullyQualifiedName = @FullyQualifiedName' -Params @{'@FullyQualifiedName'='Cook, Brian'}
  4. Save a list of the column names from the returned data.

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name

Inserting QuickBooks Online Data into the MySQL Database

With the data and column names collected, you are ready to replicate the data into a MySQL database.

  1. Install the module:

    Install-Module MySQLCmdlets
  2. Connect to MySQL, using the server address and port of the MySQL server, valid user credentials, and a specific database with the table in which the data will be replicated:

    $mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
  3. Loop through the QuickBooks Online data, store the values, and use the Add-MySQL cmdlet to insert the data into the MySQL database, one row at a time. In this example, the table will need to have the same name as the QuickBooks Online resource (Customers) and to exist in the database.

    $data | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Customers" -Columns $columns -Values $values }

You have now replicated your QuickBooks Online data to a MySQL database. This gives you freedom to work with QuickBooks Online data in the same way that you work with other MySQL tables, whether that is performing analytics, building reports, or other business functions.

Notes

  • Once you have connected to QuickBooks Online and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

    Select-QBOnline -Connection $quickbooksonline -Table "Customers" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Customers" -Columns $columns -Values $values }
  • If you wish to replicate the QuickBooks Online data to another database using another PowerShell module, you will want to exclude the Columns, Connection, and Table columns from the data returned by the Select-QBOnline cmdlet since those columns are used to help pipe data from one CData cmdlet to another:

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}