TaxDebug for WooCommerce

外掛說明

Are your WooCommerce taxes actually correct?

If you’re using WooCommerce Tax, TaxJar, or Avalara to calculate sales tax automatically, you’re trusting a black box with your compliance. But what happens when it gets it wrong?

  • A customer in Ohio gets charged $0 tax — and you don’t find out until quarter-end
  • WooCommerce Tax under-collects county-level tax on 200 orders before you notice
  • Your effective rate suddenly drops and you have no idea why
  • Your accountant asks “how was this tax calculated?” and you have no answer

TaxDebug for WooCommerce is your tax safety net. It watches every order, detects problems automatically, and gives you the audit trail your accountant needs.

What TaxDebug Does For You

1. Catches Tax Mistakes Automatically
Our Issue Detection Engine scans every order and flags:
* Zero tax collected where tax was expected
* Tax charged in non-taxable regions (customers complaining about overcharges)
* Rate mismatches vs. reference rates
* Missing local/county/city taxes
* Tax amount changes between cart and checkout
* Suspected API errors from your tax service

2. Shows You Exactly How Every Order Was Taxed
Stop guessing. For every order, TaxDebug shows you:
* Which tax service calculated the rates (WooCommerce Core, WooCommerce Tax, TaxJar, Avalara)
* The exact tax rates applied at line-item level
* Full calculation breakdowns so you can verify accuracy
* Which jurisdiction triggered each tax amount

3. Gives Your Accountant What They Need
Export audit-ready reports in seconds:
* Summary reports by country and state
* Detailed order-level tax breakdowns (CSV, Excel-compatible)
* Issue reports for your review and resolution
* Filter by date range, country, state, tax source, and more

4. Beautiful Dashboard at a Glance
* KPI cards: total tax collected, taxable sales, effective rates
* Interactive charts: tax by state, country, and over time
* One-click issue identification — see which orders need attention

5. 100% Safe — Never Touches Your Tax Calculations
TaxDebug only observes and reports. It does NOT modify how taxes are calculated, does NOT interfere with your existing tax setup, and works alongside any tax plugin.

Who Is TaxDebug For?

  • Store owners who use automated tax services and want to trust but verify
  • Accountants and bookkeepers who need detailed tax breakdowns for filings
  • Agency managers who manage multiple WooCommerce stores and need tax oversight
  • Anyone who has been burned by a tax calculation error and doesn’t want it to happen again

Compatibility

TaxDebug works with any WooCommerce tax setup:
* WooCommerce Core tax rates (manual rates)
* WooCommerce Tax (automated taxes via TaxJar)
* TaxJar plugin
* Avalara AvaTax
* Any other tax plugin or custom calculation

Requirements

  • WordPress 5.8 or higher
  • WooCommerce 5.0 or higher
  • PHP 7.4 or higher

Privacy

TaxDebug stores order tax data locally in your WordPress database. This includes:
* Order IDs and dates
* Customer billing/shipping addresses (country, state, city, postcode only)
* Order totals and tax amounts
* Tax calculation details

TaxDebug does NOT:
* Store payment information
* Store full customer names or personal details beyond address location

Data retention can be configured in Settings. You can also manually clear all logs at any time.

Feedback Collection

TaxDebug collects optional feedback to improve the plugin:

  • In-app feedback: Report false positives, false negatives, feature requests, or success stories
  • Usage analytics: Anonymous local tracking of which features are used
  • Deactivation survey: Optional one-question survey when deactivating

Local Storage: All feedback is always stored locally in your WordPress database.

Optional Remote Sending: You can opt-in to send anonymous feedback to the developer to help improve TaxDebug. This is disabled by default and must be explicitly enabled in Settings.

What IS Sent (When Opted-In)

  • Anonymous store UUID (random identifier, NOT your domain)
  • Feedback type and message
  • Your email (only if you voluntarily provide it)
  • Store country and currency
  • Active tax plugin (e.g., TaxJar, Avalara)
  • Plugin, WordPress, and WooCommerce versions
  • Daily aggregated counts: orders logged, issues detected, features used

What is NEVER Sent

  • Your site URL or domain name
  • Customer names, emails, or addresses
  • Order details, totals, or line items
  • Tax amounts or financial data
  • Any personally identifiable information (PII)

How to Disable Remote Sending

