CreateSalesByClassReport
Generates a Sales by Class report schema file.
Input
| Name | Type | Accepts Output Streams | Description |
| ReportName | String | False | The name of the report.
The default value is SalesByClassReport. |
| ReportDescription | String | False | A description for the report. If one is not specified, a description based on the ReportType will be selected. |
| AccountingMethod | String | False | The accounting method used in the report.
The allowed values are Cash, Accrual. |
| Class | String | False | Filters report contents to include information for specified classes if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Class IDs. |
| Customer | String | False | Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs |
| 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. |
| Department | String | False | Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs. |
| Item | String | False | Filters report contents to include information for specified items. This is a comma separated list (spaces omitted after/before separating comma) of one or more Item IDs. |
| StartDate | String | False | The startdate of the report. StartDate must be less than EndDate. |
| EndDate | String | False | The enddate of the report. EndDate must be greater than StartDate. |
| SummarizeColumnsBy | String | False | 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 | 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. |