CreateTrialBalancesReportSchema
Constructs a schema file for a trial balance report, allowing for customized formatting and data extraction.
Input
| Name | Type | Accepts Output Streams | Description |
| FileName | String | False | 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\\'). |
| ReportName | String | False | The name of the report to be generated. |
| FileStream | String | True | The output stream where the generated schema will be written. This is a stream output. |
| Reportingperiodname | String | False | Reporting period name. Required if not using startdate and enddate. |
| Startdate | String | False | Opening balance date. Required if not using reportingperiodname. |
| Enddate | String | False | Closing balance date. Required if not using reportingperiodname. |
| Debitcreditbalance | String | False | Set to true to show starting and ending balance debits and credits. (Default: false) |
| Showzerobalances | String | False | Show zero balance accounts. Use true or false. (Default: false) |
| Showdeptdetail | String | False | Expand department detail. Use true or false. (Default: false) |
| Showlocdetail | String | False | Expand location detail. Use true or false. (Default: false) |
| Reportingbook | String | False | Reporting book ID. Use ACCRUAL or CASH depending on the company configuration. If Global Consolidations is enabled, you can provide a consolidation book ID instead. (Default: Configured reporting book ID) |
| Adjbooks | String | False | Adjustment book IDs for journals that are enabled in the GL configuration. Use GAAP, TAX, and/or the IDs of user defined books. Do not append text to the IDs. If you need help, look at the Trial Balance page in the Sage Intacct UI to see what is enabled. |
| Includereportingbook | String | False | Combine reporting book with other adjustment books. Use true to include the reporting book entries with entries from the specified adjustment books, or false to return only entries for the specified adjustment books. |
| Statistical | String | False | Statistical accounts. Use either include, exclude, or only. (Default: include) |
| Departmentid | String | False | Department ID. |
| Dept_subs | String | False | Include department subs. (Default: true) |
| Locationid | String | False | Location ID. This field is required in a multi-base currency company. |
| Loc_subs | String | False | Include location subs. (Default: true) |
| Projectid | String | False | Project ID or project group ID. |
| Projectid_subs | String | False | Include project subs. (Default: true) |
| Projecttypeid | String | False | Project type. Do not use if Project ID is set. |
| Taskid | String | False | Task ID. Only available when the parent projectid is also specified. |
| Taskid_subs | String | False | Include task sub dimensions. (Default: true) |
| Customerid | String | False | Customer ID or customer group ID. |
| Customerid_subs | String | False | Include customer subs. (Default: true) |
| Customertypeid | String | False | Customer type. Do not use if Customer ID is set. |
| Vendorid | String | False | Vendor ID or vendor group ID. |
| Vendorid_subs | String | False | Include vendor subs. (Default: true) |
| Vendortypeid | String | False | Vendor type. Do not use if Vendor ID is set. |
| Employeeid | String | False | Employee ID or employee group ID. |
| Employeeid_subs | String | False | Include employee subs. (Default: true) |
| Employeetypeid | String | False | Employee type. Do not use if Employee ID is set. |
| Itemid | String | False | Item ID or item group ID. |
| Productlineid | String | False | Product line. Do not use if Item ID is set. |
| Classid | String | False | Class ID or class group ID. |
| Classid_subs | String | False | Include class subs. (Default: true) |
| Contractid | String | False | Contract ID or contract group ID. |
| Contractid_subs | String | False | Include contract subs. (Default: true) |
| Warehouseid | String | False | Warehouse ID or warehouse group ID. |
| Warehouseid_subs | String | False | Include warehouse subs. (Default: true) |
| Userdefineddimensions | String | False | User defined dimension filters. |
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. |