Go to WooCommerce TaxDebug Settings and turn off “Send Anonymous Feedback”. You can do this at any time. Local feedback storage will continue to work.

Developer Notes

Hooks & Filters

TaxDebug provides several hooks for extensibility:

Actions:
* taxdebug_loaded – Fired when TaxDebug is fully loaded
* taxdebug_order_logged – Fired when an order is logged (params: log_id, order_id, payload)
* taxdebug_installed – Fired on plugin installation
* taxdebug_logs_cleaned_up – Fired when old logs are cleaned up

Filters:
* taxdebug_order_payload – Filter the order payload before logging
* taxdebug_detected_issues – Add custom issue detection rules

REST API Endpoints

TaxDebug provides a REST API under the taxdebug/v1 namespace:

  • GET /logs – Get tax logs with filtering
  • GET /logs/{id} – Get single log
  • GET /logs/order/{order_id} – Get log by order ID
  • POST /logs/reanalyze/{order_id} – Re-analyze an order
  • GET /issues – Get detected issues
  • GET /stats/dashboard – Get dashboard statistics
  • GET /stats/chart/time – Get time series chart data
  • GET /stats/chart/state – Get tax by state data
  • GET /stats/chart/country – Get tax by country data
  • GET /export/summary – Export summary CSV
  • GET /export/detailed – Export detailed CSV
  • GET /export/issues – Export issues CSV

All endpoints require manage_woocommerce capability.

Database Tables

TaxDebug creates custom tables:

  • {prefix}taxdebug_logs – Stores order tax log data
  • {prefix}taxdebug_issues – Stores detected issues
  • {prefix}taxdebug_feedback – Stores user feedback submissions
  • {prefix}taxdebug_analytics – Stores usage analytics
  • {prefix}taxdebug_error_logs – Stores internal error logs

WP-CLI Commands

(Coming in future versions)

螢幕擷圖

  • Dashboard Overview — KPI cards showing total tax collected, taxable sales, effective rates, and interactive charts by state/country/over time
  • Issue Detection — Automatically flagged orders with tax problems: zero tax, rate mismatches, missing local taxes, and more

安裝方式

  1. Upload the taxdebug-for-woocommerce folder to /wp-content/plugins/
  2. Activate the plugin through the ‘Plugins’ menu in WordPress
  3. Go to WooCommerce TaxDebug to access the dashboard
  4. (Optional) Go to Settings to configure logging and retention options
  5. (Optional) Use “Analyze Past Orders” in Settings to check your existing order history

Quick Start

  1. After activation, TaxDebug will automatically log tax data for new orders
  2. Visit WooCommerce TaxDebug to see the dashboard
  3. Check the Issues tab — are any orders flagged?
  4. Use Order Explorer to search and filter orders
  5. Click on any order to see exactly how taxes were calculated
  6. Export reports your accountant needs in CSV format

常見問題集

Does TaxDebug change how my taxes are calculated?

No. TaxDebug is completely non-intrusive. It only observes and logs tax calculation data — it never modifies tax amounts or rates. Think of it as a read-only audit tool.

What data does TaxDebug store?

TaxDebug stores:
* Order IDs and dates
* Customer shipping/billing addresses (country, state, city, postcode only)
* Order totals and tax amounts
* Applied tax rates and calculation details

TaxDebug does NOT store payment information or sensitive personal data.

Does TaxDebug send data to external servers?

TaxDebug uses a cloud-based analysis service (api.taxdebug.com) to provide intelligent tax issue detection. This service:
* Receives order tax data (amounts, rates, locations) for analysis
* Returns detected issues (e.g., rate mismatches, missing taxes)
* Does NOT store personally identifiable customer information
* Does NOT require an account or API key

All other data (logs, settings, feedback) is stored locally in your WordPress database. For privacy details, see our Privacy Policy.

How long is data retained?

By default, data is retained for 12 months. You can configure this in Settings (3, 6, 12, or 24 months, or forever).

Can I analyze orders that were created before installing TaxDebug?

Yes! Go to Settings and use the “Analyze Past Orders” tool to retroactively check your existing order history for tax issues.

What are “reference rate checks”?

TaxDebug includes approximate tax rate data for US states, Canadian provinces, and EU countries. It compares your effective tax rates against these references to detect potential mismatches — so you can catch under-collection or over-collection early. This can be disabled in Settings.

