Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/dvlpjrs/guMCP/llms.txt

Use this file to discover all available pages before exploring further.

The QuickBooks server provides comprehensive access to QuickBooks Online data, enabling financial analysis, customer management, and transaction monitoring.

​
Authentication

This server uses OAuth 2.0 authentication with QuickBooks Online.

​
Prerequisites

  • QuickBooks Online Developer account (sign up here)
  • A registered application with scopes:
    • com.intuit.quickbooks.accounting
    • com.intuit.quickbooks.payment

​
Local Setup

  1. Create your app and configure a redirect URI (e.g., http://localhost:8080)
  2. Get your client ID and client secret
  3. Create local_auth/oauth_configs/quickbooks/oauth.json:
{
  "client_id": "xxxxxxxxxxxxxxxxxxxxx",
  "client_secret": "xxxxxxxxxxxxxxxxxxxxx",
  "redirect_uri": "http://localhost:8080",
  "quickbooks_environment": "sandbox"
}
  1. Run authentication:
python src/servers/quickbooks/main.py auth
Credentials are stored at ~/.config/gumcp/quickbooks/{user_id}.json.

​
Resources

The server exposes these QuickBooks resources:
URIDescription
quickbooks://customersAll customers
quickbooks://invoicesAll invoices
quickbooks://accountsChart of accounts
quickbooks://itemsItems/products
quickbooks://billsAll bills
quickbooks://paymentsAll payments

​
Tools

​
Customer Management

Search for customers by name, email, or phone.Parameters:
  • query (string, required): Search query for customer name, email, or phone
  • limit (integer, optional): Maximum number of results (default: 10)
Example:
{
  "query": "acme",
  "limit": 20
}
Implementation: Searches across customer name, email, and phone fields in QuickBooks.

​
Financial Analysis

Generate key financial metrics and ratios for a date range.Parameters:
  • start_date (string, required): Start date (YYYY-MM-DD)
  • end_date (string, required): End date (YYYY-MM-DD)
  • metrics (array, optional): List of metrics to calculate
Available Metrics:
  • current_ratio - Current assets / current liabilities
  • quick_ratio - (Current assets - inventory) / current liabilities
  • debt_to_equity - Total debt / total equity
  • gross_margin - (Revenue - COGS) / Revenue
  • operating_margin - Operating income / Revenue
  • net_margin - Net income / Revenue
Default Metrics: current_ratio, gross_margin, net_marginExample:
{
  "start_date": "2024-01-01",
  "end_date": "2024-12-31",
  "metrics": ["current_ratio", "debt_to_equity", "net_margin"]
}
Analyze cash flow trends and patterns over a date range.Parameters:
  • start_date (string, required): Start date (YYYY-MM-DD)
  • end_date (string, required): End date (YYYY-MM-DD)
  • group_by (string, optional): Group results by ‘month’ or ‘quarter’ (default: month)
Example:
{
  "start_date": "2024-01-01",
  "end_date": "2024-12-31",
  "group_by": "quarter"
}
Analysis Includes:
  • Cash inflows by period
  • Cash outflows by period
  • Net cash flow
  • Trend analysis
Analyze customer payment behavior and patterns.Parameters:
  • customer_id (string, required): QuickBooks customer ID
  • months (integer, optional): Number of months to analyze (default: 12)
Example:
{
  "customer_id": "123",
  "months": 6
}
Analysis Includes:
  • Average days to payment
  • Payment consistency
  • Outstanding balance trends
  • Late payment patterns

​
Transaction Management

Identify potential duplicate transactions.Parameters:
  • start_date (string, required): Start date (YYYY-MM-DD)
  • end_date (string, required): End date (YYYY-MM-DD)
  • amount_threshold (number, optional): Minimum amount to consider (default: 100)
Example:
{
  "start_date": "2024-01-01",
  "end_date": "2024-03-31",
  "amount_threshold": 50
}
Detection Criteria:
  • Same amount
  • Same date (or within 1 day)
  • Same vendor/customer
  • Similar descriptions

​
Tax & Compliance

Analyze expenses for potential SR&ED (Scientific Research and Experimental Development) eligibility.Parameters:
  • start_date (string, required): Start date (YYYY-MM-DD)
  • end_date (string, required): End date (YYYY-MM-DD)
  • keywords (array, optional): Additional keywords to search for
Default Keywords:
  • research
  • development
  • experiment
  • testing
  • prototype
  • engineering
Example:
{
  "start_date": "2024-01-01",
  "end_date": "2024-12-31",
  "keywords": ["research", "development", "R&D", "innovation"]
}
Note: This tool is specifically designed for Canadian SR&ED tax credit analysis.

​
API Reference

The server uses the python-quickbooks library to interact with QuickBooks Online API.

​
Authentication Flow

  1. OAuth client created with Intuit credentials
  2. Access token and refresh token managed automatically
  3. Company ID (realm ID) stored with credentials

​
Environment Support

  • Sandbox: For testing (default)
  • Production: For live data
Set via quickbooks_environment in oauth.json.

​
Resource Formatting

Resources are formatted with helper functions:
  • Customers: ID, name, email, phone, balance
  • Invoices: ID, customer, date, amount, balance
  • Accounts: ID, name, type, balance
  • Items: ID, name, type, price
  • Bills: ID, vendor, date, due date, amount, balance
  • Payments: ID, customer, date, amount

​
Error Handling

Comprehensive error handling for:
  • Authentication failures
  • Invalid QuickBooks credentials
  • Missing permissions
  • API rate limits
  • Invalid resource URIs
  • Network errors
All errors are logged and returned with descriptive messages.

Build docs developers (and LLMs) love

Get started for freeTalk to us