QuickBooks: Query a report — vendorbalancedetail query

← vendorbalancedetail operations · Get started · OpenAPI downloads

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

Provider route: GET /v3/company/{realmID}/reports/VendorBalanceDetail. 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["vendorbalancedetail"]["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.vendorbalancedetail.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.vendorbalancedetail.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.appaid	string	Optional	Status of the balance. Supported Values: Paid , Unpaid , All
query.columns	string	Optional	Column types to be shown in the report. Supported Values: create_by, create_date, doc_num*, due_date*, last_mod_by, last_mod_date, memo*, term_name, tx_date*, txn_type*, vend_bill_addr, vend_comp_name, vend_name*, vend_pri_cont, vend_pri_email, vend_pri_tel Additional columns with location tracking enabled: dept_name*
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.duedate_macro	string	Optional	Predefined date range of due dates for balances to include in the report; otherwise, use the start_duedate and end_duedate 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.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.report_date	string	Optional	Start date to use for the report, in the format YYYY-MM-DD .
query.sort_by	string	Optional	The column type used in sorting report rows. Specify a column type as defined with the columns query parameter.
query.sort_order	string	Optional	The sort order. Supported Values: ascend , descend
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.term	string	Optional	Filters report contents based on term or terms supplied. Supported Values: One or more comma separated term IDs as returned in the attribute, Term.Id of the Term object response code.
query.vendor	string	Optional	Filters report contents to include information for specified vendors. Supported Values: One or more comma separated vendor IDs as returned in the attribute, Vendor.Id , of the Vendor object response code.
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.vendorbalancedetail.query_a_report. Catalog operation: vendorbalancedetail/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