CreateTrialBalanceReport
Generates a Trial Balance report schema file, summarizing all account balances (debits and credits) at a point in time for reconciliation.
Input
| Name | Type | Description |
| ReportName | String | The name that is assigned to the trial balance report. This value is used to label and identify the report in generated outputs and downstream integrations.
The default value is TrialBalanceReport. |
| ReportDescription | String | A descriptive summary of the trial balance 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. |
| AccountingMethod | String | The accounting method that is applied to the report calculations, such as Cash or Accrual. This method determines how income and expenses are recognized in the report.
The allowed values are Cash, Accrual. |
| DateMacro | String | A predefined date range that is automatically applied to the report timeframe. Use this parameter for standard date periods; otherwise specify the StartDate and EndDate parameters for a custom 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 parameter specifies the starting date of the report. This parameter defines the earliest transaction date to include and must be earlier than the ending date specified in the EndDate parameter. |
| EndDate | String | The EndDate parameter specifies the ending date of the report. This parameter defines the latest transaction date to include and must be later than the starting date specified in the StartDate parameter. |
| SummarizeColumnsBy | String | Specifies the criteria that is used to group or summarize the report results by columns. This allows you to control how the trial balance data is aggregated.
The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices. |
| Locale | String | Specifies the locale of the QuickBooks Online company for which you are running this report. This parameter is generally needed when calling GeneralLedger and TrialBalance reports for a French company. In that case, specify the locale parameter as FR. |
| 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 trial balance report data. |
| 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. |