CreateAccountListReport
Generates an Account List report schema file, allowing you to extract the structure of your QuickBooks chart of accounts for integration or analysis.
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.
For example:
To create the RSD file, it will be generated based on the value of the Location connection property.
EXECUTE CreateAccountListReport
To return BASE64 encoded data in FileData column.
EXECUTE CreateAccountListReport WriteToFile = 'False'
Input
| Name | Type | Description |
| ReportName | String | The name of the report.
The default value is AccountListReport. |
| ReportDescription | String | A description for the report. If one is not specified, a description based on the ReportType will be selected. |
| Columns | String | Column types to be shown in the report. A comma separated list of one or more of the following: account_name*, account_type*, detail_acc_type, create_date, create_by, detail_acc_type*, last_ mod_date, last_ mod_by, account_desc*, account_bal* |
| AccountType | String | Account type from which transactions are included in the report.
The allowed values are Bank, AccountsReceivable, OtherCurrentAsset, FixedAsset, OtherAsset, AccountsPayable, CreditCard, OtherCurrentLiability, LongTermLiability, Equity, Income, CostOfGoodsSold, Expense, OtherIncome, OtherExpense, NonPosting. |
| AccountStatus | String | The account status. Supported values include: Deleted, Not_Deleted |
| DateMacro | String | 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. |
| StartDate | String | The startdate of the report. StartDate must be less than EndDate. |
| EndDate | String | The enddate of the report. EndDate must be greater than StartDate. |
| ModDateMacro | String | A predefined report account modification date range. Use if you want the report to cover a standard report date range when accounts were modified; otherwise, use the StartModDate and EndModDate to cover an explicit report date 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. |
| StartModDate | Date | The startdate of which accounts were modified. StartModDate must be less than EndModDate. |
| EndModDate | Date | The enddate of which accounts were modified. EndModDate must be greater than StartModDate.. |
| CreateDateMacro | String | A predefined account create date range. Use this if you want the report to cover a standard date range when accounts were created. Otherwise, use the StartCreateDate and EndCreateDate 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. |
| StartCreateDate | Date | The startcreatedate of account creation to include in the report. StartCreateDate must be less than EndCreateDate. |
| EndCreateDate | Date | The endcreatedate account creation to include in the report. EndCreateDate must be greater than StartCreateDate. |
| SortBy | String | The column type used in sorting report rows. Specify one of the Columns from the Columns input. |
| SortOrder | String | The order in which to sort the report results.
The allowed values are ascend, descend. The default value is ascend. |
| WriteToFile | String | 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. |