AccountBalanceReport
Create an Account Balance report.
Input
| Name | Type | Description |
| Reportingperiodname | String | Reporting period name. Required if not using startdate and enddate. |
| Startdate | Object | Opening balance date. Required if not using reportingperiodname. |
| Enddate | Object | Closing balance date. Required if not using reportingperiodname. |
| Showperiodbalancedetail | Boolean | Set to true to include the periodbalancedetail amounts in the response as well as the periodbalance amount. Can only be used when contentselection is set to Actual. |
| Contentselection | String | Specifies the type of data to return. You can pull actual data (Actual), budget data (Budget) , or both (Actual and Budget). (Default: Actual) |
| Budgetid | String | ID of a GL budget to use. Applicable when pulling budget data (Budget) or both actual-and-budget data (Actual and Budget). (Default: Uses the default budget for the company if configured) |
| Budgetcomparison | String | Specifies how to compare actual data to budget data. Applicable when pulling both actual-and-budget data (Actual and Budget). Use Budget minus Actual or Actual minus Budget. (Default: Budget minus Actual) |
| Showzerowithactivity | Boolean | Specifies whether to show account activity even though the ending balance for the account is zero. Use false for No, true for Yes. (Default: false) |
| Glaccountno | String | GL account number. Required if not using accountgroupname or startaccountno and endaccountno. |
| Accountgroupname | String | Account group name. Required if not using glaccountno or startaccountno and endaccountno. |
| Startaccountno | String | Starting GL account number. Required if not using glaccountno or accountgroupname. |
| Endaccountno | String | Ending GL account number. Required if not using glaccountno or accountgroupname. |
| Reportingbook | String | Reporting book ID. 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 | Array | 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 Account Balances page in the Sage Intacct UI to see what is enabled. |
| Includereportingbook | Boolean | 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. (Default: false) |
| Statistical | String | Statistical accounts. Use either include, exclude, or only. (Default: exclude) |
| Departmentid | String | Department ID or department group ID. (If you pass an empty element, no filtering is performed and all department data is listed.) |
| Dept_subs | Boolean | Include department sub dimensions. (Default: true) |
| Locationid | String | Location ID or location group ID. If you pass an empty element, no filtering is performed and all location data is listed. This field is required in a multi-base currency company. |
| Loc_subs | Boolean | Include location sub dimensions. (Default: true) |
| Projectid | String | Project ID or project group ID. |
| Projectid_subs | Boolean | Include project sub dimensions. (Default: true) |
| Projecttypeid | String | Project type. Do not use if project ID is set. |
| Taskid | String | Task ID. Only available when the parent projectid is also specified. |
| Taskid_subs | Boolean | Include task sub dimensions. (Default: true) |
| Costtypeid | String | Cost type ID. Only available when taskid is also specified. |
| Costtypeid_subs | Boolean | Include cost type sub dimensions. (Default: true) |
| Customerid | String | Customer ID or customer group ID |
| Customerid_subs | Boolean | Include customer sub dimensions. (Default: true) |
| Customertypeid | String | Customer type. Do not use if Customer ID is set. |
| Vendorid | String | Vendor ID or vendor group ID |
| Vendorid_subs | Boolean | Include vendor sub dimensions. (Default: true) |
| Vendortypeid | String | Vendor type. Do not use if Vendor ID is set. |
| Employeeid | String | Employee ID or employee group ID |
| Employeeid_subs | Boolean | Include employee sub dimensions. (Default: true) |
| Employeetypeid | String | Employee type. Do not use if Employee ID is set. |
| Itemid | String | Item ID or item group ID |
| Productlineid | String | Product line. Do not use if Item ID is set. |
| Classid | String | Class ID or class group ID |
| Classid_subs | Boolean | Include class sub dimensions. (Default: true) |
| Contractid | String | Contract ID or contract group ID |
| Contractid_subs | Boolean | Include contract sub dimensions. (Default: true) |
| Warehouseid | String | Warehouse ID or warehouse group ID |
| Warehouseid_subs | Boolean | Include warehouse sub dimensions. (Default: true) |
| UserDefinedDimensions | Array | User defined dimensions to include |
| Groupby | String | Comma-separated list of the names of standard and/or user-defined dimensions for grouping the results. |
Result Set Columns
| Name | Type | Description |
| Glaccountno | String | Returns the glaccountno field. |
| Startbalance | String | Returns the startbalance field. |
| Periodbalance | String | Returns the startbalance field. |
| Periodbalancedetail_debit | String | Returns the periodbalancedetail_debit field. |
| Periodbalancedetail_credit | String | Returns the periodbalancedetail_credit field. |
| Periodbalancedetail_adjdebit | String | Returns the periodbalancedetail_adjdebit field. |
| Periodbalancedetail_adjcredit | String | Returns the periodbalancedetail_adjcredit field. |
| Endbalance | String | Returns the endbalance field. |
| Currency | String | Returns the currency field. |