CreateGeneralLedgerDetailReport
Generates a General Ledger Detail report schema file, listing all posted transactions across accounts with debits and credits for reconciliation.
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 | Description |
| ReportName | String | The name of the report that is to be generated. This name identifies which report definition QuickBooks Online should use.
デフォルト値はGeneralLedgerDetailReportです。 |
| ReportDescription | String | A description for the report. If the report description is not specified, QuickBooks Online selects a description based on the report type. |
| Account | String | Filters the report contents to include information for one or more specified accounts. Provide a comma-separated list (with one space after each comma) of Account identifiers (Ids). |
| AccountingMethod | String | The accounting method that is used in the report (for example, Accrual or Cash). This input determines how QuickBooks Online calculates and displays the report's values.
使用できる値は次のとおりです。Cash, Accrual |
| AccountType | String | Filters the report contents to include transactions from one or more specified account types. Provide a comma-separated list (with one space after each comma) of account types, which can include Bank, AccountsReceivable, OtherCurrentAsset, FixedAsset, OtherAsset, AccountsPayable, CreditCard, OtherCurrentLiability, LongTermLiability, Equity, Income, CostOfGoodsSold, Expense, OtherIncome, OtherExpense, and NonPosting. |
| SourceAccountType | String | Filters the report contents to include transactions from one or more specified source account types. Provide a comma-separated list (with one space after each comma) of account types, which can include Bank, AccountsReceivable, OtherCurrentAsset, FixedAsset, OtherAsset, AccountsPayable, CreditCard, OtherCurrentLiability, LongTermLiability, Equity, Income, CostOfGoodsSold, Expense, OtherIncome, OtherExpense, and NonPosting. |
| Class | String | Filters the report contents to include information for one or more specified classes when the company file is configured to use classes. Provide a comma-separated list (with one space after each comma) of Class Ids. |
| Columns | String | 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: 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, and vend_name. When class tracking is enabled, the additional column klass_name is available. When sales tax is enabled, the additional columns net_amount, tax_amount, and tax_code are available. 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 debt_amt, credit_amt, nat_open_bal, subt_nat_amount, rbal_nat_amount, tax_amount, and net_amount. When multicurrency is enabled, the supported values are 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, and home_net_amount.
デフォルト値はtx_date,txn_type,doc_num,account_name,memo,split_acc,subt_nat_home_amount,rbal_nat_home_amount,subt_nat_amount,rbal_nat_amountです。 |
| Customer | String | Filters the report contents to include information for one or more specified customers. Provide a comma-separated list (with one space after each comma) of Customer Ids. |
| Locale | String | Specifies the locale of the QuickBooks Online company you are running this report for. This input is generally required when calling General Ledger or Trial Balance reports for a French company. In that case, specify the locale as FR. |
| DateMacro | String | A predefined date range that is used to automatically populate the StartDate and EndDate inputs. Use this input when you want the report to cover a standard reporting range without specifying dates manually.
使用できる値は次のとおりです。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 | Filters the report contents to include information for one or more specified departments when the company file is configured to use departments. Provide a comma-separated list (with one space after each comma) of Department Ids. |
| SortBy | String | The column that is used to sort report rows. Specify one of the columns from the Columns input to control the sort order. |
| SortOrder | String | The sort order for the report rows (for example, Ascending or Descending).
使用できる値は次のとおりです。ascend, descend デフォルト値はascendです。 |
| SourceAccount | String | Filters the report contents to include information for one or more specified source accounts. Provide a comma-separated list (with one space after each comma) of Account Ids. |
| StartDate | String | The starting date of the report. This date must be earlier than the ending date. |
| EndDate | String | The ending date of the report. This date must be later than the starting date. |
| Vendor | String | 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 | Indicates whether spaces are added at the start of values to visually identify totals and grouped values in the report output. |
| WriteToFile | String | 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 output helps applications validate and map returned data. |
| FileData | String | The Base64-encoded downloaded file content. The FileData output is returned only when the WriteToFile parameter is set to false and the FileStream parameter is not set. |