JDBC Driver for QuickBooks Online

Build 26.0.9666

CreateAPAgingDetailReport

Generates an Accounts Payable Aging Detail report schema file, providing detailed insight into unpaid vendor balances and their aging by date.

Stored Procedure-Specific Information

This report supports multicurrency. The parameters available for use in an EXEC query vary, depending on whether or not multicurrency is enabled:

  • Multicurrency disabled: subt_neg_open_bal, subt_neg_amount.
  • Multicurrency enabled: currency, exch_rate, neg_foreign_open_bal, subt_neg_home_open_bal, neg_foreign_amount, subt_neg_home_amount.

To check whether the authenticated account supports multicurrency, execute:

SELECT CurrencyPrefs_MultiCurrencyEnabled FROM Preferences;

The RSD file is generated based on the value of the Location connection property:

EXEC CreateAPAgingDetailReport

To return BASE64 encoded data in FileData column:

EXEC CreateAPAgingDetailReport WriteToFile = 'False'

Input

Name Type Accepts Output Streams Description
ReportName String False The name of the report that is to be generated. This name identifies which report definition QuickBooks Online should use.

The default value is APAgingDetailReport.

ReportDescription String False A description for the report. If the report description is not specified, QuickBooks Online selects a description based on the report type.
AccountingMethod String False The accounting method that is used in the report (for example, Accrual or Cash). The accounting method determines how QuickBooks Online calculates and displays the report's values.

The allowed values are Cash, Accrual.

AgingPeriod String False The number of days that are used to define each aging period in the report. The aging period controls how open balances are grouped by age.
Columns String False The column types that are to be shown in the report. Provide a comma-separated list (with one space after each comma) of one or more of the following types: create_by, create_date, doc_num, due_date, last_mod_by, last_mod_date, memo, past_due, term_name, tx_date, txn_type, vend_bill_addr, vend_comp_name, vend_name, vend_pri_cont, vend_pri_email, vend_pri_tel. When location tracking is enabled, the additional column dept_name is available. In addition, the following values are supported based on the multicurrency setting for the company. When multicurrency is disabled, the supported values are subt_neg_open_bal and subt_neg_amount. When multicurrency is enabled, the supported values are currency, exch_rate, neg_foreign_open_bal, subt_neg_home_open_bal, neg_foreign_amount, and subt_neg_home_amount.

The default value is tx_date,txn_type,doc_num,vend_name,dept_name,due_date,past_due,subt_neg_amount,subt_neg_open_bal,subt_neg_home_amount,subt_neg_home_open_bal.

NumPeriods String False The number of periods that are to be shown in the report. This number controls how many columns of aged balances are displayed.
PastDue String False Filters the report contents based on the minimum number of days past due. The PastDue input restricts the output to only items that exceed the specified threshold.
ReportDate String False The starting date that is used for the report. This input determines the anchor date for aging calculations.
ShipVia String False Filters the report by the shipping method as specified in the invoice's shipping-method reference.
StartDueDate String False The starting due date for which the receivables are due. This date must be earlier than the ending due date.
EndDueDate String False The ending due date for which the receivables are due. This date must be later than the starting due date.
Term String False Filters the report contents to include information for one or more specified terms. Provide a comma-separated list (with one space after each comma) of Term identifiers (Ids).
Vendor String False Filters the report contents to include information for one or more specified vendors. Provide a comma-separated list (with one space after each comma) of Vendor Ids.
Indentation String False Indicates whether spaces are added at the start of values to visually identify totals and grouped values in the report output.
FileStream String True An instance of an output stream where file data is written. The FileStream input is used only when the WriteToFile parameter is set to false.
WriteToFile String False Indicates whether the stored procedure writes the output to a file. This input defaults to true. Set it to false to have the procedure write the output to the file stream that you supply or to return the output as file data.

Result Set Columns

Name Type Description
Result String Indicates whether the stored-procedure execution completed successfully or failed. The stored procedure returns the Result output so that calling applications can check the execution status.
SchemaFile String The generated schema file that is produced by the stored procedure. The schema file contains the structure of the report.
Columns String The number of columns that are found in the generated report. This information helps applications validate and map returned data.
FileData String The Base64-encoded downloaded file content. The content is returned only when the WriteToFile parameter is set to false and the FileStream parameter is not set.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9666