CreateGeneralLedgerDetailReport
Generates a General Ledger 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: debt_amt, credit_amt, nat_open_bal, subt_nat_amount, rbal_nat_amount, tax_amount, net_amount.
Multicurrency enabled: debt_home_amt, credit_home_amt, currency, exch_rate, nat_home_open_bal, nat_foreign_open_bal, subt_nat_home_amount, nat_foreign_amount, rbal_nat_home_amount, home_tax_amount, home_net_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 CreateGeneralLedgerDetailReport
To return BASE64 encoded data in FileData column.
EXECUTE CreateGeneralLedgerDetailReport WriteToFile = 'False'
Input
| Name | Type | Accepts Output Streams | Description |
| ReportName | String | False | The name of the report.
The default value is GeneralLedgerDetailReport. |
| ReportDescription | String | False | A description for the report. If one is not specified, a description based on the ReportType will be selected. |
| Account | String | False | Filters report contents to include information for specified accounts. This is a comma separated list (spaces omitted after/before separating comma) of one or more Account IDs. |
| AccountingMethod | String | False | The accounting method used in the report.
The allowed values are Cash, Accrual. |
| AccountType | String | False | Account type from which transactions are included in the report. This is a comma separated list (spaces omitted after/before separating comma) and may include: Bank,AccountsReceivable,OtherCurrentAsset,FixedAsset,OtherAsset,AccountsPayable,CreditCard,OtherCurrentLiability,LongTermLiability,Equity,Income,CostOfGoodsSold,Expense,OtherIncome,OtherExpense,NonPosting. |
| SourceAccountType | String | False | Account type from which transactions are included in the report. This is a comma separated list (spaces omitted after/before separating comma) and may include: Bank,AccountsReceivable,OtherCurrentAsset,FixedAsset,OtherAsset,AccountsPayable,CreditCard,OtherCurrentLiability,LongTermLiability,Equity,Income,CostOfGoodsSold,Expense,OtherIncome,OtherExpense,NonPosting. |
| Class | String | False | Filters report contents to include information for specified classes if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Class IDs. |
| Columns | String | False | Column types to be shown in the report. A comma separated list of one or more of the following: account_name, chk_print_state, create_by, create_date, cust_name, doc_num, emp_name, inv_date, is_adj, is_ap_paid, is_ar_paid, is_cleared, item_name, last_mod_by, last_mod_date, memo, name, quantity, rate, split_acc, tx_date, txn_type, vend_name. Additional columns when class tracking enabled: klass_name. Additional columns when sales tax enabled: net_amount, tax_amount, tax_code. Additional columns when 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: debt_amt, credit_amt, nat_open_bal, subt_nat_amount, rbal_nat_amount, tax_amount, net_amount. Multicurrency enabled: debt_home_amt, credit_home_amt, currency, exch_rate, nat_home_open_bal, nat_foreign_open_bal, subt_nat_home_amount, nat_foreign_amount, rbal_nat_home_amount, home_tax_amount, home_net_amount. Default=tx_date,txn_type,doc_num,account_name,memo,split_acc,subt_nat_home_amount,rbal_nat_home_amount. For more information refer to API documentation. |
| Customer | String | False | Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs. |
| Locale | String | False | Specify the Locale of the QBOnline Company you are running this report for. This is generally needed when calling GeneralLedger and TrailBalance reports for a French company. In that case, specify the locale as FR. |
| 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.
The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year. |
| Department | String | False | Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs. |
| 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. The default value is ascend. |
| SourceAccount | String | False | Filters report contents to include information for specified accounts. This is a comma separated list (spaces omitted after/before separating comma) of one or more Account IDs. |
| 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. |
| 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. |