Can I export reports for my accountant?

Yes! TaxDebug exports three types of CSV reports: summary by country/state, detailed order-level breakdowns, and detected issues. All CSV files are Excel-compatible and can be shared directly with your accountant or bookkeeper.

What tax plugins does TaxDebug work with?

TaxDebug works with WooCommerce Core tax rates, WooCommerce Tax (automated taxes via TaxJar), the TaxJar plugin, Avalara AvaTax, and any other WooCommerce tax calculation method. It simply observes the taxes that were applied — it doesn’t care how they were calculated.

Will TaxDebug slow down my store?

No. TaxDebug logs tax data asynchronously after orders are placed. It does not intercept or modify the checkout process in any way, so there is zero impact on your store’s performance or customer experience.

使用者評論

這個外掛目前沒有任何使用者評論。

參與者及開發者

以下人員參與了開源軟體〈TaxDebug for WooCommerce〉的開發相關工作。

參與者

將〈TaxDebug for WooCommerce〉外掛本地化為台灣繁體中文版

對開發相關資訊感興趣?

任何人均可瀏覽程式碼、查看 SVN 存放庫,或透過 RSS 訂閱開發記錄

變更記錄

1.2.2

  • NEW: Settings License tab with trial countdown, feature comparison table, and purchase CTA for each state
  • NEW: Reset Trial button for developer testing
  • FIX: Use correct license status string (‘active’ instead of ‘purchased’) to match TaxDebug_Pro::get_license_status()
  • FIX: Reference Rate Checks setting no longer shows PRO badge (gating still works via issue detector)
  • FIX: Remove ‘purchased’ terminology — now uses ‘active’ / ‘expired’ / ‘trialing’ consistently

1.2.1

  • FIX: Log LICENSE_REQUIRED responses as info instead of error to prevent false error log entries
  • FIX: Include HTTP status code in Lambda API error messages for easier debugging
  • FIX: Add expandable context details to error log viewer
  • FIX: Limit plugin tags to 5 per WordPress.org requirements
  • FIX: Remove invalid contributor per WordPress.org requirements
  • FIX: Shorten short description to 150 characters per WordPress.org requirements
  • FIX: Update screenshots to match current UI

1.2.0

  • NEW: 7-day free trial with all features unlocked
  • NEW: Subscription model — continue with free tier or upgrade for full access
  • NEW: 4 additional subscription-only issue detection rules (missing local taxes, cart-to-checkout changes, API errors, shipping tax anomalies)
  • NEW: Reference rate checks (subscription)
  • NEW: Historical order analysis — “Analyze Past Orders” tool (subscription)
  • NEW: Full CSV export suite — summary (free), detailed + issues (subscription)
  • NEW: License tab in Settings with trial status and subscription management
  • NEW: Upgrade prompts with context-specific messaging on gated features
  • NEW: First-install admin notice
  • NEW: Deferred license check via Lambda API (no separate API call — status derived from analyze responses)
  • IMPROVED: Search-optimized tags for better discoverability (24 tags)
  • IMPROVED: Rewritten description focused on user benefits and pain points
  • IMPROVED: Richer FAQ with trial and subscription answers

1.1.0

  • NEW: In-app feedback widget on all TaxDebug screens
  • NEW: Feedback admin page (WooCommerce TaxDebug Feedback)
  • NEW: Report false positives and false negatives
  • NEW: Submit feature requests and success stories
  • NEW: Privacy-first usage analytics (local storage)
  • NEW: Optional remote feedback sending to developer (opt-in, disabled by default)
  • NEW: Deactivation exit survey
  • NEW: Internal error logging for debugging
  • NEW: CSV export for feedback data
  • Added opt-in/opt-out for local analytics in Settings
  • Added opt-in for anonymous remote feedback sending (off by default)
  • Clear documentation of what data is/isn’t sent remotely

1.0.0

  • Initial release
  • Dashboard with KPIs and charts
  • Order Explorer with search and filtering
  • Detailed Order Debug View
  • Issue Detection Engine with 7 detection rules
  • CSV exports (summary, detailed, issues)
  • Sample data generator for testing
  • Support for WooCommerce Core, WooCommerce Tax, TaxJar, and Avalara