JDBC Driver for QuickBooks Online

Build 24.0.9060

CreateAPAgingDetailReport

Generates an A/P Aging Detail report schema file.

Stored Procedure Specific Information

QuickBooks Online allows only a small subset of columns to be used in the Exec query. All the columns are optional for this Stored Procedure.

This report supports multicurrency. The available columns will differ depending on whether multicurrency is enabled or disabled. Below are the columns supported for each state: multicurrency enabled or disabled.

Multicurrency disabled: subt_net_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 determine if the authenticated account supports multicurrency, check with the following statement:

SELECT CurrencyPrefs_MultiCurrencyEnabled FROM Preferences;

For example:

To create the RSD file, it will be generated based on the value of the Location connection property.

EXECUTE CreateAPAgingDetailReport

To return BASE64 encoded data in FileData column.

EXECUTE CreateAPAgingDetailReport WriteToFile = 'False'

Input

Name Type Accepts Output Streams Description
ReportName String False The name of the report.

The default value is APAgingDetailReport.

ReportDescription String False A description for the report. If one is not specified, a description based on the ReportType will be selected.
AccountingMethod String False The accounting method used in the report.

The allowed values are Cash, Accrual.

AgingPeriod String False The number of days in the aging period.
Columns String False Column types to be shown in the report. A comma separated list of one or more of the following: 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. Additional columns with location tracking enabled: dept_name. In addition to the above, the following values are supported based on the multicurrency setting for the company. Multicurrency disabled: subt_net_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. Default=tx_date,txn_type,doc_num,vend_name,dept_name,due_date,past_due,subt_neg_amount,subt_net_open_bal
NumPeriods String False The number of periods to be shown in the report.
PastDue String False Filters report contents based on minimum days past due.
ReportDate String False Start date to use for the report.
ShipVia String False Filter by the shipping method as specified in Invoice's ShipMethodRef. This is the name of the shipping method.
StartDueDate String False The startdate of which the recievables are due. StartDueDate must be less than EndDueDate.
EndDueDate String False The enddate of which the recievables are due. EndDueDate must be greater than StartDueDate.
Term String False Filters report contents to include information for specified term or terms supplied. This is a comma separated list (spaces omitted after/before separating comma) of one or more Term IDs.
Vendor String False Filters report contents to include information for specified vendors. This is a comma separated list (spaces omitted after/before separating comma) of one or more Vendor IDs.
Indentation String False Add spaces at the start of values to visually identify totals and group values.
FileStream String True An instance of an output stream where file data is written to. Only used if WriteToFile set to false
WriteToFile String False Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns

Name Type Description
Result String Success or Failure.
SchemaFile String The generated schema file.
Columns String The number of columns found.
FileData String The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060