CreateCustomerBalanceDetailReport
Generates a Customer Balance Detail report schema file, listing each customer's outstanding invoices, payments, and credits with running balances.
Stored Procedure Specific Information
QuickBooks Online allows only a small subset of columns to be used in the Exec query. All the columns are optional for this Stored Procedure.
This report supports multicurrency. The available columns will differ depending on whether multicurrency is enabled or disabled. Below are the columns supported for each state: multicurrency enabled or disabled.
Multicurrency disabled: subt_open_bal, rbal_open_bal, subt_amount.
Multicurrency enabled: currency, exch_rate, foreign_open_bal, subt_home_open_bal, rbal_home_open_bal, foreign_amount, subt_home_amount.
To determine if the authenticated account supports multicurrency, check with the following statement:
SELECT CurrencyPrefs_MultiCurrencyEnabled FROM Preferences;
For example:
To create the RSD file, it will be generated based on the value of the Location connection property.
EXECUTE CreateCustomerBalanceDetailReport
To return BASE64 encoded data in FileData column.
EXECUTE CreateCustomerBalanceDetailReport WriteToFile = 'False'
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 CustomerBalanceDetailReport. |
| ReportDescription | String | A description for the report. If the report description is not specified, QuickBooks Online selects a description based on the report type. |
| AgingMethod | String | The date basis upon which aging is determined (for example, Transaction Date or Due Date). This basis controls how QuickBooks Online calculates aging buckets.
The allowed values are Report_Date, Current. |
| ARPaid | String | The accounts-receivable paid status that is applied as a filter for the report. This status allows you to include or exclude paid items.
The allowed values are All, Paid, Unpaid. The default value is Unpaid. |
| Columns | String | The column types that are to be shown in the report. Provide a comma-separated list (with one space after each comma) of one or more of the following types: bill_addr, create_by, create_date, cust_bill_email, cust_comp_name, cust_msg, cust_phone_other, cust_tel, cust_name, deliv_addr, doc_num, due_date, last_mod_by, last_mod_date, memo, sale_sent_state, ship_addr, ship_date, ship_via, term_name, tracking_num, tx_date, txn_type. When custom fields are enabled, the additional columns sales_cust1, sales_cust2, and sales_cust3 are available. When location tracking is enabled, the additional column dept_name is available. In addition, the following values are supported based on the multicurrency setting for the company. When multicurrency is disabled, the supported values are subt_open_bal, rbal_open_bal, and subt_amount. When multicurrency is enabled, the supported values are currency, exch_rate, foreign_open_bal, subt_home_open_bal, rbal_home_open_bal, foreign_amount, and subt_home_amount. |
| 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. |
| 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. |
| ReportDate | String | The starting date of the report. This date determines the anchor date for aging calculations. |
| ShipVia | String | Filters the report by the shipping method as specified in the Invoice's shipping-method reference (ShipMethodRef). |
| SortBy | String | The column that is used to sort report rows. Specify one of the columns from the Columns input to control the sort order. |
| SortOrder | String | The sort order for the report rows (for example, Ascending or Descending).
The allowed values are ascend, descend. The default value is ascend. |
| StartDueDate | String | The starting due date of the report. This date must be earlier than the ending due date. |
| EndDueDate | String | The ending due date of the report. This date must be later than the starting due date. |
| Term | String | Filters the report contents to include information for one or more specified terms. Provide a comma-separated list (with one space after each comma) of Term Ids. |
| 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. |