🚀 Quick Links
🔌 Connection Management
POST /api/connection/connect
Establish WebSocket connection to QuickBooks for API key
POST /api/connection/disconnect
Disconnect WebSocket connection for API key
GET /api/connection/status
Get connection status and health for API key
GET /api/connection/pool/status
Get status of all connections in the pool (admin)
💰 Accounts (Chart of Accounts)
POST /api/accounts
Create a new account
GET /api/accounts
Query accounts with filters and pagination
GET /api/accounts/{list_id}
Get a specific account by ListID
PUT /api/accounts/{list_id}
Update account information
DELETE /api/accounts/{list_id}
Deactivate account (mark as inactive)
GET /api/accounts/tax-lines
Get tax line information for account mapping
💳 AR Credit Card Refunds
POST /api/ar-refunds/credit-card
Create a credit card refund for a customer
GET /api/ar-refunds/credit-card
Query credit card refunds with filters
GET /api/ar-refunds/credit-card/{txn_id}
Get a specific refund by Transaction ID
GET /api/ar-refunds/credit-card/by-customer/{customer_id}
Get all refunds for a specific customer
💸 Bills & Payments
POST /api/bills
Create a new bill from vendor
GET /api/bills
Query bills with filters and pagination
GET /api/bills/{txn_id}
Get a specific bill by Transaction ID
PUT /api/bills/{txn_id}
Update an existing bill
GET /api/bills/to-pay
Get bills that need to be paid with discount info
GET /api/bills/unpaid/summary
Get summary of unpaid bills with aging information
POST /api/bills/payment/check
Pay bills by check
GET /api/bills/payments/check
Query check payments
PUT /api/bills/payments/check/{txn_id}
Update check payment details
POST /api/bills/payments/credit-card
Pay bills by credit card
GET /api/bills/payments/credit-card
Query credit card payments
POST /api/bills/billing-rates
Create billing rate for time tracking
GET /api/bills/billing-rates
Query billing rates
POST /api/bills/from-purchase-order
Create bill from a purchase order
👥 Customers
POST /api/customers
Create a new customer in QuickBooks
GET /api/customers
Query customers with filters (name, status, etc.)
GET /api/customers/{list_id}
Get a specific customer by ListID
PUT /api/customers/{list_id}
Update customer information
📦 Items
POST /api/items
Create a new item in QuickBooks
GET /api/items
Query items with advanced filtering and pagination
GET /api/items/{list_id}
Get a specific item by ListID
PUT /api/items/{list_id}
Update item information
DELETE /api/items/{list_id}
Delete item (soft delete)
📋 Supporting Lists
GET /api/lists/help/list-types
Get information about all supported list types
GET /api/lists/terms
Get payment terms (Net 30, 2/10 Net 30, etc.)
GET /api/lists/customer-types
Get customer types for categorization
GET /api/lists/vendor-types
Get vendor types for categorization
GET /api/lists/payment-methods
Get payment methods (Cash, Check, Credit Card)
🏢 Vendors
POST /api/vendors
Create a new vendor in QuickBooks
GET /api/vendors
Query vendors with filters (name, status, etc.)
GET /api/vendors/{list_id}
Get a specific vendor by ListID
PUT /api/vendors/{list_id}
Update vendor information
DELETE /api/vendors/{list_id}
Mark vendor as inactive
🔧 Utility Operations
GET /api/company
Get company information
GET /api/host
Get QuickBooks host information
POST /api/qbxml
Send raw QBXML request
⚙️ Configuration
WebSocket Server: wss://qb-test.solvedsolutions.net:8765
QBXML Version: 16.0
Request Timeout: 300 seconds
📝 Authentication
Include your API key in requests using:
- Header:
X-API-Key: your-api-key - Body:
{"api_key": "your-api-key"}(for POST requests)