README
¶
.png#keepProtocol){kind=logo}
Quickbooks Online Plugin for Steampipe
Use SQL to query accounting data from QuickBooks Online (QBO).
- Get started →
- Documentation: Table definitions & examples
- Community: Join #steampipe on Slack →
- Get involved: Issues
Quick start
Install
Download and install the latest QuickBooks Online plugin:
steampipe plugin install qbo
Configure your config file in ~/.steampipe/config/qbo.spc:
connection "qbo" {
plugin = "qbo"
# Sandbox configuration
baseURL = "https://sandbox-quickbooks.api.intuit.com"
discoveryDocumentURL = "https://developer.api.intuit.com/.well-known/openid_sandbox_configuration"
clientId = "[Client ID]"
clientSecret = "[Client Secret]"
realmId = "[Realm ID]"
accessToken = "[Access Token]"
refreshToken = "[Refresh Token]"}
Run steampipe:
steampipe query
Get information about the QuickBooks Online company:
select
id,
company_name
from
qbo_company_info;
+----+--------------+
| id | company_name |
+----+--------------+
| 1 | Cloudticity |
+----+--------------+
Engines
This plugin is available for the following engines:
| Engine | Description |
|---|---|
| Steampipe | The Steampipe CLI exposes APIs and services as a high-performance relational database, giving you the ability to write SQL-based queries to explore dynamic data. Mods extend Steampipe's capabilities with dashboards, reports, and controls built with simple HCL. The Steampipe CLI is a turnkey solution that includes its own Postgres database, plugin management, and mod support. |
| Postgres FDW | Steampipe Postgres FDWs are native Postgres Foreign Data Wrappers that translate APIs to foreign tables. Unlike Steampipe CLI, which ships with its own Postgres server instance, the Steampipe Postgres FDWs can be installed in any supported Postgres database version. |
| SQLite Extension | Steampipe SQLite Extensions provide SQLite virtual tables that translate your queries into API calls, transparently fetching information from your API or service as you request it. |
| Export | Steampipe Plugin Exporters provide a flexible mechanism for exporting information from cloud services and APIs. Each exporter is a stand-alone binary that allows you to extract data using Steampipe plugins without a database. |
| Turbot Pipes | Turbot Pipes is the only intelligence, automation & security platform built specifically for DevOps. Pipes provide hosted Steampipe database instances, shared dashboards, snapshots, and more. |
Developing
Prerequisites:
Clone:
git clone https://github.com/Cloudticity/steampipe-plugin-qbo.git
cd steampipe-plugin-qbo
Build, which automatically installs the new version to your ~/.steampipe/plugins directory:
make
Configure the plugin:
cp config/* ~/.steampipe/config
vi ~/.steampipe/config/qbo.spc
Try it!
steampipe query
> .inspect qbo
Further reading:
Open Source & Contributing
This repository is published under the Apache 2.0 (source code) and CC BY-NC-ND (docs) licenses. Please see our code of conduct. We look forward to collaborating with you!
Steampipe is a product produced from this open source software, exclusively by Turbot HQ, Inc. It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our Open Source FAQ.
Get Involved
Want to help but don't know where to start? Pick up one of the help wanted issues:
Documentation
¶
There is no documentation for this package.
Source Files
Directories