CreateJournalReport
Generates a Journal report schema file.
Input
| Name | Type | Accepts Output Streams | Description |
| ReportName | String | False | The name of the report. |
| 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: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 | 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. |
| JournalCode | String | False | One or more comma separated journal codes. For example AN, BQ1, VT, and so on. Default is to include data for all journal codes. |
| 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. |
| StartDate | String | False | The startdate of the report. StartDate must be less than EndDate. If not specified value of DateMacro is used. |
| EndDate | String | False | The enddate of the report. EndDate must be greater than StartDate. |
| Locale | String | False | Specify the Locale of the QBOnline Company you are running this report for. If a French company, specify the locale as FR. |
| 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. |