JDBC Driver for QuickBooks Online

Build 24.0.9060

CreateTransactionListWithSplitsReport

Generates an Account list report schema file.

Input

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

The default value is TransactionListWithSplitsReport.

ReportDescription String False A description for the report. If one is not specified, a description based on the ReportType will be selected.
Columns String False Column types to be shown in the report. A comma separated list of one or more of the following: tx_date, txn_type, doc_num, is_no_post, account_name, memo, account_name, amount, is_adj, create_by, create_date, last_mod_date, last_mod_by, cust_name, vend_name, rate, quantity, item_name, emp_name, pmt_mthd, nat_open_bal, tax_type, is_billable, debt_amt, credit_amt, is_cleared, olb_status. 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.
StartDate String False The startdate of the report. StartDate must be less than EndDate.
EndDate String False The enddate of the report. EndDate must be greater than StartDate.
DateMacro String False A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range.
SourceAccountType String False Account type from which transactions are included in the report.
SortBy String False The column type used in sorting report rows. Specify one of the Columns from the Columns input.
SortOrder String False The sort ordering.

The allowed values are ascend, descend.

DocNum String False Filters report contents to include information for specified transaction number, as found in the docnum parameter of the transaction object.
PaymentMethod String False Filter report contents based on payment method.
Transactiontype String False Filters report based on transaction type.
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