CreateAccountBalanceReportSchema
Generates a comprehensive account balance report, showing actual vs. budget data for a chosen period to assist in financial review.
Input
| Name | Type | Description |
| ReportName | String | The name of the report to be generated. |
| FileName | String | The name of the schema file to be generated. If left blank, the output will be a base64-encoded binary file. To modify the default schema directory, update the Locations property (e.g., Locations='C:\\Users\\User\\Desktop\\SageIntacct\\CustomSchemaDirectory\\'). |
| Reportingperiodname | String | Name of the reporting period. This is required unless using startdate and enddate to define the period. |
| Startdate | Object | The start date for the report, defining the beginning of the balance period. Required if not using reportingperiodname. |
| Enddate | Object | The end date for the report, defining the conclusion of the balance period. Required if not using reportingperiodname. |
| Showperiodbalancedetail | Boolean | Set to true to include detailed period balance amounts (debit and credit) along with the total period balance. Only applicable when contentselection is set to Actual.
The default value is false. |
| Contentselection | String | Specifies the type of data to be included in the report: Actual, Budget, or both (Actual and Budget). Default is Actual. |
| Budgetid | String | The ID of the GL budget to use for budget data. Applicable when pulling budget data or both actual-and-budget data. |
| Budgetcomparison | String | Defines how to compare actual data with budget data when both are included. Options: 'Budget minus Actual' or 'Actual minus Budget'. Default is Budget minus Actual. |
| Showzerowithactivity | Boolean | Determines whether to show accounts with zero balances but non-zero activity. Set to true to include these accounts, or false to exclude them. Default is false.
The default value is false. |
| Glaccountno | String | The specific GL account number to filter by. This is required unless using account group name or account number range. |
| Accountgroupname | String | The account group name to filter the report by. Required unless using a specific GL account number or range. |
| Startaccountno | String | The starting GL account number to filter by. Required unless using a specific GL account number or account group name. |
| Endaccountno | String | The ending GL account number to filter by. Required unless using a specific GL account number or account group name. |
| Reportingbook | String | The reporting book ID (ACCRUAL or CASH) for the report. If Global Consolidations is enabled, provide a consolidation book ID instead. Default is the configured reporting book ID. |
| Adjbooks | Array | Adjustment book IDs for GL journals, such as GAAP, TAX, or other user-defined books. Do not append text to the IDs. Check the Sage Intacct UI for enabled books. |
| Includereportingbook | Boolean | Whether to include entries from the reporting book along with those from the specified adjustment books. Set to true to include, or false to exclude. Default is true.
The default value is true. |
| Statistical | String | Defines whether to include statistical accounts. Options: 'include', 'exclude', or 'only'. Default is exclude. |
| Departmentid | String | The department or department group ID for filtering the report. Pass an empty element to include all departments. |
| Dept_subs | Boolean | Set to true to include department sub-dimensions, or false to exclude them. Default is true.
The default value is true. |
| Locationid | String | The location or location group ID for filtering. This is required in multi-currency companies. |
| Loc_subs | Boolean | Set to true to include location sub-dimensions, or false to exclude them. Default is true.
The default value is true. |
| Projectid | String | The project or project group ID for filtering the report. |
| Projectid_subs | Boolean | Set to true to include project sub-dimensions, or false to exclude them. Default is true.
The default value is true. |
| Projecttypeid | String | The project type ID. Do not use if project ID is specified. |
| Taskid | String | The task ID, available when project ID is specified. |
| Taskid_subs | Boolean | Set to true to include task sub-dimensions, or false to exclude them. Default is true.
The default value is true. |
| Costtypeid | String | The cost type ID, available when task ID is specified. |
| Costtypeid_subs | Boolean | Set to true to include cost type sub-dimensions, or false to exclude them. Default is true.
The default value is true. |
| Customerid | String | The customer or customer group ID for filtering the report. |
| Customerid_subs | Boolean | Set to true to include customer sub-dimensions, or false to exclude them. Default is true.
The default value is true. |
| Customertypeid | String | The customer type ID. Do not use if customer ID is specified. |
| Vendorid | String | The vendor or vendor group ID for filtering the report. |
| Vendorid_subs | Boolean | Set to true to include vendor sub-dimensions, or false to exclude them. Default is true.
The default value is true. |
| Vendortypeid | String | The vendor type ID. Do not use if vendor ID is specified. |
| Employeeid | String | The employee or employee group ID for filtering the report. |
| Employeeid_subs | Boolean | Set to true to include employee sub-dimensions, or false to exclude them. Default is true.
The default value is true. |
| Employeetypeid | String | The employee type ID. Do not use if employee ID is specified. |
| Itemid | String | The item or item group ID for filtering the report. |
| Productlineid | String | The product line ID. Do not use if item ID is specified. |
| Classid | String | The class or class group ID for filtering the report. |
| Classid_subs | Boolean | Set to true to include class sub-dimensions, or false to exclude them. Default is true.
The default value is true. |
| Contractid | String | The contract or contract group ID for filtering the report. |
| Contractid_subs | Boolean | Set to true to include contract sub-dimensions, or false to exclude them. Default is true.
The default value is true. |
| Warehouseid | String | The warehouse or warehouse group ID for filtering the report. |
| Warehouseid_subs | Boolean | Set to true to include warehouse sub-dimensions, or false to exclude them. Default is true.
The default value is true. |
| UserDefinedDimensions | Array | User-defined dimensions to include in the report. |
| Groupby | String | A comma-separated list of dimensions by which to group the report results. |
Result Set Columns
| Name | Type | Description |
| Result | String | Indicates whether the schema creation was successful or failed. |
| FileData | String | The generated schema file encoded in base64. This is only returned if FileName is not provided. |