CreateTaxSummaryReport
Generates a Tax Summary report schema file, summarizing tax collected, tax owed, and taxable amounts by jurisdiction.
Input
| Name | Type | Accepts Output Streams | Description |
| ReportName | String | False | The name assigned to the tax summary report. This value is used to label and identify the report in generated outputs and downstream integrations.
The default value is TaxSummaryReport. |
| ReportDescription | String | False | A descriptive summary of the tax summary 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. |
| TaxAgencyId | String | False | The unique identifier (Id) of the tax agency for which the tax summary report is generated. Retrieve valid Ids by querying the TaxAgency entity to ensure compliance with QuickBooks Online requirements. |
| AccountingMethod | String | False | 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 | False | A predefined date range that automatically populates the report timeframe, such as Last Month, Last Quarter, or This Year. Use this parameter for standard date periods; otherwise specify the start date and end data 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 | False | The starting date for the reporting period. This defines the earliest transaction date to include and must be earlier than the ending date. |
| EndDate | String | False | The end date for the reporting period. This defines the latest transaction date to include and must be later than the starting date. |
| Indentation | String | False | Indicates whether to add leading spaces to report values. This field helps visually differentiate groupings and totals within the output for improved readability. |
| FileStream | String | True | A stream object where the generated file data is written when the WriteToFile parameter is set to false. Use this to handle the output programmatically instead of creating a file on disk. |
| WriteToFile | String | False | 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 tax-summary 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. |