Report request reference

This page supplies information about attributes that can be supplied in report request messages.The information is organized as follows:

Valid request options by report type – sorted by report type; a table for each of the following report types that lists the attributes the SDK provides for each report in the group:
- aging reports
- job reports
- time reports
- general detail reports
- general summary reports
Detailed remarks about some request attribute types:
- the includeSubcolumns attribute
- the includeColumnlist attribute
- the reportEntity filter for job reports
- the account filter is required for missing checks reports
- the budget report requests

Valid report request options by report type

Different report types have different options available. The tables that follow, one for each report type, list the valid request options for different report types.

Aging reports

Report name	Include Columns	ReportAgingAsOf	IncludeAccounts
APAgingDetail	Supports all	X
APAgingSummary	(none)	X
AR AgingDetail	Supports all	X
ARAgingSummary	(none)	X
CollectionsReport	Supports all	X	X

Note

Note

ReportAgingAsOf is an enum (Today, ReportEndDate); in this table an “X” indicates the SDK supports this report option. IncludeAccounts is also an enum (InUse or All);as in QuickBooks, this option is supported only in the Collections Report.

Job reports

Report name	SummarizeColumnsBy	Subcolumns	Entity Filter
ItemEstimatesVsActuals	Dates and Class	X
ItemProfitability	Dates and Class	X
JobEstimatesVsActualsDetail	Dates and Class	X	Required
JobEstimatesVsActualsSummary	Dates and Class	X
JobProfitabilityDetail	Dates and Class	X	Required
JobProfitabilitySummary	Dates and Class	X

Note

Note

Dates includes TotalOnly, Day, Week, TwoWeek, FourWeek, HalfMonth, Month, Quarter, Year. Reports support either all dates or no dates.

Time reports

Report name	SummarizeColumnsBy	Report Calendar	Return Rows	Return Columns
TimeByItem	Dates only	X	X	X
TimeByJobDetail	no columns
TimeByJobSummary	Dates only	X	X	X
TimeByName	Dates only	X	X	X

Note

Note

Time Reports do not support AccountFilter or TxnTypeFilter.

General detail reports

Report name	Dates Allowed	Account Filter	Include- Accounts	Report- Balance- AsOf
1099Detail	X		InUse	Current
AuditTrail	X		None	None
BalanceSheetDetail	X		All	Current
CheckDetail	X		InUse	Current
CustomerBalanceDetail	X		InUse	Current
DepositDetail	X		InUse	Current
EstimatesByJob	X		InUse	Current
ExpenseByVendorDetail	X		InUse	Current
GeneralLedger	X		All	Current
IncomeByCustomerDetail	X		InUse	Current
IncomeTaxDetail	X		InUse	Current
InventoryValuationDetail	X		InUse	Current
JobProgressInvoicesVs- Estimates
Journal	X		InUse	Current
MissingChecks	X	Required	None	None
OpenInvoices	X		InUse	Current
OpenPOs	X		InUse	Current
OpenPOsByJob	X		InUse	Current
OpenSalesOrderByCustomer	X		InUse	Current
OpenSalesOrderByItem	X		InUse	Current
PendingSales	X		InUse	Current
ProfitAndLossDetail	X		InUse	Current
PurchaseByItemDetail	X		InUse	Current
PurchaseByVendorDetail	X		InUse	Current
SalesByCustomerDetail	X		InUse	Current
SalesByItemDetail	X		InUse	Current
SalesByRepDetail	X		InUse	Current
TxnDetailByAccount	X		InUse	Current
TxnListByCustomer	X		InUse	Current
TxnListByDate	X		InUse	Current
TxnListByVendor	X		InUse	Current
UnbilledCostsByJob	X		InUse	Current
UnpaidBillsDetail	X		InUse	Current
VendorBalanceDetail	X		InUse	Current

Note

Note

Values shown for IncludeAccount and ReportBalanceAsOf are the default values used by QuickBooks if not specified in the request. “None” means the report doesn’t use the setting.

General summary reports Valid Options for SummarizeColumnsBy (table 1 of 4)

