README.md

tap-quickbooks-report

A Singer tap for extracting data from the Report Entities in the Quickbooks Online API.

Configuration

The Quickbooks Online API provides authentication via OAuth2.0. The tap expects the user to provide a valid Refresh Token via a config file. You can kick off a OAuth2.0 User Consent process using the --auth argument while running the tap:

(tap-quickbooks-report) bash-3.2$ tap-quickbooks-report --auth

If you are an admin of the Quickbooks account, you will be able to authorize the Singer Tap application to access your account. You will then be redirected to a developer portal where you can access a valid Authentication Code and Realm ID. Copy and paste these values into the corresponding prompts in your terminal:

(tap-quickbooks-report) bash-3.2$ tap-quickbooks-report --auth
INFO Starting User Consent process..
Enter the Authorization Code: <auth-code>
Enter the Realm ID: <realm-id>

After entering the Authorization Code and Realm ID values, the tap will write the Realm ID, Refresh Token, and Refresh Token Expiration Date to the existing Config file:

(tap-quickbooks-report) bash-3.2$ tap-quickbooks-report --auth
INFO Starting User Consent process..
Enter the Authorization Code: <auth-code>
Enter the Realm ID: <realm-id>
INFO Generating new config..