Overview

The Reports API lets you generate downloadable reports from your Taxbit data. Reports are processed asynchronously — you trigger a report, poll for its status, and download the result when ready.

Available Reports

Inventory Summary: Generates a per-account inventory summary including asset quantities, cost basis, and average unit cost. You can optionally scope the report to specific accounts.

Prerequisites

1. A tenant-scoped bearer token must be created via the Auth Token endpoint.

Workflow

1. Trigger a report — Call POST /reports/inventory-summary with your parameters. You will receive a report_id and an initial status of pending.
2. Poll for status — Call GET /reports/inventory-summary/{reportId} with the report_id. The status will transition through pending → processing → completed (or failed).
3. Download the report — Once the status is completed, use the download_url from the GET response to download your report. The URL is valid for 15 minutes. You can call the GET endpoint again to receive a fresh URL.

Report Retention: Reports are available for 30 days after creation. After 30 days, the report and its data are automatically deleted.

Response Metadata

When a report is completed, the GET response includes a metadata object that summarizes what was included in the report. The structure varies depending on whether you specified account_ids in the request.

When account_ids is provided:

{
  "metadata": {
    "total_accounts_requested": 100,
    "total_accounts_included": 95,
    "skipped_account_ids": {
      "not_found_in_organization": ["account-98", "account-99", "account-100"]
    }
  }
}

• total_accounts_requested: The number of account IDs you provided.
• total_accounts_included: The number of accounts that were found and included in the report.
• skipped_account_ids.not_found_in_organization: Account IDs that could not be found in your organization. Only present if any accounts were skipped.

When account_ids is omitted (all accounts):

{
  "metadata": {
    "total_accounts_included": 1500
  }
}

• total_accounts_included: The total number of accounts in your organization that were included in the report.