python-quickbooks Reference

from quickbooks.objects.customer import Customer
from quickbooks.objects.invoice import Invoice

# Get by ID
customer = Customer.get(1, qb=client)

# Save (create or update — determined by presence of Id)
customer = Customer()
customer.DisplayName = "New Customer"
customer.save(qb=client)

# List all (max 100 by default)
customers = Customer.all(qb=client)

# Filter with kwargs
customers = Customer.filter(Active=True, CompanyName="Acme", qb=client)

# Raw WHERE clause
customers = Customer.where("Active = true AND Balance > '100'", qb=client)

# Raw SQL query
customers = Customer.query("SELECT * FROM Customer WHERE Active = true", qb=client)

# Count
count = Customer.count("Active = true", qb=client)

# Choose (IN-style query)
customers = Customer.choose([1, 2, 3], field="Id", qb=client)

# Delete (requires Id + SyncToken — not all objects support delete)
invoice = Invoice.get(42, qb=client)
invoice.delete(qb=client)

# Void (Invoice, Payment, BillPayment, SalesReceipt)
invoice.void(qb=client)

# Send via email
invoice.send(qb=client)
invoice.send(qb=client, send_to="[email protected]")

# Download PDF (Invoice, Estimate, SalesReceipt)
pdf_data = invoice.download_pdf(qb=client)

Object Capabilities Matrix

*Preferences uses PrefMixin.get() (no id param). ExchangeRate uses UpdateNoIdMixin. RecurringTransaction uses UpdateNoIdMixin/DeleteNoIdMixin.

Critical Notes

• PascalCase naming: All object properties use PascalCase (e.g., DisplayName, TotalAmt), NOT Python snake_case. This matches the QBO API directly.
• 1000 entity max: QBO API returns max 1000 entities per query. Use start_position and max_results for pagination.
• No input sanitization: The library does not sanitize query inputs. Escape user input in WHERE clauses yourself.
• Minor version required: As of v0.9.8+, you must specify minorversion explicitly. Default minimum is 75. See Intuit deprecation notice.
• Singleton behavior: By default, QuickBooks() creates a new instance each call. To enable singleton, use the mangled name: QuickBooks._QuickBooks__use_global = True (the __use_global attribute is name-mangled; QuickBooks.__use_global = True silently creates a new attribute).
• Sparse updates: Always set obj.sparse = True before save() on updates to avoid overwriting unset fields. Full updates (default) replace ALL fields. See CRUD Operations.
• Rate limits: QBO enforces 500 requests/min and 10 concurrent per realm. The library does no rate limiting or retry. See Advanced Features.
• SalesReceipt/RefundReceipt empty detail_dict: Both have detail_dict = {}, so all lines deserialize as generic DetailLine — you lose typed detail attributes. Manually check DetailType and access raw dicts. See Financial Objects.
• Single-use refresh tokens: Each refresh invalidates the previous token. Persist the new refresh token immediately after client init, or risk requiring full re-authorization. See Authentication.
• CreditMemo DetailType key: CreditMemo uses "DescriptionLineDetail" where Invoice/Estimate use "DescriptionOnly" for description-only lines. Code that works for invoices silently falls back to generic DetailLine on CreditMemos. See Line Items.
• save() determines create vs update: If obj.Id exists and > 0, it updates; otherwise it creates.
• delete() needs SyncToken: Always get() the object first before deleting to ensure you have the current SyncToken.

Reference Index

Detailed documentation is available in the following reference files. Read these on demand for comprehensive coverage:

• Authentication — AuthClient, OAuth, env vars, sandbox vs production, refresh tokens, minor version
• Querying — all, filter, where, query, count, choose, pagination, ordering
• CRUD Operations — get, save, delete, void, send, download_pdf
• Object Capabilities — Full capabilities matrix with import paths
• Entity Objects — Customer, Vendor, Employee, Department, CompanyCurrency, CustomerType
• Financial Objects — Invoice, Bill, Payment, Estimate, Purchase, SalesReceipt, etc.
• Items & Accounting — Item, Account, Term, Class, Budget, TimeActivity, ExchangeRate
• Tax & Settings — TaxCode, TaxRate, Preferences, CompanyInfo, Attachable, RecurringTransaction
• Line Items — DetailLine types, SalesItemLine, AccountBasedExpenseLine, all line detail types
• Batch Operations — batch_create/update/delete, result handling
• Advanced Features — CDC, attachments, reports, recurring transactions, webhooks
• Helpers & Errors — Date formatting, JSON utilities, exception hierarchy
• Examples — Complete working examples end-to-end