CreateSalesByClassReport
Generates a Sales by Class report schema file, breaking down sales totals by QuickBooks class for segmented reporting.
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.
The default value is SalesByClassReport. |
| ReportDescription | String | A description for the report. If the report description is not specified, QuickBooks Online selects a description based on the report type. |
| AccountingMethod | String | The accounting method used in the report.
The allowed values are Cash, Accrual. |
| Class | String | Filters the report contents to include information for one or more specified classes when the company file is configured to use classes. Provide a comma-separated list (with one space after each comma) of Class identifiers (Ids). |
| Customer | String | Filters the report contents to include information for one or more specified customers. Provide a comma-separated list (with one space after each comma) of Customer Ids. |
| DateMacro | String | A predefined date range that is used to automatically populate the StartDate and EndDate inputs. Use this stored procedure 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. |
| Department | String | Filters the report contents to include information for one or more specified departments when the company file is configured to use departments. Provide a comma-separated list (with one space after each comma) of Department Ids. |
| Item | String | Filters the report contents to include information for one or more specified items. Provide a comma-separated list (with one space after each comma) of Item Ids. |
| StartDate | String | The starting date of the report. This date must be earlier than the ending date. |
| EndDate | String | The ending date of the report. This date must be later than the starting date. |
| SummarizeColumnsBy | String | The criteria by which to group the report results.
The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices. |
| 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. |