CreateTransactionListWithSplitsReport
Generates a Transaction List with Splits report schema file, showing transactions along with their split account allocations.
Input
| Name | Type | Description |
| ReportName | String | The name that is assigned to the transaction list with splits report. This value is used to label and identify the report in generated outputs and downstream integrations.
The default value is TransactionListWithSplitsReport. |
| ReportDescription | String | A descriptive summary of the transaction list with splits report that explains its contents or purpose. If you do not specify one, the system automatically generates a description based on the selected report type. |
| Columns | String | Specifies the column types that are displayed in the report. Provide a comma separated list (with a space after each comma) of one or more of the following values: tx_date, txn_type, doc_num, is_no_post, account_name, memo, account_name, amount, is_adj, create_by, create_date, last_mod_date, last_mod_by, cust_name, vend_name, rate, quantity, item_name, emp_name, pmt_mthd, nat_open_bal, tax_type, is_billable, debt_amt, credit_amt, is_cleared, olb_status. The dept_name column is also supported when location tracking is enabled. Multicurrency is enabled for the company when the Preferences.MultiCurrencyEnabled flag is set to true. |
| StartDate | String | The starting date of the report. This input defines the earliest transaction date to include and must be earlier than the ending date specified in the EndDate parameter. |
| EndDate | String | The ending date of the report. This input defines the latest transaction date to include and must be later than the starting date specified in the StartDate parameter. |
| DateMacro | String | A predefined date range that is automatically applied to the report timeframe. Use this parameter for standard date periods. Otherwise, specify the starting date and ending date a custom range. |
| SourceAccountType | String | Specifies the account types from which transactions are included in the report. Provide a comma separated list (with a space after each comma) of the account types that are used for the transactions. |
| SortBy | String | Specifies the column type that is used to sort the report rows. Provide one of the column values specified in the Columns input. |
| SortOrder | String | Specifies the sort order that is applied to the report rows, such as ascending or descending.
The allowed values are ascend, descend. |
| DocNum | String | Filters the report contents to include transactions for specified transaction numbers as found in the docnum parameter of the transaction object. |
| PaymentMethod | String | Filters the report contents based on the payment method that is used in the transactions. |
| Transactiontype | String | Filters the report contents based on the transaction type that is used in the transactions. |
| 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 the execution outcome of the stored procedure. Returns a value of Success when the report generation is successful or a value of Failure if it is not. |
| SchemaFile | String | The path or reference to the generated schema file that defines the structure of the returned transaction-list-with-splits report data. The schema file contains the structure of the report. |
| Columns | String | The number of columns that are present in the generated report schema. This number provides a quick count of the report's fields for validation or processing. |
| FileData | String | The Base64-encoded content of the generated report file. This output is returned only when the WriteToFile parameter is set to false and the FileStream parameter is not set. |