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.5.3
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.5.3.tar.gz | 15.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| qbosdk-1.5.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 39.2 kB
Release files / qbosdk-1.5.3.tar.gz
| Download URL | qbosdk-1.5.3.tar.gz |
|---|---|
| Size | 15.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
67651e0dab1d3b6705f0111c6a4c6a2b08575d0b8eee961fbdbfc04e2e793388
|
|
BLAKE2b-256 checksum How to use checksums |
31a4db3fff56b0bce9fe1ea4dfbec3b341f7ec55c0fc4c43eb6b2786629b4860
|
| 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.5.3-py3-none-any.whl
| Download URL | qbosdk-1.5.3-py3-none-any.whl |
|---|---|
| Size | 24.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
da5c56c62efee14c84c0a6f13ba492087420e93965c0f4f61255af17c8e58f73
|
|
BLAKE2b-256 checksum How to use checksums |
2b96ec63bf348d677a61d0098ee20281b5700ed95b367e92c40ccc8da80d6521
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
