CreateVendorBalanceReport
Generates a Vendor Balance Summary report schema file, summarizing total balances that are owed to each vendor.
Input
| Name | Type | Description |
| ReportName | String | The name that is assigned to the vendor balance report. This value is used to label and identify the report in generated outputs and downstream integrations.
The default value is VendorBalanceReport. |
| ReportDescription | String | A descriptive summary of the vendor balance 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. |
| AccountingMethod | String | 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 | A predefined date range that is automatically applied to the report timeframe. Use this parameter for standard date periods. Otherwise, specify the StartDate and EndDate parameters 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. |
| Department | String | Filters the report contents to include transactions for specified departments. Provide a comma separated list (with a space after each comma) of one or more Department identifiers (Ids). |
| ReportDate | String | Specifies the starting date that is used for the report timeframe. This input defines the earliest date from which to generate the report data. |
| SummarizeColumnsBy | String | Specifies the criteria that is used to group or summarize the report results by columns. This input allows you to control how the vendor balance data is aggregated.
The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices. |
| Vendor | String | Filters the report contents to include transactions for specified vendors. Provide a comma separated list (with a space after each comma) of one or more Vendor Ids. |
| 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 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 vendor balance report data. |
| 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. |