Report name	Dates*	Customer- Job	Vendor	Employee	Payroll- Item- Detail
BalanceSheetPrevYearComp	X
BalanceSheetStandard	X
BalanceSheetSummary	X
CustomerBalanceSummary	X
ExpenseByVendorSummary	X
IncomeByCustomerSummary	X
IncomeTaxSummary
InventoryStockStatusByItem
InventoryStockStatusByVendor
InventoryValuationSummary
PhysicalInventoryWorksheet
ProfitAndLossByClass	X	X	X	X	X
ProfitAndLossByJob	X	X	X	X	X
ProfitAndLossPrevYearComp	X	X	X	X	X
ProfitAndLossStandard	X	X	X	X	X
ProfitAndLossYTDComp	X	X	X	X	X
PurchaseByItemSummary	X	X	X	X
PurchaseByVendorSummary	X
SalesByCustomerSummary	X
SalesByItemSummary	X	X	X	X
SalesByRepSummary	X
SalesTaxLiability
SalesTaxRevenueSummary	X	X	X	X	X
TrialBalance
VendorBalanceSummary	X

*All reports except PhysicalInventoryWorksheet also support macro/custom Dates

Note

Note

Dates includes TotalOnly, Day, Week, TwoWeek, FourWeek, HalfMonth, Month, Quarter, Year. Reports support either all dates or no dates.

Valid Options for SummarizeColumnsBy (table 2 of 4)

Report name	Dates*	Customer- Job	Vendor	Employee	Payroll- Item- Detail
BalanceSheetPrevYearComp
BalanceSheetStandard
BalanceSheetSummary
CustomerBalanceSummary
ExpenseByVendorSummary
IncomeByCustomerSummary
IncomeTaxSummary
InventoryStockStatusByItem
InventoryStockStatusByVendor
InventoryValuationSummary
PhysicalInventoryWorksheet
ProfitAndLossByClass	X	X	X	X	X
ProfitAndLossByJob	X	X	X	X	X
ProfitAndLossPrevYearComp	X	X	X	X	X
ProfitAndLossStandard	X	X	X	X	X
ProfitAndLossYTDComp	X	X	X	X	X
PurchaseByItemSummary	X	X	X
PurchaseByVendorSummary		X	X	X	X
SalesByCustomerSummary		X	X	X	X
SalesByItemSummary	X	X	X
SalesByRepSummary		X	X	X	X
SalesTaxLiability
SalesTaxRevenueSummary	X	X	X	X	X
TrialBalance
VendorBalanceSummary

Valid Options for SummarizeColumnsBy (table 3 of 4)

Report name	Dates*	Customer- Job	Vendor	Employee
BalanceSheetPrevYearComp
BalanceSheetStandard
BalanceSheetSummary
CustomerBalanceSummary
ExpenseByVendorSummary
IncomeByCustomerSummary
IncomeTaxSummary
InventoryStockStatusByItem
InventoryStockStatusByVendor
InventoryValuationSummary
PhysicalInventoryWorksheet
ProfitAndLossByClass	X	X	X	X
ProfitAndLossByJob	X	X	X	X
ProfitAndLossPrevYearComp	X	X	X	X
ProfitAndLossStandard	X	X	X	X
ProfitAndLossYTDComp	X	X	X	X
PurchaseByItemSummary	X	X	X	X
PurchaseByVendorSummary	X	X	X	X
SalesByCustomerSummary	X	X	X	X
SalesByItemSummary	X	X	X	X
SalesByRepSummary	X	X	X	X
SalesTaxLiability
SalesTaxRevenueSummary	X	X	X	X
TrialBalance
VendorBalanceSummary

General Summary Reports: Valid Options for SummarizeColumnsBy (table 4 of 4)

Report name	ShipMethod	Terms	Payment-Method	SalesTax-Code	Account
Report	Subcolumns	Return Rows	Return Columns	Report Calendar	Report Basis
BalanceSheetPrevYearComp	X	NonZero	ActiveOnly	FiscalYear	X
BalanceSheetStandard	X	NonZero	ActiveOnly	FiscalYear	X
BalanceSheetSummary	X	NonZero	ActiveOnly	FiscalYear	X
CustomerBalanceSummary	X	NonZero	ActiveOnly	FiscalYear	no
ExpenseByVendorSummary	X	ActiveOnly	ActiveOnly	FiscalYear	X
IncomeByCustomerSummary	X	ActiveOnly	ActiveOnly	FiscalYear	X
IncomeTaxSummary	no	ActiveOnly	ActiveOnly	TaxYear	X
InventoryStockStatusByItem	no	no	no	no	no
InventoryStockStatusByVendor	no	no	no	no	no
InventoryValuationSummary	no	no	no	no	no
PhysicalInventoryWorksheet	no	no	no	no	no
ProfitAndLossByClass	X	ActiveOnly	ActiveOnly	FiscalYear	X
ProfitAndLossByJob	X	ActiveOnly	ActiveOnly	FiscalYear	X
ProfitAndLossPrevYearComp	X	ActiveOnly	ActiveOnly	FiscalYear	X
ProfitAndLossStandard	X	ActiveOnly	ActiveOnly	FiscalYear	X
ProfitAndLossYTDComp	X	ActiveOnly	ActiveOnly	FiscalYear	X
PurchaseByItemSummary	X	NonZero	ActiveOnly	FiscalYear	X
PurchaseByVendorSummary	X	ActiveOnly	ActiveOnly	FiscalYear	X
SalesByCustomerSummary	X	ActiveOnly	ActiveOnly	FiscalYear	X
SalesByItemSummary	X	ActiveOnly	ActiveOnly	FiscalYear	X
SalesByRepSummary	X	ActiveOnly	ActiveOnly	FiscalYear	X
SalesTaxLiability	no	ActiveOnly	ActiveOnly	Calendar- Year	X
SalesTaxRevenueSummary	X	ActiveOnly	ActiveOnly	Calendar- Year	X
TrialBalance	no	ActiveOnly	ActiveOnly	FiscalYear	X
VendorBalanceSummary	X	NonZero	ActiveOnly	FiscalYear	X

