CreateCustomerBalanceReport
Generates a Customer Balance Summary report schema file, showing total balances that are owed by each customer without transaction-level detail.
Input
| Name | Type | Accepts Output Streams | Description |
| ReportName | String | False | The name of the report that is to be generated. This name identifies which report definition QuickBooks Online should use.
The default value is CustomerBalanceReport. |
| ReportDescription | String | False | A description for the report. If the report description is not specified, QuickBooks Online selects a description based on the report type. |
| AccountingMethod | String | False | The accounting method that is used in the report (for example, Accrual or Cash). This input determines how QuickBooks Online calculates and displays the report's values.
The allowed values are Cash, Accrual. |
| ARPaid | String | False | The accounts-receivable paid status that is applied as a filter for the report. This input allows you to include or exclude paid items.
The allowed values are All, Paid, Unpaid. The default value is Unpaid. |
| Customer | String | False | 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 identifiers (Ids). |
| DateMacro | String | False | A predefined date range that is used to automatically populate the StartDate and EndDate inputs. Use this 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 | False | 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. |
| ReportDate | String | False | The starting date of the report. This date determines the anchor date for balance calculations. |
| SummarizeColumnsBy | String | False | The criteria by which to group or summarize the report results (for example, by Customer or by Term).
The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices. |
| FileStream | String | True | An instance of an output stream where file data is written. This FileStream input is used only when the WriteToFile parameter is set to false. |
| 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 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. |