How to pipe QuickBooks Data to CSV in PowerShell

The CData Cmdlets Module for QuickBooks is a standard PowerShell module offering straightforward integration with QuickBooks. Below, you will find examples of using our QuickBooks Cmdlets with native PowerShell cmdlets.

Getting Started

---

Creating a Connection to Your QuickBooks Data

When you are connecting to a local QuickBooks instance, you do not need to set any connection properties.

Requests are made to QuickBooks through the Remote Connector. The Remote Connector runs on the same machine as QuickBooks and accepts connections through a lightweight, embedded Web server. The server supports SSL/TLS, enabling users to connect securely from remote machines.

The first time you connect, authorize the Remote Connector with QuickBooks. See the "Getting Started" chapter of the help documentation for a guide.

$conn = Connect-QB -URL "$URL" -User "$User" -Password "$Password"

Selecting Data

Follow the steps below to retrieve data from the Customers table and pipe the result into to a CSV file:

Select-QuickBooks -Connection $conn -Table Customers | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myCustomersData.csv -NoTypeInformation

You will notice that we piped the results from Select-QuickBooks into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.

The Connection, Table, and Columns are appended to the results in order to facilitate piping results from one of the CData Cmdlets directly into another one.

Deleting Data

The following line deletes any records that match the criteria:

Select-QuickBooks -Connection $conn -Table Customers -Where "Type = Commercial" | Remove-QuickBooks

Inserting and Updating Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into QuickBooks, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyCustomersUpdates.csv | %{
 $record = Select-QuickBooks -Connection $QuickBooks -Table Customers -Where ("Id = `'"+$_.Id+"`'")
 if($record){
 Update-QuickBooks -Connection $quickbooks -Table Customers -Columns ("Name","CustomerBalance") -Values ($_.Name, $_.CustomerBalance) -Where ("Id = `'"+$_.Id+"`'")
 }else{
 Add-QuickBooks -Connection $quickbooks -Table Customers -Columns ("Name","CustomerBalance") -Values ($_.Name, $_.CustomerBalance)
 }
}

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!