CreateVendorBalanceDetailReport
Generates a Vendor Balance Detail report schema file.
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_net_open_bal, rbal_neg_open_bal, subt_neg_amount.
Multicurrency enabled: currency, exch_rate, neg_foreign_open_bal, subt_neg_home_open_bal, rbal_neg_home_open_bal.
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 CreateVendorBalanceDetailReport
To return BASE64 encoded data in FileData column.
EXECUTE CreateVendorBalanceDetailReport WriteToFile = 'False'
Input
| Name | Type | Description |
| ReportName | String | The name of the report.
デフォルト値はVendorBalanceDetailReportです。 |
| ReportDescription | String | A description for the report. If one is not specified, a description based on the ReportType will be selected. |
| AccountingMethod | String | The accounting method used in the report.
使用できる値は次のとおりです。Cash, Accrual |
| APPaid | String | The status of the balance.
使用できる値は次のとおりです。Paid, Unpaid, All デフォルト値はUnpaidです。 |
| Columns | String | Column types to be shown in the report. A comma separated list of one or more of the following: create_by, create_date, doc_num, due_date, last_mod_by, last_mod_date, memo, term_name, tx_date, txn_type, vend_bill_addr, vend_comp_name, vend_name, vend_pri_cont, vend_pri_email, vend_pri_tel. Additional columns with location tracking enabled: dept_name. In addition to the above, the following values are supported based on the multicurrency setting for the company: Multicurrency disabled: subt_net_open_bal, rbal_neg_open_bal, subt_neg_amount. Multicurrency enabled: currency, exch_rate, neg_foreign_open_bal, subt_neg_home_open_bal, rbal_neg_home_open_bal. Default=tx_date,txn_type,doc_num,dept_name,subt_neg_amount,subt_net_open_bal, rbal_neg_open_bal |
| DateMacro | String | 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.
使用できる値は次のとおりです。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 report contents based on term or terms supplied. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs. |
| DueDateMacro | String | 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.
使用できる値は次のとおりです。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 |
| ReportDate | String | Start date to use for the report. |
| StartDueDate | String | The startduedate of which receivables are due. StartDueDate must be less than EndDueDate. |
| EndDueDate | String | The endduedate of the report. EndDueDate must be greater than StartDueDate. |
| SortBy | String | The column type used in sorting report rows. Specify one of the Columns from the Columns input. |
| SortOrder | String | The sort ordering.
使用できる値は次のとおりです。ascend, descend デフォルト値はascendです。 |
| Term | String | Filters report contents to include information for specified term or terms supplied. This is a comma separated list (spaces omitted after/before separating comma) of one or more Term IDs. |
| Vendor | String | Filters report contents to include information for specified vendors. This is a comma separated list (spaces omitted after/before separating comma) of one or more Vendor IDs. |
| Indentation | String | Add spaces at the start of values to visually identify totals and group values. |
| WriteToFile | String | 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. |