Note

Note

Subcolumns is a Boolean; either return subcolumns or do not return subcolumns. ReportCalendar can be FiscalYear, CalendarYear, or TaxYear.

eturnRows and ReturnColumns can be ActiveOnly, NonZero, or All.

Report request attributes

When it comes to the columns included or not included in response to report requests, different report types have different default behavior, and in some cases the responses of reports, also in terms of columns that will be displayed or not displayed, to the attributes set in report requests are different, too.

IncludeSubcolumns

This section describes how different report types and individual reports respond to the values that report requests send for the IncludeColumns attribute.

Report type	Effect of including subcolumns
Time and Job reports	By default, requests for Time and Job reports return all subcolumns. Even if the request specifies False for IncludeSubcolumns, one subcolumn—Average Cost—will be returned (otherwise the report would contain no data).
Summary reports	For Summary reports, specifying True for IncludeSubcolumns will cause the following columns to be returned (with certain qualifications described in the next row): Previous Period Previous Year % of Row % of Column
Previous Period and Previous Year columns	If you specify True for IncludeSubcolumns, the PreviousPeriod and PreviousYear subcolumns will be turned on for the reports that have this information, unless the ReportDateMacro is set to ALL or a FromDate is provided.
Sales By ItemSummary Report	The SalesByItemSummary report has eight subcolumns that are returned by default: Qty, Amount, % of Sales, Avg. Price, Average Cost, COGS, Gross Margin, Gross Margin %. When a request specifies IncludeSumcolumns as False, only four columns are omitted from the response, and these columns are still retlurned: Qty, Amount, % of Sales, Avg. Price.

IncludeColumnList

The IncludeColumnList attribute is available in Aging, Custom Detail, PayrollDetail, and General Detail report requests. If a request uses this attribute to request a column, the default columns will not be returned, so if the application needs the default columns, it must include them, too, in the IncludeColumnlist.

Some columns that are available for selection in the QuickBooks user interface for a given report type are not available through IncludeColumnlist. See Report column types and data types for a list of column types that identifies those that can be requested with IncludeColumnList.

Note that a convenient way to obtain a number of transaction IDs in a report is to use the IncludeColumnList attribute to add the TxnID column to a report. This technique is often more effective than performing queries to obtain the TxnIDs.For an example, see the PurchaseOrderModify sample program included with the SDK.

ReportEntity filter required for job reports

For the JobEstimatesVsActualsDetail report and the JobProfitabilityDetail report, you must provide a ReportEntity filter that specifies a customer reference.

AccountFilter required for MissingChecks report

For the MissingChecks report (a type of GeneralDetail report), the request must include a ReportAccountFilter that specifies an account.

Requests for budget reports

Before you can request a budget report, the “target” budget must be defined in QuickBooks.

The type of budget determines the valid combinations of rows and columns you can request for a budget report.

Budget report type	BudgetCriterion value	Valid Row/Column combinations
BalanceSheetBudgetOverview BalanceSheetBudgetVsAct	must be Accounts	Account/Date
	Accounts	Account/Date
ProfitAndLossBudgetOverview ProfitAndLossBudgetVsActual ProfitAndLossBudgetPerformance	AccountsAndClasses	Account/Class Account/Date Class/Date
	AccountsAndCustomers	Account/Customer Account/Date Customer/Date

As long as your budget defines them for the appropriate year.