QuickBooks: Query a report — salesbyproduct query

← salesbyproduct operations · Get started · OpenAPI downloads

Contract 2026-10-20 · Operation quickbooks.salesbyproduct.query_a_report

Provider route: GET /v3/company/{realmID}/reports/ItemSales. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/quickbooks with npm, or alter-sdk-quickbooks with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { QuickBooksIntegration } from "@alter-ai/quickbooks";

async function execute(input: Parameters<QuickBooksIntegration["salesbyproduct"]["query"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new QuickBooksIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.salesbyproduct.query(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_quickbooks import QuickBooksIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = QuickBooksIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.salesbyproduct.query(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.accounting_method	string	Optional	The accounting method used in the report. Supported Values: Cash , Accrual
query.class	string	Optional	Filters report contents to include information for specified classes if so configured in the company file. Supported Values: One or more comma separated class IDs as returned in the attribute, Class.Id , of the Class entity response code.
query.customer	string	Optional	Filters report contents to include information for specified customers. Supported Values: One or more comma separated customer IDs as returned in the attribute, Customer.Id , of the Customer object response code.
query.date_macro	string	Optional	Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the start_date and end_date to cover an explicit report date range. Supported Values: Today, Yesterday, This Week, Last Week, This Week-to-date, Last Week-to-date, Next Week, Next 4 Weeks, This Month, Last Month, This Month-to-date, Last Month-to-date, Next Month, This Fiscal Quarter, Last Fiscal Quarter, This Fiscal Quarter-to-date, Last Fiscal Quarter-to-date, Next Fiscal Quarter, This Fiscal Year, Last Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year-to-date, Next Fiscal Year
query.department	string	Optional	Filters report contents to include information for specified departments if so configured in the company file. Supported Values: One or more comma separated department IDs as returned in the attribute, Department.Id of the Department object response code.
query.end_date	string	Optional	If not specified value of date_macro is used. The end date of the report, in the format YYYY-MM-DD . start_date must be less than end_date . Use if you want the report to cover an explicit date range; otherwise, use date_macro to cover a standard report date range.
query.end_duedate	string	Optional	The range of dates over which receivables are due, in the format YYYY-MM-DD . start_duedate must be less than end_duedate . If not specified, all data is returned.
query.item	string	Optional	Filters report contents to include information for specified items. Supported Values: One or more comma separated item IDs as returned in the attribute, Item.Id ,of the Item entity response code.
query.sort_order	string	Optional	The sort order. Supported Values: ascend , descend
query.start_date	string	Optional	If not specified value of date_macro is used. The start date of the report, in the format YYYY-MM-DD . start_date must be less than end_date . Use if you want the report to cover an explicit date range; otherwise, use date_macro to cover a standard report date range.
query.start_duedate	string	Optional	The range of dates over which receivables are due, in the format YYYY-MM-DD . start_duedate must be less than end_duedate . If not specified, all data is returned.
query.summarize_column_by	string	Optional	The criteria by which to group the report results. Supported Values: Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices
query.minorversion	integer	Optional	Must equal: 75
query.requestid	string	Optional	Minimum length: 1

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Query a report — taxsummary query — response body

Referenced models: Query a report — taxsummary query — response body

Policy, approvals and errors

SDK function policy ID: quickbooks.salesbyproduct.query_a_report. Catalog operation: salesbyproduct/query_a_report. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source