CreateJournalReport
Generates a Journal report schema file, presenting transactions in journal format with debits and credits by account.
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. |
| ReportDescription | String | A description for the report. If the report description is not specified, QuickBooks Online selects a description based on the report type. |
| 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: acct_num_with_extn, account_name, credit_amt, create_by, create_date, debt_amt, doc_num, due_date, is_ar_paid, is_ap_paid, item_name, journal_code_name, last_mod_by, last_mod_date, memo, name, neg_open_bal, paid_date, pmt_mthd, quantity, rate, tx_date, txn_num, txn_type. |
| 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.
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. |
| JournalCode | String | Filters the report contents to include information for one or more specified journal codes. Provide a comma-separated list (with one space after each comma) of journal codes such as AN, BQ1, or VT. By default, the report includes data for all journal codes. |
| 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).
The allowed values are ascend, descend. |
| StartDate | String | The starting date of the report. This date must be earlier than the ending date. If this input is not specified, the value from the DateMacro parameter is used. |
| EndDate | String | The ending date of the report. This date must be later than the starting date. |
| Locale | String | Specifies the locale of the QuickBooks Online company for which you are running this report. This input is generally required for French companies, where you must specify the locale as FR. |
| 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. |