QuickbooksOnlineSDK
Python SDK for accessing QBO APIs.
Installation
This project requires Python 3+ and Requests library (pip install requests).
-
Download this project and use it (copy it in your project, etc).
-
Install it from pip.
$ pip install qbosdk
Usage
To use this SDK you'll need these QBO credentials used for OAuth2 authentication: client ID, client secret and refresh token.
This SDK is very easy to use.
- First you'll need to create a connection using the main class QuickbooksOnlineSDK.
from qbosdk import QuickbooksOnlineSDK
connection = QuickbooksOnlineSDK(
client_id='<YOUR CLIENT ID>',
client_secret='<YOUR CLIENT SECRET>',
refresh_token='<YOUR REFRESH TOKEN>',
realm_id='<REALM / COMPANY ID>',
environment='<sandbox / production>'
)
- After that you'll be able to access any of the API classes
"""
USAGE: <QuickbooksOnlineSDK INSTANCE>.<API_NAME>.<API_METHOD>(<PARAMETERS>)
"""
# Get a list of all Employees (with all available details for Employee)
response = connection.employees.get()
# Get a list of all Accounts
response = connection.accounts.get()
See more details about the usage into the wiki pages of this project.
Integration Tests
To run integration tests, you will need a mechanism to connect to a real qbo account. Save this info in a test_credentials.json file in your root directory:
{
"client_id": "<client_id>",
"client_secret": "<client_secret>",
"realm_id": "<realm_id>",
"refresh_token": "<refresh_token>",
"environment": "<environment sandbox / production>"
}
$ pip install pytest
$ python -m pytest test/integration
License
This project is licensed under the MIT License - see the LICENSE file for details
1 maintainer
Metadata
1 maintainer
Release files for qbosdk 1.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| qbosdk-1.6.1.tar.gz | 15.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| qbosdk-1.6.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 39.5 kB
Release files / qbosdk-1.6.1.tar.gz
| Download URL | qbosdk-1.6.1.tar.gz |
|---|---|
| Size | 15.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0618cf78ebc0dbad791020bd0950407c84e4fcec498e8b3eceedbc93cccf5cf5
|
|
BLAKE2b-256 checksum How to use checksums |
d384e6c972b2b855859ea99ce6fc8694fa07ecbe06e097bc1e887e7b72fa6ef1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / qbosdk-1.6.1-py3-none-any.whl
| Download URL | qbosdk-1.6.1-py3-none-any.whl |
|---|---|
| Size | 24.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8afc3c309cc9901ca0d627e47c5b0de670cf39cd27e869725157c0f1bf52d957
|
|
BLAKE2b-256 checksum How to use checksums |
f32cdecdab09b4b7623f29fa7d88ef77208d681230a891b428313579728cca12
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
