QuickBooks: Query a report — transactionlistbyvendor query

← transactionlistbyvendor operations · Get started · OpenAPI downloads

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

Provider route: GET /v3/company/{realmID}/reports/TransactionListByVendor. 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["transactionlistbyvendor"]["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.transactionlistbyvendor.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.transactionlistbyvendor.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.appaid	string	Optional	Status of the balance. Supported Values: Paid , Unpaid , All
query.arpaid	string	Optional	Supported Values: All , Paid , Unpaid
query.bothamount	string	Optional	Filters report contents to include information for specified transaction amount. For example, bothamount=1233.45 limits report contents to transactions of amount 1233.45.
query.cleared	string	Optional	Filters report contents to include information for specified check status. Supported Values: Cleared : The transaction has been processed by a bank or credit card account and is reflected in the bank balance. Uncleared : A financial entry that has not been reconciled or matched with the corresponding bank statement records. Reconciled : The transaction has been compared to original records and verified as correct. Deposited : A deposit was made into a bank account, such as a checking account.
query.columns	string	Optional	Column types to be shown in the report. Supported Values: account_name*, create_by, create_date, cust_msg, due_date, doc_num*, inv_date, is_ap_paid, is_cleared, is_no_post*, last_mod_by, memo*, name*, other_account*, pmt_mthd, printed, sales_cust1, sales_cust2, sales_cust3, term_name, tracking_num, tx_date*, txn_type*, term_name, last_mod_date, po_status, ship_via, olb_status, vendor_name Additional columns when location tracking enabled: dept_name* Additional columns with location tracking enabled: dept_name* Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here .
query.createdate_macro	string	Optional	Predefined report account create date range. Use if you want the report to cover a standard create report date range; otherwise, use start_createdate and end_createdate 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.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, This Calendar Quarter, This Calendar Quarter-to-date, Last Calendar Quarter, Last Calendar Quarter-to-date, Next Calendar Quarter, This Calendar Year, This Calendar Year-to-date, Last Calendar Year, Last Calendar Year-to-date, Next Calendar 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.docnum	string	Optional	Filters report contents to include information for specified transaction number, as found in the docnum parameter of the transaction object.
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_createdate	string	Optional	Specify an explicit account create report date range, 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 createdate_macro to cover a standard report date range. (This field is not currently available.)
query.end_date	string	Optional	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. If not specified value of date_macro is used
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.end_moddate	string	Optional	(Account List Detail) Specify an explicit account modification report date range, 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 the moddate_macro to cover a standard report date range.
query.group_by	string	Optional	The field in the transaction by which to group results. Supported Values: Name, Account, Transaction Type, Customer, Vendor, Employee, Location, Payment Method, Day, Week, Month, Quarter, Year, Fiscal Year, Fiscal Quarter, None
query.memo	string	Optional	Filters report contents to include information for specified memo. Supported Values: One or more comma separated memo IDs.
query.moddate_macro	string	Optional	Predefined report account modification date range. Use if you want the report to cover a standard report date range when accounts were modified; otherwise, use the start_moddate and end_moddate 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.name	string	Optional	Filters report contents based on the specified comma separated list of ids for the name list customer, vendor, or employee objects. Query the Customer, Vendor, or Employee name list resource to determine the list of objects for this reference. Specify values found in Customer.Id , Vendor.Id , and Employee.Id . For example, name=1,4,7 includes data in the report for namelist ids 1, 4, and 7. vendor and employee objects
query.payment_method	string	Optional	Filters report contents based on payment method. Supported Values: Cash , Check , Dinners Club , American Express , Discover , MasterCard , Visa , Credit Card
query.printed	string	Optional	Filters report contents based on whether checks are printed or not. Supported Values: Printed , To_be_printed
query.qzurl	string	Optional	Specifies whether Quick Zoom URL information should be generated for rows in the report. Quick Zoom URL is a hyperlink to another report containing further details about the particular column of data. Supported Values: true , false
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.source_account_type	string	Optional	Account type from which transactions are included in the report. Supported Values: AccountsPayable , AccountsReceivable , Bank , CostOfGoodsSold , CreditCard , Equity , Expense , FixedAsset , Income , LongTermLiability , NonPosting , OtherAsset , OtherCurrentAsset , OtherCurrentLiability , OtherExpense , OtherIncome
query.start_createdate	string	Optional	Specify an explicit account create report date range, 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 createdate_macro to cover a standard report date range. (This field is not currently available.)
query.start_date	string	Optional	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. If not specified value of date_macro is used
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.start_moddate	string	Optional	(Account List Detail) Specify an explicit account modification report date range, 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 the moddate_macro to cover a standard report date range.
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.transaction_type	string	Optional	Filters report contents based transaction type. Supported values include: CreditCardCharge, Check, Invoice, ReceivePayment, JournalEntry, Bill, CreditCardCredit, VendorCredit, Credit, BillPaymentCheck, BillPaymentCreditCard, Charge, Transfer, Deposit, Statement, BillableCharge, TimeActivity, CashPurchase, SalesReceipt, CreditMemo, CreditRefund, Estimate, InventoryQuantityAdjustment, PurchaseOrder, GlobalTaxPayment, GlobalTaxAdjustment, Service Tax Refund, Service Tax Gross Adjustment, Service Tax Reversal, Service Tax Defer, Service Tax Partial Utilisation
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.transactionlistbyvendor.query_a_report. Catalog operation: transactionlistbyvendor/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