BalanceSheetSummary
Summarizes the key figures of the Balance Sheet in a concise report format.
Columns
| Name | Type | References | Description |
| Account | String | The name or label of the account in the BalanceSheetSummary report, representing financial accounts such as Assets, Liabilities, or Equity. | |
| Total | Double | The total monetary value associated with the account in the BalanceSheetSummary report. |
Pseudo-Columns
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| ReportPeriod | String | Specifies the date range for the report in the format fromdate:todate. Set the todate to get the balance as of a specific date (for example, :2017-12-25). Supported date format is yyyy-MM-dd. | |
| ReportDateRangeMacro | String | A predefined macro specifying the date range for the report, such as 'LastMonth' or 'ThisFiscalYear'.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is THISYEARTODATE. | |
| AccountType | String | Filters the report to include only accounts of a specific type, such as Asset, Liability, or Equity.
The allowed values are NONE, ACCOUNTSPAYABLE, ACCOUNTSRECEIVABLE, ALLOWEDFOR1099, APANDSALESTAX, APORCREDITCARD, ARANDAP, ASSET, BALANCESHEET, BANK, BANKANDARANDAPANDUF, BANKANDUF, COSTOFSALES, CREDITCARD, CURRENTASSET, CURRENTASSETANDEXPENSE, CURRENTLIABILITY, EQUITY, EQUITYANDINCOMEANDEXPENSE, EXPENSEANDOTHEREXPENSE, FIXEDASSET, INCOMEANDEXPENSE, INCOMEANDOTHERINCOME, LIABILITY, LIABILITYANDEQUITY, LONGTERMLIABILITY, NONPOSTING, ORDINARYEXPENSE, ORDINARYINCOME, ORDINARYINCOMEANDCOGS, ORDINARYINCOMEANDEXPENSE, OTHERASSET, OTHERCURRENTASSET, OTHERCURRENTLIABILITY, OTHEREXPENSE, OTHERINCOME, OTHERINCOMEOREXPENSE. | |
| AccountList | String | A comma-separated list of account names or IDs to include in the report. Specify AccountListType when using this input. | |
| AccountListType | String | Determines the type of account list specified in AccountList, such as 'Name' or 'ID'.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. | |
| EntityType | String | Filters the report to include only entities of a specific type, such as Customer, Vendor, or Employee.
The allowed values are NONE, CUSTOMER, EMPLOYEE, OTHERNAME, VENDOR. | |
| EntityList | String | A comma-separated list of entity names or IDs to include in the report. Specify EntityListType when using this input. | |
| EntityListType | String | Determines the type of entity list specified in EntityList, such as 'Name' or 'ID'.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. | |
| ItemType | String | Filters the report to include only items of a specific type, such as Inventory or Non-Inventory.
The allowed values are NONE, ALLEXCEPTFIXEDASSET, ASSEMBLY, DISCOUNT, FIXEDASSET, INVENTORY, INVENTORYANDASSEMBLY, NONINVENTORY, OTHERCHARGE, PAYMENT, SALES, SALESTAX, SERVICE. | |
| ItemList | String | A comma-separated list of item names or IDs to include in the report. Specify ItemListType when using this input. | |
| ItemListType | String | Determines the type of item list specified in ItemList, such as 'Name' or 'ID'.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. | |
| ClassList | String | A comma-separated list of class names or IDs to include in the report. Specify ClassListType when using this input. | |
| ClassListType | String | Determines the type of class list specified in ClassList, such as 'Name' or 'ID'.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. | |
| TransactionTypes | String | A comma-separated list of transaction types to include in the report. Possible values include ALL, INVOICE, PAYMENT, DEPOSIT, and many more.
The default value is ALL. | |
| ModifiedDateRange | String | Specifies the date range for modified entries in the format fromdate:todate. Supports open-ended ranges (for example, 2017-12-25:). | |
| ModifiedDateRangeMacro | String | A predefined macro specifying the modified date range, such as 'LastWeek' or 'ThisQuarter'.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, ASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. | |
| DetailLevel | String | Specifies the level of detail to include in the report. Options include Summary or AllTransactions.
The allowed values are ALL, ALLEXCEPTSUMMARY, SUMMARYONLY. The default value is ALL. | |
| PostingStatus | String | Filters the report to include only posting transactions, nonposting transactions, or both.
The allowed values are EITHER, NONPOSTING, POSTING. The default value is POSTING. | |
| ReportBasis | String | Defines the accounting method for the report. Use 'Cash' for cash basis, 'Accrual' for accrual basis, or 'None' to use the default report basis. | |
| ReturnColumns | String | Specifies whether the report should include only columns with active information, only columns with nonzero values, or all columns regardless of their content or status.
The allowed values are NONE, ACTIVEONLY, NONZERO, All. The default value is ACTIVEONLY. | |
| ReturnRows | String | Specifies whether the report should include only rows with active information, only rows with nonzero values, or all rows regardless of their content or status.
The allowed values are NONE, ACTIVEONLY, NONZERO, All. The default value is NONZERO. | |
| ReportCalendar | String | Specifies the type of year to use for the report, such as CalendarYear or FiscalYear.
The allowed values are NONE, CALENDARYEAR, FISCALYEAR, TAXYEAR. The default value is FISCALYEAR. |