Cmdlets for QuickBooks Online

Build 24.0.9060

Getting Started

Connecting to QuickBooks Online

Establishing a Connection shows how to authenticate to QuickBooks Online and configure any necessary connection properties. You can also configure cmdlet capabilities through the available Connection properties, from data modeling to firewall traversal. The Advanced Settings section shows how to set up more advanced configurations and troubleshoot connection errors.

Connecting from PowerShell

The CData Cmdlets PowerShell Module for QuickBooks Online provides a familiar way to interact with QuickBooks Online from PowerShell. The cmdlets provide a standard PowerShell interface and an SQL interface to live data. The CData cmdlets enable you to work with QuickBooks Online using standard PowerShell objects; you can chain the cmdlets to each other or other cmdlets in pipelines. The cmdlets also support PowerShell debug streams.

Data Manipulation with Cmdlets

See Establishing a Connection to learn how to get started with the Connect-QBOnline cmdlet. You can then pass the QBOnlineConnection object returned to other cmdlets for accessing data:

  • Select-QBOnline
  • Add-QBOnline
  • Update-QBOnline
  • Remove-QBOnline

Executing SQL from PowerShell

You can execute any SQL query with the Invoke-QBOnline cmdlet.

Accessing Debug Output from Streams

See Capturing Errors and Logging to obtain the debug output through PowerShell streams.

PowerShell Version Support

The standard cmdlets are supported in PowerShell 2, 3, 4, and 5.

QuickBooks Online Version Support

The cmdlet models the QuickBooks Online Accounting APIs as a relational database.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060