Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ej2 committed Jan 3, 2024
1 parent 31f0a1f commit cae8ed1
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
2 changes: 1 addition & 1 deletion Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ urllib3 = ">=2.1.0"
intuit-oauth = "==1.2.4"
requests = ">=2.31.0"
simplejson = ">=3.19.1"
requests_oauthlib = ">=1.3.1"
requests_oauthlib = ">=1.3.1"
6 changes: 2 additions & 4 deletions Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Then create a QuickBooks client object passing in the AuthClient, refresh token,
company_id='COMPANY_ID',
)

If you need to access a minor version (See [Minor versions](https://developer.intuit.com/docs/0100_quickbooks_online/0200_dev_guides/accounting/minor_versions) for
If you need to access a minor version (See [Minor versions](https://developer.intuit.com/app/developer/qbo/docs/learn/explore-the-quickbooks-online-api/minor-versions#working-with-minor-versions) for
details) pass in minorversion when setting up the client:

client = QuickBooks(
Expand All @@ -74,7 +74,9 @@ List of objects:

**Note:** The maximum number of entities that can be returned in a
response is 1000. If the result size is not specified, the default
number is 100. (See [Intuit developer guide](https://developer.intuit.com/docs/0100_accounting/0300_developer_guides/querying_data) for details)
number is 100. (See [Query operations and syntax](https://developer.intuit.com/app/developer/qbo/docs/learn/explore-the-quickbooks-online-api/data-queries) for details)

**Warning:** You should never allow user input to pass into a query without sanitizing it first! This library DOES NOT sanitize user input!

Filtered list of objects:

Expand Down Expand Up @@ -104,6 +106,8 @@ List with custom Where Clause (do not include the `"WHERE"`):

customers = Customer.where("Active = True AND CompanyName LIKE 'S%'", qb=client)



List with custom Where and ordering

customers = Customer.where("Active = True AND CompanyName LIKE 'S%'", order_by='DisplayName', qb=client)
Expand All @@ -112,7 +116,7 @@ List with custom Where Clause and paging:

customers = Customer.where("CompanyName LIKE 'S%'", start_position=1, max_results=25, qb=client)

Filtering a list with a custom query (See [Intuit developer guide](https://developer.intuit.com/docs/0100_accounting/0300_developer_guides/querying_data) for
Filtering a list with a custom query (See [Query operations and syntax](https://developer.intuit.com/app/developer/qbo/docs/learn/explore-the-quickbooks-online-api/data-queries) for
supported SQL statements):

customers = Customer.query("SELECT * FROM Customer WHERE Active = True", qb=client)
Expand Down

0 comments on commit cae8ed1

Please sign in to comment.